cloud-sql-proxy-operator icon indicating copy to clipboard operation
cloud-sql-proxy-operator copied to clipboard

Feature Request: Helm Chart

Open brad-taylor-yvr opened this issue 2 years ago • 12 comments

Any thoughts about / plans for creating a Helm Chart?

As is, it is a bit of a lift to convert the 30-odd resources in https://storage.googleapis.com/cloud-sql-connectors/cloud-sql-proxy-operator/v0.5.0/cloud-sql-proxy-operator.yaml into something that can be orchestrated with Terraform, which will become out of date at the next release.

thanks...

Specifications

  • Version: v0.5.0
  • Platform: n/a

brad-taylor-yvr avatar May 15 '23 05:05 brad-taylor-yvr

I like this idea. I'd like to explore the requirements a little bit before we make a commitment to do it. Here are a few questions for the community:

What parameters do you need on the operator helm chart?

Here's my preliminary list

  • Operator Version (default latest)
  • Number of replicas for the operator deployment
  • Operator pod configuration:
    • resource requirements
    • labels & annotations
    • affinity

Could you elaborate why helm is better for you than kustomize? There is a Kustomize project layout the config folder in this repo, but we haven't documented how to use Kustomize to deploy the operator yet. I imagine that you prefer Helm to Kustomize.

hessjcg avatar May 15 '23 13:05 hessjcg

For me, Helm > Kustomize purely because of familiarity.

I know how to run Helm charts in Terraform (which I have to use). Kustomize is new to me. Looks great, but do I have to convert everything to Kustomize? If so, that's a non-starter. ;)

Other Helm charts I use include installCRDs yes/no namespace override

thanks for the quick answer back :)

brad-taylor-yvr avatar May 16 '23 05:05 brad-taylor-yvr

Hi team, I know you've been hard at work getting to the 1.0.1 release. :) Any more thoughts on this request?

brad-taylor-yvr avatar Jun 22 '23 21:06 brad-taylor-yvr

Does the list of parameters look good to you @brad-taylor-yvr from

enocom avatar Jun 29 '23 21:06 enocom

Hi that list looks ok to me

  • Operator Version (default latest)
  • Number of replicas for the operator deployment
  • Operator pod configuration:
  • resource requirements
  • labels & annotations
  • affinity

I also mentioned in the following comment:

  • installCRDs yes/no
  • namespace override

If Operator version is not the way to pick the version of the cloud-sql-auth-proxy image, then that would be useful too.

Along the same lines, if the version of cert-manager is non-deterministic, it might be useful to be able to change that too?

thanks... :)

brad-taylor-yvr avatar Jul 04 '23 18:07 brad-taylor-yvr

Given the interest here, we'll work on prioritizing this.

enocom avatar Jul 05 '23 15:07 enocom

an additional point of view on the matter: the helm chart would help us indeed with terraform

helm vs kustomization

The helm terraform provider is maintained by hashicorp, and is battle tested and well known by the community. We have not yet tested the community kustomization terraform provider.

CRDs installation

The CRD story is critical for migrations from a previous kind of deployment: we cannot just delete everything and start again: workloads use the CRDs!

For helm: I would recommend the method 1 documented here: https://helm.sh/docs/chart_best_practices/custom_resource_definitions/#method-1-let-helm-do-it-for-you

  • It avoids accidental CRD deletion: helm handles explicitly itself the CRDs and only ever creates them
  • helm tolerates pre-existing ones (modulo manually adding some labels to simulate a previous installation by helm))
  • helm also allows to not install them for those who prefer that

misc

terraform cloud started billing by the resource: helm charts become even more interesting (vs ~30 kubernetes_manifest)

thomas-riccardi avatar Aug 02 '23 16:08 thomas-riccardi

Adding a feature to the helm chart values: #461: List namespaces monitored by the webhook.

hessjcg avatar Oct 11 '23 15:10 hessjcg

I just created a very early Proof of Concept helm chart. I would love your feedback as I design this new feature. See #483

hessjcg avatar Oct 30 '23 19:10 hessjcg

Is there any update on that? The PR has been stale for many months.

via-justa avatar Jul 29 '24 10:07 via-justa