diff --git a/docs/cce/api-ref/AddNode.html b/docs/cce/api-ref/AddNode.html index 6bd93c56..72a8f51b 100644 --- a/docs/cce/api-ref/AddNode.html +++ b/docs/cce/api-ref/AddNode.html @@ -163,7 +163,7 @@

String

-

Operating system. If you specify a custom image, the actual OS version in the IMS image is used. Select an OS version supported by the current cluster, for example, EulerOS 2.5, CentOS 7.7, or EulerOS 2.9.

+

Operating system. If you specify a custom image, the actual OS version in the IMS image is used. Select an OS version supported by the current cluster, for example, EulerOS 2.5, EulerOS 2.9, Ubuntu 22.04, or HCE OS 2.0.

login

diff --git a/docs/cce/api-ref/ResetNode.html b/docs/cce/api-ref/ResetNode.html index 23d8ee86..f0e1a56f 100644 --- a/docs/cce/api-ref/ResetNode.html +++ b/docs/cce/api-ref/ResetNode.html @@ -161,7 +161,7 @@

String

-

Operating system. If you specify a custom image, the actual OS version in the IMS image is used. Select an OS version supported by the current cluster, for example, EulerOS 2.5, CentOS 7.7, or EulerOS 2.9.

+

Operating system. If you specify a custom image, the actual OS version in the IMS image is used. Select an OS version supported by the current cluster, for example, EulerOS 2.5, EulerOS 2.9, Ubuntu 22.04, or HCE OS 2.0.

login

diff --git a/docs/cce/api-ref/cce_02_0236.html b/docs/cce/api-ref/cce_02_0236.html index 87f166c8..a7091f09 100644 --- a/docs/cce/api-ref/cce_02_0236.html +++ b/docs/cce/api-ref/cce_02_0236.html @@ -296,6 +296,15 @@

Configuration of Cloud Native Network 2.0. Specify this field when creating a CCE Turbo cluster.

+

publicAccess

+ +

No

+ +

PublicAccess object

+ +

Cluster API access control.

+ +

authentication

No

@@ -340,7 +349,7 @@

extendParam object

Extended fields in the format of key-value pairs.

-

If the cluster will span across AZs or belong to a specified enterprise project, set extended fields as described in Table 13.

+

If the cluster will span across AZs or belong to a specified enterprise project, set extended fields as described in Table 14.

enableMasterVolumeEncryption

@@ -390,86 +399,111 @@

String

-

Security group ID of the node. The value is generated when you create a security group, and any user-defined value is invalid.

+

Default worker node security group ID of the cluster. If specified, the cluster will be bound to the target security group. Otherwise, the system will automatically create a default worker node security group for you. The default worker node security group needs to allow access from certain ports to ensure normal communications.

-
Table 7 Data structure of the authentication field

Parameter

+
- - - - - - - + + +
Table 7 PublicAccess

Parameter

Mandatory

+

Mandatory

Type

+

Type

Description

+

Description

mode

+

cidrs

No

+

No

String

+

Array of strings

Cluster authentication mode.

+

Trustlist of network CIDRs that are allowed to access cluster APIs. You are advised to allow the traffic from VPC and container network CIDRs. By default, no trustlist is configured, and the value is ["0.0.0.0/0"].

+
NOTE:

This parameter is valid only when a cluster is created.

+
+
+
+ +
+ + + + + + + + + - - - -
Table 8 Data structure of the authentication field

Parameter

+

Mandatory

+

Type

+

Description

+

mode

+

No

+

String

+

Cluster authentication mode.

  • Clusters of Kubernetes v1.11 and earlier
    • Possible values: x509, rbac, and authenticating_proxy
    • Default value: x509
  • Clusters of Kubernetes v1.13 and later
    • Possible values: rbac and authenticating_proxy
    • Default value: rbac

authenticatingProxy

+

authenticatingProxy

No

+

No

authenticatingProxy object

+

authenticatingProxy object

Configurations of the authenticating_proxy mode.

+

Configurations of the authenticating_proxy mode.
-
Table 8 Data structure of the authenticatingProxy field

Parameter

+
- - - - - - - - - - - - - - - @@ -477,35 +511,35 @@
Table 9 Data structure of the authenticatingProxy field

Parameter

Mandatory

+

Mandatory

Type

+

Type

Description

+

Description

ca

+

ca

No

+

No

String

+

String

X509 CA certificate (Base64-encoded) configured in authenticating_proxy mode. This field is mandatory when the cluster authentication mode is authenticating_proxy. The maximum size of the certificate is 1 MB.

+

X509 CA certificate (Base64-encoded) configured in authenticating_proxy mode. This field is mandatory when the cluster authentication mode is authenticating_proxy. The maximum size of the certificate is 1 MB.

NOTE:

The uploaded CA certificate is used for both the authentication proxy and the kube-apiserver aggregation layer configuration. If the certificate is invalid, the cluster cannot be created. For details about the kube-apiserver aggregation layer, see Configure the Aggregation Layer.

