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.

Sign up for GitHub

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

Jump to bottom

Chart: Add values.schema.json. #11295

Open
wants to merge 1 commit into
base: main
Choose a base branch
from
Open

Chart: Add values.schema.json. #11295

wants to merge 1 commit into from
+2,027 −29

Conversation

ubergesundheit
Copy link
Contributor

What this PR does / why we need it:

This PR adds a schema file for the helm chart values and means to generate and validate the schema and the default values file in CI.

User supplied values will be validated using the schema on helm install and helm upgrade. This can prevent misconfiguations.

Fixes #10838

Types of changes

  • Bug fix (non-breaking change which fixes an issue)
  • New feature (non-breaking change which adds functionality)
  • CVE Report (Scanner found CVE and adding report)
  • Breaking change (fix or feature that would cause existing functionality to change)
  • Documentation only

Which issue/s this PR fixes

fixes #10838

How Has This Been Tested?

This has been tested by running the GitHub actions workflow in my fork. See https://github.com/ubergesundheit/ingress-nginx/actions/runs/8784477153

Checklist:

  • My change requires a change to the documentation.
  • I have updated the documentation accordingly.
  • I've read the CONTRIBUTION guide
  • I have added unit and/or e2e tests to cover my changes.
  • All new and existing tests passed.

@k8s-ci-robot k8s-ci-robot added area/helm Issues or PRs related to helm charts cncf-cla: yes Indicates the PR's author has signed the CNCF CLA. needs-triage Indicates an issue or PR lacks a `triage/foo` label and requires one. needs-kind Indicates a PR lacks a `kind/foo` label and requires one. needs-priority size/XXL Denotes a PR that changes 1000+ lines, ignoring generated files. labels Apr 22, 2024
@netlify Netlify
Copy link

netlify bot commented Apr 22, 2024 •
edited

✅ Deploy Preview for kubernetes-ingress-nginx canceled.

Name Link
🔨 Latest commit e0af377
🔍 Latest deploy log https://app.netlify.com/sites/kubernetes-ingress-nginx/deploys/6628b26a91a5620008407f98

@Gacko
Copy link
Member

Gacko commented Apr 23, 2024

/triage accepted
/kind feature
/priority backlog

@k8s-ci-robot k8s-ci-robot added triage/accepted Indicates an issue or PR is ready to be actively worked on. kind/feature Categorizes issue or PR as related to a new feature. priority/backlog Higher priority than priority/awaiting-more-evidence. and removed needs-triage Indicates an issue or PR lacks a `triage/foo` label and requires one. needs-kind Indicates a PR lacks a `kind/foo` label and requires one. needs-priority labels Apr 23, 2024
@Gacko
Copy link
Member

Gacko commented Apr 23, 2024

/retitle Chart: Add values.schema.json.

@k8s-ci-robot k8s-ci-robot changed the title Add helm values.schema.json Chart: Add values.schema.json. Apr 23, 2024
@Gacko
Copy link
Member

Gacko commented Apr 23, 2024

/cherry-pick release-1.10
/hold
/assign

@k8s-infra-cherrypick-robot
Copy link
Contributor

@Gacko: once the present PR merges, I will cherry-pick it on top of release-1.10 in a new PR and assign it to you.

In response to this:

/cherry-pick release-1.10
/hold
/assign

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.

@k8s-ci-robot k8s-ci-robot added the do-not-merge/hold Indicates that a PR should not merge because someone has issued a /hold command. label Apr 23, 2024
tao12345666333
tao12345666333 requested changes Apr 24, 2024
View reviewed changes
.github/workflows/ci.yaml Outdated
echo "Please use dadav/helm-schema in your clone, of your fork, of the project, and commit a updated values.schema.json for the chart. https://github.com/kubernetes/ingress-nginx/blob/main/MANUAL_RELEASE.md#d-edit-the-valuesyaml-and-run-helm-schema-and-helm-docs"
fi
git diff --exit-code
rm -f ./helm-docs
Copy link
Member

Choose a reason for hiding this comment

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

helm-schema

@k8s-ci-robot
Copy link
Contributor

[APPROVALNOTIFIER] This PR is NOT APPROVED

This pull-request has been approved by: ubergesundheit
Once this PR has been reviewed and has the lgtm label, please ask for approval from gacko. For more information see the Kubernetes Code Review Process.

The full list of commands accepted by this bot can be found 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

@ubergesundheit
Add helm values.schema.json
e0af377 
Signed-off-by: Gerald Pape <gerald@giantswarm.io>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@tao12345666333 tao12345666333 tao12345666333 requested changes

@puerco puerco Awaiting requested review from puerco

Assignees

@Gacko Gacko

Labels
area/helm Issues or PRs related to helm charts cncf-cla: yes Indicates the PR's author has signed the CNCF CLA. do-not-merge/hold Indicates that a PR should not merge because someone has issued a /hold command. kind/feature Categorizes issue or PR as related to a new feature. priority/backlog Higher priority than priority/awaiting-more-evidence. size/XXL Denotes a PR that changes 1000+ lines, ignoring generated files. triage/accepted Indicates an issue or PR is ready to be actively worked on.
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.

Provide a schema for values for the Helm chart
5 participants
@ubergesundheit @Gacko @k8s-infra-cherrypick-robot @k8s-ci-robot @tao12345666333