Skip to content

Commit

Permalink
feat: pull nginx deployment out of development flow
Browse files Browse the repository at this point in the history
  • Loading branch information
trev-dev committed Nov 18, 2024
1 parent acda8e0 commit aae838c
Show file tree
Hide file tree
Showing 3 changed files with 171 additions and 85 deletions.
41 changes: 1 addition & 40 deletions .github/workflows/deploy-to-openshift-backend-dev.yml
Original file line number Diff line number Diff line change
Expand Up @@ -35,12 +35,6 @@ env:
MIN_MEM: "200Mi"
MAX_MEM: "700Mi"

MIN_REPLICAS_NGINX: "1"
MAX_REPLICAS_NGINX: "2"
MIN_CPU_NGINX: "50m"
MAX_CPU_NGINX: "100m"
MIN_MEM_NGINX: "200Mi"
MAX_MEM_NGINX: "250Mi"
# SITE_URL should have no scheme or port. It will be prepended with https://
HOST_ROUTE: ${{ secrets.SITE_URL }}

Expand Down Expand Up @@ -150,9 +144,6 @@ jobs:
oc rollout cancel deployment/${{ env.APP_NAME }}-${{ env.IMAGE_NAME }}-${{ env.APP_ENVIRONMENT }} 2> /dev/null \
|| true && echo "No rollout in progress"
oc rollout cancel deployment/${{ env.APP_NAME }}-nginx-${{ env.APP_ENVIRONMENT }} 2> /dev/null \
|| true && echo "No rollout in progress"
oc tag \
${{ steps.push-image-backend.outputs.registry-path }} \
${{ env.REPO_NAME }}-${{ env.IMAGE_NAME }}-${{ env.BRANCH }}:${{ env.TAG }}
Expand All @@ -175,28 +166,6 @@ jobs:
-p APP_ENVIRONMENT=${{ env.APP_ENVIRONMENT }} \
| oc apply -f -
# Process and apply nginx deployment template
oc process \
-f tools/openshift/nginx.deployment.yaml \
-p APP_NAME=${{ env.APP_NAME }} \
-p REPO_NAME=${{ env.REPO_NAME }} \
-p BRANCH=${{ env.BRANCH }} \
-p NAMESPACE=${{ env.OPENSHIFT_NAMESPACE }} \
-p MIN_REPLICAS=${{ env.MIN_REPLICAS_NGINX }} \
-p MAX_REPLICAS=${{ env.MAX_REPLICAS_NGINX }} \
-p MIN_CPU=${{ env.MIN_CPU_NGINX }} \
-p MAX_CPU=${{ env.MAX_CPU_NGINX }} \
-p MIN_MEM=${{ env.MIN_MEM_NGINX }} \
-p MAX_MEM=${{ env.MAX_MEM_NGINX }} \
-p HOST_ROUTE=${{ secrets.NGINX_HOST_ROUTE }} \
-p APP_ENVIRONMENT=${{ env.APP_ENVIRONMENT }} \
-p NGINX_BASIC_AUTH_TOKEN=${{ secrets.NGINX_BASIC_AUTH_TOKEN }} \
| oc apply -f -
cat <<- \EOF | sed 's/^ \+//g' > /tmp/nginx_htpasswd
${{ secrets.NGINX_HTPASSWD_FILE }}
EOF
# Process update-configmap
curl -s https://raw.githubusercontent.com/bcgov/${{ env.REPO_NAME }}/${{ env.BRANCH }}/tools/config/update-configmap.sh \
| bash /dev/stdin \
Expand All @@ -210,8 +179,7 @@ jobs:
${{ secrets.SOAM_CLIENT_SECRET_IDIR }} \
${{ secrets.SPLUNK_TOKEN }} \
${{ secrets.REDIS_PASSWORD }} \
${{ secrets.D365_API_PREFIX }} \
/tmp/nginx_htpasswd
${{ secrets.D365_API_PREFIX }}
# Start rollout of the application
oc rollout restart deployment/${{ env.APP_NAME }}-${{ env.IMAGE_NAME }}-${{ env.APP_ENVIRONMENT }} 2> /dev/null \
Expand All @@ -220,13 +188,6 @@ jobs:
# Get status, returns 0 if rollout is successful
oc rollout status deployment/${{ env.APP_NAME }}-${{ env.IMAGE_NAME }}-${{ env.APP_ENVIRONMENT }}
# Start rollout of nginx
oc rollout restart deployment/${{ env.APP_NAME }}-nginx-${{ env.APP_ENVIRONMENT }} 2> /dev/null \
|| true && echo "Rollout in progress"
# Get status, returns 0 if rollout is successful
oc rollout status deployment/${{ env.APP_NAME }}-${{ env.IMAGE_NAME }}-${{ env.APP_ENVIRONMENT }}
- name: ZAP Scan
uses: zaproxy/[email protected]
with:
Expand Down
170 changes: 170 additions & 0 deletions .github/workflows/deploy-to-openshift-nginx-dev.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,170 @@
name: Deploy Nginx Proxy

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_PASSWORD: ${{ github.token }}

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

APP_NAME: "ccof"
REPO_NAME: "educ-ccof"
# grabs the branch name from github dynamically
BRANCH: ${{ github.ref_name }}
APP_ENVIRONMENT: "dev"

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

on:
workflow_dispatch:

jobs:
openshift-ci-cd:
name: Deploy nginx reverse proxy to Openshift
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@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 with branch [${{ env.BRANCH }}]
uses: actions/checkout@v2
with:
ref: ${{ env.BRANCH }}

