Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Host stable/kube-state-metrics helm chart #1237

Merged
merged 90 commits into from
Dec 15, 2020

Conversation

scottrigby
Copy link
Contributor

@scottrigby scottrigby commented Sep 18, 2020

What this PR does / why we need it:

See #1153

To-do:

  • import stable/kube-state-metrics helm chart history
  • clean up chart README
  • bump chart version (PATCH is fine, as this chart can upgrade in-place using the new repo info)
  • add chart-testing GitHub Action (for chart CI)
  • add chart-releaser GitHub Action (for helm repo CD)
    • configure a gh-pages branch for package releasing
  • invite stable/kube-state-metrics chart maintainers to collaborate on this git repo
    • add an OWNERS file to match, if needed (I left the one in place from helm/charts. However please provide guidance on what you would like to do with this)

After PR merge:

Which issue(s) this PR fixes (optional, in fixes #<issue number>(, fixes #<issue_number>, ...) format, will close the issue(s) when PR gets merged):
Fixes #1153

@k8s-ci-robot k8s-ci-robot added do-not-merge/work-in-progress Indicates that a PR should not merge because it is a work in progress. do-not-merge/invalid-commit-message Indicates that a PR should not merge because it has an invalid commit message. size/XL Denotes a PR that changes 500-999 lines, ignoring generated files. labels Sep 18, 2020
@k8s-ci-robot k8s-ci-robot added the do-not-merge/invalid-owners-file Indicates that a PR should not merge because it has an invalid OWNERS file in it. label Sep 18, 2020
@k8s-ci-robot
Copy link
Contributor

Thanks for your pull request. Before we can look at your pull request, you'll need to sign a Contributor License Agreement (CLA).

📝 Please follow instructions at https://git.k8s.io/community/CLA.md#the-contributor-license-agreement to sign the CLA.

It may take a couple minutes for the CLA signature to be fully registered; after that, please reply here with a new comment and we'll verify. Thanks.


  • If you've already signed a CLA, it's possible we don't have your GitHub username or you're using a different email address. Check your existing CLA data and verify that your email is set on your git commits.
  • If you signed the CLA as a corporation, please sign in with your organization's credentials at https://identity.linuxfoundation.org/projects/cncf to be authorized.
  • If you have done the above and are still having issues with the CLA being reported as unsigned, please log a ticket with the Linux Foundation Helpdesk: https://support.linuxfoundation.org/
  • Should you encounter any issues with the Linux Foundation Helpdesk, send a message to the backup e-mail support address at: [email protected]

Instructions for interacting with me using PR comments are available here. If you have questions or suggestions related to my behavior, please file an issue against the kubernetes/test-infra repository. I understand the commands that are listed here.

@k8s-ci-robot k8s-ci-robot added the cncf-cla: no Indicates the PR's author has not signed the CNCF CLA. label Sep 18, 2020
@scottrigby
Copy link
Contributor Author

I believe the CLA problem is because I'm (purposefully) also importing other user's commits from the stable repo.

@k8s-ci-robot k8s-ci-robot added size/XXL Denotes a PR that changes 1000+ lines, ignoring generated files. and removed size/XL Denotes a PR that changes 500-999 lines, ignoring generated files. labels Sep 18, 2020
- monitoring
- prometheus
- kubernetes
version: 2.9.2

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I suggest to bump version to 2.10.0. That allows to use 2.9.2 in the old repo to deprecate the chart over there.

Copy link
Contributor Author

@scottrigby scottrigby Sep 21, 2020

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@torstenwalter 👋 Good question, I had to think about this for a moment.

Re semver, this chart repo move isn't a backwards incompatible change (MAJOR), or a new feature (MINOR), so PATCH is fine.

In general when charts move repos they don't bump two PATCH versions to address a conflict with the deprecation bump in stable. We could do that here, but it give us anything – there is no version conflict since the release will be from a different repo.

If you see a problem with this line of thinking lmk. But I wouldn't think so since this is the way every other chart repo move has done it.

- prometheus
- kubernetes
version: 2.9.2
appVersion: 1.9.7
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

We launched a pre-release candidate v2.0.0-alpha which is now merged in master, if we merge this it will differ.

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Hi @lilic. In general it's ok for the appVersion in a chart to be behind the newest release of the app it installs (for a short time anyway, it has to be, since the container image tag for the app must be available for CI to pass for the PR.

But in this case, 1.9.7 is the most recent release, right? https://github.com/kubernetes/kube-state-metrics/releases/tag/v1.9.7

Copy link
Member

@lilic lilic Sep 22, 2020

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

We have a pre-release of v2.0.0-alpha cut a few days ago, not sure if that counts for helm charts and the meaning of stable in helm? Just for your information https://github.com/kubernetes/kube-state-metrics/releases/tag/v2.0.0-alpha. (no objections to using 1.9.7 at all, just want folks to switch to 2.0 as soon as possible :) )

@torstenwalter
Copy link

@brancz @lilic @tariq1890 any feedback on this PR.

@lilic
Copy link
Member

lilic commented Oct 20, 2020

@scottrigby sorry I was under the impression is not ready for review yet. I have not used helm recently but will give it a try in reviewing.

But the biggest problem right now is the CLAs that were not signed and we cannot merge without those signed:

cla/linuxfoundation — scottrigby authorized, but 17 other problems

@scottrigby
Copy link
Contributor Author

@lilic Hi 👋 I'm happy to move this out of draft mode, I was just looking for feedback per #1153 (comment) and #1237 (comment).

Re CLA, from what I understand CNCF requires either CLA or DCO. Most of these commits have DCO signoff, and for those which don't (since many of these commits were made before DCO was enforced) I could add mine. However I understand Kubernetes contribution guidelines require CLA. I could not hope to get that from all of these contributors, so can we discuss allowable options for retaining this commit history? I believe history is important for several reasons - both credit to those who worked on it as well as a record of past change motivations that may help inform future decisions (especially if we hope to simplify the chart in future due to new options such as Helm's post-renderer flag).

