[prometheus-operator] Rename to kube-prometheus-stack

[scottrigby]

Fixes #9

Background

See prometheus-community/community#28 (comment)

Description

This is an attempt to rename the chart. There are a lot of changes needed, so it's taken some time to review.

I have also dramatically simplified the README per new charts template decision in #14. (tl;dr, helm show values gives all the info a user needs, and makes that the older convention of duplicating these value configurations in the README unnecessary). Without deep experience using this chart, I can't know if the existing upgrading sections are still relevant, so I organized and left them in case they are useful to end users.

PR status

• All feedback has been addressed so far
• Chart tested both for new installs, and upgrade path from stable/prometheus-operator.
  • See [prometheus-operator] Rename to kube-prometheus-stack #1 (comment) and [prometheus-operator] Rename to kube-prometheus-stack #1 (comment) for reasoning for manual testing steps (tl;dr, one of this chart's dependencies has also moved here, so to test installing before we transfer this repo, you need to manually edit requirements.yaml and change https://prometheus-community.github.io/helm-charts to https://scottrigby.github.io/prometheus-helm-charts. The URL will be correct after repo transfer)
• @brancz please address [prometheus-operator] Rename to kube-prometheus-stack #1 (comment) by @Xtigyro (prometheus chart maintainer) about the new name chosen, and make a final decision.
  • This needs a final say one way or the other. Some alternatives have been suggested, while most others agree kube-prometheus is the best name. Be sure to "load more" comments to see the discussion through to [prometheus-operator] Rename to kube-prometheus-stack #1 (comment). If you decide to use a different name I will update the PR accordingly
• Rename the chart kube-prometheus-stack per [prometheus-operator] Rename to kube-prometheus-stack #1 (comment)

Once steps above are complete, we can merge this PR. Merging will release the new chart package and add to the helm repo index.

Note: merging this PR has not been identified as a blocker to transferring the repo to prometheus-community. See #11

[vsliouniaev]

This seems like it will have issues with PVCs that anyone may have created as part of the previous release as well as anyone using this in umbrella charts. Would be nice to give some guidance on how to solve for those issues using some variables. I've had no time to look at this in the last while.

[scottrigby]

@vsliouniaev Thanks for looking into this. There is a section in the readme under "Persistent Volumes" that I believe addresses this:

If you would like to keep the data of the current persistent volumes, it should be possible to attach existing volumes to new PVCs and PVs that are created using the conventions in the new chart… [EXAMPLE]
The PVC will take ownership of the PV and when you create a release using a persistent volume claim template it will use the existing PVCs as they match the naming convention used by the chart. For other cloud providers similar approaches can be used.

I have not done this myself with this chart, but have helped with migrations by configuring other charts to attach existing claims to the new deployment.

[monotek]

Wow, I didn't even know that prometheus-operator chart is not the prometheus-operator as I wanted to try out the operator soon.

So +1 to rename it.

[scottrigby]

Once #14 is merged, will will need to rebase this PR. The change to this chart is deprecating the old chart to begin with so it doesn't get indexed until we finish reviewing this PR and un-deprecate it under the new name.

[scottrigby]

I merged main, so #14 is now merged into this PR, which is now ready for review. I'm sure some things are broken.

I'd appreciate review/testing by both maintainers and anyone who uses the stable/prometheus-operator chart. I'm also happy for the maintainers of this chart to push fixes directly to this branch (you should be able to do that per the CODEOWNERS file at it's current state in main. Please lmk if you can't).

Testing scenarios:

• for now test by adding repo and installing per Transfer ownership and rename scottrigby/prometheus-helm-charts to prometheus-community/helm-charts #11
• also test in-place upgrade from stable/prometheus-operator
• anything else?

Thanks!

[torstenwalter]

Nice! We are getting there. Two approvals. @scottrigby you should be the one to do the merge ;-)

[steven-sheehy]

I'm not sure why the need to prefix with kube as all Helm charts are by definition associated with kubernetes already. So within that context prefixing with kube is redundant. I prefer the simpler prometheus-stack as it:

• Drops the unnecessary prefix
• Matches the prefix of every other chart in this repo (e.g. prometheus-)
• Clearly differentiates between the separate prometheus-operator and kube-prometheus projects
• Reads nicer: Indicates you're installing prometheus plus a stack of other components. You're not installing a "kube".

[scottrigby]

@steven-sheehy I know a ton of discussion is buried in GitHub collapsed comments, so please read the direct links:

• Summary: [prometheus-operator] Rename to kube-prometheus-stack #1 (comment)
• Final sponsor approval: [prometheus-operator] Rename to kube-prometheus-stack #1 (comment)

The kube-prometheus project name must be part of the chart name, as an absolute condition of moving this git repo to the prometheus-community org. The maintainers of that chart and prometheus devs (including maintainer of upstream kube-prometheus project) have agreed on the name. That process is now finished.

[scottrigby]

I believe we've covered all our bases and then some over the past month of this PR. We're now – finally – ready to merge 😅 With that said… Thanks everyone! 🎉 💖 🙌

[Xtigyro]

@scottrigby Thank you, man! Your work has been UNBELIEVABLY VALUABLE! 🥇