|
1 | 1 | # Virtualization |
| 2 | + |
2 | 3 | Subcommand for the command line client for Deckhouse. |
3 | 4 | Manages virtual machine-related operations in your Kubernetes cluster. |
4 | 5 |
|
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. | |
15 | 20 |
|
16 | 21 | ### 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 | + |
17 | 42 | #### console |
| 43 | + |
18 | 44 | ```shell |
19 | 45 | d8 virtualization console myvm |
20 | 46 | d8 virtualization console myvm.mynamespace |
21 | 47 | ``` |
| 48 | + |
22 | 49 | #### port-forward |
| 50 | + |
23 | 51 | ```shell |
24 | 52 | d8 virtualization port-forward myvm tcp/8080:8080 |
25 | 53 | d8 virtualization port-forward --stdio=true myvm.mynamespace 22 |
26 | 54 | ``` |
| 55 | + |
27 | 56 | #### scp |
| 57 | + |
28 | 58 | ```shell |
29 | 59 | d8 virtualization scp myfile.bin user@myvm:myfile.bin |
30 | 60 | d8 virtualization scp user@myvm:myfile.bin ~/myfile.bin |
31 | 61 | ``` |
| 62 | + |
32 | 63 | #### ssh |
| 64 | + |
33 | 65 | ```shell |
34 | 66 | d8 virtualization --identity-file=/path/to/ssh_key ssh [email protected] |
35 | 67 | d8 virtualization ssh --local-ssh=true --namespace=mynamespace --username=user myvm |
36 | 68 | ``` |
| 69 | + |
37 | 70 | #### vnc |
| 71 | + |
38 | 72 | ```shell |
39 | 73 | d8 virtualization vnc myvm.mynamespace |
40 | 74 | d8 virtualization vnc myvm -n mynamespace |
41 | 75 | ``` |
| 76 | + |
42 | 77 | #### start |
| 78 | + |
43 | 79 | ```shell |
44 | | -d8 virtualization start myvm.mynamespace --wait |
| 80 | +d8 virtualization start myvm.mynamespace --wait |
45 | 81 | d8 virtualization start myvm -n mynamespace |
46 | 82 | ``` |
| 83 | + |
47 | 84 | #### stop |
| 85 | + |
48 | 86 | ```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 |
51 | 89 | ``` |
| 90 | + |
52 | 91 | #### restart |
| 92 | + |
53 | 93 | ```shell |
54 | 94 | d8 virtualization restart myvm.mynamespace --timeout=1m |
55 | 95 | d8 virtualization restart myvm -n mynamespace |
56 | 96 | ``` |
| 97 | + |
57 | 98 | #### evict |
| 99 | + |
58 | 100 | ```shell |
59 | 101 | d8 virtualization evict myvm.mynamespace |
60 | 102 | d8 virtualization evict myvm -n mynamespace |
61 | | -``` |
| 103 | +``` |
0 commit comments