Skip to content

Commit

Permalink
docs(aws): dual-region setup in AWS (#3430)
Browse files Browse the repository at this point in the history
* docs(aws): add dual-region setup

* docs(aws): additions to the dual-region setup

* docs(aws): switch to tabs and collapsables for dual-region

* docs(aws): further adjustments to the dual-region

* style(formatting): initial technical review

* docs(aws): pull request adjustments

pre-cloning setup

* docs(aws): dual-region switch to git clone

* docs(aws): pull request adjustments

* docs(aws): remove tabs and simplify with more scripts

* docs(aws): use new folder path

* docs(aws): implement pr suggestions

* small tweak

---------

Co-authored-by: Christina Ausley <[email protected]>
  • Loading branch information
Langleu and christinaausley committed Mar 27, 2024
1 parent 64fbfcd commit 8135940
Show file tree
Hide file tree
Showing 6 changed files with 621 additions and 6 deletions.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.

Large diffs are not rendered by default.

Original file line number Diff line number Diff line change
Expand Up @@ -86,19 +86,21 @@ The [AWS Terraform provider](https://registry.terraform.io/providers/hashicorp/a
There are several ways to authenticate the `AWS` provider.

- (Recommended) Use the [AWS CLI](https://docs.aws.amazon.com/cli/latest/userguide/cli-chap-getting-started.html) to configure access. Terraform will automatically default to AWS CLI configuration when present.
- Set environment variables `AWS_ACCESS_KEY_ID` and `AWS_SECRET_ACCESS_KEY`, where the `key` and `id` can be retrieved from the [AWS Console](https://docs.aws.amazon.com/IAM/latest/UserGuide/id_credentials_access-keys.html).
- Set environment variables `AWS_ACCESS_KEY_ID` and `AWS_SECRET_ACCESS_KEY`, which can be retrieved from the [AWS Console](https://docs.aws.amazon.com/IAM/latest/UserGuide/id_credentials_access-keys.html).

:::

:::warning

Do not use secrets in your configuration files.
Do not store sensitive information (credentials) in your Terraform files.

:::

:::warning

The user who creates the resources will always be the owner. This means the user will always have admin access to the Kubernetes cluster until you delete it. Therefore, it can make sense to create an extra [AWS IAM user](https://docs.aws.amazon.com/IAM/latest/UserGuide/id_users.html) that's solely used for Terraform purposes.
A user who creates resources in AWS will therefore own these resources. In this particular case, the user will always have admin access to the Kubernetes cluster until the cluster is deleted.

Therefore, it can make sense to create an extra [AWS IAM user](https://docs.aws.amazon.com/IAM/latest/UserGuide/id_users.html) which credentials are used for Terraform purposes.

:::

Expand Down
4 changes: 4 additions & 0 deletions optimize_sidebars.js
Original file line number Diff line number Diff line change
Expand Up @@ -1787,6 +1787,10 @@ module.exports = {
"Install Camunda 8 on an EKS cluster",
"self-managed/platform-deployment/helm-kubernetes/platforms/amazon-eks/eks-helm/"
),
docsLink(
"Dual-region setup",
"self-managed/platform-deployment/helm-kubernetes/platforms/amazon-eks/dual-region/"
),
docsLink(
"IAM roles for service accounts",
"self-managed/platform-deployment/helm-kubernetes/platforms/amazon-eks/irsa/"
Expand Down
1 change: 1 addition & 0 deletions sidebars.js
Original file line number Diff line number Diff line change
Expand Up @@ -824,6 +824,7 @@ module.exports = {
"self-managed/platform-deployment/helm-kubernetes/platforms/amazon-eks/eks-eksctl",
"self-managed/platform-deployment/helm-kubernetes/platforms/amazon-eks/eks-terraform",
"self-managed/platform-deployment/helm-kubernetes/platforms/amazon-eks/eks-helm",
"self-managed/platform-deployment/helm-kubernetes/platforms/amazon-eks/dual-region",
"self-managed/platform-deployment/helm-kubernetes/platforms/amazon-eks/irsa",
],
},
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -86,19 +86,21 @@ The [AWS Terraform provider](https://registry.terraform.io/providers/hashicorp/a
There are several ways to authenticate the `AWS` provider.

- (Recommended) Use the [AWS CLI](https://docs.aws.amazon.com/cli/latest/userguide/cli-chap-getting-started.html) to configure access. Terraform will automatically default to AWS CLI configuration when present.
- Set environment variables `AWS_ACCESS_KEY_ID` and `AWS_SECRET_ACCESS_KEY`, where the `key` and `id` can be retrieved from the [AWS Console](https://docs.aws.amazon.com/IAM/latest/UserGuide/id_credentials_access-keys.html).
- Set environment variables `AWS_ACCESS_KEY_ID` and `AWS_SECRET_ACCESS_KEY`, which can be retrieved from the [AWS Console](https://docs.aws.amazon.com/IAM/latest/UserGuide/id_credentials_access-keys.html).

:::

:::warning

Do not use secrets in your configuration files.
Do not store sensitive information (credentials) in your Terraform files.

:::

:::warning

The user who creates the resources will always be the owner. This means the user will always have admin access to the Kubernetes cluster until you delete it. Therefore, it can make sense to create an extra [AWS IAM user](https://docs.aws.amazon.com/IAM/latest/UserGuide/id_users.html) that's solely used for Terraform purposes.
A user who creates resources in AWS will therefore own these resources. In this particular case, the user will always have admin access to the Kubernetes cluster until the cluster is deleted.

Therefore, it can make sense to create an extra [AWS IAM user](https://docs.aws.amazon.com/IAM/latest/UserGuide/id_users.html) which credentials are used for Terraform purposes.

:::

Expand Down

0 comments on commit 8135940

Please sign in to comment.