Difference between revisions of "Tricircle"

Revision as of 02:01, 18 September 2016

The Tricircle is to provide networking automation across Neutron in multi-region OpenStack deployment.

~~ Attention ~~

During the big-tent application of Tricircle: https://review.openstack.org/#/c/338796/, the proposal is to move API-gateway part away from Tricircle, and form two independent and decoupled projects:

Tricircle: Dedicated for cross Neutron networking automation in multi-region OpenStack deployment, run without or with Trio2o.

Trio2o: Dedicated to provide API gateway for those who need single Nova/Cinder API endpoint in multi-region OpenStack deployment, run without or with Tricircle.

The wiki for Tricircle before splitting is linked here: https://wiki.openstack.org/wiki/tricircle_before_splitting

Use Cases

Cloud Capacity Expansion

When one OpenStack cloud is provisioned with more and more resources, the capacity of one OpenStack instance may not be enough. A new openstack instance has to be added to the cloud. But tenants still want to add VMs to existing network. And they don’t want to add a new network, router or whatever required resources.

Application high availability running over cloud

In telecom and other industries(for example, MySQL Galera cluster), normally applications tend to be designed as Active-Active, Active-Passive or N-to-1 node configurations. Because those applications need to be available as much as possible. Once those applications are planned to be migrated to cloud infrastructure, active instance(s) need(s) to be deployed in one OpenStack instance first. After that, passive or active instances(s) will be deployed in another (other) OpenStack instance(s) in order for achieving 99.999% availability, if it’s required.

The reason why this deployment style is required is that in general cloud system only achieve 99.99% availability. [3] [4]

To achieve required high availability, design of network architecture (especially Layer 2 and 3) needs to be considered to use state replication, heartbeat.

The above picture shows an application with Galera DB cluster as backend which are geographically distributed into multiple OpenStack instances.

Isolation of East-West traffic

In financial industry, more than one OpenStack instances will be deployed, some OpenStack instance will be put in DMZ zone, and the other ones in trust zone, so that application or part of the application could be put in different level security zone. Although the tenant’s resources are provisioned in different OpenStack instances, east-west traffic among the tenant’s resources should be isolated.

Bandwidth sensitive, heavy load App like CAD modeling asked for the cloud close to the end user in each edge site, but the east-west communication with isolation between the tenant’s resources are also required.

Dual ISPs Load Balancing for internet link

Deploy application in separate OpenStack instance with dual ISPs for internet link redundancy, load balancing, east-west traffic isolation for data/state replication is needed.

Cross Neutron L2 network for NFV(Network Function Virtualization) area

IN NFV area, network functions like router, NAT, LB etc will be virtualized, The cross Neutron L2 networking capability like IP address space management, IP allocation and L2 network segment global management provided by the Tricircle can help VNFs(virtualized network function) across site inter-connection. For example, vRouter1 in site1, but vRouter2 in site2, these two VNFs could be in one L2 network across site[5].

Architecture

Now the Tricircle is dedicated for networking automation across Neutron in multi-region OpenStack deployments. The design blueprint has been developed with ongoing improvement in https://docs.google.com/document/d/1zcxwl8xMEpxVCqLTce2-dUOtB-ObmzJTbV1uSQ6qTsY/,

Sared KeyStone (centralized or distributed deployment) or federated KeyStones could be used for identity management for the Tricrcle and multiple OpenStack instances.

• Tricircle Central Neutron Plugin

1. It runs under Neutron server in the same process like OVN/Dragonflow Neutron plugin.
2. The Tricircle Central Neutron Plugin serve for tenant level L2/L3 networking automation across multi-OpenStack instances.
3. In the Tricircle context, The Tricircle Central Neutron Plugin could be called “central plugin” for short.
4. The Neutron server with the Tricircle Central Neutron Plugin installed is also called “central Neutron” or “central Neutron server”.

• Tricircle Local Neutron Plugin

1. It runs under Neutron server in the same process like OVN/Dragonflow Neutron plugin.
2. The Tricircle Local Neutron Plugin serve for cross Neutron networking automation triggering.
3. In the Tricircle context, The Tricircle Local Neutron Plugin could be called “local plugin” for short.
4. The Neutron server with the Tricircle Local Neutron Plugin installed is also called “local Neutron” or “local Neutron server”. Nova/Cinder which work together with local Neutron also could be called local Nova/local Cinder, compared to the central Neutron.

• Admin API

1. Manage the mappings between OpenStack instances and availability zone.
2. Retrieve object uuid routing.
3. Expose API for maintenance.

• XJob

