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

values schema #811

Draft
wants to merge 20 commits into
base: main
Choose a base branch
from
Draft

values schema #811

wants to merge 20 commits into from

Conversation

wkloucek
Copy link
Contributor

@wkloucek wkloucek commented Nov 22, 2024 •
edited by d7oc
Loading

Description

Maintain a schema file to find misconfigurations.
There were already some misconfigurations found in the deployment examples (see the diff).

Related Issue

Motivation and Context

How Has This Been Tested?

  • tested in CI against CI values and deployment examples
  • tested against well known deployments outside of this Chart repo
    • the "B" project, see issue backref on this ticket
    • the "E" project, I ran a command like this helm lint charts/ocis -f ~/Projects/gitlab.xxx/exxx/ocis-infra/common/ocis/values.yaml -f ~/Projects/gitlab.xxx/exxx/ocis-infra/prod/apps/ocis/values.yaml

Screenshots (if appropriate):

Types of changes

  • Bug fix (non-breaking change which fixes an issue)
  • New feature (non-breaking change which adds functionality)
  • Breaking change (fix or feature that would cause existing functionality to change)
  • Technical debt
  • Tests only (no source changes)

Checklist:

  • Code changes
  • Unit tests added
  • Acceptance tests added
  • Documentation generated (make docs) and committed
  • Documentation ticket raised:
  • Documentation PR created:

@wkloucek wkloucek marked this pull request as draft November 22, 2024 10:27
@wkloucek wkloucek mentioned this pull request Nov 25, 2024
Merged
11 tasks
@wkloucek wkloucek added the QA label Nov 25, 2024
@wkloucek wkloucek requested a review from d7oc November 25, 2024 14:23
@wkloucek
Copy link
Contributor Author

wkloucek commented Nov 25, 2024 •
edited
Loading

@d7oc could you skim those changes to check if you agree with the principle of this change?

Most interesting from my side:

  • the effect on the values.yaml changes in the future (one needs to maintain the schema annotations)
  • the schema helps devs to put configuration in the right place and avoid configuration that does nothing (includes config that was removed)
  • the deployment examples stay up to date because their configuration is now linted, too
  • the schema forces us to have sane defaults / configuration methods

If we can agree on the schema beeing a good thing, I'll gonna do some polishing on this PR, especially on the configuration documentation that received a small fallout.

This was referenced Nov 25, 2024
Merged
Merged
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@d7oc d7oc Awaiting requested review from d7oc

At least 1 approving review is required to merge this pull request.

Assignees
No one assigned
Labels
QA
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.

Add values schema
1 participant
@wkloucek