Jump to
Overview
Integrating with a PostgreSQL server will allow you to manage access requests to all databases in that server, and to schemas, tables, and views in each of these databases.
You need to create a separate PostgreSQL Integration for each PostgreSQL server.
PostgreSQL integration consists of:
Gathering connection details: hostname, username, password.
Creating a new PostgreSQL user and granting in mandatory grants.
Entering the collected connection details in Axiom web-based user console.
NOTE
If you want to use self-hosted Axiom runner, start by reviewing Axiom Runner - Setup and Secret Configuration page.
Prerequisites
To complete this integration, you need:
An Axiom admin user.
PostgreSQL superuser access (or rds_superuser for AWS RDS).
PostgreSQL server connection details.
Step-by-step guide
To create a new superuser, connect to your database and execute one of the following:
AWS RDS:
-- Step 1: Create a user
CREATE USER axiom_integration_user WITH LOGIN PASSWORD 'strong_password' CREATEROLE;
-- Step 2: Grant administrative privileges
GRANT rds_superuser TO axiom_integration_user;Self hosted PostgreSQL:
-- Create a user with superuser
CREATE USER axiom_integration_user WITH LOGIN PASSWORD 'strong_password' SUPERUSER;Gather the following information:
PostgreSQL hostname
Username (either your existing user or the newly created axiom_user)
Password
SECURITY NOTE!
The user created by the above commands has extensive privileges! Use a strong password and store it securely.
Axiom
Sign in to the Axiom web based user console, and press on "Integrations" from the left side navigation menu
Under "Databases" find the card for PostgreSQL, and press on the "+ Add" button
In the PostgreSQL integration page enter the the connection details:
Name:
Choose a meaningful name
Hostname:
Enter the PostgreSQL hostname
Username:
Enter the username of the new/ created user you created in PostgreSQL (as per above directions)
Password:
Enter the password for the user
Click on the "Integrate" button.
Making use of the new Integration
After you press Integrate, Axiom will perform an initial scan of the server to collect it's databases, schemas, tables, and views.
Once the initial scan is complete, you can begin creating scopes, and managing requests for these resources.
To find out the status of the scan, click on "accounts". If there is a spinner, then the scan is still in progress. If there is a "Play" icon, then the scan is complete. Hover over the play button to see the scan details. Press on the play button to scan again now (scans happen every four hours).
