diff options
| author | zdc <zdc@users.noreply.github.com> | 2022-03-26 15:41:59 +0200 |
|---|---|---|
| committer | GitHub <noreply@github.com> | 2022-03-26 15:41:59 +0200 |
| commit | aa60d48c2711cdcd9f88a4e5c77379adb0408231 (patch) | |
| tree | 349631a02467dae0158f6f663cc8aa8537974a97 /doc/man | |
| parent | 5c4b3943343a85fbe517e5ec1fc670b3a8566b4b (diff) | |
| parent | 31448cccedd8f841fb3ac7d0f2e3cdefe08a53ba (diff) | |
| download | vyos-cloud-init-aa60d48c2711cdcd9f88a4e5c77379adb0408231.tar.gz vyos-cloud-init-aa60d48c2711cdcd9f88a4e5c77379adb0408231.zip | |
Merge pull request #51 from zdc/T2117-sagitta-22.1
T2117: Cloud-init updated to 22.1
Diffstat (limited to 'doc/man')
| -rw-r--r-- | doc/man/cloud-id.1 | 25 | ||||
| -rw-r--r-- | doc/man/cloud-init.1 | 2 |
2 files changed, 25 insertions, 2 deletions
diff --git a/doc/man/cloud-id.1 b/doc/man/cloud-id.1 index 98ce130c..cb500189 100644 --- a/doc/man/cloud-id.1 +++ b/doc/man/cloud-id.1 @@ -6,6 +6,15 @@ cloud-id \- Report the canonical cloud-id for this instance .SH SYNOPSIS .BR "cloud-id" " [-h] [-j] [-l] [-i <INSTANCE_DATA>]" +.SH DESCRIPTION +cloud-id is the lowercase name of the cloud datasource discovered. + +The cloud-id will be 'not run' when systemd generator has not run yet. +The cloud-id will be 'disabled' when cloud-init is disabled or when +ds-identify did not find a valid datasource. + +See cloud-init status --long for more information. + .SH OPTIONS .TP .B "-h, --help" @@ -24,8 +33,22 @@ Report extended cloud-id information as tab-delimited string Path to instance-data.json file. Default is /run/cloud-init/instance-data.json +.SH EXIT STATUS +.TP +0 +On success +.TP +1 +Due to an error +.TP +2 +Due to cloud-init in a disabled state. See: cloud-init status --long +.TP +3 +The cloud-init generator and discovery has not yet run. + .SH COPYRIGHT -Copyright (C) 2020 Canonical Ltd. License GPL-3 or Apache-2.0 +Copyright (C) 2021 Canonical Ltd. License GPL-3 or Apache-2.0 .SH SEE ALSO Full documentation at: <https://cloudinit.readthedocs.io> diff --git a/doc/man/cloud-init.1 b/doc/man/cloud-init.1 index 9b52dc8d..3fde4148 100644 --- a/doc/man/cloud-init.1 +++ b/doc/man/cloud-init.1 @@ -10,7 +10,7 @@ cloud-init \- Cloud instance initialization 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. +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 |