Merge "[Docs] Edits the plugin guide"
This commit is contained in:
commit
df598a8984
|
@ -2,8 +2,8 @@ Kafka plugin
|
|||
=======================
|
||||
|
||||
The *Kafka Plugin* installs [Apache Kafka](http://kafka.apache.org) and
|
||||
[Apache ZooKeeper](https://zookeeper.apache.org) in a
|
||||
Mirantis OpenStack (MOS) environment deployed by Fuel.
|
||||
[Apache ZooKeeper](https://zookeeper.apache.org) in a Mirantis OpenStack
|
||||
environment deployed by Fuel.
|
||||
|
||||
Please go to the [Kafka Plugin Documentation](
|
||||
http://fuel-plugin-kafka.readthedocs.org/en/latest/index.html)
|
||||
|
|
|
@ -3,43 +3,41 @@
|
|||
Configure the plugin
|
||||
~~~~~~~~~~~~~~~~~~~~
|
||||
|
||||
Once the *Kafka Plugin* is installed following the instructions of
|
||||
the :ref:`installation`, you can add Kafka nodes to new or
|
||||
existing Mirantis OpenStack (MOS) environment.
|
||||
Once installed, configure the Kafka Plugin and add nodes with the **Kafka**
|
||||
role to a new or existing Mirantis OpenStack environment.
|
||||
|
||||
To use the *Kafka Plugin*, you need to add nodes with the **Kafka** role
|
||||
`Add a node to an OpenStack environment
|
||||
<http://docs.openstack.org/developer/fuel-docs/userdocs/fuel-user-guide/configure-environment/add-nodes.html>`_.
|
||||
**To configure the plugin:**
|
||||
|
||||
1. Make sure that the plugin is properly installed on the Fuel Master node.
|
||||
|
||||
Go to the *Plugins* tab. You should see the following:
|
||||
#. Log in to the Fuel web UI.
|
||||
#. Verify that the Kafka Plugin is listed in the :guilabel:`Plugins` tab:
|
||||
|
||||
.. image:: images/plugins-list.png
|
||||
:width: 100%
|
||||
:width: 450pt
|
||||
|
||||
2. Enable the plugin. You can configure additional settings on this step.
|
||||
#. `Create a new environment <http://docs.openstack.org/developer/fuel-docs/userdocs/fuel-user-guide/create-environment/start-create-env.html>`_
|
||||
or use an existing one.
|
||||
|
||||
Go to the *Environments* tab and select the *The Apache Kafka Message
|
||||
Broker Plugin* checkbox:
|
||||
#. To enable the plugin and configure additional settings, navigate to the
|
||||
:guilabel:`Environments` tab and select the
|
||||
:guilabel:`The Apache Kafka Message Broker Plugin` checkbox:
|
||||
|
||||
.. image:: images/settings.png
|
||||
:width: 100%
|
||||
:width: 450pt
|
||||
|
||||
3. Add nodes to your environment and assign the **Kafka** role.
|
||||
#. Add nodes to your environment and assign the **Kafka** role to these nodes.
|
||||
|
||||
.. note:: When `adding nodes
|
||||
<http://docs.openstack.org/developer/fuel-docs/userdocs/fuel-user-guide/configure-environment/add-nodes.html>`_
|
||||
to the environment and `assign or change a role
|
||||
to the environment and `assigning or changing a role
|
||||
<http://docs.openstack.org/developer/fuel-docs/userdocs/fuel-user-guide/configure-environment/change-roles.html>`_,
|
||||
do not forget to use an odd number of nodes as recommended in the :ref:`introduction` section.
|
||||
do not forget to use an odd number of nodes as recommended in the
|
||||
:ref:`requirements` section.
|
||||
|
||||
.. image:: images/assign-role.png
|
||||
:width: 100%
|
||||
.. image:: images/assign-role.png
|
||||
:width: 450pt
|
||||
|
||||
4. `Verify your network configuration
|
||||
<http://docs.openstack.org/developer/fuel-docs/userdocs/fuel-user-guide/configure-environment/verify-networks.html>`_.
|
||||
|
||||
5. `Deploy your changes
|
||||
<http://docs.openstack.org/developer/fuel-docs/userdocs/fuel-user-guide/deploy-environment.html>`_
|
||||
once you are done with the configuration of your environment.
|
||||
5. `Deploy your environment
|
||||
<http://docs.openstack.org/developer/fuel-docs/userdocs/fuel-user-guide/deploy-environment.html>`_.
|
Binary file not shown.
Before Width: | Height: | Size: 74 KiB After Width: | Height: | Size: 75 KiB |
Binary file not shown.
Before Width: | Height: | Size: 124 KiB After Width: | Height: | Size: 122 KiB |
|
@ -3,9 +3,10 @@
|
|||
Install the plugin
|
||||
~~~~~~~~~~~~~~~~~~
|
||||
|
||||
To install the *Kafka Plugin*, you need to follow these steps.
|
||||
Before you proceed with installing the plugin, see the :ref:`limitations`
|
||||
section.
|
||||
|
||||
#. Please refer to the :ref:`limitations` section before you proceed.
|
||||
**To install the Kafka Plugin:**
|
||||
|
||||
#. Download the plugin from the
|
||||
`Fuel Plugins Catalog <https://www.mirantis.com/products/openstack-drivers-and-plugins/fuel-plugins/>`_.
|
||||
|
@ -13,20 +14,31 @@ To install the *Kafka Plugin*, you need to follow these steps.
|
|||
#. Copy the plugin's RPM file to the
|
||||
`Fuel Master node
|
||||
<http://docs.openstack.org/developer/fuel-docs/userdocs/fuel-install-guide/intro/intro_fuel_intro.html>`_
|
||||
with secure copy (scp)::
|
||||
using the secure copy :command:`scp` command:
|
||||
|
||||
# scp fuel-plugin-ceilometer-redis/kafka-1.0-0.1.0-1.noarch.rpm /
|
||||
root@:<the_Fuel_Master_node_IP address>:/tmp
|
||||
.. code-block:: console
|
||||
|
||||
#. Log into the Fuel Master node and install the plugin::
|
||||
# scp fuel-plugin-ceilometer-redis/kafka-1.0-0.1.0-1.noarch.rpm /
|
||||
root@:<the_Fuel_Master_node_IP address>:/tmp
|
||||
|
||||
# ssh root@:<the_Fuel_Master_node_IP address>
|
||||
[root@fuel-master ~]# cd /tmp
|
||||
[root@fuel-master ~]# fuel plugins --install kafka-1.0-0.1.0-1.noarch.rpm
|
||||
#. Log in to the Fuel Master node:
|
||||
|
||||
#. Verify that the plugin is installed correctly::
|
||||
.. code-block:: console
|
||||
|
||||
[root@fuel-master ~]# fuel plugins list
|
||||
id | name | version | package_version | releases
|
||||
---+-------+---------+-----------------+--------------------
|
||||
1 | kafka | 1.0.0 | 4.0.0 | ubuntu (mitaka-9.0)
|
||||
# ssh root@:<the_Fuel_Master_node_IP address>
|
||||
|
||||
#. Install the plugin:
|
||||
|
||||
.. code-block:: console
|
||||
|
||||
[root@fuel-master ~]# cd /tmp
|
||||
[root@fuel-master ~]# fuel plugins --install kafka-1.0-0.1.0-1.noarch.rpm
|
||||
|
||||
#. Verify that the plugin is installed correctly:
|
||||
|
||||
.. code-block:: console
|
||||
|
||||
[root@fuel-master ~]# fuel plugins list
|
||||
id | name | version | package_version | releases
|
||||
---+-------+---------+-----------------+--------------------
|
||||
1 | kafka | 1.0.0 | 4.0.0 | ubuntu (mitaka-9.0)
|
|
@ -3,19 +3,14 @@
|
|||
Introduction
|
||||
~~~~~~~~~~~~
|
||||
|
||||
The *Kafka Plugin* installs `Apache Kafka <http://kafka.apache.org/>`_ and
|
||||
The Kafka Plugin installs `Apache Kafka <http://kafka.apache.org/>`_ and
|
||||
`Apache ZooKeeper <https://zookeeper.apache.org/>`_ in a
|
||||
Mirantis OpenStack (MOS) environment deployed by Fuel.
|
||||
Apache Kafka is a publish-subscribe messaging system. It is fast,
|
||||
scalable and durable.
|
||||
Mirantis OpenStack environment deployed by Fuel. Apache Kafka is a
|
||||
publish-subscribe messaging system. It is fast, scalable, and durable.
|
||||
|
||||
The *Kafka Plugin* is created for exchanging messages between various
|
||||
The Kafka Plugin is created for exchanging messages between various
|
||||
components of StackLight and Ceilometer, but it is generic enough to
|
||||
accommodate other usages.
|
||||
The Plugin implements the *Kafka* Fuel role. The maximum number of nodes for
|
||||
the *Kafka* Fuel role is 5. To support high-availability, the minimum number
|
||||
of nodes is 3. You need to have an initial odd number of nodes to comply with
|
||||
the leader election process constraints.
|
||||
|
||||
Please refer to the `Kafka 0.10.0 documentation <http://kafka.apache.org/documentation.html>`_
|
||||
for more information.
|
||||
.. seealso::
|
||||
* `Kafka 0.10.0 documentation <http://kafka.apache.org/documentation.html>`_
|
|
@ -3,10 +3,12 @@
|
|||
Limitations
|
||||
~~~~~~~~~~~
|
||||
|
||||
* Kafka supports authentication, encryption and authorization. Current version of the
|
||||
plugin doesn't support any form of security, meaning that the Kafka cluster will be
|
||||
“open” on the management network.
|
||||
The Kafka Plugin has the following limitations:
|
||||
|
||||
* Kafka Plugin will not expose configuration properties for all the broker configuration parameters.
|
||||
This means that the Kafka broker configuration set by the plugin will not be appropriate for every
|
||||
usage.
|
||||
* Kafka supports authentication, encryption, and authorization. The current
|
||||
version of the plugin does not support any form of security, meaning that
|
||||
the Kafka cluster will be “open” on the management network.
|
||||
|
||||
* The Kafka Plugin will not expose configuration properties for all the broker
|
||||
configuration parameters. That is, the Kafka broker configuration set by the
|
||||
plugin will not be appropriate for every usage.
|
|
@ -3,6 +3,8 @@
|
|||
Requirements
|
||||
~~~~~~~~~~~~
|
||||
|
||||
The Kafka Plugin has the following requirements:
|
||||
|
||||
.. tabularcolumns:: |p{4cm}|p{12.5cm}|
|
||||
|
||||
+----------------------+-------------------------------------------------------+
|
||||
|
@ -26,4 +28,11 @@ Requirements
|
|||
| |setup would require a quad-core server with at least |
|
||||
| |8 GB of RAM for Kafka and 3GB for Zookeeper and access |
|
||||
| |to a 500+ IOPS disk. |
|
||||
+----------------------+-------------------------------------------------------+
|
||||
|OpenStack nodes |The plugin implements the *Kafka* Fuel role. The |
|
||||
| |maximum number of nodes for the *Kafka* Fuel role is |
|
||||
| |five. To support high-availability, the minimum number |
|
||||
| |of nodes is three. You need to have an initial odd |
|
||||
| |number of nodes to comply with the leader election |
|
||||
| |process constraints. |
|
||||
+----------------------+-------------------------------------------------------+
|
|
@ -1,34 +1,40 @@
|
|||
.. _verify_plugin:
|
||||
.. _verification:
|
||||
|
||||
Verify the plugin
|
||||
~~~~~~~~~~~~~~~~~
|
||||
|
||||
#. On the Fuel Master node, find the IP address of a node where Kafka is
|
||||
Depending on the number of nodes and deployment setup, deploying a Mirantis
|
||||
OpenStack environment may take 20 minutes to several hours. Once the
|
||||
deployment is complete, you should see a deployment success notification
|
||||
message.
|
||||
|
||||
**To verify the plugin:**
|
||||
|
||||
#. On the Fuel Master node, find the IP address of the node where Kafka is
|
||||
installed using the :command:`fuel nodes` command:
|
||||
|
||||
.. code-block:: console
|
||||
|
||||
[root@fuel ~]# fuel nodes
|
||||
id|status|name |cluster|ip |mac |roles |
|
||||
--|------|----------------|-------|----|-------------------------|
|
||||
1 |ready |Untitled (fa:87)| 1 |... |... |kafka |
|
||||
2 |ready |Untitled (12:aa)| 1 |... |... |kafka |
|
||||
3 |ready |Untitled (4e:6e)| 1 |... |... |kafka |
|
||||
|
||||
[root@fuel ~]# fuel nodes
|
||||
id|status|name |cluster|ip |mac |roles |
|
||||
--|------|----------------|-------|----|-------------------------|
|
||||
1 |ready |Untitled (fa:87)| 1 |... |... |kafka |
|
||||
2 |ready |Untitled (12:aa)| 1 |... |... |kafka |
|
||||
3 |ready |Untitled (4e:6e)| 1 |... |... |kafka |
|
||||
|
||||
#. Log in to any of these nodes using SSH, for example, to ``node-1``.
|
||||
#. Run the following command:
|
||||
|
||||
.. code-block:: console
|
||||
|
||||
root@node-1:~# netstat -ntpl | grep java
|
||||
tcp6 0 0 :::9092 :::* LISTEN 14702/java
|
||||
tcp6 0 0 :::2181 :::* LISTEN 9710/java
|
||||
tcp6 0 0 :::9990 :::* LISTEN 14702/java
|
||||
root@node-1:~# netstat -ntpl | grep java
|
||||
tcp6 0 0 :::9092 :::* LISTEN 14702/java
|
||||
tcp6 0 0 :::2181 :::* LISTEN 9710/java
|
||||
tcp6 0 0 :::9990 :::* LISTEN 14702/java
|
||||
|
||||
You will see Zookeeper running and listening on port 2181 and Kafka on ports
|
||||
9092 and 9990 accordingly.
|
||||
You should see Zookeeper running and listening on port 2181 and Kafka on
|
||||
ports 9092 and 9990 accordingly.
|
||||
|
||||
#. To perform additional verification tests, for example, to try send and
|
||||
receive messages, see the instructions provided in the
|
||||
`Quick Start Guide (Step 3 - Step 5) <http://kafka.apache.org/documentation.html#quickstart>`_.
|
||||
`Quick Start Guide (steps 3-5) <http://kafka.apache.org/documentation.html#quickstart>`_.
|
Loading…
Reference in New Issue