Skip to content

Commit

Permalink
doc: Document boot status meaning (#4670)
Browse files Browse the repository at this point in the history
  • Loading branch information
holmanb committed Dec 11, 2023
1 parent 3c0394c commit 6fc10ed
Showing 1 changed file with 24 additions and 0 deletions.
24 changes: 24 additions & 0 deletions doc/rtd/howto/status.rst
Original file line number Diff line number Diff line change
Expand Up @@ -58,5 +58,29 @@ See the list of all possible reported statuses:
"degraded running"
"disabled"
Cloud-init enablement status
----------------------------

Separately from the current running status described above, cloud-init can also
report how it was disabled or enabled. This can be viewed by checking
the `boot_status_code` in ``cloud-init status --long``, which may
contain any of the following states:

- ``'unknown'``: ``ds-identify`` has not run yet to determine if cloud-init
should be run during this boot
- ``'disabled-by-marker-file'``: :file:`/etc/cloud/cloud-init.disabled` exists
which prevents cloud-init from ever running
- ``'disabled-by-generator'``: ``ds-identify`` determined no applicable
cloud-init datasources
- ``'disabled-by-kernel-cmdline'``: kernel cmdline contained
cloud-init=disabled
- ``'disabled-by-environment-variable'``: environment variable
``KERNEL_CMDLINE`` contained ``cloud-init=disabled``
- ``'enabled-by-kernel-cmdline'``: kernel cmdline contained
cloud-init=enabled
- ``'enabled-by-generator'``: ``ds-identify`` detected possible cloud-init
datasources
- ``'enabled-by-sysvinit'``: enabled by default in SysV init environment

See :ref:`our explanation of failure states<failure_states>` for more
information.

0 comments on commit 6fc10ed

Please sign in to comment.