Jump to: navigation, search

Difference between revisions of "Senlin"

(Get Involved)
(Get Involved)
 
(14 intermediate revisions by 2 users not shown)
Line 1: Line 1:
 
__NOTOC__
 
__NOTOC__
 +
 +
[[File:OpenStack_Project_Senlin_Horizontal.png|right]]
  
 
== Overview ==
 
== Overview ==
  
The mission of the Senlin project is to provide a generic clustering service for an OpenStack cloud. Such a service is capable of managing the homogeneous objects exposed by other OpenStack components, such as Nova, Heat, Cinder etc.
+
Senlin is a clustering service for OpenStack clouds. It creates and operates clusters of homogeneous objects exposed by other OpenStack services. The goal is to make orchestration of collections of similar objects easier.
 +
 
 +
Senlin interacts with other OpenStack services so that clusters of resources exposed by those services can be created and operated. These interactions are mostly done through the via profile plugins. Each profile type implementation enable Senlin to create, update, delete a specific type of resources.
 +
 
 +
A Cluster can be associated with different Policy objects that can be checked/enforced at varying enforcement levels. Through service APIs, a user can dynamically add Node to and remove node from a cluster, attach and detach policies, such as creation policy, deletion policy, load-balancing policy, scaling policy, health policy etc. Through integration with other OpenStack projects, users will be enabled to manage deployments and orchestrations large-scale resource pools much easier.
 +
 
 +
Senlin is designed to be capable of managing different types of objects. An object’s lifecycle is managed using Profile Type implementations, which are plugins that can be dynamically loaded by the service engine.
  
 
=== Features Highlight ===
 
=== Features Highlight ===
Line 10: Line 18:
  
 
* A generic clustering/collection service for managing groups of homogeneous cloud objects on OpenStack.
 
