otcextensions.sdk.mrs.v1.cluster¶
The MRS ClusterInfo Class¶
The ClusterInfo class inherits from
Resource.
- class otcextensions.sdk.mrs.v1.cluster.ClusterInfo(_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.
- resource_key: ty.Optional[str] = 'cluster'¶
Singular form of key for resource.
- resources_key: ty.Optional[str] = 'clusters'¶
Plural form of key for resource.
- base_path: str = '/cluster_infos'¶
The base part of the URI for this resource.
- allow_list = True¶
Allow list operation for this resource.
- id¶
Properties Cluster ID.
- name: ty.Union[Body, URI]¶
Cluster name.
- master_num¶
Number of Master nodes deployed in a cluster.
- core_num¶
Number of Core nodes deployed in a cluster.
- total_num¶
Total number of nodes deployed in a cluster.
- status¶
Cluster status.
- created_at¶
Cluster creation time, which is a 10-bit timestamp.
- updated_at¶
Cluster update time, which is a 10-bit timestamp.
- billing_type¶
Cluster billing mode
- region¶
Cluster work region.
- vpc¶
VPC name.
- fee¶
Cluster creation fee, which is automatically calculated.
- hadoop_version¶
Hadoop version.
- master_node_size¶
Instance specifications of a Master node.
- core_node_size¶
Instance specifications of a Core node.
- component_list¶
Component list.
- external_ip¶
External IP address.
- external_alternate_ip¶
Backup external IP address.
- internal_ip¶
Internal IP address.
- deployment_id¶
Cluster deployment ID
- remark¶
Cluster remarks.
- order_id¶
Cluster creation order ID.
- az¶
AZ name.
- az_id¶
AZ ID.
- master_node_product_id¶
Product ID of a Master node.
- master_node_spec_id¶
Specification ID of a Master node.
- core_node_product_id¶
Product ID of a Core node.
- core_node_spec_id¶
Specification ID of a Core node.
- instance_id¶
Instance ID.
- vnc¶
URI for remotely logging in to an ECS.
- project_id¶
Project ID.
- volume_size¶
Disk storage space.
- volume_type¶
Disk type.
- subnet_id¶
Subnet ID.
- subnet_name¶
Subnet name.
- cluster_type¶
Cluster type.
- security_group_id¶
Security group ID.
- non_master_security_group_id¶
Security group ID of a non-Master node.
- stage_desc¶
Cluster operation progress description.
- mrs_install_state¶
Whether MRS Manager installation is finished during cluster creation.
- safe_mode¶
Running mode of an MRS cluster.
- cluster_version¶
Cluster version.
- key¶
Name of the key file.
- master_ip¶
IP address of a Master node.
- preffered_private_ip¶
Preferred private IP address.
- error_info¶
Error message.
- charging_start_time¶
Start time of billing.
- log_collection¶
Whether to collect logs when cluster installation fails.
- task_node_groups¶
List of Task nodes.
- node_groups¶
List of Master, Core and Task nodes.
- master_data_volume_type¶
Data disk storage type of the Master node. SATA, SAS and SSD are supported.
- master_data_volume_size¶
Data disk storage space of the Master node.
- master_data_volume_count¶
Number of data disks of the Master node.
- core_data_volume_type¶
Data disk storage type of the Core node.
- core_data_volume_size¶
Data disk storage space of the Core node.
- core_data_volume_count¶
Data disk storage space of the Core node.
- bootstrap_scripts¶
Bootstrap action script information.
- tags¶
Bootstrap action script information.
- scale¶
Node change status.
- parameters¶
Core parameters.
- class otcextensions.sdk.mrs.v1.cluster.ParametersSpec(_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.
- order_id¶
Properties Order ID obtained by the system during scale-out or scale-in.
- scale_type¶
Cluster scale-in or scale-out type.
- node_id¶
ID of the newly added or removed node.
- node_group¶
Node group to be scaled out or in.
- task_node_info¶
Task node specifications.
- instances¶
Number of nodes to be added or removed.
- skip_bootstrap_scripts¶
Indicates whether the bootstrap action specified during cluster creation is performed on nodes.
- scale_without_start¶
Whether to start components on the added nodes after cluster scale-out.
- server_ids¶
ID list of Task nodes to be deleted during task node scale-in..
The MRS Cluster Class¶
The Cluster class inherits from
Resource.
- class otcextensions.sdk.mrs.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.
- allow_delete = True¶
Allow delete operation for this resource.
The MRS Host Class¶
The Host class inherits from
Resource.
- class otcextensions.sdk.mrs.v1.cluster.Host(_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.
- resources_key: ty.Optional[str] = 'hosts'¶
Plural form of key for resource.
- base_path: str = '/clusters/%(cluster_id)s/hosts'¶
The base part of the URI for this resource.
- allow_list = True¶
Allow list operation for this resource.
- id¶
Properties VM ID
- ip¶
VM IP address
- flavor¶
VM flavor ID
- type¶
VM type
- name: ty.Union[Body, URI]¶
VM name
- status¶
Current VM state
- mem¶
Memory
- cpu¶
Number of CPU cores
- root_volume_size¶
OS disk capacity
- data_volume_type¶
Data disk type
- data_volume_size¶
Data disk capacity
- data_volume_count¶
Number of data disks