Skip to content

Commit

Permalink
chore: regenerate cli docs
Browse files Browse the repository at this point in the history
  • Loading branch information
pascalbreuninger committed Oct 3, 2023
1 parent fe30bf1 commit 90b9a9d
Show file tree
Hide file tree
Showing 42 changed files with 1,993 additions and 147 deletions.
11 changes: 6 additions & 5 deletions docs/pages/cli.md
Original file line number Diff line number Diff line change
Expand Up @@ -14,11 +14,12 @@ vcluster root command
### Options

```
--context string The kubernetes config context to use
--debug Prints the stack trace if an error occurs
-h, --help help for vcluster
-n, --namespace string The kubernetes namespace to use
-s, --silent Run in silent mode and prevents any vcluster log output except panics & fatals
--context string The kubernetes config context to use
--debug Prints the stack trace if an error occurs
-h, --help help for vcluster
--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
```

```
Expand Down
10 changes: 6 additions & 4 deletions docs/pages/cli/vcluster_connect.md
Original file line number Diff line number Diff line change
Expand Up @@ -41,6 +41,7 @@ vcluster connect test -n test -- kubectl get ns
--local-port int The local port to forward the virtual cluster to. If empty, vcluster will use a random unused port
--pod string The pod to connect to
--print When enabled prints the context to stdout
--project string [PRO] The pro project the vcluster is in
--server string The server to connect to
--service-account string If specified, vcluster will create a service account token to connect to the virtual cluster instead of using the default client cert / key. Service account must exist and can be used as namespace/name.
--token-expiration int If specified, vcluster will create the service account token for the given duration in seconds. Defaults to eternal
Expand All @@ -51,9 +52,10 @@ vcluster connect test -n test -- kubectl get ns
## Global & Inherited Flags

```
--context string The kubernetes config context to use
--debug Prints the stack trace if an error occurs
-n, --namespace string The kubernetes namespace to use
-s, --silent Run in silent mode and prevents any vcluster log output except panics & fatals
--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
```

27 changes: 16 additions & 11 deletions docs/pages/cli/vcluster_create.md
Original file line number Diff line number Diff line change
Expand Up @@ -31,32 +31,37 @@ vcluster create test --namespace test
--chart-name string The virtual cluster chart name to use (default "vcluster")
--chart-repo string The virtual cluster chart repo to use (default "https://charts.loft.sh")
--chart-version string The virtual cluster chart version to use (e.g. v0.9.1)
--cluster string [PRO] The vCluster.Pro connected cluster to use
--connect If true will run vcluster connect directly after the vcluster was created (default true)
--create-cluster-role DEPRECATED: cluster role is now automatically created if it is required by one of the resource syncers that are enabled by the .sync.RESOURCE.enabled=true helm value, which is set in a file that is passed via --extra-values argument.
--create-namespace If true the namespace will be created if it does not exist (default true)
--disable-ingress-sync If true the virtual cluster will not sync any ingresses
--disable-pro If true vcluster will not try to create a vCluster.Pro. You can also use 'vcluster logout' to prevent vCluster from creating any pro clusters
--distro string Kubernetes distro to use for the virtual cluster. Allowed distros: k3s, k0s, k8s, eks (default "k3s")
--expose If true will create a load balancer service to expose the vcluster endpoint
--expose-local If true and a local Kubernetes distro is detected, will deploy vcluster with a NodePort service. Will be set to false and the passed value will be ignored if --expose is set to true. (default true)
-f, --extra-values strings Path where to load extra helm values from
--extra-values strings DEPRECATED: use --values instead
-h, --help help for create
--isolate If true vcluster and its workloads will run in an isolated environment
--k3s-image string DEPRECATED: use --extra-values instead
--kube-config-context-name string If set, will override the context name of the generated virtual cluster kube config with this name
--kubernetes-version string The kubernetes version to use (e.g. v1.20). Patch versions are not supported
--local-chart-dir string The virtual cluster local chart dir to use
--release-values string DEPRECATED: use --extra-values instead
--link stringArray [PRO] A link to add to the vCluster. E.g. --link 'prod=http://exampleprod.com'
--params string [PRO] If a template is used, this can be used to use a file for the parameters. E.g. --params path/to/my/file.yaml
--project string [PRO] The vCluster.Pro project to use
--set stringArray Set values for helm. E.g. --set 'persistence.enabled=true'
--set-param stringArray [PRO] If a template is used, this can be used to set a specific parameter. E.g. --set-param 'my-param=my-value'
--template string [PRO] The vCluster.Pro template to use
--template-version string [PRO] The vCluster.Pro template version to use
--update-current If true updates the current kube config (default true)
--upgrade If true will try to upgrade the vcluster instead of failing if it already exists
-f, --values stringArray Path where to load extra helm values from
```


