A200161411/cloud-container-engine
1
0
Fork 0
forked from docs/cloud-container-engine
Code Pull Requests Activity

Update content

Browse Source
This commit is contained in:
OpenTelekomCloud Proposal Bot 2022-10-31 11:22:34 +00:00
parent 34bdead49a
commit b2758f1111
11 changed files with 93 additions and 98 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

30
api-ref/source/apis/cluster_management/creating_a_cluster.rst
View File

@ -13,7 +13,7 @@ This API is used to create an empty cluster, which has only master nodes but do
.. note:: .. note::
- The URL for cluster management is in the format of **https://Endpoint/uri**. In the URL, **uri** indicates the resource path, that is, the path for API access. - The URL for cluster management is in the format of **https://Endpoint/uri**. In the URL, **uri** indicates the resource path, that is, the path for API access.
- Info collect agent (ICAgent) is an O&M data collection agent used by Application Performance Management (APM) service. It runs on each server to collect data from probes in real time. When this API is called to create a cluster, ICAgent is not installed by default. To automatically install ICAgent during cluster creation, add **"cluster.install.addons.external/install": "[{\"addonTemplateName\":\"icagent\"}]"** to the **annotations** field in the request body. - Info collect agent (ICAgent) is an O&M data collection agent used by Application Performance Management (APM) service. It runs on each server to collect data from probes in real time. When this API is called to create a cluster, ICAgent is not installed by default. To automatically install ICAgent during cluster creation, add **"cluster.install.addons.external/install": "[{\\"addonTemplateName\\":\\"icagent\\"}]"** to the **annotations** field in the request body.
- Before creating a cluster, :ref:`Creating a VPC and Subnet <cce_02_0100>`. If a VPC and subnet already exists, you do not need to create them again. - Before creating a cluster, :ref:`Creating a VPC and Subnet <cce_02_0100>`. If a VPC and subnet already exists, you do not need to create them again.
- By default, an account can create a maximum of five clusters in each region. - By default, an account can create a maximum of five clusters in each region.
@ -127,18 +127,18 @@ Request
+----------------------+-----------------+-----------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +----------------------+-----------------+-----------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| flavor | Yes | String | Cluster flavor. | | flavor | Yes | String | Cluster flavor. |
| | | | | | | | | |
| | | | - **cce.s1.small**: small-scale, single-master cluster (≤ 50 nodes) | | | | | - **cce.s1.small**: small-scale, single-master cluster (<= 50 nodes) |
| | | | - **cce.s1.medium**: medium-scale, single-master cluster (≤ 200 nodes) | | | | | - **cce.s1.medium**: medium-scale, single-master cluster (<= 200 nodes) |
| | | | - **cce.s2.small**: small-scale, high availability cluster (≤ 50 nodes) | | | | | - **cce.s2.small**: small-scale, high availability cluster (<= 50 nodes) |
| | | | - **cce.s2.medium**: medium-scale, high availability cluster (≤ 200 nodes) | | | | | - **cce.s2.medium**: medium-scale, high availability cluster (<= 200 nodes) |
| | | | - **cce.s2.large**: large-scale, high availability cluster (≤ 1,000 nodes) | | | | | - **cce.s2.large**: large-scale, high availability cluster (<= 1,000 nodes) |
| | | | - **cce.s2.xlarge**: ultra-large-scale, high availability cluster (≤ 2,000 nodes) | | | | | - **cce.s2.xlarge**: ultra-large-scale, high availability cluster (<= 2,000 nodes) |
| | | | | | | | | |
| | | | .. note:: | | | | | .. note:: |
| | | | | | | | | |
| | | | - s1: single-master cluster | | | | | - s1: single-master cluster |
| | | | - s2: high availability cluster | | | | | - s2: high availability cluster |
| | | | - For example, **≤ 50 nodes** indicates that the maximum number of nodes that can be managed by the cluster is 50. | | | | | - For example, **<= 50 nodes** indicates that the maximum number of nodes that can be managed by the cluster is 50. |
| | | | - A single-master cluster has only one master node. If the master node is down, the cluster will become unavailable and stop serving new workloads. However, existing workloads in the cluster are not affected. | | | | | - A single-master cluster has only one master node. If the master node is down, the cluster will become unavailable and stop serving new workloads. However, existing workloads in the cluster are not affected. |
| | | | - A high-availability cluster has multiple master nodes. Faults in a single master node will not take the cluster down. | | | | | - A high-availability cluster has multiple master nodes. Faults in a single master node will not take the cluster down. |
+----------------------+-----------------+-----------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +----------------------+-----------------+-----------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
@ -530,18 +530,18 @@ Response
+-----------------------+-----------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +-----------------------+-----------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| flavor | String | Cluster flavor, which cannot be changed after the cluster is created. | | flavor | String | Cluster flavor, which cannot be changed after the cluster is created. |
| | | | | | | |
| | | - **cce.s1.small**: small-scale, single-master cluster (≤ 50 nodes) | | | | - **cce.s1.small**: small-scale, single-master cluster (<= 50 nodes) |
| | | - **cce.s1.medium**: medium-scale, single-master cluster (≤ 200 nodes) | | | | - **cce.s1.medium**: medium-scale, single-master cluster (<= 200 nodes) |
| | | - **cce.s2.small**: small-scale, high availability cluster (≤ 50 nodes) | | | | - **cce.s2.small**: small-scale, high availability cluster (<= 50 nodes) |
| | | - **cce.s2.medium**: medium-scale, high availability cluster (≤ 200 nodes) | | | | - **cce.s2.medium**: medium-scale, high availability cluster (<= 200 nodes) |
| | | - **cce.s2.large**: large-scale, high availability cluster (≤ 1,000 nodes) | | | | - **cce.s2.large**: large-scale, high availability cluster (<= 1,000 nodes) |
| | | - **cce.s2.xlarge**: ultra-large-scale, high availability cluster (≤ 2,000 nodes) | | | | - **cce.s2.xlarge**: ultra-large-scale, high availability cluster (<= 2,000 nodes) |
| | | | | | | |
| | | .. note:: | | | | .. note:: |
| | | | | | | |
| | | - s1: single-master cluster | | | | - s1: single-master cluster |
| | | - s2: high availability cluster | | | | - s2: high availability cluster |
| | | - For example, **≤ 50 nodes** indicates that the maximum number of nodes that can be managed by the cluster is 50. | | | | - For example, **<= 50 nodes** indicates that the maximum number of nodes that can be managed by the cluster is 50. |
| | | - A single-master cluster is a cluster that has only one master node. If the master node is down, the cluster will become unavailable and stop serving new workloads. However, existing workloads in the cluster are not affected. | | | | - A single-master cluster is a cluster that has only one master node. If the master node is down, the cluster will become unavailable and stop serving new workloads. However, existing workloads in the cluster are not affected. |
| | | - A high-availability cluster has multiple master nodes. Faults in a single master node will not take the cluster down. | | | | - A high-availability cluster has multiple master nodes. Faults in a single master node will not take the cluster down. |
+-----------------------+-----------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +-----------------------+-----------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+

