cloud-init icon indicating copy to clipboard operation
cloud-init copied to clipboard

[docs]: NoCloud missing mandatory file information

Open stmccartneyncc opened this issue 1 year ago • 4 comments

Documentation request

The NoCloud doc page is missing the fact that both user-data and meta-data are required in order for NoCloud to work successfully, and that the other two files are optional. If you don't have both user-data and meta-data you get the error "device /dev/sd* with label=cidata not a valid seed"


Reported from: https://cloudinit.readthedocs.io/en/latest/reference/datasources/nocloud.html

stmccartneyncc avatar Nov 07 '24 16:11 stmccartneyncc

Just wanted to mention that I've already reported here: issue 5843

MarekZydor avatar Dec 01 '24 20:12 MarekZydor

To be fair, the current docs imply that this is required:

For example, if the seedfrom value of seedfrom is https://10.42.42.42/, then the following files will be fetched from the webserver at first boot:

https://10.42.42.42/user-data
https://10.42.42.42/vendor-data
https://10.42.42.42/meta-data
https://10.42.42.42/network-config

If the required files don’t exist, this datasource will be skipped.

You're right that the docs don't say which of these are required. I guess we should include that.

holmanb avatar Dec 02 '24 18:12 holmanb

To be fair, the current docs imply that this is required:

For example, if the seedfrom value of seedfrom is https://10.42.42.42/, then the following files will be fetched from the webserver at first boot:

https://10.42.42.42/user-data
https://10.42.42.42/vendor-data
https://10.42.42.42/meta-data
https://10.42.42.42/network-config

If the required files don’t exist, this datasource will be skipped.

You're right that the docs don't say which of these are required. I guess we should include that.

Yes, if that section could be updated to just say that only two of the files are mandatory (and that meta-data can be blank) then I think that would make it much clearer

stmccartneyncc avatar Dec 03 '24 11:12 stmccartneyncc

and that meta-data can be blank

Could be, perhaps. However this would not be best practice. A unique instance id should be given to each instance.

holmanb avatar Dec 09 '24 18:12 holmanb