f9e3d6ea35
1. What is the problem Currently no configuration guide in the Tricircle. 2. What is the solution to the problem This patch adds configuration guide for the Tricircle. Only the configuration items of Tricircle will be described here. Logging, messaging, database, keystonemiddleware etc configuration which are generated from OpenStack OSLO libary, will not be described here. 3. What the features need to be implemented to the Tricircle to realize the solution None Change-Id: I73c972c60ef43f8cca394af6a1b52cd5751a0f8b Closes-Bug: #1652738
57 lines
2.8 KiB
ReStructuredText
57 lines
2.8 KiB
ReStructuredText
========================
|
|
Team and repository tags
|
|
========================
|
|
|
|
.. image:: http://governance.openstack.org/badges/tricircle.svg
|
|
:target: http://governance.openstack.org/reference/tags/index.html
|
|
|
|
.. Change things from this point on
|
|
|
|
=========
|
|
Tricircle
|
|
=========
|
|
|
|
The purpose of the Tricircle project is to provide networking automation
|
|
across Neutron servers in multi-region OpenStack clouds deployment.
|
|
|
|
Each OpenStack cloud includes its own Nova, Cinder and Neutron, the Neutron
|
|
servers in these OpenStack clouds are called local Neuron servers, all these
|
|
local Neutron servers will be configured with the Tricircle Local Neutron
|
|
Plugin. A separate Neutron server will be installed and run standalone as
|
|
the coordinator of networking automation across local Neutron servers, this
|
|
Neutron server will be configured with the Tricircle Central Neutron Plugin,
|
|
and is called central Neutron server.
|
|
|
|
Leverage the Tricircle Central Neutron Plugin and the Tricircle Local Neutron
|
|
Plugin configured in these Neutron servers, the Tricircle can ensure the
|
|
IP address pool, IP/MAC address allocation and network segment allocation
|
|
being managed globally without conflict, and the Tricircle handles tenant
|
|
oriented data link layer(Layer2) or network layer(Layer3) networking
|
|
automation across local Neutron servers, resources like VMs, bare metal or
|
|
containers of the tenant can communicate with each other via Layer2 or Layer3,
|
|
no matter in which OpenStack cloud these resources are running on.
|
|
|
|
Note: There are some our own definitions of Layer2/Layer3 networking
|
|
across Neutron. To make sure what they are, please read our design
|
|
documentation, especially "6.5 L2 Networking across Neutron". The wiki and
|
|
design documentation are linked below.
|
|
|
|
The Tricircle and multi-region OpenStack clouds will use shared
|
|
KeyStone(with centralized or distributed deployment) or federated KeyStones.
|
|
|
|
The Tricircle source code is distributed under the terms of the Apache
|
|
License, Version 2.0. The full terms and conditions of this license are
|
|
detailed in the LICENSE file.
|
|
|
|
* Free software: Apache license
|
|
* Design documentation: `Tricircle Design Blueprint <https://docs.google.com/document/d/1zcxwl8xMEpxVCqLTce2-dUOtB-ObmzJTbV1uSQ6qTsY/>`_
|
|
* Wiki: https://wiki.openstack.org/wiki/tricircle
|
|
* Installation guide: http://docs.openstack.org/developer/tricircle/installation-guide.html
|
|
* Tricircle Admin API documentation: http://docs.openstack.org/developer/tricircle/api_v1.html
|
|
* Configuration guide: http://docs.openstack.org/developer/tricircle/configuration.html
|
|
* Source: http://git.openstack.org/cgit/openstack/tricircle
|
|
* Bugs: http://bugs.launchpad.net/tricircle
|
|
* Blueprints: https://blueprints.launchpad.net/tricircle
|
|
* Release notes: https://github.com/openstack/tricircle/tree/master/releasenotes/notes
|
|
* Contributing: http://docs.openstack.org/developer/tricircle/contributing.html
|