Repository files navigation

This repository, under the umbrella of Project Cognoma(https://github.com/cognoma), holds the source code, under open sourcelicense, of the Terraform configuration files used to manage the infrastructurefor the backend of the Project Cognoma.

Make sure to forkthis repository onGitHub first.

This project directly interacts with the Greene Lab AWS account. To be ableto make any modifications using Terraform you will need to:

1. Be invited to the account.
2. Receive an AWS access key and secret key.

If you would like to contribute to this sub-project but do not have access tothe Greene Lab AWS account please contact @dhimmel.

Terraform is a way of encoding infrastructureconfigurations into code. This project has been tested with version 0.9.1 ofTerraform. Before contributing to this repository you should have Terraforminstalledandunderstand the basics.

Terraform will be expecting your AWS credentials to be stored in theenvironment variablesAWS_ACCESS_KEY_ID andAWS_SECRET_ACCESS_KEY.

For example you can run Terraform like:

AWS_ACCESS_KEY_ID=<your_access_key> AWS_SECRET_ACCESS_KEY=<your_secret_key> terraform apply

or you can just add them to your terminal's environment like so:

export AWS_ACCESS_KEY_ID=<your_access_key>export AWS_SECRET_ACCESS_KEY=<your_secret_key>

and runterraform apply. Adding those lines to your .bashrc will mean younever have to export them again.

Git Crypt is a tool which encryptscertain files as they are pushed to Github.In order to be able to unlock files you will need to send your GPG key to anexisting user and have them add you to git-crypt with

git-crypt add-gpg-user USERID

They'll need to commit that change to the project. Once they have done so youshould re-pull the project and can then decrypt all encrypted files with:

git-crypt unlock

To encrypt a new file or all files matching a pattern add a line like

<PATTERN> filter=git-crypt diff=git-crypt

to the .gitattributes file and commit that .gitattributes file BEFOREcommiting the file you want to encrypt.

Once all of the prerequisites have been met, development can follow the standardTerraform flow of:

1. Runterraform plan.
2. Inspect output.
3. Runterraform apply.
4. Correct any errors and repeat.