Skip to content

Commit 6ab55c5

Browse files
committed
add ns support
Signed-off-by: Pavel Tishkov <[email protected]>
1 parent 694cc69 commit 6ab55c5

File tree

2 files changed

+257
-45
lines changed

2 files changed

+257
-45
lines changed

src/cli/README.md

Lines changed: 56 additions & 14 deletions
Original file line numberDiff line numberDiff line change
@@ -1,61 +1,103 @@
11
# Virtualization
2+
23
Subcommand for the command line client for Deckhouse.
34
Manages virtual machine-related operations in your Kubernetes cluster.
45

5-
### Available Commands:
6-
* console - Connect to a console of a virtual machine.
7-
* port-forward - Forward local ports to a virtual machine
8-
* scp - SCP files from/to a virtual machine.
9-
* ssh - Open an ssh connection to a virtual machine.
10-
* vnc - Open a vnc connection to a virtual machine.
11-
* start - Start a virtual machine.
12-
* stop - Stop a virtual machine.
13-
* restart - Restart a virtual machine.
14-
* evict - Evict a virtual machine.
6+
### Available Commands
7+
8+
| Command | Description |
9+
|--------------------|------------------------------------------------------------------------|
10+
| ansible-inventory | Generate ansible inventory from virtual machines |
11+
| console | Connect to a console of a virtual machine. |
12+
| port-forward | Forward local ports to a virtual machine. |
13+
| scp | SCP files from/to a virtual machine. |
14+
| ssh | Open an SSH connection to a virtual machine. |
15+
| vnc | Open a VNC connection to a virtual machine. |
16+
| start | Start a virtual machine. |
17+
| stop | Stop a virtual machine. |
18+
| restart | Restart a virtual machine. |
19+
| evict | Evict a virtual machine. |
1520

1621
### Examples
22+
23+
#### ansible-inventory
24+
25+
```shell
26+
# Get inventory (default: YAML format)
27+
d8 virtualization ansible-inventory
28+
d8 virtualization ansible-inventory --list
29+
30+
# Get host variables
31+
d8 virtualization ansible-inventory --host myvm.mynamespace
32+
33+
# Specify namespace
34+
d8 virtualization ansible-inventory -n mynamespace
35+
36+
# Specify output format (json, ini, yaml)
37+
d8 virtualization ansible-inventory -o json
38+
d8 virtualization ansible-inventory -o yaml
39+
d8 virtualization ansible-inventory -o ini
40+
```
41+
1742
#### console
43+
1844
```shell
1945
d8 virtualization console myvm
2046
d8 virtualization console myvm.mynamespace
2147
```
48+
2249
#### port-forward
50+
2351
```shell
2452
d8 virtualization port-forward myvm tcp/8080:8080
2553
d8 virtualization port-forward --stdio=true myvm.mynamespace 22
2654
```
55+
2756
#### scp
57+
2858
```shell
2959
d8 virtualization scp myfile.bin user@myvm:myfile.bin
3060
d8 virtualization scp user@myvm:myfile.bin ~/myfile.bin
3161
```
62+
3263
#### ssh
64+
3365
```shell
3466
d8 virtualization --identity-file=/path/to/ssh_key ssh [email protected]
3567
d8 virtualization ssh --local-ssh=true --namespace=mynamespace --username=user myvm
3668
```
69+
3770
#### vnc
71+
3872
```shell
3973
d8 virtualization vnc myvm.mynamespace
4074
d8 virtualization vnc myvm -n mynamespace
4175
```
76+
4277
#### start
78+
4379
```shell
44-
d8 virtualization start myvm.mynamespace --wait
80+
d8 virtualization start myvm.mynamespace --wait
4581
d8 virtualization start myvm -n mynamespace
4682
```
83+
4784
#### stop
85+
4886
```shell
49-
d8 virtualization stop myvm.mynamespace --force
50-
d8 virtualization stop myvm -n mynamespace
87+
d8 virtualization stop myvm.mynamespace --force
88+
d8 virtualization stop myvm -n mynamespace
5189
```
90+
5291
#### restart
92+
5393
```shell
5494
d8 virtualization restart myvm.mynamespace --timeout=1m
5595
d8 virtualization restart myvm -n mynamespace
5696
```
97+
5798
#### evict
99+
58100
```shell
59101
d8 virtualization evict myvm.mynamespace
60102
d8 virtualization evict myvm -n mynamespace
61-
```
103+
```

0 commit comments

Comments
 (0)