deploy-to-openshift-backend-dev.yml

name: 1 DEV - Deploy Backend

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 }}
  # EDIT to set the kube context's namespace after login. Leave blank to use your user's default namespace.
  OPENSHIFT_NAMESPACE: ${{ secrets.CCOF_NAMESPACE_NO_ENV }}-dev

  # EDIT to change the image registry setting
  # 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 }}

  DOCKER_ARTIFACTORY_REPO: artifacts.developer.gov.bc.ca/docker-remote
  ARTIFACTORY_REPO: artifacts.developer.gov.bc.ca

  APP_NAME: "ccof"
  REPO_NAME: "educ-ccof"
  # grabs the branch name from github dynamically
  BRANCH: ${{ github.ref_name }}
  IMAGE_NAME: "backend"
  APP_ENVIRONMENT: "dev"
  APP_FOLDER: "backend"
  NAMESPACE_TOOLS: ${{ secrets.CCOF_NAMESPACE_NO_ENV }}-tools
  TAG: "latest"

  MIN_REPLICAS: "1"
  MAX_REPLICAS: "2"
  MIN_CPU: "50m"
  MAX_CPU: "250m"
  MIN_MEM: "200Mi"
  MAX_MEM: "700Mi"

  # SITE_URL should have no scheme or port. It will be prepended with https://
  HOST_ROUTE: ${{ secrets.SITE_URL }}

on:
  workflow_dispatch:

