You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: README.md
+14-5Lines changed: 14 additions & 5 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -90,7 +90,7 @@ What this module does not provision:
90
90
91
91
### GitHub Repo Scopes
92
92
93
-
This module accepts two GitHub tokens:
93
+
This module accepts two GitHub OAuth tokens:
94
94
95
95
1.`github_oauth_token` with permissions to pull private repos. Used by CodePipeline to clone repos before the build, and by the atlantis server to clone repos and comment on Pull Requests.
96
96
@@ -104,7 +104,6 @@ This module accepts two GitHub tokens:
104
104
105
105
2.`github_webhooks_token` with permissions to create GitHub webhooks.
106
106
Only used by [Terraform GitHub Provider](https://www.terraform.io/docs/providers/github/index.html) when provisioning the module.
107
-
It must be provided either in the `github_webhooks_token` variable, or it can also be sourced from the `GITHUB_TOKEN` environment variable.
108
107
109
108
The token needs the following OAuth scopes:
110
109
@@ -127,6 +126,15 @@ We suggest the following steps when creating the tokens and provisioning the mod
127
126
128
127
**IMPORTANT:** Do not commit the tokens to source control (_e.g._ via `terraform.tvfars`).
129
128
129
+
**NOTE:** If the two tokens are not provided (left empty), they will be looked up from SSM Parameter Store.
130
+
You can write `atlantis atlantis_gh` and `github_webhooks_token` to SSM Parameter Store before provisioning the module.
131
+
For example, by using [chamber](https://github.com/segmentio/chamber):
| ecs_cluster_arn | ARN of the ECS cluster to deploy Atlantis | string | - | yes |
261
269
| ecs_cluster_name | Name of the ECS cluster to deploy Atlantis | string | - | yes |
262
270
| enabled | Whether to create the resources. Set to `false` to prevent the module from creating any resources | string |`false`| no |
263
-
| github_oauth_token | GitHub Oauth token. If not provided the token is looked up from SSM. | string | `` | no |
264
-
| github_oauth_token_ssm_name | SSM param name to lookup GitHub OAuth token if not provided | string | `` | no |
265
-
| github_webhooks_token | GitHub OAuth Token with permissions to create webhooks. If not provided, can be sourced from the `GITHUB_TOKEN` environment variable | string | `` | no |
271
+
| github_oauth_token | GitHub OAuth token. If not provided the token is looked up from SSM | string | `` | no |
272
+
| github_oauth_token_ssm_name | SSM param name to lookup `github_oauth_token` if not provided | string | `` | no |
273
+
| github_webhooks_token | GitHub OAuth Token with permissions to create webhooks. If not provided the token is looked up from SSM | string | `` | no |
274
+
| github_webhooks_token_ssm_name | SSM param name to lookup `github_webhooks_token` if not provided | string | `` | no |
266
275
| healthcheck_path | Healthcheck path | string |`/healthz`| no |
267
276
| hostname | Atlantis URL | string | `` | no |
268
277
| kms_key_id | KMS key ID used to encrypt SSM SecureString parameters | string | `` | no |
Copy file name to clipboardExpand all lines: README.yaml
+10-2Lines changed: 10 additions & 2 deletions
Original file line number
Diff line number
Diff line change
@@ -111,7 +111,7 @@ introduction: |-
111
111
112
112
### GitHub Repo Scopes
113
113
114
-
This module accepts two GitHub tokens:
114
+
This module accepts two GitHub OAuth tokens:
115
115
116
116
1. `github_oauth_token` with permissions to pull private repos. Used by CodePipeline to clone repos before the build, and by the atlantis server to clone repos and comment on Pull Requests.
117
117
@@ -125,7 +125,6 @@ introduction: |-
125
125
126
126
2. `github_webhooks_token` with permissions to create GitHub webhooks.
127
127
Only used by [Terraform GitHub Provider](https://www.terraform.io/docs/providers/github/index.html) when provisioning the module.
128
-
It must be provided either in the `github_webhooks_token` variable, or it can also be sourced from the `GITHUB_TOKEN` environment variable.
129
128
130
129
The token needs the following OAuth scopes:
131
130
@@ -148,6 +147,15 @@ introduction: |-
148
147
149
148
**IMPORTANT:** Do not commit the tokens to source control (_e.g._ via `terraform.tvfars`).
150
149
150
+
**NOTE:** If the two tokens are not provided (left empty), they will be looked up from SSM Parameter Store.
151
+
You can write `atlantis atlantis_gh` and `github_webhooks_token` to SSM Parameter Store before provisioning the module.
152
+
For example, by using [chamber](https://github.com/segmentio/chamber):
Copy file name to clipboardExpand all lines: docs/terraform.md
+4-3Lines changed: 4 additions & 3 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -60,9 +60,10 @@
60
60
| ecs_cluster_arn | ARN of the ECS cluster to deploy Atlantis | string | - | yes |
61
61
| ecs_cluster_name | Name of the ECS cluster to deploy Atlantis | string | - | yes |
62
62
| enabled | Whether to create the resources. Set to `false` to prevent the module from creating any resources | string |`false`| no |
63
-
| github_oauth_token | GitHub Oauth token. If not provided the token is looked up from SSM. | string | `` | no |
64
-
| github_oauth_token_ssm_name | SSM param name to lookup GitHub OAuth token if not provided | string | `` | no |
65
-
| github_webhooks_token | GitHub OAuth Token with permissions to create webhooks. If not provided, can be sourced from the `GITHUB_TOKEN` environment variable | string | `` | no |
63
+
| github_oauth_token | GitHub OAuth token. If not provided the token is looked up from SSM | string | `` | no |
64
+
| github_oauth_token_ssm_name | SSM param name to lookup `github_oauth_token` if not provided | string | `` | no |
65
+
| github_webhooks_token | GitHub OAuth Token with permissions to create webhooks. If not provided the token is looked up from SSM | string | `` | no |
66
+
| github_webhooks_token_ssm_name | SSM param name to lookup `github_webhooks_token` if not provided | string | `` | no |
66
67
| healthcheck_path | Healthcheck path | string |`/healthz`| no |
67
68
| hostname | Atlantis URL | string | `` | no |
68
69
| kms_key_id | KMS key ID used to encrypt SSM SecureString parameters | string | `` | no |
0 commit comments