Skip to content

Commit

Permalink
doc: Update documentation
Browse files Browse the repository at this point in the history
- Added installation instructions.
- Added note into example-client documentation to remind
  the user that browser needs to trust the TLS certificate
  from the cluster.

Signed-off-by: Andrej Krejcir <[email protected]>
  • Loading branch information
akrejcir committed Mar 22, 2023
1 parent 4581286 commit 534baa4
Show file tree
Hide file tree
Showing 2 changed files with 17 additions and 1 deletion.
13 changes: 13 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,6 +4,19 @@ Proxy that provides access to the VNC console of a Kubevirt VM.

It can generate time limited tokens that are then used to access VNC.

## Installation

### Using SSP operator
The [SSP operator](https://github.com/kubevirt/ssp-operator) can be configured to install VM Console Proxy together with
a Route used to expose it to the outside.

### Without SSP operator
The VM Console Proxy needs to be deployed in the same namespace where Kubevirt is.
You can use these commands to deploy the latest version:
```bash
kubectl apply -n ${KUBEVIRT_NAMESPACE} -f "https://github.com/kubevirt/vm-console-proxy/releases/latest/download/vm-console-proxy.yaml"
```

## API
See the [API documentation](docs/api.md).

Expand Down
5 changes: 4 additions & 1 deletion example-client/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -17,4 +17,7 @@ The client page takes these URL parameters:
For example, the following URL will point the client to a VM after substituting variables:
```
http://localhost:8000/?host=vm-console-kubevirt.apps-crc.testing&namespace=${VM_NAMESPACE}&name=${VM_NAME}&token=${TOKEN}
```
```

**Note:** If the browser does not trust the TLS certificate from the cluster, only a generic
error message will be shown, that does not contain any reason for the failure.

0 comments on commit 534baa4

Please sign in to comment.