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]: Overhaul user data formats page #4739

Closed
holmanb opened this issue Jan 4, 2024 · 1 comment
Closed

[docs]: Overhaul user data formats page #4739

holmanb opened this issue Jan 4, 2024 · 1 comment
Assignees
Labels
documentation This Pull Request changes documentation

Comments

@holmanb
Copy link
Member

holmanb commented Jan 4, 2024

Cloud-init supports multiple formats, which are described on the user data formats page.

This page has a few improvements that should be made:

  1. Each format deserves a very brief example. This will make our format page more readable and allows skimming and reader intuition to fill in details faster than reading a wall of text.
  2. This page contains an unrelated kernel command line section. This section does not describe a format, and should be relocated or (more likely) deleted.
  3. This page contains an unrelated how to disable user data section. This section does not describe a format, and should be relocated.
  4. This page contains a how to write your own part-handler section. Future plans for this section have already been described in another issue. tl;dr - this belongs elsewhere
  5. Jinja templated user data is not documented on this page (it is best described on the instance metadata page)
  6. Currently these formats are not categorized, but could be categorized to make them easier to skim / grok by the reader (see the next section).

Recommended format categorization

These formats fall into two categories, which I will call base formats and meta-formats for now.

Base formats are formats that allow the user to configure the instance via cloud-init. Meta formats are formats that modify or aggregate base formats.

Base formats include the following: cloud config data, user data scripts, cloud-boothooks

Meta formats include the following: include files, gzip compressed content, mime archives, jinja templates (need to be documented)

@holmanb holmanb added documentation This Pull Request changes documentation new An issue that still needs triage labels Jan 4, 2024
@TheRealFalcon
Copy link
Member

The User Data Scripts section should additionally:

  • Remove euca-run-instances reference
  • Provide info on run frequency
  • Include jinja templating in an example to show how that may be used in shell scripts

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

4 participants