Compare commits

..

35 Commits

Author SHA1 Message Date
fb950a3655 Merge pull request 'propose-mrs_operation-guide-lts-748-RST repair' (#1) from propose-mrs_operation-guide-lts-748 into main
Reviewed-on: #1
2023-11-16 16:06:11 +00:00
74c287ece0 Update 'doc/component-operation-guide-lts/source/using_hetuengine/using_hetuengine_materialized_views/sql_statement_example_of_materialized_views.rst'
removed quotas from line 30 that probably causing that build is failing
2023-11-16 16:06:11 +00:00
3493830b7e Update content 2023-11-16 16:06:11 +00:00
a6f28c7c85 Update content 2023-11-16 16:06:11 +00:00
773d44336c Changes to mrs_best-practice from docs/doc-exports#928 (adding best practice doc
Reviewed-by: Hasko, Vladimir <vladimir.hasko@t-systems.com>
Co-authored-by: proposalbot <proposalbot@otc-service.com>
Co-committed-by: proposalbot <proposalbot@otc-service.com>
2023-10-24 00:02:54 +00:00
85a785fe87 Changes to mrs_api-ref from docs/doc-exports#860 (MRS API 20230906 version
1.AP

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>
2023-10-16 23:29:35 +00:00
c034443e6c Changes to mrs_umn from docs/doc-exports#861 (MRS UMN 20230907 version
1.Some c

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>
2023-09-07 15:03:43 +00:00
54945e8a61 Changes to mrs_api-ref from docs/doc-exports#829 (MRS API 20230804 version
Upda

Reviewed-by: Kacur, Michal <michal.kacur@t-systems.com>
Co-authored-by: proposalbot <proposalbot@otc-service.com>
Co-committed-by: proposalbot <proposalbot@otc-service.com>
2023-08-24 10:20:24 +00:00
a88879ea69 fix sphinx problems with constraints
Reviewed-by: vladimirhasko <vladimirhasko@gmail.com>
Co-authored-by: Hasko, Vladimir <vladimir.hasko@t-systems.com>
Co-committed-by: Hasko, Vladimir <vladimir.hasko@t-systems.com>
2023-08-10 16:14:39 +00:00
1b54a57256 Changes to mrs_umn from docs/doc-exports#747 (MRS UMN 320-lts.1 version
Release

Reviewed-by: Herenger, Hubert <hubert.herenger@t-systems.com>
Co-authored-by: proposalbot <proposalbot@otc-service.com>
Co-committed-by: proposalbot <proposalbot@otc-service.com>
2023-07-27 07:50:00 +00:00
d592bc9081 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>
2023-06-27 12:37:15 +00:00
e942f9b4bb Changes to mrs_api-ref from docs/doc-exports#769 (chore: use convertor from sepa
Reviewed-by: Hasko, Vladimir <vladimir.hasko@t-systems.com>
Co-authored-by: proposalbot <proposalbot@otc-service.com>
Co-committed-by: proposalbot <proposalbot@otc-service.com>
2023-06-03 08:30:03 +00:00
d68f08e7c3 Changes to mrs_umn from docs/doc-exports#769 (chore: use convertor from separate
Reviewed-by: Hasko, Vladimir <vladimir.hasko@t-systems.com>
Co-authored-by: proposalbot <proposalbot@otc-service.com>
Co-committed-by: proposalbot <proposalbot@otc-service.com>
2023-06-03 08:29:26 +00:00
aeffc8bd60 Changes to mrs_operation-guide from docs/doc-exports#769 (chore: use convertor f
Reviewed-by: Hasko, Vladimir <vladimir.hasko@t-systems.com>
Co-authored-by: proposalbot <proposalbot@otc-service.com>
Co-committed-by: proposalbot <proposalbot@otc-service.com>
2023-06-03 01:55:40 +00:00
acbebc1d6e Changes to mrs_operation-guide-lts from docs/doc-exports#769 (chore: use convert
Reviewed-by: Hasko, Vladimir <vladimir.hasko@t-systems.com>
Co-authored-by: proposalbot <proposalbot@otc-service.com>
Co-committed-by: proposalbot <proposalbot@otc-service.com>
2023-06-03 01:55:37 +00:00
79abdaf4e8 Changes to mrs_api-ref from docs/doc-exports#773 (Deprecating Swift API and enab
Reviewed-by: Hasko, Vladimir <vladimir.hasko@t-systems.com>
Co-authored-by: proposalbot <proposalbot@otc-service.com>
Co-committed-by: proposalbot <proposalbot@otc-service.com>
2023-06-01 21:19:33 +00:00
16d25be0bf Changes to mrs_operation-guide from docs/doc-exports#773 (Deprecating Swift API
Reviewed-by: Hasko, Vladimir <vladimir.hasko@t-systems.com>
Co-authored-by: proposalbot <proposalbot@otc-service.com>
Co-committed-by: proposalbot <proposalbot@otc-service.com>
2023-06-01 21:18:06 +00:00
f8f66a6098 Changes to mrs_operation-guide-lts from docs/doc-exports#773 (Deprecating Swift
Reviewed-by: Hasko, Vladimir <vladimir.hasko@t-systems.com>
Co-authored-by: proposalbot <proposalbot@otc-service.com>
Co-committed-by: proposalbot <proposalbot@otc-service.com>
2023-06-01 21:18:03 +00:00
26e47fdf78 Changes to mrs_umn from docs/doc-exports#773 (Deprecating Swift API and enabling
Reviewed-by: Hasko, Vladimir <vladimir.hasko@t-systems.com>
Co-authored-by: proposalbot <proposalbot@otc-service.com>
Co-committed-by: proposalbot <proposalbot@otc-service.com>
2023-06-01 18:50:55 +00:00
adb7a0ef94 Service Based View
Reviewed-by: Kacur, Michal <michal.kacur@t-systems.com>
Co-authored-by: Gode, Sebastian <sebastian.gode@t-systems.com>
Co-committed-by: Gode, Sebastian <sebastian.gode@t-systems.com>
2023-05-12 10:18:57 +00:00
9b40dd875b Changes to mrs_api-ref from docs/doc-exports#677 (Add unittests for conversion
Reviewed-by: Hasko, Vladimir <vladimir.hasko@t-systems.com>
Co-authored-by: proposalbot <proposalbot@otc-service.com>
Co-committed-by: proposalbot <proposalbot@otc-service.com>
2023-03-22 10:00:18 +00:00
ba5b8f80e7 Changes to mrs_umn from docs/doc-exports#677 (Add unittests for conversion
add

Reviewed-by: Hasko, Vladimir <vladimir.hasko@t-systems.com>
Co-authored-by: proposalbot <proposalbot@otc-service.com>
Co-committed-by: proposalbot <proposalbot@otc-service.com>
2023-03-22 09:21:15 +00:00
c356dcdb1f Changes to mrs_operation-guide-lts from docs/doc-exports#677 (Add unittests for
Reviewed-by: Hasko, Vladimir <vladimir.hasko@t-systems.com>
Co-authored-by: proposalbot <proposalbot@otc-service.com>
Co-committed-by: proposalbot <proposalbot@otc-service.com>
2023-03-22 09:21:12 +00:00
533dd26c25 Changes to mrs_operation-guide from docs/doc-exports#677 (Add unittests for conv
Reviewed-by: Hasko, Vladimir <vladimir.hasko@t-systems.com>
Co-authored-by: proposalbot <proposalbot@otc-service.com>
Co-committed-by: proposalbot <proposalbot@otc-service.com>
2023-03-22 09:21:10 +00:00
af4960df58 Changes to mrs_operation-guide-lts from docs/doc-exports#576 (adding fix for & c
Reviewed-by: Hasko, Vladimir <vladimir.hasko@t-systems.com>
Co-authored-by: proposalbot <proposalbot@otc-service.com>
Co-committed-by: proposalbot <proposalbot@otc-service.com>
2023-01-25 16:41:08 +00:00
c130711397 Changes to mrs_operation-guide from docs/doc-exports#576 (adding fix for & chara
Reviewed-by: Hasko, Vladimir <vladimir.hasko@t-systems.com>
Co-authored-by: proposalbot <proposalbot@otc-service.com>
Co-committed-by: proposalbot <proposalbot@otc-service.com>
2023-01-25 16:41:06 +00:00
f8f8093f4e Changes to mrs_api-ref from docs/doc-exports#576 (adding fix for & character)
Reviewed-by: Hasko, Vladimir <vladimir.hasko@t-systems.com>
Co-authored-by: proposalbot <proposalbot@otc-service.com>
Co-committed-by: proposalbot <proposalbot@otc-service.com>
2023-01-25 16:16:43 +00:00
4e7508dd04 Changes to mrs_umn from docs/doc-exports#576 (adding fix for & character)
Reviewed-by: Hasko, Vladimir <vladimir.hasko@t-systems.com>
Co-authored-by: proposalbot <proposalbot@otc-service.com>
Co-committed-by: proposalbot <proposalbot@otc-service.com>
2023-01-25 16:16:41 +00:00
d31d5b10fe Changes to mrs_operation-guide-lts from docs/doc-exports#515 (MRS comp-lts 2.0.3
Reviewed-by: Kacur, Michal <michal.kacur@t-systems.com>
Co-authored-by: proposalbot <proposalbot@otc-service.com>
Co-committed-by: proposalbot <proposalbot@otc-service.com>
2023-01-19 16:53:12 +00:00
d220d65b12 Update tox.ini && conf.py file
Reviewed-by: gtema <artem.goncharov@gmail.com>
Co-authored-by: Hasko, Vladimir <vladimir.hasko@t-systems.com>
Co-committed-by: Hasko, Vladimir <vladimir.hasko@t-systems.com>
2023-01-13 17:06:23 +00:00
eb952b6d23 Changes to mrs_umn from docs/doc-exports#569 (Workaround bolds ending with space
Reviewed-by: gtema <artem.goncharov@gmail.com>
Reviewed-by: Hasko, Vladimir <vladimir.hasko@t-systems.com>
Co-authored-by: proposalbot <proposalbot@otc-service.com>
Co-committed-by: proposalbot <proposalbot@otc-service.com>
2023-01-12 19:40:13 +00:00
81a0ecb29d Changes to mrs_operation-guide-lts from docs/doc-exports#569 (Workaround bolds e
Reviewed-by: gtema <artem.goncharov@gmail.com>
Co-authored-by: proposalbot <proposalbot@otc-service.com>
Co-committed-by: proposalbot <proposalbot@otc-service.com>
2023-01-12 17:02:56 +00:00
Goncharov, Artem
50ca5604e5 Update Docs configuration
Reviewed-by: gtema <artem.goncharov@gmail.com>
Co-authored-by: Goncharov, Artem <artem.goncharov@t-systems.com>
Co-committed-by: Goncharov, Artem <artem.goncharov@t-systems.com>
2023-01-06 22:09:40 +00:00
Goncharov, Artem
f5c3c21c0b Update Docs configuration
Reviewed-by: gtema <artem.goncharov@gmail.com>
Co-authored-by: Goncharov, Artem <artem.goncharov@t-systems.com>
Co-committed-by: Goncharov, Artem <artem.goncharov@t-systems.com>
2023-01-03 17:45:20 +00:00
c558050975 adding new entry for new documentation type
Reviewed-by: Kucerak, Kristian <kristian.kucerak@t-systems.com>
Co-authored-by: Hasko, Vladimir <vladimir.hasko@t-systems.com>
Co-committed-by: Hasko, Vladimir <vladimir.hasko@t-systems.com>
2022-12-13 23:05:50 +00:00
2607 changed files with 81318 additions and 2287 deletions

View File

@ -0,0 +1,14 @@
:original_name: mrs_02_0199.html
.. _mrs_02_0199:
Auto Scaling APIs (V2)
======================
- :ref:`Viewing Auto Scaling Policies <mrs_02_0200>`
.. toctree::
:maxdepth: 1
:hidden:
viewing_auto_scaling_policies

File diff suppressed because it is too large Load Diff

View File

@ -0,0 +1,95 @@
:original_name: mrs_02_0201.html
.. _mrs_02_0201:
Changing a Cluster Name
=======================
Function
--------
This API is used to change a cluster name.
URI
---
PUT /v2/{project_id}/clusters/{cluster_id}/cluster-name
.. table:: **Table 1** URI parameters
+------------+-----------+--------+------------------------------------------------------------------------------------------------------------------+
| Parameter | Mandatory | Type | Description |
+============+===========+========+==================================================================================================================+
| project_id | Yes | String | The project ID. For details about how to obtain the project ID, see :ref:`Obtaining a Project ID <mrs_02_0011>`. |
+------------+-----------+--------+------------------------------------------------------------------------------------------------------------------+
| cluster_id | Yes | String | The cluster ID. For details about how to obtain the cluster ID, see :ref:`Obtaining a Project ID <mrs_02_0011>`. |
+------------+-----------+--------+------------------------------------------------------------------------------------------------------------------+
Request Parameters
------------------
.. table:: **Table 2** Request body parameter
============ ========= ====== =====================
Parameter Mandatory Type Description
============ ========= ====== =====================
cluster_name Yes String The new cluster name.
============ ========= ====== =====================
Response Parameters
-------------------
**Status code: 200**
.. table:: **Table 3** Response body parameter
+-----------+--------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| Parameter | Type | Description |
+===========+========+==================================================================================================================================================================================+
| result | String | The operation result of the mapping update request. Value \**succeeded*\* indicates that the operation is successful, and value \**failed*\* indicates that the operation fails. |
+-----------+--------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
**Status code: 400**
.. table:: **Table 4** Response body parameters
========== ====== ==================
Parameter Type Description
========== ====== ==================
error_code String The error code.
error_msg String The error message.
========== ====== ==================
Example Request
---------------
Change the MRS cluster name to **mrs_jdRU_dm01**.
.. code-block::
{
"cluster_name" : "mrs_jdRU_dm01"
}
Example Response
----------------
**Status code: 200**
The cluster name is changed.
.. code-block::
{
"result" : "succeeded"
}
Status Codes
------------
See :ref:`Status Codes <mrs_02_0015>`.
Error Codes
-----------
See :ref:`Error Code <mrs_02_0014>`.

View File

@ -6,9 +6,11 @@ Cluster management APIs (V2)
============================
- :ref:`Creating Clusters <mrs_02_0101>`
- :ref:`Changing a Cluster Name <mrs_02_0201>`
.. toctree::
:maxdepth: 1
:hidden:
creating_clusters
changing_a_cluster_name

View File

@ -11,6 +11,7 @@ APIs
- :ref:`Job Binary Object APIs <mrs_02_0033>`
- :ref:`Job Object APIs (V1, Not Recommended) <mrs_02_0039>`
- :ref:`Job Execution Object APIs (V1, Not Recommended) <mrs_02_0049>`
- :ref:`Auto Scaling APIs (V2) <mrs_02_0199>`
- :ref:`Job Object APIs (V2) <mrs_02_0084>`
- :ref:`Auto Scaling APIs <mrs_02_0054>`
- :ref:`Tag Management APIs <mrs_02_0070>`
@ -23,8 +24,9 @@ APIs
cluster_management_apis_v2/index
cluster_management_apis_v1/index
job_binary_object_apis/index
job_object_apis_v1,_not_recommended/index
job_execution_object_apis_v1,_not_recommended/index
job_object_apis_v1_not_recommended/index
job_execution_object_apis_v1_not_recommended/index
auto_scaling_apis_v2/index
job_object_apis_v2/index
auto_scaling_apis/index
tag_management_apis/index

File diff suppressed because it is too large Load Diff

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:`Status Codes <mrs_02_0015>`
- :ref:`Error Code <mrs_02_0014>`
- :ref:`Obtaining a Project ID <mrs_02_0011>`
- :ref:`Obtaining Account ID <mrs_02_0016>`
- :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::
:maxdepth: 1
@ -18,7 +19,8 @@ Appendix
ecs_specifications_used_by_mrs
status_codes
error_code
obtaining_a_project_id
obtaining_account_id
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:
Roles and components supported by MRS11
=======================================
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
RangerAdmin Ranger
RangerUserSync Ranger
HSBroker HetuEngine
HSConsole HetuEngine
QAS HetuEngine
CDLConnector CDL
CDLService CDL
IoTDBServer IoTDB
ConfigNode IoTDB
================ ==========

View File

@ -8,10 +8,21 @@ Change History
+-----------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| Release Date | What's New |
+===================================+==============================================================================================================================================================================================================+
| 2023-09-06 | - Added an API for changing a cluster name. For details, see :ref:`Changing a Cluster Name <mrs_02_0201>`. |
| | |
| | - Added an API for checking auto scaling policies. For details, see :ref:`Viewing Auto Scaling Policies <mrs_02_0200>`. |
| | - Updated the description of the MRS cluster version based on the site requirements. For details, see :ref:`Creating Clusters <mrs_02_0101>` and :ref:`Creating a Cluster and Running a Job <mrs_02_0028>`. |
+-----------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| 2023-08-03 | - Modified the available specifications for MRS clusters. For details, see :ref:`ECS Specifications Used by MRS <mrs_01_9005>`. |
+-----------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| 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: |
| | |
| | - 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>`. |
| | - Rectified the ECS specification issue. |
+-----------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| 2022-07-05 | Modified the following content: |
| | |

View File

@ -18,18 +18,29 @@ import os
import sys
extensions = [
'otcdocstheme'
'otcdocstheme',
]
otcdocs_auto_name = False
otcdocs_auto_version = False
project = 'Map Reduce Service'
project = 'MapReduce Service'
otcdocs_repo_name = 'docs/mapreduce-service'
# Those variables are required for edit/bug links
otcdocs_git_fqdn = 'gitea.eco.tsi-dev.otc-service.com'
otcdocs_git_type = 'gitea'
# Those variables are needed for indexing into OpenSearch
otcdocs_doc_environment = 'internal'
otcdocs_doc_link = '/mapreduce-service/api-ref/'
otcdocs_doc_title = 'API Reference'
otcdocs_doc_type = 'api-ref'
otcdocs_service_category = 'big_data'
otcdocs_service_title = 'MapReduce Service'
otcdocs_service_type = 'mrs'
otcdocs_search_environment = 'hc_de'
otcdocs_search_url = "https://opensearch.eco.tsi-dev.otc-service.com/"
# If extensions (or modules to document with autodoc) are in another directory,
# add these directories to sys.path here. If the directory is relative to the
# documentation root, use os.path.abspath to make it absolute, like shown here.
@ -86,7 +97,7 @@ html_theme_options = {
# The name for this set of Sphinx documents. If None, it defaults to
# "<project> v<release> documentation".
html_title = "Map Reduce Service - API Reference"
html_title = "MapReduce Service - API Reference"
# Add any paths that contain custom static files (such as style sheets) here,
@ -94,10 +105,13 @@ html_title = "Map Reduce Service - API Reference"
# so a file named "default.css" will overwrite the builtin "default.css".
html_static_path = ['_static']
# Do not include sources into the rendered results
html_copy_source = False
# -- Options for PDF output --------------------------------------------------
latex_documents = [
('index',
'mrs-api-ref.tex',
u'Map Reduce Service - API Reference',
u'MapReduce Service - API Reference',
u'OpenTelekomCloud', 'manual'),
]

View File

@ -1,6 +1,6 @@
==================================
Map Reduce Service - API Reference
==================================
=================================
MapReduce Service - API Reference
=================================
.. toctree::
:maxdepth: 1

File diff suppressed because it is too large Load Diff

View File

@ -0,0 +1,2 @@
[html writers]
table-style: table, caption-top

View File

@ -0,0 +1,4 @@
=================================
MapReduce Service - Best Practice
=================================

Binary file not shown.

After

Width:  |  Height:  |  Size: 1.2 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 20 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 21 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 127 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 3.1 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 26 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 20 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 330 B

Binary file not shown.

After

Width:  |  Height:  |  Size: 330 B

Binary file not shown.

After

Width:  |  Height:  |  Size: 6.5 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 8.9 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 26 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 574 B

Binary file not shown.

After

Width:  |  Height:  |  Size: 1.0 KiB

Some files were not shown because too many files have changed in this diff Show More