## Welcome to the Senlin documentation!

updated: 2020-10-17 18:54

# Welcome to the Senlin documentation!

## 1 Introduction

Senlin is a service to create and manage Cluster of multiple cloud resources. Senlin provides an OpenStack-native REST API and a AWS AutoScaling-compatible Query API is in plan.

- Overview
- Installing Senlin
- Senlin Configuration

## 2 Tutorial

This tutorial walks you through the Senlin features step-by-step. For more details, please check the 3 User References section.

- Senlin Basics
- Working with Policies
- Working with Receivers
- Making Your Cluster Elastic

## 3 User References

This section provides a detailed documentation for the concepts and built-in policy types.

### 3.1 Basic Concepts

- Profile Types
- Profiles
- Clusters
- Nodes
- Cluster Membership
- Policy Types
- Policies
- Cluster-Policy Bindings
- Receiver
- Actions
- Events

### 3.2 Built-in Policy Types

The senlin service is released with some built-in policy types that target some common use cases. You can develop and deploy your own policy types by following the instructions in the 5. Developer’s Guide section.

The following is a list of builtin policy types:

- Affinity Policy
- Batch Policy
- Deletion Policy
- Health Policy
- Load-Balancing Policy
- Scaling Policy
- Region Placement Policy
- Zone Placement Policy

### 3.3 Built-in Profile Types

The senlin service is released with some built-in profile types that target some common use cases. You can develop and deploy your own profile types by following the instructions in the 5. Developer’s Guide section.

The following is a list of builtin profile types:

- Nova Profile
- Stack Profile
- Docker Profile

## 4 Usage Scenarios

This section provides some guides for typical usage scenarios. More scenarios are to be added.

### 4.1 Managing Node Affinity

Senlin provides an Affinity Policy for managing node affinity. This section contains a detailed introduction on how to use it.

- Managing Node Affinity

### 4.2 Building AutoScaling Clusters

- Support to AutoScaling
- Autoscaling using Ceilometer/Aodh
- Autoscaling with Heat

## 5. Developer’s Guide

This section targets senlin developers.

### 5.1 Understanding the Design

- API Microversioning
- Senlin Authorization
- Profiles
- Clusters
- Nodes
- Policies
- Actions
- Receiver
- Senlin testing
- Plugin Writer’s Guide
- OSProfiler

### 5.2 Built-in Policy Types

Senlin provides some built-in policy types which can be instantiated and then attached to your clusters. These policy types are designed to be orthogonal so that each of them can be used independently. They are also expected to work in a collaborative way to meet the needs of complicated usage scenarios.

- Affinity Policy V1.0
- Deletion Policy V1.1
- Health Policy V1.1
- Load Balancing Policy V1.1
- Region Placement Policy V1.0
- Scaling Policy V1.0
- Zone Placement Policy V1.0

### 5.3 Reviewing Patches

There are many general guidelines across the community about code reviews, for example:

- Code review guidelines (wiki)

- OpenStack developer’s guide

Besides these guidelines, senlin has some additional amendments based on daily review experiences that should be practiced.

- Reviews

## 6 Administering Senlin

- Administering Senlin

## 7 References

- Man Pages
- Glossary
- API Documentation

### Indices and tables

- Index

- Search Page

updated: 2020-10-17 18:54

Except where otherwise noted, this document is licensed under Creative Commons Attribution 3.0 License. See all OpenStack Legal Documents.

questions?