Skip to content

Commit 2e8042e

Browse files
terraform-docs: automated action
1 parent eaf6a61 commit 2e8042e

File tree

1 file changed

+56
-1
lines changed

1 file changed

+56
-1
lines changed

examples/complete/README.md

Lines changed: 56 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,32 @@
11
<!-- BEGIN_TF_DOCS -->
2+
## Prerequisites
3+
4+
Before using the Terraform configuration, ensure you have the following setup:
5+
6+
- **Application secrets stored in AWS SSM Parameter Store** with the following names and descriptions:
7+
- `/atlantis/ATLANTIS_GH_TOKEN`: A GitHub personal access token with repo and admin:repo\_hook permissions. Generate this from GitHub Developer settings.
8+
- `/atlantis/ATLANTIS_GH_WEBHOOK_SECRET`: The secret used to validate GitHub webhooks. Create a random secret string for this.
9+
- `/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.
10+
- `/atlantis/AWS_SECRET_ACCESS_KEY`: The AWS Secret Access Key for the same IAM user. Obtain this from AWS IAM user security credentials.
11+
- `/atlantis/ATLANTIS_GOOGLE_CLIENT_ID`: The Client ID for Google OAuth. Obtain this from Google Cloud Console.
12+
- `/atlantis/ATLANTIS_GOOGLE_CLIENT_SECRET`: The Client Secret for Google OAuth. Obtain this from Google Cloud Console.
13+
14+
- **Set up OAuth in the Google Cloud Console**:
15+
- **Authorized JavaScript origins**:
16+
- Use the value of `ATLANTIS_URL` from your `locals.tf`, defined as:
17+
```hcl
18+
ATLANTIS_URL = "https://${var.atlantis_url}"
19+
```
20+
- **Authorized redirect URIs**:
21+
- Use the value of `ATLANTIS_GOOGLE_REDIRECT_URI` from your `locals.tf`, defined as:
22+
```hcl
23+
ATLANTIS_GOOGLE_REDIRECT_URI = "https://${var.atlantis_url}/oauth2/idpresponse"
24+
```
225
326
## Example `tfvars` Configuration
427
28+
Here’s an example of how you can configure your `tfvars` file:
29+
530
```hcl
631
# Required Parameters
732
public_subnet_ids = ["subnet-xxxxxxxx", "subnet-xxxxxxxx"]
@@ -13,10 +38,40 @@ atlantis_repo_allowlist = ["repo1", "repo2"]
1338
1439
# Optional Parameters
1540
# thumbprint_list = ["oidc-thumbprint-1", "oidc-thumbprint-2"]
16-
# atlantis_docker_image = = "<your-custom-docker-image>"
41+
# atlantis_docker_image = "<your-custom-docker-image>"
1742
# ecs_cluster_name = "<your-ecs-cluster-name>"
1843
```
1944

45+
## Usage
46+
47+
To deploy the configuration, follow these steps:
48+
49+
1. **Initialize Terraform**:
50+
```sh
51+
terraform init
52+
```
53+
54+
2. **Plan the Deployment**:
55+
```sh
56+
terraform plan
57+
```
58+
59+
3. **Apply the Configuration**:
60+
```sh
61+
terraform apply
62+
```
63+
64+
4. **Clean Up Resources** (if needed):
65+
```sh
66+
terraform destroy
67+
```
68+
69+
Use this command to remove all resources created by this configuration when they are no longer needed.
70+
71+
**Note**: Be aware that applying this configuration may create resources that could incur charges on your AWS bill.
72+
73+
---
74+
2075
## Requirements
2176

2277
| Name | Version |

0 commit comments

Comments
 (0)