jobs:
  openshift-ci-cd:
    name: Build and deploy Backend to DEV
    permissions:
      contents: write
      packages: write
    runs-on: ubuntu-24.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@10b53a9ec6c222bb4ce97aa6bd2b5f739696b536 #v4.2.0
        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 with branch [${{ env.BRANCH }}]
        uses: actions/checkout@34e114876b0b11c390a56381ad16ebd13914f8d5a #v4.3.1
        with:
          ref: ${{ env.BRANCH }}
          persist-credentials: false


      - name: Login to Docker Hub
        uses: docker/login-action@4907a6ddec9925e35a0a9e82d7399ccc52663121 #v4.1.0
        with:
          registry: ${{ env.DOCKER_ARTIFACTORY_REPO }}
          username: ${{ secrets.DOCKER_HUB_USERNAME }}
          password: ${{ secrets.DOCKER_HUB_ACCESS_TOKEN }}

      - name: Build backend from Dockerfile
        id: build-image-backend
        uses: redhat-actions/buildah-build@7a95fa7ee0f02d552a32753e7414641a04307056 #v2.13
        with:
          image: ${{ env.IMAGE_NAME }}
          tags: "latest"

          # 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: |
            ./${{ env.APP_FOLDER }}/Dockerfile
          context: ./${{ env.APP_FOLDER }}

        # https://github.com/redhat-actions/push-to-registry#readme
      - name: Push backend to registry
        id: push-image-backend
        uses: redhat-actions/push-to-registry@5ed88d269cf581ea9ef6dd6806d01562096bee9c #v2.8
        with:
          image: ${{ steps.build-image-backend.outputs.image }}
          tags: ${{ steps.build-image-backend.outputs.tags }}
          registry: ${{ env.IMAGE_REGISTRY }}
          username: ${{ env.IMAGE_REGISTRY_USER }}
          password: ${{ env.IMAGE_REGISTRY_PASSWORD }}

      - name: Setup Keycloak Client
        uses: actions/github-script@f28e40c7f34bde8b3046d885e986cb6290c5673b #v7.1.0
        env:
          KC_REALM_ID: ${{ secrets.KC_REALM_ID }}
          KC_CLIENT_ID: ${{ secrets.KC_ADMIN_CLIENT_ID }}
          KC_CLIENT_SECRET: ${{ secrets.KC_ADMIN_CLIENT_SECRET }}
          KC_ENV: dev
          APP_NAME: ${{ env.APP_NAME }}
        with:
          script: |
            const { main } = require('./tools/config/keycloak.js');
            await main();

      - name: Install oc
        uses: redhat-actions/openshift-tools-installer@144527c7d98999f2652264c048c7a9bd103f8a82 #v1.13.1
        with:
          oc: 4.16

      - name: Deploy
        env:
          CCOF_NAMESPACE_NO_ENV: ${{ secrets.CCOF_NAMESPACE_NO_ENV }}
          COMMON_NAMESPACE_NO_ENV: ${{ secrets.COMMON_NAMESPACE_NO_ENV }}
          SOAM_CLIENT_ID: ${{ secrets.SOAM_CLIENT_ID }}
          SOAM_CLIENT_SECRET: ${{ secrets.SOAM_CLIENT_SECRET }}
          SOAM_IDP_HINT_BCEID: ${{ secrets.SOAM_IDP_HINT_BCEID }}
          SOAM_IDP_HINT_IDIR: ${{ secrets.SOAM_IDP_HINT_IDIR }}
          SPLUNK_TOKEN: ${{ secrets.SPLUNK_TOKEN }}
          D365_API_PREFIX: ${{ secrets.D365_API_PREFIX }}
          D365_API_KEY_HEADER: ${{ secrets.D365_API_KEY_HEADER }}
          D365_API_KEY_VALUE: ${{ secrets.D365_API_KEY_VALUE }}
          CANADA_POST_API_ENDPOINT: ${{ secrets.CANADA_POST_API_ENDPOINT }}
          CANADA_POST_API_KEY: ${{ secrets.CANADA_POST_API_KEY }}
        run: |
          set -eux
          # Login to OpenShift and select project
          oc login --token="$OPENSHIFT_TOKEN" --server="$OPENSHIFT_SERVER"
          oc project "$OPENSHIFT_NAMESPACE"
          # Cancel any rollouts in progress
          oc rollout cancel "deployment/$APP_NAME-$IMAGE_NAME-$APP_ENVIRONMENT" 2> /dev/null \
              || true && echo "No rollout in progress"

          oc tag \
             ${{ steps.push-image-backend.outputs.registry-path }} \
             "$REPO_NAME-$IMAGE_NAME-$BRANCH:$TAG"

          # Process and apply deployment template
          oc process \
             -f tools/openshift/backend.deployment.yaml \
             -p APP_NAME="$APP_NAME" \
             -p REPO_NAME="$REPO_NAME" \
             -p BRANCH="$BRANCH" \
             -p NAMESPACE="$OPENSHIFT_NAMESPACE" \
             -p TAG="$TAG" \
             -p MIN_REPLICAS="$MIN_REPLICAS" \
             -p MAX_REPLICAS="$MAX_REPLICAS" \
             -p MIN_CPU="$MIN_CPU" \
             -p MAX_CPU="$MAX_CPU" \
             -p MIN_MEM="$MIN_MEM" \
             -p MAX_MEM="$MAX_MEM" \
             -p HOST_ROUTE="$HOST_ROUTE" \
             -p APP_ENVIRONMENT="$APP_ENVIRONMENT" \
              | oc apply -f -

          # Process update-configmap
          curl -s "https://raw.githubusercontent.com/bcgov/$REPO_NAME/$BRANCH/tools/config/update-configmap.sh" \
            | bash /dev/stdin \
              "$APP_ENVIRONMENT" \
              "$APP_NAME" \
              "$CCOF_NAMESPACE_NO_ENV" \
              "$COMMON_NAMESPACE_NO_ENV" \
              "$SOAM_CLIENT_ID" \
              "$SOAM_CLIENT_SECRET" \
              "$SOAM_IDP_HINT_BCEID" \
              "$SOAM_IDP_HINT_IDIR" \
              "$SPLUNK_TOKEN" \
              "$D365_API_PREFIX" \
              "$D365_API_KEY_HEADER" \
              "$D365_API_KEY_VALUE" \
              "$CANADA_POST_API_ENDPOINT" \
              "$CANADA_POST_API_KEY"

          # Start rollout of the application
          oc rollout restart "deployment/$APP_NAME-$IMAGE_NAME-$APP_ENVIRONMENT" 2> /dev/null \
              || true && echo "Rollout in progress"

          # Get status, returns 0 if rollout is successful
          oc rollout status "deployment/$APP_NAME-$IMAGE_NAME-$APP_ENVIRONMENT"

  zap:
    name: Run Zap Scan
    uses: ./.github/workflows/zap-scan-node.yml
    needs: openshift-ci-cd
    with:
      env: 'dev'
    secrets: inherit