Skip to content

Commit bbf3f3f

Browse files
committed
fix: discription of outdated docs in examples and root module
1 parent bb8fd14 commit bbf3f3f

File tree

2 files changed

+56
-24
lines changed

2 files changed

+56
-24
lines changed

.header.md

Lines changed: 0 additions & 23 deletions
Original file line numberDiff line numberDiff line change
@@ -9,26 +9,3 @@ This Terraform module automates the deployment of the Atlantis server on an ECS
99
![Atlantis](https://github.com/user-attachments/assets/f438c7af-9aee-415e-93a4-a1bb5a9f6c0e)
1010

1111
---
12-
13-
## Prerequisites
14-
15-
- Application secrets stored in AWS SSM Parameter Store with the following names and descriptions:
16-
- `/atlantis/ATLANTIS_GH_TOKEN`: A GitHub personal access token with repo and admin:repo_hook permissions. Generate this from GitHub Developer settings.
17-
- `/atlantis/ATLANTIS_GH_WEBHOOK_SECRET`: The secret used to validate GitHub webhooks. Create a random secret string for this.
18-
- `/atlantis/AWS_ACCESS_KEY_ID`: The AWS Access Key ID for an IAM user with necessary permissions. Obtain this from AWS IAM user security credentials.
19-
- `/atlantis/AWS_SECRET_ACCESS_KEY`: The AWS Secret Access Key for the same IAM user. Obtain this from AWS IAM user security credentials.
20-
- `/atlantis/ATLANTIS_GOOGLE_CLIENT_ID`: The Client ID for Google OAuth. Obtain this from Google Cloud Console.
21-
- `/atlantis/ATLANTIS_GOOGLE_CLIENT_SECRET`: The Client Secret for Google OAuth. Obtain this from Google Cloud Console.
22-
23-
- Set up the following in the Google Cloud Console for the OAuth consent screen:
24-
- **Authorized JavaScript origins**:
25-
- Use the value of `ATLANTIS_URL` from your `locals.tf`, which is defined as:
26-
```hcl
27-
ATLANTIS_URL = "https://${local.atlantis_url}"
28-
```
29-
30-
- **Authorized redirect URIs**:
31-
- Use the value of `ATLANTIS_GOOGLE_REDIRECT_URI` from your `locals.tf`, which is defined as:
32-
```hcl
33-
ATLANTIS_GOOGLE_REDIRECT_URI = "https://${local.atlantis_url}/oauth2/idpresponse"
34-
```

examples/complete/.header.md

Lines changed: 56 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,31 @@
1+
## Prerequisites
2+
3+
Before using the Terraform configuration, ensure you have the following setup:
4+
5+
- **Application secrets stored in AWS SSM Parameter Store** with the following names and descriptions:
6+
- `/atlantis/ATLANTIS_GH_TOKEN`: A GitHub personal access token with repo and admin:repo_hook permissions. Generate this from GitHub Developer settings.
7+
- `/atlantis/ATLANTIS_GH_WEBHOOK_SECRET`: The secret used to validate GitHub webhooks. Create a random secret string for this.
8+
- `/atlantis/AWS_ACCESS_KEY_ID`: The AWS Access Key ID for an IAM user with necessary permissions. Obtain this from AWS IAM user security credentials.
9+
- `/atlantis/AWS_SECRET_ACCESS_KEY`: The AWS Secret Access Key for the same IAM user. Obtain this from AWS IAM user security credentials.
10+
- `/atlantis/ATLANTIS_GOOGLE_CLIENT_ID`: The Client ID for Google OAuth. Obtain this from Google Cloud Console.
11+
- `/atlantis/ATLANTIS_GOOGLE_CLIENT_SECRET`: The Client Secret for Google OAuth. Obtain this from Google Cloud Console.
12+
13+
- **Set up OAuth in the Google Cloud Console**:
14+
- **Authorized JavaScript origins**:
15+
- Use the value of `ATLANTIS_URL` from your `locals.tf`, defined as:
16+
```hcl
17+
ATLANTIS_URL = "https://${var.atlantis_url}"
18+
```
19+
- **Authorized redirect URIs**:
20+
- Use the value of `ATLANTIS_GOOGLE_REDIRECT_URI` from your `locals.tf`, defined as:
21+
```hcl
22+
ATLANTIS_GOOGLE_REDIRECT_URI = "https://${var.atlantis_url}/oauth2/idpresponse"
23+
```
124
225
## Example `tfvars` Configuration
326
27+
Here’s an example of how you can configure your `tfvars` file:
28+
429
```hcl
530
# Required Parameters
631
public_subnet_ids = ["subnet-xxxxxxxx", "subnet-xxxxxxxx"]
@@ -12,6 +37,36 @@ atlantis_repo_allowlist = ["repo1", "repo2"]
1237
1338
# Optional Parameters
1439
# thumbprint_list = ["oidc-thumbprint-1", "oidc-thumbprint-2"]
15-
# atlantis_docker_image = = "<your-custom-docker-image>"
40+
# atlantis_docker_image = "<your-custom-docker-image>"
1641
# ecs_cluster_name = "<your-ecs-cluster-name>"
1742
```
43+
44+
## Usage
45+
46+
To deploy the configuration, follow these steps:
47+
48+
1. **Initialize Terraform**:
49+
```sh
50+
terraform init
51+
```
52+
53+
2. **Plan the Deployment**:
54+
```sh
55+
terraform plan
56+
```
57+
58+
3. **Apply the Configuration**:
59+
```sh
60+
terraform apply
61+
```
62+
63+
4. **Clean Up Resources** (if needed):
64+
```sh
65+
terraform destroy
66+
```
67+
68+
Use this command to remove all resources created by this configuration when they are no longer needed.
69+
70+
**Note**: Be aware that applying this configuration may create resources that could incur charges on your AWS bill.
71+
72+
---

0 commit comments

Comments
 (0)