#1717 - Segregate db migrations deployment - Part 1 #1932
+610
−110
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
|
|
@@ -25,6 +25,7 @@ export QUEUE_CONSUMERS_PORT := $(or ${QUEUE_CONSUMERS_PORT}, 7000) | |
| export WEB_PORT := $(or ${WEB_PORT}, 3030) | ||
| export DATABASE_NAME_KEY := $(or ${DATABASE_NAME_KEY}, database-name) | ||
| export DB_NAME := $(or ${DB_NAME}, SIMSDB) | ||
| export DB_MIGRATIONS_BUILD_REF := $(or ${DB_MIGRATIONS_BUILD_REF}, db-migrations-${APP_NAME}) | ||
| export API_BUILD_REF := $(or ${API_BUILD_REF}, api-${APP_NAME}) | ||
| export WORKERS_BUILD_REF := $(or ${WORKERS_BUILD_REF}, workers-${APP_NAME}) | ||
| export QUEUE_CONSUMERS_BUILD_REF := $(or ${QUEUE_CONSUMERS_BUILD_REF}, queue-consumers-${APP_NAME}) | ||
|
|
@@ -34,6 +35,17 @@ export FORMIO_ROOT_EMAIL := $(or ${FORMIO_ROOT_EMAIL}, [email protected]) | |
| export MONGODB_URI := $(or ${MONGODB_URI}, $$MONGODB_URI) | ||
| export QUEUE_PREFIX := $(or $(QUEUE_PREFIX), {sims-local}) | ||
|
|
||
| export MAX_WAIT=300 # Maximum wait time in seconds | ||
|
There was a problem hiding this comment. There was a problem hiding this comment. No this variable is used to check whether the dbmigration job is completed within the specified time |
||
| export WAIT_TIME=0 # Initialize wait time to zero | ||
|
|
||
| define DB_MIGRATIONS | ||
| "$(HOST_PREFIX)db-migrations-$(APP_NAME)" | ||
| endef | ||
|
|
||
| define DB_MIGRATIONS_JOB_NAME | ||
| "db.migrations" | ||
| endef | ||
|
|
||
| define API | ||
| "$(HOST_PREFIX)api-$(APP_NAME)" | ||
| endef | ||
|
|
@@ -114,6 +126,8 @@ endef | |
| init-oc: | print-status init-project | ||
| oc-build-patroni: | print-status build-patroni | ||
| oc-deploy-patroni: | print-status deploy-patroni | ||
| oc-build-db-migrations: | print-status build-db-migrations | ||
| oc-run-db-migrations: | print-status run-db-migrations wait-for-db-migrations delete-db-migrations | ||
| oc-build-api: | print-status build-api | ||
| oc-deploy-api: | print-status deploy-api | ||
| oc-build-workers: | print-status build-workers | ||
|
|
@@ -221,6 +235,14 @@ init-artifactory-secret-credential: | |
| @oc secrets link default artifactory-secret-credential | ||
| @oc secrets link builder artifactory-secret-credential | ||
|
|
||
| build-db-migrations: | ||
| test -n "$(BUILD_NAMESPACE)" | ||
| test -n "$(BUILD_REF)" | ||
| test -n "$(DB_MIGRATIONS_BUILD_REF)" | ||
| @echo "+\n++ BUILDING DB migrations with tag: $(BUILD_REF)\n+" | ||
| @oc -n $(BUILD_NAMESPACE) process -f $(BUILD_TEMPLATE_PATH) -p TAG=$(BUILD_REF) -p SOURCE_REPOSITORY_REF=$(BUILD_REF) -p BASE_IMAGE_NAME="nodejs-16" -p BASE_IMAGE_TAG="1" -p BASE_IMAGE_REPO="artifacts.developer.gov.bc.ca/redhat-docker-remote/ubi8/" -p SOURCE_CONTEXT_DIR=$(SOURCE_CONTEXT_DIR)backend -p DOCKER_FILE_PATH=apps/db-migrations/Dockerfile -p NAME=$(DB_MIGRATIONS_BUILD_REF) | oc -n $(BUILD_NAMESPACE) apply -f - | ||
| @oc -n $(BUILD_NAMESPACE) start-build bc/$(DB_MIGRATIONS_BUILD_REF) --wait | ||
|
|
||
| build-api: | ||
| test -n "$(BUILD_NAMESPACE)" | ||
| test -n "$(BUILD_REF)" | ||
|
|
@@ -285,6 +307,33 @@ create-new-db: | |
| @echo "+\n++ Creating DB ($(NEW_DB)) in $(NAMESPACE) patroni db cluster" | ||
| @oc -n $(NAMESPACE) process -f openshift/database/createdb-job.yml -p DB_NAME=$(NEW_DB) -p BUILD_NAMESPACE=$(BUILD_NAMESPACE) -p JOB_NAME=$(JOB_NAME) | oc -n $(NAMESPACE) apply -f - | ||
|
|
||
| run-db-migrations: | ||
| test -n "$(NAMESPACE)" | ||
| test -n "$(BUILD_NAMESPACE)" | ||
| test -n "$(DB_SERVICE_NAME)" | ||
| test -n "$(DB_MIGRATIONS_BUILD_REF)" | ||
| test -n "$(BUILD_REF)" | ||
| test -n "$(DATABASE_NAME_KEY)" | ||
| test -n "$(DB_MIGRATIONS)" | ||
| @echo "+\n++ Deploying DB_MIGRATIONS with tag: $(BUILD_REF)\n+" | ||
| @oc -n $(NAMESPACE) process -f openshift/db-migrations-deploy.yml \ | ||
| -p NAME=$(DB_MIGRATIONS) \ | ||
| -p DB_SERVICE=$(DB_SERVICE_NAME) \ | ||
| -p BUILD_NAMESPACE=$(BUILD_NAMESPACE) \ | ||
| -p IMAGE_STREAM_TAG="$(DB_MIGRATIONS_BUILD_REF):$(BUILD_REF)" \ | ||
| -p BUILD_TAG=$(BUILD_REF) \ | ||
| -p DATABASE_NAME_KEY=$(DATABASE_NAME_KEY) \ | ||
| -p JOB_NAME=$(DB_MIGRATIONS_JOB_NAME) \ | ||
| | oc -n $(NAMESPACE) apply -f - | ||
|
|
||
| wait-for-db-migrations: | ||
andrewsignori-aot marked this conversation as resolved.
Show resolved
Hide resolved
|
||
| while [ "$$(oc get job $(DB_MIGRATIONS_JOB_NAME) -o=jsonpath='{.status.conditions[?(@.type=="Complete")].status}' || echo "None")" != "True" ] && [ "$$WAIT_TIME" -lt "$$MAX_WAIT" ]; do sleep 5; WAIT_TIME=$$((WAIT_TIME+5)); done | ||
|
|
||
| if [ "$$(oc get job $(DB_MIGRATIONS_JOB_NAME) -o=jsonpath='{.status.conditions[?(@.type=="Complete")].status}' || echo "None")" != "True" ]; then echo "Error: Job $(DB_MIGRATIONS_JOB_NAME) failed to complete within the specified timeout"; exit 1; fi | ||
|
|
||
| delete-db-migrations: | ||
| oc delete job $(DB_MIGRATIONS_JOB_NAME) | ||
|
|
||
| deploy-api: | ||
| test -n "$(NAMESPACE)" | ||
| test -n "$(BUILD_NAMESPACE)" | ||
|
|
||
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,87 @@ | ||
| apiVersion: template.openshift.io/v1 | ||
| kind: Template | ||
dheepak-aot marked this conversation as resolved.
Show resolved
Hide resolved
|
||
| metadata: | ||
| name: ${NAME} | ||
| annotations: | ||
| description: "Template for running a job that performs a database migrations" | ||
| labels: | ||
| project: ${PROJECT} | ||
| service: ${SERVICE_NAME} | ||
| parameters: | ||
andrewsignori-aot marked this conversation as resolved.
Show resolved
Hide resolved
|
||
| - name: NAME | ||
| required: true | ||
| - name: BUILD_TAG | ||
| value: "0" | ||
| - name: PROJECT | ||
| value: sims | ||
| - name: SERVICE_NAME | ||
| value: db-migrations | ||
| - name: JOB_NAME | ||
| description: database.migrations | ||
| required: true | ||
| value: db-migrations-job | ||
| - name: IMAGE_STREAM_TAG | ||
| required: true | ||
| - name: BUILD_NAMESPACE | ||
| required: true | ||
| - name: IMAGE_REGISTRY | ||
| value: image-registry.openshift-image-registry.svc:5000 | ||
| - name: DB_SERVICE | ||
| value: patroni-master | ||
| - name: DB_SECRET_NAME | ||
| value: patroni-creds | ||
| - name: DB_USERNAME_KEY | ||
| value: superuser-username | ||
| - name: DB_PASSWORD_KEY | ||
| value: superuser-password | ||
| - name: DATABASE_NAME_KEY | ||
| required: true | ||
| - name: CPU_LIMIT | ||
| value: "1.0" | ||
| - name: MEMORY_LIMIT | ||
| value: "2000M" | ||
| - name: CPU_REQUEST | ||
| value: "0.5" | ||
| - name: MEMORY_REQUEST | ||
| value: "1000M" | ||
| objects: | ||
| - apiVersion: batch/v1 | ||
| kind: Job | ||
| metadata: | ||
| name: ${JOB_NAME} | ||
| spec: | ||
| template: | ||
| metadata: | ||
| name: ${JOB_NAME} | ||
| spec: | ||
| containers: | ||
| - name: db-migrations-container | ||
dheepak-aot marked this conversation as resolved.
Show resolved
Hide resolved
|
||
| image: ${IMAGE_REGISTRY}/${BUILD_NAMESPACE}/${IMAGE_STREAM_TAG} | ||
| env: | ||
| - name: VERSION | ||
| value: ${BUILD_TAG} | ||
| - name: POSTGRES_HOST | ||
| value: "${DB_SERVICE}" | ||
| - name: POSTGRES_USER | ||
| valueFrom: | ||
| secretKeyRef: | ||
| key: ${DB_USERNAME_KEY} | ||
| name: ${DB_SECRET_NAME} | ||
| - name: POSTGRES_PASSWORD | ||
| valueFrom: | ||
| secretKeyRef: | ||
| key: ${DB_PASSWORD_KEY} | ||
| name: ${DB_SECRET_NAME} | ||
| - name: POSTGRES_DB | ||
| valueFrom: | ||
| secretKeyRef: | ||
| key: ${DATABASE_NAME_KEY} | ||
| name: ${DB_SECRET_NAME} | ||
| resources: | ||
| limits: | ||
| cpu: ${CPU_LIMIT} | ||
| memory: ${MEMORY_LIMIT} | ||
| requests: | ||
| cpu: ${CPU_REQUEST} | ||
| memory: ${MEMORY_REQUEST} | ||
| restartPolicy: Never | ||
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
db-migrationswill run first, then rest in parallel right?There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
oh.. since it is deployed we are doing everything in parallel?
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Yes, you are right
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
The make
oc-somethinghere, in general, are appended with--waitdoes it not mean that they will be waiting to be executed one after another?There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
No, if the oc-build-db-migrations target in the make command includes --wait in its command, it does not automatically wait for the other make commands to finish. The --wait option typically applies to the specific build process triggered by that particular make target.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I got the point when we talked about the commands concatenation with the "&".
Either way, as per the Team discussion, the approach with the GitHub parallel jobs looks great.