fuel-plugin/README.md

   1 KVM Plugin for Fuel
   2 ================================
   3
   4 KVM plugin
   5 -----------------------
   6
   7 Overview
   8 --------
   9
  10 New fuel plugin fuel-plugin-kvm is to deploy KVM enhancements for NFV
  11
  12 Requirements
  13 ------------
  14
  15 | Requirement                      | Version/Comment |
  16 |----------------------------------|-----------------|
  17 | Mirantis OpenStack compatibility | 9.0             |
  18
  19 Recommendations
  20 ---------------
  21
  22 None.
  23
  24 Limitations
  25 -----------
  26
  27 None.
  28
  29 Build Guide
  30 ===========
  31
  32 Buiding system pre-requistes
  33 ----------------------------
  34 1. Ubuntu 14.04 LTS desktop or server
  35 2. Minimum 4 CPU cores, 6 GB RAM, and 200 GB available hard drive space
  36 3. "VirtualBox" and "vagrant" installed
  37
  38 Buid instruction
  39 ----------------
  40 1. Clone the kvmfornfv repo from https://gerrit.opnfv.org/gerrit/kvmfornfv by
  41    "git clone https://gerrit.opnfv.org/gerrit/kvmfornfv".
  42 2. You can modify the kernel code in kvmfornfv/kernel as you want.
  43 3. Go to kvmfornfv/fuel-plugin/vagrant, type "vagrant destroy -f; vagrant up;
  44    vagarant destroy -f", the building will start.
  45 4. When the building completes, you should find the built fuel-plugin-kvm in
  46    kvmfornfv/fuel-plugin/vagrant with the name as "fuel-plugin-kvm-0.9-0.9.0-1.noarch.rpm",
  47    where "0.9-0.9.0-1" is the version information for this plugin, this version info
  48    may be changed in future. The built plugin incules the changes you made.
  49
  50 Installation Guide
  51 ==================
  52 1. Move the built fuel-pluginn-kvm to the Fuel Master node with secure copy (scp):
  53       scp fuel-plugin-kvm-0.9-0.9.0-1.noarch.rpm root@<the_Fuel_Master_node_IP address>:
  54 2. While logged in Fuel Masternode, install the KVM plugin by typing:
  55         fuel plugins --install fuel-plugin-kvm-0.9-0.9.0-1.noarch.rpm
  56 3. Check if the plugin was installed successfully by typing "fuel plugins", the folowing
  57    should appear:
  58
  59         id | name             | version | package_version | release
  60         ---+------------------+---------+-----------------+--------------------
  61         1  | fuel-plugin-kvm  | 0.9.0   | 4.0.0           | ubuntu (mitaka-9.0)
  62 4. Plugin is ready to use and can be enabled on the Settings tab of the Fuel web UI.
  63
  64
  65 User Guide
  66 ==========
  67
  68 KVM plugin configuration
  69 ---------------------------------------------
  70 1. Create a new environment with the Fuel UI wizard.
  71 2. Click on the Settings tab of the Fuel web UI.
  72 3. Scroll down the page, select the plugin checkbox.
  73
  74
  75 Testing
  76 -------
  77 None.
  78
  79 Known issues
  80 ------------
  81 None.
  82
  83 Contributors
  84 ------------
  85 * davi.j.chou@intel.com, ruijing.guo@intel.comi, ling.y.yu@intel.com