cert

+

cert

No

+

No

String

+

String

Client certificate (Base64-encoded) issued by the X509 CA certificate configured in authenticating_proxy mode. This certificate is used for authentication from kube-apiserver to the extended API server. This field is mandatory when the cluster authentication mode is authenticating_proxy.

+

Client certificate (Base64-encoded) issued by the X509 CA certificate configured in authenticating_proxy mode. This certificate is used for authentication from kube-apiserver to the extended API server. This field is mandatory when the cluster authentication mode is authenticating_proxy.

For details about the kube-apiserver aggregation layer, see Configure the Aggregation Layer.

privateKey

+

privateKey

No

+

No

String

+

String

Private key (Base64-encoded) of the client certificate issued by the X509 CA certificate configured in authenticating_proxy mode. This key is used for authentication from kube-apiserver to the extended API server. The private key used by the Kubernetes cluster does not support password encryption. Use an unencrypted private key. This field is mandatory when the cluster authentication mode is authenticating_proxy.

+

Private key (Base64-encoded) of the client certificate issued by the X509 CA certificate configured in authenticating_proxy mode. This key is used for authentication from kube-apiserver to the extended API server. The private key used by the Kubernetes cluster does not support password encryption. Use an unencrypted private key. This field is mandatory when the cluster authentication mode is authenticating_proxy.

For details about the kube-apiserver aggregation layer, see Configure the Aggregation Layer.
-
Table 9 Data structure of the containerNetwork field

Parameter

+
- - - - - - - - - - - - - - - @@ -527,78 +561,78 @@
Table 10 Data structure of the containerNetwork field

Parameter

Mandatory

+

Mandatory

Type

+

Type

Description

+

Description

mode

+

mode

Yes

+

Yes

String

+

String

Container network model. Select one of the following possible values:

+

Container network model. Select one of the following possible values:

  • overlay_l2: an overlay_l2 network built for containers by using OpenVSwitch (OVS).
  • vpc-router: an underlay_l2 network built for containers by using ipvlan and custom VPC routes.
  • eni: cloud native 2.0 network model. This model deeply integrates the native ENI capability of VPC, uses the VPC CIDR block to allocate container addresses, and supports passthrough between load balancers and containers to provide high performance. You can use this network model when creating a CCE Turbo cluster.
NOTE:
  • Tunnel network: Under this model, the container network is an overlay network on top of a VPC network based on the VXLAN technology. VXLAN encapsulates Ethernet packets as UDP packets for tunnel transmission. Though at some cost of performance, the tunnel encapsulation enables higher interoperability and compatibility with advanced features (such as network policy-based isolation), meeting the requirements of most applications.
  • VPC network: Routing is implemented within a VPC network according to custom VPC routes. Each node is assigned a CIDR block of a fixed size. vpc-router networks are free of tunnel encapsulation overheads and provide better container network performance than tunnel networks. In addition, as routes to node IP addresses and the containers have been configured on vpc-router, container instances can be directly accessed from outside the cluster.

cidr

+

cidr

No

+

No

String

+

String

Container CIDR block. Recommended: 10.0.0.0/12-19, 172.16.0.0/16-19, or 192.168.0.0/16-19. If the selected CIDR block conflicts with existing CIDR blocks, the system automatically selects another CIDR block.

+

Container CIDR block. Recommended: 10.0.0.0/12-19, 172.16.0.0/16-19, or 192.168.0.0/16-19. If the selected CIDR block conflicts with existing CIDR blocks, the system automatically selects another CIDR block.

This parameter cannot be modified after the cluster is created. Exercise caution when setting this parameter.(This parameter has been discarded. If cidrs has been configured, skip this parameter.)

Minimum: 0

Maximum: 64

@@ -513,13 +547,13 @@

cidrs

+

cidrs

No

+

No

Array of ContainerCIDR objects

+

Array of ContainerCIDR objects

List of container CIDR blocks. In clusters of v1.21 and later, the cidrs field is used. When the cluster network type is vpc-router, you can add multiple container CIDR blocks. In versions earlier than v1.21, if the cidrs field is used, the first CIDR element in the array is used as the container CIDR block.

+

List of container CIDR blocks. In clusters of v1.21 and later, the cidrs field is used. When the cluster network type is vpc-router, you can add multiple container CIDR blocks. In versions earlier than v1.21, if the cidrs field is used, the first CIDR element in the array is used as the container CIDR block.

The configuration cannot be changed after the cluster is created.
-
Table 10 ContainerCIDR

Parameter

+
- - - - - - -
Table 11 ContainerCIDR

Parameter

Mandatory

+

Mandatory

Type

+

Type

Description

+

Description

cidr

+

cidr

Yes

+

Yes

String

+

String

Container CIDR block. Recommended: 10.0.0.0/12-19, 172.16.0.0/16-19, and 192.168.0.0/16-19

+

Container CIDR block. Recommended: 10.0.0.0/12-19, 172.16.0.0/16-19, and 192.168.0.0/16-19
-
Table 11 EniNetwork

