diff --git a/Makefile b/Makefile index e8dfaf184..9007cc3e5 100644 --- a/Makefile +++ b/Makefile @@ -230,7 +230,7 @@ clean-kbcli: ## Clean bin/kbcli*. rm -f bin/kbcli* .PHONY: kbcli-doc -kbcli-doc: build-kbcli-embed-chart ## generate CLI command reference manual. +kbcli-doc: ## generate CLI command reference manual. $(GO) run -tags $(BUILD_TAGS) ./hack/docgen/cli/main.go ./docs/user_docs/cli diff --git a/docs/user_docs/cli/cli.md b/docs/user_docs/cli/cli.md index 89d4a61a3..eac91da81 100644 --- a/docs/user_docs/cli/cli.md +++ b/docs/user_docs/cli/cli.md @@ -4,6 +4,21 @@ description: KubeBlocks CLI overview sidebar_position: 1 --- +## [addon](kbcli_addon.md) + +Addon command. + +* [kbcli addon describe](kbcli_addon_describe.md) - Describe an addon specification. +* [kbcli addon disable](kbcli_addon_disable.md) - Disable an addon. +* [kbcli addon enable](kbcli_addon_enable.md) - Enable an addon. +* [kbcli addon index](kbcli_addon_index.md) - Manage custom addon indexes +* [kbcli addon install](kbcli_addon_install.md) - install KubeBlocks addon +* [kbcli addon list](kbcli_addon_list.md) - List addons. +* [kbcli addon search](kbcli_addon_search.md) - search the addon from index +* [kbcli addon uninstall](kbcli_addon_uninstall.md) - uninstall an existed addon +* [kbcli addon upgrade](kbcli_addon_upgrade.md) - Upgrade an existed addon to latest version or a specified version + + ## [alert](kbcli_alert.md) Manage alert receiver, include add, list and delete receiver. diff --git a/docs/user_docs/cli/kbcli.md b/docs/user_docs/cli/kbcli.md index 382fd7bb0..98d199fa5 100644 --- a/docs/user_docs/cli/kbcli.md +++ b/docs/user_docs/cli/kbcli.md @@ -54,6 +54,7 @@ kbcli [flags] ### SEE ALSO +* [kbcli addon](kbcli_addon.md) - Addon command. * [kbcli alert](kbcli_alert.md) - Manage alert receiver, include add, list and delete receiver. * [kbcli backuprepo](kbcli_backuprepo.md) - BackupRepo command. * [kbcli bench](kbcli_bench.md) - Run a benchmark. diff --git a/pkg/cmd/cli.go b/pkg/cmd/cli.go index 8ad6d23e4..7c706aef1 100644 --- a/pkg/cmd/cli.go +++ b/pkg/cmd/cli.go @@ -37,6 +37,7 @@ import ( viper "github.com/apecloud/kubeblocks/pkg/viperx" + "github.com/apecloud/kbcli/pkg/cmd/addon" "github.com/apecloud/kbcli/pkg/cmd/alert" "github.com/apecloud/kbcli/pkg/cmd/auth" "github.com/apecloud/kbcli/pkg/cmd/backuprepo" @@ -204,6 +205,7 @@ A Command Line Interface for KubeBlocks`, clusterdefinition.NewClusterDefinitionCmd(f, ioStreams), class.NewClassCommand(f, ioStreams), alert.NewAlertCmd(f, ioStreams), + addon.NewAddonCmd(f, ioStreams), migration.NewMigrationCmd(f, ioStreams), plugin.NewPluginCmd(ioStreams), fault.NewFaultCmd(f, ioStreams),