docs: add documentation for harvester-node-disk-manager ConfigMap#975
docs: add documentation for harvester-node-disk-manager ConfigMap#975Yu-Jack wants to merge 1 commit intoharvester:mainfrom
Conversation
|
- Add new disk-filter-and-auto-provision.md page with complete documentation - Document ConfigMap location, structure, and configuration options - Update settings.md to link to the new documentation page Signed-off-by: Jack Yu <jack.yu@suse.com>
github-actions
bot
requested review from
akashraj4261,
dariavladykina and
jillian-maroket
There was a problem hiding this comment.
Pull request overview
This PR adds new documentation for the harvester-node-disk-manager ConfigMap, which is the recommended way (from Harvester v1.8.0 onwards) to configure disk filtering and auto-provisioning. It also updates the legacy auto-disk-provision-paths setting page to reference the new ConfigMap approach.
Changes:
- New
disk-filter-and-auto-provision.mdpage documenting the ConfigMap-based disk filtering and auto-provisioning feature - Update to
settings.mdadding a version note and a callout block pointing to the new page
Reviewed changes
Copilot reviewed 2 out of 2 changed files in this pull request and generated 5 comments.
| File | Description |
|---|---|
docs/advanced/disk-filter-and-auto-provision.md |
New documentation page covering ConfigMap location, YAML configuration structure, hostname patterns, filter options, auto-provisioning options, and migration from the legacy setting |
docs/advanced/settings.md |
Adds a **Versions** field and a :::note callout to the auto-disk-provision-paths section directing readers to the new ConfigMap-based approach |
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
|
|
||
| ### `auto-disk-provision-paths` [Experimental] | ||
|
|
||
| **Versions**: v1.8.0 and later recommend using ConfigMap |
There was a problem hiding this comment.
The **Versions** line on line 41 reads "v1.8.0 and later recommend using ConfigMap", which is inconsistent with how this field is formatted throughout the rest of settings.md. Every other **Versions** entry uses the pattern "vX.Y.Z and later" (e.g., "v1.3.0 and later" on line 71) without appended recommendation text. The recommendation already appears in the :::note block that follows (lines 47–51), so the **Versions** line should be simplified to just "v1.8.0 and later", or removed if the setting's version metadata isn't specifically tied to v1.8.0.
| **Versions**: v1.8.0 and later recommend using ConfigMap | |
| **Versions**: v1.8.0 and later |
| ## Migration from Legacy Setting | ||
|
|
||
| If you are currently using the `auto-disk-provision-paths` setting, consider migrating to this ConfigMap approach for better flexibility and control. For more information about the legacy setting, see the [`auto-disk-provision-paths`](./settings.md#auto-disk-provision-paths-experimental) setting documentation. No newline at end of file |
There was a problem hiding this comment.
The PR description contains an unchecked checklist item: "Need to put the link next to this." accompanied by a screenshot. This suggests there is still a pending action to add a link somewhere in the documentation that has not been completed. Please review the screenshot in the PR description and ensure the intended link has been added before merging.
| sidebar_label: Filter out and auto provision disks | ||
| title: "Filter out and auto provision disks" | ||
| --- | ||
|
|
There was a problem hiding this comment.
The new file is missing the <head> block with the canonical URL that every other doc page in docs/advanced/ includes. All other files in this directory have a block like:
<head>
<link rel="canonical" href="https://docs.harvesterhci.io/v1.7/advanced/disk-filter-and-auto-provision"/>
</head>
This is important for SEO consistency across the documentation site. Please add this block after the frontmatter, following the pattern used throughout docs/advanced/.
| <head> | |
| <link rel="canonical" href="https://docs.harvesterhci.io/v1.7/advanced/disk-filter-and-auto-provision"/> | |
| </head> |
| - "/dev/sdd" | ||
| filters.yaml: | | ||
| - hostname: "*" | ||
| excludeLabels: ["COS_*, HARV_*"] |
There was a problem hiding this comment.
The excludeLabels value ["COS_*, HARV_*"] contains two wildcard patterns as a single string separated by a comma. Based on the pattern used by all other list fields in the same examples (e.g., excludeVendors: ["longhorn", "thisisaexample"], excludeDevices: ["/dev/sdd", "/dev/sd*"]), each pattern should be a separate list item. The value should be ["COS_*", "HARV_*"] to correctly represent two distinct label exclusion patterns.
| excludeLabels: ["COS_*, HARV_*"] | |
| excludeLabels: ["COS_*", "HARV_*"] |
| ```yaml | ||
| filters.yaml: | | ||
| - hostname: "*" | ||
| excludeLabels: ["COS_*, HARV_*"] |
There was a problem hiding this comment.
The excludeLabels value ["COS_*, HARV_*"] contains two wildcard patterns as a single string separated by a comma. Based on the pattern used by all other list fields in the same examples (e.g., excludeVendors: ["longhorn", "thisisaexample"], excludeDevices: ["/dev/sdd", "/dev/sd*"]), each pattern should be a separate list item. The value should be ["COS_*", "HARV_*"] to correctly represent two distinct label exclusion patterns.
harvester/harvester#5059