canonical / cloud-init

Official upstream for the cloud-init: cloud instance initialization
https://cloud-init.io/
Other
2.93k stars 877 forks source link

[docs]: Describe disabling vendor-data on the vendor-data page #5833

Open zhaohuijuan opened 1 day ago

zhaohuijuan commented 1 day ago

Documentation request

Regarding the vendor-data, the doc[1] mentions that: [1] https://cloudinit.readthedocs.io/en/latest/explanation/vendordata.html

1. Users have ultimate control over vendor data. They can disable its execution or disable handling of specific parts of multi-part input.

Does it mean users could disable the call to vendor-data? If yes, there is no detail methods provided in the doc, could you please provide the detail ways how to disable the call to vendor-data? e.g. How to config it?

Background

This requirement comes from the below user case:

We use this datasource config on the image:

datasource_list: [NoCloud]

datasource:
 NoCloud:
   seedfrom: https://server.example.com/userdata/

When we do so and when cloud-init runs, It gets the userdata metadata and then it also asks for the vendor-data.. At satellite side, we don't server anything as vendor-data, so we accepted the errors raised by that endpoint and then converted it to WARNINGS But the end-user wants to know, if we can disable the call to the vendor-data endpoint somehow or not ..

sayan3296 commented 1 day ago

I am guessing that this is what we are looking for https://docs.cloud-init.io/en/latest/reference/yaml_examples/scripts.html#example-3

sayan3296 commented 1 day ago

Not sure who can but someone should hyperlink that doc inside https://cloudinit.readthedocs.io/en/latest/explanation/vendordata.html , for ease of access.

holmanb commented 16 hours ago

At satellite side, we don't server anything as vendor-data, so we accepted the errors raised by that endpoint and then converted it to WARNINGS But the end-user wants to know, if we can disable the call to the vendor-data endpoint somehow or not.

Serving an empty file at that address would resolve the issue.

Not sure who can but someone should hyperlink that doc inside https://cloudinit.readthedocs.io/en/latest/explanation/vendordata.html , for ease of access.

@sayan3296 That seems like a reasonable addition. I'll repurpose this report for that.