Skip to content

Commit

Permalink
Merge pull request #1631 from heiko-braun/cli_docs_update_2
Browse files Browse the repository at this point in the history
Files missing from CLI docs regen
  • Loading branch information
FabianKramm authored Mar 27, 2024
2 parents 511c047 + d7c6913 commit 2f415cb
Show file tree
Hide file tree
Showing 3 changed files with 143 additions and 0 deletions.
39 changes: 39 additions & 0 deletions docs/pages/cli/vcluster_pro_connect.md
Original file line number Diff line number Diff line change
@@ -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
```

51 changes: 51 additions & 0 deletions docs/pages/cli/vcluster_pro_connect_cluster.md
Original file line number Diff line number Diff line change
@@ -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
```

53 changes: 53 additions & 0 deletions docs/pages/cli/vcluster_pro_token.md
Original file line number Diff line number Diff line change
@@ -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
```

0 comments on commit 2f415cb

Please sign in to comment.