fuel-plugin-openstack-telemetry/docs/source/install.rst

Introduction

Before you install the OpenStack Telemetry plugin, verify that your environment meets the requirements described in requirements. You must have the Fuel Master node installed and configured before you can install the plugin.

You can install the OpenStack Telemetry plugin using one of the following options:

• Install using the RPM file
• Install from source

Install using the RPM file

To install the OpenStack Telemetry plugin using the RPM file of the Fuel plugins catalog:

1. Download the OpenStack Telemetry plugin from the Fuel plugins catalog.

2. Copy the plugin .rpm file to the Fuel Master node:

   Example:

   # scp telemetry-1.0-1.0.1-1.noarch.rpm root@fuel-master:/tmp

3. Log in to the Fuel Master node CLI as root.

4. Install the plugin using the Fuel Plugins CLI:

   # fuel plugins --install telemetry-1.0-1.0.0-1.noarch.rpm

5. Verify that the plugin is installed correctly:

   # fuel plugins
   id | name       | version | package_version | releases
   ---|------------|---------|-----------------|--------------------
   1  | telemetry  |  1.0.1  |  4.0.0          | ubuntu (mitaka-9.0)

6. Proceed to configure.

Install from source

Alternatively, you may want to build the plugin RPM file from source if, for example, you want to test the latest features of the master branch or customize the plugin.

Note

Running a Fuel plugin that you built yourself is at your own risk and will not be supported.

To install the OpenStack Telemetry plugin from source, first prepare an environment to build the RPM file. The recommended approach is to build the RPM file directly onto the Fuel Master node so that you will not have to copy that file later on.

To prepare an environment and build the plugin:

1. Install the standard Linux development tools:

   [root@home ~] yum install createrepo rpm rpm-build dpkg-devel

2. Install the Fuel Plugin Builder. To do that, you should first get pip:

   [root@home ~] easy_install pip

3. Then install the Fuel Plugin Builder (the fpb command line) with pip:

   [root@home ~] pip install fuel-plugin-builder

   Note

   You may also need to build the Fuel Plugin Builder if the package version of the plugin is higher than the package version supported by the Fuel Plugin Builder you get from pypi. For instructions on how to build the Fuel Plugin Builder, see the Install Fuel Plugin Builder section of the Fuel Plugin SDK Guide.

4. Clone the plugin repository:

   [root@home ~] git clone https://github.com/openstack/fuel-plugin-openstack-telemetry

5. Verify that the plugin is valid:

   [root@home ~] fpb --check ./fuel-plugin-openstack-telemetry

6. Build the plugin:

   [root@home ~] fpb --build ./fuel-plugin-openstack-telemetry

To install the plugin:

1. Once you create the RPM file, install the plugin:

   [root@fuel ~] fuel plugins --install ./fuel-plugin-openstack-telemetry/*.noarch.rpm

2. Verify that the plugin is installed correctly:

   # fuel plugins
   id | name       | version | package_version | releases
   ---|------------|---------|-----------------|--------------------
   1  | telemetry  |  1.0.1  |  4.0.0          | ubuntu (mitaka-9.0)

3. Proceed to configure.