From ff25593f7efc3bf5029df0034f5fcb79d2410dcf Mon Sep 17 00:00:00 2001 From: "github-actions[bot]" <41898282+github-actions[bot]@users.noreply.github.com> Date: Fri, 7 Oct 2022 09:44:41 +0200 Subject: [PATCH] CLI reference was updated by edgelesssys/constellation@0edae36e (#220) Co-authored-by: daniel-weisse --- docs/docs/reference/cli.md | 73 ++++++++++++++++++++++++++++++++++++++ 1 file changed, 73 insertions(+) diff --git a/docs/docs/reference/cli.md b/docs/docs/reference/cli.md index e8451ef3b..69914a902 100644 --- a/docs/docs/reference/cli.md +++ b/docs/docs/reference/cli.md @@ -17,6 +17,9 @@ Commands: * [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 +* [mini](#constellation-mini): Manage mini Constellation clusters + * [up](#constellation-mini-up): Create and initialize a new mini Constellation cluster + * [down](#constellation-mini-down): Destroy a mini 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 @@ -175,6 +178,76 @@ constellation init [flags] --config string path to the configuration file (default "constellation-conf.yaml") ``` +## constellation mini + +Manage mini Constellation clusters + +### Synopsis + +Manage mini Constellation clusters. + +### Options + +``` + -h, --help help for mini +``` + +### Options inherited from parent commands + +``` + --config string path to the configuration file (default "constellation-conf.yaml") +``` + +## constellation mini up + +Create and initialize a new mini Constellation cluster + +### Synopsis + +Create and initialize a new mini Constellation cluster. +A mini cluster consists of a single control-plane and worker node, hosted using QEMU/KVM. + + +``` +constellation mini up [flags] +``` + +### Options + +``` + -h, --help help for up +``` + +### Options inherited from parent commands + +``` + --config string path to the configuration file (default "constellation-conf.yaml") +``` + +## constellation mini down + +Destroy a mini Constellation cluster + +### Synopsis + +Destroy a mini Constellation cluster. + +``` +constellation mini down [flags] +``` + +### Options + +``` + -h, --help help for down +``` + +### Options inherited from parent commands + +``` + --config string path to the configuration file (default "constellation-conf.yaml") +``` + ## constellation verify Verify the confidential properties of a Constellation cluster