Parameter

+
- - - - - - - - - - -
Table 12 EniNetwork

Parameter

Mandatory

+

Mandatory

Type

+

Type

Description

+

Description

eniSubnetId

+

eniSubnetId

Yes

+

Yes

String

+

String

IPv4 Subnet ID of the ENI container subnet. Currently, IPv6 is not supported.

+

IPv4 Subnet ID of the ENI container subnet. Currently, IPv6 is not supported.

eniSubnetCIDR

+

eniSubnetCIDR

Yes

+

Yes

String

+

String

ENI subnet CIDR block.

+

ENI subnet CIDR block.
-
Table 12 MasterSpec

Parameter

+
- - - - - - -
Table 13 MasterSpec

Parameter

Mandatory

+

Mandatory

Type

+

Type

Description

+

Description

availabilityZone

+

availabilityZone

No

+

No

String

+

String

Availability Zone.

+

Availability Zone.

For example:

"masters": [
 			{
@@ -617,85 +651,85 @@
-
Table 13 Data structure of the extendParam field

Parameter

+
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - @@ -771,9 +805,9 @@ }

Response

Response parameters:

-

Table 14 describes the response parameters.

+

Table 15 describes the response parameters.

-
Table 14 Data structure of the extendParam field

Parameter

Mandatory

+

Mandatory

Type

+

Type

Description

+

Description

clusterAZ

+

clusterAZ

No

+

No

String

+

String

If you want to enable multiple AZs for the cluster, enter {"clusterAZ": "multi_az"}.

+

If you want to enable multiple AZs for the cluster, enter {"clusterAZ": "multi_az"}.

NOTE:

Only HA clusters support multiple AZs. To be specific, this field can be configured only when the flavor field in Table 5 is set to cce.s2.small, cce.s2.medium, cce.s2.large, cce.t2.small, cce.t2.medium, or cce.t2.large. After multi-AZ deployment is enabled, the three master nodes of the cluster are distributed in different AZs. The cluster remains available even when one of the AZs is down.

dssMasterVolumes

+

dssMasterVolumes

No

+

No

String

+

String

Whether the system and data disks of a master node use dedicated distributed storage. If this parameter is omitted or left unspecified, EVS disks are used by default.

+

Whether the system and data disks of a master node use dedicated distributed storage. If this parameter is omitted or left unspecified, EVS disks are used by default.

kubeProxyMode

+

kubeProxyMode

No

+

No

String

+

String

Service forwarding mode. Two modes are available:

+

Service forwarding mode. Two modes are available:

  • iptables: Traditional kube-proxy uses iptables rules to implement service load balancing. In this mode, too many iptables rules will be generated when many Services are deployed. In addition, non-incremental updates will cause a latency and even tangible performance issues in the case of service traffic spikes.
  • ipvs: Optimized kube-proxy mode with higher throughput and faster speed. This mode supports incremental updates and can keep connections uninterrupted during service updates. It is suitable for large-sized clusters.
NOTE:

This parameter has been deprecated. If both this parameter and kubeProxyMode under ClusterSpec are specified, the latter will be used.

clusterExternalIP

+

clusterExternalIP

No

+

No

String

+

String

EIP of the master node.

+

EIP of the master node.

alpha.cce/fixPoolMask

+

alpha.cce/fixPoolMask

No

+

No

String

+

String

Number of mask bits of the fixed IP address pool of the container network model. This field is supported only for the VPC network model (vpc-router).

+

Number of mask bits of the fixed IP address pool of the container network model. This field is supported only for the VPC network model (vpc-router).

This parameter determines the number of container IP addresses that can be allocated to a node. The maximum number of pods that can be created on a node is decided by this parameter and maxPods set during node creation.

The value is an integer ranging from 24 to 28.

kubernetes.io/cpuManagerPolicy

+

kubernetes.io/cpuManagerPolicy

No

+

No

String

+

String

Cluster CPU management policy. The value can be none or static. The default value is none.

+

Cluster CPU management policy. The value can be none or static. The default value is none.

  • none: CPU cores will not be exclusively allocated to workload pods. Select this value if you want a large pool of shareable CPU cores.
  • static: CPU cores can be exclusively allocated to workload pods. Select this value if your workload is sensitive to latency in CPU cache and scheduling.

upgradefrom

+

upgradefrom

No

+

No

String

+

String

Reserved. This field is returned only for a query.

+

Reserved. This field is returned only for a query.
Table 14 Response parameters

Parameter

+
@@ -820,7 +854,7 @@
Table 15 Response parameters

Parameter

Type

-
Table 15 Data structure of the metadata field

Parameter

+
@@ -879,7 +913,7 @@
Table 16 Data structure of the metadata field

Parameter

Type

-
Table 16 Data structure of the spec field

Parameter

+
@@ -975,6 +1009,13 @@ + + + +
Table 17 Data structure of the spec field

Parameter

Type

Configuration of Cloud Native Network 2.0. Specify this field when creating a CCE Turbo cluster.

publicAccess

+

PublicAccess object

+

Cluster API access control.

+

authentication

authentication object

@@ -1040,7 +1081,7 @@
-
Table 17 Data structure of the hostNetwork field

Parameter

+
@@ -1066,14 +1107,14 @@ -
Table 18 Data structure of the hostNetwork field

Parameter

Type

String

Security group ID of the node. The value is generated when you create a security group, and any user-defined value is invalid.

+

Default worker node security group ID of the cluster. If specified, the cluster will be bound to the target security group. Otherwise, the system will automatically create a default worker node security group for you. The default worker node security group needs to allow access from certain ports to ensure normal communications.
-
Table 18 EniNetwork

Parameter

+
@@ -1105,19 +1146,40 @@
Table 19 EniNetwork

Parameter

Mandatory

-
Table 19 Data structure of the authentication field

Parameter

+
- - - - - + + +
Table 20 PublicAccess

Parameter

Type

+

Type

Description

+

Description

mode

+

cidrs

String

+

Array of strings

Cluster authentication mode.

+

Trustlist of network CIDRs that are allowed to access cluster APIs. You are advised to allow the traffic from VPC and container network CIDRs. By default, no trustlist is configured, and the value is ["0.0.0.0/0"].

+
NOTE:

This parameter is valid only when a cluster is created.

+
+
+
+ +
+ + + + + + + @@ -1125,19 +1187,19 @@
Table 21 Data structure of the authentication field

Parameter

+

Type

+

Description

+

mode

+

String

+

Cluster authentication mode.

  • Clusters of Kubernetes v1.11 or earlier support x509, rbac, and authenticating_proxy. The default value is x509.
  • Clusters of Kubernetes v1.13 or later support rbac and authenticating_proxy. The default value is rbac.
-
Table 20 MasterSpec

Parameter

+
- - - - -
Table 22 MasterSpec

Parameter

Type

+

Type

Description

+

Description

availabilityZone

+

availabilityZone

String

+

String

Availability Zone.

+

Availability Zone.

"masters": [
 			{
 				"availabilityZone": "eu-de-01"
@@ -1155,108 +1217,108 @@
-
Table 21 Data structure of the extendParam field

Parameter

+
- - - - - - - - - - - - - - - - - - - - - - -
Table 23 Data structure of the extendParam field

Parameter

Type

+

Type

Description

+

Description

clusterAZ

+

clusterAZ

String

+

String

If you want to enable multiple AZs for the cluster, enter {"clusterAZ": "multi_az"}.

+

If you want to enable multiple AZs for the cluster, enter {"clusterAZ": "multi_az"}.

NOTE:

Only HA clusters support multiple AZs. To be specific, this field can be configured only when the flavor field in Table 5 is set to cce.s2.small, cce.s2.medium, cce.s2.large, cce.t2.small, cce.t2.medium, or cce.t2.large. After multi-AZ deployment is enabled, the three master nodes of the cluster are distributed in different AZs. The cluster remains available even when one of the AZs is down.

dssMasterVolumes

+

dssMasterVolumes

String

+

String

Whether the system and data disks of a master node use dedicated distributed storage. If this parameter is omitted or left unspecified, EVS disks are used by default.

+

Whether the system and data disks of a master node use dedicated distributed storage. If this parameter is omitted or left unspecified, EVS disks are used by default.

kubeProxyMode

+

kubeProxyMode

String

+

String

Service forwarding mode. Two modes are available:

+

Service forwarding mode. Two modes are available:

  • iptables: Traditional kube-proxy uses iptables rules to implement service load balancing. In this mode, too many iptables rules will be generated when many Services are deployed. In addition, non-incremental updates will cause a latency and even tangible performance issues in the case of service traffic spikes.
  • ipvs: Optimized kube-proxy mode with higher throughput and faster speed. This mode supports incremental updates and can keep connections uninterrupted during service updates. It is suitable for large-sized clusters.

clusterExternalIP

+

clusterExternalIP

String

+

String

EIP used to access the cluster.

+

EIP used to access the cluster.

alpha.cce/fixPoolMask

+

alpha.cce/fixPoolMask

String

+

String

Number of mask bits of the fixed IP address pool of the container network model. This field is supported only for the VPC network model (vpc-router).

+

Number of mask bits of the fixed IP address pool of the container network model. This field is supported only for the VPC network model (vpc-router).

This parameter determines the number of container IP addresses that can be allocated to a node. The maximum number of pods that can be created on a node is decided by this parameter and maxPods set during node creation.

The value is an integer ranging from 24 to 28.

kubernetes.io/cpuManagerPolicy

+

kubernetes.io/cpuManagerPolicy

String

+

String

Cluster CPU management policy. The value can be none or static. The default value is none.

+

Cluster CPU management policy. The value can be none or static. The default value is none.

  • none: CPU cores will not be exclusively allocated to workload pods. Select this value if you want a large pool of shareable CPU cores.
  • static: CPU cores can be exclusively allocated to workload pods. Select this value if your workload is sensitive to latency in CPU cache and scheduling.

upgradefrom

+

upgradefrom

String

+

String

Reserved. This field is returned only for a query.

+

Reserved. This field is returned only for a query.
-
Table 22 Data structure of the status field

Parameter

+
- - - - - - - - - - - - - - @@ -1309,9 +1371,9 @@ "jobID": "d6bcbb0b-8529-11ea-8e34-0255ac101108" } } -

Status Code

Table 23 describes the status code of this API.

+

Status Code

Table 25 describes the status code of this API.

-
Table 24 Data structure of the status field

Parameter

Type

+

Type

Description

+

Description

phase

+

phase

String

+

String

Cluster status. Possible values:

+

Cluster status. Possible values:

  • Available: The cluster is running properly.
  • Unavailable: The cluster is exhibiting unexpected behavior.
  • ScalingUp: Nodes are being added to the cluster.
  • ScalingDown: The cluster is being downsized to fewer nodes.
  • Creating: The cluster is being created.
  • Deleting: The cluster is being deleted.
  • Upgrading: The cluster is being upgraded.
  • Empty: The cluster has no resources.

jobID

+

jobID

String

+

String

ID of the cluster creation job. You can query job progress by job ID to keep updated on cluster creation progress.

+

ID of the cluster creation job. You can query job progress by job ID to keep updated on cluster creation progress.

deleteOption

+

deleteOption

Object

+

Object

Whether to delete configurations. This parameter is contained only in the response to the deletion request.

+

Whether to delete configurations. This parameter is contained only in the response to the deletion request.

deleteStatus

+

deleteStatus

Object

+

Object

Whether to delete the status information. This parameter is contained only in the response to the deletion request.

+

Whether to delete the status information. This parameter is contained only in the response to the deletion request.
Table 23 Status code

Status Code

+
diff --git a/docs/cce/api-ref/cce_02_0238.html b/docs/cce/api-ref/cce_02_0238.html index b7ef9cc3..b1762e37 100644 --- a/docs/cce/api-ref/cce_02_0238.html +++ b/docs/cce/api-ref/cce_02_0238.html @@ -226,6 +226,13 @@ + + + + - @@ -411,23 +418,44 @@
Table 25 Status code

Status Code

Description

Configuration of Cloud Native Network 2.0. Specify this field when creating a CCE Turbo cluster.

publicAccess

+

PublicAccess object

+

Cluster API access control.

+

authentication

authentication object

@@ -309,7 +316,7 @@

String

ID of the default security group created for the node during cluster creation.

+

Default worker node security group ID of the cluster. If specified, the cluster will be bound to the target security group. Otherwise, the system will automatically create a default worker node security group for you. The default worker node security group needs to allow access from certain ports to ensure normal communications.
-
Table 9 MasterSpec

Parameter

+
- - - - - - - + +
Table 9 PublicAccess

Parameter

Mandatory

+

Type

Type

-

Description

+

Description

availabilityZone

+

cidrs

No

+

Array of strings

String

+

Trustlist of network CIDRs that are allowed to access cluster APIs. You are advised to allow the traffic from VPC and container network CIDRs. By default, no trustlist is configured, and the value is ["0.0.0.0/0"].

+
NOTE:

This parameter is valid only when a cluster is created.

+

Availability Zone.

+
+
+ +
+ + + + + + + + + @@ -435,109 +463,109 @@
Table 10 MasterSpec

Parameter

+

Mandatory

+

Type

+

Description

+

availabilityZone

+

No

+

String

+

Availability Zone.

For example, eu-de-01.
-
Table 10 Data structure of the extendParam field

Parameter

+
- - - - - - - - - - -
Table 11 Data structure of the extendParam field

Parameter

Type

+

Type

Description

+

Description

alpha.cce/fixPoolMask

+

alpha.cce/fixPoolMask

String

+

String

Number of mask bits of the fixed IP address pool of the container network model. This field is supported only for the VPC network model (vpc-router).

+

Number of mask bits of the fixed IP address pool of the container network model. This field is supported only for the VPC network model (vpc-router).

This parameter determines the number of container IP addresses that can be allocated to a node. The maximum number of pods that can be created on a node is decided by this parameter and maxPods set during node creation.

The value is an integer ranging from 24 to 28.

kubernetes.io/cpuManagerPolicy

+

kubernetes.io/cpuManagerPolicy

String

+

String

CPU management policy of the master node.

+

CPU management policy of the master node.

upgradefrom

+

upgradefrom

String

+

String

Version from which this version is upgrade.

+

Version from which this version is upgrade.
-
Table 11 Data structure of the status field

Parameter

+
- - - - - - - - - - - - - -
Table 12 Data structure of the status field

Parameter

Type

+

Type

Description

+

Description

phase

+

phase

String

+

String

Cluster status. Possible values:

+

Cluster status. Possible values:

  • Available: The cluster is running properly.
  • Unavailable: The cluster is exhibiting unexpected behavior. Manually delete the cluster or contact the administrator to delete the cluster.
  • ScalingUp: Nodes are being added to the cluster.
  • ScalingDown: The cluster is being downsized to fewer nodes.
  • Creating: The cluster is being created.
  • Deleting: The cluster is being deleted.
  • Upgrading: The cluster is being upgraded.
  • Resizing: Cluster specifications are being changed.
  • Empty: The cluster has no resources.

reason

+

reason

String

+

String

Reason of cluster state transition. This parameter is returned if the cluster is not in the Available state.

+

Reason of cluster state transition. This parameter is returned if the cluster is not in the Available state.

message

+

message

String

+

String

Detailed information about why the cluster changes to the current state. This parameter is returned if the cluster is not in the Available state.

+

Detailed information about why the cluster changes to the current state. This parameter is returned if the cluster is not in the Available state.

endpoints

+

endpoints

endpoint object

+

endpoint object

Access address of the kube-apiserver in the cluster.

+

Access address of the kube-apiserver in the cluster.
-
Table 12 Data structure of the endpoint field

Parameter

+
- - - - - - - - - - - @@ -598,9 +626,9 @@ } } -

