Skip to content

Commit

Permalink
chore: update docs
Browse files Browse the repository at this point in the history
  • Loading branch information
tshuli committed Dec 2, 2021
1 parent 590d173 commit 8798367
Show file tree
Hide file tree
Showing 4 changed files with 17 additions and 23 deletions.
4 changes: 2 additions & 2 deletions .github/mergify.yml
Original file line number Diff line number Diff line change
Expand Up @@ -11,7 +11,7 @@ pull_request_rules:
- check-success~=CodeQL # CodeQL code scanning results
- check-success~=GitGuardian
- check-success~=Semantic Pull Request
- check-success~=Travis CI - Branch
- check-success~=build_deploy_application
- check-success~=coverage/coveralls
- check-success~=license/snyk
- check-success~=security/snyk
Expand All @@ -32,7 +32,7 @@ pull_request_rules:
- check-success~=CodeQL # CodeQL code scanning results
- check-success~=GitGuardian
- check-success~=Semantic Pull Request
- check-success~=Travis CI - Branch
- check-success~=build_deploy_application
- check-success~=coverage/coveralls
- check-success~=license/snyk
- check-success~=security/snyk
Expand Down
2 changes: 1 addition & 1 deletion .github/workflows/deploy-eb.yml
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
name: Deploy to AWS Elastic Beanstalk
on:
push:
branches:
branches: # There should be 4 environments in github actions secrets: release, staging, staging-alt, uat. This is different from the DEPLOY_ENV secret which corresponds to elastic beanstalk environment name
- release
- staging
- staging-alt
Expand Down
2 changes: 1 addition & 1 deletion README.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
# FormSG

[![Build Status](https://travis-ci.com/opengovsg/formsg.svg?branch=release)](https://travis-ci.com/opengovsg/formsg)
[![Build Status](https://github.com/opengovsg/FormSG/actions/workflows/deploy-eb.yml)](https://github.com/opengovsg/FormSG/actions/workflows/deploy-eb.yml)
[![Coverage Status](https://coveralls.io/repos/github/opengovsg/FormSG/badge.svg?branch=develop)](https://coveralls.io/github/opengovsg/FormSG?branch=develop)

## Table of Contents
Expand Down
32 changes: 13 additions & 19 deletions docs/DEPLOYMENT_SETUP.md
Original file line number Diff line number Diff line change
Expand Up @@ -23,7 +23,7 @@ Infrastructure

DevOps

- TravisCI for running tests and builds
- Github Actions for running tests and builds
- AWS Elastic Container Registry to host built Docker images

Network
Expand Down Expand Up @@ -76,33 +76,27 @@ Secondly, edit the form document belonging to that specific form adminstrator by

If no `msgSrvcName` is found in the form document, SMSes associated with that form will be sent out using and charged to the default Twilio API credentials.

### Travis CI/CD environment variables
### Github Actions Secrets

For more information about the various environment variables, please refer to
[Travis documentation](https://docs.travis-ci.com/user/deployment/elasticbeanstalk/).

The following env variables are set in Travis:
| Variable | Description|
The following repository secrets are set in Github Actions:
| Secret | Description|
|:---------|------------|
|`REPO`|The repository of the AWS Elastic Container Registry|
|`STAGING_BRANCH`|Name of staging branch, usually `master`.|
|`STAGING_ALT_BRANCH`|Name of staging-alt (if any) branch, usually `release`. An alternate staging branch is used to host diverging feature sets, useful for A/B testing.|
|`PROD_BRANCH`|Name of production branch, usually `release`.|
|`AWS_ACCESS_KEY_ID`|AWS IAM access key ID used to deploy.|
|`AWS_SECRET_ACCESS_KEY`|AWS IAM access secret used to deploy.|
|`AWS_REGION`|AWS region to use.|
|`PROD_APP_NAME`|The names of the deployed docker application for the production application on AWS as determined by `PROD_BRANCH`.|
|`STAGING_APP_NAME`|The names of the deployed docker application for the staging application on AWS as determined by `STAGING_BRANCH`.|
|`PROD_BUCKET_NAME`|Bucket name to upload the code of the production app to. Elastic Beanstalk will create and deploy an application version from the source bundle in this Amazon S3 bucket.|
|`STAGING_BUCKET_NAME`|Bucket name to upload the code of the staging app to. Elastic Beanstalk will create and deploy an application version from the source bundle in this Amazon S3 bucket.|
|`PROD_DEPLOY_ENV`|The name of the Elastic Beanstalk environment the production application will be deployed to.|
|`STAGING_DEPLOY_ENV`|The name of the Elastic Beanstalk environment the staging application will be deployed to.|
|`STAGING_ALT_DEPLOY_ENV`|The name of the Elastic Beanstalk environment the staging-alt application will be deployed to.|
|`AWS_DEFAULT_REGION`|AWS region to use.|
|`ECR_REPO`|ECR Repository which stores the docker images.|
|`BUCKET_NAME`| S3 Bucket used to store zipped `Dockerrun.aws.json`.|
|`SENTRY_ORG`|Organisation that source-maps should be linked to on sentry dashboard.|
|`SENTRY_AUTH_TOKEN`|Authentication token used by sentry cli to authenticate with sentry service.|
|`SENTRY_PROJECT`|Project that source-maps should be linked to on sentry dashboard.|
|`SENTRY_URL`|Sentry service that source-maps should be pushed to.|

There are also environment secrets for each environment (`staging`, `staging-alt`, `release`, `uat`):
| Secret | Description|
|:---------|------------|
|`APP_NAME`|Application name for the environment.|
|`DEPLOY_ENV`|Deployment environment on elastic beanstalk.|

## Environment Variables

These are configured by creating groups of environment variables formatted like `.env` files in the Parameter
Expand Down

0 comments on commit 8798367

Please sign in to comment.