diff --git a/api-ref/source/apis/cluster_management_apis_v1/creating_a_cluster_and_running_a_job.rst b/api-ref/source/apis/cluster_management_apis_v1/creating_a_cluster_and_running_a_job.rst index 540de03..91bb97f 100644 --- a/api-ref/source/apis/cluster_management_apis_v1/creating_a_cluster_and_running_a_job.rst +++ b/api-ref/source/apis/cluster_management_apis_v1/creating_a_cluster_and_running_a_job.rst @@ -18,50 +18,34 @@ Before using the API, you need to obtain the resources listed in :ref:`Table 1 < .. table:: **Table 1** Obtaining resources - +-----------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | Resource | How to Obtain | - +===================================+=======================================================================================================================================================================================+ - | VPC | See operation instructions in **VPC > Querying VPCs** and **VPC > Creating a VPC** in the *VPC API Reference*. | - +-----------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | Subnet | See operation instructions in **Subnet > Querying Subnets** and **Subnet > Creating a Subnet** in the *VPC API Reference*. | - +-----------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | Key Pair | See operation instructions in **ECS SSH Key Management > Querying SSH Key Pairs** and **ECS SSH Key Management > Creating and Importing an SSH Key Pair** in the *ECS API Reference*. | - +-----------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | Region | Obtain the region and AZ information. For more information about regions and AZs, see `Regions and Endpoints `__. | - +-----------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | Version | Currently, the following versions are supported: MRS 1.6.3, MRS 1.7.2, MRS 1.9.2, MRS 2.1.0, MRS 3.1.0-LTS.1, MRS 3.1.2-LTS.3 and MRS3.2.0-LTS.1. | - +-----------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | Component | - MRS 3.1.2-LTS.3 supports the following components: | - | | | - | | - The analysis cluster contains the following components: Hadoop, Spark2x, HBase, Hive, Hue, HetuEngine, Loader, Flink, Oozie, ZooKeeper, Ranger, and Tez. | - | | - The streaming cluster contains the following components: Kafka, Flume, ZooKeeper, and Ranger. | - | | - The hybrid cluster contains the following components: Hadoop, Spark2x, HBase, Hive, Hue, HetuEngine, Loader, Flink, Oozie, ZooKeeper, Ranger, Tez, Kafka, and Flume. | - | | - A custom cluster contains the following components: Hadoop, Spark2x, HBase, Hive, Hue, HetuEngine, Loader, Kafka, Flume, Flink, Oozie, ZooKeeper, Ranger, Tez, and ClickHouse. | - | | | - | | - MRS 3.1.0-LTS.1 supports the following components: | - | | | - | | - The analysis cluster contains the following components: Hadoop, Spark2x, HBase, Hive, Hue, HetuEngine, Loader, Flink, Oozie, ZooKeeper, Ranger, and Tez. | - | | - The streaming cluster contains the following components: Kafka, Flume, ZooKeeper, and Ranger. | - | | - The hybrid cluster contains the following components: Hadoop, Spark2x, HBase, Hive, Hue, HetuEngine, Loader, Flink, Oozie, ZooKeeper, Ranger, Tez, Kafka, and Flume. | - | | - A custom cluster contains the following components: Hadoop, Spark2x, HBase, Hive, Hue, HetuEngine, Loader, Kafka, Flume, Flink, Oozie, ZooKeeper, Ranger, and Tez. | - | | | - | | - MRS 2.1.0 supports the following components: | - | | | - | | - The analysis cluster contains the following components: Presto, Hadoop, Spark, HBase, Hive, Hue, Loader, Tez, Flink. | - | | - The streaming cluster contains the following components: Kafka, Storm, and Flume. | - | | - The hybrid cluster contains the following components: Hadoop, Hive, Presto, Spark, Tez, and Flink. | - | | | - | | - MRS 1.9.2 supports the following components: | - | | | - | | - The analysis cluster contains the following components: Presto, Hadoop, Spark, HBase, Opentsdb, Hive, Hue, Loader, Tez, Flink, Alluxio and Ranger | - | | - The streaming cluster contains the following components: Kafka, KafkaManager, Storm, and Flume. | - | | - The hybrid cluster contains the following components: Hadoop, Hive, Presto, Spark, Tez, Kafka, Flink, and Ranger. | - | | | - | | - The following table lists the components supported by MRS 1.7.2, MRS 1.6.3: | - | | | - | | - The analysis cluster contains the following components: Hadoop, Spark, HBase, Hive, Hue, and Loader | - | | - The streaming cluster contains the following components: Kafka, Storm, and Flume. | - +-----------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + +-----------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | Resource | How to Obtain | + +===================================+==================================================================================================================================================================================================+ + | VPC | See operation instructions in **VPC > Querying VPCs** and **VPC > Creating a VPC** in the *VPC API Reference*. | + +-----------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | Subnet | See operation instructions in **Subnet > Querying Subnets** and **Subnet > Creating a Subnet** in the *VPC API Reference*. | + +-----------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | Key Pair | See operation instructions in **ECS SSH Key Management > Querying SSH Key Pairs** and **ECS SSH Key Management > Creating and Importing an SSH Key Pair** in the *ECS API Reference*. | + +-----------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | Region | Obtain the region and AZ information. For more information about regions and AZs, see `Regions and Endpoints `__. | + +-----------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | Version | Currently, the following versions are supported: MRS 3.1.2-LTS.3 and MRS 3.2.0-LTS.2. | + +-----------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | Component | - MRS 3.2.0-LTS.2 supports the following components: | + | | | + | | - An analysis cluster contains the following components: Hadoop, Spark2x, HBase, Hive, Hue, Loader, Flink, Oozie, ZooKeeper, HetuEngine, Ranger, and Tez. | + | | - A streaming cluster contains the following components: Kafka, Flume, ZooKeeper, and Ranger. | + | | - A hybrid cluster contains the following components: Hadoop, Spark2x, HBase, Hive, Hue, Loader, Flink, Oozie, ZooKeeper, HetuEngine, Ranger, Tez, Kafka, and Flume. | + | | | + | | - A custom cluster contains the following components: CDL, Hadoop, Spark2x, HBase, Hive, Hue, Loader, IoTDB, Kafka, Flume, Flink, Oozie, ZooKeeper, HetuEngine, Ranger, Tez, and ClickHouse. | + | | | + | | - MRS 3.1.2-LTS.3 supports the following components: | + | | | + | | - The analysis cluster contains the following components: Hadoop, Spark2x, HBase, Hive, Hue, HetuEngine, Loader, Flink, Oozie, ZooKeeper, Ranger, and Tez. | + | | - The streaming cluster contains the following components: Kafka, Flume, ZooKeeper, and Ranger. | + | | - The hybrid cluster contains the following components: Hadoop, Spark2x, HBase, Hive, Hue, HetuEngine, Loader, Flink, Oozie, ZooKeeper, Ranger, Tez, Kafka, and Flume. | + | | - A custom cluster contains the following components: Hadoop, Spark2x, HBase, Hive, Hue, HetuEngine, Loader, Kafka, Flume, Flink, Oozie, ZooKeeper, Ranger, Tez, and ClickHouse. | + +-----------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ URI --- @@ -151,13 +135,8 @@ Request | | | | | | | | | Possible values are as follows: | | | | | | - | | | | - MRS 1.6.3 | - | | | | - MRS 1.7.2 | - | | | | - MRS 1.9.2 | - | | | | - MRS 2.1.0 | - | | | | - MRS 3.1.0-LTS.1 | | | | | - MRS 3.1.2-LTS.3 | - | | | | - MRS 3.2.0-LTS.1 | + | | | | - MRS 3.2.0-LTS.2 | +-----------------------+-----------------+-----------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | cluster_type | No | Integer | Cluster type | | | | | | @@ -172,10 +151,6 @@ Request | | | | | | | | | - **0**: normal cluster. In a normal cluster, Kerberos authentication is disabled, and users can use all functions provided by the cluster. | | | | | - **1**: security cluster. In a security cluster, Kerberos authentication is enabled, and common users cannot use the file management and job management functions of an MRS cluster or view cluster resource usage and the job records of Hadoop and Spark. To use these functions, the users must obtain the relevant permissions from the MRS Manager administrator. | - | | | | | - | | | | .. note:: | - | | | | | - | | | | For MRS 1.7.2 or earlier, the request body contains the **cluster_admin_secret** field only when **safe_mode** is set to **1**. | +-----------------------+-----------------+-----------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | cluster_admin_secret | Yes | String | Password of the MRS Manager administrator | | | | | | @@ -188,10 +163,6 @@ Request | | | | - Special characters: :literal:`\`~!@#$%^&*()-_=+\\|[{}];:'",<.>/?` and space | | | | | | | | | | - Cannot be the username or the username spelled backwards. | - | | | | | - | | | | .. note:: | - | | | | | - | | | | For MRS 1.7.2 or earlier, this parameter is mandatory only when **safe_mode** is set to **1**. | +-----------------------+-----------------+-----------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | login_mode | Yes | Integer | Cluster login mode | | | | | | @@ -202,10 +173,6 @@ Request | | | | | | | | | - If **login_mode** is set to **0**, the request body contains the **cluster_master_secret** field. | | | | | - If **login_mode** is set to **1**, the request body contains the **node_public_cert_name** field. | - | | | | | - | | | | .. note:: | - | | | | | - | | | | This parameter is valid only for clusters of MRS 1.6.3 or later instead of clusters of versions earlier than MRS 1.6.3. | +-----------------------+-----------------+-----------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | cluster_master_secret | No | String | Password of user **root** for logging in to a cluster node | | | | | | @@ -241,8 +208,6 @@ Request | add_jobs | No | Array | Jobs can be submitted when a cluster is created. Currently, only one job can be created. For details about job parameters, see :ref:`Table 8 `. | +-----------------------+-----------------+-----------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | bootstrap_scripts | No | Array | Bootstrap action script information. For more parameter description, see :ref:`Table 15 `. | - | | | | | - | | | | MRS 1.7.2 or later supports this parameter. | +-----------------------+-----------------+-----------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ .. _mrs_02_0028__table3419221413: @@ -502,12 +467,8 @@ Request | resources_plans | No | List | Resource plan list. For details, see :ref:`Table 10 `. If this parameter is left blank, the resource plan is disabled. | | | | | | | | | | When auto scaling is enabled, either a resource plan or an auto scaling rule must be configured. | - | | | | | - | | | | MRS 1.6.3 or later supports this parameter. | +---------------------+-----------------+-----------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | exec_scripts | No | List | List of custom scaling automation scripts. For details, see :ref:`Table 11 `. If this parameter is left blank, a hook script is disabled. | - | | | | | - | | | | MRS 1.7.2 or later supports this parameter. | +---------------------+-----------------+-----------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | rules | No | List | List of auto scaling rules. For details, see :ref:`Table 12 `. | | | | | | diff --git a/api-ref/source/apis/cluster_management_apis_v1/querying_a_cluster_list.rst b/api-ref/source/apis/cluster_management_apis_v1/querying_a_cluster_list.rst index 5a13025..ff3a4c5 100644 --- a/api-ref/source/apis/cluster_management_apis_v1/querying_a_cluster_list.rst +++ b/api-ref/source/apis/cluster_management_apis_v1/querying_a_cluster_list.rst @@ -247,123 +247,59 @@ Response .. table:: **Table 4** **componentList** parameter description - +-----------------------+-----------------------+----------------------------------------------------------------------------------------------------------------------------+ - | Parameter | Type | Description | - +=======================+=======================+============================================================================================================================+ - | componentId | String | Component ID | - | | | | - | | | - Component IDs of MRS 3.2.0-LTS.1 are as follows: | - | | | | - | | | - MRS 3.2.0-LTS.1_001: Hadoop | - | | | - MRS 3.2.0-LTS.1_002: HBase | - | | | - MRS 3.2.0-LTS.1_003: Hive | - | | | - MRS 3.2.0-LTS.1_004: Spark2x | - | | | - MRS 3.2.0-LTS.1_006: Flink | - | | | - MRS 3.2.0-LTS.1_008: Kafka | - | | | - MRS 3.2.0-LTS.1_009: Flume | - | | | - MRS 3.2.0-LTS.1_013: Loader | - | | | - MRS 3.2.0-LTS.1_014: Hue | - | | | - MRS 3.2.0-LTS.1_015: Ooize | - | | | - MRS 3.2.0-LTS.1_018: DBService | - | | | - MRS 3.2.0-LTS.1_019: ZooKeeper | - | | | - MRS 3.2.0-LTS.1_022: Ranger | - | | | - MRS 3.2.0-LTS.1_023: HetuEngine | - | | | - MRS 3.2.0-LTS.1_024: Tez | - | | | - MRS 3.2.0-LTS.1_025: ClickHouse | - | | | - MRS 3.2.0-LTS.1_026: IoTDB | - | | | - MRS 3.2.0-LTS.1_028: CDL | - | | | | - | | | - Component IDs of MRS 3.1.2-LTS.3 are as follows: | - | | | | - | | | - MRS 3.1.2-LTS.3_001: Hadoop | - | | | - MRS 3.1.2-LTS.3_002: HBase | - | | | - MRS 3.1.2-LTS.3_003: Hive | - | | | - MRS 3.1.2-LTS.3_004: Spark2x | - | | | - MRS 3.1.2-LTS.3_006: Flink | - | | | - MRS 3.1.2-LTS.3_008: Kafka | - | | | - MRS 3.1.2-LTS.3_009: Flume | - | | | - MRS 3.1.2-LTS.3_013: Loader | - | | | - MRS 3.1.2-LTS.3_014: Hue | - | | | - MRS 3.1.2-LTS.3_015: Ooize | - | | | - MRS 3.1.2-LTS.3_018: DBService | - | | | - MRS 3.1.2-LTS.3_019: ZooKeeper | - | | | - MRS 3.1.2-LTS.3_022: Ranger | - | | | - MRS 3.1.2-LTS.3_023: HetuEngine | - | | | - MRS 3.1.2-LTS.3_024: Tez | - | | | - MRS 3.1.2-LTS.3_025: ClickHouse | - | | | | - | | | - Component IDs of MRS 3.1.0-LTS.1 are as follows: | - | | | | - | | | - MRS 3.1.0-LTS.1_001: Hadoop | - | | | - MRS 3.1.0-LTS.1_002: HBase | - | | | - MRS 3.1.0-LTS.1_003: Hive | - | | | - MRS 3.1.0-LTS.1_004: Spark2x | - | | | - MRS 3.1.0-LTS.1_006: Flink | - | | | - MRS 3.1.0-LTS.1_008: Kafka | - | | | - MRS 3.1.0-LTS.1_009: Flume | - | | | - MRS 3.1.0-LTS.1_013: Loader | - | | | - MRS 3.1.0-LTS.1_014: Hue | - | | | - MRS 3.1.0-LTS.1_015: Ooize | - | | | - MRS 3.1.0-LTS.1_018: DBService | - | | | - MRS 3.1.0-LTS.1_019: ZooKeeper | - | | | - MRS 3.1.0-LTS.1_022: Ranger | - | | | - MRS 3.1.0-LTS.1_023: HetuEngine | - | | | - MRS 3.1.2-LTS.3_024: Tez | - | | | | - | | | - Component IDs of MRS 2.1.0 are as follows: | - | | | | - | | | - MRS 2.1.0_001: Hadoop | - | | | - MRS 2.1.0_002: Spark | - | | | - MRS 2.1.0_003: HBase | - | | | - MRS 2.1.0_004: Hive | - | | | - MRS 2.1.0_005: Hue | - | | | - MRS 2.1.0_006: Kafka | - | | | - MRS 2.1.0_007: Storm | - | | | - MRS 2.1.0_008: Loader | - | | | - MRS 2.1.0_009: Flume | - | | | - MRS 2.1.0_010: Tez | - | | | - MRS 2.1.0_011: Presto | - | | | - MRS 2.1.0_014: Flink | - | | | | - | | | - Component IDs of MRS 1.9.2 are as follows: | - | | | | - | | | - MRS 1.9.2_001: Hadoop | - | | | - MRS 1.9.2_002: Spark | - | | | - MRS 1.9.2_003: HBase | - | | | - MRS 1.9.2_004: Hive | - | | | - MRS 1.9.2_005: Hue | - | | | - MRS 1.9.2_006: Kafka | - | | | - MRS 1.9.2_007: Storm | - | | | - MRS 1.9.2_008: Loader | - | | | - MRS 1.9.2_009: Flume | - | | | - MRS 1.9.2_010: Presto | - | | | - MRS 1.9.2_011: KafkaManager | - | | | - MRS 1.9.2_012: Flink | - | | | - MRS 1.9.2_013: OpenTSDB | - | | | - MRS 1.9.2_015: Alluxio | - | | | - MRS 1.9.2_16: Ranger | - | | | - MRS 1.9.2_17: Tez | - | | | | - | | | - Component IDs of MRS 1.7.2 and MRS 1.6.3 are as follows: | - | | | | - | | | - MRS 1.7.2_001: Hadoop | - | | | - MRS 1.7.2_002: Spark | - | | | - MRS 1.7.2_003: HBase | - | | | - MRS 1.7.2_004: Hive | - | | | - MRS 1.7.2_005: Hue | - | | | - MRS 1.7.2_006: Kafka | - | | | - MRS 1.7.2_007: Storm | - | | | - MRS 1.7.2_008: Loader | - | | | - MRS 1.7.2_009: Flume | - | | | | - | | | For example, the **component_id** of Hadoop is **MRS 2.1.0_001**, **MRS 1.9.2_001**, **MRS 1.7.2_001**, **MRS 1.6.3_001**. | - +-----------------------+-----------------------+----------------------------------------------------------------------------------------------------------------------------+ - | componentName | String | Component name | - +-----------------------+-----------------------+----------------------------------------------------------------------------------------------------------------------------+ - | componentVersion | String | Component version | - +-----------------------+-----------------------+----------------------------------------------------------------------------------------------------------------------------+ - | componentDesc | String | Component description | - +-----------------------+-----------------------+----------------------------------------------------------------------------------------------------------------------------+ + +-----------------------+-----------------------+-----------------------------------------------------------------------------+ + | Parameter | Type | Description | + +=======================+=======================+=============================================================================+ + | componentId | String | Component ID | + | | | | + | | | - Component IDs of MRS 3.2.0-LTS.2 are as follows: | + | | | | + | | | - MRS 3.2.0-LTS.2_001: Hadoop | + | | | - MRS 3.2.0-LTS.2_002: HBase | + | | | - MRS 3.2.0-LTS.2_003: Hive | + | | | - MRS 3.2.0-LTS.2_004: Spark2x | + | | | - MRS 3.2.0-LTS.2_006: Flink | + | | | - MRS 3.2.0-LTS.2_008: Kafka | + | | | - MRS 3.2.0-LTS.2_009: Flume | + | | | - MRS 3.2.0-LTS.2_013: Loader | + | | | - MRS 3.2.0-LTS.2_014: Hue | + | | | - MRS 3.2.0-LTS.2_015: Ooize | + | | | - MRS 3.2.0-LTS.2_018: DBService | + | | | - MRS 3.2.0-LTS.2_019: ZooKeeper | + | | | - MRS 3.2.0-LTS.2_022: Ranger | + | | | - MRS 3.2.0-LTS.2_023: HetuEngine | + | | | - MRS 3.2.0-LTS.2_024: Tez | + | | | - MRS 3.2.0-LTS.2_025: ClickHouse | + | | | - MRS 3.2.0-LTS.2_026: IoTDB | + | | | - MRS 3.2.0-LTS.2_028: CDL | + | | | | + | | | - Component IDs of MRS 3.1.2-LTS.3 are as follows: | + | | | | + | | | - MRS 3.1.2-LTS.3_001: Hadoop | + | | | - MRS 3.1.2-LTS.3_002: HBase | + | | | - MRS 3.1.2-LTS.3_003: Hive | + | | | - MRS 3.1.2-LTS.3_004: Spark2x | + | | | - MRS 3.1.2-LTS.3_006: Flink | + | | | - MRS 3.1.2-LTS.3_008: Kafka | + | | | - MRS 3.1.2-LTS.3_009: Flume | + | | | - MRS 3.1.2-LTS.3_013: Loader | + | | | - MRS 3.1.2-LTS.3_014: Hue | + | | | - MRS 3.1.2-LTS.3_015: Ooize | + | | | - MRS 3.1.2-LTS.3_018: DBService | + | | | - MRS 3.1.2-LTS.3_019: ZooKeeper | + | | | - MRS 3.1.2-LTS.3_022: Ranger | + | | | - MRS 3.1.2-LTS.3_023: HetuEngine | + | | | - MRS 3.1.2-LTS.3_024: Tez | + | | | - MRS 3.1.2-LTS.3_025: ClickHouse | + | | | | + | | | For example, the **component_id** of Hadoop is **MRS** **3.2.0-LTS.2_001**. | + +-----------------------+-----------------------+-----------------------------------------------------------------------------+ + | componentName | String | Component name | + +-----------------------+-----------------------+-----------------------------------------------------------------------------+ + | componentVersion | String | Component version | + +-----------------------+-----------------------+-----------------------------------------------------------------------------+ + | componentDesc | String | Component description | + +-----------------------+-----------------------+-----------------------------------------------------------------------------+ .. _mrs_02_0030__t8c0e29f53f5d4b5da5cba38419aac352: diff --git a/api-ref/source/apis/cluster_management_apis_v1/querying_cluster_details.rst b/api-ref/source/apis/cluster_management_apis_v1/querying_cluster_details.rst index aa05e07..bd3ea1b 100644 --- a/api-ref/source/apis/cluster_management_apis_v1/querying_cluster_details.rst +++ b/api-ref/source/apis/cluster_management_apis_v1/querying_cluster_details.rst @@ -127,8 +127,6 @@ Response | slaveSecurityGroupsId | String | Security group ID of a non-Master node. Currently, one MRS cluster uses only one security group. Therefore, this field has been discarded. This field returns the same value as **securityGroupsId** does for compatibility consideration. | +-----------------------+-----------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | bootstrap_scripts | Array | Bootstrap action script information. For more parameter description, see :ref:`Table 5 `. | - | | | | - | | | MRS 1.7.2 or later supports this parameter. | +-----------------------+-----------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | stageDesc | String | Cluster operation progress description. | | | | | @@ -234,123 +232,59 @@ Response .. table:: **Table 3** **componentList** parameter description - +-----------------------+-----------------------+----------------------------------------------------------------------------------------------------------------------------+ - | Parameter | Type | Description | - +=======================+=======================+============================================================================================================================+ - | componentId | String | Component ID | - | | | | - | | | - Component IDs of MRS 3.2.0-LTS.1 are as follows: | - | | | | - | | | - MRS 3.2.0-LTS.1_001: Hadoop | - | | | - MRS 3.2.0-LTS.1_002: HBase | - | | | - MRS 3.2.0-LTS.1_003: Hive | - | | | - MRS 3.2.0-LTS.1_004: Spark2x | - | | | - MRS 3.2.0-LTS.1_006: Flink | - | | | - MRS 3.2.0-LTS.1_008: Kafka | - | | | - MRS 3.2.0-LTS.1_009: Flume | - | | | - MRS 3.2.0-LTS.1_013: Loader | - | | | - MRS 3.2.0-LTS.1_014: Hue | - | | | - MRS 3.2.0-LTS.1_015: Ooize | - | | | - MRS 3.2.0-LTS.1_018: DBService | - | | | - MRS 3.2.0-LTS.1_019: ZooKeeper | - | | | - MRS 3.2.0-LTS.1_022: Ranger | - | | | - MRS 3.2.0-LTS.1_023: HetuEngine | - | | | - MRS 3.2.0-LTS.1_024: Tez | - | | | - MRS 3.2.0-LTS.1_025: ClickHouse | - | | | - MRS 3.2.0-LTS.1_026: IoTDB | - | | | - MRS 3.2.0-LTS.1_028: CDL | - | | | | - | | | - Component IDs of MRS 3.1.2-LTS.3 are as follows: | - | | | | - | | | - MRS 3.1.2-LTS.3_001: Hadoop | - | | | - MRS 3.1.2-LTS.3_002: HBase | - | | | - MRS 3.1.2-LTS.3_003: Hive | - | | | - MRS 3.1.2-LTS.3_004: Spark2x | - | | | - MRS 3.1.2-LTS.3_006: Flink | - | | | - MRS 3.1.2-LTS.3_008: Kafka | - | | | - MRS 3.1.2-LTS.3_009: Flume | - | | | - MRS 3.1.2-LTS.3_013: Loader | - | | | - MRS 3.1.2-LTS.3_014: Hue | - | | | - MRS 3.1.2-LTS.3_015: Ooize | - | | | - MRS 3.1.2-LTS.3_018: DBService | - | | | - MRS 3.1.2-LTS.3_019: ZooKeeper | - | | | - MRS 3.1.2-LTS.3_022: Ranger | - | | | - MRS 3.1.2-LTS.3_023: HetuEngine | - | | | - MRS 3.1.2-LTS.3_024: Tez | - | | | - MRS 3.1.2-LTS.3_025: ClickHouse | - | | | | - | | | - Component IDs of MRS 3.1.0-LTS.1 are as follows: | - | | | | - | | | - MRS 3.1.0-LTS.1_001: Hadoop | - | | | - MRS 3.1.0-LTS.1_002: Spark2x | - | | | - MRS 3.1.0-LTS.1_003: HBase | - | | | - MRS 3.1.0-LTS.1_004: Hive | - | | | - MRS 3.1.0-LTS.1_005: Hue | - | | | - MRS 3.1.0-LTS.1_006: Loader | - | | | - MRS 3.1.0-LTS.1_007: Kafka | - | | | - MRS 3.1.0-LTS.1_008: Flume | - | | | - MRS 3.1.0-LTS.1_009: Flink | - | | | - MRS 3.1.0-LTS.1_010: Oozie | - | | | - MRS 3.1.0-LTS.1_011: ZooKeeper | - | | | - MRS 3.1.0-LTS.1_012: HetuEngine | - | | | - MRS 3.1.0-LTS.1_013: Ranger | - | | | - MRS 3.1.0-LTS.1_014: Tez | - | | | - MRS 3.1.0-LTS.1_015: ClickHouse | - | | | | - | | | - Component IDs of MRS 2.1.0 are as follows: | - | | | | - | | | - MRS 2.1.0_001: Hadoop | - | | | - MRS 2.1.0_002: Spark | - | | | - MRS 2.1.0_003: HBase | - | | | - MRS 2.1.0_004: Hive | - | | | - MRS 2.1.0_005: Hue | - | | | - MRS 2.1.0_006: Kafka | - | | | - MRS 2.1.0_007: Storm | - | | | - MRS 2.1.0_008: Loader | - | | | - MRS 2.1.0_009: Flume | - | | | - MRS 2.1.0_010: Tez | - | | | - MRS 2.1.0_011: Presto | - | | | - MRS 2.1.0_014: Flink | - | | | | - | | | - Component IDs of MRS 1.9.2 are as follows: | - | | | | - | | | - MRS 1.9.2_001: Hadoop | - | | | - MRS 1.9.2_002: Spark | - | | | - MRS 1.9.2_003: HBase | - | | | - MRS 1.9.2_004: Hive | - | | | - MRS 1.9.2_005: Hue | - | | | - MRS 1.9.2_006: Kafka | - | | | - MRS 1.9.2_007: Storm | - | | | - MRS 1.9.2_008: Loader | - | | | - MRS 1.9.2_009: Flume | - | | | - MRS 1.9.2_010: Presto | - | | | - MRS 1.9.2_011: KafkaManager | - | | | - MRS 1.9.2_012: Flink | - | | | - MRS 1.9.2_013: OpenTSDB | - | | | - MRS 1.9.2_015: Alluxio | - | | | - MRS 1.9.2_16: Ranger | - | | | - MRS 1.9.2_17: Tez | - | | | | - | | | - Component IDs of MRS 1.7.2 and MRS 1.6.3 are as follows: | - | | | | - | | | - MRS 1.7.2_001: Hadoop | - | | | - MRS 1.7.2_002: Spark | - | | | - MRS 1.7.2_003: HBase | - | | | - MRS 1.7.2_004: Hive | - | | | - MRS 1.7.2_005: Hue | - | | | - MRS 1.7.2_006: Kafka | - | | | - MRS 1.7.2_007: Storm | - | | | - MRS 1.7.2_008: Loader | - | | | - MRS 1.7.2_009: Flume | - | | | | - | | | For example, the **component_id** of Hadoop is **MRS 2.1.0_001**, **MRS 1.9.2_001**, **MRS 1.7.2_001**, **MRS 1.6.3_001**. | - +-----------------------+-----------------------+----------------------------------------------------------------------------------------------------------------------------+ - | componentName | String | Component name | - +-----------------------+-----------------------+----------------------------------------------------------------------------------------------------------------------------+ - | componentVersion | String | Component version | - +-----------------------+-----------------------+----------------------------------------------------------------------------------------------------------------------------+ - | componentDesc | String | Component description | - +-----------------------+-----------------------+----------------------------------------------------------------------------------------------------------------------------+ + +-----------------------+-----------------------+--------------------------------------------------------------------------+ + | Parameter | Type | Description | + +=======================+=======================+==========================================================================+ + | componentId | String | Component ID | + | | | | + | | | - Component IDs of MRS 3.2.0-LTS.2 are as follows: | + | | | | + | | | - MRS 3.2.0-LTS.2_001: Hadoop | + | | | - MRS 3.2.0-LTS.2_002: HBase | + | | | - MRS 3.2.0-LTS.2_003: Hive | + | | | - MRS 3.2.0-LTS.2_004: Spark2x | + | | | - MRS 3.2.0-LTS.2_006: Flink | + | | | - MRS 3.2.0-LTS.2_008: Kafka | + | | | - MRS 3.2.0-LTS.2_009: Flume | + | | | - MRS 3.2.0-LTS.2_013: Loader | + | | | - MRS 3.2.0-LTS.2_014: Hue | + | | | - MRS 3.2.0-LTS.2_015: Ooize | + | | | - MRS 3.2.0-LTS.2_018: DBService | + | | | - MRS 3.2.0-LTS.2_019: ZooKeeper | + | | | - MRS 3.2.0-LTS.2_022: Ranger | + | | | - MRS 3.2.0-LTS.2_023: HetuEngine | + | | | - MRS 3.2.0-LTS.2_024: Tez | + | | | - MRS 3.2.0-LTS.2_025: ClickHouse | + | | | - MRS 3.2.0-LTS.2_026: IoTDB | + | | | - MRS 3.2.0-LTS.2_028: CDL | + | | | | + | | | - Component IDs of MRS 3.1.2-LTS.3 are as follows: | + | | | | + | | | - MRS 3.1.2-LTS.3_001: Hadoop | + | | | - MRS 3.1.2-LTS.3_002: HBase | + | | | - MRS 3.1.2-LTS.3_003: Hive | + | | | - MRS 3.1.2-LTS.3_004: Spark2x | + | | | - MRS 3.1.2-LTS.3_006: Flink | + | | | - MRS 3.1.2-LTS.3_008: Kafka | + | | | - MRS 3.1.2-LTS.3_009: Flume | + | | | - MRS 3.1.2-LTS.3_013: Loader | + | | | - MRS 3.1.2-LTS.3_014: Hue | + | | | - MRS 3.1.2-LTS.3_015: Ooize | + | | | - MRS 3.1.2-LTS.3_018: DBService | + | | | - MRS 3.1.2-LTS.3_019: ZooKeeper | + | | | - MRS 3.1.2-LTS.3_022: Ranger | + | | | - MRS 3.1.2-LTS.3_023: HetuEngine | + | | | - MRS 3.1.2-LTS.3_024: Tez | + | | | - MRS 3.1.2-LTS.3_025: ClickHouse | + | | | | + | | | For example, the **component_id** of Hadoop is **MRS 3.2.0-LTS.2\_001**. | + +-----------------------+-----------------------+--------------------------------------------------------------------------+ + | componentName | String | Component name | + +-----------------------+-----------------------+--------------------------------------------------------------------------+ + | componentVersion | String | Component version | + +-----------------------+-----------------------+--------------------------------------------------------------------------+ + | componentDesc | String | Component description | + +-----------------------+-----------------------+--------------------------------------------------------------------------+ .. _mrs_02_0031__t985f9eb1ce0c4e0186e16ed2a6c7e731: diff --git a/api-ref/source/apis/cluster_management_apis_v2/creating_clusters.rst b/api-ref/source/apis/cluster_management_apis_v2/creating_clusters.rst index 5b8ae0f..b13e385 100644 --- a/api-ref/source/apis/cluster_management_apis_v2/creating_clusters.rst +++ b/api-ref/source/apis/cluster_management_apis_v2/creating_clusters.rst @@ -27,9 +27,9 @@ Before using the API, you need to obtain the resources listed in :ref:`Table 1 < +-----------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | Zone | Obtain the region and AZ information. For more information about regions and AZs, see `Regions and Endpoints `__. | +-----------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | Version | Currently, MRS 1.6.3, MRS 1.7.2, MRS 1.9.2 MRS 2.1.0, MRS 3.1.0-LTS.1, MRS 3.1.2-LTS.3 and MRS3.2.0-LTS.1 are supported. | + | Version | Currently, MRS 3.1.2-LTS.3 and MRS 3.2.0-LTS.2 are supported. | +-----------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | Component | - MRS 3.2.0-LTS.1 supports the following components: | + | Component | - MRS 3.2.0-LTS.2 supports the following components: | | | | | | - An analysis cluster contains the following components: Hadoop, Spark2x, HBase, Hive, Hue, Loader, Flink, Oozie, ZooKeeper, HetuEngine, Ranger, and Tez. | | | - A streaming cluster contains the following components: Kafka, Flume, ZooKeeper, and Ranger. | @@ -43,30 +43,6 @@ Before using the API, you need to obtain the resources listed in :ref:`Table 1 < | | - The streaming cluster contains the following components: Kafka, Flume, ZooKeeper, and Ranger. | | | - The hybrid cluster contains the following components: Hadoop, Spark2x, HBase, Hive, Hue, HetuEngine, Loader, Flink, Oozie, ZooKeeper, Ranger, Tez, Kafka, and Flume. | | | - A custom cluster contains the following components: Hadoop, Spark2x, HBase, Hive, Hue, HetuEngine, Loader, Kafka, Flume, Flink, Oozie, ZooKeeper, Ranger, Tez, and ClickHouse. | - | | | - | | - MRS 3.1.0-LTS.1 supports the following components: | - | | | - | | - The analysis cluster contains the following components: Hadoop, Spark2x, HBase, Hive, Hue, HetuEngine, Loader, Flink, Oozie, ZooKeeper, Ranger, and Tez. | - | | - The streaming cluster contains the following components: Kafka, Flume, ZooKeeper, and Ranger. | - | | - The hybrid cluster contains the following components: Hadoop, Spark2x, HBase, Hive, Hue, HetuEngine, Loader, Flink, Oozie, ZooKeeper, Ranger, Tez, Kafka, and Flume. | - | | - A custom cluster contains the following components: Hadoop, Spark2x, HBase, Hive, Hue, HetuEngine, Loader, Kafka, Flume, Flink, Oozie, ZooKeeper, Ranger, and Tez. | - | | | - | | - MRS 2.1.0 supports the following components: | - | | | - | | - The analysis cluster contains the following components: Presto, Hadoop, Spark, HBase, Hive, Hue, Loader, Tez, Flink. | - | | - The streaming cluster contains the following components: Kafka, Storm, and Flume. | - | | - The hybrid cluster contains the following components: Hadoop, Hive, Presto, Spark, Tez, and Flink. | - | | | - | | - MRS 1.9.2 supports the following components: | - | | | - | | - The analysis cluster contains the following components: Presto, Hadoop, Spark, HBase, Opentsdb, Hive, Hue, Loader, Tez, Flink, Alluxio and Ranger | - | | - The streaming cluster contains the following components: Kafka, KafkaManager, Storm, and Flume. | - | | - The hybrid cluster contains the following components: Hadoop, Hive, Presto, Spark, Tez, Kafka, Flink, and Ranger. | - | | | - | | - MRS 1.7.2 and MRS 1.6.3 support the following components: | - | | | - | | - The analysis cluster contains the following components: Hadoop, Spark, HBase, Hive, Hue, and Loader | - | | - The streaming cluster contains the following components: Kafka, Storm, and Flume. | +-----------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ URI @@ -98,13 +74,8 @@ Request | | | | | | | | | Possible values are as follows: | | | | | | - | | | | - MRS 1.6.3 | - | | | | - MRS 1.7.2 | - | | | | - MRS 1.9.2 | - | | | | - MRS 2.1.0 | - | | | | - MRS 3.1.0-LTS.1 | | | | | - MRS 3.1.2-LTS.3 | - | | | | - MRS 3.2.1-LTS.1 | + | | | | - MRS 3.2.0-LTS.2 | +------------------------+-----------------+--------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | cluster_name | Yes | String | Cluster name. It must be unique. | | | | | | @@ -139,7 +110,7 @@ Request | | | | | | | | | On the **Virtual Private Cloud** page, obtain the subnet name of the VPC from the list. | +------------------------+-----------------+--------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | components | Yes | String | List of component names, which are separated by commas (,). For details about the component names, see the component list of each version in Table 4-1. | + | components | Yes | String | List of component names, which are separated by commas (,). For details about the component names, see the component list of each version in :ref:`Table 1 `. | +------------------------+-----------------+--------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | availability_zone | Yes | String | Name of an AZ. | | | | | | @@ -167,10 +138,6 @@ Request | | | | - Spaces | | | | | | | | | | - Cannot be the username or the username spelled backwards. | - | | | | | - | | | | .. note:: | - | | | | | - | | | | For MRS 1.7.2 or earlier, this parameter is mandatory only when **safe_mode** is set to **KERBEROS**. | +------------------------+-----------------+--------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | login_mode | Yes | String | Node login mode. | | | | | | @@ -215,8 +182,6 @@ Request | node_groups | Yes | Array of NodeGroup | Information about the node groups in the cluster. For details about the parameters, see :ref:`Table 5 `. | +------------------------+-----------------+--------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | bootstrap_scripts | No | Array of BootstrapScript | Bootstrap action script information. For more parameter description, see :ref:`Table 8 `. | - | | | | | - | | | | MRS 1.7.2 or later supports this parameter. | +------------------------+-----------------+--------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | add_jobs | No | Array of AddJobReq | Jobs can be submitted when a cluster is created. Currently, only one job can be created. For details about job parameters, see :ref:`Table 9 `. | +------------------------+-----------------+--------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ @@ -475,12 +440,8 @@ Request | resources_plans | No | List | Resource plan list. For details, see :ref:`Table 11 `. If this parameter is left blank, the resource plan is disabled. | | | | | | | | | | When auto scaling is enabled, either a resource plan or an auto scaling rule must be configured. | - | | | | | - | | | | MRS 1.6.3 or later supports this parameter. | +---------------------+-----------------+-----------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | exec_scripts | No | List | List of custom scaling automation scripts. For details, see :ref:`Table 12 `. If this parameter is left blank, a hook script is disabled. | - | | | | | - | | | | MRS 1.7.2 or later supports this parameter. | +---------------------+-----------------+-----------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | rules | No | List | List of auto scaling rules. For details, see :ref:`Table 13 `. | | | | | | diff --git a/api-ref/source/change_history.rst b/api-ref/source/change_history.rst index 3e766eb..4aa5ad1 100644 --- a/api-ref/source/change_history.rst +++ b/api-ref/source/change_history.rst @@ -11,6 +11,7 @@ Change History | 2023-09-06 | - Added an API for changing a cluster name. For details, see :ref:`Changing a Cluster Name `. | | | | | | - Added an API for checking auto scaling policies. For details, see :ref:`Viewing Auto Scaling Policies `. | +| | - Updated the description of the MRS cluster version based on the site requirements. For details, see :ref:`Creating Clusters ` and :ref:`Creating a Cluster and Running a Job `. | +-----------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | 2023-08-03 | - Modified the available specifications for MRS clusters. For details, see :ref:`ECS Specifications Used by MRS `. | +-----------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+