Update content
This commit is contained in:
parent
34bdead49a
commit
b2758f1111
@ -13,7 +13,7 @@ This API is used to create an empty cluster, which has only master nodes but do
|
||||
.. 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.
|
||||
- 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.
|
||||
- By default, an account can create a maximum of five clusters in each region.
|
||||
|
||||
@ -127,18 +127,18 @@ Request
|
||||
+----------------------+-----------------+-----------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| flavor | Yes | String | Cluster flavor. |
|
||||
| | | | |
|
||||
| | | | - **cce.s1.small**: small-scale, single-master cluster (≤ 50 nodes) |
|
||||
| | | | - **cce.s1.medium**: medium-scale, single-master cluster (≤ 200 nodes) |
|
||||
| | | | - **cce.s2.small**: small-scale, high availability cluster (≤ 50 nodes) |
|
||||
| | | | - **cce.s2.medium**: medium-scale, high availability cluster (≤ 200 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.s1.small**: small-scale, single-master cluster (<= 50 nodes) |
|
||||
| | | | - **cce.s1.medium**: medium-scale, single-master cluster (<= 200 nodes) |
|
||||
| | | | - **cce.s2.small**: small-scale, high availability cluster (<= 50 nodes) |
|
||||
| | | | - **cce.s2.medium**: medium-scale, high availability cluster (<= 200 nodes) |
|
||||
| | | | - **cce.s2.large**: large-scale, high availability cluster (<= 1,000 nodes) |
|
||||
| | | | - **cce.s2.xlarge**: ultra-large-scale, high availability cluster (<= 2,000 nodes) |
|
||||
| | | | |
|
||||
| | | | .. note:: |
|
||||
| | | | |
|
||||
| | | | - s1: single-master 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 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. |
|
||||
| | | |
|
||||
| | | - **cce.s1.small**: small-scale, single-master cluster (≤ 50 nodes) |
|
||||
| | | - **cce.s1.medium**: medium-scale, single-master cluster (≤ 200 nodes) |
|
||||
| | | - **cce.s2.small**: small-scale, high availability cluster (≤ 50 nodes) |
|
||||
| | | - **cce.s2.medium**: medium-scale, high availability cluster (≤ 200 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.s1.small**: small-scale, single-master cluster (<= 50 nodes) |
|
||||
| | | - **cce.s1.medium**: medium-scale, single-master cluster (<= 200 nodes) |
|
||||
| | | - **cce.s2.small**: small-scale, high availability cluster (<= 50 nodes) |
|
||||
| | | - **cce.s2.medium**: medium-scale, high availability cluster (<= 200 nodes) |
|
||||
| | | - **cce.s2.large**: large-scale, high availability cluster (<= 1,000 nodes) |
|
||||
| | | - **cce.s2.xlarge**: ultra-large-scale, high availability cluster (<= 2,000 nodes) |
|
||||
| | | |
|
||||
| | | .. note:: |
|
||||
| | | |
|
||||
| | | - s1: single-master 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 high-availability cluster has multiple master nodes. Faults in a single master node will not take the cluster down. |
|
||||
+-----------------------+-----------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
|
||||
@ -343,27 +343,27 @@ Request
|
||||
|
||||
.. table:: **Table 13** Data structure of the spec/extendParam field
|
||||
|
||||
+-------------------------+-----------------+-----------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
+-------------------------+-----------------+-----------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| Parameter | Mandatory | Type | Description |
|
||||
+=========================+=================+=================+===========================================================================================================================================================================================================================+
|
||||
+=========================+=================+=================+============================================================================================================================================================================================================================+
|
||||
| maxPods | No | Integer | Maximum number of pods on the node. |
|
||||
+-------------------------+-----------------+-----------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
+-------------------------+-----------------+-----------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| agency_name | No | String | Specifies the IAM agency name. |
|
||||
+-------------------------+-----------------+-----------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
+-------------------------+-----------------+-----------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| alpha.cce/preInstall | No | String | Script required before the installation. |
|
||||
| | | | |
|
||||
| | | | .. note:: |
|
||||
| | | | |
|
||||
| | | | The input value must be encoded using Base64. (Command: **echo -n "Content to be encoded" \| base64**) |
|
||||
+-------------------------+-----------------+-----------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
+-------------------------+-----------------+-----------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| alpha.cce/postInstall | No | String | Script required after the installation. |
|
||||
| | | | |
|
||||
| | | | .. note:: |
|
||||
| | | | |
|
||||
| | | | The input value must be encoded using Base64. (Command: **echo -n "Content to be encoded" \| base64**) |
|
||||
+-------------------------+-----------------+-----------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
+-------------------------+-----------------+-----------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| alpha.cce/NodeImageID | No | String | Mandatory if a custom image is used in creating a bare metal node. |
|
||||
+-------------------------+-----------------+-----------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
+-------------------------+-----------------+-----------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| DockerLVMConfigOverride | No | String | ConfigMap of the Docker data disk. The following is an example configuration: |
|
||||
| | | | |
|
||||
| | | | .. code-block:: |
|
||||
@ -378,9 +378,9 @@ Request
|
||||
| | | | - **lvType**: type of a logic volume. Currently, the value can be **linear** or **striped**. |
|
||||
| | | | - **dockerThinpool**: Docker space size, for example, **vgpaas/60%VG**. |
|
||||
| | | | - **kubernetesLV**: kubelet space size, for example, **vgpaas/20%VG**. |
|
||||
+-------------------------+-----------------+-----------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
+-------------------------+-----------------+-----------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| publicKey | No | String | Public key of the node. Used when creating a key pair. |
|
||||
+-------------------------+-----------------+-----------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
+-------------------------+-----------------+-----------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| nicMultiqueue | No | String | ENI queue settings, the default setting is: |
|
||||
| | | | |
|
||||
| | | | .. code-block:: |
|
||||
@ -390,7 +390,7 @@ Request
|
||||
| | | | - **queue** indicates the number of ENI queues. |
|
||||
| | | | - Supported proportions are {"1":128, "2":92, "4":92, "8":32, "16":16, "28":9}. That is, there is one queue, a maximum of 128 ENIs can be bound. If there are two queues, a maximum of 92 ENIs can be bound. |
|
||||
| | | | - A larger number of ENI queues indicates higher performance but fewer ENIs can be bound. The queue settings cannot be changed after the node pool is created. |
|
||||
+-------------------------+-----------------+-----------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
+-------------------------+-----------------+-----------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| nicThreshold | No | String | ENI pre-binding thresholds, the default setting is: |
|
||||
| | | | |
|
||||
| | | | .. code-block:: |
|
||||
@ -401,12 +401,12 @@ Request
|
||||
| | | | - The second decimal place indicates the high threshold. Formula: Maximum number of pre-bound ENIs = Min (128 x High threshold, Maximum number of ENIs that can be bound to the queue) |
|
||||
| | | | - The high and low thresholds of the number of pre-bound ENIs are restricted by the maximum number of ENIs that can be bound to a queue. |
|
||||
| | | | - ENIs bound to a BMS node = Number of ENIs currently used by pods + Number of pre-bound ENIs |
|
||||
| | | | - CCE keeps binding ENIs to a BMS node to ensure that the minimum number of ENIs is always reached. (Min. pre-bound ENIs ≤ Number of pre-bound ENIs + Number of ENIs currently used by pods) |
|
||||
| | | | - At every 2 minutes, CCE releases ENIs pre-bound to a BMS node to ensure that the maximum number of ENIs will not be exceeded. (Max. pre-bound ENIs ≥ Number of pre-bound ENIs + Number of ENIs currently used by pods) |
|
||||
| | | | - CCE keeps binding ENIs to a BMS node to ensure that the minimum number of ENIs is always reached. (Min. pre-bound ENIs <= Number of pre-bound ENIs + Number of ENIs currently used by pods) |
|
||||
| | | | - At every 2 minutes, CCE releases ENIs pre-bound to a BMS node to ensure that the maximum number of ENIs will not be exceeded. (Max. pre-bound ENIs >= Number of pre-bound ENIs + Number of ENIs currently used by pods) |
|
||||
| | | | - Both the thresholds are one-decimal-place values ranging from 0.0 to 1.0. The low threshold must be smaller than or equal to the high one. |
|
||||
| | | | - This field can be configured only for BMS nodes in a CCE Turbo cluster. |
|
||||
| | | | - Pre-binding ENIs can speed up workload creation but occupies IP addresses. |
|
||||
+-------------------------+-----------------+-----------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
+-------------------------+-----------------+-----------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
|
||||
.. _cce_02_0354__table322873620312:
|
||||
|
||||
|
||||
@ -140,7 +140,7 @@ Response
|
||||
| | | |
|
||||
| | | 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** |
|
||||
+-----------------------+---------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
|
||||
@ -175,7 +175,7 @@ Response
|
||||
| | | |
|
||||
| | | 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** |
|
||||
+-----------------------+---------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
|
||||
@ -102,18 +102,18 @@ Response
|
||||
+-----------------------+-----------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| 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.medium**: medium-scale, single-master cluster (≤ 200 nodes) |
|
||||
| | | - **cce.s2.small**: small-scale, high availability cluster (≤ 50 nodes) |
|
||||
| | | - **cce.s2.medium**: medium-scale, high availability cluster (≤ 200 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.s1.small**: small-scale, single-master cluster (<= 50 nodes) |
|
||||
| | | - **cce.s1.medium**: medium-scale, single-master cluster (<= 200 nodes) |
|
||||
| | | - **cce.s2.small**: small-scale, high availability cluster (<= 50 nodes) |
|
||||
| | | - **cce.s2.medium**: medium-scale, high availability cluster (<= 200 nodes) |
|
||||
| | | - **cce.s2.large**: large-scale, high availability cluster (<= 1,000 nodes) |
|
||||
| | | - **cce.s2.xlarge**: ultra-large-scale, high availability cluster (<= 2,000 nodes) |
|
||||
| | | |
|
||||
| | | .. note:: |
|
||||
| | | |
|
||||
| | | - s1: single-master 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 high-availability cluster has multiple master nodes. Faults in a single master node will not take the cluster down. |
|
||||
+-----------------------+-----------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
|
||||
@ -25,7 +25,6 @@ Creating a VPC
|
||||
.. figure:: /_static/images/en-us_image_0233731209.png
|
||||
:alt: **Figure 1** Obtaining the VPC ID
|
||||
|
||||
|
||||
**Figure 1** Obtaining the VPC ID
|
||||
|
||||
Creating a Subnet
|
||||
@ -41,5 +40,4 @@ Creating a Subnet
|
||||
.. figure:: /_static/images/en-us_image_0233732535.png
|
||||
:alt: **Figure 2** Obtaining the network ID of a subnet
|
||||
|
||||
|
||||
**Figure 2** Obtaining the network ID of a subnet
|
||||
|
||||
@ -16,7 +16,6 @@ project_id
|
||||
.. figure:: /_static/images/en-us_image_0203982493.png
|
||||
:alt: **Figure 1** Viewing project IDs
|
||||
|
||||
|
||||
**Figure 1** Viewing project IDs
|
||||
|
||||
cluster_id
|
||||
@ -30,7 +29,6 @@ cluster_id
|
||||
.. figure:: /_static/images/en-us_image_0233732613.png
|
||||
:alt: **Figure 2** Obtaining the cluster ID
|
||||
|
||||
|
||||
**Figure 2** Obtaining the cluster ID
|
||||
|
||||
node_id
|
||||
@ -44,7 +42,6 @@ node_id
|
||||
.. figure:: /_static/images/en-us_image_0279177365.png
|
||||
:alt: **Figure 3** Obtaining the node ID
|
||||
|
||||
|
||||
**Figure 3** Obtaining the node ID
|
||||
|
||||
job_id
|
||||
@ -62,5 +59,4 @@ job_id
|
||||
.. figure:: /_static/images/en-us_image_0203982464.png
|
||||
:alt: **Figure 4** Obtaining the job ID
|
||||
|
||||
|
||||
**Figure 4** Obtaining the job ID
|
||||
|
||||
@ -93,8 +93,8 @@ Using an existing ELB:
|
||||
| | | |
|
||||
| | | **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 private network load balancer that is automatically created: "{\"type\":\"inner\"}" |
|
||||
| | | - 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\\"}" |
|
||||
+-------------------------------------+-----------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| loadBalancerIP | String | Private IP address of a private network load balancer or public IP address of a public network load balancer. |
|
||||
+-------------------------------------+-----------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
|
||||
@ -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
|
||||
:alt: **Figure 1** Obtaining the Project ID
|
||||
|
||||
|
||||
**Figure 1** Obtaining the Project ID
|
||||
|
||||
@ -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
|
||||
:alt: **Figure 1** Obtaining the Account ID
|
||||
|
||||
|
||||
**Figure 1** Obtaining the Account ID
|
||||
|
||||
@ -35,6 +35,9 @@ sys.path.insert(0, os.path.abspath('../'))
|
||||
sys.path.insert(0, os.path.abspath('./'))
|
||||
|
||||
# -- 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
|
||||
# extensions coming with Sphinx (named 'sphinx.ext.*') or your custom ones.
|
||||
|
||||
Loading…
x
Reference in New Issue
Block a user