chore: naming and label format deployments (env and PR number) (#6)

Author: PaulGreywal

.github/workflows/deploy.yml

@@ -19,6 +19,10 @@ on:
         description: Deployment target; usually PR number, test or prod
         default: ${{ github.event.number }}
         type: string
+      zone:
+        description: Deployment zone; usually PR number, test or prod
+        default: ${{ github.event.number }}
+        type: string
       triggers:
         description: List of directories to trigger the deployment
         default: 'frontend backend'
@@ -39,9 +43,12 @@ jobs:
           oc_namespace: ${{ vars.OC_NAMESPACE }}
           oc_server: ${{ vars.OC_SERVER }}
           oc_token: ${{ secrets.OC_TOKEN }}
-          file: common/openshift.init.yml
+          file: common/openshift.database.yml
           overwrite: true
           parameters: |
+            -p NAME=nrpti
+            -p ZONE=${{ inputs.zone || inputs.target || 'dev' }}
+            -p COMPONENT=mongodb
             -p TAG=${{ inputs.tag }}
             -p TARGET=${{ inputs.target }}
           triggers: ${{ inputs.triggers }}

.github/workflows/pr-open.yml

@@ -53,11 +53,7 @@ jobs:
           oc_token: ${{ secrets.oc_token }}
           file: ./common/openshift.database.yml
           overwrite: true
-          parameters:
-            -p MONGODB_ADMIN_PASSWORD=${{ secrets.MONGODB_ADMIN_PASSWORD }}
-            -p MONGODB_DATABASE_NAME=${{ secrets.MONGODB_DATABASE_NAME }}
-            -p MONGODB_USER=${{ secrets.MONGODB_USER }}
-            -p MONGODB_PASSWORD=${{ secrets.MONGODB_PASSWORD }}
+          parameters: -p NAME=nrpti -p ZONE=${{ github.event.number }} -p COMPONENT=mongodb -p MONGODB_ADMIN_PASSWORD=${{ secrets.MONGODB_ADMIN_PASSWORD }} -p MONGODB_DATABASE_NAME=${{ secrets.MONGODB_DATABASE_NAME }} -p MONGODB_USER=${{ secrets.MONGODB_USER }} -p MONGODB_PASSWORD=${{ secrets.MONGODB_PASSWORD }}
 
   deploy:
     name: Deploy
@@ -69,10 +65,12 @@ jobs:
         include:
           - package: api
             file: ./tools/api/api.dc.yaml
+            component: api
           # - component: admin-nrpti
           #   file: ./tools/angular-on-nginx/admin-nrced.dc.yaml
           - package: public-nrpti
             file: ./tools/angular-on-nginx/public-nrced.dc.yaml
+            component: nrced
     steps:
       - name: Deploy ${{ matrix.package }}
         uses: bcgov/action-deployer-openshift@v4.0.0
@@ -82,6 +80,7 @@ jobs:
           oc_token: ${{ secrets.oc_token }}
           file: ${{ matrix.file }}
           overwrite: true
+          parameters: -p NAME=nrpti -p ZONE=${{ github.event.number }} -p COMPONENT=${{ matrix.component }} -p GROUP_NAME=nrpti 
 
   # # https://github.com/bcgov/action-deploy-ghcr
   # deploys:

.github/workflows/pr-validate.yml

@@ -19,8 +19,8 @@ jobs:
     uses: bcgov/quickstart-openshift-helpers/.github/workflows/.pr-validate.yml@0b8121a528aaa05ef8def2f79be9081691dfe98a # v0.9.0
     with:
       markdown_links: |
-        - [Frontend](https://${{ github.event.repository.name }}-${{ github.event.number }}-frontend.apps.silver.devops.gov.bc.ca)
-        - [Backend](https://${{ github.event.repository.name }}-${{ github.event.number }}-frontend.apps.silver.devops.gov.bc.ca/api)
+        - [Frontend](https://nrpti-${{ github.event.number }}-nrced-${{ vars.OC_ENV || 'f00029-dev' }}.apps.silver.devops.gov.bc.ca)
+        - [Backend](https://nrpti-${{ github.event.number }}-api-${{ vars.OC_ENV || 'f00029-dev' }}.apps.silver.devops.gov.bc.ca)
 
   results:
     name: Validate Results

common/openshift.database.yml

@@ -1,15 +1,23 @@
 kind: Template
 apiVersion: template.openshift.io/v1
 metadata:
-  name: ${NAME}-mongodb
+  name: ${NAME}-${ZONE}-mongodb
   labels:
-    template: ${NAME}-mongodb
-    app: ${GROUP_NAME}
+    template: ${NAME}-${ZONE}-mongodb
+    app: ${NAME}-${ZONE}
 parameters:
   - name: NAME
     displayName: Name
     description: The name assigned to all of the frontend objects defined in this template.
     value: nrpti
+  - name: ZONE
+    displayName: Deployment Zone
+    description: The zone or environment (dev, test, prod, PR number)
+    required: true
+  - name: COMPONENT
+    displayName: Component Name
+    description: The component part of the name (mongodb, api, etc)
+    value: mongodb
   - name: GROUP_NAME
     displayName: Group Name
     description: The name assigned to a group of objects deployed together
@@ -73,7 +81,7 @@ objects:
   - kind: Secret
     apiVersion: v1
     metadata:
-      name: ${NAME}-mongodb
+      name: ${NAME}-${ZONE}-${COMPONENT}
     stringData:
       MONGODB_ADMIN_PASSWORD: ${MONGODB_ADMIN_PASSWORD}
       MONGODB_DATABASE: ${MONGODB_DATABASE_NAME}
@@ -83,9 +91,10 @@ objects:
   - kind: PersistentVolumeClaim
     apiVersion: v1
     metadata:
-      name: ${NAME}-mongodb-data
+      name: ${NAME}-${ZONE}-${COMPONENT}-data
       labels:
-        app: ${GROUP_NAME}
+        app: ${NAME}-${ZONE}
+        component: ${COMPONENT}
     spec:
       accessModes:
         - ReadWriteOnce
@@ -95,22 +104,24 @@ objects:
   - kind: Service
     apiVersion: v1
     metadata:
-      name: mongodb
+      name: ${NAME}-${ZONE}-${COMPONENT}
       labels:
-        app: ${GROUP_NAME}
+        app: ${NAME}-${ZONE}
+        component: ${COMPONENT}
     spec:
       ports:
-        - name: mongodb-${NAME}
+        - name: ${COMPONENT}-${NAME}
           port: 27017
           targetPort: 27017
       selector:
-        name: ${NAME}-mongodb
+        name: ${NAME}-${ZONE}-${COMPONENT}
   - kind: Deployment
     apiVersion: apps/v1
     metadata:
-      name: ${NAME}-mongodb
+      name: ${NAME}-${ZONE}-${COMPONENT}
       labels:
-        app: ${GROUP_NAME}
+        app: ${NAME}-${ZONE}
+        component: ${COMPONENT}
         role: database
     spec:
       strategy:
@@ -120,48 +131,49 @@ objects:
           imageChangeParams:
             automatic: true
             containerNames:
-              - ${NAME}-mongodb
+              - ${NAME}-${ZONE}-${COMPONENT}
             from:
               kind: ImageStreamTag
               namespace: ${APP_IMAGE_NAMESPACE}
               name: mongodb:${MONGO_VER}
       replicas: 1
       selector:
         matchLabels:
-          name: ${NAME}-mongodb
+          name: ${NAME}-${ZONE}-${COMPONENT}
       template:
         metadata:
-          name: ${NAME}-mongodb
+          name: ${NAME}-${ZONE}-${COMPONENT}
           labels:
-            name: ${NAME}-mongodb
-            app: ${GROUP_NAME}
+            name: ${NAME}-${ZONE}-${COMPONENT}
+            app: ${NAME}-${ZONE}
+            component: ${COMPONENT}
             role: database
         spec:
           containers:
-            - name: ${NAME}-mongodb
+            - name: ${NAME}-${ZONE}-${COMPONENT}
               image: image-registry.openshift-image-registry.svc:5000/${APP_IMAGE_NAMESPACE}/mongodb:${MONGO_VER}
               ports:
                 - containerPort: 27017
               env:
                 - name: MONGODB_USER
                   valueFrom:
                     secretKeyRef:
-                      name: ${NAME}-mongodb
+                      name: ${NAME}-${ZONE}-${COMPONENT}
                       key: MONGODB_USERNAME
                 - name: MONGODB_PASSWORD
                   valueFrom:
                     secretKeyRef:
-                      name: ${NAME}-mongodb
+                      name: ${NAME}-${ZONE}-${COMPONENT}
                       key: MONGODB_PASSWORD
                 - name: MONGODB_DATABASE
                   valueFrom:
                     secretKeyRef:
-                      name: ${NAME}-mongodb
+                      name: ${NAME}-${ZONE}-${COMPONENT}
                       key: MONGODB_DATABASE
                 - name: MONGODB_ADMIN_PASSWORD
                   valueFrom:
                     secretKeyRef:
-                      name: ${NAME}-mongodb
+                      name: ${NAME}-${ZONE}-${COMPONENT}
                       key: MONGODB_ADMIN_PASSWORD
               readinessProbe:
                 timeoutSeconds: 5
@@ -186,9 +198,9 @@ objects:
                   cpu: ${DATABASE_CPU_REQUESTS}
                   memory: ${DATABASE_MEMORY_REQUESTS}
               volumeMounts:
-                - name: ${NAME}-mongodb-data
+                - name: ${NAME}-${ZONE}-${COMPONENT}-data
                   mountPath: /var/lib/mongodb/data
           volumes:
-            - name: ${NAME}-mongodb-data
+            - name: ${NAME}-${ZONE}-${COMPONENT}-data
               persistentVolumeClaim:
-                claimName: ${NAME}-mongodb-data
+                claimName: ${NAME}-${ZONE}-${COMPONENT}-data

tools/angular-on-nginx/public-nrced.dc.yaml

@@ -1,35 +1,38 @@
 apiVersion: template.openshift.io/v1
 kind: Template
 metadata:
-  name: ${NAME}
+  name: ${NAME}-${ZONE}-${COMPONENT}
 objects:
   - kind: Service
     apiVersion: v1
     metadata:
-      name: ${NAME}
+      name: ${NAME}-${ZONE}-${COMPONENT}
       labels:
-        app: ${GROUP_NAME}
+        app: ${NAME}-${ZONE}
+        component: ${COMPONENT}
     spec:
       ports:
         - name: 8080-tcp
           protocol: TCP
           port: 8080
           targetPort: 8080
       selector:
-        app: ${GROUP_NAME}
-        deployment: ${NAME}
+        app: ${NAME}-${ZONE}
+        component: ${COMPONENT}
+        deployment: ${NAME}-${ZONE}-${COMPONENT}
       type: ClusterIP
   - kind: Route
     apiVersion: route.openshift.io/v1
     metadata:
-      name: ${NAME}
+      name: ${NAME}-${ZONE}-${COMPONENT}
       labels:
-        app: ${GROUP_NAME}
+        app: ${NAME}-${ZONE}
+        component: ${COMPONENT}
     spec:
-      host: ${NAME}-${Host}
+      host: ${NAME}-${ZONE}-${COMPONENT}-${Host}
       to:
         kind: Service
-        name: ${NAME}
+        name: ${NAME}-${ZONE}-${COMPONENT}
         weight: 100
       port:
         targetPort: 8080-tcp
@@ -40,9 +43,10 @@ objects:
   - kind: Deployment
     apiVersion: apps/v1
     metadata:
-      name: ${NAME}
+      name: ${NAME}-${ZONE}-${COMPONENT}
       labels:
-        app: ${GROUP_NAME}
+        app: ${NAME}-${ZONE}
+        component: ${COMPONENT}
         role: frontend
     spec:
       strategy:
@@ -51,17 +55,19 @@ objects:
       revisionHistoryLimit: 5
       selector:
         matchLabels:
-          app: ${GROUP_NAME}
-          deployment: ${NAME}
+          app: ${NAME}-${ZONE}
+          component: ${COMPONENT}
+          deployment: ${NAME}-${ZONE}-${COMPONENT}
       template:
         metadata:
           labels:
-            app: ${GROUP_NAME}
-            deployment: ${NAME}
+            app: ${NAME}-${ZONE}
+            component: ${COMPONENT}
+            deployment: ${NAME}-${ZONE}-${COMPONENT}
             role: frontend
         spec:
           containers:
-            - name: ${NAME}
+            - name: ${NAME}-${ZONE}-${COMPONENT}
               image: image-registry.openshift-image-registry.svc:5000/${RUNTIME_IMAGE_NAMESPACE}/${RUNTIME_IMAGE_NAME}:${RUNTIME_IMAGE_TAG}
               ports:
                 - containerPort: 8080
@@ -112,9 +118,18 @@ objects:
           securityContext: {}
           schedulerName: default-scheduler
 parameters:
-  - description: A name used for all objects
+  - name: NAME
+    description: The name assigned to all of the frontend objects defined in this template.
     displayName: Name
-    name: NAME
+    required: true
+    value: nrpti
+  - name: ZONE
+    description: Deployment zone (dev, test, prod or PR number)
+    displayName: Deployment Zone
+    required: true
+  - name: COMPONENT
+    description: Component name
+    displayName: Component
     required: true
     value: nrced
   - description: A name used for all objects in the build or deploy group