diff --git a/.github/workflows/deploy-to-openshift-backend-dev.yml b/.github/workflows/deploy-to-openshift-backend-dev.yml index c437b830..c77b0d91 100644 --- a/.github/workflows/deploy-to-openshift-backend-dev.yml +++ b/.github/workflows/deploy-to-openshift-backend-dev.yml @@ -1,4 +1,3 @@ -# OFM Backend DEV workflow name: 1 DEV - Deploy Backend env: @@ -177,7 +176,7 @@ jobs: # Process update-configmap curl -s https://raw.githubusercontent.com/bcgov/${{ env.REPO_NAME }}/${{ env.BRANCH }}/tools/config/update-configmap.sh \ | bash /dev/stdin \ - dev \ + ${{ env.APP_ENVIRONMENT }} \ ${{ env.APP_NAME }} \ ${{ env.NAMESPACE }} \ ${{ env.COMMON_NAMESPACE }} \ diff --git a/.github/workflows/deploy-to-openshift-backend-efx.yml b/.github/workflows/deploy-to-openshift-backend-efx.yml new file mode 100644 index 00000000..d9fe7e6a --- /dev/null +++ b/.github/workflows/deploy-to-openshift-backend-efx.yml @@ -0,0 +1,161 @@ +name: 4 EFX - 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.OFM_NAMESPACE_NO_ENV }}-test + COMMON_NAMESPACE: ${{ secrets.COMMON_NAMESPACE_NO_ENV }} + + # 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 }} + + APP_NAME: 'ofm' + REPO_NAME: 'ecc-ofm' + #grabs the branch name from github dynamically + BRANCH: ${{ github.ref_name }} + IMAGE_NAME: 'ecc-ofm-backend' + APP_NAME_BACKEND: 'backend' + # We have multiple environments in each openshift namespace dev, test in DEV and uat, efx in TEST. This setting will help name the deployment config and routes for each. + APP_ENVIRONMENT: 'efx' + + NAMESPACE: ${{ secrets.OFM_NAMESPACE_NO_ENV }} + + MIN_REPLICAS: '2' + MAX_REPLICAS: '3' + 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: Deploy Backend to EFX + runs-on: ubuntu-24.04 + environment: efx + + 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 with branch [${{ env.BRANCH }}] + uses: actions/checkout@v3 + with: + ref: ${{ env.BRANCH }} + + - 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.16 + + - 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.APP_NAME }}-${{ env.APP_NAME_BACKEND }}-${{ env.APP_ENVIRONMENT }} 2> /dev/null \ + || true && echo "No rollout in progress" + + # Create the image stream if it doesn't exist + oc create imagestream ${{ env.IMAGE_NAME }} 2> /dev/null || true && echo "backend image stream in place" + + # Create tag for UAT env from DEV env image + oc tag ${{ env.NAMESPACE }}-dev/${{ env.REPO_NAME }}-${{ env.APP_NAME_BACKEND }}:${{ steps.get-latest-tag.outputs.tag }} ${{ env.NAMESPACE }}-test/${{ env.REPO_NAME }}-${{ env.APP_NAME_BACKEND }}:${{ steps.get-latest-tag.outputs.tag }} + + # Process and apply deployment template + oc process -f tools/openshift/backend.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 }} \ + -p HOST_ROUTE=${{ env.HOST_ROUTE }} \ + -p ENVIRONMENT=${{ env.APP_ENVIRONMENT }} \ + | oc apply -f - + + # Process update-configmap + curl -s https://raw.githubusercontent.com/bcgov/${{ env.REPO_NAME }}/${{ env.BRANCH }}/tools/config/update-configmap.sh \ + | bash /dev/stdin \ + ${{ env.APP_ENVIRONMENT }} \ + ${{ env.APP_NAME }} \ + ${{ env.NAMESPACE }} \ + ${{ env.COMMON_NAMESPACE }} \ + ${{ secrets.D365_API_PREFIX }} \ + ${{ secrets.D365_API_KEY_HEADER }} \ + ${{ secrets.D365_API_KEY_VALUE }} \ + ${{ secrets.SOAM_CLIENT_ID }} \ + ${{ secrets.SOAM_CLIENT_SECRET }} \ + ${{ secrets.SOAM_IDP_HINT_BCEID }} \ + ${{ secrets.SOAM_IDP_HINT_IDIR }} \ + ${{ secrets.SPLUNK_TOKEN }} + + # Start rollout (if necessary) and follow it + oc rollout latest dc/${{ env.APP_NAME }}-${{ env.APP_NAME_BACKEND }}-${{ env.APP_ENVIRONMENT }} 2> /dev/null \ + || true && echo "Rollout in progress" + + # Get status, returns 0 if rollout is successful + oc rollout status dc/${{ env.APP_NAME }}-${{ env.APP_NAME_BACKEND }}-${{ env.APP_ENVIRONMENT }} diff --git a/.github/workflows/deploy-to-openshift-backend-prod.yml b/.github/workflows/deploy-to-openshift-backend-prod.yml index 6aa9b378..06495cef 100644 --- a/.github/workflows/deploy-to-openshift-backend-prod.yml +++ b/.github/workflows/deploy-to-openshift-backend-prod.yml @@ -1,5 +1,4 @@ -# OFM Backend PROD workflow -name: 4 PROD - Deploy Backend +name: 5 PROD - Deploy Backend env: # 🖊️ EDIT your repository secrets to log into your OpenShift cluster and set up the context. @@ -142,7 +141,7 @@ jobs: # Process update-configmap curl -s https://raw.githubusercontent.com/bcgov/${{ env.REPO_NAME }}/${{ env.BRANCH }}/tools/config/update-configmap.sh \ | bash /dev/stdin \ - prod \ + ${{ env.APP_ENVIRONMENT }} \ ${{ env.APP_NAME }} \ ${{ env.NAMESPACE }} \ ${{ env.COMMON_NAMESPACE }} \ diff --git a/.github/workflows/deploy-to-openshift-backend-test.yml b/.github/workflows/deploy-to-openshift-backend-test.yml index 820d1df0..e0365e37 100644 --- a/.github/workflows/deploy-to-openshift-backend-test.yml +++ b/.github/workflows/deploy-to-openshift-backend-test.yml @@ -1,4 +1,3 @@ -# OFM Backend QA workflow name: 2 QA - Deploy Backend env: @@ -138,7 +137,7 @@ jobs: # Process update-configmap curl -s https://raw.githubusercontent.com/bcgov/${{ env.REPO_NAME }}/${{ env.BRANCH }}/tools/config/update-configmap.sh \ | bash /dev/stdin \ - test \ + ${{ env.APP_ENVIRONMENT }} \ ${{ env.APP_NAME }} \ ${{ env.NAMESPACE }} \ ${{ env.COMMON_NAMESPACE }} \ diff --git a/.github/workflows/deploy-to-openshift-backend-uat.yml b/.github/workflows/deploy-to-openshift-backend-uat.yml index 6991fa29..d249ed9a 100644 --- a/.github/workflows/deploy-to-openshift-backend-uat.yml +++ b/.github/workflows/deploy-to-openshift-backend-uat.yml @@ -1,4 +1,3 @@ -# OFM Backend UAT workflow name: 3 UAT - Deploy Backend env: @@ -141,7 +140,7 @@ jobs: # Process update-configmap curl -s https://raw.githubusercontent.com/bcgov/${{ env.REPO_NAME }}/${{ env.BRANCH }}/tools/config/update-configmap.sh \ | bash /dev/stdin \ - uat \ + ${{ env.APP_ENVIRONMENT }} \ ${{ env.APP_NAME }} \ ${{ env.NAMESPACE }} \ ${{ env.COMMON_NAMESPACE }} \ diff --git a/.github/workflows/deploy-to-openshift-frontend-dev.yml b/.github/workflows/deploy-to-openshift-frontend-dev.yml index 9d04c523..8b339a70 100644 --- a/.github/workflows/deploy-to-openshift-frontend-dev.yml +++ b/.github/workflows/deploy-to-openshift-frontend-dev.yml @@ -1,4 +1,3 @@ -# OFM Frontend DEV workflow name: 1 DEV - Deploy Frontend env: diff --git a/.github/workflows/deploy-to-openshift-frontend-efx.yml b/.github/workflows/deploy-to-openshift-frontend-efx.yml new file mode 100644 index 00000000..8816a05a --- /dev/null +++ b/.github/workflows/deploy-to-openshift-frontend-efx.yml @@ -0,0 +1,159 @@ +name: 4 EFX - Deploy Frontend + +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.OFM_NAMESPACE_NO_ENV }}-test + + # 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 }} + + APP_NAME: 'ofm' + REPO_NAME: 'ecc-ofm' + #grabs the branch name from github dynamically + BRANCH: ${{ github.ref_name }} + IMAGE_NAME: 'ecc-ofm-frontend' + APP_NAME_FRONTEND: 'frontend' + # We have multiple environments in each openshift namespace dev, test in DEV and uat, efx in TEST. This setting will help name the deployment config and routes for each. + APP_ENVIRONMENT: 'efx' + + NAMESPACE: ${{ secrets.OFM_NAMESPACE_NO_ENV }} + + MIN_REPLICAS: '2' + MAX_REPLICAS: '3' + MIN_CPU: '50m' + MAX_CPU: '100m' + MIN_MEM: '200Mi' + MAX_MEM: '250Mi' + # SITE_URL should have no scheme or port. It will be prepended with https:// + HOST_ROUTE: ${{ secrets.SITE_URL }} + CA_CERT: ${{ secrets.CA_CERT }} + CERTIFICATE: ${{ secrets.CERTIFICATE }} + PRIVATE_KEY: ${{ secrets.PRIVATE_KEY }} + + # Frontend configuration + BANNER_ENVIRONMENT: 'EFX' + BANNER_COLOR: '#006600' + TDAD_CONTACT_EMAIL: '10aDayCentres@gov.bc.ca' + CCOF_URL: 'https://test.mychildcareservices.gov.bc.ca' + IRREGULAR_EXPENSE_FORM_URL: 'https://www2.gov.bc.ca/assets/download/80DAA65E3FA44EFCA61F4557C6FAEE59' + +on: + workflow_dispatch: + +jobs: + openshift-ci-cd: + name: Deploy Frontend to EFX + runs-on: ubuntu-24.04 + environment: efx + + 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 with branch [${{ env.BRANCH }}] + uses: actions/checkout@v3 + with: + ref: ${{ env.BRANCH }} + + - 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.16 + + - 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.APP_NAME }}-${{ env.APP_NAME_FRONTEND }}-${{ env.APP_ENVIRONMENT }} 2> /dev/null \ + || true && echo "No rollout in progress" + + # Create the image stream if it doesn't exist + oc create imagestream ${{ env.IMAGE_NAME }} 2> /dev/null || true && echo "frontend image stream in place" + + # Create tag for EFX env from DEV env image + oc tag ${{ env.NAMESPACE }}-dev/${{ env.REPO_NAME }}-${{ env.APP_NAME_FRONTEND }}:${{ steps.get-latest-tag.outputs.tag }} ${{ env.NAMESPACE }}-test/${{ env.REPO_NAME }}-${{ env.APP_NAME_FRONTEND }}:${{ steps.get-latest-tag.outputs.tag }} + + # Process and apply deployment template + oc process \ + -f tools/openshift/frontend.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 }} \ + -p ENVIRONMENT=${{ env.APP_ENVIRONMENT }} \ + -p BANNER_ENVIRONMENT=${{ env.BANNER_ENVIRONMENT }} \ + -p BANNER_COLOR=${{ env.BANNER_COLOR }} \ + -p TDAD_CONTACT_EMAIL=${{ env.TDAD_CONTACT_EMAIL }} \ + -p CCOF_URL=${{ env.CCOF_URL }} \ + -p IRREGULAR_EXPENSE_FORM_URL=${{ env.IRREGULAR_EXPENSE_FORM_URL }} \ + | oc apply -f - + + # Start rollout (if necessary) and follow it + oc rollout latest dc/${{ env.APP_NAME }}-${{ env.APP_NAME_FRONTEND }}-${{ env.APP_ENVIRONMENT }} 2> /dev/null \ + || true && echo "Rollout in progress" + + # Get status, returns 0 if rollout is successful + oc rollout status dc/${{ env.APP_NAME }}-${{ env.APP_NAME_FRONTEND }}-${{ env.APP_ENVIRONMENT }} diff --git a/.github/workflows/deploy-to-openshift-frontend-prod.yml b/.github/workflows/deploy-to-openshift-frontend-prod.yml index 126af2ea..bb6ad73c 100644 --- a/.github/workflows/deploy-to-openshift-frontend-prod.yml +++ b/.github/workflows/deploy-to-openshift-frontend-prod.yml @@ -1,5 +1,4 @@ -# OFM Frontend PROD workflow -name: 4 PROD - Deploy Frontend +name: 5 PROD - Deploy Frontend env: # 🖊️ EDIT your repository secrets to log into your OpenShift cluster and set up the context. diff --git a/.github/workflows/deploy-to-openshift-frontend-test.yml b/.github/workflows/deploy-to-openshift-frontend-test.yml index 303215eb..4e2c8cb5 100644 --- a/.github/workflows/deploy-to-openshift-frontend-test.yml +++ b/.github/workflows/deploy-to-openshift-frontend-test.yml @@ -1,4 +1,3 @@ -# OFM Frontend QA workflow name: 2 QA - Deploy Frontend env: diff --git a/.github/workflows/deploy-to-openshift-frontend-uat.yml b/.github/workflows/deploy-to-openshift-frontend-uat.yml index 078a9c3b..06bc3843 100644 --- a/.github/workflows/deploy-to-openshift-frontend-uat.yml +++ b/.github/workflows/deploy-to-openshift-frontend-uat.yml @@ -1,4 +1,3 @@ -# OFM Frontend UAT workflow name: 3 UAT - Deploy Frontend env: