Governance App Deployment On Container

Deploying the Governance App on Red Hat OpenShift Service on AWS (ROSA) involves Helm-based configuration, environment variable injection, and proper domain and certificate setup. This document outlines the deployment process in a structured format, covering prerequisites, Helm chart changes, configuration file updates, and final verification.

Prerequisites

Before starting the deployment, ensure the following:

• Domain Name: A registered domain (e.g., https://<domain>) to expose the Governance App.

• ACM Certificate: An AWS Certificate Manager (ACM) certificate for the above domain (for LoadBalancer SSL termination).

• Access: Sufficient permissions to modify and deploy Helm charts in the OpenShift environment.

• gov.zip: Contains deployment and service templates for the Governance App (provided by OvalEdge).

Steps for Governance App Deployment on Container

Adding Templates to Helm Chart

Navigate to the Helm chart directory where the OvalEdge application is managed.

Extract gov.zip provided by OvalEdge.

Copy the following into the templates/ directory of the Helm chart:

• gov-deployment.yaml

• gov-service.yaml

Modify UI and Job Deployment Files

Update environment variables for the OvalEdge UI and Job pods to connect with Governance App:

Update User Deployment File

• Locate the container’s environment variables section.

  Open userdeployment.yaml from the helm chart directory. add under container env:

  - name: GOV_APP_HOST
    value: {{ .Values.gov.HOST }}
  - name: GOV_APP_PORT
    value: {{ .Values.gov.PORT }}
  - name: GOV_APP_PROTOCOL
    value: {{ .Values.gov.PROTOCOL }}

Update Job Deployment File

• Open jobdeployment.yaml

• Locate the container’s environment variables section.

• Add the same environment variables as above:

  - name: GOV_APP_HOST
    value: {{ .Values.gov.HOST }}
  - name: GOV_APP_PORT
    value: {{ .Values.gov.PORT }}
  - name: GOV_APP_PROTOCOL
    value: {{ .Values.gov.PROTOCOL }}

Update values.yaml Configuration

Add Governance App Image Reference

In the Add gov_image with the actual image name provided by the OvalEdge team:

  gov_image: <actual_image_name>

Add Governance Service Section

Add the Governance App service configuration block:

gov:
  HOST: gov-service
  PORT: 8081
  PROTOCOL: http
  replicas: 2
  resources:
    requests:
      cpu: 500m
      memory: 1Gi
    limits:
      cpu: 1
      memory: 2Gi
  service:
    type: LoadBalancer
    port: 443
  loadBalancer:
    cert: "arn-of-certificate"

👉 Best Practices Added:

• replicas: ensures HA by running ≥2 pods.

• resources: enforces requests/limits for stability.

Apply Helm Upgrade

helm upgrade --install ovedge ./helm-chart -f values.yaml

Post-Deployment Validation

Health Check

• Open: https://<domain>/actuator/health

• Confirm status = "UP".

TLS & Domain Validation

• Verify DNS resolves to LoadBalancer.

• Confirm ACM certificate is correctly attached.

Application Integration

• To register the Governance App domain in the OvalEdge application:

  • Log in to the OvalEdge application.

  • Navigate to: Administration → System Settings → Others.

  • Locate the key for Gov App.

  • Update the value with the Governance App’s domain name.

    

Observability

• If issues occur after deployment:

  • Re-check the gov-deployment.yaml and gov-service.yaml configurations.

  • Verify if the domain resolves correctly and the ACM certificate is properly attached to the LoadBalancer.

  • Inspect Helm logs or use kubectl describe and kubectl logs for pod-level diagnostics.

---

Copyright © 2025, OvalEdge LLC, Peachtree Corners, GA, USA.

---