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
Description
Cloud-init provides a mechanism for cloud instance initialization. This is done by identifying the cloud platform that is in use, reading provided cloud metadata and optional vendor and user data, and then initializing the instance as requested.
Generally, this command is not normally meant to be run directly by the user. However, some subcommands may useful for development or debug of deployments.
Options
- -h, --help
Show help message and exit.
- -d, --debug
Show additional pre-action logging (default: False).
- -f <files>, --files <files>
Use additional YAML configuration files.
- --force
Force running even if no datasource is found (use at your own risk).
- -v, --version
Show program's version number and exit.
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.
- init
Initialize cloud-init and execute initial modules.
- modules
Activate modules using a given configuration key.
- query
Query standardized instance metadata from the command line.
- schema
Validate cloud-config files using jsonschema.
- single
Run a single module.
- status
Report cloud-init status or wait on completion.
Exit Status
0 - Success
1 - Error - Cloud-init failed.
2 - Recoverable error - Cloud-init completed but experienced errors.
Copyright
Copyright (C) 2020 Canonical Ltd. License GPL-3 or Apache-2.0
See Also
Full documentation at: <https://cloudinit.readthedocs.io>