feat(catalogs): implements catalog options override capability

[abhijith-darshan]

Description

when overrides for options are spec'd, Catalog controller can prepare Kustomize patches to override PluginDefinition option's default value matched by its name.

Catalog controller does this by extracting the archive of the PluginDefinition manifests resolved by flux GitRepository and resource composition from ArtifactGenerator. The archive URL is available in a referencing Kind ExternalArtifact which is fed as a source for flux Kustomization.

Catalog controller also saves the archive of external artifact to a tmp location, to avoid archive fetches from source-watcher for repeated reconciliations and the digest hasn't changed.

Example

apiVersion: greenhouse.sap/v1alpha1
kind: Catalog
metadata:
  name: greenhouse-extensions
  namespace: greenhouse
spec:
  sources:
    - ref:
        branch: main
      repository: https://github.com/cloudoperators/greenhouse-extensions
      resources:
        - cert-manager/plugindefinition.yaml
        - ingress-nginx/plugindefinition.yaml
        - kube-monitoring/plugindefinition.yaml
      overrides:
        - name: cert-manager
          alias: cert-manager-overridden
          optionsOverride:
            - name: "cert-manager.installCRDs"
              value: true
            - name: cert-manager.webhook.timeoutSeconds
              value: 15
    - ref:
        sha: ed3ff23bca21eef6cffc0956df338d8185340fc5
      repository: https://github.com/cloudoperators/greenhouse-extensions
      resources:
        - perses/plugindefinition.yaml
      overrides:
        - name: perses
          alias: perses-overridden
          optionsOverride:
            - name: "perses.serviceMonitor.selector.matchLabels"
              value:
                foo: bar
                baz: qux

If an option is overridden, then the description of the option is modified to contain (overridden by Catalog) at the end.

$ kc get pd cert-manager-overridden -n greenhouse -o yaml | yq '.spec.options[] | select(.description | match("(?i)overridden"))'

default: true
description: Whether to install CRDs (overridden by Catalog)
name: cert-manager.installCRDs
required: false
type: bool
default: false
description: Whether to enable Prometheus metrics (overridden by Catalog)
name: cert-manager.prometheus.enabled
required: false
type: bool
default: letsencrypt-prod
description: Name of the cert-manager issuer to use for TLS certificates (overridden by Catalog)
displayName: Enable certificate owner reference
name: cert-manager.ingressShim.defaultIssuerName
required: false
type: string
default: 15
description: Timeout in seconds for the CertManager webhook (overridden by Catalog)
name: cert-manager.webhook.timeoutSeconds
required: false
type: int

What type of PR is this? (check all applicable)

• 🍕 Feature
• 🐛 Bug Fix
• 📝 Documentation Update
• 🎨 Style
• 🧑‍💻 Code Refactor
• 🔥 Performance Improvements
• ✅ Test
• 🤖 Build
• 🔁 CI
• 📦 Chore (Release)
• ⏩ Revert

Related Tickets & Documents

• Closes [FEAT] - Catalog supports defaults for PluginDefinitions #1557

Added tests?

• 👍 yes
• 🙅 no, because they aren't needed
• 🙋 no, because I need help
• Separate ticket for tests # (issue/pr)

Added to documentation?

• 📜 README.md
• 🤝 Documentation pages updated
• 🙅 no documentation needed
• (if applicable) generated OpenAPI docs for CRD changes

Checklist

• My code follows the style guidelines of this project
• I have performed a self-review of my code
• I have commented my code, particularly in hard-to-understand areas
• My changes generate no new warnings
• New and existing unit tests pass locally with my changes

[abhijith-darshan]

needs #1597 to be merged for writing e2e Kustomize patch scenarios for optionsOverride

[abhijith-darshan]

needs cloudoperators/common#49 to fix the change in shared e2e workflow