Status Code

Table 13 describes the status code of this API.

+

Status Code

Table 14 describes the status code of this API.

-
Table 13 Data structure of the endpoint field

Parameter

Type

+

Type

Description

+

Description

internal

+

internal

String

+

String

Internal network address.

+

Internal network address.

external

+

external

String

+

String

External network address.

+

External network address.

external_otc

+

external_otc

String

+

String

Endpoint of the cluster to be accessed through API Gateway.

+

Endpoint of the cluster to be accessed through API Gateway.
Table 13 Status code

Status Code

+
diff --git a/docs/cce/api-ref/cce_02_0242.html b/docs/cce/api-ref/cce_02_0242.html index 3a71faa1..c2b94917 100644 --- a/docs/cce/api-ref/cce_02_0242.html +++ b/docs/cce/api-ref/cce_02_0242.html @@ -207,7 +207,7 @@ @@ -1442,7 +1442,7 @@ - + + + + + + - - - - - - diff --git a/docs/cce/api-ref/cce_02_0357.html b/docs/cce/api-ref/cce_02_0357.html index 179fd704..3d9e1758 100644 --- a/docs/cce/api-ref/cce_02_0357.html +++ b/docs/cce/api-ref/cce_02_0357.html @@ -247,6 +247,7 @@ -
Table 14 Status code

