Compare commits

...

6 Commits

31 changed files with 3896 additions and 867 deletions

Binary file not shown.

After

Width:  |  Height:  |  Size: 205 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 209 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 83 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 63 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 80 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 26 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 16 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 74 KiB

File diff suppressed because it is too large Load Diff

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. 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.

File diff suppressed because it is too large Load Diff

View File

@ -160,6 +160,38 @@ Response
"size": 100 "size": 100
} }
], ],
"storage": {
"storageSelectors": [
{
"name": "cceUse",
"storageType": "evs",
"matchLabels": {
"size": "100",
"volumeType": "SAS",
"count": "1"
}
}
],
"storageGroups": [
{
"name": "vgpaas",
"selectorNames": [
"cceUse"
],
"cceManaged": true,
"virtualSpaces": [
{
"name": "runtime",
"size": "90%"
},
{
"name": "kubernetes",
"size": "10%"
}
]
}
]
},
"publicIP": { "publicIP": {
"eip": { "eip": {
"bandwidth": {} "bandwidth": {}

View File

@ -22,6 +22,10 @@ Cluster Management
- :ref:`Reading Job Progress <cce_02_0247>` - :ref:`Reading Job Progress <cce_02_0247>`
- :ref:`Querying the Access Information of a Specified Cluster <cce_02_0347>` - :ref:`Querying the Access Information of a Specified Cluster <cce_02_0347>`
- :ref:`Modifying the Access Information of a Specified Cluster <cce_02_0346>` - :ref:`Modifying the Access Information of a Specified Cluster <cce_02_0346>`
- :ref:`Accepting a Node <addnode>`
- :ref:`Resetting a Node <resetnode>`
- :ref:`Removing a Node <removenode>`
- :ref:`Migrating a Node <migratenode>`
- :ref:`Creating a Node Pool <cce_02_0354>` - :ref:`Creating a Node Pool <cce_02_0354>`
- :ref:`Querying a Specified Node Pool <cce_02_0355>` - :ref:`Querying a Specified Node Pool <cce_02_0355>`
- :ref:`Updating a Specified Node Pool <cce_02_0356>` - :ref:`Updating a Specified Node Pool <cce_02_0356>`
@ -49,6 +53,10 @@ Cluster Management
reading_job_progress reading_job_progress
querying_the_access_information_of_a_specified_cluster querying_the_access_information_of_a_specified_cluster
modifying_the_access_information_of_a_specified_cluster modifying_the_access_information_of_a_specified_cluster
accepting_a_node
resetting_a_node
removing_a_node
migrating_a_node
creating_a_node_pool creating_a_node_pool
querying_a_specified_node_pool querying_a_specified_node_pool
updating_a_specified_node_pool updating_a_specified_node_pool

View File

@ -113,6 +113,38 @@ Response
"size": 100 "size": 100
} }
], ],
"storage": {
"storageSelectors": [
{
"name": "cceUse",
"storageType": "evs",
"matchLabels": {
"size": "100",
"volumeType": "SAS",
"count": "1"
}
}
],
"storageGroups": [
{
"name": "vgpaas",
"selectorNames": [
"cceUse"
],
"cceManaged": true,
"virtualSpaces": [
{
"name": "runtime",
"size": "90%"
},
{
"name": "kubernetes",
"size": "10%"
}
]
}
]
},
"publicIP": { "publicIP": {
"eip": { "eip": {
"bandwidth": {} "bandwidth": {}

File diff suppressed because it is too large Load Diff

File diff suppressed because it is too large Load Diff

File diff suppressed because it is too large Load Diff

View File

@ -123,6 +123,38 @@ For the description of the response parameters, see :ref:`Table 4 <cce_02_0243__
"diskSize": 100 "diskSize": 100
} }
], ],
"storage": {
"storageSelectors": [
{
"name": "cceUse",
"storageType": "evs",
"matchLabels": {
"size": "100",
"volumeType": "SAS",
"count": "1"
}
}
],
"storageGroups": [
{
"name": "vgpaas",
"selectorNames": [
"cceUse"
],
"cceManaged": true,
"virtualSpaces": [
{
"name": "runtime",
"size": "90%"
},
{
"name": "kubernetes",
"size": "10%"
}
]
}
]
},
"publicIP": { "publicIP": {
"eip": { "eip": {
"bandwidth": {} "bandwidth": {}

File diff suppressed because it is too large Load Diff

File diff suppressed because it is too large Load Diff

View File

@ -11,11 +11,11 @@ Appendix
- :ref:`Error Codes <cce_02_0250>` - :ref:`Error Codes <cce_02_0250>`
- :ref:`Obtaining a Project ID <cce_02_0341>` - :ref:`Obtaining a Project ID <cce_02_0341>`
- :ref:`Obtaining the Account ID <cce_02_0342>` - :ref:`Obtaining the Account ID <cce_02_0342>`
- :ref:`How to Use ELB in a Cluster <cce_02_0087>`
- :ref:`How to Obtain Parameters in the API URI <cce_02_0271>` - :ref:`How to Obtain Parameters in the API URI <cce_02_0271>`
- :ref:`API Permissions <cce_02_0272>` - :ref:`API Permissions <cce_02_0272>`
- :ref:`Creating a VPC and Subnet <cce_02_0100>` - :ref:`Creating a VPC and Subnet <cce_02_0100>`
- :ref:`Creating a Key Pair <cce_02_0101>` - :ref:`Creating a Key Pair <cce_02_0101>`
- :ref:`Attaching Disks to a Node <node_storage_example>`
.. toctree:: .. toctree::
:maxdepth: 1 :maxdepth: 1
@ -27,8 +27,8 @@ Appendix
error_codes error_codes
obtaining_a_project_id obtaining_a_project_id
obtaining_the_account_id obtaining_the_account_id
how_to_use_elb_in_a_cluster
how_to_obtain_parameters_in_the_api_uri how_to_obtain_parameters_in_the_api_uri
api_permissions api_permissions
creating_a_vpc_and_subnet creating_a_vpc_and_subnet
creating_a_key_pair creating_a_key_pair
attaching_disks_to_a_node

View File

@ -10,14 +10,21 @@ Change History
+-----------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +-----------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| Date | Revision | | Date | Revision |
+===================================+============================================================================================================================================================================+ +===================================+============================================================================================================================================================================+
| 2023-02-10 | - Supported clusters of v1.25. |
| | - Added the **storage** field in :ref:`Table 5 <cce_02_0242__table3150105216225>`. |
| | - Added :ref:`Attaching Disks to a Node <node_storage_example>`. |
| | - Added :ref:`Accepting a Node <addnode>`. |
| | - Added :ref:`Resetting a Node <resetnode>`. |
| | - Added :ref:`Removing a Node <removenode>`. |
| | - Added :ref:`Migrating a Node <migratenode>`. |
+-----------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| 2022-05-24 | - Supported clusters of v1.23. | | 2022-05-24 | - Supported clusters of v1.23. |
| | - Add a note about how to automatically install ICAgent. For details, see :ref:`Creating a Cluster <cce_02_0236>`. | | | - Add a note about how to automatically install ICAgent. For details, see :ref:`Creating a Cluster <cce_02_0236>`. |
| | - The native APIs of Kubernetes will no longer be maintained. For details, see :ref:`Overview <kubernetesapi>`. | | | - The native APIs of Kubernetes will no longer be maintained. For details, see :ref:`Overview <kubernetesapi>`. |
+-----------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +-----------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| 2022-03-24 | Supported clusters of v1.21. | | 2022-03-24 | - Supported clusters of v1.21. |
| | |
| | - The cluster certificate SAN can be customized. For details, see **customSan** field in :ref:`Table 5 <cce_02_0236__table1034041612134>`. | | | - The cluster certificate SAN can be customized. For details, see **customSan** field in :ref:`Table 5 <cce_02_0236__table1034041612134>`. |
| | - Added the **cidrs** field in :ref:`Table 5 <cce_02_0236__table1034041612134>`. | | | - Added the **cidrs** field in :ref:`Table 9 <cce_02_0236__table882310145412>`. |
| | - Added :ref:`Quota Management <quota_lifecycle_management>`. | | | - Added :ref:`Quota Management <quota_lifecycle_management>`. |
+-----------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +-----------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| 2022-02-17 | - Supported the creation of CCE Turbo Cluster. | | 2022-02-17 | - Supported the creation of CCE Turbo Cluster. |
@ -68,7 +75,7 @@ Change History
| | - Updated **spec** in :ref:`Table 3 <cce_02_0238__table34052983203655>`. | | | - Updated **spec** in :ref:`Table 3 <cce_02_0238__table34052983203655>`. |
| | - Added **description** in :ref:`Table 4 <cce_02_0238__table1034041612134>`. | | | - Added **description** in :ref:`Table 4 <cce_02_0238__table1034041612134>`. |
| | - Deleted **patchVersion** in :ref:`Table 10 <cce_02_0238__table17575013586>`. | | | - Deleted **patchVersion** in :ref:`Table 10 <cce_02_0238__table17575013586>`. |
| | - Added **publicKey** in :ref:`Table 21 <cce_02_0242__table2039318361484>`. | | | - Added **publicKey** in :ref:`Table 28 <cce_02_0242__table2039318361484>`. |
| | - Added **initialNodeCount** in Table 6. | | | - Added **initialNodeCount** in Table 6. |
| | - Added **minNodeCount** in Table 17. | | | - Added **minNodeCount** in Table 17. |
| | - Updated Table 19. | | | - Updated Table 19. |

View File

@ -24,7 +24,7 @@ extensions = [
otcdocs_auto_name = False otcdocs_auto_name = False
otcdocs_auto_version = False otcdocs_auto_version = False
project = 'Cloud Container Service' project = 'Cloud Container Engine'
otcdocs_repo_name = 'docs/cloud-container-engine' otcdocs_repo_name = 'docs/cloud-container-engine'
# Those variables are required for edit/bug links # Those variables are required for edit/bug links
otcdocs_git_fqdn = 'gitea.eco.tsi-dev.otc-service.com' otcdocs_git_fqdn = 'gitea.eco.tsi-dev.otc-service.com'
@ -86,7 +86,7 @@ html_theme_options = {
# The name for this set of Sphinx documents. If None, it defaults to # The name for this set of Sphinx documents. If None, it defaults to
# "<project> v<release> documentation". # "<project> v<release> documentation".
html_title = "Cloud Container Service - API Reference" html_title = "Cloud Container Engine - API Reference"
# Add any paths that contain custom static files (such as style sheets) here, # Add any paths that contain custom static files (such as style sheets) here,
@ -101,6 +101,6 @@ html_copy_source = False
latex_documents = [ latex_documents = [
('index', ('index',
'cce-api-ref.tex', 'cce-api-ref.tex',
u'Cloud Container Service - API Reference', u'Cloud Container Engine - API Reference',
u'OpenTelekomCloud', 'manual'), u'OpenTelekomCloud', 'manual'),
] ]

View File

@ -1,6 +1,6 @@
======================================= ======================================
Cloud Container Service - API Reference Cloud Container Engine - API Reference
======================================= ======================================
.. toctree:: .. toctree::
:maxdepth: 1 :maxdepth: 1

View File

@ -15,6 +15,7 @@ To find detailed API definitions for different Kubernetes versions, visit the fo
- 1.19: https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.19/ - 1.19: https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.19/
- 1.21: https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.21/ - 1.21: https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.21/
- 1.23: https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.23/ - 1.23: https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.23/
- 1.25: https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.25/
Based on the open source Kubernetes APIs, CCE enhances and adapts following functions. Based on the open source Kubernetes APIs, CCE enhances and adapts following functions.