An HTML5 management interface for KVM
Python JavaScript CSS M4 Shell Makefile Other
Latest commit 1e1f7b0 Mar 21, 2017 @alinefm alinefm Bug fix: Display full Volume dropdown menu content even when pool has…
… few volumes

When the storage pool has one or two storage volumes, the dropdown menu
would not display all the options as the height set to it was not
enough.
To avoid that, increase the min-height configuration.

Signed-off-by: Aline Manera <alinefm@linux.vnet.ibm.com>
Permalink
Failed to load latest commit information.
build-aux Update pkg-version script to work with submodules Feb 24, 2016
contrib Use Websocket facilities from WoK Mar 10, 2017
control Remove role_key parameter Jan 25, 2017
distros.d Update Ubuntu remote images. Jun 28, 2016
docs Use Websocket facilities from WoK Mar 10, 2017
m4 Use Autoconf macros AC_PROG_MKDIR_P and MKDIR_P Jan 29, 2014
model Bug fix #1123: Do not rely on Wok configuration to get host information Mar 21, 2017
po po/ja_JP.po: fix trailing whitespace Nov 10, 2016
tests Use Websocket facilities from WoK Mar 10, 2017
ui Bug fix: Display full Volume dropdown menu content even when pool has… Mar 22, 2017
xmlutils Bug fix #1107: Only set cache=none to disks that support direct IO Mar 13, 2017
.gitignore Do not rely on python-pip to install build dependencies Dec 23, 2015
ABOUT-NLS build: Add gettext i18n support Jul 30, 2013
API.json Live migration RDMA support: doc changes Jan 19, 2017
AUTHORS Update ChangeLog and po files for 2.0 release Dec 17, 2015
CONTRIBUTE.md Add mailing list information. Feb 13, 2014
COPYING Import term.js to Kimchi project Feb 15, 2016
COPYING.ASL2 burnet: relicense source tree Jun 20, 2013
COPYING.LGPL Update back-end license to LGPLv2.1 Oct 5, 2015
ChangeLog Update ChangeLog, VERSION and po files to 2.3 release Sep 29, 2016
IBM-license-blacklist Added Kimchi SVG logo for login page, footer and about window Feb 26, 2016
INSTALL build: Add basic autotools infrastructure Jul 30, 2013
Makefile.am Use libvirtd service in Ubuntu Dec 14, 2016
README.md Display "README" with markdown style on Github Oct 6, 2014
VERSION Update ChangeLog, VERSION and po files to 2.3 release Sep 29, 2016
__init__.py Update copyright according to make check-local result Feb 23, 2016
autogen.sh Update copyright according to make check-local result Feb 23, 2016
check_spec_errors.sh Issue #962: Suggestion to check spec guidelines Oct 6, 2016
check_ui_code_errors.sh Improve UI error codes checking Jun 17, 2016
config.py.in Virt-Viewer launcher: Makefile and config changes Jul 27, 2016
config.rpath build: Add basic autotools infrastructure Jul 30, 2013
configure.ac Issue #962: Suggestion to check spec guidelines Oct 6, 2016
distroloader.py remote iso listing for s390x Sep 13, 2016
i18n.py Improve logic to identify if a network is in use or not Feb 9, 2017
imageinfo.py Add more details to error message when probing image Dec 13, 2016
iscsi.py Update copyright according to make check-local result Feb 23, 2016
isoinfo.py Recognize openSUSE 42.2 ISO Dec 1, 2016
kimchi.conf Remove URI configuration from kimchi.conf file Oct 28, 2016
kvmusertests.py Added on_poweroff, on_reboot, on_crash tag to also support s390x arch… Aug 11, 2016
mockmodel.py Fix patch_auth() call according to Wok changes Feb 16, 2017
network.py Do not use default value when declare a function Jun 8, 2016
osinfo.py Bug fix #1089: osinfo.py tablet_bus='usb' for x86 modern Feb 6, 2017
root.py Use Websocket facilities from WoK Mar 10, 2017
scan.py Update copyright according to make check-local result Feb 23, 2016
screenshot.py Update copyright according to make check-local result Feb 23, 2016
serialconsole.py Use Wok session timeout value to configure serial console May 31, 2016
template.conf s390x specific changes to support storage path and storage pool as disk. Nov 10, 2016
utils.py Fix checking for libvirt daemon on Ubuntu Dec 7, 2016
vmtemplate.py s390x specific changes to support storage path and storage pool as disk. Nov 10, 2016

README.md

What is Kimchi?

Kimchi 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.

Kimchi runs as a Wok plugin.

Kimchi manages KVM guests through libvirt. The management interface is accessed over the web using a browser that supports HTML5.

Getting Started

The latest packages available can be found at http://kimchi-project.github.io/kimchi/downloads/

If you prefer to install Kimchi from source code, follow the steps below!

Install Dependencies

First of all, make sure to Wok and Ginger Base installed in your system. To add Kimchi plugin, please make sure to have all the dependencies installed before starting up the wokd service.

Build and Install

For openSUSE:
$ ./autogen.sh --with-spice-html5

Otherwise:
$ ./autogen.sh --system

$ make

# Optional if running from the source tree
$ sudo make install

Testing

$ make check-local
$ sudo make check

After all tests are executed, a summary will be displayed containing any errors/failures which might have occurred.

Usage

Connect your browser to https://localhost:8001. You should see a screen like:

Wok Login Screen

By default, wok uses PAM to authenticate users so you can log in with the same username and password that you would use to log in to the machine itself. Once logged in you will see a screen like:

Kimchi Guest View

This shows you the list of running guests including a live screenshot of the guest session. You can use the action buttons to shutdown the guests or connect to the display in a new window.

To create a new guest, click on the "+" button in the upper right corner. In Kimchi, all guest creation is done through templates.

You can view or modify templates by clicking on the Templates link in the top navigation bar.

The template screen looks like:

Kimchi Template View

From this view, you can change the parameters of a template or create a new template using the "+" button in the upper right corner.

To create a template, you need an ISO or image file on your host or use a remote one. If you are willing to use your own ISO, please copy it to out of box storage pool (default path is: /var/lib/kimchi/isos).

Troubleshooting

Server access

Please, check Wok configuration if you are getting problems to access Wok server.

NFS storage pool

Please, check the NFS export path permission is configured like below:

  1. Export path need to be squashed as kvm gid and libvirt uid: /my_export_path *(all_squash,anongid=, anonuid=,rw,sync)

    So that root user can create volume with right user/group.

  2. Set libvirt user and kvm group for export path, in order to make sure all mapped user can get into the mount point.

Contributing to Kimchi Project

There are a lof of ways to contribute to the Kimchi Project:

Find more information about Wok Project at https://github.com/kimchi-project/kimchi/wiki