Skip to content

docs: clarify default user entry in users examples#6894

Open
alan747271363-art wants to merge 1 commit into
canonical:mainfrom
alan747271363-art:docs-note-default-user-entry
Open

docs: clarify default user entry in users examples#6894
alan747271363-art wants to merge 1 commit into
canonical:mainfrom
alan747271363-art:docs-note-default-user-entry

Conversation

@alan747271363-art
Copy link
Copy Markdown

Summary

  • turn the existing default-user behavior warning into a more visible note in the Users and Groups module docs
  • add the same warning to the YAML example page so custom users: lists mention keeping default first

Fixes #6702.

Testing

  • git diff --check HEAD~1..HEAD
  • YAML parse check for doc/module-docs/cc_users_groups/data.yaml

Note: I could not run the full Sphinx docs build on Windows because importing cloud-init docs currently requires the Unix-only grp module in this environment.

Comment on lines +35 to +40
.. note::
If you provide a ``users`` list and still want cloud-init to create the
default distribution user, keep ``default`` as the first item in the
list. Omitting ``default`` skips creation of the default user and can
prevent cloud-provided SSH keys from being installed for that user.

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

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

Isn't this already documented?

Signed-off-by: Alan <alan747271363-art@users.noreply.github.com>
@alan747271363-art alan747271363-art force-pushed the docs-note-default-user-entry branch from d4f241c to fc946fd Compare June 3, 2026 12:02
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.

[docs]: Explicitly mention the need to put - default in the users array if we want to modify an existing user

2 participants