-
Notifications
You must be signed in to change notification settings - Fork 0
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Merge pull request #307 from bcgov/feature/districtPrimary
Updates for actions and primary code note
- Loading branch information
Showing
6 changed files
with
146 additions
and
92 deletions.
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
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1,4 +1,4 @@ | ||
| name: Build & Deploy to DEV and TEST | ||
| name: Build & Deploy to DEV | ||
|
|
||
| env: | ||
| # 🖊️ EDIT your repository secrets to log into your OpenShift cluster and set up the context. | ||
|
|
@@ -7,7 +7,6 @@ env: | |
| OPENSHIFT_SERVER: ${{ secrets.OPENSHIFT_SERVER }} | ||
| OPENSHIFT_TOKEN: ${{ secrets.OPENSHIFT_TOKEN }} | ||
| OPENSHIFT_NAMESPACE_DEV: ${{ secrets.EDX_NAMESPACE_NO_ENV }}-dev | ||
| OPENSHIFT_NAMESPACE_TEST: ${{ secrets.EDX_NAMESPACE_NO_ENV }}-test | ||
|
|
||
| DB_JDBC_CONNECT_STRING: ${{ secrets.DB_JDBC_CONNECT_STRING }} | ||
| DB_PWD: ${{ secrets.DB_PWD }} | ||
|
|
@@ -47,8 +46,6 @@ env: | |
| MAX_CPU: "400m" | ||
| MIN_MEM: "800Mi" | ||
| MAX_MEM: "1Gi" | ||
| MIN_REPLICAS_TEST: "2" | ||
| MAX_REPLICAS_TEST: "2" | ||
| on: | ||
| push: | ||
| branches: | ||
|
|
@@ -184,89 +181,3 @@ jobs: | |
| with: | ||
| target: 'https://${{ env.APP_NAME }}-${{ env.OPENSHIFT_NAMESPACE_DEV }}.apps.silver.devops.gov.bc.ca/v3/api-docs' | ||
|
|
||
| deploy-test: | ||
| name: Deploy to OpenShift TEST | ||
| needs: build-and-deploy-dev | ||
| runs-on: ubuntu-20.04 | ||
| environment: test | ||
|
|
||
| outputs: | ||
| ROUTE: ${{ steps.deploy-and-expose.outputs.route }} | ||
| SELECTOR: ${{ steps.deploy-and-expose.outputs.selector }} | ||
|
|
||
| steps: | ||
| - name: Check for required secrets | ||
| uses: actions/github-script@v6 | ||
| with: | ||
| script: | | ||
| const secrets = { | ||
| OPENSHIFT_SERVER: `${{ secrets.OPENSHIFT_SERVER }}`, | ||
| OPENSHIFT_TOKEN: `${{ secrets.OPENSHIFT_TOKEN }}`, | ||
| }; | ||
| const GHCR = "ghcr.io"; | ||
| if (`${{ env.IMAGE_REGISTRY }}`.startsWith(GHCR)) { | ||
| core.info(`Image registry is ${GHCR} - no registry password required`); | ||
| } | ||
| else { | ||
| core.info("A registry password is required"); | ||
| secrets["IMAGE_REGISTRY_PASSWORD"] = `${{ secrets.IMAGE_REGISTRY_PASSWORD }}`; | ||
| } | ||
| const missingSecrets = Object.entries(secrets).filter(([ name, value ]) => { | ||
| if (value.length === 0) { | ||
| core.error(`Secret "${name}" is not set`); | ||
| return true; | ||
| } | ||
| core.info(`✔️ Secret "${name}" is set`); | ||
| return false; | ||
| }); | ||
| if (missingSecrets.length > 0) { | ||
| core.setFailed(`❌ At least one required secret is not set in the repository. \n` + | ||
| "You can add it using:\n" + | ||
| "GitHub UI: https://docs.github.com/en/actions/reference/encrypted-secrets#creating-encrypted-secrets-for-a-repository \n" + | ||
| "GitHub CLI: https://cli.github.com/manual/gh_secret_set \n" + | ||
| "Also, refer to https://github.com/redhat-actions/oc-login#getting-started-with-the-action-or-see-example"); | ||
| } | ||
| else { | ||
| core.info(`✅ All the required secrets are set`); | ||
| } | ||
| - name: Check out repository | ||
| uses: actions/checkout@v3 | ||
|
|
||
| - name: Install oc | ||
| uses: redhat-actions/openshift-tools-installer@v1 | ||
| with: | ||
| oc: 4 | ||
|
|
||
| - name: Deploy API | ||
| run: | | ||
| set -eu | ||
| # Login to OpenShift and select project | ||
| oc login --token=${{ env.OPENSHIFT_TOKEN }} --server=${{ env.OPENSHIFT_SERVER }} | ||
| oc project ${{ env.OPENSHIFT_NAMESPACE_TEST }} | ||
| # Cancel any rollouts in progress | ||
| oc rollout cancel dc/${{ env.SPRING_BOOT_IMAGE_NAME }} 2> /dev/null \ | ||
| || true && echo "No rollout in progress" | ||
| oc tag ${{ env.NAMESPACE }}-dev/${{ env.REPO_NAME }}-${{ env.BRANCH }}:${{ env.TAG }} ${{ env.NAMESPACE }}-test/${{ env.REPO_NAME }}-${{ env.BRANCH }}:${{ env.TAG }} | ||
| # Process and apply deployment template | ||
| oc process -f tools/openshift/api.dc.yaml -p APP_NAME=${{ env.APP_NAME }} -p REPO_NAME=${{ env.REPO_NAME }} -p BRANCH=${{ env.BRANCH }} -p NAMESPACE=${{ env.OPENSHIFT_NAMESPACE_TEST }} -p TAG=${{ env.TAG }} -p MIN_REPLICAS=${{ env.MIN_REPLICAS_TEST }} -p MAX_REPLICAS=${{ env.MAX_REPLICAS_TEST }} -p MIN_CPU=${{ env.MIN_CPU }} -p MAX_CPU=${{ env.MAX_CPU }} -p MIN_MEM=${{ env.MIN_MEM }} -p MAX_MEM=${{ env.MAX_MEM }} \ | ||
| | oc apply -f - | ||
| curl -s https://raw.githubusercontent.com/bcgov/${{ env.REPO_NAME }}/master/tools/config/update-configmap.sh | bash /dev/stdin test ${{ env.APP_NAME }} ${{ env.NAMESPACE }} ${{ env.COMMON_NAMESPACE }} ${{ env.DB_JDBC_CONNECT_STRING }} ${{ env.DB_PWD }} ${{ env.DB_USER }} ${{ env.SPLUNK_TOKEN }} ${{ env.CHES_CLIENT_ID }} ${{ env.CHES_CLIENT_SECRET }} ${{ env.CHES_TOKEN_URL }} ${{ env.CHES_ENDPOINT_URL }} ${{ env.SITE_URL }} | ||
| # Start rollout (if necessary) and follow it | ||
| oc rollout latest dc/${{ env.SPRING_BOOT_IMAGE_NAME }} 2> /dev/null \ | ||
| || true && echo "Rollout in progress" | ||
| oc logs -f dc/${{ env.SPRING_BOOT_IMAGE_NAME }} | ||
| # Get status, returns 0 if rollout is successful | ||
| oc rollout status dc/${{ env.SPRING_BOOT_IMAGE_NAME }} | ||
| - name: ZAP Scan | ||
| uses: zaproxy/[email protected] | ||
| with: | ||
| target: 'https://${{ env.APP_NAME }}-${{ env.OPENSHIFT_NAMESPACE_TEST }}.apps.silver.devops.gov.bc.ca/v3/api-docs' | ||
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,136 @@ | ||
| name: Deploy to TEST | ||
|
|
||
| env: | ||
| # 🖊️ EDIT your repository secrets to log into your OpenShift cluster and set up the context. | ||
| # See https://github.com/redhat-actions/oc-login#readme for how to retrieve these values. | ||
| # To get a permanent token, refer to https://github.com/redhat-actions/oc-login/wiki/Using-a-Service-Account-for-GitHub-Actions | ||
| OPENSHIFT_SERVER: ${{ secrets.OPENSHIFT_SERVER }} | ||
| OPENSHIFT_TOKEN: ${{ secrets.OPENSHIFT_TOKEN }} | ||
| OPENSHIFT_NAMESPACE: ${{ secrets.EDX_NAMESPACE_NO_ENV }}-test | ||
|
|
||
| DB_JDBC_CONNECT_STRING: ${{ secrets.DB_JDBC_CONNECT_STRING }} | ||
| DB_PWD: ${{ secrets.DB_PWD }} | ||
| DB_USER: ${{ secrets.DB_USER }} | ||
| SPLUNK_TOKEN: ${{ secrets.SPLUNK_TOKEN }} | ||
|
|
||
| CHES_CLIENT_ID: ${{ secrets.CHES_CLIENT_ID }} | ||
| CHES_CLIENT_SECRET: ${{ secrets.CHES_CLIENT_SECRET }} | ||
| CHES_TOKEN_URL: ${{ secrets.CHES_TOKEN_URL }} | ||
| CHES_ENDPOINT_URL: ${{ secrets.CHES_ENDPOINT_URL }} | ||
| SITE_URL: ${{ secrets.SITE_URL }} | ||
|
|
||
| # 🖊️ EDIT to change the image registry settings. | ||
| # Registries such as GHCR, Quay.io, and Docker Hub are supported. | ||
| IMAGE_REGISTRY: ghcr.io/${{ github.repository_owner }} | ||
| IMAGE_REGISTRY_USER: ${{ github.actor }} | ||
| IMAGE_REGISTRY_PASSWORD: ${{ github.token }} | ||
|
|
||
| SPRING_BOOT_IMAGE_NAME: edx-api-master | ||
|
|
||
| APP_NAME: 'edx-api' | ||
| DB_NAME: 'edx_api' | ||
| REPO_NAME: "educ-edx-api" | ||
| BRANCH: "master" | ||
| NAMESPACE: ${{ secrets.EDX_NAMESPACE_NO_ENV }} | ||
| COMMON_NAMESPACE: ${{ secrets.COMMON_NAMESPACE_NO_ENV }} | ||
| TAG: "latest" | ||
| TARGET_ENV: "test" | ||
| MIN_REPLICAS: "2" | ||
| MAX_REPLICAS: "2" | ||
| MIN_CPU: "200m" | ||
| MAX_CPU: "400m" | ||
| MIN_MEM: "800Mi" | ||
| MAX_MEM: "1Gi" | ||
|
|
||
| on: | ||
| # https://docs.github.com/en/actions/reference/events-that-trigger-workflows | ||
| workflow_dispatch: | ||
|
|
||
| jobs: | ||
| openshift-ci-cd: | ||
| name: Deploy to OpenShift TEST | ||
| # ubuntu-20.04 can also be used. | ||
| runs-on: ubuntu-20.04 | ||
| environment: test | ||
|
|
||
| outputs: | ||
| ROUTE: ${{ steps.deploy-and-expose.outputs.route }} | ||
| SELECTOR: ${{ steps.deploy-and-expose.outputs.selector }} | ||
|
|
||
| steps: | ||
| - name: Check for required secrets | ||
| uses: actions/github-script@v6 | ||
| with: | ||
| script: | | ||
| const secrets = { | ||
| OPENSHIFT_SERVER: `${{ secrets.OPENSHIFT_SERVER }}`, | ||
| OPENSHIFT_TOKEN: `${{ secrets.OPENSHIFT_TOKEN }}`, | ||
| }; | ||
| const GHCR = "ghcr.io"; | ||
| if (`${{ env.IMAGE_REGISTRY }}`.startsWith(GHCR)) { | ||
| core.info(`Image registry is ${GHCR} - no registry password required`); | ||
| } | ||
| else { | ||
| core.info("A registry password is required"); | ||
| secrets["IMAGE_REGISTRY_PASSWORD"] = `${{ secrets.IMAGE_REGISTRY_PASSWORD }}`; | ||
| } | ||
| const missingSecrets = Object.entries(secrets).filter(([ name, value ]) => { | ||
| if (value.length === 0) { | ||
| core.error(`Secret "${name}" is not set`); | ||
| return true; | ||
| } | ||
| core.info(`✔️ Secret "${name}" is set`); | ||
| return false; | ||
| }); | ||
| if (missingSecrets.length > 0) { | ||
| core.setFailed(`❌ At least one required secret is not set in the repository. \n` + | ||
| "You can add it using:\n" + | ||
| "GitHub UI: https://docs.github.com/en/actions/reference/encrypted-secrets#creating-encrypted-secrets-for-a-repository \n" + | ||
| "GitHub CLI: https://cli.github.com/manual/gh_secret_set \n" + | ||
| "Also, refer to https://github.com/redhat-actions/oc-login#getting-started-with-the-action-or-see-example"); | ||
| } | ||
| else { | ||
| core.info(`✅ All the required secrets are set`); | ||
| } | ||
| - name: Check out repository | ||
| uses: actions/checkout@v3 | ||
|
|
||
| - name: Get latest tag | ||
| uses: actions-ecosystem/action-get-latest-tag@v1 | ||
| id: get-latest-tag | ||
|
|
||
| - name: Install oc | ||
| uses: redhat-actions/openshift-tools-installer@v1 | ||
| with: | ||
| oc: 4 | ||
|
|
||
| # https://github.com/redhat-actions/oc-login#readme | ||
| - uses: actions/checkout@v3 | ||
| - name: Deploy | ||
| run: | | ||
| set -eux | ||
| # Login to OpenShift and select project | ||
| oc login --token=${{ env.OPENSHIFT_TOKEN }} --server=${{ env.OPENSHIFT_SERVER }} | ||
| oc project ${{ env.OPENSHIFT_NAMESPACE }} | ||
| # Cancel any rollouts in progress | ||
| oc rollout cancel dc/${{ env.SPRING_BOOT_IMAGE_NAME }} 2> /dev/null \ | ||
| || true && echo "No rollout in progress" | ||
| oc tag ${{ env.NAMESPACE }}-dev/${{ env.REPO_NAME }}-${{ env.BRANCH }}:${{ steps.get-latest-tag.outputs.tag }} ${{ env.NAMESPACE }}-test/${{ env.REPO_NAME }}-${{ env.BRANCH }}:${{ steps.get-latest-tag.outputs.tag }} | ||
| # Process and apply deployment template | ||
| oc process -f tools/openshift/api.dc.yaml -p APP_NAME=${{ env.APP_NAME }} -p REPO_NAME=${{ env.REPO_NAME }} -p BRANCH=${{ env.BRANCH }} -p NAMESPACE=${{ env.OPENSHIFT_NAMESPACE }} -p TAG=${{ steps.get-latest-tag.outputs.tag }} -p MIN_REPLICAS=${{ env.MIN_REPLICAS }} -p MAX_REPLICAS=${{ env.MAX_REPLICAS }} -p MIN_CPU=${{ env.MIN_CPU }} -p MAX_CPU=${{ env.MAX_CPU }} -p MIN_MEM=${{ env.MIN_MEM }} -p MAX_MEM=${{ env.MAX_MEM }} \ | ||
| | oc apply -f - | ||
| curl -s https://raw.githubusercontent.com/bcgov/${{ env.REPO_NAME }}/master/tools/config/update-configmap.sh | bash /dev/stdin ${{ env.TARGET_ENV }} ${{ env.APP_NAME }} ${{ env.NAMESPACE }} ${{ env.COMMON_NAMESPACE }} ${{ env.DB_JDBC_CONNECT_STRING }} ${{ env.DB_PWD }} ${{ env.DB_USER }} ${{ env.SPLUNK_TOKEN }} ${{ env.CHES_CLIENT_ID }} ${{ env.CHES_CLIENT_SECRET }} ${{ env.CHES_TOKEN_URL }} ${{ env.CHES_ENDPOINT_URL }} ${{ env.SITE_URL }} | ||
| # Start rollout (if necessary) and follow it | ||
| oc rollout latest dc/${{ env.SPRING_BOOT_IMAGE_NAME }} 2> /dev/null \ | ||
| || true && echo "Rollout in progress" | ||
| oc logs -f dc/${{ env.SPRING_BOOT_IMAGE_NAME }} | ||
| # Get status, returns 0 if rollout is successful | ||
| oc rollout status dc/${{ env.SPRING_BOOT_IMAGE_NAME }} |
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 |
|---|---|---|
|
|
@@ -39,6 +39,8 @@ [email protected] | |
| email.subject.edx.school.primary-code.notification=Primary Access Code for Education Data Exchange | ||
| email.template.edx.school.primary-code.notification=<!DOCTYPE html><html xmlns:th="http://www.thymeleaf.org"><head><meta charset="ISO-8859-1"><title>New Secure Exchange Message</title></head><body><p>Hi <span th:text="${$}{recipient}"></span>,</p><p>Here is the Primary Access Code for the Education Data Exchange (EDX) for <span th:text="${$}{minCode}"></span> - <span th:text="${$}{instituteName}"></span>: <span th:text="${$}{primaryCode}"></span></p><p>Please keep this code safe. It will be required for the activation of each EDX account at your school. Once you have activated your EDX Administrator Account, you will be able to view the Primary Access Code through the School User Management screen - available under the "Administration" menu option.</p><p>Regards,<br/>The Ministry of Education and Child Care\'s EDX Team</p></body></html> | ||
|
|
||
| email.template.edx.district.primary-code.notification=<!DOCTYPE html><html xmlns:th="http://www.thymeleaf.org"><head><meta charset="ISO-8859-1"><title>New Secure Exchange Message</title></head><body><p>Hi <span th:text="${$}{recipient}"></span>,</p><p>Here is the Primary Access Code for the Education Data Exchange (EDX) for <span th:text="${$}{minCode}"></span> - <span th:text="${$}{instituteName}"></span>: <span th:text="${$}{primaryCode}"></span></p><p>Please keep this code safe. It will be required for the activation of each EDX account at your school. Once you have activated your EDX Administrator Account, you will be able to view the Primary Access Code through the School User Management screen - available under the "Administration" menu option.</p><p>Regards,<br/>The Ministry of Education and Child Care\'s EDX Team</p></body></html> | ||
|
|
||
| email.template.edx.new.secure.exchange.notification=<!DOCTYPE html><html xmlns:th=\"http://www.thymeleaf.org\"><head><meta charset=\"ISO-8859-1\"><title> New Secure Exchange Message</title></head><body>Hi <span th:text="${$}{recipient}"></span>,<br><br><span th:text=\"\${$}{instituteName}\"></span> has received a new secure message from the <span th:text=\"\${$}{ministryTeamName}\"></span>.<br><br>To view the message, please log into the Education Data Exchange: <a th:href=\"@{\${\$}{linkToEDX}}\">here</a><br><br>If the above link doesn't work, please paste this link into your web browser's address field:<br><br><a th:href=\"@{\${\$}{linkToEDX}}\" th:text=\"\${\$}{linkToEDX}\"></a><br><br>Regards,<br>The Ministry of Education and Child Care's EDX Team</body></html> | ||
| email.subject.edx.new.secure.exchange.notification=New Secure Exchange Message | ||
|
|
||
|
|
||
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