1KIMCHI(8) Kimchi Manual KIMCHI(8)
2
6 Kimchi - HTML5 based management tool for KVM
7
9 kimchid [-h|--help] [--host host] [--port port] [--ssl-port ssl_port]
10 [--cherrypy_port cherrypy_port] [--log-level log_level] [--access-log
11 access_log] [--error-log error_log] [--environment environment] [--fed‐
12 eration federation] [--test]
13
15 Kimchi is an HTML5 based management tool for KVM. It is designed to
16 make it as easy as possible to get started with KVM and create your
17 first guest. kimchid launches the daemon on the hypervisor host which
18 manages KVM guests through libvirt. The management interface is
19 accessed over the web using a browser that supports HTML5.
20
22 The following options are supported:
23 -h , --help
25 Show this help message and exit.
26 --host host
28 Specify the hostname or IP to listen on.
29 --port port
31 Specify the HTTP port (default 8000).
32 --ssl-port ssl_port
34 Specify the HTTPS port (default 8001).
35 --cherrypy_port cherrypy_port
37 Specify the Cherrypy server port (default 8010).
38 --log-level [debug | info | warning | error | critical]
40 Specify the log level (default debug).
41 --access-log access_log
43 Specify the access log location where kimchi should create the
44 access log file.
45 --environment [development | production]
47 Specify the running environment of kimchi server. Check cherrypy
48 documentation for more details (default production).
49 --federation [on | off]
51 Register and discover Kimchi peers in the same network using
52 OpenSLP. Check below the FEDERATION section for more details
53 (default off).
54 --test Run kimchi on a mock version that does not affect the system.
56 For testing proposals.
57
59 Federation feature is a mechanism to discover Kimchi peers in the same
60 network. It uses OpenSLP tool (http://www.openslp.org/) to register
61 and find the Kimchi servers.
62 By default this feature is disabled on Kimchi as it is not critical for
64 KVM virtualization and requires additional software installation.
65 To enable it, do the following:
67 1. Install OpenSLP server package
69 2. OpenSLP uses port 427 (UDP) and port 427 (TCP) so make sure to open
71 those
72 ports in your firewall configuration
73 For system using firewalld, do:
75 sudo firewall-cmd --permanent --add-port=427/udp
76 sudo firewall-cmd --permanent --add-port=427/tcp
77 sudo firewall-cmd --reload
78 For openSUSE systems, do:
80 sudo /sbin/SuSEfirewall2 open EXT TCP 427
81 sudo /sbin/SuSEfirewall2 open EXT UDP 427
82 For system using iptables, do:
84 sudo iptables -A INPUT -p tcp --dport 427 -j ACCEPT
85 sudo iptables -A INPUT -p udp --dport 427 -j ACCEPT
86 3. In addition to the OpenSLP ports, you also need to allow multicast
88 in the
89 firewall configuration
90 For system using firewalld, do:
92 sudo firewall-cmd --direct --add-rule ipv4 filter INPUT 0 -s <sub‐
93 net> -j ACCEPT
94 For openSUSE systems, do:
96 Add the subnet to the trusted networks listed on FW_TRUSTED_NETS in
97 /etc/sysconfig/SuSEfirewall2 file.
98 Make sure to restart /sbin/SuSEfirewall2 after modifying
99 /etc/sysconfig/SuSEfirewall2
100 For system using iptables, do:
102 sudo iptables -A INPUT -s <subnet> -j ACCEPT
103 4. Start slpd service and make sure it is up while running Kimchi
105 sudo service slpd start
106 5. Enable federation on Kimchi by editing the /etc/kimchi/kimchi.conf
108 file:
109 federation = on
111 6. Then start Kimchi service
113 sudo service kimchid start
114 The Kimchi server will be registered on OpenSLP on server starting up
116 and will be found by other Kimchi peers (with federation feature
117 enabled) in the same network.
118
120 Kimchi is distributed pursuant to the terms of two different licenses.
121 The user interface (located in ui/ in this distribution) is governed by
122 the Apache License version 2.0.
123 The code under ui/spice-html5 is imported from spice-html5 project
125 (http://cgit.freedesktop.org/spice/spice-html5) and the code under
126 ui/libs which is imported from JQuery UI (http://jqueryui.com)
127 The rest of this distribution is governed by the GNU Lesser General
129 Public License version 3.
130 See COPYING.LGPL and COPYING.ASL2.
132
134 Current bugs can be found here : https://github.com/kimchi-project/kim‐
135 chi/issues
136 If you find any, please open an issue : https://github.com/kimchi-
137 project/kimchi/issues/new
138
140 Adam King <rak@linux.vnet.ibm.com>, Adam Litke
141 <agl@linux.vnet.ibm.com>, Adriano Botega <abotega@linux.vnet.ibm.com>,
142 Alexandre Tanaka Hirata <hirata@linux.vnet.ibm.com>, Aline Manera
143 <alinefm@br.ibm.com>, apporc <appleorchard2000@gmail.com>, Anthony
144 Liguori <aliguori@us.ibm.com>, Bing Bu Cao <mars@linux.vnet.ibm.com>,
145 Christy Perez <christy@linux.vnet.ibm.com>, Cole Robinson
146 <crobinso@redhat.com>, Crístian Viana <vianac@linux.vnet.ibm.com>,
147 Daniel H Barboza <danielhb@linux.vnet.ibm.com>, Eduardo Elias Ferreira
148 <edusf@linux.vnet.ibm.com>, Eli Qiao(Li Yong Qiao)
149 <taget@linux.vnet.ibm.com>, Hongliang Wang <hlwang@linux.vnet.ibm.com>,
150 Leonardo Garcia <lagarcia@br.ibm.com>, Lise Noble <lwnoble@us.ibm.com>,
151 Malcolm Yu <minghaoyusombie@gmail.com>, Mark Wu
152 <wudxw@linux.vnet.ibm.com>, Mei Na Zhou <zhoumein@linux.vnet.ibm.com>,
153 Paulo Vital <pvital@linux.vnet.ibm.com>, Pradeep K Surisetty
154 <psuriset@linux.vnet.ibm.com>, Ramon Medeiros
155 <ramonn@linux.vnet.ibm.com>, Rodrigo Trujilo <rodrigo.tru‐
156 jillo@linux.vnet.ibm.com>, Royce Lv <lvroyce@linux.vnet.ibm.com>,
157 ShaoHe Feng <shaohef@linux.vnet.ibm.com>, Shu Ming <shum‐
158 ing@linux.vnet.ibm.com>, Toby Allsopp <toby@MI6.GEN.NZ>, Tony Breeds
159 <tonyb@au1.ibm.com>, Xin BJ Ding <xinding@cn.ibm.com>, Yu Xin Huo
160 <huoyuxin@linux.vnet.ibm.com>, Zhou Zheng Sheng
161 <zhshzhou@linux.vnet.ibm.com>,
162
164Version 1.5.1 February 05, 2015 KIMCHI(8)