* A generic clustering/collection service for managing groups of homogeneous cloud objects on OpenStack.
* A set of [http://developer.openstack.org/api-ref-clustering-v1.html APIs] for managing cluster membership, e.g. add/remove nodes.
+
* A set of [http://developer.openstack.org/api-ref/clustering APIs] for managing cluster membership, e.g. add/remove nodes.
 
* A plugin-based object profile management enabling the creation and management of any object pools.
 
* A plugin-based object profile management enabling the creation and management of any object pools.
 
* A plugin-based policy enforcement framework featuring flexible policy customization for cluster management.
 
* A plugin-based policy enforcement framework featuring flexible policy customization for cluster management.
 +
* A plugin-based event notification that allows for dumping or pumping cluster actions to storage or downstream software.
 
* A asynchronous execution engine for ensuring the state consistency of clusters and nodes.
 
* A asynchronous execution engine for ensuring the state consistency of clusters and nodes.
* A open design for action execution that can be extended to accommodate complex application deployment.
 
  
 
== Architecture ==
 
== Architecture ==
Line 27: Line 35:
 
* The ''senlin-engine'' service sits behind the ''senlin-api'' service and operates on the clusters/nodes, using ''profiles'' and ''policies'' that are loaded as plugins.
 
* The ''senlin-engine'' service sits behind the ''senlin-api'' service and operates on the clusters/nodes, using ''profiles'' and ''policies'' that are loaded as plugins.
  
== Terminologies ==
+
== Usage Scenarios ==
  
===== ¤ Cluster =====
+
Below are some typical usage scenarios of the Senlin service. More scenarios will be added later.
Senlin provides a clustering service to create and manage objects of the same nature, e.g. Nova servers, Heat stacks, Cinder volumes, etc. The collection of these objects is referred to as a ''cluster''.
 
  
===== ¤ Nodes =====
+
* [http://docs.openstack.org/developer/senlin/scenarios/affinity.html Managing Node Affinity]
Senlin abstracts the physical objects as ''nodes'', which can belong to any cluster of the same ''profile type''.
+
* [http://docs.openstack.org/developer/senlin/scenarios/autoscaling_ceilometer.html AutoScaling using Ceilometer/Aodh]
 +
* [http://docs.openstack.org/developer/senlin/scenarios/autoscaling_heat.html AutoScaling using Heat Resource Types]
  
===== ¤ Profiles =====
+
== Documentation ==
Senlin supports object creation, deletion and update via a concept called ''Profile''. Each profile is in essential a driver to communicate with certain services for object manipulation.
 
  
[[file:senlin-profiles.png]]
+
* [http://docs.openstack.org/developer/senlin/#install-and-configuration Installation Guide]
 +
* [http://docs.openstack.org/developer/senlin/#tutorial Tutorial]
 +
* [http://docs.openstack.org/developer/senlin/#user-references User References]
 +
* [http://docs.openstack.org/developer/senlin/#developer-s-guide Developer Documents]
 +
* [http://developer.openstack.org/api-ref/clustering API Version 1.0 Reference]
  
===== ¤ Policies =====
+
== Related Presentations ==
With Senlin, user can attach a ''policy'' to a cluster and enforce it, or detach it from a cluster. Some [[senlin/policies|built-in policies]] are provided to meet requirements such as auto-scaling, load-balancing, high-availability etc.
 
  
[[file:senlin-policies.png]]
+
* [http://www.slideshare.net/cliffton75/high-availability-in-openstack-cloud Enhancing high availability in the context of OpenStack], Atlanta Summit, 2014
 +
  - A taxonomy of architecting high-availability into an OpenStack cloud.
 +
  - The then current status of OpenStack support to HA.
 +
  - A proposed service (HAaaS) which layed the foundation for Senlin's cluster design.
 +
* [http://www.slideshare.net/cliffton75/suning-openstack-cloud-and-heat Suning cloud and Heat], Paris Summit, 2014
 +
  - Experience sharing on using OpenStack for an online retailer
 +
  - Requirements on orchestrating enterprise applications: clustering, scaling, HA ...
 +
  - Gaps identified in the then current status of OpenStack services
 +
* [http://www.slideshare.net/cliffton75/vm-ha-and-crossregion-scaling VM HA and cross-region autoscaling], Paris Summit, 2014
 +
  - How VM HA can be achieved by integrating OpenStack services.
 +
  - How to scale a VM cluster across multiple regions.
 +
* [http://www.slideshare.net/cliffton75/senlin-deep-dive-2015-0520 Senlin design discussion], Vancouver Design Summit, 2015
 +
  - A discussion on Heat design summit about senlin service design
 +
  - How the service is architected, the terminology behind it
 +
  - How auto-scaling can be achieved in this design
 +
* [http://www.slideshare.net/cliffton75/autoscaling-with-magnum-and-senlin Integration Magnum and Senlin for container autoscaling], Tokyo Summit, 2015
 +
  - Experience sharing on integrating Magnum and Senlin
 +
  - Magnum provisions the container orchestration engines (COEs)
 +
  - Senlin is responsible to scale the container clusters and the underlying VM clusters.
 +
* [http://www.slideshare.net/cliffton75/senlin-deep-dive-2016 Senlin deep dive for v1.0.0 release], Austin Summit, 2016
 +
  - An overview of the Senlin service design as of the 1.0.0 release.
 +
  - A summary of progress made during Mitaka cycle.
 +
  - An overlook of features planned for Newton cycle.
 +
* [http://www.slideshare.net/cliffton75/managing-container-clusters-in-openstack-native-way OpenStack native container clustering], Austin Summit, 2016
 +
  - A technology preview of the container clustering support in Senlin
 +
  - The discussion focuses on the on-going effort that builds and manages a docker cluster on OpenStack
 +
* [http://www.slideshare.net/cliffton75/deploy-an-elastic-resilient-loadbalanced-cluster-in-5-minutes-with-senlin Elastic, resilient and load-balanced cluster in 5 mins], Austin Summit, 2016
 +
  - Experiences sharing how elasticity, resiliency and load-balancing can be achieved using Senlin
 +
  - The demo shows how the above requirements are met using a Heat template consisting of Senlin resource types.
 +
* on-building-an-auto-healing-resource-cluster-using-senlin [https://www.openstack.org/videos/barcelona-2016/on-building-an-auto-healing-resource-cluster-using-senlin], Barcelona, 2016
 +
* managing-clusters-of-thousands-of-vms-using-senlin [https://www.openstack.org/videos/barcelona-2016/managing-clusters-of-thousands-of-vms-using-senlin], Barcelona, 2016
 +
* integration-of-enterprise-monitoring-product-senlin-and-mistral-for-auto-healing [https://www.openstack.org/videos/boston-2017/integration-of-enterprise-monitoring-product-senlin-and-mistral-for-auto-healing], Boston, 2017
  
== Documentation ==
+
*high-availablity-and-scalability-management-of-vnf [https://www.openstack.org/videos/boston-2017/high-availablity-and-scalability-management-of-vnf], Boston, 2017
* [http://docs.openstack.org/developer/senlin/install.html Installation Guide]
+
 
* [http://docs.openstack.org/developer/senlin/user/index.html Getting Started]
+
* senlin-an-ideal-bridge-between-nfv-orchestrator-and-openstack[https://www.openstack.org/videos/boston-2017/senlin-an-ideal-bridge-between-nfv-orchestrator-and-openstack], Boston, 2017
* [http://developer.openstack.org/api-ref-clustering-v1.html API Reference]
+
 
 +
* standing-up-kubernetes-on-openstack-is-cool-then-what [https://www.openstack.org/videos/sydney-2017/standing-up-kubernetes-on-openstack-is-cool-then-what], Sydeny Summit, 2017
  
 
== Get Involved ==
 
== Get Involved ==
* Projects on Launchpad
+
 
 
{| class="wikitable"
 
{| class="wikitable"
 
|-
 
|-
Line 68: Line 110:
 
| Mailinglist || Drop emails to [http://lists.openstack.org/cgi-bin/mailman/listinfo/openstack-dev openstack-dev] with tag <code>[Senlin]</code> in the subject.
 
| Mailinglist || Drop emails to [http://lists.openstack.org/cgi-bin/mailman/listinfo/openstack-dev openstack-dev] with tag <code>[Senlin]</code> in the subject.
 
|-
 
|-
| Weekly Meetings || 1300UTC every Tuesday on #openstack-meeting channel. <br />
+
| Weekly Meetings || 0530UTC biweekly-even:Friday on #openstack-meeting channel. <br />
 
[https://wiki.openstack.org/wiki/Meetings/SenlinAgenda Agenda] [http://eavesdrop.openstack.org/meetings/senlin/2015/ 2015 Minutes Archive] [http://eavesdrop.openstack.org/meetings/senlin/2016/ 2016 Minutes Archive]
 
[https://wiki.openstack.org/wiki/Meetings/SenlinAgenda Agenda] [http://eavesdrop.openstack.org/meetings/senlin/2015/ 2015 Minutes Archive] [http://eavesdrop.openstack.org/meetings/senlin/2016/ 2016 Minutes Archive]
 
|}
 
|}

Latest revision as of 05:52, 6 May 2019


OpenStack Project Senlin Horizontal.png

Overview

Senlin is a clustering service for OpenStack clouds. It creates and operates clusters of homogeneous objects exposed by other OpenStack services. The goal is to make orchestration of collections of similar objects easier.

Senlin interacts with other OpenStack services so that clusters of resources exposed by those services can be created and operated. These interactions are mostly done through the via profile plugins. Each profile type implementation enable Senlin to create, update, delete a specific type of resources.

A Cluster can be associated with different Policy objects that can be checked/enforced at varying enforcement levels. Through service APIs, a user can dynamically add Node to and remove node from a cluster, attach and detach policies, such as creation policy, deletion policy, load-balancing policy, scaling policy, health policy etc. Through integration with other OpenStack projects, users will be enabled to manage deployments and orchestrations large-scale resource pools much easier.

Senlin is designed to be capable of managing different types of objects. An object’s lifecycle is managed using Profile Type implementations, which are plugins that can be dynamically loaded by the service engine.

Features Highlight

The primary features of the Senlin service are listed below:

  • A generic clustering/collection service for managing groups of homogeneous cloud objects on OpenStack.
  • A set of APIs for managing cluster membership, e.g. add/remove nodes.
  • A plugin-based object profile management enabling the creation and management of any object pools.
  • A plugin-based policy enforcement framework featuring flexible policy customization for cluster management.
  • A plugin-based event notification that allows for dumping or pumping cluster actions to storage or downstream software.
  • A asynchronous execution engine for ensuring the state consistency of clusters and nodes.

Architecture

The following picture depicts the high-level system architecture of the Senlin service:

Senlin-architecture.png

The main components in the picture are:

  • The senlinclient component provides the command line interface (CLI) for users to interact with the Senlin service;
  • The senlin-api service provides the RESTful APIs for the senlinclient component or other services;
  • The senlin-engine service sits behind the senlin-api service and operates on the clusters/nodes, using profiles and policies that are loaded as plugins.

Usage Scenarios

Below are some typical usage scenarios of the Senlin service. More scenarios will be added later.

Documentation

Related Presentations

 - A taxonomy of architecting high-availability into an OpenStack cloud.
 - The then current status of OpenStack support to HA.
 - A proposed service (HAaaS) which layed the foundation for Senlin's cluster design.
 - Experience sharing on using OpenStack for an online retailer
 - Requirements on orchestrating enterprise applications: clustering, scaling, HA ...
 - Gaps identified in the then current status of OpenStack services
 - How VM HA can be achieved by integrating OpenStack services.
 - How to scale a VM cluster across multiple regions.
 - A discussion on Heat design summit about senlin service design
 - How the service is architected, the terminology behind it
 - How auto-scaling can be achieved in this design
 - Experience sharing on integrating Magnum and Senlin
 - Magnum provisions the container orchestration engines (COEs)
 - Senlin is responsible to scale the container clusters and the underlying VM clusters.
 - An overview of the Senlin service design as of the 1.0.0 release.
 - A summary of progress made during Mitaka cycle.
 - An overlook of features planned for Newton cycle.
 - A technology preview of the container clustering support in Senlin
 - The discussion focuses on the on-going effort that builds and manages a docker cluster on OpenStack
 - Experiences sharing how elasticity, resiliency and load-balancing can be achieved using Senlin
 - The demo shows how the above requirements are met using a Heat template consisting of Senlin resource types.
  • on-building-an-auto-healing-resource-cluster-using-senlin [1], Barcelona, 2016
  • managing-clusters-of-thousands-of-vms-using-senlin [2], Barcelona, 2016
  • integration-of-enterprise-monitoring-product-senlin-and-mistral-for-auto-healing [3], Boston, 2017
  • high-availablity-and-scalability-management-of-vnf [4], Boston, 2017
  • senlin-an-ideal-bridge-between-nfv-orchestrator-and-openstack[5], Boston, 2017
  • standing-up-kubernetes-on-openstack-is-cool-then-what [6], Sydeny Summit, 2017

Get Involved

Launchpad Projects Senlin SenlinClient SenlinDashboard
Code Repositories Senlin SenlinClient SenlinDashboard
Blueprints Senlin Blueprints
Code Review Senlin SenlinClient SenlinDashboard
Bug Tracking Senlin SenlinClient
IRC Channel #senlin on freenode.net
Mailinglist Drop emails to openstack-dev with tag [Senlin] in the subject.
Weekly Meetings 0530UTC biweekly-even:Friday on #openstack-meeting channel.

Agenda 2015 Minutes Archive 2016 Minutes Archive