aboutsummaryrefslogtreecommitdiff
path: root/doc
diff options
context:
space:
mode:
authorHui Kang <kangh@us.ibm.com>2016-03-29 13:25:43 -0400
committerHui Kang <kangh@us.ibm.com>2016-09-15 23:47:22 +0000
commit0d28b311eb351ab93518dea4355316fa9fa50a27 (patch)
tree1c77264042fbbfc717972d941fbc1ceede17869e /doc
parent97c99a92149c5a2d2e027486d55645c26f90ace8 (diff)
downloadkolla-0d28b311eb351ab93518dea4355316fa9fa50a27.tar.gz
kolla-0d28b311eb351ab93518dea4355316fa9fa50a27.zip
Add Kuryr ansible role3.0.0.0rc1
Change-Id: I7134bffab940ee780e5f5010d639af56f97b41d6 Co-authored-by: Mohammad Banikazemi <mb@us.ibm.com> Co-Authored-By: zhubingbing <zhubingbing10@gmail.com> Co-Authored-By: Antoni Segura Puimedon <antonisp@celebdor.com> Partially-implements: bp kuryr-docker-plugin
Diffstat (limited to 'doc')
-rw-r--r--doc/index.rst1
-rw-r--r--doc/kuryr-guide.rst63
2 files changed, 64 insertions, 0 deletions
diff --git a/doc/index.rst b/doc/index.rst
index ae313d412..ed72c05d3 100644
--- a/doc/index.rst
+++ b/doc/index.rst
@@ -59,6 +59,7 @@ Kolla Services
swift-guide
kibana-guide
bifrost
+ kuryr-guide
Developer Docs
==============
diff --git a/doc/kuryr-guide.rst b/doc/kuryr-guide.rst
new file mode 100644
index 000000000..6303a53d6
--- /dev/null
+++ b/doc/kuryr-guide.rst
@@ -0,0 +1,63 @@
+Kuryr in Kolla
+==============
+
+"Kuryr is a Docker network plugin that uses Neutron to provide networking
+services to Docker containers. It provides containerized images for the common
+Neutron plugins" [1]. Kuryr requires at least Keystone and neutron. Kolla makes
+kuryr deployment faster and accessible.
+
+Requirements
+------------
+
+* A minimum of 3 hosts for a vanilla deploy
+
+Preparation and Deployment
+--------------------------
+
+To allow docker daemon connect to the etcd, add the following in the docker.server
+file.
+
+::
+
+ ExecStart= -H tcp://172.16.1.13:2375 -H unix:///var/run/docker.sock --cluster-store=etcd://172.16.1.13:2379 --cluster-advertise=172.16.1.13:2375
+
+The IP address is host runnning the etcd service. ```2375``` is port that allows
+Docker daemon to be accessed remotely. ```2379``` is the etcd listening port.
+
+
+By default etcd and kuryr are disabled in the ``group_vars/all.yml``. In order to
+enable them, you need to edit the file globals.yml and set the following
+variables
+
+::
+
+ enable_etcd: "yes"
+ enable_kuryr: "yes"
+
+Deploy the OpenStack cloud and kuryr network plugin
+
+::
+
+ kolla-ansible deploy
+
+Create a Virtual Network
+--------------------------------
+
+::
+
+ docker network create -d kuryr --ipam-driver=kuryr --subnet=10.1.0.0/24 --gateway=10.1.0.1 docker-net1
+
+To list the created network:
+
+::
+
+ docker network ls
+
+The created network is also available from openstack CLI:
+
+::
+
+ openstack network list
+
+
+[1] https://github.com/openstack/kuryr