annotate README.md @ 75:b4d2ef1897f9 default tip master

update README
author AnaTofuZ <anatofuz@gmail.com>
date Sun, 20 Dec 2020 23:04:41 +0900
parents 833d55f0b5bd
children
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
55
833d55f0b5bd add README.md
AnaTofuZ <anatofuz@gmail.com>
parents:
diff changeset
1 # ie-virsh
833d55f0b5bd add README.md
AnaTofuZ <anatofuz@gmail.com>
parents:
diff changeset
2
833d55f0b5bd add README.md
AnaTofuZ <anatofuz@gmail.com>
parents:
diff changeset
3 - `virsh`のwrapperコマンド
833d55f0b5bd add README.md
AnaTofuZ <anatofuz@gmail.com>
parents:
diff changeset
4
833d55f0b5bd add README.md
AnaTofuZ <anatofuz@gmail.com>
parents:
diff changeset
5
833d55f0b5bd add README.md
AnaTofuZ <anatofuz@gmail.com>
parents:
diff changeset
6 # help
833d55f0b5bd add README.md
AnaTofuZ <anatofuz@gmail.com>
parents:
diff changeset
7
833d55f0b5bd add README.md
AnaTofuZ <anatofuz@gmail.com>
parents:
diff changeset
8 ```shell
833d55f0b5bd add README.md
AnaTofuZ <anatofuz@gmail.com>
parents:
diff changeset
9 $ie-virsh
833d55f0b5bd add README.md
AnaTofuZ <anatofuz@gmail.com>
parents:
diff changeset
10 ie-virsh 1.0
833d55f0b5bd add README.md
AnaTofuZ <anatofuz@gmail.com>
parents:
diff changeset
11 AnaTofuZ <anatofuz@cr.ie.u-ryukyu.ac.jp>
833d55f0b5bd add README.md
AnaTofuZ <anatofuz@gmail.com>
parents:
diff changeset
12
833d55f0b5bd add README.md
AnaTofuZ <anatofuz@gmail.com>
parents:
diff changeset
13 USAGE:
833d55f0b5bd add README.md
AnaTofuZ <anatofuz@gmail.com>
parents:
diff changeset
14 ie-virsh <SUBCOMMAND>
833d55f0b5bd add README.md
AnaTofuZ <anatofuz@gmail.com>
parents:
diff changeset
15
833d55f0b5bd add README.md
AnaTofuZ <anatofuz@gmail.com>
parents:
diff changeset
16 FLAGS:
833d55f0b5bd add README.md
AnaTofuZ <anatofuz@gmail.com>
parents:
diff changeset
17 -h, --help Prints help information
833d55f0b5bd add README.md
AnaTofuZ <anatofuz@gmail.com>
parents:
diff changeset
18 -V, --version Prints version information
833d55f0b5bd add README.md
AnaTofuZ <anatofuz@gmail.com>
parents:
diff changeset
19
833d55f0b5bd add README.md
AnaTofuZ <anatofuz@gmail.com>
parents:
diff changeset
20 SUBCOMMANDS:
833d55f0b5bd add README.md
AnaTofuZ <anatofuz@gmail.com>
parents:
diff changeset
21 console connect to the guest console
833d55f0b5bd add README.md
AnaTofuZ <anatofuz@gmail.com>
parents:
diff changeset
22 define define (but don't start) a domain from an template XML file
833d55f0b5bd add README.md
AnaTofuZ <anatofuz@gmail.com>
parents:
diff changeset
23 define-gdb define the domain in which the gdb port is opened from the template XML file
833d55f0b5bd add README.md
AnaTofuZ <anatofuz@gmail.com>
parents:
diff changeset
24 destroy destroy (stop) a domain
833d55f0b5bd add README.md
AnaTofuZ <anatofuz@gmail.com>
parents:
diff changeset
25 domiflist list all domain virtual interfaces
833d55f0b5bd add README.md
AnaTofuZ <anatofuz@gmail.com>
parents:
diff changeset
26 dominfo domain information
833d55f0b5bd add README.md
AnaTofuZ <anatofuz@gmail.com>
parents:
diff changeset
27 dumpxml domain information in XML
833d55f0b5bd add README.md
AnaTofuZ <anatofuz@gmail.com>
parents:
diff changeset
28 help Prints this message or the help of the given subcommand(s)
833d55f0b5bd add README.md
AnaTofuZ <anatofuz@gmail.com>
parents:
diff changeset
29 list list domains
833d55f0b5bd add README.md
AnaTofuZ <anatofuz@gmail.com>
parents:
diff changeset
30 shutdown gracefully shutdown a domain
833d55f0b5bd add README.md
AnaTofuZ <anatofuz@gmail.com>
parents:
diff changeset
31 start start a (previously defined) inactive domain
833d55f0b5bd add README.md
AnaTofuZ <anatofuz@gmail.com>
parents:
diff changeset
32 ttyconsole tty console
833d55f0b5bd add README.md
AnaTofuZ <anatofuz@gmail.com>
parents:
diff changeset
33 undefine undefine a domain
833d55f0b5bd add README.md
AnaTofuZ <anatofuz@gmail.com>
parents:
diff changeset
34 vncdisplay vncdisplay
833d55f0b5bd add README.md
AnaTofuZ <anatofuz@gmail.com>
parents:
diff changeset
35 ```
833d55f0b5bd add README.md
AnaTofuZ <anatofuz@gmail.com>
parents:
diff changeset
36
833d55f0b5bd add README.md
AnaTofuZ <anatofuz@gmail.com>
parents:
diff changeset
37
833d55f0b5bd add README.md
AnaTofuZ <anatofuz@gmail.com>
parents:
diff changeset
38 # list
833d55f0b5bd add README.md
AnaTofuZ <anatofuz@gmail.com>
parents:
diff changeset
39
833d55f0b5bd add README.md
AnaTofuZ <anatofuz@gmail.com>
parents:
diff changeset
40 - 自分が作ったVMの状況が確認可能
833d55f0b5bd add README.md
AnaTofuZ <anatofuz@gmail.com>
parents:
diff changeset
41
833d55f0b5bd add README.md
AnaTofuZ <anatofuz@gmail.com>
parents:
diff changeset
42 # define
833d55f0b5bd add README.md
AnaTofuZ <anatofuz@gmail.com>
parents:
diff changeset
43
833d55f0b5bd add README.md
AnaTofuZ <anatofuz@gmail.com>
parents:
diff changeset
44 ## 通常の方法
833d55f0b5bd add README.md
AnaTofuZ <anatofuz@gmail.com>
parents:
diff changeset
45
833d55f0b5bd add README.md
AnaTofuZ <anatofuz@gmail.com>
parents:
diff changeset
46 - テンプレートxmlをもとにvmをdefineする
833d55f0b5bd add README.md
AnaTofuZ <anatofuz@gmail.com>
parents:
diff changeset
47 - 名前はなんでも良いが、prefixにlogin user nameが入る
833d55f0b5bd add README.md
AnaTofuZ <anatofuz@gmail.com>
parents:
diff changeset
48 - 例えば e155730 が `ie-virsh define anatofuz` とすると `e155730-anatofuz`というVMが作られる
833d55f0b5bd add README.md
AnaTofuZ <anatofuz@gmail.com>
parents:
diff changeset
49
75
b4d2ef1897f9 update README
AnaTofuZ <anatofuz@gmail.com>
parents: 55
diff changeset
50 ## gdbのポートを開ける
b4d2ef1897f9 update README
AnaTofuZ <anatofuz@gmail.com>
parents: 55
diff changeset
51 - linux kernelのデバッグをしたい際はgdb用のportをkvmレベルであける必要がある
b4d2ef1897f9 update README
AnaTofuZ <anatofuz@gmail.com>
parents: 55
diff changeset
52 - `$ie-virsh define --gdb vm_name`の様に`--gdb`オプションをつけるとportを開けてくれる
b4d2ef1897f9 update README
AnaTofuZ <anatofuz@gmail.com>
parents: 55
diff changeset
53 - あけたportはdefineしたタイミングで表示される
b4d2ef1897f9 update README
AnaTofuZ <anatofuz@gmail.com>
parents: 55
diff changeset
54
b4d2ef1897f9 update README
AnaTofuZ <anatofuz@gmail.com>
parents: 55
diff changeset
55
55
833d55f0b5bd add README.md
AnaTofuZ <anatofuz@gmail.com>
parents:
diff changeset
56 ## 差分生成
833d55f0b5bd add README.md
AnaTofuZ <anatofuz@gmail.com>
parents:
diff changeset
57
833d55f0b5bd add README.md
AnaTofuZ <anatofuz@gmail.com>
parents:
diff changeset
58 - qcow2もテンプレートから生成することが可能
833d55f0b5bd add README.md
AnaTofuZ <anatofuz@gmail.com>
parents:
diff changeset
59 - `$ie-virsh templates`でテンプレート一覧を確認する
833d55f0b5bd add README.md
AnaTofuZ <anatofuz@gmail.com>
parents:
diff changeset
60 - `$ie-virsh define ubuntu20 -t Ubuntu-20`の様に `-t`オプションの後ろにtemplateの名前を指定すると生成される
833d55f0b5bd add README.md
AnaTofuZ <anatofuz@gmail.com>
parents:
diff changeset
61 - `/ie-ryukyu/kvm/images/rental`にqcow2が生成される
833d55f0b5bd add README.md
AnaTofuZ <anatofuz@gmail.com>
parents:
diff changeset
62
833d55f0b5bd add README.md
AnaTofuZ <anatofuz@gmail.com>
parents:
diff changeset
63
833d55f0b5bd add README.md
AnaTofuZ <anatofuz@gmail.com>
parents:
diff changeset
64 # start, dumpxmlなど
833d55f0b5bd add README.md
AnaTofuZ <anatofuz@gmail.com>
parents:
diff changeset
65 - vm名を指定する必要があるが、wrapperなので全部打つ必要がないようにしている
833d55f0b5bd add README.md
AnaTofuZ <anatofuz@gmail.com>
parents:
diff changeset
66 - `e155730-anatofuz` の場合は `ie-virsh start anatofuz` でいい
833d55f0b5bd add README.md
AnaTofuZ <anatofuz@gmail.com>
parents:
diff changeset
67 - vm名をフルで打っても問題ない
833d55f0b5bd add README.md
AnaTofuZ <anatofuz@gmail.com>
parents:
diff changeset
68 - 起動しているvmに対しての操作はidを指定しても問題ないようになっている
833d55f0b5bd add README.md
AnaTofuZ <anatofuz@gmail.com>
parents:
diff changeset
69
833d55f0b5bd add README.md
AnaTofuZ <anatofuz@gmail.com>
parents:
diff changeset
70
833d55f0b5bd add README.md
AnaTofuZ <anatofuz@gmail.com>
parents:
diff changeset
71 # 2020年以前のバージョン
833d55f0b5bd add README.md
AnaTofuZ <anatofuz@gmail.com>
parents:
diff changeset
72
833d55f0b5bd add README.md
AnaTofuZ <anatofuz@gmail.com>
parents:
diff changeset
73 - [virsh-wrapper](http://www.cr.ie.u-ryukyu.ac.jp/hg/Applications/virsh-wrapper/)
833d55f0b5bd add README.md
AnaTofuZ <anatofuz@gmail.com>
parents:
diff changeset
74