What do you think about me modifying the commits to list myself as author and crediting the original committers as co-authors? I could add a note in the commit message clarifying that modification was made due to CLA requirements, and this way it would still be an accurate depiction of the work, including me collating and brining in the previous work. I would think this would be more acceptable from an attribution point of view than flattening it all and bringing it in as if it were my own commit. If done this way, could my own CLA then suffice to allow retaining commit history?

@eddiezane
Copy link
Member

Maybe @mrbobbytables or @nikhita have suggestions for importing commits from folks that haven't signed the CLA.

@nikhita
Copy link
Member

nikhita commented Nov 17, 2020

We've merged one-offs like these (CLA problems due to code migration - kubernetes/kube-openapi#211 (comment)) in the past so we could merge it manually. Before we do that, we need to ensure:

  • The git history is maintained. This looks good as-is. ✅
  • The LICENSE/copyright is handled correctly. I think this probably means that the helm/charts LICENSE needs to be added to the charts/kube-state-metrics directory...but IANAL so I'm not sure. :)

@swinslow can you please let us know what would be the right workflow for handling the license/copyright?

fyi @dims

@lilic
Copy link
Member

lilic commented Nov 18, 2020

Let me know if there is anything you need from my side, I have admin access to merge if we get an okay from Kubernetes org.

@scottrigby scottrigby marked this pull request as ready for review November 24, 2020 23:56
@k8s-ci-robot k8s-ci-robot removed the do-not-merge/work-in-progress Indicates that a PR should not merge because it is a work in progress. label Nov 24, 2020
@scottrigby
Copy link
Contributor Author

@nikhita Great news, yes that would be much easier. I have moved this PR from draft to ready for review. I have also updated the PR description checklist now that some of the steps are no longer needed.

# Default values for kube-state-metrics.
prometheusScrape: true
image:
repository: quay.io/coreos/kube-state-metrics
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Any chance we can change this to the gcr image and build a 1.9.7 image there?

See prometheus-community/helm-charts#373

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@eddiezane Good idea. Though based on past experience I would prefer that to be a follow-up PR to keep the scope clear in this one. Does that sound reasonable?

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

1.9.7 did not have the gcr images yet, but you can do the migration in v2.0.0 to gcr.

Copy link
Member

@eddiezane eddiezane Dec 2, 2020

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@scottrigby that works for me.

@lilic Since v2.0.0 will have breaking changes I'd like to advocate for the last v1 release to have an official image (with multi arch support) cut. Should I open an issue as a better place to have that discussion?

@scottrigby
Copy link
Contributor Author

scottrigby commented Nov 25, 2020

I have added one additional commit. This was the final commit made to the stable chart since I opened this PR, and before the deprecation notice: helm/charts#23968. The only difference now is the version had bumped again (in case users already have 2.9.2 installed from stable).

