Skip to content

Commit

Permalink
Add docs for virtletctl vnc
Browse files Browse the repository at this point in the history
  • Loading branch information
jellonek committed Mar 9, 2018
1 parent 2fe663b commit d863810
Show file tree
Hide file tree
Showing 2 changed files with 59 additions and 1 deletion.
3 changes: 2 additions & 1 deletion docs/virtletctl/virtletctl.md
Original file line number Diff line number Diff line change
Expand Up @@ -45,5 +45,6 @@ Kubernetes cluster.
* [virtletctl install](virtletctl_install.md) - Install virtletctl as a kubectl plugin
* [virtletctl ssh](virtletctl_ssh.md) - Connect to a VM pod using ssh
* [virtletctl virsh](virtletctl_virsh.md) - Execute a virsh command
* [virtletctl vnc](virtletctl_vnc.md) - Provide an access to a VM pod VNC console

###### Auto generated by spf13/cobra on 8-Mar-2018
###### Auto generated by spf13/cobra on 9-Mar-2018
57 changes: 57 additions & 0 deletions docs/virtletctl/virtletctl_vnc.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,57 @@
## virtletctl vnc

Provide an access to a VM pod VNC console

### Synopsis



This command prepares an access to a VM pod. If port is
provided port forwarding for VNC will try to use that one.
Otherwise the kernel will chose a random one which will
be displayed as a part of command output.


```
virtletctl vnc pod [port] [flags]
```

### Options

```
-h, --help help for vnc
```

### Options inherited from parent commands

```
--alsologtostderr log to standard error as well as files
--as string Username to impersonate for the operation
--as-group stringArray Group to impersonate for the operation, this flag can be repeated to specify multiple groups.
--certificate-authority string Path to a cert file for the certificate authority
--client-certificate string Path to a client certificate file for TLS
--client-key string Path to a client key file for TLS
--cluster string The name of the kubeconfig cluster to use
--context string The name of the kubeconfig context to use
--insecure-skip-tls-verify If true, the server's certificate will not be checked for validity. This will make your HTTPS connections insecure
--kubeconfig string Path to the kubeconfig file to use for CLI requests.
--log-backtrace-at traceLocation when logging hits line file:N, emit a stack trace (default :0)
--log-dir string If non-empty, write log files in this directory
--logtostderr log to standard error instead of files
-n, --namespace string If present, the namespace scope for this CLI request
--password string Password for basic authentication to the API server
--request-timeout string The length of time to wait before giving up on a single server request. Non-zero values should contain a corresponding time unit (e.g. 1s, 2m, 3h). A value of zero means don't timeout requests. (default "0")
-s, --server string The address and port of the Kubernetes API server
--stderrthreshold severity logs at or above this threshold go to stderr (default 2)
--token string Bearer token for authentication to the API server
--user string The name of the kubeconfig user to use
--username string Username for basic authentication to the API server
-v, --v Level log level for V logs
--virtlet-runtime string the name of virtlet runtime used in kubernetes.io/target-runtime annotation (default "virtlet.cloud")
--vmodule moduleSpec comma-separated list of pattern=N settings for file-filtered logging
```

### SEE ALSO
* [virtletctl](virtletctl.md) - Virtlet control tool

###### Auto generated by spf13/cobra on 9-Mar-2018

0 comments on commit d863810

Please sign in to comment.