128
api-ref/source/apis/cluster_management/creating_a_node_pool.rst
View File

File diff suppressed because it is too large Load Diff

2
api-ref/source/apis/cluster_management/deleting_a_node_pool.rst
View File

@ -140,7 +140,7 @@ Response
| | | | | | | |
| | | Maximum: **50** | | | | Maximum: **50** |
+-----------------------+---------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +-----------------------+---------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| az | String | \\t\nName of the AZ where the node is located. This AZ exists at the underlying layer and is in the physical AZ group of the user. | | az | String | \\t\\nName of the AZ where the node is located. This AZ exists at the underlying layer and is in the physical AZ group of the user. |
| | | | | | | |
| | | Maximum: **200** | | | | Maximum: **200** |
+-----------------------+---------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +-----------------------+---------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+

2
api-ref/source/apis/cluster_management/listing_all_node_pools_in_a_specified_cluster.rst
View File

@ -175,7 +175,7 @@ Response
| | | | | | | |
| | | Maximum: **50** | | | | Maximum: **50** |
+-----------------------+---------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +-----------------------+---------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| az | String | \\t\nName of the AZ where the node is located. This AZ exists at the underlying layer and is in the physical AZ group of the user. | | az | String | \\t\\nName of the AZ where the node is located. This AZ exists at the underlying layer and is in the physical AZ group of the user. |
| | | | | | | |
| | | Maximum: **200** | | | | Maximum: **200** |
+-----------------------+---------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +-----------------------+---------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+

