add details on configuring genesis infrastructure using env

whiteblock · Jul 6, 2020 · 5ab9e89 · 5ab9e89
1 parent e89d0ac
commit 5ab9e89
Showing 1 changed file with 21 additions and 1 deletion.
diff --git a/_docs/running_on_your_infrastructure.md b/_docs/running_on_your_infrastructure.md
@@ -39,12 +39,32 @@ It will then ask you for the zone to build in, the image name (what you called i
 
 * Compute Instance Admin (v1)
 
+### CI/CD
+You can set the genesis cli to deploy to your gcp environment using these environment variables. They are required unless marked as optional. Note, if you don't set GCP_USE_ACCESS_TOKEN or GCP_SERVICE_ACCOUNT_KEY, genesis will attempt to use [google cloud default credentials](https://cloud.google.com/docs/authentication/production). 
+
+* GENESIS_PROVIDER : This needs to be set to "gcp" in order to use GCP
+* GCP_USE_ACCESS_TOKEN: (optional) Set this if you would like to use the access token generated from the `gcloud auth print-access-token`
+* GCP_SERVICE_ACCOUNT_KEY: (optional) Set this to the path to the service account key json file if you wish to authenticate using that service account details
+* GCP_ZONE : The zone in the GCP to deploy to
+* GCP_PROJECT : The project in GCP to deploy to
+* GCP_IMAGE : The Genesis Biome image created in the setup.
+* GCP_NETWORK : (Optional) The GCP network to run the instances inside. Defaults to the default network.
+* GCP_SUBNETWORK: (Optional) The GCP sub-network to run the instances inside. Defaults to the default network.
+
+
 ## AWS
 
 ### Getting Started
 Getting Started with AWS is super easy. 
 Simply run the command `genesis cloud`, select the aws provider, and then simply provide answers to the guided setup.
 
-#### Notice
+### CI/CD
+If you wish to configure AWS for your CI/CD platform, you can do so by setting these environment variables. 
+* GENESIS_PROVIDER : This needs to be set to "aws" in order to use AWS
+* AWS_REGION : The region in AWS to deploy to, for example us-east-2
+* AWS_ACCESS_KEY_ID : Your AWS access key id
+* AWS_SECRET_ACCESS_KEY : Your AWS secret access key
+
+### Notice
 AWS support is still considered experimental. There are many unstable features, and some features may not work in AWS. If you encounter any issues with the AWS implementation.