From fba697144db2cb5e55c491265359e55824f9bbda Mon Sep 17 00:00:00 2001 From: "github-actions[bot]" <41898282+github-actions[bot]@users.noreply.github.com> Date: Mon, 12 Sep 2022 13:39:56 +0200 Subject: [PATCH] Update CLI reference (#126) * CLI reference was updated by edgelesssys/constellation@d83a5f86 * CLI reference was updated by edgelesssys/constellation@4b36d3a9 Co-authored-by: thomasten --- docs/docs/reference/cli.md | 155 ++++++++++++++++++------------------- 1 file changed, 77 insertions(+), 78 deletions(-) diff --git a/docs/docs/reference/cli.md b/docs/docs/reference/cli.md index df204bec2..59b9c0afd 100644 --- a/docs/docs/reference/cli.md +++ b/docs/docs/reference/cli.md @@ -14,15 +14,15 @@ Commands: * [config](#constellation-config): Work with the Constellation configuration file * [generate](#constellation-config-generate): Generate a default configuration file * [fetch-measurements](#constellation-config-fetch-measurements): Fetch measurements for configured cloud provider and image - * [instance-types](#constellation-config-instance-types): Prints the supported instance types for all cloud providers + * [instance-types](#constellation-config-instance-types): Print the supported instance types for all cloud providers * [create](#constellation-create): Create instances on a cloud platform for your Constellation cluster * [init](#constellation-init): Initialize the Constellation cluster * [verify](#constellation-verify): Verify the confidential properties of a Constellation cluster +* [upgrade](#constellation-upgrade): Plan and perform an upgrade of a Constellation cluster + * [plan](#constellation-upgrade-plan): Plan an upgrade of a Constellation cluster + * [execute](#constellation-upgrade-execute): Execute an upgrade of a Constellation cluster * [recover](#constellation-recover): Recover a completely stopped Constellation cluster * [terminate](#constellation-terminate): Terminate a Constellation cluster -* [upgrade](#constellation-upgrade): Plan and perform an upgrade of a Constellation cluster - * [execute](#constellation-upgrade-execute): Execute an upgrade of a Constellation cluster - * [plan](#constellation-upgrade-plan): Plan an upgrade of a Constellation cluster * [version](#constellation-version): Display version of this CLI ## constellation config @@ -31,7 +31,7 @@ Work with the Constellation configuration file ### Synopsis -Generate a configuration file for Constellation. +Work with the Constellation configuration file. ### Options @@ -98,11 +98,11 @@ constellation config fetch-measurements [flags] ## constellation config instance-types -Prints the supported instance types for all cloud providers +Print the supported instance types for all cloud providers ### Synopsis -Prints the supported instance types for all cloud providers. +Print the supported instance types for all cloud providers. ``` constellation config instance-types [flags] @@ -192,10 +192,78 @@ constellation verify [flags] ### Options ``` - --cluster-id string verify using Constellation's cluster identifier + --cluster-id string expected cluster identifier -h, --help help for verify -e, --node-endpoint string endpoint of the node to verify, passed as HOST[:PORT] - --owner-id string verify using the owner identity derived from the master secret +``` + +### Options inherited from parent commands + +``` + --config string path to the configuration file (default "constellation-conf.yaml") +``` + +## constellation upgrade + +Plan and perform an upgrade of a Constellation cluster + +### Synopsis + +Plan and perform an upgrade of a Constellation cluster. + +### Options + +``` + -h, --help help for upgrade +``` + +### Options inherited from parent commands + +``` + --config string path to the configuration file (default "constellation-conf.yaml") +``` + +## constellation upgrade plan + +Plan an upgrade of a Constellation cluster + +### Synopsis + +Plan an upgrade of a Constellation cluster by fetching compatible image versions and their measurements. + +``` +constellation upgrade plan [flags] +``` + +### Options + +``` + -f, --file string path to output file, or '-' for stdout (omit for interactive mode) + -h, --help help for plan +``` + +### Options inherited from parent commands + +``` + --config string path to the configuration file (default "constellation-conf.yaml") +``` + +## constellation upgrade execute + +Execute an upgrade of a Constellation cluster + +### Synopsis + +Execute an upgrade of a Constellation cluster by applying the chosen configuration. + +``` +constellation upgrade execute [flags] +``` + +### Options + +``` + -h, --help help for execute ``` ### Options inherited from parent commands @@ -255,75 +323,6 @@ constellation terminate [flags] --config string path to the configuration file (default "constellation-conf.yaml") ``` -## constellation upgrade - -Plan and perform an upgrade of a Constellation cluster - -### Synopsis - -Plan and perform an upgrade of a Constellation cluster. - -### Options - -``` - -h, --help help for upgrade -``` - -### Options inherited from parent commands - -``` - --config string path to the configuration file (default "constellation-conf.yaml") -``` - -## constellation upgrade execute - -Execute an upgrade of a Constellation cluster - -### Synopsis - -Execute an upgrade of a Constellation cluster by applying the chosen configuration. - -``` -constellation upgrade execute [flags] -``` - -### Options - -``` - -h, --help help for execute -``` - -### Options inherited from parent commands - -``` - --config string path to the configuration file (default "constellation-conf.yaml") -``` - -## constellation upgrade plan - -Plan an upgrade of a Constellation cluster - -### Synopsis - -Plan an upgrade of a Constellation cluster by fetching compatible image versions and their measurements. - -``` -constellation upgrade plan [flags] -``` - -### Options - -``` - -f, --file string path to output file, or '-' for stdout, leave empty for interactive mode - -h, --help help for plan -``` - -### Options inherited from parent commands - -``` - --config string path to the configuration file (default "constellation-conf.yaml") -``` - ## constellation version Display version of this CLI