Skip to content

Commit

Permalink
[IT-1914] Add documentation for required vars (#69)
Browse files Browse the repository at this point in the history
  • Loading branch information
@zaro0508
zaro0508 authored Aug 23, 2022
1 parent 46f7d55 commit d70c57a
Showing 1 changed file with 17 additions and 0 deletions.
17 changes: 17 additions & 0 deletions README.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -21,5 +21,22 @@ To deploy an updated data version to the Agora development database
To deploy an updated data version to the staging and prod database.
1. Merge data-version update to staging and prod branches.

# Setup

The following environment variables need to be setup for the scripts to deploy database updates:

| Variable | Description | Example |
|----------------------|-----------------------------------|---------------------------------------------------------------------------|
| BASTIAN_HOST_develop | The bastian host | ec2-10-11-12-13.compute-1.amazonaws.com |
| DB_HOST_develop | The database host | dbcluster-mr0a782pfjnk.cluster-ctcayu3de2lt.us-east-1.docdb.amazonaws.com |
| DB_USER_develop | The database user | dbuser |
| DB_PASS_develop | The database password | supersecret |
| SYNAPSE_USERNAME | The Synapse service user | syn-service-user |
| SYNAPSE_PASSWORD | The Synapse service user password | supersecret |

__Note__: The variables containing `_develop` postfix corresponds to the branch.
To deploy to a prod environment a prod branch is require along with a variable
containing a `_prod` prefix (i.e. BASTIAN_HOST_prod)


[db_update]: diagram1.png "update diagram"

0 comments on commit d70c57a

Please sign in to comment.