From addc5bbe4c427475c0b40d13234d86db6c221d69 Mon Sep 17 00:00:00 2001 From: smcaine Date: Fri, 6 Dec 2024 13:03:49 +0000 Subject: [PATCH] adding aws_irsa to old docs --- old_docs/barman-cloud-backup-delete.1.md | 3 +++ old_docs/barman-cloud-backup-keep.1.md | 1 + old_docs/barman-cloud-backup-list.1.md | 3 +++ old_docs/barman-cloud-backup-show.1.md | 3 +++ old_docs/barman-cloud-backup.1.md | 3 +++ old_docs/barman-cloud-check-wal-archive.1.md | 3 +++ old_docs/barman-cloud-restore.1.md | 3 +++ old_docs/barman-cloud-wal-archive.1.md | 3 +++ old_docs/barman-cloud-wal-restore.1.md | 3 +++ old_docs/manual/28-snapshots.en.md | 2 ++ old_docs/manual/55-barman-cli.en.md | 1 + 11 files changed, 28 insertions(+) diff --git a/old_docs/barman-cloud-backup-delete.1.md b/old_docs/barman-cloud-backup-delete.1.md index a413973e9..e74708ab0 100644 --- a/old_docs/barman-cloud-backup-delete.1.md +++ b/old_docs/barman-cloud-backup-delete.1.md @@ -45,6 +45,7 @@ of PostgreSQL servers written in Python and maintained by EnterpriseDB. usage: barman-cloud-backup-delete [-V] [--help] [-v | -q] [-t] [--cloud-provider {aws-s3,azure-blob-storage,google-cloud-storage}] [--endpoint-url ENDPOINT_URL] + [--aws-irsa] [-P AWS_PROFILE] [--profile AWS_PROFILE] [--read-timeout READ_TIMEOUT] [--azure-credential {azure-cli,managed-identity} @@ -91,6 +92,8 @@ optional arguments: Extra options for the aws-s3 cloud provider: --endpoint-url ENDPOINT_URL Override default S3 endpoint URL with the given one + --aws-irsa + use iam role service account instead of aws profile (recommended if running from an aws service) -P AWS_PROFILE, --aws-profile AWS_PROFILE profile name (e.g. INI section in AWS credentials file) diff --git a/old_docs/barman-cloud-backup-keep.1.md b/old_docs/barman-cloud-backup-keep.1.md index 797d2a83d..dd6efe9e0 100644 --- a/old_docs/barman-cloud-backup-keep.1.md +++ b/old_docs/barman-cloud-backup-keep.1.md @@ -27,6 +27,7 @@ of PostgreSQL servers written in Python and maintained by EnterpriseDB. usage: barman-cloud-backup-keep [-V] [--help] [-v | -q] [-t] [--cloud-provider {aws-s3,azure-blob-storage,google-cloud-storage}] [--endpoint-url ENDPOINT_URL] + [--aws-irsa] [-P AWS_PROFILE] [--profile AWS_PROFILE] [--read-timeout READ_TIMEOUT] [--azure-credential {azure-cli,managed-identity}] diff --git a/old_docs/barman-cloud-backup-list.1.md b/old_docs/barman-cloud-backup-list.1.md index 04ee124ce..dc5407e97 100644 --- a/old_docs/barman-cloud-backup-list.1.md +++ b/old_docs/barman-cloud-backup-list.1.md @@ -27,6 +27,7 @@ of PostgreSQL servers written in Python and maintained by EnterpriseDB. usage: barman-cloud-backup-list [-V] [--help] [-v | -q] [-t] [--cloud-provider {aws-s3,azure-blob-storage,google-cloud-storage}] [--endpoint-url ENDPOINT_URL] + [--aws-irsa] [-P AWS_PROFILE] [--profile AWS_PROFILE] [--read-timeout READ_TIMEOUT] [--azure-credential {azure-cli,managed-identity}] @@ -54,6 +55,8 @@ optional arguments: Extra options for the aws-s3 cloud provider: --endpoint-url ENDPOINT_URL Override default S3 endpoint URL with the given one + --aws-irsa + use iam role service account instead of aws profile (recommended if running from an aws service) -P AWS_PROFILE, --aws-profile AWS_PROFILE profile name (e.g. INI section in AWS credentials file) diff --git a/old_docs/barman-cloud-backup-show.1.md b/old_docs/barman-cloud-backup-show.1.md index f5b164b23..405a1a3e4 100644 --- a/old_docs/barman-cloud-backup-show.1.md +++ b/old_docs/barman-cloud-backup-show.1.md @@ -27,6 +27,7 @@ of PostgreSQL servers written in Python and maintained by EnterpriseDB. usage: barman-cloud-backup-show [-V] [--help] [-v | -q] [-t] [--cloud-provider {aws-s3,azure-blob-storage,google-cloud-storage}] [--endpoint-url ENDPOINT_URL] + [--aws-irsa] [-P AWS_PROFILE] [--profile AWS_PROFILE] [--read-timeout READ_TIMEOUT] [--azure-credential {azure-cli,managed-identity}] @@ -56,6 +57,8 @@ optional arguments: Extra options for the aws-s3 cloud provider: --endpoint-url ENDPOINT_URL Override default S3 endpoint URL with the given one + --aws-irsa + use iam role service account instead of aws profile (recommended if running from an aws service) -P AWS_PROFILE, --aws-profile AWS_PROFILE profile name (e.g. INI section in AWS credentials file) diff --git a/old_docs/barman-cloud-backup.1.md b/old_docs/barman-cloud-backup.1.md index 2e2e634ff..633854e2e 100644 --- a/old_docs/barman-cloud-backup.1.md +++ b/old_docs/barman-cloud-backup.1.md @@ -43,6 +43,7 @@ parameter. usage: barman-cloud-backup [-V] [--help] [-v | -q] [-t] [--cloud-provider {aws-s3,azure-blob-storage,google-cloud-storage}] [--endpoint-url ENDPOINT_URL] [-P AWS_PROFILE] + [--aws-irsa] [--profile AWS_PROFILE] [--read-timeout READ_TIMEOUT] [--azure-credential {azure-cli,managed-identity}] @@ -129,6 +130,8 @@ optional arguments: Extra options for the aws-s3 cloud provider: --endpoint-url ENDPOINT_URL Override default S3 endpoint URL with the given one + --aws-irsa + use iam role service account instead of aws profile (recommended if running from an aws service) -P AWS_PROFILE, --aws-profile AWS_PROFILE profile name (e.g. INI section in AWS credentials file) diff --git a/old_docs/barman-cloud-check-wal-archive.1.md b/old_docs/barman-cloud-check-wal-archive.1.md index b8accb3fd..429abb1e9 100644 --- a/old_docs/barman-cloud-check-wal-archive.1.md +++ b/old_docs/barman-cloud-check-wal-archive.1.md @@ -28,6 +28,7 @@ of PostgreSQL servers written in Python and maintained by EnterpriseDB. usage: barman-cloud-check-wal-archive [-V] [--help] [-v | -q] [-t] [--cloud-provider {aws-s3,azure-blob-storage,google-cloud-storage}] [--endpoint-url ENDPOINT_URL] + [--aws-irsa] [-P AWS_PROFILE] [--profile AWS_PROFILE] [--read-timeout READ_TIMEOUT] [--azure-credential {azure-cli,managed-identity}] @@ -56,6 +57,8 @@ optional arguments: Extra options for the aws-s3 cloud provider: --endpoint-url ENDPOINT_URL Override default S3 endpoint URL with the given one + --aws-irsa + use iam role service account instead of aws profile (recommended if running from an aws service) -P AWS_PROFILE, --aws-profile AWS_PROFILE profile name (e.g. INI section in AWS credentials file) diff --git a/old_docs/barman-cloud-restore.1.md b/old_docs/barman-cloud-restore.1.md index 0fc9d990a..992ffb1fa 100644 --- a/old_docs/barman-cloud-restore.1.md +++ b/old_docs/barman-cloud-restore.1.md @@ -31,6 +31,7 @@ of PostgreSQL servers written in Python and maintained by EnterpriseDB. usage: barman-cloud-restore [-V] [--help] [-v | -q] [-t] [--cloud-provider {aws-s3,azure-blob-storage,google-cloud-storage}] [--endpoint-url ENDPOINT_URL] [-P AWS_PROFILE] + [--aws-irsa] [--profile AWS_PROFILE] [--read-timeout READ_TIMEOUT] [--azure-credential {azure-cli,managed-identity}] @@ -72,6 +73,8 @@ optional arguments: Extra options for the aws-s3 cloud provider: --endpoint-url ENDPOINT_URL Override default S3 endpoint URL with the given one + --aws-irsa + use iam role service account instead of aws profile (recommended if running from an aws service) -P AWS_PROFILE, --aws-profile AWS_PROFILE profile name (e.g. INI section in AWS credentials file) diff --git a/old_docs/barman-cloud-wal-archive.1.md b/old_docs/barman-cloud-wal-archive.1.md index 04c5a166f..19e406bb1 100644 --- a/old_docs/barman-cloud-wal-archive.1.md +++ b/old_docs/barman-cloud-wal-archive.1.md @@ -32,6 +32,7 @@ of PostgreSQL servers written in Python and maintained by EnterpriseDB. usage: barman-cloud-wal-archive [-V] [--help] [-v | -q] [-t] [--cloud-provider {aws-s3,azure-blob-storage,google-cloud-storage}] [--endpoint-url ENDPOINT_URL] [-P AWS_PROFILE] + [--aws-irsa] [--profile AWS_PROFILE] [--read-timeout READ_TIMEOUT] [--azure-credential {azure-cli,managed-identity}] @@ -81,6 +82,8 @@ optional arguments: Extra options for the aws-s3 cloud provider: --endpoint-url ENDPOINT_URL Override default S3 endpoint URL with the given one + --aws-irsa + use iam role service account instead of aws profile (recommended if running from an aws service) -P AWS_PROFILE, --aws-profile AWS_PROFILE profile name (e.g. INI section in AWS credentials file) diff --git a/old_docs/barman-cloud-wal-restore.1.md b/old_docs/barman-cloud-wal-restore.1.md index a0fcc496c..19e8e5338 100644 --- a/old_docs/barman-cloud-wal-restore.1.md +++ b/old_docs/barman-cloud-wal-restore.1.md @@ -27,6 +27,7 @@ of PostgreSQL servers written in Python and maintained by EnterpriseDB. usage: barman-cloud-wal-restore [-V] [--help] [-v | -q] [-t] [--cloud-provider {aws-s3,azure-blob-storage,google-cloud-storage}] [--endpoint-url ENDPOINT_URL] [-P AWS_PROFILE] + [--aws-irsa] [--profile AWS_PROFILE] [--read-timeout READ_TIMEOUT] [--azure-credential {azure-cli,managed-identity}] @@ -59,6 +60,8 @@ optional arguments: Extra options for the aws-s3 cloud provider: --endpoint-url ENDPOINT_URL Override default S3 endpoint URL with the given one + --aws-irsa + use iam role service account instead of aws profile (recommended if running from an aws service) -P AWS_PROFILE, --aws-profile AWS_PROFILE profile name (e.g. INI section in AWS credentials file) diff --git a/old_docs/manual/28-snapshots.en.md b/old_docs/manual/28-snapshots.en.md index 326e8cb1e..8518c3090 100644 --- a/old_docs/manual/28-snapshots.en.md +++ b/old_docs/manual/28-snapshots.en.md @@ -156,10 +156,12 @@ The following optional parameters can be set when using AWS: ``` ini aws_region = AWS_REGION +; aws_irsa = will build using os environments AWS_ROLE_ARN & AWS_WEB_IDENTITY_TOKEN_FILE aws_profile = AWS_PROFILE_NAME aws_await_snapshots_timeout = TIMEOUT_IN_SECONDS ``` +If `aws_irsa` is used it will attempt to use the IAM role of the service account using AWS_ROLE_ARN and AWS_WEB_IDENTITY_TOKEN_FILE If `aws_profile` is used it should be set to the name of a section in the AWS credentials file. If `aws_profile` is not used then the default profile will be used. If no credentials file exists then credentials will be sourced from the environment. diff --git a/old_docs/manual/55-barman-cli.en.md b/old_docs/manual/55-barman-cli.en.md index a5df2a6cf..41f99ce32 100644 --- a/old_docs/manual/55-barman-cli.en.md +++ b/old_docs/manual/55-barman-cli.en.md @@ -226,6 +226,7 @@ If the `--cloud-provider` is `azure-blob-storage` then the following arguments a If the `--cloud-provider` is `aws-s3` then the following optional arguments can be used: +- `--aws-irsa` - `--aws-profile` - `--aws-region`