Status Code

Description

String

Node OS.

-
  • Nodes in clusters of Kubernetes v1.11 or earlier support EulerOS 2.2.
  • Nodes in clusters of Kubernetes v1.13 or v1.15 support EulerOS 2.5.
  • Nodes in clusters of Kubernetes v1.17 support EulerOS 2.5 and CentOS 7.7.
  • Nodes in clusters of Kubernetes v1.19, v1.21 or v1.23 support EulerOS 2.5, EulerOS 2.9 and CentOS 7.7.
  • Nodes using kata runtime in CCE Turbo cluster support EulerOS 2.9.
+
  • Nodes in clusters of Kubernetes v1.13, v1.15, v1.17, v1.19, v1.21, v1.23, or v1.25 support EulerOS 2.5.
  • Nodes in clusters of Kubernetes v1.19 or later support EulerOS 2.9.
  • Nodes in clusters of Kubernetes v1.25 or later support Ubuntu 22.04 and HCE OS 2.0.
  • Nodes using kata runtime in CCE Turbo cluster support EulerOS 2.9.
NOTE:

If the alpha.cce/NodeImageID parameter in extendParam is specified during node creation, you do not need to set this field.

String

Node OS.

-
  • Nodes in clusters of Kubernetes v1.11 or earlier support EulerOS 2.2.
  • Nodes in clusters of Kubernetes v1.13 or v1.15 support EulerOS 2.5.
  • Nodes in clusters of Kubernetes v1.17 support EulerOS 2.5 and CentOS 7.7.
  • Nodes in clusters of Kubernetes v1.19, v1.21 or v1.23 support EulerOS 2.5, EulerOS 2.9 and CentOS 7.7.
  • Nodes using kata runtime in CCE Turbo cluster support EulerOS 2.9.
