[Kimchi-devel] [PATCH] Issue #587: Man page submission for kimchid
Aline Manera
alinefm at linux.vnet.ibm.com
Wed Mar 11 15:25:50 UTC 2015
I have just some comments below:
On 10/03/2015 08:21, Frédéric Bonnard wrote:
> From: Frederic Bonnard <frediz at linux.vnet.ibm.com>
>
> Adding a man page for kimchid.
> Adapting files that needed it and also COPYING as the license part in the manpage
> was taken from there and I updated it in the manpage.
> ---
> COPYING | 5 +-
> Makefile.am | 2 +
> contrib/kimchi.spec.fedora.in | 4 ++
> contrib/kimchi.spec.suse.in | 4 ++
> docs/Makefile.am | 1 +
> docs/kimchid.8 | 156 ++++++++++++++++++++++++++++++++++++++++++
> 6 files changed, 170 insertions(+), 2 deletions(-)
> create mode 100644 docs/kimchid.8
>
> diff --git a/COPYING b/COPYING
> index e759833..b34c747 100644
> --- a/COPYING
> +++ b/COPYING
> @@ -2,9 +2,10 @@ Kimchi is distributed pursuant to the terms of two different licenses.
> The user interface (located in ui/ in this distribution) is governed by
> the Apache License version 2.0.
>
> -Except the code under ui/spice-html5 which is imported from spice-html5 project
> -(http://cgit.freedesktop.org/spice/spice-html5) and under ui/libs which is
> imported from JQuery UI (http://jqueryui.com)
> +The code under ui/spice-html5 is imported from spice-html5 project
> +(http://cgit.freedesktop.org/spice/spice-html5) and the code under ui/libs
> +which is imported from JQuery UI (http://jqueryui.com)
>
> The rest of this distribution is governed by the GNU Lesser General Public
> License version 3.
> diff --git a/Makefile.am b/Makefile.am
> index 36e12d0..0720277 100644
> --- a/Makefile.am
> +++ b/Makefile.am
> @@ -19,6 +19,8 @@
>
> SUBDIRS = src ui docs contrib tests po config plugins
>
> +man_MANS = docs/kimchid.8
> +
> AUTOMAKE_OPTIONS = foreign
>
> ACLOCAL_AMFLAGS = --install -I m4
> diff --git a/contrib/kimchi.spec.fedora.in b/contrib/kimchi.spec.fedora.in
> index d80081a..08e69de 100644
> --- a/contrib/kimchi.spec.fedora.in
> +++ b/contrib/kimchi.spec.fedora.in
> @@ -169,6 +169,7 @@ rm -rf $RPM_BUILD_ROOT
> %{_sharedstatedir}/kimchi/
> %{_localstatedir}/log/kimchi/*
> %{_localstatedir}/log/kimchi/
> +%{_mandir}/man8/kimchid.8.gz
>
> %if 0%{?with_systemd}
> %{_unitdir}/kimchid.service
> @@ -182,6 +183,9 @@ rm -rf $RPM_BUILD_ROOT
> %endif
>
> %changelog
> +* Thu Feb 26 2015 Frédéric Bonnard <frediz at linux.vnet.ibm.com> 1.4.0
> +- Add man page for kimchid
> +
> * Tue Feb 11 2014 Crístian Viana <vianac at linux.vnet.ibm.com> 1.1.0
> - Add help pages and XSLT dependency
>
> diff --git a/contrib/kimchi.spec.suse.in b/contrib/kimchi.spec.suse.in
> index 11daf50..fb2dec5 100644
> --- a/contrib/kimchi.spec.suse.in
> +++ b/contrib/kimchi.spec.suse.in
> @@ -109,8 +109,12 @@ rm -rf $RPM_BUILD_ROOT
> %{_var}/lib/kimchi/
> %{_localstatedir}/log/kimchi/*
> %{_localstatedir}/log/kimchi/
> +%{_mandir}/man8/kimchid.8.gz
>
> %changelog
> +* Thu Feb 26 2015 Frédéric Bonnard <frediz at linux.vnet.ibm.com> 1.4.0
> +- Add man page for kimchid
> +
> * Tue Feb 11 2014 Crístian Viana <vianac at linux.vnet.ibm.com> 1.1.0
> - Add help pages and XSLT dependency
>
> diff --git a/docs/Makefile.am b/docs/Makefile.am
> index 679aa18..a22fe1a 100644
> --- a/docs/Makefile.am
> +++ b/docs/Makefile.am
> @@ -25,4 +25,5 @@ dist_doc_DATA = \
> README-federation.md \
> kimchi-guest.png \
> kimchi-templates.png \
> + kimchid.8 \
> $(NULL)
> diff --git a/docs/kimchid.8 b/docs/kimchid.8
> new file mode 100644
> index 0000000..03cde9b
> --- /dev/null
> +++ b/docs/kimchid.8
> @@ -0,0 +1,156 @@
> +.TH KIMCHI 1 "February 05, 2015" "Version 1.4.0" "Kimchi Manual"
> +.SH NAME
> +Kimchi \- HTML5 based management tool for KVM
> +.SH SYNOPSIS
> +.B kimchid
> +[\fB-h\fP|\fB--help\fP] [\fB--host\fP \fIhost\fP] [\fB--port\fP \fIport\fP]
> +[\fB--ssl-port\fP \fIssl_port\fP] [\fB--cherrypy_port\fP \fIcherrypy_port\fP]
> +[\fB--log-level\fP \fIlog_level\fP] [\fB--access-log\fP \fIaccess_log\fP]
> +[\fB--error-log\fP \fIerror_log\fP] [\fB--environment\fP \fIenvironment\fP]
> +[\fB--federation\fP \fIfederation\fP] [\fB--test\fP]
> +.SH DESCRIPTION
> +\fBKimchi\fP is an HTML5 based management tool for KVM. It is designed to make
> +it as easy as possible to get started with KVM and create your first guest.
> +\fBkimchid\fP launches the daemon on the hypervisor host which manages KVM guests through
> +libvirt. The management interface is accessed over the web using a browser that
> +supports HTML5.
> +.SH OPTIONS
> +The following options are supported:
> +.TP
> +\fB-h\fP , \fB--help\fP
> +Show this help message and exit.
> +.TP
> +\fB--host\fP \fIhost\fP
> +Specify the hostname or IP to listen on.
> +.TP
> +\fB--port\fP \fIport\fP
> +Specify the HTTP port (default \fI8000\fP).
> +.TP
> +\fB--ssl-port\fP \fIssl_port\fP
> +Specify the HTTPS port (default \fI8001\fP).
> +.TP
> +\fB--cherrypy_port\fP \fIcherrypy_port\fP
> +Specify the Cherrypy server port (default \fI8010\fP).
> +.TP
> +\fB--log-level\fP [\fIdebug\fP | \fIinfo\fP | \fIwarning\fP | \fIerror\fP | \fIcritical\fP]
> +Specify the log level (default \fIdebug\fP).
> +.TP
> +\fB--access-log\fP \fIaccess_log\fP
> +Specify the access log location where kimchi should create the access log file.
> +.TP
> +\fB--environment\fP [\fIstaging\fP | \fIproduction\fP | \fIembedded\fP | \fItest_suite\fP]
AFAIK, the environment options are: production and development
> +Specify the running environment of kimchi server. Check cherrypy documentation for more details (default \fIproduction\fP).
> +.TP
> +\fB--federation\fP [\fIon\fP | \fIoff\fP]
> +Register and discover Kimchi peers in the same network using OpenSLP. Check
> +below the \fBFEDERATION\fP section for more details (default \fIoff\fP).
> +.TP
> +\fB--test\fP
> +Run a series of tests on a mock version of kimchi.
Run kimchi on a mock version that do not affect the system. For testing
proposals.
> +.SH FEDERATION
> +Federation feature is a mechanism to discover Kimchi peers in the same network.
> +It uses OpenSLP tool (http://www.openslp.org/) to register and find the Kimchi
> +servers.
> +
> +By default this feature is disabled on Kimchi as it is not critical for KVM
> +virtualization and requires additional software installation.
> +
> +To enable it, do the following:
> +
> +1. Install OpenSLP server package
> +
> +2. OpenSLP uses port 427 (UDP) and port 427 (TCP) so make sure to open those
> + ports in your firewall configuration
> +
> + For system using firewalld, do:
> + sudo firewall-cmd --permanent --add-port=427/udp
> + sudo firewall-cmd --permanent --add-port=427/tcp
> + sudo firewall-cmd --reload
> +
> + For openSUSE systems, do:
> + sudo /sbin/SuSEfirewall2 open EXT TCP 427
> + sudo /sbin/SuSEfirewall2 open EXT UDP 427
> +
> + For system using iptables, do:
> + sudo iptables -A INPUT -p tcp --dport 427 -j ACCEPT
> + sudo iptables -A INPUT -p udp --dport 427 -j ACCEPT
> +
> +3. In addition to the OpenSLP ports, you also need to allow multicast in the
> + firewall configuration
> +
> + For system using firewalld, do:
> + sudo firewall-cmd --direct --add-rule ipv4 filter INPUT 0 -s <subnet> -j ACCEPT
> +
> + For openSUSE systems, do:
> + Add the subnet to the trusted networks listed on FW_TRUSTED_NETS in
> + /etc/sysconfig/SuSEfirewall2 file.
> + Make sure to restart /sbin/SuSEfirewall2 after modifying /etc/sysconfig/SuSEfirewall2
> +
> + For system using iptables, do:
> + sudo iptables -A INPUT -s <subnet> -j ACCEPT
> +
> +4. Start slpd service and make sure it is up while running Kimchi
> + sudo service slpd start
> +
> +5. Enable federation on Kimchi by editing the /etc/kimchi/kimchi.conf file:
> +
> + federation = on
> +
> +6. Then start Kimchi service
> + sudo service kimchid start
> +
> +The Kimchi server will be registered on OpenSLP on server starting up and will
> +be found by other Kimchi peers (with federation feature enabled) in the same
> +network.
> +.SH LICENCE
> +.br
> +Kimchi is distributed pursuant to the terms of two different licenses.
> +The user interface (located in ui/ in this distribution) is governed by
> +the Apache License version 2.0.
> +
> +The code under ui/spice-html5 is imported from spice-html5 project
> +(http://cgit.freedesktop.org/spice/spice-html5) and the code under ui/libs which is
> +imported from JQuery UI (http://jqueryui.com)
> +
> +The rest of this distribution is governed by the GNU Lesser General Public
> +License version 3.
> +
> +See COPYING.LGPL and COPYING.ASL2.
> +.SH BUGS
> +Current bugs can be found here : https://github.com/kimchi-project/kimchi/issues
> +.br
> +If you find any, please open an issue : https://github.com/kimchi-project/kimchi/issues/new
> +.SH AUTHOR
> +\fBAdam King\fP <rak at linux.vnet.ibm.com>,
> +\fBAdam Litke\fP <agl at linux.vnet.ibm.com>,
> +\fBAdriano Botega\fP <abotega at linux.vnet.ibm.com>,
> +\fBAlexandre Tanaka Hirata\fP <hirata at linux.vnet.ibm.com>,
> +\fBAline Manera\fP <alinefm at br.ibm.com>,
> +\fBapporc\fP <appleorchard2000 at gmail.com>,
> +\fBAnthony Liguori\fP <aliguori at us.ibm.com>,
> +\fBBing Bu Cao\fP <mars at linux.vnet.ibm.com>,
> +\fBChristy Perez\fP <christy at linux.vnet.ibm.com>,
> +\fBCole Robinson\fP <crobinso at redhat.com>,
> +\fBCrístian Viana\fP <vianac at linux.vnet.ibm.com>,
> +\fBDaniel H Barboza\fP <danielhb at linux.vnet.ibm.com>,
> +\fBEduardo Elias Ferreira\fP <edusf at linux.vnet.ibm.com>,
> +\fBEli Qiao(Li Yong Qiao)\fP <taget at linux.vnet.ibm.com>,
> +\fBHongliang Wang\fP <hlwang at linux.vnet.ibm.com>,
> +\fBLeonardo Garcia\fP <lagarcia at br.ibm.com>,
> +\fBLise Noble\fP <lwnoble at us.ibm.com>,
> +\fBMalcolm Yu\fP <minghaoyusombie at gmail.com>,
> +\fBMark Wu\fP <wudxw at linux.vnet.ibm.com>,
> +\fBMei Na Zhou\fP <zhoumein at linux.vnet.ibm.com>,
> +\fBPaulo Vital\fP <pvital at linux.vnet.ibm.com>,
> +\fBPradeep K Surisetty\fP <psuriset at linux.vnet.ibm.com>,
> +\fBRamon Medeiros\fP <ramonn at linux.vnet.ibm.com>,
> +\fBRodrigo Trujilo\fP <rodrigo.trujillo at linux.vnet.ibm.com>,
> +\fBRoyce Lv\fP <lvroyce at linux.vnet.ibm.com>,
> +\fBShaoHe Feng\fP <shaohef at linux.vnet.ibm.com>,
> +\fBShu Ming\fP <shuming at linux.vnet.ibm.com>,
> +\fBToby Allsopp\fP <toby at MI6.GEN.NZ>,
> +\fBTony Breeds\fP <tonyb at au1.ibm.com>,
> +\fBXin BJ Ding\fP <xinding at cn.ibm.com>,
> +\fBYu Xin Huo\fP <huoyuxin at linux.vnet.ibm.com>,
> +\fBZhou Zheng Sheng\fP <zhshzhou at linux.vnet.ibm.com>,
> +.SH SEE ALSO
More information about the Kimchi-devel
mailing list