Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

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

Open
zhaohuijuan opened this issue Oct 21, 2024 · 3 comments
Open

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

zhaohuijuan opened this issue Oct 21, 2024 · 3 comments
Labels
documentation This Pull Request changes documentation

Comments

@zhaohuijuan
Copy link

zhaohuijuan commented Oct 21, 2024

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 ..

@zhaohuijuan zhaohuijuan added documentation This Pull Request changes documentation new An issue that still needs triage labels Oct 21, 2024
@sayan3296
Copy link

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
Copy link

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
Copy link
Member

holmanb commented Oct 22, 2024

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.

@holmanb holmanb changed the title [docs]: Is there any way to disable the call to the vendor-data endpoint? [docs]: Describe disabling vendor-data on the vendor-data page Oct 22, 2024
@holmanb holmanb removed the new An issue that still needs triage label Oct 22, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation This Pull Request changes documentation
Projects
None yet
Development

No branches or pull requests

3 participants