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(nodeadm): clarify config-source #2108

Open
wants to merge 1 commit into
base: main
Choose a base branch
from
Open

Conversation

Issacwww
Copy link
Member

@Issacwww Issacwww commented Jan 5, 2025

Issue #, if available:
N/A

Description of changes:
Add clarification for the config-source in the doc

By submitting this pull request, I confirm that you can use, modify, copy, and redistribute this contribution, under the terms of your choice.

Testing Done

See this guide for recommended testing for PRs. Some tests may not apply. Completing tests and providing additional validation steps are not required, but it is recommended and may reduce review time and time to merge.

@@ -49,6 +49,6 @@ spec: ...
--BOUNDARY--
```

A different source for the configuration object can be specified with the `--config-source` flag.
The source for the configuration object can be specified with the `--config-source` flag. It accepts a URI with supported schemes: [imds, file]. The default source is `imds://user-data`,
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
The source for the configuration object can be specified with the `--config-source` flag. It accepts a URI with supported schemes: [imds, file]. The default source is `imds://user-data`,
The source for the configuration object can be specified with the `--config-source` flag and follows a URI format. The default is `imds://user-data`, which pulls from EC2 instance userdata, but you may provide a file path with `file://...`.

@ndbaker1 ndbaker1 changed the title doc(nodeadm) Clarify config-source docs(nodeadm): clarify config-source Jan 11, 2025
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants