Skip to content

Commit

Permalink
more doc updates
Browse files Browse the repository at this point in the history
  • Loading branch information
zaro0508 committed Jan 5, 2024
1 parent 55f11e2 commit ffe5940
Show file tree
Hide file tree
Showing 2 changed files with 10 additions and 7 deletions.
4 changes: 2 additions & 2 deletions .github/workflows/main.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -6,9 +6,9 @@ on:

jobs:
deploy:
# self hosted runners are setup in github to match branch names
# self hosted runner labels are setup in github to match branch names
runs-on: [self-hosted, ${{ github.ref_name }}]
# context environment variables are setup in github to match branch names
# variables in context environments are setup in github to match branch names
environment:
name: ${{ github.ref_name }}

Expand Down
13 changes: 8 additions & 5 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,6 @@
# Overview
Agora Data Manager is a tool that loads the JSON files into Agora's document database instances in our AWS environments.
Agora Data Manager is a tool that loads the JSON files into Agora's document database
instances in our AWS environments.

# Purpose
This project allows Agora maintainers to update the Agora database with
Expand Down Expand Up @@ -55,12 +56,14 @@ Context specific secrets for each environment that corresponds to a git branch (

## Self hosted runners

[agora2-infra] repository deploys a bastian host in AWS for each environment which have
access to the databases. Then we associate those bastian hosts to [Github self-hosted runners].
The update is executed from these runners. Each runner corresponds to an environment which
corresponds to a git branch. When a push happens on a branch (i.e. develop), the update
[agora2-infra] repository deploys a bastian host in AWS for each environment which have access to
the databases. We manually configure a [Github self-hosted runner] for each bastian host,
a label is applied to each runner to match the corresponding deployment branch name (develop/staging/prod).
Each runner corresponds to an environment which corresponds to a git branch. The update is
executed from these runners. When a push happens on a branch (i.e. develop), the update
is executed on the `agora-bastian-develop` runner which in turn updates the development database.


![alt text][self_hosted_runners]


Expand Down

0 comments on commit ffe5940

Please sign in to comment.