+
  • Nodes in clusters of Kubernetes v1.13, v1.15, v1.17, v1.19, v1.21, v1.23, or v1.25 support EulerOS 2.5.
  • Nodes in clusters of Kubernetes v1.19 or later support EulerOS 2.9.
  • Nodes in clusters of Kubernetes v1.25 or later support Ubuntu 22.04 and HCE OS 2.0.
  • Nodes using kata runtime in CCE Turbo cluster support EulerOS 2.9.

login

diff --git a/docs/cce/api-ref/cce_02_0243.html b/docs/cce/api-ref/cce_02_0243.html index 7452b0ca..54f6a218 100644 --- a/docs/cce/api-ref/cce_02_0243.html +++ b/docs/cce/api-ref/cce_02_0243.html @@ -255,7 +255,7 @@

String

Node OS.

-
  • Nodes in clusters of Kubernetes v1.11 or earlier support EulerOS 2.2.
  • Nodes in clusters of Kubernetes v1.13 or v1.15 support EulerOS 2.5.
  • Nodes in clusters of Kubernetes v1.17 support EulerOS 2.5 and CentOS 7.7.
  • Nodes in clusters of Kubernetes v1.19, v1.21 or v1.23 support EulerOS 2.5, EulerOS 2.9 and CentOS 7.7.
  • Nodes using kata runtime in CCE Turbo cluster support EulerOS 2.9.
