You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: examples/dev/README.md
+27-2Lines changed: 27 additions & 2 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -77,13 +77,19 @@ This section describes how to deploy OpenCRVS using the provided GitHub Action w
77
77
78
78
Fork [opencrvs/infrastructure](https://github.com/opencrvs/infrastructure) into your own GitHub account or organization.
79
79
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:
81
81
82
82
* GitHub organization or account name: `<your-org-or-account>`
83
83
* GitHub repository name: `<your-repository>`
84
84
* 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.
85
86
* 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
86
90
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/`
87
93
---
88
94
89
95
## 1. Create a GitHub environment
@@ -100,14 +106,33 @@ You will need to provide the following values while installation multiple times:
100
106
```
101
107
yarn environment:init
102
108
```
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:
* Go to GitHub and verify the newly created environment
104
129
* Commit configuration files generated at `infrastructure/server-setup/inventory/` and `environments/` into git
105
130
106
131
## 2. Bootstrap GitHub Self-Hosted Runner
107
132
108
133
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).
109
134
110
-
> NOTE: On previous step environment configuration script left correct command as output.
135
+
> NOTE: Use code snippet generated on previous step.
0 commit comments