4.8 KiB
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 install configuration
2 Tutorial
This tutorial walks you through the Senlin features step-by-step. For
more details, please check the user-references section.
tutorial/basics tutorial/policies tutorial/receivers tutorial/autoscaling
3 User References
This section provides a detailed documentation for the concepts and built-in policy types.
3.1 Basic Concepts
user/profile_types user/profiles user/clusters user/nodes user/membership user/policy_types user/policies user/bindings user/receivers user/actions user/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 developer-guide section.
The following is a list of builtin policy types:
user/policy_types/affinity user/policy_types/deletion user/policy_types/load_balancing user/policy_types/scaling user/policy_types/region_placement user/policy_types/zone_placement
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 <user/policy_types/affinity> for
managing node affinity. This section contains a detailed introduction on
how to use it.
scenarios/affinity
4.2 Building AutoScaling Clusters
scenarios/autoscaling_overview scenarios/autoscaling_ceilometer scenarios/autoscaling_heat
5. Developer's Guide
This section targets senlin developers.
5.1 Understanding the Design
developer/api_microversion developer/authorization developer/profile developer/cluster developer/node developer/policy developer/action developer/receiver developer/testing developer/plugin_guide developer/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.
developer/policies/affinity_v1 developer/policies/deletion_v1 developer/policies/health_v1 developer/policies/load_balance_v1 developer/policies/region_v1 developer/policies/scaling_v1 developer/policies/zone_v1
5.3 Reviewing Patches
There are many general guidelines across the community about code reviews, for example:
Besides these guidelines, senlin has some additional amendments based on daily review experiences that should be practiced.
developer/reviews
6 References
6.1 API Documentation
Follow the link below for the Senlin API V1 specification:
6.2 Man Pages
man/index
6.3 Glossary
glossary
Indices and tables
genindexsearch