14
api-ref/source/apis/cluster_management/reading_a_specified_cluster.rst
View File

@ -102,18 +102,18 @@ Response
+-----------------------+-----------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +-----------------------+-----------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| flavor | String | Cluster flavor, which cannot be changed after the cluster is created. | | flavor | String | Cluster flavor, which cannot be changed after the cluster is created. |
| | | | | | | |
| | | - **cce.s1.small**: small-scale, single-master cluster (≤ 50 nodes) | | | | - **cce.s1.small**: small-scale, single-master cluster (<= 50 nodes) |
| | | - **cce.s1.medium**: medium-scale, single-master cluster (≤ 200 nodes) | | | | - **cce.s1.medium**: medium-scale, single-master cluster (<= 200 nodes) |
| | | - **cce.s2.small**: small-scale, high availability cluster (≤ 50 nodes) | | | | - **cce.s2.small**: small-scale, high availability cluster (<= 50 nodes) |
| | | - **cce.s2.medium**: medium-scale, high availability cluster (≤ 200 nodes) | | | | - **cce.s2.medium**: medium-scale, high availability cluster (<= 200 nodes) |
| | | - **cce.s2.large**: large-scale, high availability cluster (≤ 1,000 nodes) | | | | - **cce.s2.large**: large-scale, high availability cluster (<= 1,000 nodes) |
| | | - **cce.s2.xlarge**: ultra-large-scale, high availability cluster (≤ 2,000 nodes) | | | | - **cce.s2.xlarge**: ultra-large-scale, high availability cluster (<= 2,000 nodes) |
| | | | | | | |
| | | .. note:: | | | | .. note:: |
| | | | | | | |
| | | - s1: single-master cluster | | | | - s1: single-master cluster |
| | | - s2: high availability cluster | | | | - s2: high availability cluster |
| | | - For example, **≤ 50 nodes** indicates that the maximum number of nodes that can be managed by the cluster is 50. | | | | - For example, **<= 50 nodes** indicates that the maximum number of nodes that can be managed by the cluster is 50. |
| | | - A single-master cluster has only one master node. If the master node is down, the cluster will become unavailable and stop serving new workloads. However, existing workloads in the cluster are not affected. | | | | - A single-master cluster has only one master node. If the master node is down, the cluster will become unavailable and stop serving new workloads. However, existing workloads in the cluster are not affected. |
| | | - A high-availability cluster has multiple master nodes. Faults in a single master node will not take the cluster down. | | | | - A high-availability cluster has multiple master nodes. Faults in a single master node will not take the cluster down. |
+-----------------------+-----------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +-----------------------+-----------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+

2
api-ref/source/appendix/creating_a_vpc_and_subnet.rst
View File

@ -25,7 +25,6 @@ Creating a VPC
.. figure:: /_static/images/en-us_image_0233731209.png .. figure:: /_static/images/en-us_image_0233731209.png
:alt: **Figure 1** Obtaining the VPC ID :alt: **Figure 1** Obtaining the VPC ID
**Figure 1** Obtaining the VPC ID **Figure 1** Obtaining the VPC ID
Creating a Subnet Creating a Subnet
@ -41,5 +40,4 @@ Creating a Subnet
.. figure:: /_static/images/en-us_image_0233732535.png .. figure:: /_static/images/en-us_image_0233732535.png
:alt: **Figure 2** Obtaining the network ID of a subnet :alt: **Figure 2** Obtaining the network ID of a subnet
**Figure 2** Obtaining the network ID of a subnet **Figure 2** Obtaining the network ID of a subnet

4
api-ref/source/appendix/how_to_obtain_parameters_in_the_api_uri.rst
View File