- 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 deployment/${{ env.APP_NAME }}-nginx-${{ env.APP_ENVIRONMENT }} 2> /dev/null \
|| true && echo "No rollout in progress"
# Process and apply nginx deployment template
oc process \
-f tools/openshift/nginx.deployment.yaml \
-p APP_NAME=${{ env.APP_NAME }} \
-p REPO_NAME=${{ env.REPO_NAME }} \
-p BRANCH=${{ env.BRANCH }} \
-p NAMESPACE=${{ env.OPENSHIFT_NAMESPACE }} \
-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=${{ secrets.NGINX_HOST_ROUTE }} \
-p APP_ENVIRONMENT=${{ env.APP_ENVIRONMENT }} \
-p NGINX_BASIC_AUTH_TOKEN=${{ secrets.NGINX_BASIC_AUTH_TOKEN }} \
| oc apply -f -
API_CLUSTER_ADDRESS="http://${{ secrets.D365_API_PREFIX }}-${{ env.APP_ENVIRONMENT }}.${{ env.OPENSHIFT_NAMESPACE }}.svc.cluster.local:5091"
# Generate and apply ConfigMap
cat << CONF > /tmp/nginx_conf
server {
listen 8080 default_server;
location / {
proxy_ignore_client_abort on;
proxy_pass $API_CLUSTER_ADDRESS;
proxy_redirect off;
proxy_set_header X-Real-IP \$remote_addr;
proxy_set_header X-Forwarded-For \$proxy_add_x_forwarded_for;
proxy_set_header Host \$http_host;
expires -1;
proxy_no_cache 1;
auth_basic "Authentication Required";
auth_basic_user_file /etc/nginx/conf.d/htpasswd;
}
location /api/Health {
proxy_ignore_client_abort on;
proxy_pass $API_CLUSTER_ADDRESS/api/Health;
proxy_redirect off;
proxy_set_header X-Real-IP \$remote_addr;
proxy_set_header X-Forwarded-For \$proxy_add_x_forwarded_for;
proxy_set_header Host \$http_host;
expires -1;
proxy_no_cache 1;
}
}
CONF
cat <<- \EOF | sed 's/^ \+//g' > /tmp/nginx_htpasswd
${{ secrets.NGINX_HTPASSWD_FILE }}
EOF
echo Creating config map "${{ env.APP_NAME }}-nginx-config-map"
oc create -n "${{ env.OPENSHIFT_NAMESPACE }}" \
configmap "${{ env.APP_NAME }}-nginx-config-map" \
--from-file=default.conf=/tmp/nginx_conf \
--from-file=htpasswd=/tmp/nginx_htpasswd \
--dry-run=client -o yaml | oc apply -f -
# Start rollout of nginx
oc rollout restart deployment/${{ env.APP_NAME }}-nginx-${{ env.APP_ENVIRONMENT }} 2> /dev/null \
|| true && echo "Rollout in progress"
# Get status, returns 0 if rollout is successful
oc rollout status deployment/${{ env.APP_NAME }}-nginx-${{ env.APP_ENVIRONMENT }}
45 changes: 0 additions & 45 deletions tools/config/update-configmap.sh
Original file line number Diff line number Diff line change
Expand Up @@ -11,7 +11,6 @@ readonly SOAM_CLIENT_SECRET_IDIR=$8
readonly SPLUNK_TOKEN=$9
readonly REDIS_PASSWORD=${10}
readonly D365_API_PREFIX=${11}
readonly NGINX_HTPASSWD_FILE=${12:-unset}
readonly SOAM_KC_REALM_ID="standard"
readonly D365_API_ENDPOINT="http://$D365_API_PREFIX-$ENV_VAL:5091"
readonly TIMEZONE="America/Vancouver"
Expand Down Expand Up @@ -114,50 +113,6 @@ oc create -n "$OPENSHIFT_NAMESPACE" configmap \
--from-literal="ISSUER=EDUC_CCOF" \
--dry-run=client -o yaml | oc apply -f -

if [ "$ENV_VAL" = 'dev' ]; then
API_CLUSTER_ADDRESS="http://$D365_API_PREFIX-$ENV_VAL.$OPENSHIFT_NAMESPACE.svc.cluster.local:5091"

cat << CONF > /tmp/nginx_conf
server {
listen 8080 default_server;
location / {
proxy_ignore_client_abort on;
proxy_pass $API_CLUSTER_ADDRESS;
proxy_redirect off;
proxy_set_header X-Real-IP \$remote_addr;
proxy_set_header X-Forwarded-For \$proxy_add_x_forwarded_for;
proxy_set_header Host \$http_host;
expires -1;
proxy_no_cache 1;
auth_basic "Authentication Required";
auth_basic_user_file /etc/nginx/conf.d/htpasswd;
}
location /api/Health {
proxy_ignore_client_abort on;
proxy_pass $API_CLUSTER_ADDRESS/api/Health;
proxy_redirect off;
proxy_set_header X-Real-IP \$remote_addr;
proxy_set_header X-Forwarded-For \$proxy_add_x_forwarded_for;
proxy_set_header Host \$http_host;
expires -1;
proxy_no_cache 1;
}
}
CONF

if [ "$NGINX_HTPASSWD_FILE" != 'unset' ]; then
echo Creating config map "$APP_NAME-nginx-config-map"
oc create -n "$OPENSHIFT_NAMESPACE" \
configmap "$APP_NAME-nginx-config-map" \
--from-file=default.conf=/tmp/nginx_conf \
--from-file=htpasswd="$NGINX_HTPASSWD_FILE" \
--dry-run=client -o yaml | oc apply -f -
else
echo "Nginx htpasswd file unset, cannot create nginx config map!"
exit 1
fi
fi

if [ "$ENV_VAL" != 'qa' ]; then
SPLUNK_URL="gww.splunk.educ.gov.bc.ca"
FLB_CONFIG="[SERVICE]
Expand Down

0 comments on commit aae838c

Please sign in to comment.