+
  • Nodes in clusters of Kubernetes v1.13, v1.15, v1.17, v1.19, v1.21, v1.23, or v1.25 support EulerOS 2.5.
  • Nodes in clusters of Kubernetes v1.19 or later support EulerOS 2.9.
  • Nodes in clusters of Kubernetes v1.25 or later support Ubuntu 22.04 and HCE OS 2.0.
  • Nodes using kata runtime in CCE Turbo cluster support EulerOS 2.9.

login

diff --git a/docs/cce/api-ref/cce_02_0269.html b/docs/cce/api-ref/cce_02_0269.html index 12a17d79..c5824e8e 100644 --- a/docs/cce/api-ref/cce_02_0269.html +++ b/docs/cce/api-ref/cce_02_0269.html @@ -444,7 +444,7 @@
  • DockerLVMConfigOverride: Docker data disk configuration item. (This parameter has been discarded. Use the storage field instead.) The following is an example default configuration:
    "DockerLVMConfigOverride":"dockerThinpool=vgpaas/90%VG;kubernetesLV=vgpaas/10%VG;diskType=evs;lvType=linear"

    The configuration contains the following fields:

    • userLV: size of the user space, for example, vgpaas/20%VG.
    • userPath: mount path of the user space, for example, /home/wqt-test.
    • diskType: disk type. Currently, only evs, hdd, and ssd are supported.
    • 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.
    -
  • dockerBaseSize: available disk space of a single Docker container on a node in Device Mapper mode. This field is not supported in OverlayFS mode (nodes that use CentOS 7.6 or Ubuntu 18.04 in CCE Turbo clusters and nodes that use Ubuntu 18.04 in CCE clusters).
  • init-node-password: initial node password
  • offloadNode: whether the node is a CCE Turbo cluster node. This parameter is not supported when you add a node to a node pool.
  • publicKey: node public key. Used when creating a key pair.
  • alpha.cce/preInstall: pre-installation script.
