Skip to content
Open
Show file tree
Hide file tree
Changes from 3 commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
70 changes: 56 additions & 14 deletions src/cli/README.md
Original file line number Diff line number Diff line change
@@ -1,61 +1,103 @@
# Virtualization

Subcommand for the command line client for Deckhouse.
Manages virtual machine-related operations in your Kubernetes cluster.

### Available Commands:
* console - Connect to a console of a virtual machine.
* port-forward - Forward local ports to a virtual machine
* scp - SCP files from/to a virtual machine.
* ssh - Open an ssh connection to a virtual machine.
* vnc - Open a vnc connection to a virtual machine.
* start - Start a virtual machine.
* stop - Stop a virtual machine.
* restart - Restart a virtual machine.
* evict - Evict a virtual machine.
### Available Commands

| Command | Description |
|--------------------|------------------------------------------------------------------------|
| ansible-inventory | Generate ansible inventory from virtual machines |
| console | Connect to a console of a virtual machine. |
| port-forward | Forward local ports to a virtual machine. |
| scp | SCP files from/to a virtual machine. |
| ssh | Open an SSH connection to a virtual machine. |
| vnc | Open a VNC connection to a virtual machine. |
| start | Start a virtual machine. |
| stop | Stop a virtual machine. |
| restart | Restart a virtual machine. |
| evict | Evict a virtual machine. |

### Examples

#### ansible-inventory

```shell
# Get inventory (default: YAML format)
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
# Get inventory (default: YAML format)
# Get inventory for default namespace in YAML format

d8 virtualization ansible-inventory
d8 virtualization ansible-inventory --list

# Get host variables
d8 virtualization ansible-inventory --host myvm.mynamespace

# Specify namespace
d8 virtualization ansible-inventory -n mynamespace

# Specify output format (json, ini, yaml)
d8 virtualization ansible-inventory -o json
d8 virtualization ansible-inventory -o yaml
d8 virtualization ansible-inventory -o ini
```

#### console

```shell
d8 virtualization console myvm
d8 virtualization console myvm.mynamespace
```

#### port-forward

```shell
d8 virtualization port-forward myvm tcp/8080:8080
d8 virtualization port-forward --stdio=true myvm.mynamespace 22
```

#### scp

```shell
d8 virtualization scp myfile.bin user@myvm:myfile.bin
d8 virtualization scp user@myvm:myfile.bin ~/myfile.bin
```

#### ssh

```shell
d8 virtualization --identity-file=/path/to/ssh_key ssh [email protected]
d8 virtualization ssh --local-ssh=true --namespace=mynamespace --username=user myvm
```

#### vnc

```shell
d8 virtualization vnc myvm.mynamespace
d8 virtualization vnc myvm -n mynamespace
```

#### start

```shell
d8 virtualization start myvm.mynamespace --wait
d8 virtualization start myvm.mynamespace --wait
d8 virtualization start myvm -n mynamespace
```

#### stop

```shell
d8 virtualization stop myvm.mynamespace --force
d8 virtualization stop myvm -n mynamespace
d8 virtualization stop myvm.mynamespace --force
d8 virtualization stop myvm -n mynamespace
```

#### restart

```shell
d8 virtualization restart myvm.mynamespace --timeout=1m
d8 virtualization restart myvm -n mynamespace
```

#### evict

```shell
d8 virtualization evict myvm.mynamespace
d8 virtualization evict myvm -n mynamespace
```
```
Loading
Loading