Changes to mrs_api-ref from docs/doc-exports#746 (MRS API 320-lts.1 version

MRS

Reviewed-by: Pruthi, Vineet <vineet.pruthi@t-systems.com>
Co-authored-by: proposalbot <proposalbot@otc-service.com>
Co-committed-by: proposalbot <proposalbot@otc-service.com>
This commit is contained in:
proposalbot 2023-06-27 12:37:15 +00:00 committed by zuul
parent e942f9b4bb
commit d592bc9081
8 changed files with 508 additions and 89 deletions

View File

@ -29,7 +29,7 @@ Before using the API, you need to obtain the resources listed in :ref:`Table 1 <
+-----------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +-----------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| Region | Obtain the region and AZ information. For more information about regions and AZs, see `Regions and Endpoints <https://docs.otc.t-systems.com/en-us/endpoint/index.html>`__. | | Region | Obtain the region and AZ information. For more information about regions and AZs, see `Regions and Endpoints <https://docs.otc.t-systems.com/en-us/endpoint/index.html>`__. |
+-----------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +-----------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| 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 and MRS 3.1.2-LTS.3. | | 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: | | Component | - MRS 3.1.2-LTS.3 supports the following components: |
| | | | | |
@ -157,6 +157,7 @@ Request
| | | | - MRS 2.1.0 | | | | | - MRS 2.1.0 |
| | | | - MRS 3.1.0-LTS.1 | | | | | - MRS 3.1.0-LTS.1 |
| | | | - MRS 3.1.2-LTS.3 | | | | | - MRS 3.1.2-LTS.3 |
| | | | - MRS 3.2.0-LTS.1 |
+-----------------------+-----------------+-----------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +-----------------------+-----------------+-----------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| cluster_type | No | Integer | Cluster type | | cluster_type | No | Integer | Cluster type |
| | | | | | | | | |

View File

@ -252,24 +252,45 @@ Response
+=======================+=======================+============================================================================================================================+ +=======================+=======================+============================================================================================================================+
| componentId | String | Component ID | | componentId | String | Component ID |
| | | | | | | |
| | | - Component IDs of MRS 3.2.0-LTS.3 are as follows: | | | | - Component IDs of MRS 3.2.0-LTS.1 are as follows: |
| | | | | | | |
| | | - MRS 3.2.0-LTS.3_001: Hadoop | | | | - MRS 3.2.0-LTS.1_001: Hadoop |
| | | - MRS 3.2.0-LTS.3_002: HBase | | | | - MRS 3.2.0-LTS.1_002: HBase |
| | | - MRS 3.2.0-LTS.3_003: Hive | | | | - MRS 3.2.0-LTS.1_003: Hive |
| | | - MRS 3.2.0-LTS.3_004: Spark2x | | | | - MRS 3.2.0-LTS.1_004: Spark2x |
| | | - MRS 3.2.0-LTS.3_006: Flink | | | | - MRS 3.2.0-LTS.1_006: Flink |
| | | - MRS 3.2.0-LTS.3_008: Kafka | | | | - MRS 3.2.0-LTS.1_008: Kafka |
| | | - MRS 3.2.0-LTS.3_009: Flume | | | | - MRS 3.2.0-LTS.1_009: Flume |
| | | - MRS 3.2.0-LTS.3_013: Loader | | | | - MRS 3.2.0-LTS.1_013: Loader |
| | | - MRS 3.2.0-LTS.3_014: Hue | | | | - MRS 3.2.0-LTS.1_014: Hue |
| | | - MRS 3.2.0-LTS.3_015: Ooize | | | | - MRS 3.2.0-LTS.1_015: Ooize |
| | | - MRS 3.2.0-LTS.3_018: DBService | | | | - MRS 3.2.0-LTS.1_018: DBService |
| | | - MRS 3.2.0-LTS.3_019: ZooKeeper | | | | - MRS 3.2.0-LTS.1_019: ZooKeeper |
| | | - MRS 3.2.0-LTS.3_022: Ranger | | | | - MRS 3.2.0-LTS.1_022: Ranger |
| | | - MRS 3.2.0-LTS.3_023: HetuEngine | | | | - MRS 3.2.0-LTS.1_023: HetuEngine |
| | | - MRS 3.2.0-LTS.3_024: Tez | | | | - MRS 3.2.0-LTS.1_024: Tez |
| | | - MRS 3.2.0-LTS.3_025: ClickHouse | | | | - MRS 3.2.0-LTS.1_025: ClickHouse |
| | | - MRS 3.2.0-LTS.1_026: CDL |
| | | - MRS 3.2.0-LTS.1_027: IoTDB |
| | | |
| | | - 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: | | | | - Component IDs of MRS 3.1.0-LTS.1 are as follows: |
| | | | | | | |
@ -287,7 +308,7 @@ Response
| | | - MRS 3.1.0-LTS.1_019: ZooKeeper | | | | - MRS 3.1.0-LTS.1_019: ZooKeeper |
| | | - MRS 3.1.0-LTS.1_022: Ranger | | | | - MRS 3.1.0-LTS.1_022: Ranger |
| | | - MRS 3.1.0-LTS.1_023: HetuEngine | | | | - MRS 3.1.0-LTS.1_023: HetuEngine |
| | | - MRS 3.2.0-LTS.3_024: Tez | | | | - MRS 3.1.2-LTS.3_024: Tez |
| | | | | | | |
| | | - Component IDs of MRS 2.1.0 are as follows: | | | | - Component IDs of MRS 2.1.0 are as follows: |
| | | | | | | |

