otcextensions.sdk.css.v1.cluster¶
The CSS Cluster Class¶
The Cluster class inherits from
Resource.
- class otcextensions.sdk.css.v1.cluster.Cluster(_synchronized=False, connection=None, **attrs)¶
The base resource
- Parameters:
_synchronized (bool) – This is not intended to be used directly. See
new()andexisting().connection (openstack.connection.Connection) – Reference to the Connection being used. Defaults to None to allow Resource objects to be used without an active Connection, such as in unit tests. Use of
self._connectionin Resource code should protect itself with a check for None.
- base_path: str = '/clusters'¶
The base part of the URI for this resource.
- resources_key: ty.Optional[str] = 'clusters'¶
Plural form of key for resource.
- resource_key: ty.Optional[str] = 'cluster'¶
Singular form of key for resource.
- allow_create = True¶
Allow create operation for this resource.
- allow_list = True¶
Allow list operation for this resource.
- allow_delete = True¶
Allow delete operation for this resource.
- allow_fetch = True¶
Allow get operation for this resource.
- action_progress¶
Cluster behavior progress, which shows the progress of cluster creation and scaling in percentage.
- actions¶
Current behavior of a cluster.
- admin_pwd¶
Password of the cluster user admin in security mode.
- backup_strategy¶
Automatic snapshot creation.
- bandwidth_size¶
Public network bandwidth.
- cmk_id¶
KMS Key ID.
- created_at¶
Cluster creation time.
- datastore¶
Type of the data search engine.
- disk_encryption¶
Whether disks are encrypted.
- elb_whitelist¶
Public network access information.
- endpoints¶
IP address and port number of the user used to access the VPC.
- enterprise_project_id¶
ID of the enterprise project that a cluster belongs to.
- error¶
Error object
- floating_ip¶
Public IP address information.
- id¶
Cluster ID.
- instance¶
Instance.
- instance_num¶
Number of clusters.
- is_authority_enabled¶
Whether to enable authentication.
- is_billed¶
Whether cluster is billed.
- is_backup_enabled¶
Whether the snapshot function is enabled.
- is_disk_encrypted¶
Whether disks are encrypted.
- is_https_enabled¶
Communication encryption status.
- network_id¶
Network ID.
- nodes¶
List of node objects.
- name: ty.Union[Body, URI]¶
Cluster name.
- public_kibana_resp¶
Kibana public network access information.
- router_id¶
Router (VPC) ID.
- security_group_id¶
Security group ID.
- status¶
Cluster status.
- status_code¶
Cluster status code.
- tags¶
Cluster tags.
- updated_at¶
Last modification time of a cluster.
- vpcep_ip¶
Endpoint IP address.
- restart(session)¶
Restart the cluster.
- extend(session, add_nodes)¶
Scaling Out a Cluster with only Common Nodes.
- classmethod existing(connection=None, **kwargs)¶
Create an instance of an existing remote resource.
When creating the instance set the
_synchronizedparameter ofResourcetoTrueto indicate that it represents the state of an existing server-side resource. As such, all attributes passed in**kwargsare considered “clean”, such that an immediateupdate()call would not generate a body of attributes to be modified on the server.- Parameters:
kwargs (dict) – Each of the named arguments will be set as attributes on the resulting Resource object.