From d7c69138e019e854e903d4cdd50aa0ddf3199d0e Mon Sep 17 00:00:00 2001 From: heiko-braun Date: Wed, 27 Mar 2024 18:30:59 +0100 Subject: [PATCH] Files missing from CLI docs regen --- docs/pages/cli/vcluster_pro_connect.md | 39 ++++++++++++++ .../pages/cli/vcluster_pro_connect_cluster.md | 51 ++++++++++++++++++ docs/pages/cli/vcluster_pro_token.md | 53 +++++++++++++++++++ 3 files changed, 143 insertions(+) create mode 100644 docs/pages/cli/vcluster_pro_connect.md create mode 100644 docs/pages/cli/vcluster_pro_connect_cluster.md create mode 100644 docs/pages/cli/vcluster_pro_token.md diff --git a/docs/pages/cli/vcluster_pro_connect.md b/docs/pages/cli/vcluster_pro_connect.md new file mode 100644 index 000000000..059c9d025 --- /dev/null +++ b/docs/pages/cli/vcluster_pro_connect.md @@ -0,0 +1,39 @@ +--- +title: "vcluster pro connect --help" +sidebar_label: vcluster pro connect +sidebar_class_name: "pro-feature-sidebar-item" +--- + +:::info Note: +`vcluster pro connect` is only available in the enterprise-ready [vCluster.Pro](https://vcluster.pro) offering. +::: + + +Connects a cluster to vCluster.Pro + +## Synopsis + +``` +####################################################### +################ vcluster pro connect ################# +####################################################### +``` + + +## Flags + +``` + -h, --help help for connect +``` + + +## Global & Inherited Flags + +``` + --context string The kubernetes config context to use + --debug Prints the stack trace if an error occurs + --log-output string The log format to use. Can be either plain, raw or json (default "plain") + -n, --namespace string The kubernetes namespace to use + -s, --silent Run in silent mode and prevents any vcluster log output except panics & fatals +``` + diff --git a/docs/pages/cli/vcluster_pro_connect_cluster.md b/docs/pages/cli/vcluster_pro_connect_cluster.md new file mode 100644 index 000000000..dcc1b05fb --- /dev/null +++ b/docs/pages/cli/vcluster_pro_connect_cluster.md @@ -0,0 +1,51 @@ +--- +title: "vcluster pro connect cluster --help" +sidebar_label: vcluster pro connect cluster +sidebar_class_name: "pro-feature-sidebar-item" +--- + +:::info Note: +`vcluster pro connect cluster` is only available in the enterprise-ready [vCluster.Pro](https://vcluster.pro) offering. +::: + + +connect current cluster to vCluster.Pro + +## Synopsis + +``` +vcluster pro connect cluster [flags] +``` + +``` +####################################################### +############ vcluster pro connect cluster ############# +####################################################### +Connect a cluster to the vCluster.Pro instance. + +Example: +vcluster pro connect cluster my-cluster +######################################################## +``` + + +## Flags + +``` + --context string The kube context to use for installation + --display-name string The display name to show in the UI for this cluster + -h, --help help for cluster + --namespace string The namespace to generate the service account in. The namespace will be created if it does not exist (default "loft") + --service-account string The service account name to create (default "loft-admin") + --wait If true, will wait until the cluster is initialized +``` + + +## Global & Inherited Flags + +``` + --debug Prints the stack trace if an error occurs + --log-output string The log format to use. Can be either plain, raw or json (default "plain") + -s, --silent Run in silent mode and prevents any vcluster log output except panics & fatals +``` + diff --git a/docs/pages/cli/vcluster_pro_token.md b/docs/pages/cli/vcluster_pro_token.md new file mode 100644 index 000000000..8957fc2a5 --- /dev/null +++ b/docs/pages/cli/vcluster_pro_token.md @@ -0,0 +1,53 @@ +--- +title: "vcluster pro token --help" +sidebar_label: vcluster pro token +sidebar_class_name: "pro-feature-sidebar-item" +--- + +:::info Note: +`vcluster pro token` is only available in the enterprise-ready [vCluster.Pro](https://vcluster.pro) offering. +::: + + +Token prints the access token to a vCluster.Pro instance + +## Synopsis + +``` +vcluster pro token [flags] +``` + +``` +######################################################## +################## vcluster pro token ################## +######################################################## + +Prints an access token to a vCluster.Pro instance. This +can be used as an ExecAuthenticator for kubernetes + +Example: +vcluster pro token +######################################################## +``` + + +## Flags + +``` + --direct-cluster-endpoint When enabled prints a direct cluster endpoint token + -h, --help help for token + --project string The project containing the virtual cluster + --virtual-cluster string The virtual cluster +``` + + +## Global & Inherited Flags + +``` + --context string The kubernetes config context to use + --debug Prints the stack trace if an error occurs + --log-output string The log format to use. Can be either plain, raw or json (default "plain") + -n, --namespace string The kubernetes namespace to use + -s, --silent Run in silent mode and prevents any vcluster log output except panics & fatals +``` +