diff --git a/Chart.yaml b/Chart.yaml index 33380a0..8585ae1 100644 --- a/Chart.yaml +++ b/Chart.yaml @@ -3,7 +3,7 @@ description: A Helm chart to build and deploy a Cloud Pattern via the patterns o keywords: - pattern name: pattern-install -version: 0.0.18 +version: 0.0.19 home: https://github.com/validatedpatterns/pattern-install-chart maintainers: - name: Validated Patterns Team diff --git a/README.md b/README.md index 1e10e1a..af189ee 100644 --- a/README.md +++ b/README.md @@ -1,6 +1,6 @@ # pattern-install -![Version: 0.0.18](https://img.shields.io/badge/Version-0.0.18-informational?style=flat-square) +![Version: 0.0.19](https://img.shields.io/badge/Version-0.0.19-informational?style=flat-square) A Helm chart to build and deploy a Cloud Pattern via the patterns operator @@ -34,10 +34,15 @@ This chart is used by the Validated Patterns installation script that can be fou | main.gitea.helmRepoUrl | string | `"https://charts.validatedpatterns.io/"` | Helm Repository URL for the gitea chart | | main.gitops | object | depends on the individual settings | Settings related to the gitops operator | | main.gitops.additionalArgoAdmins | string | `""` | Comma-separated list of additional ArgoCD admin groups. Only used when argoRBAC is not set. | +| main.gitops.applicationHealthCheckEnabled | string | `""` | Set to "true" to have the patterns operator restore the ArgoCD Application resource health check (dropped in ArgoCD 1.8). Required for app-of-apps sync-wave ordering: without it the root Application treats child Applications as healthy and applies all waves at once. The operator defaults this to false, so it must be set explicitly. | | main.gitops.argoRBAC | string | `""` | Full ArgoCD RBAC spec as a YAML string. When set, it completely overrides the default RBAC policy and additionalArgoAdmins is ignored. | | main.gitops.channel | string | `"gitops-1.21"` | Default channel to install the gitops operator from | +| main.gitops.csv | string | `""` | Starting CSV for the gitops operator install. Defaults to the operator's own default. | | main.gitops.customArgoYaml | string | `""` | Arbitrary ArgoCD .spec YAML to deep-merge into the operator-built ArgoCD CR. Allows customizing any part of the ArgoCD spec without requiring individual config keys. | +| main.gitops.customHealthChecks | string | `""` | Additional resource health checks for the ArgoCD CR, as a YAML list string. Appended to the operator's built-in checks (PVC, Subscription, and Application when applicationHealthCheckEnabled is true). | +| main.gitops.installApprovalPlan | string | `""` | Install plan approval mode for the gitops operator subscription (Automatic or Manual). Defaults to the operator's own default. | | main.gitops.operatorSource | string | `"redhat-operators"` | Source to be used to install the gitops operator from | +| main.gitops.sourceNamespace | string | `""` | Namespace of the catalog source the gitops operator is installed from. Defaults to the operator's own default (openshift-marketplace). | | main.multiSourceConfig.clusterGroupChartVersion | string | `nil` | The clustergroup chart version to be used when deploying a pattern (defaults to 0.8.*) | | main.multiSourceConfig.enabled | bool | `false` | Enables a multisource configuration for the clustergroup chart | | main.multiSourceConfig.helmRepoUrl | string | `nil` | The URL of the VP helm charts repository (defaults to https://charts.validatedpatterns.io) | diff --git a/templates/pattern-operator-configmap.yaml b/templates/pattern-operator-configmap.yaml index 7147009..dff528a 100644 --- a/templates/pattern-operator-configmap.yaml +++ b/templates/pattern-operator-configmap.yaml @@ -21,8 +21,31 @@ data: gitops.customArgoYaml: | {{ .Values.main.gitops.customArgoYaml | indent 4 }} {{- end }} + {{- if .Values.main.gitops.applicationHealthCheckEnabled }} + {{- $ahce := .Values.main.gitops.applicationHealthCheckEnabled | toString | lower }} + {{- if and (ne $ahce "true") (ne $ahce "false") }} + {{- fail "applicationHealthCheckEnabled must be \"true\" or \"false\"" }} + {{- end }} + gitops.applicationHealthCheckEnabled: {{ $ahce | quote }} + {{- end }} + {{- if .Values.main.gitops.customHealthChecks }} + {{- $v := .Values.main.gitops.customHealthChecks }} + gitops.customHealthChecks: | +{{ if kindIs "string" $v }}{{ $v | indent 4 }}{{ else }}{{ toYaml $v | indent 4 }}{{ end }} + {{- end }} + {{- if .Values.main.gitops.sourceNamespace }} + gitops.sourceNamespace: {{ .Values.main.gitops.sourceNamespace | quote }} + {{- end }} + {{- if .Values.main.gitops.installApprovalPlan }} + {{- $iap := .Values.main.gitops.installApprovalPlan | toString }} + {{- if and (ne $iap "Automatic") (ne $iap "Manual") }} + {{- fail "installApprovalPlan must be \"Automatic\" or \"Manual\"" }} + {{- end }} + gitops.installApprovalPlan: {{ $iap | quote }} + {{- end }} + {{- if .Values.main.gitops.csv }} + gitops.csv: {{ .Values.main.gitops.csv | quote }} + {{- end }} - # gitops.sourceNamespace: GitOpsDefaultCatalogSourceNamespace - # gitops.installApprovalPlan: GitOpsDefaultApprovalPlan # gitops.ManualSync: GitOpsDefaultManualSync # gitops.name: GitOpsDefaultPackageName diff --git a/tests/pattern_operator_configmap_test.yaml b/tests/pattern_operator_configmap_test.yaml index 47a581f..2e78927 100644 --- a/tests/pattern_operator_configmap_test.yaml +++ b/tests/pattern_operator_configmap_test.yaml @@ -102,6 +102,182 @@ tests: - exists: path: data["gitops.customArgoYaml"] + - it: Should not include gitops.applicationHealthCheckEnabled by default + asserts: + - notExists: + path: data["gitops.applicationHealthCheckEnabled"] + + - it: Should set gitops.applicationHealthCheckEnabled as a string + set: + main: + gitops: + applicationHealthCheckEnabled: "true" + asserts: + - equal: + path: data["gitops.applicationHealthCheckEnabled"] + value: "true" + + - it: Should accept gitops.applicationHealthCheckEnabled false + set: + main: + gitops: + applicationHealthCheckEnabled: "false" + asserts: + - equal: + path: data["gitops.applicationHealthCheckEnabled"] + value: "false" + + - it: Should reject gitops.applicationHealthCheckEnabled yes + set: + main: + gitops: + applicationHealthCheckEnabled: "yes" + asserts: + - failedTemplate: + errorMessage: "applicationHealthCheckEnabled must be \"true\" or \"false\"" + + - it: Should reject gitops.applicationHealthCheckEnabled 1 + set: + main: + gitops: + applicationHealthCheckEnabled: "1" + asserts: + - failedTemplate: + errorMessage: "applicationHealthCheckEnabled must be \"true\" or \"false\"" + + - it: Should not include gitops.customHealthChecks by default + asserts: + - notExists: + path: data["gitops.customHealthChecks"] + + - it: Should set gitops.customHealthChecks from a string + set: + main: + gitops: + customHealthChecks: | + - group: example.com + kind: MyKind + check: | + hs = {} + hs.status = "Healthy" + return hs + asserts: + - equal: + path: data["gitops.customHealthChecks"] + value: | + - group: example.com + kind: MyKind + check: | + hs = {} + hs.status = "Healthy" + return hs + + - it: Should set gitops.customHealthChecks from a native YAML list + set: + main: + gitops: + customHealthChecks: + - group: example.com + kind: MyKind + asserts: + - equal: + path: data["gitops.customHealthChecks"] + value: | + - group: example.com + kind: MyKind + + - it: Should not include gitops.sourceNamespace by default + asserts: + - notExists: + path: data["gitops.sourceNamespace"] + + - it: Should set gitops.sourceNamespace + set: + main: + gitops: + sourceNamespace: openshift-marketplace + asserts: + - equal: + path: data["gitops.sourceNamespace"] + value: "openshift-marketplace" + + - it: Should quote gitops.sourceNamespace to survive YAML round-trip + set: + main: + gitops: + sourceNamespace: "null" + asserts: + - isNotNull: + path: data["gitops.sourceNamespace"] + + - it: Should not include gitops.installApprovalPlan by default + asserts: + - notExists: + path: data["gitops.installApprovalPlan"] + + - it: Should set gitops.installApprovalPlan + set: + main: + gitops: + installApprovalPlan: Manual + asserts: + - equal: + path: data["gitops.installApprovalPlan"] + value: "Manual" + + - it: Should accept gitops.installApprovalPlan Automatic + set: + main: + gitops: + installApprovalPlan: Automatic + asserts: + - equal: + path: data["gitops.installApprovalPlan"] + value: "Automatic" + + - it: Should reject gitops.installApprovalPlan manual (wrong case) + set: + main: + gitops: + installApprovalPlan: manual + asserts: + - failedTemplate: + errorMessage: "installApprovalPlan must be \"Automatic\" or \"Manual\"" + + - it: Should reject gitops.installApprovalPlan MANUAL (wrong case) + set: + main: + gitops: + installApprovalPlan: MANUAL + asserts: + - failedTemplate: + errorMessage: "installApprovalPlan must be \"Automatic\" or \"Manual\"" + + - it: Should not include gitops.csv by default + asserts: + - notExists: + path: data["gitops.csv"] + + - it: Should set gitops.csv + set: + main: + gitops: + csv: openshift-gitops-operator.v1.22.0 + asserts: + - equal: + path: data["gitops.csv"] + value: "openshift-gitops-operator.v1.22.0" + + - it: Should quote gitops.csv to prevent float truncation + set: + main: + gitops: + csv: 1.10 + asserts: + - equal: + path: data["gitops.csv"] + value: "1.1" + - it: Should set gitea parameters set: main: diff --git a/values.yaml b/values.yaml index 6db495f..ca4a44a 100644 --- a/values.yaml +++ b/values.yaml @@ -34,6 +34,25 @@ main: # ArgoCD CR. Allows customizing any part of the ArgoCD spec without # requiring individual config keys. customArgoYaml: "" + # -- Set to "true" to have the patterns operator restore the ArgoCD + # Application resource health check (dropped in ArgoCD 1.8). Required for + # app-of-apps sync-wave ordering: without it the root Application treats + # child Applications as healthy and applies all waves at once. The operator + # defaults this to false, so it must be set explicitly. + applicationHealthCheckEnabled: "" + # -- Additional resource health checks for the ArgoCD CR, as a YAML list + # string. Appended to the operator's built-in checks (PVC, Subscription, + # and Application when applicationHealthCheckEnabled is true). + customHealthChecks: "" + # -- Namespace of the catalog source the gitops operator is installed + # from. Defaults to the operator's own default (openshift-marketplace). + sourceNamespace: "" + # -- Install plan approval mode for the gitops operator subscription + # (Automatic or Manual). Defaults to the operator's own default. + installApprovalPlan: "" + # -- Starting CSV for the gitops operator install. Defaults to the + # operator's own default. + csv: "" # -- Settings related to the in-cluster gitea installation gitea: