From c78fddea409b5b699572f19e2db6bfdc4ded4894 Mon Sep 17 00:00:00 2001 From: Joshua Powers Date: Wed, 11 Dec 2019 14:27:34 -0800 Subject: docs: add cloud-init manpage --- doc/man/cloud-init.1 | 88 ++++++++++++++++++++++++++++++++++++++++++++++++++++ 1 file changed, 88 insertions(+) create mode 100644 doc/man/cloud-init.1 (limited to 'doc/man') diff --git a/doc/man/cloud-init.1 b/doc/man/cloud-init.1 new file mode 100644 index 00000000..9b52dc8d --- /dev/null +++ b/doc/man/cloud-init.1 @@ -0,0 +1,88 @@ +.TH CLOUD-INIT 1 + +.SH NAME +cloud-init \- Cloud instance initialization + +.SH SYNOPSIS +.BR "cloud-init" " [-h] [-d] [-f FILES] [--force] [-v] {init,modules,single,query,dhclient-hook,features,analyze,collect-logs,clean,status}" + +.SH 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 intializing 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. + +.SH OPTIONS +.TP +.B "-h, --help" +Show help message and exit + +.TP +.B "-d, --debug" +Show additional pre-action logging (default: False) + +.TP +.B "-f , --files " +Additional YAML configuration files to use + +.TP +.B "--force" +Force running even if no datasource is found (use at your own risk) + +.TP +.B "-v, --version" +Show program's version number and exit + +.SH SUBCOMMANDS +Please see the help output for each subcommand for additional details, +flags, and subcommands. + +.TP +.B "analyze" +Analyze cloud-init logs and data. + +.TP +.B "collect-logs" +Collect and tar all cloud-init debug info. + +.TP +.B "clean" +Remove logs and artifacts so cloud-init can re-run. + +.TP +.B "dhclient-hook" +Run the dhclient hook to record network info. + +.TP +.B "features" +List defined features. + +.TP +.B "init" +Initializes cloud-init and performs initial modules. + +.TP +.B "modules" +Activates modules using a given configuration key. + +.TP +.B "query" +Query standardized instance metadata from the command line. + +.TP +.B "single" +Run a single module. + +.TP +.B "status" +Report cloud-init status or wait on completion. + +.SH COPYRIGHT +Copyright (C) 2020 Canonical Ltd. License GPL-3 or Apache-2.0 + +.SH SEE ALSO +Full documentation at: -- cgit v1.2.3 From e48081e7b88ae9add3c08cb248a2d3f99f863bd1 Mon Sep 17 00:00:00 2001 From: Joshua Powers Date: Wed, 11 Dec 2019 14:28:49 -0800 Subject: docs: add cloud-init-per manpage --- doc/man/cloud-init-per.1 | 45 +++++++++++++++++++++++++++++++++++++++++++++ 1 file changed, 45 insertions(+) create mode 100644 doc/man/cloud-init-per.1 (limited to 'doc/man') diff --git a/doc/man/cloud-init-per.1 b/doc/man/cloud-init-per.1 new file mode 100644 index 00000000..3668232e --- /dev/null +++ b/doc/man/cloud-init-per.1 @@ -0,0 +1,45 @@ +.TH CLOUD-INIT-PER 1 + +.SH NAME +cloud-init-per \- Run a command with arguments at a specific frequency + +.SH SYNOPSIS +.BR "cloud-init-per" " [ arg1 [ arg2 [...]]]" + +.SH DESCRIPTION +Run a command with arguments at a specific frequency. + +This utility can make it easier to use boothooks or bootcmd on a per +"once" or "always" basis. For example: + + - [ cloud-init-per, once, mymkfs, mkfs, /dev/vdb ] + +The cloud-init-per command replaced the cloud-init-run-module command. + +.SH OPTIONS +.TP +.B "frequency" +This can be one of the following values: + +.BR "once" ":" +run only once and do not re-run for new instance-id + +.BR "instance" ":" +run only the first boot for a given instance-id + +.BR "always" ":" +run every boot + +.TP +.B "name" +A name to give the command to run to show up in logs. + +.TP +.B "cmd [ arg1 [ arg2 [...]]]" +The actual command to run followed by any additional arguments. + +.SH COPYRIGHT +Copyright (C) 2020 Canonical Ltd. License GPL-3 or Apache-2.0 + +.SH SEE ALSO +Full documentation at: -- cgit v1.2.3 From 37ffa8d2bf1d56769a40fea26228b82e33ab1fff Mon Sep 17 00:00:00 2001 From: Joshua Powers Date: Wed, 11 Dec 2019 14:30:52 -0800 Subject: docs: add cloud-id manpage --- doc/man/cloud-id.1 | 31 +++++++++++++++++++++++++++++++ 1 file changed, 31 insertions(+) create mode 100644 doc/man/cloud-id.1 (limited to 'doc/man') diff --git a/doc/man/cloud-id.1 b/doc/man/cloud-id.1 new file mode 100644 index 00000000..98ce130c --- /dev/null +++ b/doc/man/cloud-id.1 @@ -0,0 +1,31 @@ +.TH CLOUD-ID 1 + +.SH NAME +cloud-id \- Report the canonical cloud-id for this instance + +.SH SYNOPSIS +.BR "cloud-id" " [-h] [-j] [-l] [-i ]" + +.SH OPTIONS +.TP +.B "-h, --help" +Show help message and exit + +.TP +.B "-j, --json" +Report all standardized cloud-id information as json + +.TP +.B "-l, --long" +Report extended cloud-id information as tab-delimited string + +.TP +.BR "-i , --instance-data " +Path to instance-data.json file. Default is +/run/cloud-init/instance-data.json + +.SH COPYRIGHT +Copyright (C) 2020 Canonical Ltd. License GPL-3 or Apache-2.0 + +.SH SEE ALSO +Full documentation at: -- cgit v1.2.3