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 | 8.0             |
  18
  19 Recommendations
  20 ---------------
  21
  22 None.
  23
  24 Limitations
  25 -----------
  26
  27 None.
  28
  29 Installation Guide
  30 ==================
  31
  32 KVM plugin installation
  33 ----------------------------------------
  34
  35 1. Clone the fuel-plugin repo from https://gerrit.opnfv.org/gerrit/kvmfornfv/fuel-plugin:
  36
  37         git clone https://gerrit.opnfv.org/gerrit/kvmfornfv/fuel-plugin
  38
  39 2. Install the Fuel Plugin Builder:
  40
  41         pip install fuel-plugin-builder
  42
  43 3. Build KVM Fuel plugin:
  44
  45         fpb --build fuel-plugin-kvm/
  46
  47 4. The *fuel-plugin-kvm-[x.x.x].rpm* plugin package will be created in the plugin folder.
  48
  49 5. Move this file to the Fuel Master node with secure copy (scp):
  50
  51         scp fuel-plugin-kvm-[x.x.x].rpm root@<the_Fuel_Master_node_IP address>:/tmp
  52
  53 6. While logged in Fuel Master install the KVM plugin:
  54
  55         fuel plugins --install fuel-plugin-kvm-[x.x.x].rpm
  56
  57 7. Check if the plugin was installed successfully:
  58
  59         fuel plugins
  60
  61         id | name             | version | package_version
  62         ---|------------------|---------|----------------
  63         1  | fuel-plugin-kvm | 0.5.2   | 3.0.0
  64
  65 8. Plugin is ready to use and can be enabled on the Settings tab of the Fuel web UI.
  66
  67
  68 User Guide
  69 ==========
  70
  71 KVM plugin configuration
  72 ---------------------------------------------
  73
  74 1. Create a new environment with the Fuel UI wizard.
  75 2. Click on the Settings tab of the Fuel web UI.
  76 3. Scroll down the page, select the plugin checkbox.
  77
  78
  79 Build options
  80 -------------
  81
  82 It is possible to modify process of building plugin by setting environment variables. Look into [pre_build_hook file](pre_build_hook) for more details.
  83
  84 Dependencies
  85 ------------
  86
  87 If you plan to use plugin in environment without internet access or/and CentOS environment modify build command:
  88
  89      INCLUDE_DEPENDENCIES=true fpb --build fuel-plugin-kvm/
  90
  91 Pre build script will try download required dependencies so it become part of the compiled plugin.
  92
  93 Note: List of packages for [ubuntu](kvm_package/ubuntu/dependencies.txt) and [centos](kvm_package/centos/dependencies.txt) may need to be modified if packages in centos or ubuntu repositories will change.
  94
  95 Testing
  96 -------
  97
  98 None.
  99
 100 Known issues
 101 ------------
 102
 103 None.
 104
 105
 106
 107 Development
 108 ===========
 109
 110 The *OpenStack Development Mailing List* is the preferred way to communicate,
 111 emails should be sent to `openstack-dev@lists.openstack.org` with the subject
 112 prefixed by `[fuel][plugins][kvm]`.
 113
 114 Reporting Bugs
 115 --------------
 116
 117 Bugs should be filled on the [Launchpad fuel-plugins project](
 118 https://bugs.launchpad.net/fuel-plugins) (not GitHub) with the tag `kvm`.
 119
 120
 121 Contributing
 122 ------------
 123
 124 If you would like to contribute to the development of this Fuel plugin you must
 125 follow the [OpenStack development workflow](
 126 http://docs.openstack.org/infra/manual/developers.html#development-workflow).
 127
 128 Patch reviews take place on the [OpenStack gerrit](
 129 https://review.openstack.org/#/q/status:open+project:stackforge/fuel-plugin-kvm,n,z)
 130 system.
 131
 132 Contributors
 133 ------------
 134
 135 * ling.y.yu@intel.com,ruijing.guo@intel.com