doc: clarify required vs optional files for NoCloud datasource - #7029
Open
sundeep8967 wants to merge 2 commits into
Open
doc: clarify required vs optional files for NoCloud datasource#7029sundeep8967 wants to merge 2 commits into
sundeep8967 wants to merge 2 commits into
Conversation
github-actions
Bot
added
the
documentation
sundeep8967
force-pushed
the
fix/nocloud-mandatory-files-doc
branch
from
August 27, 2026 05:38
a0f8d1d to
bafbc05
Compare
blackboxsw
requested changes
Aug 31, 2026
blackboxsw
left a comment
blackboxsw
left a comment
Collaborator
There was a problem hiding this comment.
Thank you @sundeep8967 for this update. Couple of minor comments and then +1
|
|
||
| * ``vendor-data`` (optional): Used for cloud provider defaults. | ||
| * ``network-config`` (optional): Network configuration if differing | ||
| from defaults. |
Collaborator
There was a problem hiding this comment.
Thank you for these clarifying headers and section breaks.
I think this section is clear enough given the bolded title. Let's drop the (required) and (optional) for each item within that section.
Suggested change
| from defaults. | |
| * ``meta-data``: Contains cloud-instance information. | |
| It is recommended to define a unique ``instance-id``. | |
| * ``user-data``: Contains user configuration instructions | |
| (can be empty if no configuration is needed). | |
| * **Optional files:** | |
| * ``vendor-data`` : Used for cloud provider defaults. | |
| * ``network-config``: Network configuration if differing | |
| from defaults. |
Comment on lines
+227
to
+228
| invalid and skip it (e.g., logging a warning such as | ||
| ``device ... with label=cidata not a valid seed``). |
Collaborator
There was a problem hiding this comment.
I don't think we want to statically represent the exact warning log message here as it may change in the future.
Suggested change
| invalid and skip it (e.g., logging a warning such as | |
| ``device ... with label=cidata not a valid seed``). | |
| invalid and skip it while logging a warning. |
Collaborator
There was a problem hiding this comment.
Can we add your (required) up here instead as we don't have a clear representation madatory vs optional data in this section.
Suggested change
| user-data (required) |
Collaborator
There was a problem hiding this comment.
Suggested change
| meta-data (required) |
Collaborator
There was a problem hiding this comment.
Suggested change
| vendor-data (optional) |
Collaborator
There was a problem hiding this comment.
Suggested change
| network-config (optional) |
Contributor
Author
|
thanks for the review! updated the documentation with all the suggestions:
|
Explicitly specify that user-data and meta-data are required for the NoCloud datasource to operate, while vendor-data and network-config are optional. Add explanatory note regarding missing seed files. Fixes canonicalGH-5858
…l files Signed-off-by: sundeep8967 <sundeep8967@gmail.com>
sundeep8967
force-pushed
the
fix/nocloud-mandatory-files-doc
branch
from
September 5, 2026 09:38
1b4a7b5 to
0d4dd31
Compare
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Summary of changes
This PR updates the NoCloud documentation in
doc/rtd/reference/datasources/nocloud.rst:meta-dataanduser-dataas Required files andvendor-dataandnetwork-configas Optional files.user-dataormeta-datais missing, the NoCloud datasource treats the seed as invalid and skips it (which often manifests asdevice ... with label=cidata not a valid seed).Fixes #5858
Testing done
Ran pytest unit tests locally:
All tests passed.