diff options
Diffstat (limited to 'fuel-plugin/README.md')
| -rw-r--r-- | fuel-plugin/README.md | 118 |
1 files changed, 34 insertions, 84 deletions
diff --git a/fuel-plugin/README.md b/fuel-plugin/README.md index 810d8a021..77dee17c2 100644 --- a/fuel-plugin/README.md +++ b/fuel-plugin/README.md @@ -14,7 +14,7 @@ Requirements | Requirement | Version/Comment | |----------------------------------|-----------------| -| Mirantis OpenStack compatibility | 8.0 | +| Mirantis OpenStack compatibility | 9.0 | Recommendations --------------- @@ -26,43 +26,40 @@ Limitations None. -Installation Guide -================== - -KVM plugin installation ----------------------------------------- - -1. Clone the fuel-plugin repo from https://gerrit.opnfv.org/gerrit/kvmfornfv/fuel-plugin: - - git clone https://gerrit.opnfv.org/gerrit/kvmfornfv/fuel-plugin - -2. Install the Fuel Plugin Builder: - - pip install fuel-plugin-builder - -3. Build KVM Fuel plugin: - - fpb --build fuel-plugin-kvm/ - -4. The *fuel-plugin-kvm-[x.x.x].rpm* plugin package will be created in the plugin folder. - -5. Move this file to the Fuel Master node with secure copy (scp): - - scp fuel-plugin-kvm-[x.x.x].rpm root@<the_Fuel_Master_node_IP address>:/tmp - -6. While logged in Fuel Master install the KVM plugin: - - fuel plugins --install fuel-plugin-kvm-[x.x.x].rpm - -7. Check if the plugin was installed successfully: +Build Guide +=========== - fuel plugins +Buiding system pre-requistes +---------------------------- +1. Ubuntu 14.04 LTS desktop or server +2. Minimum 4 CPU cores, 6 GB RAM, and 200 GB available hard drive space +3. "VirtualBox" and "vagrant" installed + +Buid instruction +---------------- +1. Clone the kvmfornfv repo from https://gerrit.opnfv.org/gerrit/kvmfornfv by + "git clone https://gerrit.opnfv.org/gerrit/kvmfornfv" +2. You can modify the kernel code in kvmfornfv/kernel as you want +3. Go to kvmfornfv/fuel-plugin/vagrant, type "vagrant destroy -f; vagrant up; + estroy -f", the building will start +4. When the building completes, you should find the built fuel-plugin-kvm in + kvmfornfv/fuel-plugin with the name as "fuel-plugin-kvm-0.9-0.9.0-1.noarch.rpm", + where "0.9-0.9.0-1" is the version information for this plugin, this version info + may be changed in future. The built plugin incules the changes you made. - id | name | version | package_version - ---|------------------|---------|---------------- - 1 | fuel-plugin-kvm | 0.5.2 | 3.0.0 +Installation Guide +================== +1. Move the built fuel-pluginn-kvm to the Fuel Master node with secure copy (scp): + scp fuel-plugin-kvm-0.9-0.9.0-1.noarch.rpm root@<the_Fuel_Master_node_IP address>: +2. While logged in Fuel Masternode, install the KVM plugin by typing: + fuel plugins --install fuel-plugin-kvm-0.9-0.9.0-1.noarch.rpm +3. Check if the plugin was installed successfully by typing "fuel plugins", the folowing + should appear: -8. Plugin is ready to use and can be enabled on the Settings tab of the Fuel web UI. + id | name | version | package_version | release + ---+------------------+---------+-----------------+-------------------- + 1 | fuel-plugin-kvm | 0.9.0 | 4.0.0 | ubuntu (mitaka-9.0) +4. Plugin is ready to use and can be enabled on the Settings tab of the Fuel web UI. User Guide @@ -70,66 +67,19 @@ User Guide KVM plugin configuration --------------------------------------------- - 1. Create a new environment with the Fuel UI wizard. 2. Click on the Settings tab of the Fuel web UI. -3. Scroll down the page, select the plugin checkbox. - +3. Scroll down the page, select the plugin checkbox. -Build options -------------- - -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. - -Dependencies ------------- - -If you plan to use plugin in environment without internet access or/and CentOS environment modify build command: - - INCLUDE_DEPENDENCIES=true fpb --build fuel-plugin-kvm/ - -Pre build script will try download required dependencies so it become part of the compiled plugin. - -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. Testing ------- - None. Known issues ------------ - None. - - -Development -=========== - -The *OpenStack Development Mailing List* is the preferred way to communicate, -emails should be sent to `openstack-dev@lists.openstack.org` with the subject -prefixed by `[fuel][plugins][kvm]`. - -Reporting Bugs --------------- - -Bugs should be filled on the [Launchpad fuel-plugins project]( -https://bugs.launchpad.net/fuel-plugins) (not GitHub) with the tag `kvm`. - - -Contributing ------------- - -If you would like to contribute to the development of this Fuel plugin you must -follow the [OpenStack development workflow]( -http://docs.openstack.org/infra/manual/developers.html#development-workflow). - -Patch reviews take place on the [OpenStack gerrit]( -https://review.openstack.org/#/q/status:open+project:stackforge/fuel-plugin-kvm,n,z) -system. - Contributors ------------ - -* ling.y.yu@intel.com,ruijing.guo@intel.com +* davi.j.chou@intel.com, ruijing.guo@intel.comi, ling.y.yu@intel.com |