From 2ef42923e4f39e81f9a3a61ae96fd38e2b8cc9fb Mon Sep 17 00:00:00 2001
From: Andrey Pavlov <apavlov@mirantis.com>
Date: Thu, 2 Mar 2017 21:20:16 +0400
Subject: [PATCH] Doc about zmq in ccp

Change-Id: I8a59813224ac384294a74b749d097bae2a595cfe
---
 doc/source/index.rst               |  1 +
 doc/source/zmq.rst                 | 57 ++++++++++++++++++++++++++++++
 etc/topology-with-zmq-example.yaml | 54 ++++++++++++++++++++++++++++
 3 files changed, 112 insertions(+)
 create mode 100644 doc/source/zmq.rst
 create mode 100644 etc/topology-with-zmq-example.yaml

diff --git a/doc/source/index.rst b/doc/source/index.rst
index 7b26cb42..3fe21df8 100644
--- a/doc/source/index.rst
+++ b/doc/source/index.rst
@@ -32,6 +32,7 @@ Advanced topics
    using_calico_instead_of_ovs
    using_odl_instead_of_ovs
    ironic
+   zmq
    known_issues
    neutron_configuration
 
diff --git a/doc/source/zmq.rst b/doc/source/zmq.rst
new file mode 100644
index 00000000..1aac383b
--- /dev/null
+++ b/doc/source/zmq.rst
@@ -0,0 +1,57 @@
+.. _zmq:
+
+============
+ZeroMQ Guide
+============
+
+This guide provides information about how to enable zmq in the CCP.
+
+To use zmq as an rpc backend the following steps are required:
+
+1. `fuel-ccp-zmq` repository should be added to the repositories list:
+
+::
+
+    repositories:
+      repos:
+        - git_url: https://git.openstack.org/openstack/fuel-ccp-zmq
+          name: fuel-ccp-zmq
+
+2. `zmq-proxy` and `redis` images should be built:
+
+::
+
+    ccp build -c zmq-proxy redis
+
+3. `rpc` service should be configured to use zmq:
+
+::
+
+    services:
+      rpc:
+        service_def: zmq-proxy
+
+4. `rpc` and `redis` services should be added to topology. Example of such
+   topology provided in :file:`fuel-ccp/etc/topology-with-zmq-example.yaml`
+
+5. `configs` should be extended with the following values:
+
+::
+
+    configs:
+      messaging:
+        backend:
+          rpc: zmq
+
+Pretty much the same steps required to enable zmq as a notifications backend:
+
+::
+
+    services:
+      notifications:
+        service_def: zmq-proxy
+
+    configs:
+      messaging:
+        backend:
+          notifications: zmq
diff --git a/etc/topology-with-zmq-example.yaml b/etc/topology-with-zmq-example.yaml
new file mode 100644
index 00000000..e518c8cc
--- /dev/null
+++ b/etc/topology-with-zmq-example.yaml
@@ -0,0 +1,54 @@
+services:
+  database:
+    service_def: galera
+  rpc:
+    service_def: zmq-proxy
+  notifications:
+    service_def: zmq-proxy
+
+nodes:
+  node1:
+    roles:
+      - db
+      - messaging
+      - controller
+      - openvswitch
+  node[2-3]:
+    roles:
+      - db
+      - messaging
+      - compute
+      - openvswitch
+roles:
+  db:
+    - database
+  messaging:
+    - rpc
+    - notifications
+    - redis
+  controller:
+    - etcd
+    - glance-api
+    - glance-registry
+    - heat-api-cfn
+    - heat-api
+    - heat-engine
+    - horizon
+    - keystone
+    - memcached
+    - neutron-dhcp-agent
+    - neutron-l3-agent
+    - neutron-metadata-agent
+    - neutron-server
+    - nova-api
+    - nova-conductor
+    - nova-consoleauth
+    - nova-novncproxy
+    - nova-scheduler
+  compute:
+    - nova-compute
+    - nova-libvirt
+  openvswitch:
+    - neutron-openvswitch-agent
+    - openvswitch-db
+    - openvswitch-vswitchd