|
@@ -1,6 +1,6 @@
|
|
|
-# How to Use this Module
|
|
|
+ How to Use this Module
|
|
|
|
|
|
-This module is where the CodeBuild artifacts are created. It uses the Terraform GitHub Provider and requires a Personal Access Token. This should be your Personal Access Token not mdr-aws-codebuild's token. The provider will look in the environmental variables for the token.
|
|
|
+This module is where the CodeBuild artifacts are created. It uses the Terraform GitHub Provider and requires a Personal Access Token. This should be your Personal Access Token not mdr-aws-codebuild's token (see how-to below). The provider will look in the environmental variables for the token.
|
|
|
|
|
|
```
|
|
|
export GITHUB_TOKEN=<gihub_token>
|
|
@@ -13,3 +13,10 @@ This module should NOT create the github repo. That is a manual process. I am no
|
|
|
AWS CodeBuild needs a Github Personal Access Token to pull code after the code in a repository has been updated. Terraform is capable of storing the Github Personal Access Token, but that is a bad idea. A better idea is a service account in Github that gives CodeBuild access to specific repositories. This user will need access to repositories in different organizations. The login credentials as well as the Personal Access Token for mdr-aws-codebuild are stored in Vault.
|
|
|
|
|
|
The service account (mdr-aws-codebuild) needs to have a personal access token manually placed into the aws console.
|
|
|
+
|
|
|
+## Creating a Personal Access Token
|
|
|
+
|
|
|
+1) In github, go to `settings->Developer Settings->Personal Access Tokens`
|
|
|
+2) Click 'Generate Token'
|
|
|
+3) Give it a name (e.g. `terragrunt`)
|
|
|
+4) TBD.. which permissions are needed?
|