summaryrefslogtreecommitdiffstats
path: root/fuel-plugin/README.md
blob: 810d8a021b51d601303d2cd6b1cca80f23ef568b (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
KVM Plugin for Fuel
================================

KVM plugin
-----------------------

Overview
--------

New fuel plugin fuel-plugin-kvm is to deploy KVM enhancements for NFV

Requirements
------------

| Requirement                      | Version/Comment |
|----------------------------------|-----------------|
| Mirantis OpenStack compatibility | 8.0             |

Recommendations
---------------

None.

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:

        fuel plugins

        id | name             | version | package_version
        ---|------------------|---------|----------------
        1  | fuel-plugin-kvm | 0.5.2   | 3.0.0

8. Plugin is ready to use and can be enabled on the Settings tab of the Fuel web UI.


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. 


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