From 83f6c7f44f6873862fd35ec9d75b0e296de724af Mon Sep 17 00:00:00 2001 From: Mathieu Cloutier Date: Tue, 25 Mar 2025 12:51:38 -0600 Subject: [PATCH 1/2] improve replicator doc --- .../user-guide/tools/aws-replicator/index.md | 27 +++++++++++-------- 1 file changed, 16 insertions(+), 11 deletions(-) diff --git a/content/en/user-guide/tools/aws-replicator/index.md b/content/en/user-guide/tools/aws-replicator/index.md index 010e4eba5b..20841bab7d 100644 --- a/content/en/user-guide/tools/aws-replicator/index.md +++ b/content/en/user-guide/tools/aws-replicator/index.md @@ -37,25 +37,26 @@ These operations can be limited by creating a minimal IAM role with just the pol See the [supported resources section](#supported-resources) for details of what policy actions are required for each resource. -Replication is triggered using the LocalStack CLI, which must run in a shell configured to access AWS. +When the replication is triggered using the LocalStack CLI, which must run in a shell configured to access AWS. + +**Using the aws-cli v2** + If you have the aws-cli v2 installed, the cli will read credentials from your configured `AWS_PROFILE`. -Otherwise, the following environment variables must be set: +{{< command >}} +$ export AWS_PROFILE=my-aws-profile +$ localstack replicator ... +{{< /command >}} + +**Using the aws-cli v1 or no aws-cli** + +If you have the aws-cli v1 installed or no installation of the aws-cli, the following environment variables must be set: - `AWS_ACCESS_KEY_ID` - `AWS_SECRET_ACCESS_KEY` - `AWS_SESSION_TOKEN` (optional) - `AWS_DEFAULT_REGION` -{{< callout "tip" >}} -Use `aws configure export-credentials --format env` to print the required environment variables in a format that can be evaluated. - -{{< command >}} -$ eval $(AWS_PROFILE= aws configure export-credentials \ - --format env) -{{< /command >}} -{{< /callout >}} - ### Trigger a replication job Replication jobs can be triggered using the LocalStack CLI or an HTTP API. @@ -306,6 +307,10 @@ Use the `--target-account-id` flag to specify a different account. ## Supported Resources +The project is still in preview state and we welcome feedback and bug reports. +We have opened a [github issue where you can request and upvote](https://github.com/localstack/localstack/issues/12439) to help us prioritize our efforts and support the resources with the most impact. +For any other requests or reports, please open a [new github issue](https://github.com/localstack/localstack/issues/new/choose). + {{< callout "tip" >}} To ensure support for all resources, use the latest LocalStack Docker image. {{< /callout >}} From c212f993e71df12d59e797ed3e648bcc095ade53 Mon Sep 17 00:00:00 2001 From: Harsh Mishra Date: Thu, 3 Apr 2025 23:36:43 +0530 Subject: [PATCH 2/2] format something --- .../user-guide/tools/aws-replicator/index.md | 18 +++++++++++++----- 1 file changed, 13 insertions(+), 5 deletions(-) diff --git a/content/en/user-guide/tools/aws-replicator/index.md b/content/en/user-guide/tools/aws-replicator/index.md index 20841bab7d..fb0709f997 100644 --- a/content/en/user-guide/tools/aws-replicator/index.md +++ b/content/en/user-guide/tools/aws-replicator/index.md @@ -38,24 +38,32 @@ These operations can be limited by creating a minimal IAM role with just the pol See the [supported resources section](#supported-resources) for details of what policy actions are required for each resource. When the replication is triggered using the LocalStack CLI, which must run in a shell configured to access AWS. +Here are some options: -**Using the aws-cli v2** +{{< tabpane text=true >}} +{{< tab header="AWS CLI v2" >}} +{{% markdown %}} -If you have the aws-cli v2 installed, the cli will read credentials from your configured `AWS_PROFILE`. +If you have the AWS CLI v2 installed, the CLI will read credentials from your configured `AWS_PROFILE`. {{< command >}} $ export AWS_PROFILE=my-aws-profile $ localstack replicator ... {{< /command >}} -**Using the aws-cli v1 or no aws-cli** - -If you have the aws-cli v1 installed or no installation of the aws-cli, the following environment variables must be set: +{{% /markdown %}} +{{< /tab >}} +{{< tab header="AWS CLI v1" >}} +{{% markdown %}} +If you have the AWS CLI v1 installed or no installation of the AWS CLI, the following environment variables must be set: - `AWS_ACCESS_KEY_ID` - `AWS_SECRET_ACCESS_KEY` - `AWS_SESSION_TOKEN` (optional) - `AWS_DEFAULT_REGION` +{{% /markdown %}} +{{< /tab >}} +{{< /tabpane >}} ### Trigger a replication job