Skip to content

Doc: Clarify how to configure CephFS vols as image/backup store#1418

Open
roosterfish wants to merge 1 commit into
canonical:mainfrom
roosterfish:fix_manual_vol_setup
Open

Doc: Clarify how to configure CephFS vols as image/backup store#1418
roosterfish wants to merge 1 commit into
canonical:mainfrom
roosterfish:fix_manual_vol_setup

Conversation

@roosterfish

@roosterfish roosterfish commented Jun 18, 2026

Copy link
Copy Markdown
Contributor

Fixes #1417.

A user might not be aware that it's crucial to set the config per cluster member. So instead of mentioning it at the bottom, use the --target key specifically.

Otherwise a user would need to know that he needs to go to each cluster member to set the config key.

Copilot AI left a comment

Copy link
Copy Markdown

Choose a reason for hiding this comment

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

Pull request overview

Updates the MicroCloud initialization documentation to clarify how to configure LXD’s storage.images_volume and storage.backups_volume when using CephFS, emphasizing per-cluster-member configuration via lxc --target.

Changes:

  • Adjusts the instructions for setting storage.images_volume / storage.backups_volume to use --target <cluster member>.
  • Adjusts the “view configured values” examples to use --target <cluster member> as well.

💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.

Comment thread doc/how-to/initialize.md Outdated

@elijahgreenstein elijahgreenstein left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

Just a small suggestion, @roosterfish

Comment thread doc/how-to/initialize.md Outdated
```

Once the storage volumes are created, set them as the values for the {ref}`configuration options <lxd:server-options-misc>` of `storage.images_volume` and `storage.backups_volume`. This example syntax uses `remote-fs` as the storage pool, along with volumes named `images` and `backup`:
Once the storage volumes are created, set them as the values for the {ref}`configuration options <lxd:server-options-misc>` of `storage.images_volume` and `storage.backups_volume`. Repeat these steps for each cluster member.

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

Suggested change
Once the storage volumes are created, set them as the values for the {ref}`configuration options <lxd:server-options-misc>` of `storage.images_volume` and `storage.backups_volume`. Repeat these steps for each cluster member.
Once the storage volumes are created, set them as the values for the `storage.images_volume` and `storage.backups_volume` {ref}`configuration options <lxd:server-options-misc>`. Repeat these steps for each cluster member.

Copy link
Copy Markdown
Contributor Author

Choose a reason for hiding this comment

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

Thanks, fixed.

I have also moved the "Repeat these steps for each cluster member" sentence based on reporters feedback in #1417 (comment).

…backup store

A user might not be aware that it's crucial to set the config per cluster member.
So instead of mentioning it at the bottom, use the --target key specifically.

Otherwise a user would need to know that he needs to go to each cluster member to set the config key.

Signed-off-by: Julian Pelizäus <julian.pelizaeus@canonical.com>

@elijahgreenstein elijahgreenstein left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

LGTM! Moving the "repeat these steps" line makes a lot of sense

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

Documentation Documentation needs updating

Projects

None yet

Development

Successfully merging this pull request may close these issues.

docs: Documentation incorrect or misleading?

3 participants