Merge "Update README and setup description after splitting"
This commit is contained in:
commit
45a9bbb031
49
README.rst
49
README.rst
|
@ -2,33 +2,40 @@
|
|||
Tricircle
|
||||
=========
|
||||
|
||||
The Tricircle provides an OpenStack API gateway and networking automation
|
||||
funtionality to allow multiple OpenStack instances, spanning in one site or
|
||||
multiple sites or in hybrid cloud, to be managed as a single OpenStack cloud.
|
||||
The purpose of the Tricircle project is to provide networking automation
|
||||
across Neutron servers in multi-region OpenStack clouds deployment.
|
||||
|
||||
The Tricircle and these managed OpenStack instances will use shared KeyStone
|
||||
(with centralized or distributed deployment) or federated KeyStones for
|
||||
identity management.
|
||||
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 seperate 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.
|
||||
|
||||
The Tricircle presents one big region to the end user in KeyStone. And each
|
||||
OpenStack instance called a pod is a sub-region of the Tricircle in
|
||||
KeyStone, and usually not visible to end user directly.
|
||||
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.
|
||||
|
||||
The Tricircle acts as OpenStack API gateway, can handle OpenStack API calls,
|
||||
schedule one proper OpenStack instance if needed during the API calls handling,
|
||||
forward the API calls to the appropriate OpenStack instance, and deal with
|
||||
tenant level L2/L3 networking across OpenStack instances automatically. So it
|
||||
doesn't matter on which bottom OpenStack instance the VMs for the tenant are
|
||||
running, they can communicate with each other via L2 or L3.
|
||||
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 end user can see avaialbility zone(AZ) and use AZ to provision
|
||||
VM, Volume, even Network through the Tricircle. One AZ can include many
|
||||
OpenStack instances, the Tricircle can schedule and bind OpenStack instance
|
||||
for the tenant inside one AZ. A tenant's resources could be bound to multiple
|
||||
specific bottom OpenStack instances in one or multiple AZs automatically.
|
||||
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/18kZZ1snMOCD9IQvUKI5NVDzSASpw-QKj7l2zNqMEd3g/>`_
|
||||
* Design documentation: `Tricircle Design Blueprint <https://docs.google.com/document/d/1zcxwl8xMEpxVCqLTce2-dUOtB-ObmzJTbV1uSQ6qTsY/>`_
|
||||
* Wiki: https://wiki.openstack.org/wiki/tricircle
|
||||
* Installation with DevStack: https://github.com/openstack/tricircle/blob/master/doc/source/installation.rst
|
||||
* Tricircle Admin API documentation: https://github.com/openstack/tricircle/blob/master/doc/source/api_v1.rst
|
||||
|
|
|
@ -1,6 +1,6 @@
|
|||
[metadata]
|
||||
name = tricircle
|
||||
summary = the Tricircle provides an OpenStack API gateway and networking automation to allow multiple OpenStack instances, spanning in one site or multiple sites or in hybrid cloud, to be managed as a single OpenStack cloud
|
||||
summary = The Tricircle is to provide networking automation across Neutron in multi-region OpenStack deployments.
|
||||
description-file = README.rst
|
||||
author = OpenStack
|
||||
author-email = openstack-dev@lists.openstack.org
|
||||
|
|
Loading…
Reference in New Issue