## Global & Inherited Flags

```
--context string The kubernetes config context to use
--debug Prints the stack trace if an error occurs
-n, --namespace string The kubernetes namespace to use
-s, --silent Run in silent mode and prevents any vcluster log output except panics & fatals
--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
```

11 changes: 7 additions & 4 deletions docs/pages/cli/vcluster_delete.md
Original file line number Diff line number Diff line change
Expand Up @@ -32,15 +32,18 @@ vcluster delete test --namespace test
--delete-namespace If enabled, vcluster will delete the namespace of the vcluster. In the case of multi-namespace mode, will also delete all other namespaces created by vcluster
-h, --help help for delete
--keep-pvc If enabled, vcluster will not delete the persistent volume claim of the vcluster
--project string [PRO] The pro project the vcluster is in
--wait If enabled, vcluster will wait until the vcluster is deleted (default true)
```


## Global & Inherited Flags

```
--context string The kubernetes config context to use
--debug Prints the stack trace if an error occurs
-n, --namespace string The kubernetes namespace to use
-s, --silent Run in silent mode and prevents any vcluster log output except panics & fatals
--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
```

9 changes: 5 additions & 4 deletions docs/pages/cli/vcluster_disconnect.md
Original file line number Diff line number Diff line change
Expand Up @@ -37,9 +37,10 @@ vcluster disconnect
## Global & Inherited Flags

```
--context string The kubernetes config context to use
--debug Prints the stack trace if an error occurs
-n, --namespace string The kubernetes namespace to use
-s, --silent Run in silent mode and prevents any vcluster log output except panics & fatals
--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
```

9 changes: 5 additions & 4 deletions docs/pages/cli/vcluster_get.md
Original file line number Diff line number Diff line change
Expand Up @@ -26,9 +26,10 @@ Gets cluster related information
## Global & Inherited Flags

```
--context string The kubernetes config context to use
--debug Prints the stack trace if an error occurs
-n, --namespace string The kubernetes namespace to use
-s, --silent Run in silent mode and prevents any vcluster log output except panics & fatals
--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
```

11 changes: 6 additions & 5 deletions docs/pages/cli/vcluster_get_service-cidr.md
Original file line number Diff line number Diff line change
Expand Up @@ -19,7 +19,7 @@ vcluster get service-cidr [flags]
#######################################################
Prints Service CIDR of the cluster
Ex:
Ex:
vcluster get service-cidr
10.96.0.0/12
#######################################################
Expand All @@ -36,9 +36,10 @@ vcluster get service-cidr
## Global & Inherited Flags

```
--context string The kubernetes config context to use
--debug Prints the stack trace if an error occurs
-n, --namespace string The kubernetes namespace to use
-s, --silent Run in silent mode and prevents any vcluster log output except panics & fatals
--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
```

48 changes: 48 additions & 0 deletions docs/pages/cli/vcluster_import.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,48 @@
---
title: "vcluster import --help"
sidebar_label: vcluster import
---


Imports a vcluster into a vCluster.Pro project

## Synopsis

```
vcluster import VCLUSTER_NAME [flags]
```

```
########################################################
################### vcluster import ####################
########################################################
Imports a vcluster into a vCluster.Pro project.
Example:
vcluster import my-vcluster --cluster connected-cluster \
--namespace vcluster-my-vcluster --project my-project --importname my-vcluster
#######################################################
```


## Flags

```
--cluster string Cluster name of the cluster the virtual cluster is running on
--disable-upgrade If true, will disable auto-upgrade of the imported vcluster to vCluster.Pro
-h, --help help for import
--importname string The name of the vcluster under projects. If unspecified, will use the vcluster name
--project string The project to import the vcluster into
```


## 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
```