View File

@ -239,30 +239,45 @@ Response
+=======================+=======================+============================================================================================================================+ +=======================+=======================+============================================================================================================================+
| componentId | String | Component ID | | 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: CDL |
| | | - MRS 3.2.0-LTS.1_027: IoTDB |
| | | |
| | | - Component IDs of MRS 3.1.2-LTS.3 are as follows: | | | | - 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_001: Hadoop |
| | | - MRS 3.1.2-LTS.3_002: Spark2x | | | | - MRS 3.1.2-LTS.3_002: HBase |
| | | - MRS 3.1.2-LTS.3_003: HBase | | | | - MRS 3.1.2-LTS.3_003: Hive |
| | | - MRS 3.1.2-LTS.3_004: Hive | | | | - MRS 3.1.2-LTS.3_004: Spark2x |
| | | - MRS 3.1.2-LTS.3_005: Hue | | | | - MRS 3.1.2-LTS.3_006: Flink |
| | | - MRS 3.1.2-LTS.3_006: Loader | | | | - MRS 3.1.2-LTS.3_008: Kafka |
| | | - MRS 3.1.2-LTS.3_007: Kafka | | | | - MRS 3.1.2-LTS.3_009: Flume |
| | | - MRS 3.1.2-LTS.3_008: Flume | | | | - MRS 3.1.2-LTS.3_013: Loader |
| | | - MRS 3.1.2-LTS.3_009: FTP-Server | | | | - MRS 3.1.2-LTS.3_014: Hue |
| | | - MRS 3.1.2-LTS.3_010: Solr | | | | - MRS 3.1.2-LTS.3_015: Ooize |
| | | - MRS 3.1.2-LTS.3_010: Redis | | | | - MRS 3.1.2-LTS.3_018: DBService |
| | | - MRS 3.1.2-LTS.3_011: Elasticsearch | | | | - MRS 3.1.2-LTS.3_019: ZooKeeper |
| | | - MRS 3.1.2-LTS.3_012: Flink | | | | - MRS 3.1.2-LTS.3_022: Ranger |
| | | - MRS 3.1.2-LTS.3_013: Oozie | | | | - MRS 3.1.2-LTS.3_023: HetuEngine |
| | | - MRS 3.1.2-LTS.3_014: GraphBase | | | | - MRS 3.1.2-LTS.3_024: Tez |
| | | - MRS 3.1.2-LTS.3_015: ZooKeeper | | | | - MRS 3.1.2-LTS.3_025: ClickHouse |
| | | - MRS 3.1.2-LTS.3_016: HetuEngine |
| | | - MRS 3.1.2-LTS.3_017: Ranger |
| | | - MRS 3.1.2-LTS.3_018: Tez |
| | | - MRS 3.1.2-LTS.3_019: ClickHouse |
| | | - MRS 3.1.2-LTS.3_020: Metadata |
| | | - MRS 3.1.2-LTS.3_021: KMS |
| | | | | | | |
| | | - Component IDs of MRS 3.1.0-LTS.1 are as follows: | | | | - Component IDs of MRS 3.1.0-LTS.1 are as follows: |
| | | | | | | |

