Git-Mirrors/constellation
1
0
Fork 0
mirror of https://github.com/edgelesssys/constellation.git synced 2024-10-01 01:36:09 -04:00
Code Issues Packages Projects Releases Wiki Activity

docs: update cli reference

Browse Source
This commit is contained in:
derpsteb 2023-02-15 15:48:53 +00:00 committed by Thomas Tendyck
parent f757b5bf56
commit d0daf26da7
1 changed files with 9 additions and 9 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

18
docs/docs/reference/cli.md
View File

@ -21,9 +21,9 @@ Commands:
* [up](#constellation-mini-up): Create and initialize a new MiniConstellation cluster * [up](#constellation-mini-up): Create and initialize a new MiniConstellation cluster
* [down](#constellation-mini-down): Destroy a MiniConstellation cluster * [down](#constellation-mini-down): Destroy a MiniConstellation cluster
* [verify](#constellation-verify): Verify the confidential properties of a Constellation cluster * [verify](#constellation-verify): Verify the confidential properties of a Constellation cluster
* [upgrade](#constellation-upgrade): Find and execute upgrades to your Constellation cluster * [upgrade](#constellation-upgrade): Find and apply upgrades to your Constellation cluster
* [check](#constellation-upgrade-check): Check for possible upgrades * [check](#constellation-upgrade-check): Check for possible upgrades
* [execute](#constellation-upgrade-execute): Execute an upgrade of a Constellation cluster * [apply](#constellation-upgrade-apply): Apply an upgrade to a Constellation cluster
* [recover](#constellation-recover): Recover a completely stopped Constellation cluster * [recover](#constellation-recover): Recover a completely stopped Constellation cluster
* [terminate](#constellation-terminate): Terminate a Constellation cluster * [terminate](#constellation-terminate): Terminate a Constellation cluster
* [version](#constellation-version): Display version of this CLI * [version](#constellation-version): Display version of this CLI
@ -307,11 +307,11 @@ constellation verify [flags]
## constellation upgrade ## constellation upgrade
Find and execute upgrades to your Constellation cluster Find and apply upgrades to your Constellation cluster
### Synopsis ### Synopsis
Find and execute upgrades to your Constellation cluster. Find and apply upgrades to your Constellation cluster.
### Options ### Options
@ -356,22 +356,22 @@ constellation upgrade check [flags]
--force disable version compatibility checks - might result in corrupted clusters --force disable version compatibility checks - might result in corrupted clusters
``` ```
## constellation upgrade execute ## constellation upgrade apply
Execute an upgrade of a Constellation cluster Apply an upgrade to a Constellation cluster
### Synopsis ### Synopsis
Execute an upgrade of a Constellation cluster by applying the chosen configuration. Apply an upgrade to a Constellation cluster by applying the chosen configuration.
``` ```
constellation upgrade execute [flags] constellation upgrade apply [flags]
``` ```
### Options ### Options
``` ```
-h, --help help for execute -h, --help help for apply
-y, --yes run upgrades without further confirmation -y, --yes run upgrades without further confirmation
WARNING: might delete your resources in case you are using cert-manager in your cluster. Please read the docs. WARNING: might delete your resources in case you are using cert-manager in your cluster. Please read the docs.
``` ```