From ffe5940fa536833190f290a006ec054eb162f92b Mon Sep 17 00:00:00 2001 From: Khai Do Date: Fri, 5 Jan 2024 09:22:47 -0800 Subject: [PATCH] more doc updates --- .github/workflows/main.yaml | 4 ++-- README.md | 13 ++++++++----- 2 files changed, 10 insertions(+), 7 deletions(-) diff --git a/.github/workflows/main.yaml b/.github/workflows/main.yaml index 7917e48..badadc5 100644 --- a/.github/workflows/main.yaml +++ b/.github/workflows/main.yaml @@ -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 }} diff --git a/README.md b/README.md index db79094..03ce22d 100644 --- a/README.md +++ b/README.md @@ -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 @@ -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]