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

*: Add dedicated CRD helm chart #10828

Open
wants to merge 6 commits into
base: main
Choose a base branch
from

Conversation

timflannagan
Copy link
Member

Description

Introduces a dedicated CRD helm chart in preparation for the 2.0 release. This aligns with helm best practices w.r.t CRD management. See https://helm.sh/docs/chart_best_practices/custom_resource_definitions/#method-2-separate-charts for more information on this approach.

This is the first step towards auditing our install UX story. Having a dedicated chart before 2.0 is cut helps prevents any painful migrations for subsequent 2.x minor versions. See #10640 for some of the details captured there.

Checklist:

  • I have performed a self-review of my own code
  • I have commented my code, particularly in hard-to-understand areas
  • I have made corresponding changes to the documentation
  • I have added tests that prove my fix is effective or that my feature works

- helm create install/helm/kgateway-crds

- Delete charts/ directory

- Delete the templates/ directory

- Remove all unrelated values.yaml

Signed-off-by: timflannagan <[email protected]>
@timflannagan timflannagan changed the title Chore/add separate crd chart *: Add dedicated CRD helm chart Mar 12, 2025
@timflannagan timflannagan linked an issue Mar 12, 2025 that may be closed by this pull request
Copy link
Contributor

@lgadban lgadban left a comment

Choose a reason for hiding this comment

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

just a few comments/questions

# This is the chart version. This version number should be incremented each time you make changes
# to the chart and its templates, including the app version.
# Versions are expected to follow Semantic Versioning (https://semver.org/)
version: 0.1.0
Copy link
Contributor

Choose a reason for hiding this comment

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

I think I'm missing something, but is this version relevant?

package-kgateway-charts: package-kgateway-chart package-kgateway-crd-chart

.PHONY: package-kgateway-chart
package-kgateway-chart: ## Package the kgateway chart for testing
Copy link
Contributor

Choose a reason for hiding this comment

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

nit: is this comment accurate w.r.t. "for testing"?
Looks like this is the target used in the release workflow as well

@@ -1,6 +1,6 @@
apiVersion: v2
name: kgateway
description: A Helm chart for Kubernetes
description: A Helm chart for the kgateway project
Copy link
Contributor

Choose a reason for hiding this comment

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

👍

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Add dedicated CRD helm chart
2 participants