What problem does it solve?
Prevents silent traffic drops, CI gate failures, and runtime misconfigurations by documenting Emerald-specific OpenShift requirements such as AVI route annotations, DataClass pod labels, PriorityClass enforcement, storage selection, and Helm settings so reviewers and engineers can apply consistent platform controls.
Core Features & Use Cases
- AVI route mapping: guidance on the aviinfrasetting annotation values and when to use private vs public VIPs to avoid ERR_EMPTY_RESPONSE.
- Pod labels & policy compliance: required DataClass, owner, environment, and Internet-Ingress labels to satisfy ag-devops Datree/Conftest rules and to align with default-deny NetworkPolicy expectations.
- Helm and runtime settings: mandates global.openshift: true, recommends netapp-file-standard StorageClass, and explains PriorityClass and DNS split-tunneling considerations for debugging and deployment.
- Use cases: review Helm charts and deployment manifests before PRs, triage route connectivity issues, and prepare applications to pass platform policy gates.
Quick Start
Use bc-gov-emerald to validate a Helm chart or manifest for Emerald compliance by checking aviinfrasetting annotations, DataClass and Internet-Ingress labels, global.openshift, PriorityClass presence, StorageClass, and Route termination rules.