9 changes: 5 additions & 4 deletions docs/pages/cli/vcluster_list.md
Original file line number Diff line number Diff line change
Expand Up @@ -38,9 +38,10 @@ vcluster list --namespace test
## Global & Inherited Flags

```
--context string The kubernetes config context to use
--debug Prints the stack trace if an error occurs
-n, --namespace string The kubernetes namespace to use
-s, --silent Run in silent mode and prevents any vcluster log output except panics & fatals
--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
```

47 changes: 47 additions & 0 deletions docs/pages/cli/vcluster_login.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,47 @@
---
title: "vcluster login --help"
sidebar_label: vcluster login
---


Login to a vCluster.Pro instance

## Synopsis

```
vcluster login [VCLUSTER_PRO_HOST] [flags]
```

```
########################################################
#################### vcluster login ####################
########################################################
Login into vCluster.Pro
Example:
vcluster login https://my-vcluster-pro.com
vcluster login https://my-vcluster-pro.com --access-key myaccesskey
########################################################
```


## Flags

```
--access-key string The access key to use
--docker-login If true, will log into the docker image registries the user has image pull secrets for (default true)
-h, --help help for login
--insecure Allow login into an insecure Loft instance (default true)
```


## 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
```

43 changes: 43 additions & 0 deletions docs/pages/cli/vcluster_logout.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,43 @@
---
title: "vcluster logout --help"
sidebar_label: vcluster logout
---


Log out of a vCluster.Pro instance

## Synopsis

```
vcluster logout [flags]
```

```
########################################################
################### vcluster logout ####################
########################################################
Log out of vCluster.Pro
Example:
vcluster logout
########################################################
```


## Flags

```
-h, --help help for logout
```


## 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
```

15 changes: 9 additions & 6 deletions docs/pages/cli/vcluster_pause.md
Original file line number Diff line number Diff line change
Expand Up @@ -22,7 +22,7 @@ computing resources.
Pause will scale down the virtual cluster and delete
all workloads created through the virtual cluster. Upon resume,
all workloads will be recreated. Other resources such
all workloads will be recreated. Other resources such
as persistent volume claims, services etc. will not be affected.
Example:
Expand All @@ -34,16 +34,19 @@ vcluster pause test --namespace test
## Flags

```
-h, --help help for pause
-h, --help help for pause
--prevent-wakeup vcluster resume vcluster [PRO] The amount of seconds this vcluster should sleep until it can be woken up again (use 0 for infinite sleeping). During this time the space can only be woken up by vcluster resume vcluster, manually deleting the annotation on the namespace or through the loft UI (default -1)
--project string [PRO] The pro project the vcluster is in
```


## Global & Inherited Flags

```
--context string The kubernetes config context to use
--debug Prints the stack trace if an error occurs
-n, --namespace string The kubernetes namespace to use
-s, --silent Run in silent mode and prevents any vcluster log output except panics & fatals
--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
```

9 changes: 5 additions & 4 deletions docs/pages/cli/vcluster_pro.md
Original file line number Diff line number Diff line change
Expand Up @@ -30,9 +30,10 @@ vCluster.Pro subcommands
## Global & Inherited Flags

```
--context string The kubernetes config context to use
--debug Prints the stack trace if an error occurs
-n, --namespace string The kubernetes namespace to use
-s, --silent Run in silent mode and prevents any vcluster log output except panics & fatals
--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
```

Loading

0 comments on commit 90b9a9d

Please sign in to comment.