Compare commits
1 Commits
main
...
constraint
| Author | SHA1 | Date | |
|---|---|---|---|
| 089e56803e |
@ -377,6 +377,34 @@ Request Parameters
|
||||
+-----------------+-----------------+-------------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| maxPods | No | Integer | Maximum number of pods that can be created on a node, including the default system pods. Value range: 16 to 256. This limit prevents the node from being overloaded of pods. |
|
||||
+-----------------+-----------------+-------------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| nicMultiqueue | No | String | - Number of ENI queues. Example setting: |
|
||||
| | | | |
|
||||
| | | | .. code-block:: |
|
||||
| | | | |
|
||||
| | | | "[{\"queue\":4}]" |
|
||||
| | | | |
|
||||
| | | | The following fields are included: |
|
||||
| | | | |
|
||||
| | | | - **queue**: number of ENI queues. |
|
||||
| | | | - This field can be configured only for BMS nodes in a CCE Turbo cluster. |
|
||||
| | | | - Supported proportions are {"1":128, "2":92, "4":92, "8":32, "16":16, "28":9}. That is, if 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 for two queues. |
|
||||
| | | | - 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. Example setting: |
|
||||
| | | | |
|
||||
| | | | .. code-block:: |
|
||||
| | | | |
|
||||
| | | | "0.3:0.6" |
|
||||
| | | | |
|
||||
| | | | - Low threshold (L): determines the minimum number of pre-bound ENIs (Min). Formula: Min = Total number of ENIs of the node x L |
|
||||
| | | | - High threshold (H): determines the maximum number of pre-bound ENIs (Max). Formula: Max = Total number of ENIs of the node x H |
|
||||
| | | | - Number of ENIs bound to a BMS node (B) and number of ENIs being used by pods (U): U + Min < B < U + Max |
|
||||
| | | | - If the number of pre-bound ENIs on a BMS node is smaller than the minimum allowed, the system will bind more ENIs to make the numbers equal. |
|
||||
| | | | - If the number of pre-bound ENIs on a BMS node is larger than the maximum allowed, the system periodically unbinds ENIs (about every 2 minutes) to make the numbers equal. |
|
||||
| | | | - 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. |
|
||||
+-----------------+-----------------+-------------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
|
||||
.. _addnode__en-us_topic_0000001417516392_request_taint:
|
||||
|
||||
|
||||
File diff suppressed because it is too large
Load Diff
@ -110,28 +110,22 @@ Response
|
||||
|
||||
.. table:: **Table 5** NodePoolSpec
|
||||
|
||||
+-----------------------+---------------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------+
|
||||
+-----------------------+---------------------------------------------------------------------------------------+---------------------------------------------------------------------------------------+
|
||||
| Parameter | Type | Description |
|
||||
+=======================+=======================================================================================+=================================================================================================================================+
|
||||
+=======================+=======================================================================================+=======================================================================================+
|
||||
| type | String | Node pool type. If this parameter is left blank, the value **vm** is used by default. |
|
||||
| | | |
|
||||
| | | - **vm**: ECS |
|
||||
| | | - **ElasticBMS**: BMS. This value is valid in CCE Turbo cluster. |
|
||||
+-----------------------+---------------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------+
|
||||
+-----------------------+---------------------------------------------------------------------------------------+---------------------------------------------------------------------------------------+
|
||||
| nodeTemplate | :ref:`V3NodeSpec <cce_02_0357__response_v3nodespec>` object | Detailed parameters of the node pool template. |
|
||||
+-----------------------+---------------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------+
|
||||
+-----------------------+---------------------------------------------------------------------------------------+---------------------------------------------------------------------------------------+
|
||||
| initialNodeCount | Integer | Initial number of nodes for the node pool. |
|
||||
+-----------------------+---------------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------+
|
||||
+-----------------------+---------------------------------------------------------------------------------------+---------------------------------------------------------------------------------------+
|
||||
| autoscaling | :ref:`NodePoolNodeAutoscaling <cce_02_0357__response_nodepoolnodeautoscaling>` object | Auto scaling parameters. |
|
||||
+-----------------------+---------------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------+
|
||||
+-----------------------+---------------------------------------------------------------------------------------+---------------------------------------------------------------------------------------+
|
||||
| nodeManagement | :ref:`NodeManagement <cce_02_0357__response_nodemanagement>` object | Node management configuration. |
|
||||
+-----------------------+---------------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------+
|
||||
| customSecurityGroups | Array of strings | Custom security group settings for a node pool. New nodes scaled out in a node pool can be bound to a specified security group. |
|
||||
| | | |
|
||||
| | | - Specifying no security group ID will add the new nodes to the default security group of the worker nodes. |
|
||||
| | | - Specifying a valid security group ID will put new nodes in that security group. |
|
||||
| | | - When specifying a security group, do not modify the rules of the port on which CCE running depends. |
|
||||
+-----------------------+---------------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------+
|
||||
+-----------------------+---------------------------------------------------------------------------------------+---------------------------------------------------------------------------------------+
|
||||
|
||||
.. _cce_02_0357__response_v3nodespec:
|
||||
|
||||
|
||||
@ -145,28 +145,22 @@ Response
|
||||
|
||||
.. table:: **Table 7** NodePoolSpec
|
||||
|
||||
+-----------------------+---------------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------+
|
||||
+-----------------------+---------------------------------------------------------------------------------------+---------------------------------------------------------------------------------------+
|
||||
| Parameter | Type | Description |
|
||||
+=======================+=======================================================================================+=================================================================================================================================+
|
||||
+=======================+=======================================================================================+=======================================================================================+
|
||||
| type | String | Node pool type. If this parameter is left blank, the value **vm** is used by default. |
|
||||
| | | |
|
||||
| | | - **vm**: ECS |
|
||||
| | | - **ElasticBMS**: BMS. This value is valid in CCE Turbo cluster. |
|
||||
+-----------------------+---------------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------+
|
||||
+-----------------------+---------------------------------------------------------------------------------------+---------------------------------------------------------------------------------------+
|
||||
| nodeTemplate | :ref:`V3NodeSpec <cce_02_0269__response_v3nodespec>` object | Detailed parameters of the node pool template. |
|
||||
+-----------------------+---------------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------+
|
||||
+-----------------------+---------------------------------------------------------------------------------------+---------------------------------------------------------------------------------------+
|
||||
| initialNodeCount | Integer | Initial number of nodes for the node pool. |
|
||||
+-----------------------+---------------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------+
|
||||
+-----------------------+---------------------------------------------------------------------------------------+---------------------------------------------------------------------------------------+
|
||||
| autoscaling | :ref:`NodePoolNodeAutoscaling <cce_02_0269__response_nodepoolnodeautoscaling>` object | Auto scaling parameters. |
|
||||
+-----------------------+---------------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------+
|
||||
+-----------------------+---------------------------------------------------------------------------------------+---------------------------------------------------------------------------------------+
|
||||
| nodeManagement | :ref:`NodeManagement <cce_02_0269__response_nodemanagement>` object | Node management configuration. |
|
||||
+-----------------------+---------------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------+
|
||||
| customSecurityGroups | Array of strings | Custom security group settings for a node pool. New nodes scaled out in a node pool can be bound to a specified security group. |
|
||||
| | | |
|
||||
| | | - Specifying no security group ID will add the new nodes to the default security group of the worker nodes. |
|
||||
| | | - Specifying a valid security group ID will put new nodes in that security group. |
|
||||
| | | - When specifying a security group, do not modify the rules of the port on which CCE running depends. |
|
||||
+-----------------------+---------------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------+
|
||||
+-----------------------+---------------------------------------------------------------------------------------+---------------------------------------------------------------------------------------+
|
||||
|
||||
.. _cce_02_0269__response_v3nodespec:
|
||||
|
||||
|
||||
@ -150,7 +150,8 @@ Response
|
||||
"External": "https://10.185.69.54:5443",
|
||||
},
|
||||
{
|
||||
"external_otc": "https://a140174a-2f3e-11e9-9f91-0255ac101405.cce.eu-de.otc.t-systems.com", }
|
||||
"external_otc": "https://a140174a-2f3e-11e9-9f91-0255ac101405.cce.eu-de.otc.t-systems.com",
|
||||
}
|
||||
]
|
||||
}
|
||||
}
|
||||
|
||||
@ -133,28 +133,22 @@ Response
|
||||
|
||||
.. table:: **Table 7** Data structure of the spec field
|
||||
|
||||
+-----------------------+----------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------+
|
||||
+-----------------------+----------------------------------------------------------------+-------------------------------------------------------------------+
|
||||
| Parameter | Type | Description |
|
||||
+=======================+================================================================+=================================================================================================================================+
|
||||
+=======================+================================================================+===================================================================+
|
||||
| type | String | Node type. |
|
||||
| | | |
|
||||
| | | - **vm**: ECS |
|
||||
| | | - **ElasticBMS**: BMS. This value is valid in CCE Turbo cluster. |
|
||||
+-----------------------+----------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------+
|
||||
+-----------------------+----------------------------------------------------------------+-------------------------------------------------------------------+
|
||||
| initialNodeCount | Integer | Initial number of nodes for the node pool. |
|
||||
+-----------------------+----------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------+
|
||||
+-----------------------+----------------------------------------------------------------+-------------------------------------------------------------------+
|
||||
| nodeTemplate | :ref:`nodeTemplate <cce_02_0355__table3150105216225>` object | Detailed parameters of the node pool template. |
|
||||
+-----------------------+----------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------+
|
||||
+-----------------------+----------------------------------------------------------------+-------------------------------------------------------------------+
|
||||
| autoscaling | :ref:`autoscaling <cce_02_0355__table14356154632610>` object | Auto scaling parameters. |
|
||||
+-----------------------+----------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------+
|
||||
+-----------------------+----------------------------------------------------------------+-------------------------------------------------------------------+
|
||||
| nodeManagement | :ref:`nodeManagement <cce_02_0355__table1778609171919>` object | Node management parameters. |
|
||||
+-----------------------+----------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------+
|
||||
| customSecurityGroups | Array of strings | Custom security group settings for a node pool. New nodes scaled out in a node pool can be bound to a specified security group. |
|
||||
| | | |
|
||||
| | | - Specifying no security group ID will add the new nodes to the default security group of the worker nodes. |
|
||||
| | | - Specifying a valid security group ID will put new nodes in that security group. |
|
||||
| | | - When specifying a security group, do not modify the rules of the port on which CCE running depends. |
|
||||
+-----------------------+----------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------+
|
||||
+-----------------------+----------------------------------------------------------------+-------------------------------------------------------------------+
|
||||
|
||||
.. _cce_02_0355__table3150105216225:
|
||||
|
||||
|
||||
@ -363,7 +363,8 @@ Response
|
||||
"External": "https://10.185.69.54:5443",
|
||||
},
|
||||
{
|
||||
"external_otc": "https://a140174a-2f3e-11e9-9f91-0255ac101405.cce.eu-de.otc.t-systems.com", },
|
||||
"external_otc": "https://a140174a-2f3e-11e9-9f91-0255ac101405.cce.eu-de.otc.t-systems.com",
|
||||
},
|
||||
]
|
||||
}
|
||||
}
|
||||
|
||||
@ -231,7 +231,8 @@ For details about the response parameters, see :ref:`Table 7 <cce_02_0240__table
|
||||
"External": "https://10.185.69.54:5443",
|
||||
},
|
||||
{
|
||||
"external_otc": "https://a140174a-2f3e-11e9-9f91-0255ac101405.cce.eu-de.otc.t-systems.com", },
|
||||
"external_otc": "https://a140174a-2f3e-11e9-9f91-0255ac101405.cce.eu-de.otc.t-systems.com",
|
||||
},
|
||||
]
|
||||
}
|
||||
}
|
||||
|
||||
@ -43,10 +43,10 @@ The basic logic for field matching is as follows:
|
||||
|
||||
|image2|
|
||||
|
||||
a. In step 1, the first disk in **dataVolumes** is matched by the EVS disk whose size is 100 GiB and storage class is SAS. In step 2, the second disk in **dataVolumes** is matched by the EVS disk whose size is 100 GiB because the first disk has been selected.
|
||||
a. In step 1, the first disk in **dataVolumes** is matched by the EVS disk whose size is 100 GB and storage class is SAS. In step 2, the second disk in **dataVolumes** is matched by the EVS disk whose size is 100 GB because the first disk has been selected.
|
||||
b. In step 3, two disks in **dataVolumes** can be matched because **volumeType** or **count** is not specified in **matchLabels**. In this case, no disk is available for matching in step 4.
|
||||
|
||||
#. **storageGroups** associates with **storageSelectors** based on **selectorName**. Finally, two 100 GiB disks are selected. The CCE backend groups the two PVs into a volume group (VG) and divides the VG into two logical volumes (LVs) in the ratio of 9:1. 10% of Kubernetes LVs are partitioned in striped mode. 90% runtime LVs are partitioned in linear mode by default because runtimeConfig is not configured.
|
||||
#. **storageGroups** associates with **storageSelectors** based on **selectorName**. Finally, two 100 GB disks are selected. The CCE backend groups the two PVs into a volume group (VG) and divides the VG into two logical volumes (LVs) in the ratio of 9:1. 10% of Kubernetes LVs are partitioned in striped mode. 90% runtime LVs are partitioned in linear mode by default because runtimeConfig is not configured.
|
||||
|
||||
Creating a Raw Disk
|
||||
-------------------
|
||||
@ -57,11 +57,11 @@ The following figure shows the API calling logic.
|
||||
|
||||
|image3|
|
||||
|
||||
#. The **cceUse** selector matches a 100 GiB data disk.
|
||||
#. The **cceUse** selector matches a 100 GB data disk.
|
||||
#. The selected disk is managed by CCE and used as a data disk.
|
||||
#. The other 100 GiB data disk created in **dataVolumes** is not selected by any selector and is managed by storageGroups. Therefore, this EVS disk will be attached to the node as a raw disk and will not be initialized.
|
||||
#. The other 100 GB data disk created in **dataVolumes** is not selected by any selector and is managed by storageGroups. Therefore, this EVS disk will be attached to the node as a raw disk and will not be initialized.
|
||||
|
||||
After the node is created, log in to the node and check whether a 100 GiB disk has been attached but not initialized.
|
||||
After the node is created, log in to the node and check whether a 100 GB disk has been attached but not initialized.
|
||||
|
||||
|image4|
|
||||
|
||||
@ -156,11 +156,11 @@ The following figure shows the API calling logic.
|
||||
|
||||
|image5|
|
||||
|
||||
#. The **user1** selector selects a 100 GiB data disk.
|
||||
#. The **user1** selector selects a 100 GB data disk.
|
||||
#. Create a VG named **vguser1** using LVM.
|
||||
#. Strip all the space of **vguser1** into an LV named **user** and format the disk in ext4 format. Finally, attach the disk to the **/tmp2** directory.
|
||||
|
||||
After the node is created, log in to the node and check whether a 100 GiB disk has been attached and managed by LVM.
|
||||
After the node is created, log in to the node and check whether a 100 GB disk has been attached and managed by LVM.
|
||||
|
||||
|image6|
|
||||
|
||||
@ -278,7 +278,7 @@ Currently, the striped LV function is supported only by calling an API. The foll
|
||||
|
||||
|image7|
|
||||
|
||||
#. **storageSelectors** matches all EVS disks in **dataVolumes** because **matchLabels** is not contained in **storageSelectors**.
|
||||
#. **storageSelectors** matches all EVS disks in **dataVolumes** because **matchLables** is not contained in **storageSelectors**.
|
||||
#. Create a VG named **vgpaas** using LVM.
|
||||
#. Strip 90% of the **vgpaas** space into runtime LVs.
|
||||
#. Strip 10% of the **vgpaas** space into Kubernetes LVs.
|
||||
@ -286,8 +286,7 @@ Currently, the striped LV function is supported only by calling an API. The foll
|
||||
.. note::
|
||||
|
||||
- Two or more data disks are required for striping.
|
||||
- When creating a striped LV, ensure that the types and sizes of the PVs added to the VG are the same. Otherwise, the creation will fail.
|
||||
- When creating a striped LV, use the striping configuration for both the runtime LV and Kubernetes LV. Otherwise, the creation will fail.
|
||||
- When creating a striped LV, ensure that the types and sizes of the PVs added to the VG are the same. Otherwise, the striping fails.
|
||||
|
||||
Log in to the node and run the following command to view the striping result:
|
||||
|
||||
|
||||
@ -15,7 +15,6 @@ Appendix
|
||||
- :ref:`API Permissions <cce_02_0272>`
|
||||
- :ref:`Creating a VPC and Subnet <cce_02_0100>`
|
||||
- :ref:`Creating a Key Pair <cce_02_0101>`
|
||||
- :ref:`Node Flavor Description <cce_02_0368>`
|
||||
- :ref:`Attaching Disks to a Node <node_storage_example>`
|
||||
|
||||
.. toctree::
|
||||
@ -32,5 +31,4 @@ Appendix
|
||||
api_permissions
|
||||
creating_a_vpc_and_subnet
|
||||
creating_a_key_pair
|
||||
node_flavor_description
|
||||
attaching_disks_to_a_node
|
||||
|
||||
@ -1,45 +0,0 @@
|
||||
:original_name: cce_02_0368.html
|
||||
|
||||
.. _cce_02_0368:
|
||||
|
||||
Node Flavor Description
|
||||
=======================
|
||||
|
||||
.. note::
|
||||
|
||||
Different regions support different node flavors, and node flavors may be changed. You are advised to log in to the CCE console and check whether the required node flavors are supported on the page for creating nodes.
|
||||
|
||||
- **CCE cluster**
|
||||
|
||||
CCE clusters support only 2 vCPUs and 4 GiB or higher specifications. You are advised to query node specifications on the console. For details about node specifications, see ECS Specifications.
|
||||
|
||||
You need to enter the specific flavor name, for example, **c4.large.2**.
|
||||
|
||||
The following tables list the specifications supported by CCE. (The specifications of some ECS models vary by region. The actual specifications displayed on the console are used.)
|
||||
|
||||
- ECS (VM):
|
||||
|
||||
.. table:: **Table 1** x86 nodes
|
||||
|
||||
====================== =====================
|
||||
Node Type Flavor
|
||||
====================== =====================
|
||||
General computing-plus c4, c3
|
||||
General-purpose s3, s2
|
||||
Memory-optimized m4, m3
|
||||
Disk-intensive d2
|
||||
GPU-accelerated pi2, p2s, g6, and p2v
|
||||
====================== =====================
|
||||
|
||||
- **CCE Turbo clusters**
|
||||
|
||||
- ECS (VM):
|
||||
|
||||
.. table:: **Table 2** x86 nodes
|
||||
|
||||
====================== ======
|
||||
Node Type Flavor
|
||||
====================== ======
|
||||
General computing-plus c3n
|
||||
Container-plus m3n
|
||||
====================== ======
|
||||
@ -10,9 +10,6 @@ Change History
|
||||
+-----------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| Date | Revision |
|
||||
+===================================+============================================================================================================================================================================+
|
||||
| 2023-11-06 | - Added the customSecurityGroups field. For details, see :ref:`Table 5 <cce_02_0354__table620623542313>`. |
|
||||
| | - Added :ref:`Node Flavor Description <cce_02_0368>`. |
|
||||
+-----------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| 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>`. |
|
||||
|
||||
File diff suppressed because it is too large
Load Diff
@ -1,2 +0,0 @@
|
||||
[html writers]
|
||||
table-style: table, caption-top
|
||||
@ -1,4 +0,0 @@
|
||||
======================================
|
||||
Cloud Container Engine - Best Practice
|
||||
======================================
|
||||
|
||||
@ -1,10 +1,7 @@
|
||||
sphinx>=2.0.0,!=2.1.0 # BSD
|
||||
|
||||
otcdocstheme # Apache-2.0
|
||||
|
||||
# releasenotes
|
||||
reno>=3.1.0 # Apache-2.0
|
||||
|
||||
otc-sphinx-directives>=0.1.0
|
||||
sphinx-minify>=0.0.1 # Apache-2.0
|
||||
git+https://gitea.eco.tsi-dev.otc-service.com/infra/otc-metadata.git#egg=otc_metadata
|
||||
@ -31,17 +31,6 @@ otcdocs_repo_name = 'docs/cloud-container-engine'
|
||||
otcdocs_git_fqdn = 'gitea.eco.tsi-dev.otc-service.com'
|
||||
otcdocs_git_type = 'gitea'
|
||||
|
||||
# Those variables are needed for indexing into OpenSearch
|
||||
otcdocs_doc_environment = ''
|
||||
otcdocs_doc_link = ''
|
||||
otcdocs_doc_title = ''
|
||||
otcdocs_doc_type = ''
|
||||
otcdocs_service_category = 'container'
|
||||
otcdocs_service_title = 'Cloud Container Engine'
|
||||
otcdocs_service_type = 'cce'
|
||||
otcdocs_search_environment = 'hc_de'
|
||||
otcdocs_search_url = "https://opensearch.eco.tsi-dev.otc-service.com/"
|
||||
|
||||
# If extensions (or modules to document with autodoc) are in another directory,
|
||||
# add these directories to sys.path here. If the directory is relative to the
|
||||
# documentation root, use os.path.abspath to make it absolute, like shown here.
|
||||
|
||||
@ -8,7 +8,5 @@ CCE provides highly scalable, high-performance, enterprise-class Kubernetes clus
|
||||
|
||||
.. service_card::
|
||||
:service_type: cce
|
||||
:environment: internal
|
||||
:umn: Describes the basic concepts, functions, key terms, best practices, FAQs and steps for quickly creating clusters and containerized applications.
|
||||
:api-ref: Describes the APIs provided by CCE including the functions, parameters, and examples of each API.
|
||||
:best-practice: To use Cloud Container Engine more securely, reliably, flexibly, and efficiently, you are advised to follow the following best practices.
|
||||
|
||||
60
tox.ini
60
tox.ini
@ -34,13 +34,10 @@ allowlist_externals =
|
||||
rm
|
||||
sphinx-build
|
||||
commands =
|
||||
rm -rf doc/build/html doc/build/html_temp doc/build/doctrees
|
||||
sphinx-build -a -E -W -d doc/build/doctrees -b html doc/source doc/build/html_temp
|
||||
sphinx-minify --input-directory doc/build/html_temp/ --output-directory doc/build/html
|
||||
rm -rf doc/build/html doc/build/doctrees
|
||||
sphinx-build -a -E -W -d doc/build/doctrees -b html doc/source doc/build/html
|
||||
{[testenv:umn]commands}
|
||||
{[testenv:json-umn]commands}
|
||||
{[testenv:best-practice]commands}
|
||||
{[testenv:json-best-practice]commands}
|
||||
{[testenv:api-ref]commands}
|
||||
{[testenv:json-api-ref]commands}
|
||||
|
||||
@ -54,7 +51,6 @@ allowlist_externals =
|
||||
cp
|
||||
commands =
|
||||
mkdir -p doc/build/pdf
|
||||
{[testenv:best-practice-pdf-docs]commands}
|
||||
{[testenv:api-ref-pdf-docs]commands}
|
||||
|
||||
|
||||
@ -65,8 +61,7 @@ allowlist_externals =
|
||||
cp
|
||||
mkdir
|
||||
commands =
|
||||
sphinx-build -W --keep-going -b html umn/source doc/build/html_temp/umn
|
||||
sphinx-minify --input-directory doc/build/html_temp/umn --output-directory doc/build/html/umn
|
||||
sphinx-build -W --keep-going -b html umn/source doc/build/html/umn
|
||||
mkdir -p umn/build/html
|
||||
cp -av doc/build/html/umn umn/build/html
|
||||
|
||||
@ -87,52 +82,6 @@ commands =
|
||||
|
||||
|
||||
|
||||
# HTML version
|
||||
[testenv:best-practice]
|
||||
deps = {[testenv:docs]deps}
|
||||
allowlist_externals =
|
||||
cp
|
||||
mkdir
|
||||
commands =
|
||||
sphinx-build -W --keep-going -b html doc/best-practice/source doc/build/html_temp/best-practice
|
||||
sphinx-minify --input-directory doc/build/html_temp/best-practice --output-directory doc/build/html/best-practice
|
||||
mkdir -p best-practice/build/html
|
||||
cp -av doc/build/html/best-practice best-practice/build/html
|
||||
|
||||
# Json version (for search)
|
||||
[testenv:json-best-practice]
|
||||
deps = {[testenv:docs]deps}
|
||||
allowlist_externals =
|
||||
cp
|
||||
mkdir
|
||||
sh
|
||||
commands =
|
||||
sphinx-build -W --keep-going -b json doc/best-practice/source doc/build/json/best-practice
|
||||
# Drop data useless for the search - wrap it also with sh/xargs due to bugs
|
||||
# in tox
|
||||
sh -c "find doc/build/json -type d -and '(' -name '_images' -or -name '_static' -or -name '_sources' ')' -print0 | xargs -0 rm -rf"
|
||||
mkdir -p best-practice/build/json
|
||||
cp -av doc/build/json/best-practice best-practice/build/json
|
||||
|
||||
# PDF version
|
||||
[testenv:best-practice-pdf-docs]
|
||||
deps = {[testenv:docs]deps}
|
||||
allowlist_externals =
|
||||
rm
|
||||
mkdir
|
||||
make
|
||||
bash
|
||||
cp
|
||||
commands =
|
||||
rm -rf doc/best-practice/build/pdf
|
||||
sphinx-build -W --keep-going -b latex doc/best-practice/source doc/best-practice/build/pdf/
|
||||
bash -c "for f in doc/best-practice/build/pdf/*.gif; do convert $f $\{f/%gif/png\}; done || true"
|
||||
bash -c "for f in doc/best-practice/build/pdf/*.tex; do sed -iorig 's/\.gif//g' $f; done"
|
||||
make -C doc/best-practice/build/pdf
|
||||
mkdir -p doc/build/pdf
|
||||
cp doc/best-practice/build/pdf/cce-best-practice.pdf doc/build/pdf/
|
||||
|
||||
|
||||
# HTML version
|
||||
[testenv:api-ref]
|
||||
deps = {[testenv:docs]deps}
|
||||
@ -140,8 +89,7 @@ allowlist_externals =
|
||||
cp
|
||||
mkdir
|
||||
commands =
|
||||
sphinx-build -W --keep-going -b html api-ref/source doc/build/html_temp/api-ref
|
||||
sphinx-minify --input-directory doc/build/html_temp/api-ref --output-directory doc/build/html/api-ref
|
||||
sphinx-build -W --keep-going -b html api-ref/source doc/build/html/api-ref
|
||||
mkdir -p api-ref/build/html
|
||||
cp -av doc/build/html/api-ref api-ref/build/html
|
||||
|
||||
|
||||
Loading…
x
Reference in New Issue
Block a user