Verbiage #759
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
| name: Build & Deploy to DEV and 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_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 }} | |
| DB_USER: ${{ secrets.DB_USER }} | |
| SPLUNK_TOKEN: ${{ secrets.SPLUNK_TOKEN }} | |
| # 🖊️ 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 }} | |
| 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 }} | |
| # 🖊️ EDIT to specify custom tags for the container image, or default tags will be generated below. | |
| IMAGE_TAGS: "" | |
| SPRING_BOOT_IMAGE_NAME: student-data-collection-api-master | |
| DOCKER_ARTIFACTORY_REPO: artifacts.developer.gov.bc.ca/docker-remote | |
| ARTIFACTORY_REPO: artifacts.developer.gov.bc.ca | |
| APP_NAME: 'student-data-collection-api' | |
| REPO_NAME: "educ-student-data-collection-api" | |
| BRANCH: "master" | |
| APP_NAME_FULL: "student-data-collection-api-master" | |
| NAMESPACE: ${{ secrets.EDX_NAMESPACE_NO_ENV }} | |
| COMMON_NAMESPACE: ${{ secrets.COMMON_NAMESPACE_NO_ENV }} | |
| TAG: "latest" | |
| MIN_REPLICAS_DEV: "1" | |
| MAX_REPLICAS_DEV: "2" | |
| MIN_REPLICAS_TEST: "4" | |
| MAX_REPLICAS_TEST: "5" | |
| MIN_CPU: "500m" | |
| MAX_CPU: "1" | |
| MIN_MEM: "800Mi" | |
| MAX_MEM: "1200Mi" | |
| on: | |
| # https://docs.github.com/en/actions/reference/events-that-trigger-workflows | |
| push: | |
| branches: | |
| - master | |
| jobs: | |
| build-and-deploy-dev: | |
| name: Build and deploy to OpenShift DEV | |
| runs-on: ubuntu-22.04 | |
| environment: dev | |
| 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@v4 | |
| with: | |
| script: | | |
| const secrets = { | |
| OPENSHIFT_SERVER: `${{ secrets.OPENSHIFT_SERVER }}`, | |
| OPENSHIFT_TOKEN: `${{ secrets.OPENSHIFT_TOKEN }}`, | |
| DB_USER: `${{ secrets.DB_USER }}`, | |
| SPLUNK_TOKEN: `${{ secrets.SPLUNK_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@v2 | |
| - name: Determine image tags | |
| if: env.IMAGE_TAGS == '' | |
| run: | | |
| echo "IMAGE_TAGS=latest ${GITHUB_SHA::12}" | tee -a $GITHUB_ENV | |
| - name: Login to Docker Hub | |
| uses: docker/login-action@v1 | |
| with: | |
| registry: ${{ env.DOCKER_ARTIFACTORY_REPO }} | |
| username: ${{ secrets.DOCKER_HUB_USERNAME }} | |
| password: ${{ secrets.DOCKER_HUB_ACCESS_TOKEN }} | |
| # https://github.com/redhat-actions/buildah-build#readme | |
| - name: Build from Dockerfile | |
| id: build-image | |
| uses: redhat-actions/buildah-build@v2 | |
| with: | |
| image: ${{ env.APP_NAME_FULL }} | |
| tags: ${{ env.IMAGE_TAGS }} | |
| # If you don't have a Dockerfile/Containerfile, refer to https://github.com/redhat-actions/buildah-build#scratch-build-inputs | |
| # Or, perform a source-to-image build using https://github.com/redhat-actions/s2i-build | |
| # Otherwise, point this to your Dockerfile/Containerfile relative to the repository root. | |
| dockerfiles: | | |
| ./Dockerfile | |
| # https://github.com/redhat-actions/push-to-registry#readme | |
| - name: Push to registry | |
| id: push-image | |
| uses: redhat-actions/push-to-registry@v2 | |
| with: | |
| image: ${{ steps.build-image.outputs.image }} | |
| tags: ${{ steps.build-image.outputs.tags }} | |
| registry: ${{ env.IMAGE_REGISTRY }} | |
| username: ${{ env.IMAGE_REGISTRY_USER }} | |
| password: ${{ env.IMAGE_REGISTRY_PASSWORD }} | |
| # The path the image was pushed to is now stored in ${{ steps.push-image.outputs.registry-path }} | |
| - name: Install oc | |
| uses: redhat-actions/openshift-tools-installer@v1 | |
| with: | |
| oc: 4 | |
| # https://github.com/redhat-actions/oc-login#readme | |
| - uses: actions/checkout@v2 | |
| - 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_DEV }} | |
| # 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 ${{ steps.push-image.outputs.registry-path }} ${{ 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_DEV }} -p TAG=${{ env.TAG }} -p MIN_REPLICAS=${{ env.MIN_REPLICAS_DEV }} -p MAX_REPLICAS=${{ env.MAX_REPLICAS_DEV }} -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 dev ${{ 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 }} | |
| # 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/action-api-scan@v0.7.0 | |
| with: | |
| target: 'https://${{ env.APP_NAME }}-${{ env.OPENSHIFT_NAMESPACE_DEV }}-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-22.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@v4 | |
| 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@v2 | |
| - 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 }} | |
| # 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/action-api-scan@v0.7.0 | |
| with: | |
| target: 'https://${{ env.APP_NAME }}-${{ env.OPENSHIFT_NAMESPACE_TEST }}-dev.apps.silver.devops.gov.bc.ca/v3/api-docs' |