Skip to content

Commit 3f973d9

Browse files
committed
DESENG-811: Update README.md for deployment instructions and fix typos
1 parent 5c98da3 commit 3f973d9

File tree

1 file changed

+32
-15
lines changed

1 file changed

+32
-15
lines changed

openshift/README.md

Lines changed: 32 additions & 15 deletions
Original file line numberDiff line numberDiff line change
@@ -125,7 +125,7 @@ To restore the backup follow these steps:
125125
psql -h localhost -d app -U postgres -p 5432 -a -q -f <path-to-file>
126126
```
127127

128-
**Note:** Should the restore fail due to roles not being found, the following psql commands can be ran from within the database pod to alter the roles
128+
**Note:** Should the restore fail due to roles not being found, the following psql commands can be run from within the database pod to alter the roles
129129

130130
```
131131
alter role met WITH LOGIN NOSUPERUSER NOCREATEDB NOCREATEROLE NOINHERIT NOREPLICATION
@@ -152,18 +152,27 @@ To restore the backup follow these steps:
152152
In each environment namespace (dev, test, prod) use the following
153153
IMAGE_TAG values of the following commands should also be changed to reflect the environment they will be installed to
154154

155-
Deploy the web application:
155+
**Deploy the `WEB` application**:
156156

157-
```
158-
oc process -f ./web.dc.yml \
159-
-p ENV=<dev/test/prod> \
160-
-p IMAGE_TAG=<dev/test/prod> \
161-
| oc create -f -
157+
> This deployment uses the helm chart located in the `openshift/web` folder.
158+
> Use one of dev, test or prod and the corresponding values.yaml file to deploy the web application.
159+
160+
```bash
161+
cd ./openshift/web
162+
### Dev
163+
oc project e903c2-dev
164+
helm upgrade --install met-web . --values values_dev.yaml
165+
### Test
166+
oc project e903c2-test
167+
helm upgrade --install met-web . --values values_test.yaml
168+
### Prod
169+
oc project e903c2-prod
170+
helm upgrade --install met-web . --values values_prod.yaml
162171
```
163172

164173
**Deploy the `API` application**:
165174

166-
> This deployment uses the helm chart located in the openshift/api folder.
175+
> This deployment uses the helm chart located in the `openshift/api` folder.
167176
> Use one of dev, test or prod and the corresponding values.yaml file to deploy the api application.
168177
169178
```bash
@@ -181,7 +190,7 @@ helm upgrade --install met-api . --values values_prod.yaml
181190

182191
Deploy the notify api application:
183192

184-
```
193+
```bash
185194
oc process -f ./notify-api.dc.yml \
186195
-p ENV=<dev/test/prod> \
187196
-p IMAGE_TAG=<dev/test/prod> \
@@ -192,7 +201,7 @@ oc process -f ./notify-api.dc.yml \
192201

193202
Deploy the cron job application:
194203

195-
```
204+
```bash
196205
oc process -f ./cron.dc.yml \
197206
-p ENV=<dev/test/prod> \
198207
-p IMAGE_TAG=<dev/test/prod> \
@@ -201,28 +210,36 @@ oc process -f ./cron.dc.yml \
201210
-p MET_ADMIN_CLIENT_SECRET=<SERVICE_ACCOUNT_SECRET> \
202211
-p NOTIFICATIONS_EMAIL_ENDPOINT=https://met-notify-api-test.apps.gold.devops.gov.bc.ca/api/v1/notifications/email \
203212
| oc create -f -
204-
205213
```
206214

207215
Deploy the analytics api
208216

209-
```
210-
217+
```bash
211218
oc process -f ./analytics-api.dc.yml \
212219
-p ENV=<dev/test/prod> \
213220
-p IMAGE_TAG=<dev/test/prod>
214221
| oc create -f -
215-
216222
```
217223

218224
Deploy the redash analytics helm chart:
219225

220-
```
226+
```bash
221227
cd redash
222228
helm dependency build
223229
helm install met-analytics ./ -f ./values.yaml --set redash.image.tag=test
224230
```
225231

232+
**Deploying the MET RBAC chart**:
233+
234+
> RBAC in this project is managed by the helm chart located in the `openshift/rbac` folder.
235+
> This chart determines its environment based on the namespace it is being deployed to.
236+
237+
Currently the chart creates the following:
238+
239+
1. **Vault Service Account RoleBinding**: This rolebinding allows the vault service account to pull images from the tools namespace.
240+
> The {licenseplate}-vault service account should be used on Deployments that need access to Vault.
241+
> In order for the Vault service account to be able to pull images from the tools namespace, this rolebinding must be created.
242+
226243
### Additional NetworkPolicies
227244

228245
Setting this ingress policy on all pods allows incoming connections from pods within the same environment (API pods can connect to the database pods):

0 commit comments

Comments
 (0)