+
  • dockerBaseSize: available disk space of a single Docker container on a node in Device Mapper mode. This field is not supported in OverlayFS mode (nodes that use Ubuntu 18.04 in CCE Turbo clusters and nodes that use Ubuntu 18.04 in CCE clusters).
  • init-node-password: initial node password
  • offloadNode: whether the node is a CCE Turbo cluster node. This parameter is not supported when you add a node to a node pool.
  • publicKey: node public key. Used when creating a key pair.
  • alpha.cce/preInstall: pre-installation script.
    • NOTE:

    The input value must be Base64-encoded. (Command: echo -n Content to be encoded | base64)

    • alpha.cce/postInstall: post-installation script
    diff --git a/docs/cce/api-ref/cce_02_0273.html b/docs/cce/api-ref/cce_02_0273.html index d2facf34..d003ae64 100644 --- a/docs/cce/api-ref/cce_02_0273.html +++ b/docs/cce/api-ref/cce_02_0273.html @@ -8,19 +8,29 @@

    2024-05-23

    +

    2024-08-30

    +

    Added the publicAccess field in Creating a Cluster and Reading a Specified Cluster.

    +

    2024-08-15

    +    		 +

    2024-05-23
    • Updated the ipv6enable field in Table 5.
    • Updated the ipv6enable field in Table 4.

    2024-03-29

    +

    2024-03-29

    2023-11-06

    		 +

    2023-02-10

    @@ -35,7 +45,7 @@

    2022-03-24

    • Supported clusters of v1.21.
    • The cluster certificate SAN can be customized. For details, see customSan field in Table 5.
    • Added the cidrs field in Table 9.
    • Added Quota Management.
    +
    • Supported clusters of v1.21.
    • The cluster certificate SAN can be customized. For details, see customSan field in Table 5.
    • Added the cidrs field in Table 10.
    • Added Quota Management.

    2022-02-17

    @@ -70,12 +80,12 @@

    2020-05-08

    		 +

    2020-04-14

    		 +

    2020-03-25

    diff --git a/docs/cce/api-ref/cce_02_0341.html b/docs/cce/api-ref/cce_02_0341.html index efc5a9a9..0d75ed62 100644 --- a/docs/cce/api-ref/cce_02_0341.html +++ b/docs/cce/api-ref/cce_02_0341.html @@ -2,7 +2,7 @@

    Obtaining a Project ID

    Obtaining the Project ID by Calling an API

    You can obtain the project ID by calling the API used to query project information based on the specified criteria.

    -

    The API used to obtain a project ID is GET https://{Endpoint}/v3/projects, where {Endpoint} indicates the IAM endpoint. You can obtain the IAM endpoint from Regions and Endpoints.

    +

    The API used to obtain a project ID is GET https://{Endpoint}/v3/projects, where {Endpoint} indicates the IAM endpoint. You can obtain the IAM endpoint from Regions and Endpoints.

    The following is an example response. The value of id in the projects field is the project ID.

    {
     "projects": [
diff --git a/docs/cce/api-ref/cce_02_0354.html b/docs/cce/api-ref/cce_02_0354.html
index c1279d56..67b28d71 100644
--- a/docs/cce/api-ref/cce_02_0354.html
+++ b/docs/cce/api-ref/cce_02_0354.html
@@ -252,7 +252,7 @@

    String

    • Nodes in clusters of Kubernetes v1.11 or earlier support EulerOS 2.2.
    • Nodes in clusters of Kubernetes v1.13 or v1.15 support EulerOS 2.5.
    • Nodes in clusters of Kubernetes v1.17 support EulerOS 2.5 and CentOS 7.7.
    • Nodes in clusters of Kubernetes v1.19, v1.21 or v1.23 support EulerOS 2.5, EulerOS 2.9 and CentOS 7.7.
    • Nodes using kata runtime in CCE Turbo cluster support EulerOS 2.9.
    +
    • Nodes in clusters of Kubernetes v1.13, v1.15, v1.17, v1.19, v1.21, v1.23, or v1.25 support EulerOS 2.5.
    • Nodes in clusters of Kubernetes v1.19 or later support EulerOS 2.9.
    • Nodes in clusters of Kubernetes v1.25 or later support Ubuntu 22.04 and HCE OS 2.0.
    • Nodes using kata runtime in CCE Turbo cluster support EulerOS 2.9.
    NOTE:

    If the alpha.cce/NodeImageID parameter in extendParam is specified during node creation, you do not need to set this field.

    String

    Node OS.

    +
    • Nodes in clusters of Kubernetes v1.11 or earlier support EulerOS 2.2.
    • Nodes in clusters of Kubernetes v1.13, v1.15, v1.17, v1.19, v1.21, v1.23, or v1.25 support EulerOS 2.5.
    • Nodes in clusters of Kubernetes v1.19 or later support EulerOS 2.9.
    • Nodes in clusters of Kubernetes v1.25 or later support Ubuntu 22.04 and HCE OS 2.0.

    login

    @@ -383,7 +384,7 @@
    • DockerLVMConfigOverride: Docker data disk configuration item. (This parameter has been discarded. Use the storage field instead.) The following is an example default configuration:
      "DockerLVMConfigOverride":"dockerThinpool=vgpaas/90%VG;kubernetesLV=vgpaas/10%VG;diskType=evs;lvType=linear"

      The configuration contains the following fields:

      • userLV: size of the user space, for example, vgpaas/20%VG.
      • userPath: mount path of the user space, for example, /home/wqt-test.
      • diskType: disk type. Currently, only evs, hdd, and ssd are supported.
      • 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.
      -
    • dockerBaseSize: available disk space of a single Docker container on a node in Device Mapper mode. This field is not supported in OverlayFS mode (nodes that use CentOS 7.6 or Ubuntu 18.04 in CCE Turbo clusters and nodes that use Ubuntu 18.04 in CCE clusters).
    • init-node-password: initial node password
    • offloadNode: whether the node is a CCE Turbo cluster node.
    • publicKey: node public key. Used when creating a key pair.
    • alpha.cce/preInstall: pre-installation script.
    +
  • dockerBaseSize: available disk space of a single Docker container on a node in Device Mapper mode. This field is not supported in OverlayFS mode (nodes that use Ubuntu 18.04 in CCE Turbo clusters and nodes that use Ubuntu 18.04 in CCE clusters).
  • init-node-password: initial node password
  • offloadNode: whether the node is a CCE Turbo cluster node.
  • publicKey: node public key. Used when creating a key pair.
  • alpha.cce/preInstall: pre-installation script.
    • NOTE:

    The input value must be Base64-encoded. (Command: echo -n Content to be encoded | base64)

    • alpha.cce/postInstall: post-installation script
    diff --git a/docs/cce/api-ref/kubernetesapi.html b/docs/cce/api-ref/kubernetesapi.html index c99710be..696bf97c 100644 --- a/docs/cce/api-ref/kubernetesapi.html +++ b/docs/cce/api-ref/kubernetesapi.html @@ -20,7 +20,7 @@

    Endpoint

    Web service entry URL. It can be obtained from Regions and Endpoints.

    +

    Web service entry URL. It can be obtained from Regions and Endpoints.

    uri