cloud-init - Man Page

Cloud instance initialization

Examples (TL;DR)

Display the status of the most recent cloud-init run: cloud-init status
Wait for cloud-init to finish running and then report status: cloud-init status --wait
List available top-level metadata keys to query: cloud-init query --list-keys
Query cached instance metadata for data: cloud-init query dot_delimited_variable_path
Clean logs and artifacts to allow cloud-init to rerun: cloud-init clean

Synopsis

cloud-init [-h] [-d] [--force] [-v] [SUBCOMMAND]

Cloud-init provides a mechanism for cloud instance initialization. This is done by identifying the cloud platform that is in use, reading cloud meta-data, vendor-data and user-data, and then initializing the instance as requested.

Options

-h, --help: Show help message and exit.
-v, --version: Show program's version number and exit.
--all-stages: INTERNAL: Run cloud-init's stages under a single process using a syncronization protocol. This is not intended for CLI usage.

Subcommands

Please see the help output for each subcommand for additional details, flags, and subcommands.

analyze: Analyze cloud-init logs and data.
collect-logs: Collect and tar all cloud-init debug info.
clean: Remove logs and artifacts so cloud-init can re-run.
devel: Run development tools. See help output for subcommand details.
features: List defined features.
query: Query standardized instance metadata from the command line.
schema: Validate cloud-config files using jsonschema.
single: Manually run a single module. Useful for testing during development.
status: Report cloud-init status or wait on completion.

Deprecated

-d, --debug: Show additional pre-action logging (default: False).
--force: Force running even if no datasource is found (use at your own risk).
init: Initialize cloud-init and execute initial modules.
modules: Activate modules using a given configuration key.