View File

@ -16,20 +16,28 @@ Before using the API, you need to obtain the resources listed in :ref:`Table 1 <
.. table:: **Table 1** Obtaining resources .. table:: **Table 1** Obtaining resources
+-----------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +-----------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| Resource | How to Obtain | | Resource | How to Obtain |
+===================================+=======================================================================================================================================================================================+ +===================================+==================================================================================================================================================================================================+
| VPC | See operation instructions in **VPC > Querying VPCs** and **VPC > Creating a VPC** in the *VPC API Reference*. | | 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*. | | 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*. | | 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*. |
+-----------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +-----------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| Zone | Obtain the region and AZ information. For more information about regions and AZs, see `Regions and Endpoints <https://docs.otc.t-systems.com/en-us/endpoint/index.html>`__. | | Zone | Obtain the region and AZ information. For more information about regions and AZs, see `Regions and Endpoints <https://docs.otc.t-systems.com/en-us/endpoint/index.html>`__. |
+-----------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +-----------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| Version | Currently, MRS 1.6.3, MRS 1.7.2, MRS 1.9.2 MRS 2.1.0, MRS 3.1.0-LTS.1 and MRS 3.1.2-LTS.3 are supported. | | 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. |
+-----------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +-----------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| Component | - MRS 3.1.2-LTS.3 supports the following components: | | Component | - MRS 3.2.0-LTS.1 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 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 streaming cluster contains the following components: Kafka, Flume, ZooKeeper, and Ranger. |
@ -59,7 +67,7 @@ Before using the API, you need to obtain the resources listed in :ref:`Table 1 <
| | | | | |
| | - The analysis cluster contains the following components: Hadoop, Spark, HBase, Hive, Hue, and Loader | | | - 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. | | | - The streaming cluster contains the following components: Kafka, Storm, and Flume. |
+-----------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +-----------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
URI URI
--- ---
@ -96,6 +104,7 @@ Request
| | | | - MRS 2.1.0 | | | | | - MRS 2.1.0 |
| | | | - MRS 3.1.0-LTS.1 | | | | | - MRS 3.1.0-LTS.1 |
| | | | - MRS 3.1.2-LTS.3 | | | | | - MRS 3.1.2-LTS.3 |
| | | | - MRS 3.2.1-LTS.1 |
+------------------------+-----------------+--------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +------------------------+-----------------+--------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| cluster_name | Yes | String | Cluster name. It must be unique. | | cluster_name | Yes | String | Cluster name. It must be unique. |
| | | | | | | | | |
@ -271,7 +280,7 @@ Request
| | | | - If the role is deployed on a specified subscript node in the node group: *<role name>:<index1>,<index2>..., <indexN>*, for example, **NameNode:1,2**. The subscript starts from 1. | | | | | - If the role is deployed on a specified subscript node in the node group: *<role name>:<index1>,<index2>..., <indexN>*, for example, **NameNode:1,2**. The subscript starts from 1. |
| | | | - Some roles support multi-instance deployment (that is, multiple instances of the same role are deployed on a node): *<role name>[<instance count>*], for example, **EsNode[9]**. | | | | | - Some roles support multi-instance deployment (that is, multiple instances of the same role are deployed on a node): *<role name>[<instance count>*], for example, **EsNode[9]**. |
| | | | | | | | | |
| | | | For details about available roles, see :ref:`Roles and components supported by MRS11 <mrs_02_0106>`. | | | | | For details about available roles, see :ref:`Roles and components supported by MRS <mrs_02_0106>`. |
+---------------------+-----------------+-------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +---------------------+-----------------+-------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
.. _mrs_02_0101__table1164193817438: .. _mrs_02_0101__table1164193817438:

File diff suppressed because it is too large Load Diff

View File

@ -7,10 +7,11 @@ Appendix
- :ref:`ECS Specifications Used by MRS <mrs_01_9005>` - :ref:`ECS Specifications Used by MRS <mrs_01_9005>`
- :ref:`Status Codes <mrs_02_0015>` - :ref:`Status Codes <mrs_02_0015>`
- :ref:`Error Code <mrs_02_0014>`
- :ref:`Obtaining a Project ID <mrs_02_0011>` - :ref:`Obtaining a Project ID <mrs_02_0011>`
- :ref:`Obtaining Account ID <mrs_02_0016>` - :ref:`Obtaining Account ID <mrs_02_0016>`
- :ref:`Obtain MRS Cluster Information <mrs_02_0091>` - :ref:`Obtain MRS Cluster Information <mrs_02_0091>`
- :ref:`Roles and components supported by MRS11 <mrs_02_0106>` - :ref:`Roles and components supported by MRS <mrs_02_0106>`
.. toctree:: .. toctree::
:maxdepth: 1 :maxdepth: 1
@ -18,7 +19,8 @@ Appendix
ecs_specifications_used_by_mrs ecs_specifications_used_by_mrs
status_codes status_codes
error_code
obtaining_a_project_id obtaining_a_project_id
obtaining_account_id obtaining_account_id
obtain_mrs_cluster_information obtain_mrs_cluster_information
roles_and_components_supported_by_mrs11 roles_and_components_supported_by_mrs

View File

@ -2,8 +2,8 @@
.. _mrs_02_0106: .. _mrs_02_0106:
Roles and components supported by MRS11 Roles and components supported by MRS
======================================= =====================================
.. table:: **Table 1** Roles and components supported by MRS .. table:: **Table 1** Roles and components supported by MRS
@ -52,4 +52,11 @@ Roles and components supported by MRS11
TezUI Tez TezUI Tez
RangerAdmin Ranger RangerAdmin Ranger
RangerUserSync Ranger RangerUserSync Ranger
HSBroker HetuEngine
HSConsole HetuEngine
QAS HetuEngine
CDLConnector CDL
CDLService CDL
IoTDBServer IoTDB
ConfigNode IoTDB
================ ========== ================ ==========

View File

@ -8,10 +8,14 @@ Change History
+-----------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +-----------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| Release Date | What's New | | Release Date | What's New |
+===================================+==============================================================================================================================================================================================================+ +===================================+==============================================================================================================================================================================================================+
| 2023-05-04 | - Added the support for MRS 3.2.0-LTS.1. For details, see :ref:`Creating Clusters <mrs_02_0101>`. |
| | - Added error code reference. For details, see :ref:`Error Code <mrs_02_0014>`. |
+-----------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| 2022-9-29 | Modified the following content: | | 2022-9-29 | Modified the following content: |
| | | | | |
| | - Added MRS 1.9.2 and MRS 2.1.0 hybrid cluster components. For details, see :ref:`Creating Clusters <mrs_02_0101>`. | | | - Added MRS 1.9.2 and MRS 2.1.0 hybrid cluster components. For details, see :ref:`Creating Clusters <mrs_02_0101>`. |
| | - Add component lists for MRS 3.1.2-LTS.3 and 3.1.0-LTS.1. For details, see :ref:`Querying Cluster Details <mrs_02_0031>`. | | | - Add component lists for MRS 3.1.2-LTS.3 and 3.1.0-LTS.1. For details, see :ref:`Querying Cluster Details <mrs_02_0031>`. |
| | - Rectified the ECS specification issue. |
+-----------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +-----------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| 2022-07-05 | Modified the following content: | | 2022-07-05 | Modified the following content: |
| | | | | |