@ -16,7 +16,6 @@ project_id
.. figure:: /_static/images/en-us_image_0203982493.png .. figure:: /_static/images/en-us_image_0203982493.png
:alt: **Figure 1** Viewing project IDs :alt: **Figure 1** Viewing project IDs
**Figure 1** Viewing project IDs **Figure 1** Viewing project IDs
cluster_id cluster_id
@ -30,7 +29,6 @@ cluster_id
.. figure:: /_static/images/en-us_image_0233732613.png .. figure:: /_static/images/en-us_image_0233732613.png
:alt: **Figure 2** Obtaining the cluster ID :alt: **Figure 2** Obtaining the cluster ID
**Figure 2** Obtaining the cluster ID **Figure 2** Obtaining the cluster ID
node_id node_id
@ -44,7 +42,6 @@ node_id
.. figure:: /_static/images/en-us_image_0279177365.png .. figure:: /_static/images/en-us_image_0279177365.png
:alt: **Figure 3** Obtaining the node ID :alt: **Figure 3** Obtaining the node ID
**Figure 3** Obtaining the node ID **Figure 3** Obtaining the node ID
job_id job_id
@ -62,5 +59,4 @@ job_id
.. figure:: /_static/images/en-us_image_0203982464.png .. figure:: /_static/images/en-us_image_0203982464.png
:alt: **Figure 4** Obtaining the job ID :alt: **Figure 4** Obtaining the job ID
**Figure 4** Obtaining the job ID **Figure 4** Obtaining the job ID

4
api-ref/source/appendix/how_to_use_elb_in_a_cluster.rst
View File

@ -93,8 +93,8 @@ Using an existing ELB:
| | | | | | | |
| | | **Example:** | | | | **Example:** |
| | | | | | | |
| | | - Value for a public network load balancer that is automatically created: "{\"type\":\"public\",\"bandwidth_name\":\"cce-bandwidth-1551163379627\",\"bandwidth_chargemode\":\"traffic\",\"bandwidth_size\":5,\"bandwidth_sharetype\":\"PER\",\"eip_type\":\"5_bgp\",\"name\":\"james\"}" | | | | - Value for a public network load balancer that is automatically created: "{\\"type\\":\\"public\\",\\"bandwidth_name\\":\\"cce-bandwidth-1551163379627\\",\\"bandwidth_chargemode\\":\\"traffic\\",\\"bandwidth_size\\":5,\\"bandwidth_sharetype\\":\\"PER\\",\\"eip_type\\":\\"5_bgp\\",\\"name\\":\\"james\\"}" |
| | | - Value for a private network load balancer that is automatically created: "{\"type\":\"inner\"}" | | | | - Value for a private network load balancer that is automatically created: "{\\"type\\":\\"inner\\"}" |
+-------------------------------------+-----------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +-------------------------------------+-----------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| loadBalancerIP | String | Private IP address of a private network load balancer or public IP address of a public network load balancer. | | loadBalancerIP | String | Private IP address of a private network load balancer or public IP address of a public network load balancer. |
+-------------------------------------+-----------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +-------------------------------------+-----------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+

1
api-ref/source/appendix/obtaining_a_project_id.rst
View File

@ -55,5 +55,4 @@ A project ID is required for some URLs when an API is called. To obtain a projec
.. figure:: /_static/images/en-us_image_0203982368.png .. figure:: /_static/images/en-us_image_0203982368.png
:alt: **Figure 1** Obtaining the Project ID :alt: **Figure 1** Obtaining the Project ID
**Figure 1** Obtaining the Project ID **Figure 1** Obtaining the Project ID

1
api-ref/source/appendix/obtaining_the_account_id.rst
View File

@ -17,5 +17,4 @@ An account ID is required for some URLs when an API is called. To obtain an acco
.. figure:: /_static/images/en-us_image_0233731004.png .. figure:: /_static/images/en-us_image_0233731004.png
:alt: **Figure 1** Obtaining the Account ID :alt: **Figure 1** Obtaining the Account ID
**Figure 1** Obtaining the Account ID **Figure 1** Obtaining the Account ID

3
api-ref/source/conf.py
View File

@ -35,6 +35,9 @@ sys.path.insert(0, os.path.abspath('../'))
sys.path.insert(0, os.path.abspath('./')) sys.path.insert(0, os.path.abspath('./'))
# -- General configuration ---------------------------------------------------- # -- General configuration ----------------------------------------------------
# https://docutils.sourceforge.io/docs/user/smartquotes.html - it does not
# what it is expected
smartquotes = False
# Add any Sphinx extension module names here, as strings. They can be # Add any Sphinx extension module names here, as strings. They can be
# extensions coming with Sphinx (named 'sphinx.ext.*') or your custom ones. # extensions coming with Sphinx (named 'sphinx.ext.*') or your custom ones.