Documentation and Guides

PostgreSQL

Create an integration to manage access your PostgreSQL databases

PostgreSQL databases are open-source relational database management systems emphasizing extensibility and SQL compliance.

Through this integration, Apono helps you securely manage access to your PostgreSQL instance.

To enable Apono to manage PostgreSQL user access, you must create a user and then configure the integration within the Apono UI.

If your PostgreSQL instance runs on a cloud service, follow one of these guides:

Prerequisites

ItemDescription

Apono Connector

On-prem connection serving as a bridge between your PostgreSQL databases and Apono:

Minimum Required Version: 1.3.0 Use the following steps to update an existing connector:

PostgreSQL Info

Information for the database instance to be integrated:

  • Hostname

  • Port number

  • Database Name

Create a PostgreSQL user

You must create a user in your PostgreSQL instance for the Apono connector.

You must use the admin account and password to connect to your database.

Follow these steps to create a user and grant it permissions:

  1. In your preferred client tool, create a new user. Use apono_connector for the username. Be sure to set a strong password for the user. You must also grant the SUPERUSER role to the user in the database instance.

    CREATE USER apono_connector WITH ENCRYPTED PASSWORD 'password';
ALTER USER apono_connector WITH SUPERUSER;

  2. Using the credentials from step 1, create a secret for the database instance.

You can also input the user credentials directly into the Apono UI during the integration process.

Integrate PostgreSQL

You can also use the steps below to integrate with Apono using Terraform.

In step 11, instead of clicking Confirm, follow the Are you integrating with Apono using Terraform? guidance.

Follow these steps to complete the integration:

  1. On the Catalog tab, click PostgreSQL. The Connect Integration page appears.

  2. Under Discovery, select one or multiple resource types for Apono to discover in all instances of the environment.

  3. Click Next. The Apono connector section expands.

  4. From the dropdown menu, select a connector. Choosing a connector links Apono to all the services available on the account where the connector is located.

If the desired connector is not listed, click + Add new connector and follow the instructions for creating a connector (AWS, Azure, GCP, Kubernetes).

  1. Click Next. The Integration Config section expands.

  2. Define the Integration Config settings.

    Setting

    Description

    Integration Name

    Unique, alphanumeric, user-friendly name used to identify this integration when constructing an access flow

    Hostname

    Hostname of the PostgreSQL database instance to connect

    Port

    Port value for the instance By default, Apono sets this value to 5432.

    Database Name

    Name of the database to integrate By default, Apono sets this value to postgre

    SSL Mode

    (Optionl) Mode of Secure Sockets Layer (SSL) encryption used to secure the connection with the SQL database server

    Option

    Description

    require

    An SSL-encrypted connection must be used.

    allow

    An SSL-encrypted or unencrypted connection is used. If an SSL encrypted connection is unavailable, the unencrypted connection is used.

    disable

    An unencrypted connection is used.

    prefer

    An SSL encrypted connection is attempted. If the encrypted connection is unavailable, the unencrypted connection is used.

    verify-ca

    An SSL-encrypted connection must be used and a server certification verification against the provided CA certificates must pass.

    verify-full

    An SSL-encrypted connection must be used and a server certification verification against the provided CA certificates must pass. Additionally, the server hostname is checked against the certificate's names.

  3. Click Next. The Secret Store section expands.

  4. Associate the secret or credentials.

  5. Click Next. The Get more with Apono section expands.

  6. Define the Get more with Apono settings.

    SettingDescription

    Credential Rotation

    (Optional) Number of days after which the database credentials must be rotated

    Custom Access Details

    (Optional) Instructions explaining how to access this integration's resources Upon accessing an integration, a message with these instructions will be displayed to end users in the User Portal. The message may include up to 400 characters. To view the message as it appears to end users, click Preview.

    Integration Owner

    1. From the Attribute dropdown menu, select User or Group under the relevant identity provider (IdP) platform.

    2. From the Value dropdown menu, select one or multiple users or groups.

    NOTE: When Resource Owner is defined, an Integration Owner must be defined.

    Resource Owner

    1. Enter a Key name. This value is the name of the tag created in your cloud environment.

    2. From the Attribute dropdown menu, select an attribute under the IdP platform to which the key name is associated. Apono will use the value associated with the key (tag) to identify the resource owner. When you update the membership of the group or role in your IdP platform, this change is also reflected in Apono.

    NOTE: When this setting is defined, an Integration Owner must also be defined.

​

  1. Click Confirm.

💡Are you integrating with Apono using Terraform?

If you want to integrate with Apono using Terraform, follow these steps instead of clicking Confirm:

  1. At the top of the screen, click View as Code. A modal appears with the completed Terraform configuration code.

  2. Click to copy the code.

  3. Make any additional edits.

  4. Deploy the code in your Terraform.

Refer to Integration Config Metadata for more details about the schema definition.

​

Now that you have completed this integration, you can create access flows that grant permission to your PostgreSQL instance.​

PreviousOracle DatabaseNextRedis Cloud (Redislabs)

Last updated