[Docs] Added sample pillars to readme.
Change-Id: I5078bbf988a6638bd16bb9728ed9d349c8802daa
diff --git a/README.rst b/README.rst
index a539898..155f957 100644
--- a/README.rst
+++ b/README.rst
@@ -4,9 +4,537 @@
Contrail Controller is an open, standards-based software solution that delivers network virtualization and service automation for federated cloud networks. It provides self-service provisioning, improves network troubleshooting and diagnostics, and enables service chaining for dynamic application environments across enterprise virtual private cloud (VPC), managed Infrastructure as a Service (IaaS), and Networks Functions Virtualization (NFV) use cases.
+
Sample pillars
==============
+Controller nodes
+----------------
+
+There are several scenarios for OpenContrail control plane.
+
+All-in-one single
+~~~~~~~~~~~~~~~~~
+
+Config, control, analytics, database, web -- altogether on one node.
+
+.. code-block:: yaml
+
+ opencontrail:
+ common:
+ version: 2.2
+ source:
+ engine: pkg
+ address: http://mirror.robotice.cz/contrail-havana/
+ identity:
+ engine: keystone
+ host: 127.0.0.1
+ port: 35357
+ token: token
+ password: password
+ network:
+ engine: neutron
+ host: 127.0.0.1
+ port: 9696
+ config:
+ version: 2.2
+ enabled: true
+ network:
+ engine: neutron
+ host: 127.0.0.1
+ port: 9696
+ discovery:
+ host: 127.0.0.1
+ analytics:
+ host: 127.0.0.1
+ bind:
+ address: 127.0.0.1
+ message_queue:
+ engine: rabbitmq
+ host: 127.0.0.1
+ port: 5672
+ database:
+ members:
+ - host: 127.0.0.1
+ port: 9160
+ cache:
+ host: 127.0.0.1
+ identity:
+ engine: keystone
+ version: '2.0'
+ region: RegionOne
+ host: 127.0.0.1
+ port: 35357
+ user: admin
+ password: password
+ token: token
+ tenant: admin
+ members:
+ - host: 127.0.0.1
+ id: 1
+ control:
+ version: 2.2
+ enabled: true
+ bind:
+ address: 127.0.0.1
+ discovery:
+ host: 127.0.0.1
+ master:
+ host: 127.0.0.1
+ members:
+ - host: 127.0.0.1
+ id: 1
+ collector:
+ version: 2.2
+ enabled: true
+ bind:
+ address: 127.0.0.1
+ master:
+ host: 127.0.0.1
+ discovery:
+ host: 127.0.0.1
+ data_ttl: 2
+ database:
+ members:
+ - host: 127.0.0.1
+ port: 9160
+ database:
+ version: 2.2
+ cassandra:
+ version: 2
+ enabled: true
+ minimum_disk: 10
+ name: 'Contrail'
+ original_token: 0
+ data_dirs:
+ - /var/lib/cassandra
+ id: 1
+ discovery:
+ host: 127.0.0.1
+ bind:
+ host: 127.0.0.1
+ port: 9042
+ rpc_port: 9160
+ members:
+ - host: 127.0.0.1
+ id: 1
+ web:
+ version: 2.2
+ enabled: True
+ bind:
+ address: 127.0.0.1
+ analytics:
+ host: 127.0.0.1
+ master:
+ host: 127.0.0.1
+ cache:
+ engine: redis
+ host: 127.0.0.1
+ port: 6379
+ members:
+ - host: 127.0.0.1
+ id: 1
+ identity:
+ engine: keystone
+ version: '2.0'
+ host: 127.0.0.1
+ port: 35357
+ user: admin
+ password: password
+ token: token
+ tenant: admin
+
+
+All-in-one cluster
+~~~~~~~~~~~~~~~~~~
+
+Config, control, analytics, database, web -- altogether, clustered on multiple nodes.
+
+.. code-block:: yaml
+
+ opencontrail:
+ common:
+ version: 2.2
+ source:
+ engine: pkg
+ address: http://mirror.robotice.cz/contrail-havana/
+ identity:
+ engine: keystone
+ host: 127.0.0.1
+ port: 35357
+ token: token
+ password: password
+ network:
+ engine: neutron
+ host: 127.0.0.1
+ port: 9696
+ config:
+ version: 2.2
+ enabled: true
+ network:
+ engine: neutron
+ host: 127.0.0.1
+ port: 9696
+ discovery:
+ host: 127.0.0.1
+ analytics:
+ host: 127.0.0.1
+ bind:
+ address: 127.0.0.1
+ message_queue:
+ engine: rabbitmq
+ host: 127.0.0.1
+ port: 5672
+ database:
+ members:
+ - host: 127.0.0.1
+ port: 9160
+ - host: 127.0.0.1
+ port: 9160
+ - host: 127.0.0.1
+ port: 9160
+ cache:
+ host: 127.0.0.1
+ identity:
+ engine: keystone
+ version: '2.0'
+ region: RegionOne
+ host: 127.0.0.1
+ port: 35357
+ user: admin
+ password: password
+ token: token
+ tenant: admin
+ members:
+ - host: 127.0.0.1
+ id: 1
+ - host: 127.0.0.1
+ id: 2
+ - host: 127.0.0.1
+ id: 3
+ control:
+ version: 2.2
+ enabled: true
+ bind:
+ address: 127.0.0.1
+ discovery:
+ host: 127.0.0.1
+ master:
+ host: 127.0.0.1
+ members:
+ - host: 127.0.0.1
+ id: 1
+ - host: 127.0.0.1
+ id: 2
+ - host: 127.0.0.1
+ id: 3
+ collector:
+ version: 2.2
+ enabled: true
+ bind:
+ address: 127.0.0.1
+ master:
+ host: 127.0.0.1
+ discovery:
+ host: 127.0.0.1
+ data_ttl: 1
+ database:
+ members:
+ - host: 127.0.0.1
+ port: 9160
+ - host: 127.0.0.1
+ port: 9160
+ - host: 127.0.0.1
+ port: 9160
+ database:
+ version: 2.2
+ cassandra:
+ version: 2
+ enabled: true
+ name: 'Contrail'
+ minimum_disk: 10
+ original_token: 0
+ data_dirs:
+ - /var/lib/cassandra
+ id: 1
+ discovery:
+ host: 127.0.0.1
+ bind:
+ host: 127.0.0.1
+ port: 9042
+ rpc_port: 9160
+ members:
+ - host: 127.0.0.1
+ id: 1
+ - host: 127.0.0.1
+ id: 2
+ - host: 127.0.0.1
+ id: 3
+ web:
+ version: 2.2
+ enabled: True
+ bind:
+ address: 127.0.0.1
+ master:
+ host: 127.0.0.1
+ analytics:
+ host: 127.0.0.1
+ cache:
+ engine: redis
+ host: 127.0.0.1
+ port: 6379
+ members:
+ - host: 127.0.0.1
+ id: 1
+ - host: 127.0.0.1
+ id: 2
+ - host: 127.0.0.1
+ id: 3
+ identity:
+ engine: keystone
+ version: '2.0'
+ host: 127.0.0.1
+ port: 35357
+ user: admin
+ password: password
+ token: token
+ tenant: admin
+
+
+Separated analytics from control and config
+~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+
+Config, control, database, web.
+
+.. code-block:: yaml
+
+ opencontrail:
+ common:
+ version: 2.2
+ identity:
+ engine: keystone
+ host: 127.0.0.1
+ port: 35357
+ token: token
+ password: password
+ network:
+ engine: neutron
+ host: 127.0.0.1
+ port: 9696
+ config:
+ version: 2.2
+ enabled: true
+ network:
+ engine: neutron
+ host: 127.0.0.1
+ port: 9696
+ discovery:
+ host: 127.0.0.1
+ analytics:
+ host: 127.0.0.1
+ bind:
+ address: 127.0.0.1
+ message_queue:
+ engine: rabbitmq
+ host: 127.0.0.1
+ port: 5672
+ database:
+ members:
+ - host: 127.0.0.1
+ port: 9160
+ - host: 127.0.0.1
+ port: 9160
+ - host: 127.0.0.1
+ port: 9160
+ cache:
+ host: 127.0.0.1
+ identity:
+ engine: keystone
+ version: '2.0'
+ region: RegionOne
+ host: 127.0.0.1
+ port: 35357
+ user: admin
+ password: password
+ token: token
+ tenant: admin
+ members:
+ - host: 127.0.0.1
+ id: 1
+ - host: 127.0.0.1
+ id: 2
+ - host: 127.0.0.1
+ id: 3
+ control:
+ version: 2.2
+ enabled: true
+ bind:
+ address: 127.0.0.1
+ discovery:
+ host: 127.0.0.1
+ master:
+ host: 127.0.0.1
+ members:
+ - host: 127.0.0.1
+ id: 1
+ - host: 127.0.0.1
+ id: 2
+ - host: 127.0.0.1
+ id: 3
+ database:
+ version: 127.0.0.1
+ cassandra:
+ version: 2
+ enabled: true
+ name: 'Contrail'
+ minimum_disk: 10
+ original_token: 0
+ data_dirs:
+ - /var/lib/cassandra
+ id: 1
+ discovery:
+ host: 127.0.0.1
+ bind:
+ host: 127.0.0.1
+ port: 9042
+ rpc_port: 9160
+ members:
+ - host: 127.0.0.1
+ id: 1
+ - host: 127.0.0.1
+ id: 2
+ - host: 127.0.0.1
+ id: 3
+ web:
+ version: 2.2
+ enabled: True
+ bind:
+ address: 127.0.0.1
+ analytics:
+ host: 127.0.0.1
+ master:
+ host: 127.0.0.1
+ cache:
+ engine: redis
+ host: 127.0.0.1
+ port: 6379
+ members:
+ - host: 127.0.0.1
+ id: 1
+ - host: 127.0.0.1
+ id: 2
+ - host: 127.0.0.1
+ id: 3
+ identity:
+ engine: keystone
+ version: '2.0'
+ host: 127.0.0.1
+ port: 35357
+ user: admin
+ password: password
+ token: token
+ tenant: admin
+
+
+Analytic nodes
+----------------
+
+Analytics and database on an analytic node(s)
+
+.. code-block:: yaml
+
+ opencontrail:
+ common:
+ version: 2.2
+ identity:
+ engine: keystone
+ host: 127.0.0.1
+ port: 35357
+ token: token
+ password: password
+ network:
+ engine: neutron
+ host: 127.0.0.1
+ port: 9696
+ collector:
+ version: 2.2
+ enabled: true
+ bind:
+ address: 127.0.0.1
+ master:
+ host: 127.0.0.1
+ discovery:
+ host: 127.0.0.1
+ data_ttl: 1
+ database:
+ members:
+ - host: 127.0.0.1
+ port: 9160
+ - host: 127.0.0.1
+ port: 9160
+ - host: 127.0.0.1
+ port: 9160
+ database:
+ version: 2.2
+ cassandra:
+ version: 2
+ enabled: true
+ name: 'Contrail'
+ minimum_disk: 10
+ original_token: 0
+ data_dirs:
+ - /var/lib/cassandra
+ id: 1
+ discovery:
+ host: 127.0.0.1
+ bind:
+ host: 127.0.0.1
+ port: 9042
+ rpc_port: 9160
+ members:
+ - host: 127.0.0.1
+ id: 1
+ - host: 127.0.0.1
+ id: 2
+ - host: 127.0.0.1
+ id: 3
+
+
+Compute nodes
+----------------
+
+Vrouter configuration on a compute node(s)
+
+.. code-block:: yaml
+
+ opencontrail:
+ common:
+ version: 2.2
+ identity:
+ engine: keystone
+ host: 127.0.0.1
+ port: 35357
+ token: token
+ password: password
+ network:
+ engine: neutron
+ host: 127.0.0.1
+ port: 9696
+ compute:
+ version: 2.2
+ enabled: True
+ discovery:
+ host: 127.0.0.1
+ interface:
+ address: 127.0.0.1
+ dev: eth0
+ gateway: 127.0.0.1
+ mask: /24
+ dns: 127.0.0.1
+ mtu: 9000
+
+
+
Keystone v3
-------------