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 Reference Docs for Charm Configurations #939

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

Conversation

mateoflorido
Copy link
Member

Overview

This pull request adds a reference page for the configuration options for the k8s and k8s-worker operator charms.

Changes

  • Configuration options for the k8s operator charm.
  • Configuration options for the k8s-worker charm.
  • Options prefixed with bootstrap are intended to be set exclusively during the bootstrap stage.
  • Python script to regenerate the reference parts using the charmcraft.yaml files.

@mateoflorido mateoflorido requested a review from a team as a code owner January 9, 2025 00:54
Copy link
Contributor

@HomayoonAlimohammadi HomayoonAlimohammadi left a comment

Choose a reason for hiding this comment

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

Great work @mateoflorido, thanks a lot! LGTM

Copy link
Contributor

Choose a reason for hiding this comment

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

What a nice addition to this PR. Maybe we can also add a check in CI (in the future) to make sure running this script won't cause changes (so that the docs match the charmcraft.yaml file).

Copy link
Contributor

@nhennigan nhennigan left a comment

Choose a reason for hiding this comment

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

Great work. Quick question on the versioning.

Please also fix the md lint issue.

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.

3 participants