From 59b3f3694376aacb463024de1d4b5c22195f1b0f Mon Sep 17 00:00:00 2001 From: Fabian Martinez <46371672+famarting@users.noreply.github.com> Date: Thu, 14 Nov 2024 13:39:17 +0100 Subject: [PATCH 1/5] update postgres aws auth profile metadata Signed-off-by: Fabian Martinez <46371672+famarting@users.noreply.github.com> --- .../components-reference/supported-bindings/postgresql.md | 6 ++++-- .../postgresql-configuration-store.md | 6 ++++-- .../supported-state-stores/setup-postgresql-v1.md | 6 ++++-- .../supported-state-stores/setup-postgresql-v2.md | 6 ++++-- 4 files changed, 16 insertions(+), 8 deletions(-) diff --git a/daprdocs/content/en/reference/components-reference/supported-bindings/postgresql.md b/daprdocs/content/en/reference/components-reference/supported-bindings/postgresql.md index 97617eb3eb3..fd0da724feb 100644 --- a/daprdocs/content/en/reference/components-reference/supported-bindings/postgresql.md +++ b/daprdocs/content/en/reference/components-reference/supported-bindings/postgresql.md @@ -65,9 +65,11 @@ The AWS authentication token will be dynamically rotated before it's expiration | `useAWSIAM` | Y | Must be set to `true` to enable the component to retrieve access tokens from AWS IAM. This authentication method only works with AWS Relational Database Service for PostgreSQL databases. | `"true"` | | `connectionString` | Y | The connection string for the PostgreSQL database.
This must contain an already existing user, which corresponds to the name of the user created inside PostgreSQL that maps to the AWS IAM policy. This connection string should not contain any password. Note that the database name field is denoted by dbname with AWS. | `"host=mydb.postgres.database.aws.com user=myapplication port=5432 dbname=my_db sslmode=require"`| | `awsRegion` | Y | The AWS Region where the AWS Relational Database Service is deployed to. | `"us-east-1"` | -| `awsAccessKey` | Y | AWS access key associated with an IAM account | `"AKIAIOSFODNN7EXAMPLE"` | -| `awsSecretKey` | Y | The secret key associated with the access key | `"wJalrXUtnFEMI/K7MDENG/bPxRfiCYEXAMPLEKEY"` | +| `awsAccessKey` | N | AWS access key associated with an IAM account | `"AKIAIOSFODNN7EXAMPLE"` | +| `awsSecretKey` | N | The secret key associated with the access key | `"wJalrXUtnFEMI/K7MDENG/bPxRfiCYEXAMPLEKEY"` | | `awsSessionToken` | N | AWS session token to use. A session token is only required if you are using temporary security credentials. | `"TOKEN"` | +| `awsIamRoleArn` | N | IAM role that has access to AWS Relational Database Service. This is another option to authenticate with AWS aside from the AWS Credentials. | `"arn:aws:iam::123456789:role/rdsRole"` | +| `awsStsSessionName` | N | Represents the session name for assuming a role. | `"PGDefaultSession"` | ### Other metadata options diff --git a/daprdocs/content/en/reference/components-reference/supported-configuration-stores/postgresql-configuration-store.md b/daprdocs/content/en/reference/components-reference/supported-configuration-stores/postgresql-configuration-store.md index 29d7859c326..a72e4d2f8bf 100644 --- a/daprdocs/content/en/reference/components-reference/supported-configuration-stores/postgresql-configuration-store.md +++ b/daprdocs/content/en/reference/components-reference/supported-configuration-stores/postgresql-configuration-store.md @@ -91,9 +91,11 @@ The AWS authentication token will be dynamically rotated before it's expiration | `useAWSIAM` | Y | Must be set to `true` to enable the component to retrieve access tokens from AWS IAM. This authentication method only works with AWS Relational Database Service for PostgreSQL databases. | `"true"` | | `connectionString` | Y | The connection string for the PostgreSQL database.
This must contain an already existing user, which corresponds to the name of the user created inside PostgreSQL that maps to the AWS IAM policy. This connection string should not contain any password. Note that the database name field is denoted by dbname with AWS. | `"host=mydb.postgres.database.aws.com user=myapplication port=5432 dbname=my_db sslmode=require"`| | `awsRegion` | Y | The AWS Region where the AWS Relational Database Service is deployed to. | `"us-east-1"` | -| `awsAccessKey` | Y | AWS access key associated with an IAM account | `"AKIAIOSFODNN7EXAMPLE"` | -| `awsSecretKey` | Y | The secret key associated with the access key | `"wJalrXUtnFEMI/K7MDENG/bPxRfiCYEXAMPLEKEY"` | +| `awsAccessKey` | N | AWS access key associated with an IAM account | `"AKIAIOSFODNN7EXAMPLE"` | +| `awsSecretKey` | N | The secret key associated with the access key | `"wJalrXUtnFEMI/K7MDENG/bPxRfiCYEXAMPLEKEY"` | | `awsSessionToken` | N | AWS session token to use. A session token is only required if you are using temporary security credentials. | `"TOKEN"` | +| `awsIamRoleArn` | N | IAM role that has access to AWS Relational Database Service. This is another option to authenticate with AWS aside from the AWS Credentials. | `"arn:aws:iam::123456789:role/rdsRole"` | +| `awsStsSessionName` | N | Represents the session name for assuming a role. | `"PGDefaultSession"` | ### Other metadata options diff --git a/daprdocs/content/en/reference/components-reference/supported-state-stores/setup-postgresql-v1.md b/daprdocs/content/en/reference/components-reference/supported-state-stores/setup-postgresql-v1.md index 8cec85ad16a..4539ba0374f 100644 --- a/daprdocs/content/en/reference/components-reference/supported-state-stores/setup-postgresql-v1.md +++ b/daprdocs/content/en/reference/components-reference/supported-state-stores/setup-postgresql-v1.md @@ -95,9 +95,11 @@ The AWS authentication token will be dynamically rotated before it's expiration | `useAWSIAM` | Y | Must be set to `true` to enable the component to retrieve access tokens from AWS IAM. This authentication method only works with AWS Relational Database Service for PostgreSQL databases. | `"true"` | | `connectionString` | Y | The connection string for the PostgreSQL database.
This must contain an already existing user, which corresponds to the name of the user created inside PostgreSQL that maps to the AWS IAM policy. This connection string should not contain any password. Note that the database name field is denoted by dbname with AWS. | `"host=mydb.postgres.database.aws.com user=myapplication port=5432 dbname=my_db sslmode=require"`| | `awsRegion` | Y | The AWS Region where the AWS Relational Database Service is deployed to. | `"us-east-1"` | -| `awsAccessKey` | Y | AWS access key associated with an IAM account | `"AKIAIOSFODNN7EXAMPLE"` | -| `awsSecretKey` | Y | The secret key associated with the access key | `"wJalrXUtnFEMI/K7MDENG/bPxRfiCYEXAMPLEKEY"` | +| `awsAccessKey` | N | AWS access key associated with an IAM account | `"AKIAIOSFODNN7EXAMPLE"` | +| `awsSecretKey` | N | The secret key associated with the access key | `"wJalrXUtnFEMI/K7MDENG/bPxRfiCYEXAMPLEKEY"` | | `awsSessionToken` | N | AWS session token to use. A session token is only required if you are using temporary security credentials. | `"TOKEN"` | +| `awsIamRoleArn` | N | IAM role that has access to AWS Relational Database Service. This is another option to authenticate with AWS aside from the AWS Credentials. | `"arn:aws:iam::123456789:role/rdsRole"` | +| `awsStsSessionName` | N | Represents the session name for assuming a role. | `"PGDefaultSession"` | ### Other metadata options diff --git a/daprdocs/content/en/reference/components-reference/supported-state-stores/setup-postgresql-v2.md b/daprdocs/content/en/reference/components-reference/supported-state-stores/setup-postgresql-v2.md index 3223867787f..3c4a69307b4 100644 --- a/daprdocs/content/en/reference/components-reference/supported-state-stores/setup-postgresql-v2.md +++ b/daprdocs/content/en/reference/components-reference/supported-state-stores/setup-postgresql-v2.md @@ -95,9 +95,11 @@ The AWS authentication token will be dynamically rotated before it's expiration | `useAWSIAM` | Y | Must be set to `true` to enable the component to retrieve access tokens from AWS IAM. This authentication method only works with AWS Relational Database Service for PostgreSQL databases. | `"true"` | | `connectionString` | Y | The connection string for the PostgreSQL database.
This must contain an already existing user, which corresponds to the name of the user created inside PostgreSQL that maps to the AWS IAM policy. This connection string should not contain any password. Note that the database name field is denoted by dbname with AWS. | `"host=mydb.postgres.database.aws.com user=myapplication port=5432 dbname=my_db sslmode=require"`| | `awsRegion` | Y | The AWS Region where the AWS Relational Database Service is deployed to. | `"us-east-1"` | -| `awsAccessKey` | Y | AWS access key associated with an IAM account | `"AKIAIOSFODNN7EXAMPLE"` | -| `awsSecretKey` | Y | The secret key associated with the access key | `"wJalrXUtnFEMI/K7MDENG/bPxRfiCYEXAMPLEKEY"` | +| `awsAccessKey` | N | AWS access key associated with an IAM account | `"AKIAIOSFODNN7EXAMPLE"` | +| `awsSecretKey` | N | The secret key associated with the access key | `"wJalrXUtnFEMI/K7MDENG/bPxRfiCYEXAMPLEKEY"` | | `awsSessionToken` | N | AWS session token to use. A session token is only required if you are using temporary security credentials. | `"TOKEN"` | +| `awsIamRoleArn` | N | IAM role that has access to AWS Relational Database Service. This is another option to authenticate with AWS aside from the AWS Credentials. | `"arn:aws:iam::123456789:role/rdsRole"` | +| `awsStsSessionName` | N | Represents the session name for assuming a role. | `"PGDefaultSession"` | ### Other metadata options From 4fdcd06a64218dfd4a7d77485efd6c3831d4e275 Mon Sep 17 00:00:00 2001 From: Fabian Martinez <46371672+famarting@users.noreply.github.com> Date: Thu, 14 Nov 2024 14:40:25 +0100 Subject: [PATCH 2/5] Update daprdocs/content/en/reference/components-reference/supported-bindings/postgresql.md Co-authored-by: Josh van Leeuwen Signed-off-by: Fabian Martinez <46371672+famarting@users.noreply.github.com> --- .../components-reference/supported-bindings/postgresql.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/daprdocs/content/en/reference/components-reference/supported-bindings/postgresql.md b/daprdocs/content/en/reference/components-reference/supported-bindings/postgresql.md index fd0da724feb..cb58757737f 100644 --- a/daprdocs/content/en/reference/components-reference/supported-bindings/postgresql.md +++ b/daprdocs/content/en/reference/components-reference/supported-bindings/postgresql.md @@ -68,7 +68,7 @@ The AWS authentication token will be dynamically rotated before it's expiration | `awsAccessKey` | N | AWS access key associated with an IAM account | `"AKIAIOSFODNN7EXAMPLE"` | | `awsSecretKey` | N | The secret key associated with the access key | `"wJalrXUtnFEMI/K7MDENG/bPxRfiCYEXAMPLEKEY"` | | `awsSessionToken` | N | AWS session token to use. A session token is only required if you are using temporary security credentials. | `"TOKEN"` | -| `awsIamRoleArn` | N | IAM role that has access to AWS Relational Database Service. This is another option to authenticate with AWS aside from the AWS Credentials. | `"arn:aws:iam::123456789:role/rdsRole"` | +| `awsIamRoleArn` | N | IAM role to assume that has access to AWS Relational Database Service. This is another option to authenticate with AWS aside from the AWS Credentials. | `"arn:aws:iam::123456789:role/rdsRole"` | | `awsStsSessionName` | N | Represents the session name for assuming a role. | `"PGDefaultSession"` | ### Other metadata options From e738316d242a1b9ce73d559c3e80203098f647b7 Mon Sep 17 00:00:00 2001 From: Fabian Martinez <46371672+famarting@users.noreply.github.com> Date: Thu, 14 Nov 2024 14:40:31 +0100 Subject: [PATCH 3/5] Update daprdocs/content/en/reference/components-reference/supported-configuration-stores/postgresql-configuration-store.md Co-authored-by: Josh van Leeuwen Signed-off-by: Fabian Martinez <46371672+famarting@users.noreply.github.com> --- .../postgresql-configuration-store.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/daprdocs/content/en/reference/components-reference/supported-configuration-stores/postgresql-configuration-store.md b/daprdocs/content/en/reference/components-reference/supported-configuration-stores/postgresql-configuration-store.md index a72e4d2f8bf..5cef58a3866 100644 --- a/daprdocs/content/en/reference/components-reference/supported-configuration-stores/postgresql-configuration-store.md +++ b/daprdocs/content/en/reference/components-reference/supported-configuration-stores/postgresql-configuration-store.md @@ -94,7 +94,7 @@ The AWS authentication token will be dynamically rotated before it's expiration | `awsAccessKey` | N | AWS access key associated with an IAM account | `"AKIAIOSFODNN7EXAMPLE"` | | `awsSecretKey` | N | The secret key associated with the access key | `"wJalrXUtnFEMI/K7MDENG/bPxRfiCYEXAMPLEKEY"` | | `awsSessionToken` | N | AWS session token to use. A session token is only required if you are using temporary security credentials. | `"TOKEN"` | -| `awsIamRoleArn` | N | IAM role that has access to AWS Relational Database Service. This is another option to authenticate with AWS aside from the AWS Credentials. | `"arn:aws:iam::123456789:role/rdsRole"` | +| `awsIamRoleArn` | N | IAM role to assume that has access to AWS Relational Database Service. This is another option to authenticate with AWS aside from the AWS Credentials. | `"arn:aws:iam::123456789:role/rdsRole"` | | `awsStsSessionName` | N | Represents the session name for assuming a role. | `"PGDefaultSession"` | ### Other metadata options From d47692f6046c78c4444a02fe316a4d0ff1c0f2cd Mon Sep 17 00:00:00 2001 From: Fabian Martinez <46371672+famarting@users.noreply.github.com> Date: Thu, 14 Nov 2024 14:40:40 +0100 Subject: [PATCH 4/5] Update daprdocs/content/en/reference/components-reference/supported-state-stores/setup-postgresql-v1.md Co-authored-by: Josh van Leeuwen Signed-off-by: Fabian Martinez <46371672+famarting@users.noreply.github.com> --- .../supported-state-stores/setup-postgresql-v1.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/daprdocs/content/en/reference/components-reference/supported-state-stores/setup-postgresql-v1.md b/daprdocs/content/en/reference/components-reference/supported-state-stores/setup-postgresql-v1.md index 4539ba0374f..41c50bdf134 100644 --- a/daprdocs/content/en/reference/components-reference/supported-state-stores/setup-postgresql-v1.md +++ b/daprdocs/content/en/reference/components-reference/supported-state-stores/setup-postgresql-v1.md @@ -98,7 +98,7 @@ The AWS authentication token will be dynamically rotated before it's expiration | `awsAccessKey` | N | AWS access key associated with an IAM account | `"AKIAIOSFODNN7EXAMPLE"` | | `awsSecretKey` | N | The secret key associated with the access key | `"wJalrXUtnFEMI/K7MDENG/bPxRfiCYEXAMPLEKEY"` | | `awsSessionToken` | N | AWS session token to use. A session token is only required if you are using temporary security credentials. | `"TOKEN"` | -| `awsIamRoleArn` | N | IAM role that has access to AWS Relational Database Service. This is another option to authenticate with AWS aside from the AWS Credentials. | `"arn:aws:iam::123456789:role/rdsRole"` | +| `awsIamRoleArn` | N | IAM role to assume that has access to AWS Relational Database Service. This is another option to authenticate with AWS aside from the AWS Credentials. | `"arn:aws:iam::123456789:role/rdsRole"` | | `awsStsSessionName` | N | Represents the session name for assuming a role. | `"PGDefaultSession"` | ### Other metadata options From 7ea57ccce53a0876be729b04a650b531f1eae0e0 Mon Sep 17 00:00:00 2001 From: Fabian Martinez <46371672+famarting@users.noreply.github.com> Date: Thu, 14 Nov 2024 14:40:49 +0100 Subject: [PATCH 5/5] Update daprdocs/content/en/reference/components-reference/supported-state-stores/setup-postgresql-v2.md Co-authored-by: Josh van Leeuwen Signed-off-by: Fabian Martinez <46371672+famarting@users.noreply.github.com> --- .../supported-state-stores/setup-postgresql-v2.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/daprdocs/content/en/reference/components-reference/supported-state-stores/setup-postgresql-v2.md b/daprdocs/content/en/reference/components-reference/supported-state-stores/setup-postgresql-v2.md index 3c4a69307b4..c5e073fdf9b 100644 --- a/daprdocs/content/en/reference/components-reference/supported-state-stores/setup-postgresql-v2.md +++ b/daprdocs/content/en/reference/components-reference/supported-state-stores/setup-postgresql-v2.md @@ -98,7 +98,7 @@ The AWS authentication token will be dynamically rotated before it's expiration | `awsAccessKey` | N | AWS access key associated with an IAM account | `"AKIAIOSFODNN7EXAMPLE"` | | `awsSecretKey` | N | The secret key associated with the access key | `"wJalrXUtnFEMI/K7MDENG/bPxRfiCYEXAMPLEKEY"` | | `awsSessionToken` | N | AWS session token to use. A session token is only required if you are using temporary security credentials. | `"TOKEN"` | -| `awsIamRoleArn` | N | IAM role that has access to AWS Relational Database Service. This is another option to authenticate with AWS aside from the AWS Credentials. | `"arn:aws:iam::123456789:role/rdsRole"` | +| `awsIamRoleArn` | N | IAM role to assume that has access to AWS Relational Database Service. This is another option to authenticate with AWS aside from the AWS Credentials. | `"arn:aws:iam::123456789:role/rdsRole"` | | `awsStsSessionName` | N | Represents the session name for assuming a role. | `"PGDefaultSession"` | ### Other metadata options