feat(localenv): local development tooling for PluginDefinition

[abhijith-darshan]

Pull Request Details

• Adds kustomization.yaml at repository root for all PluginDefinition
• Generates PluginDefinition(s) for local development using kustomize

Other Relevant Information

The root kustomization.yaml can be used by any greenhouse operator developers to easily pull PluginDefinition via kustomize remote links

Example:

resources:
  - https://github.com/cloudoperators/greenhouse-extensions?ref=<branch-name>

This will be an intermediate solution for greenhousectl dev setup .... to provision a full development environment for Operator developers and UI / Dashboard developers

The shell script to generate PluginDefinition in bin/.generated is to ease local development of Plugin developers

This already generates a PluginDefinition where name will point to a local mounted path (Plugin Development HostPathConfig)

The generated resources are ignored and so that the actual plugindefinition.yaml is not altered for local development

Example:

greenhouse-extensions % make generate-kustomization 
test -s /Users/D072950/ccloud/greenhouse/greenhouse-extensions/bin/yq || curl -L https://github.com/mikefarah/yq/releases/latest/download/yq_darwin_arm64 -o /Users/D072950/ccloud/greenhouse/greenhouse-extensions/bin/yq && chmod +x /Users/D072950/ccloud/greenhouse/greenhouse-extensions/bin/yq
hack/generate-kustomization
✅ Successfully generated bin/.generated/kustomization.yaml!

Generated files Screenshot -

Note

There is currently a slight mismatch in the exposed-services. The file name is exposed-service.yaml but in kustomization.yaml it is exposed-services.yaml, you need to edit it by removing the s at the end

.spec.helmChart.name will not be accurate as many plugins have versioned chart folders. Please make the necessary path changes before applying to your local cluster

Now you can apply the generated local dev PluginDefinition

greenhouse-extensions % kubectl apply -k bin/.generated
plugindefinition.greenhouse.sap/alerts created
plugindefinition.greenhouse.sap/cert-manager created
plugindefinition.greenhouse.sap/exposed-service created
plugindefinition.greenhouse.sap/external-dns created
plugindefinition.greenhouse.sap/github-guard created
plugindefinition.greenhouse.sap/ingress-nginx created
plugindefinition.greenhouse.sap/kube-monitoring created
plugindefinition.greenhouse.sap/openbao created
plugindefinition.greenhouse.sap/opentelemetry created
plugindefinition.greenhouse.sap/perses created
plugindefinition.greenhouse.sap/plutono created
plugindefinition.greenhouse.sap/service-proxy unchanged
plugindefinition.greenhouse.sap/teams2slack created
plugindefinition.greenhouse.sap/thanos created

[ibakshay]

Thank you very much. I have tested locally and it looks great already 🚀 I have left a minor comment.

[viennaa]

Thanks for providing this helper.

Please add some documentation on how to use it.

[abhijith-darshan]

Thanks for providing this helper.

Please add some documentation on how to use it.

@viennaa if it’s fine i can add a readme in docs folder 📂

[viennaa]

@viennaa if it’s fine i can add a readme in docs folder 📂

I would add a little section to the existing README and point to the docs, if you want to put the main doc there.

[abhijith-darshan]

@viennaa if it’s fine i can add a readme in docs folder 📂

I would add a little section to the existing README and point to the docs, if you want to put the main doc there.

done

[ibakshay]

Thanks a lot! LGTM 🚀🚀

[richardtief]

Very good work. Thanks

implemented