Skip to content

Document manifest and storage backend operations#173

Merged
hemanthnakkina merged 1 commit intocanonical:mainfrom
gboutry:docs/storage
Mar 9, 2026
Merged

Document manifest and storage backend operations#173
hemanthnakkina merged 1 commit intocanonical:mainfrom
gboutry:docs/storage

Conversation

@gboutry
Copy link
Copy Markdown
Contributor

@gboutry gboutry commented Mar 6, 2026

No description provided.

Copy link
Copy Markdown

Copilot AI left a comment

Choose a reason for hiding this comment

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

Pull request overview

Adds documentation for configuring and operating storage backends via the deployment manifest and Sunbeam operational procedures, expanding the ops guide to cover Pure Storage and gated (feature-flagged) in-tree backends.

Changes:

  • Documented storage: manifest structure for DellSC, Hitachi, and Pure Storage backends.
  • Added new operations guides for deploying a Pure Storage backend and enabling gated storage backends.
  • Updated the Operations toctree to include the new guides.

Reviewed changes

Copilot reviewed 4 out of 4 changed files in this pull request and generated 2 comments.

File Description
reference/manifest-file-reference.rst Adds a new storage: section describing backend config structure and example keys.
how-to/operations/index.rst Registers new storage backend operation pages in the Operations toctree.
how-to/operations/enable-a-gated-storage-backend.rst New how-to explaining feature-gate unlock and deployment workflow for gated backends.
how-to/operations/deploy-pure-storage-backend.rst New how-to detailing Pure Storage backend deployment and configuration keys.

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

You can also share your feedback on Copilot code review. Take the survey.

Comment on lines +52 to +55
For NVMe/TCP deployments, you can also set ``pure-nvme-cidr`` and
``pure-nvme-transport``. Only ``tcp`` is supported for
``pure-nvme-transport``.

Copy link

Copilot AI Mar 6, 2026

Choose a reason for hiding this comment

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

The Pure Storage how-to mentions configuring pure-nvme-transport, but the manifest reference’s purestorage config key list omits it. Please align these docs (either document pure-nvme-transport in the manifest reference, or remove/adjust the how-to guidance if it isn’t a supported key).

Suggested change
For NVMe/TCP deployments, you can also set ``pure-nvme-cidr`` and
``pure-nvme-transport``. Only ``tcp`` is supported for
``pure-nvme-transport``.
For NVMe/TCP deployments, you can also set ``pure-nvme-cidr`` to specify the
NVMe/TCP network used by the array. NVMe transport is TCP.

Copilot uses AI. Check for mistakes.
Comment thread reference/manifest-file-reference.rst
@gboutry gboutry force-pushed the docs/storage branch 2 times, most recently from 1808af9 to a21f86c Compare March 9, 2026 08:16
Signed-off-by: Guillaume Boutry <guillaume.boutry@canonical.com>
@gboutry gboutry marked this pull request as ready for review March 9, 2026 08:47
@gboutry gboutry requested a review from hemanthnakkina March 9, 2026 08:47
@hemanthnakkina hemanthnakkina merged commit 23b0da1 into canonical:main Mar 9, 2026
6 of 7 checks passed
@gboutry gboutry deleted the docs/storage branch March 9, 2026 15:44
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