Skip to content

Commit 50fbdf6

Browse files
committed
fix: Adjustment to README made
1 parent 01538e4 commit 50fbdf6

File tree

2 files changed

+30
-3
lines changed

2 files changed

+30
-3
lines changed

examples/dev/README.md

Lines changed: 27 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -77,13 +77,19 @@ This section describes how to deploy OpenCRVS using the provided GitHub Action w
7777

7878
Fork [opencrvs/infrastructure](https://github.com/opencrvs/infrastructure) into your own GitHub account or organization.
7979

80-
You will need to provide the following values while installation multiple times:
80+
You will need to provide the following values and answers to the following questions:
8181

8282
* GitHub organization or account name: `<your-org-or-account>`
8383
* GitHub repository name: `<your-repository>`
8484
* GitHub PAT (personal access token) with access to repository code and workflows: `<GH_TOKEN or dedicated token>`
85+
* Choose environment type, depending on answer additional questions will be asked.
8586
* Environment name: `<env name>`
87+
* Provide ip addresses for worker nodes and backup server
88+
* For production environment provide list of GutHub users allowed to approve production workflows.
89+
* Configure Email/SMS notifications for alerting
8690

91+
> [!NOTE]
92+
> OpenCRVS environment is provisioned with and deployed as Helm charts. Configuration files are created at first run of `yarn environment:init`, all further changes should be manually at `environments/<environment name>/` and `infrastructure/server-setup/inventory/`
8793
---
8894

8995
## 1. Create a GitHub environment
@@ -100,14 +106,33 @@ You will need to provide the following values while installation multiple times:
100106
```
101107
yarn environment:init
102108
```
109+
* Answer all questions, pay attention to the following items
110+
* On the final step you will get code snipped with command to be executed on servers (master, worker, backup), example:
111+
```
112+
━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━
113+
Follow the steps below to complete the setup of your environment:
114+
━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━
115+
➡️ Run following command on Kubernetes master VM to bootstrap self-hosted runner:
116+
117+
curl -sfL https://raw.githubusercontent.com/opencrvs/infrastructure/refs/heads/develop/scripts/bootstrap/opencrvs-bootstrap.sh -o opencrvs-bootstrap.sh && \
118+
bash opencrvs-bootstrap.sh --owner foo \
119+
--repo bar \
120+
--env demo \
121+
--token ghp_token \
122+
--enable-runner
123+
124+
125+
━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━
126+
```
127+
* Save generated snippet for later usage
103128
* Go to GitHub and verify the newly created environment
104129
* Commit configuration files generated at `infrastructure/server-setup/inventory/` and `environments/` into git
105130

106131
## 2. Bootstrap GitHub Self-Hosted Runner
107132

108133
The self-hosted runner must be installed on the single VM (master node). The VM must be provisioned with an SSH user account according to [Provision Your Server Nodes with SSH Access](https://documentation.opencrvs.org/setup/3.-installation/3.3-set-up-a-server-hosted-environment/3.3.1-provision-your-server-nodes-with-ssh-access).
109134

110-
> NOTE: On previous step environment configuration script left correct command as output.
135+
> NOTE: Use code snippet generated on previous step.
111136
112137
1. Login as user with sudo access or as root
113138

examples/localhost/README.md

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,5 @@
11
# Run OpenCRVS on localhost
22

3-
Please check Quickstart guide on how to deploy this environment: [see](../../charts/opencrvs-services/README.md#-quickstart)
3+
Available options to run OpenCRVS on localhost:
4+
- Quickstart guide on how to deploy this environment: [see](../../charts/opencrvs-services/README.md#-quickstart)
5+
- Use `tilt` (Tiltfile): [see](../../README.md#development-environment-setup)

0 commit comments

Comments
 (0)