-
Notifications
You must be signed in to change notification settings - Fork 251
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Merge pull request #4025 from EnterpriseDB/release/2023-05-04
Release: 2023-05-04
- Loading branch information
Showing
18 changed files
with
145 additions
and
157 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
|
@@ -2,51 +2,51 @@ | |
title: "Managing Postgres access" | ||
--- | ||
|
||
You control access to your Postgres database by database authentication implemented by creating databases with specific roles and privileges. Database authentication differs from portal authentication, which controls access to the BigAnimal portal. | ||
You control access to your Postgres database using database authentication implemented by creating databases with specific roles and privileges. Database authentication differs from portal authentication, which controls access to the BigAnimal portal. | ||
|
||
For information on portal authentication, see: | ||
|
||
- [Setting up your identity provider](/biganimal/latest/getting_started/identity_provider/) if you purchased BigAnimal directly from EDB, or | ||
- [Setting up your identity provider](/biganimal/latest/getting_started/identity_provider/) if you purchased BigAnimal directly from EDB | ||
- [Setting up your Azure Marketplace account](/biganimal/latest/getting_started/02_azure_market_setup/) if you purchased BigAnimal through Azure Marketplace | ||
|
||
## Setting up your database authentication | ||
Don't use the `edb_admin` database role and `edb_admin` database created when creating your cluster in your application. Instead, create a new database role and a new database, which provides a high level of isolation in Postgres. If multiple applications are using the same cluster, each database can also contain multiple schemas, essentially a namespace in the database. If strict isolation is needed, use a dedicated cluster or dedicated database. If that strict isolation level isn't required, you can deploy a single database with multiple schemas. Refer to [Privileges](https://www.postgresql.org/docs/current/ddl-priv.html) in the PostgreSQL documentation to further customize ownership and roles to your requirements. | ||
Don't use the edb_admin database role and edb_admin database created when creating your cluster in your application. Instead, create a new database role and a new database, which provides a high level of isolation in Postgres. If multiple applications are using the same cluster, each database can also contain multiple schemas, essentially a namespace in the database. If you need strict isolation, use a dedicated cluster or dedicated database. If you don't need that strict isolation level, you can deploy a single database with multiple schemas. See [Privileges](https://www.postgresql.org/docs/current/ddl-priv.html) in the PostgreSQL documentation to further customize ownership and roles to your requirements. | ||
|
||
To create a new role and database, first connect using `psql`: | ||
|
||
```shell | ||
psql -W "postgres://[email protected]:5432/edb_admin?sslmode=require" | ||
``` | ||
!!! Note | ||
Avoid storing data in the `postgres` system database. | ||
Avoid storing data in the postgres system database. | ||
|
||
## Notes on the edb_admin role | ||
|
||
- The `edb_admin` role does not have superuser privileges by default. Contact [Support](../overview/support) to request superuser privileges for `edb_admin`. If you request superuser privileges, you **must** take care to limit the number of connections used by superusers to avoid degraded service and/or compromising availability. | ||
- The edb_admin role doesn't have superuser privileges by default. Contact [Support](../overview/support) to request superuser privileges for edb_admin. If you request superuser privileges, you must take care to limit the number of connections used by superusers to avoid degraded service or compromising availability. | ||
|
||
!!! note | ||
Superuser privileges allow you to make Postgres configuration changes using `ALTER SYSTEM` queries. We recommend you don't do this because it may lead to an unpredictable/unrecoverable state of the cluster. In addition, `ALTER SYSTEM` changes are not replicated across the cluster. | ||
Superuser privileges allow you to make Postgres configuration changes using `ALTER SYSTEM` queries. We recommend you don't do this because it might lead to an unpredictable or unrecoverable state of the cluster. In addition, `ALTER SYSTEM` changes aren't replicated across the cluster. | ||
|
||
- Changes to system configuration (GUCs) made by edb_admin or other Postgres users are not persisted though a reboot or maintenance. Use the BigAnimal portal to modify system configuration. | ||
- Changes to system configuration (GUCs) made by edb_admin or other Postgres users don't persist through a reboot or maintenance. Use the BigAnimal portal to modify system configuration. | ||
|
||
- You have to remember your `edb_admin` password as EDB does not have access to it. If you forget it, you can set a new one in the BigAnimal portal on the Edit Cluster page. | ||
- You have to remember your edb_admin password, as EDB doesn't have access to it. If you forget it, you can set a new one in the BigAnimal portal on the Edit Cluster page. | ||
|
||
- Don't use the `edb_admin` user or the `edb_admin` database in your applications. Instead, use `CREATE USER; GRANT; CREATE DATABASE.` | ||
- Don't use the edb_admin user or the edb_admin database in your applications. Instead, use `CREATE USER; GRANT; CREATE DATABASE.` | ||
|
||
- BigAnimal stores all database-level authentication securely and directly in PostgreSQL. The `edb_admin` user password is SCRAM-SHA-256 hashed prior to storage. This hash, even if compromised, cannot be replayed by an attacker to gain access to the system. | ||
- BigAnimal stores all database-level authentication securely and directly in PostgreSQL. The `edb_admin` user password is `SCRAM-SHA-256` hashed prior to storage. This hash, even if compromised, can't be replayed by an attacker to gain access to the system. | ||
|
||
|
||
|
||
## One database with one application | ||
|
||
For one database hosting a single application, replace app1 with your preferred user name: | ||
For one database hosting a single application, replace `app1` with your preferred user name: | ||
|
||
1. Create a new database user. For example, | ||
``` | ||
edb_admin=# create user app1 with password 'app1_pwd'; | ||
``` | ||
|
||
2. Assign the new role to your `edb_admin` user. Assigning this role allows you to assign ownership to the new user in the next step. For example: | ||
2. Assign the new role to your edb_admin user. Assigning this role allows you to assign ownership to the new user in the next step. For example: | ||
``` | ||
edb_admin=# grant app1 to edb_admin; | ||
``` | ||
|
@@ -56,11 +56,11 @@ For one database hosting a single application, replace app1 with your preferred | |
edb_admin=# create database app1 with owner app1; | ||
``` | ||
|
||
Using this example, the username and database in your connection string is `app1`. | ||
Using this example, the username and database in your connection string is app1. | ||
|
||
## One database with multiple schemas | ||
|
||
If a single database is used to host multiple schemas, create a database owner and then roles and schemas for each application. This example shows creating two database roles and two schemas. The default `search_path` for database roles in BigAnimal is `"$user",public`. If the role name and schema match, then objects in that schema match first, and no `search_path` changes or fully qualifying of objects are needed. The [PostgreSQL documentation](https://www.postgresql.org/docs/current/ddl-schemas.html#DDL-SCHEMAS-PATH) covers the schema search path in detail. | ||
If you use a single database to host multiple schemas, create a database owner and then roles and schemas for each application. This example shows creating two database roles and two schemas. The default `search_path` for database roles in BigAnimal is `"$user",public`. If the role name and schema match, then objects in that schema match first, and no `search_path` changes or fully qualifying of objects are needed. The [PostgreSQL documentation](https://www.postgresql.org/docs/current/ddl-schemas.html#DDL-SCHEMAS-PATH) covers the schema search path in detail. | ||
|
||
1. Create a database owner and new database. For example: | ||
``` | ||
|
@@ -83,14 +83,14 @@ If a single database is used to host multiple schemas, create a database owner a | |
prod1=# grant app2 to edb_admin; | ||
``` | ||
|
||
4. Create a new schema for each application with the AUTHORIZATION clause for the application owner. For example: | ||
4. Create a new schema for each application with the `AUTHORIZATION` clause for the application owner. For example: | ||
``` | ||
prod1=# create schema app1 authorization app1; | ||
prod1=# create schema app2 authorization app2; | ||
``` | ||
## IAM authentication for Postgres | ||
|
||
Any AWS user with an AWS account connected to a BigAnimal subscription who has the Postgres role of "iam_aws" can authenticate to the database using their AWS IAM credentials. | ||
Any AWS user with an AWS account connected to a BigAnimal subscription who has the Postgres role of iam_aws can authenticate to the database using their AWS IAM credentials. | ||
|
||
### Configuring IAM for Postgres | ||
|
||
|
@@ -100,7 +100,7 @@ Provision your cluster before configuring IAM for Postgres. | |
1. On the **Additional Settings** tab, under **Authentication**, select **Identity and Access Management (IAM) Authentication**. | ||
1. Select **Create Cluster** or **Save**. | ||
!!!note | ||
To turn on IAM authentication using the CLI, see the [Using IAM authentication on AWS](/biganimal/latest/reference/cli/using_features/#iam-authentication-cli-commands) section in the Using the BigAnimal CLI topic. | ||
To turn on IAM authentication using the CLI, see [Using IAM authentication on AWS](/biganimal/latest/reference/cli/using_features/#iam-authentication-cli-commands). | ||
1. In AWS, get the ARN of each IAM user requiring database access. In the AWS account connected to BigAnimal, use AWS Identity and Access Management (IAM) to perform user management. See the [AWS documentation](https://docs.aws.amazon.com/IAM/latest/UserGuide/id_users_manage.html). | ||
|
||
1. In Postgres, if the IAM role doesnβt exist yet, run this Postgres command: | ||
|
@@ -124,7 +124,7 @@ If IAM integration is configured for your cluster, you can log in to Postgres us | |
|
||
1. Using your AWS CLI or Cloud shell, obtain your ARN and access key. For guidance on obtaining your ARN and access key, see [Managing access keys for IAM users](https://docs.aws.amazon.com/IAM/latest/UserGuide/id_credentials_access-keys.html). | ||
1. Connect to Postgres using your IAM credentials. | ||
1. When prompted for the password, enter your access key (<access key ID>:<secret access key>). | ||
1. When prompted for the password, enter your access key (`<access key ID><secret access key>`). | ||
|
||
### Using IAM authentication CLI commands | ||
|
||
|
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Oops, something went wrong.
bfbe073
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
π Published on https://edb-docs-staging.netlify.app as production
π Deployed on https://64538e528cccf0077b608b44--edb-docs-staging.netlify.app
bfbe073
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
π Published on https://edb-docs.netlify.app as production
π Deployed on https://6453942a8cccf00d30608ad1--edb-docs.netlify.app