From a764fbbcc90ee6cc3003e7ccef5d47ff42876c7e Mon Sep 17 00:00:00 2001 From: Suraj Deshmukh Date: Tue, 7 Apr 2020 14:49:37 +0530 Subject: [PATCH] docs: Add `lokoctl component delete` Signed-off-by: Suraj Deshmukh --- docs/cli/lokoctl_component.md | 1 + docs/cli/lokoctl_component_delete.md | 32 ++++++++++++++++++++++++++++ 2 files changed, 33 insertions(+) create mode 100644 docs/cli/lokoctl_component_delete.md diff --git a/docs/cli/lokoctl_component.md b/docs/cli/lokoctl_component.md index fb81f4a67..9447cf9b3 100644 --- a/docs/cli/lokoctl_component.md +++ b/docs/cli/lokoctl_component.md @@ -24,6 +24,7 @@ Manage components * [lokoctl](lokoctl.md) - Manage Lokomotive clusters * [lokoctl component apply](lokoctl_component_apply.md) - Deploy or update a component +* [lokoctl component delete](lokoctl_component_delete.md) - Delete an installed component * [lokoctl component list](lokoctl_component_list.md) - List all available components * [lokoctl component render-manifest](lokoctl_component_render-manifest.md) - Print the manifests for a component diff --git a/docs/cli/lokoctl_component_delete.md b/docs/cli/lokoctl_component_delete.md new file mode 100644 index 000000000..c24c7765c --- /dev/null +++ b/docs/cli/lokoctl_component_delete.md @@ -0,0 +1,32 @@ +## lokoctl component delete + +Delete an installed component + +### Synopsis + +Delete a component. +When run with no arguments, all components listed in the configuration are deleted. + +``` +lokoctl component delete [flags] +``` + +### Options + +``` + --delete-namespace Delete namespace with component. + -h, --help help for delete +``` + +### Options inherited from parent commands + +``` + --kubeconfig string Path to kubeconfig file, taken from the asset dir if not given, and finally falls back to ~/.kube/config + --lokocfg string Path to lokocfg directory or file (default "./") + --lokocfg-vars string Path to lokocfg.vars file (default "./lokocfg.vars") +``` + +### SEE ALSO + +* [lokoctl component](lokoctl_component.md) - Manage components +