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

Reorder values and their documentation #199

Merged
merged 2 commits into from
May 7, 2024

Conversation

LeoColomb
Copy link
Member

@LeoColomb LeoColomb commented May 5, 2024

The goal of this PR is to give the values.yaml a sectioned structure to ease its reading and its maintenance.
The following objectives are in mind:

  • Add standard global parameters (used across more and more charts)
  • Document all values as much as possible
  • Gives all values a formatted comment
    • It follows Bitnami's standard
    • That will help to auto-generate docs as a next step
      • With something that can use on tools like https://artifacthub.io/
      • Eventually get rid of the cumbersome to maintain README's list
  • Regroup parameters per scope
    • Global
    • Common
    • NetBox Image
    • NetBox Configuration
    • Deployment
    • Traffic Exposure
    • Metrics
    • Databases
    • Autoscaling
    • Volume permissions / Init
    • Test
    • Housekeeping
    • Worker

Note

Despite the high number of line changed, very few values (~10) are renamed.
The chart remains mostly the same.

Note

install --upgrade test is failing since one or more values have been renamed but the chart not bumped to the next major version.

@LeoColomb LeoColomb force-pushed the fix/values branch 4 times, most recently from 8da620a to 8e6d57f Compare May 5, 2024 20:23
@RangerRick RangerRick merged commit d4c5ca7 into netbox-community:develop May 7, 2024
7 of 8 checks passed
@LeoColomb LeoColomb deleted the fix/values branch May 20, 2024 09:06
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.

2 participants