See https://github.com/helm/charts/commits/master/stable/kube-state-metrics/Chart.yaml for a list of all changes to this stable chart's Chart.yaml file. I did not add the notice or deprecation PR commits purposefully. This PR is now completely caught up.

@scottrigby
Copy link
Contributor Author

@nikhita - wrapping up one more open question:

  • The LICENSE/copyright is handled correctly. I think this probably means that the helm/charts LICENSE needs to be added to the charts/kube-state-metrics directory...but IANAL so I'm not sure. :)

@swinslow can you please let us know what would be the right workflow for handling the license/copyright?

From similar efforts in other k8s projects (example https://github.com/kubernetes/ingress-nginx) the Apache 2.0 License at the root of this repo has been seen as compatible with the same Apache 2.0 License at the root of the now deprecated helm/charts repo.

BUT to be on the safe side, in case it helps move this PR along, I added the one from helm/charts (with "The Helm Authors" copyright line) to the charts/kube-state-metrics/ directory. I didn't add to the parent charts/ directory, in case additional charts (for future sub-components, etc) need to be added in the future.

@lilic
Copy link
Member

lilic commented Nov 25, 2020

@scottrigby I can merge manually as soon as we get an okay from someone from the cncf or Kubernetes org that it's legally alright to do so, we had to get this okay in another project we are migrating. Or if you can reach out to the folks who did not sign the CLA to sign it?

@nikhita
Copy link
Member

nikhita commented Nov 25, 2020

Or if you can reach out to the folks who did not sign the CLA to sign it?

It looks like there are at least 17 people who have not signed the CLA. Getting them to sign the CLA wouldn't be feasible...

@swinslow or @caniszczyk can you please take a look and suggest next steps from a legal perspective?

More context in #1237 (comment)

Note we may want to add GPG signing in a follow-up PR.

Signed-off-by: Scott Rigby <[email protected]>
@scottrigby
Copy link
Contributor Author

I am actually more in favour of binding the release cadence of helm charts to that of the main application itself.

Agreed, but not up to me, I am not a helm user, so I have no clue, but this makes sense to me. I would say let's start with some cadence and we can always change later on?

@lilic I can see that, but generally chart repos don't work like this. With the helm/chart-releaser-action, each time a PR is merged into the main branch, a new version of the chart is released. Charts also normally have a different version than the application (charts generally version faster than the app it installs). If you want to change this workflow to have fewer releases, you could do it by having a staging branch and merge into the main branch less frequently – in that case you would also want to adjust the chart-testing options, otherwise each PR would still need to bump the version, even though there would be fewer actual releases, which would confuse users. In general this would be an anti-pattern for charts. Is it OK for the chart to have its own release cadence, based on need/PR?

@scottrigby I was under the impression we wanted to just remove the commits and squash all into one? As we still see a failing CI? e.g. like @mrueg suggested as per this PR kubernetes/ingress-nginx#5159

On this question, @caniszczyk said it's up to us which way we do it:

I brought in commits because it has been useful in other projects to have the history. Here is an example (one of many) where someone has asked for commit history to be restored. This is one I happened to help with: goharbor/harbor-helm#48

From what @nikhita said, the fact that CLA bot isn't passing does not have to be a show stopper, as long as we get the go-ahead from @caniszczyk which we now have. I asked @lilic in Slack for an opinion on this (the value of commit history etc), given the above, who said:

I have no problem one way or another. Sure commit history is important, no clue about how much in helm case here. But if it has proven to be a problem before happy to continue down this path 👍
I don’t use helm, so I am the wrong person to ask 😄 I am not a blocker, might be easier to reach out to tariq on this as he is the helm chart maintainer as well as kube-state-metrics maintainer

So @tariq1890 just checking with you on this. Do you have an issue keeping the commit history (for the reasons above), or would you prefer I squash it out?

As for the OWNERS file, I guess its just @tariq1890 and @mrueg in the file then?

@lilic Sounds good, just pushed that change to remove fiunchinho. Do you want to invite @mrueg to the org?

Also @lilic and @tariq1890 I just pushed a change to update the Helm repo GitHub actions to the most recent versions. I noticed the app releases are signed with a GPG key. As of v1.0.0 @helm/chart-releaser-action added the ability to GHG sign releases. If you would like, we could work together on this in a follow up PR?

@tariq1890
Copy link
Contributor

@scottrigby I'd say we keep the commit history of the helm charts. It would definitely be unfortunate if we lost a record of all the helm chart contributors and their contributions. Final decision : I am in favour of this.

@tariq1890
Copy link
Contributor

Follow up PR for chart signing sounds good to me. I believe this PR should solely be intended for chart migration. CI improvements can be done in subsequent PRs. Will let @lilic chime in as well

@lilic
Copy link
Member

lilic commented Dec 15, 2020

Looks good to me, I am just wondering does the CLA check checks all the code or just the newest commits? So if we merge this will the next PR fail with CLA or will it pass?

Otherwise lgtm 🎉

@nikhita
Copy link
Member

nikhita commented Dec 15, 2020

I am just wondering does the CLA check checks all the code or just the newest commits? So if we merge this will the next PR fail with CLA or will it pass?

It just checks the commits in the PR so future PRs won't have any problems with the CLA. :)

@lilic also please feel free to merge manually once OWNERS is fixed!

@lilic
Copy link
Member

lilic commented Dec 15, 2020

Thanks can do!

@tariq1890 do we want to just leave you in the OWNERS and once @mrueg is part of k8s org, we can add him after that? So we unblock this PR?

@mrueg
Copy link
Member

mrueg commented Dec 15, 2020

@tariq1890 do we want to just leave you in the OWNERS and once @mrueg is part of k8s org, we can add him after that? So we unblock this PR?

Quick update on this: My request to become part of the org was approved and I've accepted the invite. kubernetes/org#2378 Thanks again for sponsoring!

@nikhita
Copy link
Member

nikhita commented Dec 15, 2020

/verify-owners

@k8s-ci-robot k8s-ci-robot removed the do-not-merge/invalid-owners-file Indicates that a PR should not merge because it has an invalid OWNERS file in it. label Dec 15, 2020
@lilic
Copy link
Member

lilic commented Dec 15, 2020

/lgtm

Thanks all! 🎉

@k8s-ci-robot k8s-ci-robot added the lgtm "Looks good to me", indicates that a PR is ready to be merged. label Dec 15, 2020
@k8s-ci-robot
Copy link
Contributor

[APPROVALNOTIFIER] This PR is APPROVED

This pull-request has been approved by: lilic, scottrigby

The full list of commands accepted by this bot can be found here.

The pull request process is described here

Needs approval from an approver in each of these files:

Approvers can indicate their approval by writing /approve in a comment
Approvers can cancel approval by writing /approve cancel in a comment

@k8s-ci-robot k8s-ci-robot added the approved Indicates a PR has been approved by an approver from all required OWNERS files. label Dec 15, 2020
@lilic
Copy link
Member

lilic commented Dec 15, 2020

Merging manually. 🎉 😅

@lilic lilic merged commit 52885f7 into kubernetes:master Dec 15, 2020
@devurandom
Copy link

The build failed:

Failed to resolve action download info. Error: Unable to resolve action helm/[email protected], unable to find version v1.1.1

Latest version appears to be v1.1.0: https://github.com/helm/chart-releaser-action/releases

@lilic
Copy link
Member

lilic commented Dec 15, 2020

@devurandom see this comment here, this will be done in a follow PR. #1237 (comment) but you are welcome to submit a PR for this!

@k8s-ci-robot
Copy link
Contributor

Keywords which can automatically close issues and at(@) or hashtag(#) mentions are not allowed in commit messages.

The list of commits with invalid commit messages:

  • ab1143e [stable/kube-state-metrics] add pod affinity (#12819)
  • 21b54d2 [stable/kube-state-metrics] Version bump to 1.9.5 (#20915)

Instructions for interacting with me using PR comments are available here. If you have questions or suggestions related to my behavior, please file an issue against the kubernetes/test-infra repository. I understand the commands that are listed here.

mrueg pushed a commit to mrueg/prometheus-community-helm-charts that referenced this pull request Apr 15, 2021
mrueg pushed a commit to mrueg/prometheus-community-helm-charts that referenced this pull request Apr 25, 2021
langecode pushed a commit to neticdk/helm-charts that referenced this pull request Aug 12, 2021
QuentinBisson pushed a commit to giantswarm/prometheus-community-helm-charts-upstream that referenced this pull request Oct 5, 2021
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
approved Indicates a PR has been approved by an approver from all required OWNERS files. cncf-cla: no Indicates the PR's author has not signed the CNCF CLA. do-not-merge/invalid-commit-message Indicates that a PR should not merge because it has an invalid commit message. lgtm "Looks good to me", indicates that a PR is ready to be merged. size/XXL Denotes a PR that changes 1000+ lines, ignoring generated files.
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Provide a new home for the helm chart