openstack.cluster.v1.Cluster

openstack.cluster.v1.Cluster

The Cluster Class

The Cluster class inherits from Resource.

class openstack.cluster.v1.cluster.Cluster(attrs=None, loaded=False)

Construct a Resource to interact with a service’s REST API.

The Resource class offers two class methods to construct resource objects, which are preferrable to entering through this initializer. See Resource.new() and Resource.existing().

Parameters:
  • attrs (dict) – The attributes to set when constructing this Resource.
  • loaded (bool) – True if this Resource exists on the server, False if it does not.
name = None

The name of the cluster.

profile_id = None

The ID of the profile used by this cluster.

user_id = None

The ID of the user who created this cluster, thus the owner of it.

project_id = None

The ID of the project this cluster belongs to.

domain_id = None

The domain ID of the cluster owner.

parent_id = None

The ID of the parent cluster (if any).

init_at = None

Timestamp of when the cluster was initialized.

created_at = None

Timestamp of when the cluster was created.

updated_at = None

Timestamp of when the cluster was last updated.

min_size = None

Lower bound (inclusive) for the size of the cluster.

max_size = None

Upper bound (inclusive) for the size of the cluster. A value of -1 indicates that there is no upper limit of cluster size.

desired_capacity = None

Desired capacity for the cluster. A cluster would be created at the scale specified by this value.

timeout = None

Default timeout (in seconds) for cluster operations.

status = None

A string representation of the cluster status.

status_reason = None

A string describing the reason why the cluster in current status.

metadata = None

A collection of key-value pairs that are attached to the cluster.

data = None

A dictionary with some runtime data associated with the cluster.

node_ids = None

A list IDs of nodes that are members of the cluster.

profile_name = None

Name of the profile used by the cluster.

delete(session)

Delete the remote resource associated with this instance.

Parameters:session (Session) – The session to use for making this request.
Returns:The instance of the Cluster which was deleted.
Return type:Cluster.
Creative Commons Attribution 3.0 License

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