Skip to content

docs: Address default-storage class UX #61

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

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

docs: Address default-storage class UX #61

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
e182b58
docs: Address default-storage class UX
addyess Oct 24, 2025
3217e2f
Update charmcraft.yaml
addyess Dec 18, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
12 changes: 11 additions & 1 deletion charmcraft.yaml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -47,7 +47,17 @@ config:
options:
default-storage:
default: ceph-xfs
description: "Default storage class to use. Allowed values: 'ceph-ext4', 'ceph-xfs', 'cephfs'"
description: |
Default storage class to use.

If the charm created storage class matches this value, it will be
annotated as the default storage class in the kubernetes cluster.

Note: a cluster should only annotate one storage class as the default.
If multiple storage classes are annotated as default, the behavior
is undefined and may lead to unexpected results.

Leave empty to not set any storage class default via this charm.
Comment on lines +50 to +60
Copy link

Copilot AI Dec 18, 2025

Choose a reason for hiding this comment

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

The updated description removes the list of allowed values that was present in the original description ('ceph-ext4', 'ceph-xfs', 'cephfs'). While the new explanation of the behavior is clearer, users still need guidance on what values to specify here.

Consider adding a line that mentions the default storage class names or references the storage-class-name-formatter configuration options. For example: "By default, the charm creates storage classes named 'ceph-xfs', 'ceph-ext4', and 'cephfs' (these names can be customized via the respective storage-class-name-formatter options)."

Without this information, users may not know what value to set for this configuration option.

Copilot uses AI. Check for mistakes.
Copy link
Contributor

@nhennigan nhennigan Dec 18, 2025

Choose a reason for hiding this comment

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

Does copilot have a point about including the accepted types?

type: string

provisioner-replicas:
Expand Down
Loading