# Managing Clusters

Clusters are first-class citizens in Senlin service design. A cluster is defined as a collection of homogeneous objects. The “homogeneous” here means that the objects managed (aka. Nodes) have to be instantiated from the same “profile type”.

## List Clusters

To examine the list of receivers:

When listing clusters, you can specify the sorting option using the `sort` parameter and you can do pagination using the `limit` and `marker` parameters.

Full example: manage cluster

## Create Cluster

When creating a cluster, you will provide a dictionary with keys and values according to the cluster type referenced.

Optionally, you can specify a `metadata` keyword argument that contains some key-value pairs to be associated with the cluster.

Full example: manage cluster

## Get Cluster

To get a cluster based on its name or ID:

Full example: manage cluster

## Find Cluster

To find a cluster based on its name or ID:

Full example: manage cluster

## Update Cluster

After a cluster is created, most of its properties are immutable. Still, you can update a cluster’s `name` and/or `params`.

Full example: manage cluster

## Delete Cluster

A cluster can be deleted after creation, When there are nodes in the cluster, the Senlin engine will launch a process to delete all nodes from the cluster and destroy them before deleting the cluster object itself.

## Add Nodes to Cluster

Add some existing nodes into the specified cluster.

## Remove Nodes from Cluster

Remove nodes from specified cluster.

## Replace Nodes in Cluster

Replace some existing nodes in the specified cluster.

## Cluster Scale Out

Inflate the size of a cluster.

## Cluster Scale In

Shrink the size of a cluster.

## Cluster Resize

Resize of cluster.

## Attach Policy to Cluster

Once a policy is attached (bound) to a cluster, it will be enforced when related actions are performed on that cluster, unless the policy is (temporarily) disabled on the cluster

## Detach Policy from Cluster

Once a policy is attached to a cluster, it can be detached from the cluster at user’s request.

## Cluster Check

Check cluster health status, Cluster members can be check.

## Cluster Recover

To restore a specified cluster, members in the cluster will be checked.

this page last updated: 2026-01-16 23:06:19

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