1. Receive and process cross OpenStack functionalities and other async jobs from Admin API or Tricircle Central Neutron Plugin.
2. For example, when booting an instance for the first time for the project, router, security group rule, FIP and other resources may have not already been created in the bottom OpenStack instance. But it’s required. Not like network,security group, ssh keypair, other resources they must be created before a instance booting. These resources could be created in async way to accelerate response for the first instance booting request.
3. Admin API, Tricircle Central Neutron plugin could send an async job to XJob through message bus with RPC API provided by XJob.

• Database

1. The Tricircle has its own database to store pods, jobs, resource routing tables.
2. Tricircle Neutron Central Plugin will reuse DB of Neutron, for one tenant’s network, router will be spread into multiple pods, and managing tenant level IP/mac address.
3. Tricircle Neutron Locall Plugin is a shim layer between real core plugin and Neutron API server, so Neutron DB will be still there for Neutron API server and real core plugin.

For Glance deployment, there are several choice:

• Shared Glance, if all OpenStack instances are located inside a high bandwidth, low latency site.
• Shared Glance with distributed back-end, if OpenStack instances are located in several sites.
• Distributed Glance deployment, Glance service is deployed distributed in multiple site with distributed back-end
• Separate Glance deployment, each site is installed with separate Glance instance and back-end, no cross site image sharing is needed.

Value

The motivation to develop the Tricircle open source project is to meet the demands which are required in the use cases mentioned above:

• Leverage Neutron API for cross Neutron networking automation, eco-system like CLI, SDK, Heat, Murano, Magum etc, all of these could be reserved seamlessly.
• support modularized capacity expansion in large scale cloud, just add more and more OpenStack instance, and these OpenStack instances are inter-connected in tenant level.
• L2/L3 networking automation across OpenStack instances.
• Tenant's VMs communicate with each other via L2 or L3 networking across OpenStack instances.
• Security group applied across OpenStack instances.
• Tenant level IP/mac addresses management to avoid conflict across OpenStack instances.
• Tenant level quota control across OpenStack instances.

Installation and Play

Set up the Tricircle in 3 VMs with virtualbox in Ubuntu 14.04 LTS. Install Tricircle in VirtualBox.
Or refer to installation guide in https://github.com/openstack/tricircle for single node/two nodes setup using devstack.

How to read the source code

To read the source code, it's much easier if you follow this blueprint:

Implement Stateless Architecture: https://blueprints.launchpad.net/tricircle/+spec/implement-stateless

This blueprint is to build Tricircle from scratch

Resources

• Design documentation: Tricircle Design Blueprint
• Wiki: https://wiki.openstack.org/wiki/tricircle
• Source: https://github.com/openstack/tricircle
• Bugs: http://bugs.launchpad.net/tricircle
• Blueprints: https://launchpad.net/tricircle
• Review Board: https://review.openstack.org/#/q/project:openstack/tricircle
• Weekly meeting IRC channel: #openstack-meeting, irc.freenode.net on every Wednesday starting from UTC 13:00 to UTC 14:00
• Weekly meeting IRC log: https://wiki.openstack.org/wiki/Meetings/Tricircle
• Tricircle project IRC channel: #openstack-tricircle on irc.freenode.net
• Tricircle project IRC channel log: http://eavesdrop.openstack.org/irclogs/%23openstack-tricircle/
• Mail list: openstack-dev@lists.openstack.org, with [openstack-dev][tricircle] in the mail subject
• New contributor's guide: http://docs.openstack.org/infra/manual/developers.html
• Documentation: http://docs.openstack.org/developer/tricircle

• Tricircle big-tent application defense: https://review.openstack.org/#/c/338796 (A lots of comment and discussion to learn about Tricircle from many aspects)

Tricircle is designed to use the same tools for submission and review as other OpenStack projects. As such we follow the OpenStack development workflow. New contributors should follow the getting started steps before proceeding, as a Launchpad ID and signed contributor license are required to add new entries.

Meeting minutes and logs

all meeting logs and minutes could be found in
2016: http://eavesdrop.openstack.org/meetings/tricircle/2016/
2015: http://eavesdrop.openstack.org/meetings/tricircle/2015/

To do list

To do list is in the etherpad: https://etherpad.openstack.org/p/TricircleToDo

Splitting Tricircle into two projects: https://etherpad.openstack.org/p/TricircleSplitting

Team Member

Contact team members in IRC channel: #openstack-tricircle

Current active participants

Joe Huang, Huawei

Khayam Gondal, Dell

Shinobu Kinjo, RedHat

Ge Li, China UnionPay

Vega Cai, Huawei

Pengfei Shi, OMNI Lab

Bean Zhang, OMNI Lab

Yipei Niu, Huazhong University of Science and Technology

Ronghui Cao, Hunan University

Xiongqiu Long, Hunan University

Zhuo Tang, Hunan University

Liuzyu, Hunan University

Jiawei He, Hunan University

KunKun Liu, Hunan University

Yangkai Shi, Hunan University

Yuquan Yue, Hunan University

Howard Huang, Huawei