vpruthi/doc-exports
1
0
Fork 0
forked from docs/doc-exports
Code Pull Requests Activity

CCE API: Fix some link problems

Browse Source 
Reviewed-by: Eotvos, Oliver <oliver.eotvos@t-systems.com>
Co-authored-by: Dong, Qiu Jian <qiujiandong1@huawei.com>
Co-committed-by: Dong, Qiu Jian <qiujiandong1@huawei.com>
This commit is contained in:
Dong, Qiu Jian 2023-06-13 06:42:51 +00:00 committed by zuul
parent 51dc9baefd
commit a177f38d14
9 changed files with 412 additions and 380 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

4
docs/cce/api-ref/ALL_META.TXT.json
View File

@ -140,7 +140,7 @@
"githuburl":""
},
{
"uri":"cce_02_0359_0.html",
"uri":"cce_02_0359.html",
"product_code":"cce",
"code":"15",
"des":"This API is used to obtain certificates of a specified cluster in form of kubeconfig file.GET /api/v3/projects/{project_id}/clusters/{cluster_id}/clustercertTable 1 descr",
@ -423,7 +423,7 @@
"uri":"kubernetesapi.html",
"product_code":"cce",
"code":"43",
"des":"You can use Kubernetes native APIs to manage your Kubernetes clusters. For details, see Kubernetes API Concepts.To find detailed API definitions for different Kubernetes ",
"des":"Kubernetes APIs are resource-based (RESTful) programming interfaces provided through HTTP. It supports query, creation, update, and deletion of various cluster resources ",
"doc_type":"api2",
"kw":"Overview,Kubernetes APIs,API Reference",
"title":"Overview",

4
docs/cce/api-ref/CLASS.TXT.json
View File

@ -129,7 +129,7 @@
"desc":"This API is used to obtain certificates of a specified cluster in form of kubeconfig file.GET /api/v3/projects/{project_id}/clusters/{cluster_id}/clustercertTable 1 descr",
"product_code":"cce",
"title":"Obtaining Cluster Certificates (Deprecated)",
"uri":"cce_02_0359_0.html",
"uri":"cce_02_0359.html",
"doc_type":"api2",
"p_code":"6",
"code":"15"
@ -378,7 +378,7 @@
"code":"42"
},
{
"desc":"You can use Kubernetes native APIs to manage your Kubernetes clusters. For details, see Kubernetes API Concepts.To find detailed API definitions for different Kubernetes ",
"desc":"Kubernetes APIs are resource-based (RESTful) programming interfaces provided through HTTP. It supports query, creation, update, and deletion of various cluster resources ",
"product_code":"cce",
"title":"Overview",
"uri":"kubernetesapi.html",

63
docs/cce/api-ref/MigrateNode.html
View File

File diff suppressed because it is too large Load Diff

2
docs/cce/api-ref/cce_02_0092.html
View File

@ -20,7 +20,7 @@
</li>
<li class="ulchildlink"><strong><a href="cce_02_0248.html">Obtaining Cluster Certificates</a></strong><br>
</li>
<li class="ulchildlink"><strong><a href="cce_02_0359_0.html">Obtaining Cluster Certificates (Deprecated)</a></strong><br>
<li class="ulchildlink"><strong><a href="cce_02_0359.html">Obtaining Cluster Certificates (Deprecated)</a></strong><br>
</li>
<li class="ulchildlink"><strong><a href="cce_02_0242.html">Creating a Node</a></strong><br>
</li>

6
docs/cce/api-ref/cce_02_0344.html
View File

@ -3,15 +3,15 @@
<h1 class="topictitle1">API Usage Guidelines</h1>
<div id="body1569373330500"><p id="cce_02_0344__p694217218">Cloud APIs comply with the RESTful API design principles. REST-based web services are organized into resources. Each resource is identified by one or more Uniform Resource Identifiers (URIs). An application accesses a resource based on the resource's Unified Resource Locator (URL). A URL is usually in the following format: <em id="cce_02_0344__i8449151122912">https://Endpoint/uri</em>. In the URL, <em id="cce_02_0344__i114521051192914">uri</em> indicates the resource path, that is, the API access path.</p>
<p id="cce_02_0344__p4816427810259">Cloud APIs use HTTPS as the transmission protocol. Requests/Responses are transmitted by using JSON messages, with media type represented by <strong id="cce_02_0344__b1025950229154127">Application/json</strong>.</p>
<ul id="cce_02_0344__ul13319112316819"><li id="cce_02_0344__li43190231280">The URL of APIs described in <a href="cce_02_0092.html">Cluster Management</a> is in the format of <em id="cce_02_0344__i1611453113614">https://Endpoint/uri</em>. In the URL, uri indicates the resource path, that is, the API access path. Use X-Auth-Token as a header.</li><li id="cce_02_0344__li11319132310812">The URL of Kubernetes-native APIs described in <a href="cce_02_0320.html">Add-on Management</a> and <a href="cce_02_0340.html">Kubernetes APIs</a> is in the format of <strong id="cce_02_0344__b1319152318817">https://{clusterid}.Endpoint/uri</strong>. In the URL, {clusterid} indicates a cluster ID, and uri indicates the resource path, that is, the API access path. Use X-Auth-Token as a header.</li><li id="cce_02_0344__li251551565014">The URL of Kubernetes-native APIs is in the format of <strong id="cce_02_0344__b1760920115129">https://{publicip}:5443/uri</strong>. In the URL, <strong id="cce_02_0344__b166093113127">{publicip}</strong> indicates EIP of the cluster, and <strong id="cce_02_0344__b146096111217">uri</strong> indicates the resource path, that is, the API access path. Use X-Remote-User or Authorization as a header.<div class="p" id="cce_02_0344__p1887502514125">Before using X-Remote-User as a header, obtain the required certificate in advance. Two types of certificates are supported:<ul id="cce_02_0344__ul1498525216115"><li id="cce_02_0344__li594175418416">Self-owned certificate uploaded during cluster creation. For details, see <a href="https://docs.otc.t-systems.com/en-us/usermanual2/cce/cce_01_0028.html" target="_blank" rel="noopener noreferrer">Creating a Cluster</a>.<p id="cce_02_0344__p519555315"><span><img id="cce_02_0344__image20959154315152" src="en-us_image_0000001121602072.png" title="Click to enlarge" class="imgResize"></span></p>
</li><li id="cce_02_0344__li119868526113">Cluster certificate generated and downloaded after cluster creation. For details, see <a href="https://docs.otc.t-systems.com/en-us/usermanual2/cce/cce_01_0175.html" target="_blank" rel="noopener noreferrer">Obtaining a Cluster Certificate</a>.<p id="cce_02_0344__p2297165721520"><span><img id="cce_02_0344__image97354579155" src="en-us_image_0227096557.png" title="Click to enlarge" class="imgResize"></span></p>
<ul id="cce_02_0344__ul13319112316819"><li id="cce_02_0344__li43190231280">The URL of APIs described in <a href="cce_02_0092.html">Cluster Management</a> is in the format of <em id="cce_02_0344__i1611453113614">https://Endpoint/uri</em>. In the URL, uri indicates the resource path, that is, the API access path. Use X-Auth-Token as a header.</li><li id="cce_02_0344__li11319132310812">The URL of Kubernetes-native APIs described in <a href="cce_02_0320.html">Add-on Management</a> and <a href="cce_02_0340.html">Kubernetes APIs</a> is in the format of <strong id="cce_02_0344__b1319152318817">https://{clusterid}.Endpoint/uri</strong>. In the URL, {clusterid} indicates a cluster ID, and uri indicates the resource path, that is, the API access path. Use X-Auth-Token as a header.</li><li id="cce_02_0344__li251551565014">The URL of Kubernetes-native APIs is in the format of <strong id="cce_02_0344__b1760920115129">https://{publicip}:5443/uri</strong>. In the URL, <strong id="cce_02_0344__b166093113127">{publicip}</strong> indicates EIP of the cluster, and <strong id="cce_02_0344__b146096111217">uri</strong> indicates the resource path, that is, the API access path. Use X-Remote-User or Authorization as a header.<div class="p" id="cce_02_0344__p1887502514125">Before using X-Remote-User as a header, obtain the required certificate in advance. Two types of certificates are supported:<ul id="cce_02_0344__ul1498525216115"><li id="cce_02_0344__li594175418416">Self-owned certificate uploaded during cluster creation. For details, see <a href="https://docs.otc.t-systems.com/en-us/usermanual2/cce/cce_10_0028.html" target="_blank" rel="noopener noreferrer">Creating a Cluster</a>.<p id="cce_02_0344__p519555315"><span><img id="cce_02_0344__image20959154315152" src="en-us_image_0000001121602072.png" title="Click to enlarge" class="imgResize"></span></p>
</li><li id="cce_02_0344__li119868526113">Cluster certificate generated and downloaded after cluster creation. For details, see <a href="https://docs.otc.t-systems.com/en-us/usermanual2/cce/cce_10_0175.html" target="_blank" rel="noopener noreferrer">Obtaining a Cluster Certificate</a>.<p id="cce_02_0344__p2297165721520"><span><img id="cce_02_0344__image97354579155" src="en-us_image_0227096557.png" title="Click to enlarge" class="imgResize"></span></p>
</li></ul>
</div>
</li></ul>
<p id="cce_02_0344__p156196428514">For details about how to use APIs, see <a href="https://docs.otc.t-systems.com/en-us/api/apiug/apig-en-api-180328001.html?tag=API Documents" target="_blank" rel="noopener noreferrer">API Usage Guidelines</a>.</p>
<p id="cce_02_0344__p1928010407415">CCE provides two methods to authenticate requests for calling an API: token and AK/SK. Select an authentication method based on actual requirements. If token-based authentication is used, you can call service APIs by using either of the following methods after obtaining a token:</p>
<ul id="cce_02_0344__ul4552184012514"><li id="cce_02_0344__li17245131773918">Method 1: Add <strong id="cce_02_0344__b16119186394">X-Auth-Token</strong> to the request header and set <strong id="cce_02_0344__b9161823912">X-Auth-Token: ${token}</strong> with the obtained IAM token.</li><li id="cce_02_0344__li1387183419395">Method 2: Add <strong id="cce_02_0344__b1057022318263">Authorization</strong> to the request header and set <strong id="cce_02_0344__b6248243183920">Authorization: Bearer ${token}</strong> with the obtained IAM token or token from Kubernetes service account.</li><li id="cce_02_0344__li89714112401">Method 3: Add <strong id="cce_02_0344__b43089717408">X-Remote-User</strong> to the request header and set <strong id="cce_02_0344__b5208739122619">X-Remote-User</strong>: <strong id="cce_02_0344__b17930741152615">user</strong> with a valid certificate.</li></ul>
<div class="note" id="cce_02_0344__note162803401947"><img src="public_sys-resources/note_3.0-en-us.png"><span class="notetitle"> </span><div class="notebody"><p id="cce_02_0344__p107403334488">Method 3 requires that the CA root certificate must has been uploaded before you create a cluster on the CCE console. For details, see <a href="https://docs.otc.t-systems.com/en-us/usermanual2/cce/cce_01_0085.html" target="_blank" rel="noopener noreferrer">Cluster Management Permission Control</a>.</p>
<div class="note" id="cce_02_0344__note162803401947"><img src="public_sys-resources/note_3.0-en-us.png"><span class="notetitle"> </span><div class="notebody"><p id="cce_02_0344__p107403334488">Method 3 requires that the CA root certificate must has been uploaded before you create a cluster on the CCE console.</p>
</div></div>
</div>

347
docs/cce/api-ref/cce_02_0359.html Normal file
View File

File diff suppressed because it is too large Load Diff

347
docs/cce/api-ref/cce_02_0359_0.html
View File

File diff suppressed because it is too large Load Diff

13
docs/cce/api-ref/kubernetesapi.html
View File

@ -1,14 +1,11 @@
<a name="kubernetesapi"></a><a name="kubernetesapi"></a>
<h1 class="topictitle1">Overview</h1>
<div id="body0000001355453942"><div class="section" id="kubernetesapi__section3701731155417"><h4 class="sectiontitle">Description</h4><p id="kubernetesapi__p155192037173414">You can use Kubernetes native APIs to manage your Kubernetes clusters. For details, see <a href="https://kubernetes.io/docs/reference/using-api/api-concepts/" target="_blank" rel="noopener noreferrer">Kubernetes API Concepts</a>.</p>
<p id="kubernetesapi__p966734320541">To find detailed API definitions for different Kubernetes versions, visit the following links:</p>
<ul id="kubernetesapi__ul163062345469"><li id="kubernetesapi__li730693444617">1.19: <a href="https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.19/" target="_blank" rel="noopener noreferrer">https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.19/</a></li><li id="kubernetesapi__li2277248144615">1.21: <a href="https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.21/" target="_blank" rel="noopener noreferrer">https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.21/</a></li><li id="kubernetesapi__li1151127194715">1.23: <a href="https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.23/" target="_blank" rel="noopener noreferrer">https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.23/</a></li><li id="kubernetesapi__li4813199192015">1.25: <a href="https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.25/" target="_blank" rel="noopener noreferrer">https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.25/</a></li></ul>
<p id="kubernetesapi__p16108214174613">Based on the open source Kubernetes APIs, CCE enhances and adapts following functions.</p>
<ul id="kubernetesapi__ul104771927155520"><li id="kubernetesapi__li20477202715511">Ingress: For details, see <a href="https://docs.otc.t-systems.com/en-us/usermanual2/cce/cce_01_0252.html" target="_blank" rel="noopener noreferrer">Using kubectl to Create an ELB Ingress</a>.</li><li id="kubernetesapi__li3402181935019">PV and PVC: For details, see <a href="https://docs.otc.t-systems.com/en-us/usermanual2/cce/cce_01_0379.html" target="_blank" rel="noopener noreferrer">PV</a> and <a href="https://docs.otc.t-systems.com/en-us/usermanual2/cce/cce_01_0378.html" target="_blank" rel="noopener noreferrer">PVC</a>.<ul id="kubernetesapi__ul1086971985015"><li id="kubernetesapi__li1477627165520">EVS: For details, see <a href="https://docs.otc.t-systems.com/en-us/usermanual2/cce/cce_01_0257.html" target="_blank" rel="noopener noreferrer">Creating a Pod Mounted with an EVS Volume</a>.</li><li id="kubernetesapi__li12263113011517">SFS Turbo: For details, see <a href="https://docs.otc.t-systems.com/en-us/usermanual2/cce/cce_01_0274.html" target="_blank" rel="noopener noreferrer">Creating a Deployment Mounted with an SFS Turbo Volume</a> and <a href="https://docs.otc.t-systems.com/en-us/usermanual2/cce/cce_01_0273.html" target="_blank" rel="noopener noreferrer">Creating a StatefulSet Mounted with an SFS Turbo Volume</a>.</li><li id="kubernetesapi__li916333445011">OBS: For details, see <a href="https://docs.otc.t-systems.com/en-us/usermanual2/cce/cce_01_0269.html" target="_blank" rel="noopener noreferrer">Creating a Deployment Mounted with an OBS Volume</a> and <a href="https://docs.otc.t-systems.com/en-us/usermanual2/cce/cce_01_0268.html" target="_blank" rel="noopener noreferrer">Creating a StatefulSet Mounted with an OBS Volume</a>.</li><li id="kubernetesapi__li1162512911544">SFS: For details, see <a href="https://docs.otc.t-systems.com/en-us/usermanual2/cce/cce_01_0263.html" target="_blank" rel="noopener noreferrer">Creating a Deployment Mounted with an SFS Volume</a> and <a href="https://docs.otc.t-systems.com/en-us/usermanual2/cce/cce_01_0262.html" target="_blank" rel="noopener noreferrer">Creating a StatefulSet Mounted with an SFS Volume</a>.</li></ul>
</li><li id="kubernetesapi__li8207150145715">Network Policies: For details, see <a href="https://docs.otc.t-systems.com/en-us/usermanual2/cce/cce_01_0059.html" target="_blank" rel="noopener noreferrer">Network Policies</a>.</li></ul>
<div id="body0000001355453942"><div class="section" id="kubernetesapi__section3701731155417"><h4 class="sectiontitle">Description</h4><p id="kubernetesapi__p8472102118288">Kubernetes APIs are resource-based (RESTful) programming interfaces provided through HTTP. It supports query, creation, update, and deletion of various cluster resources using standard HTTP request methods (POST, PUT, PATCH, DELETE, and GET).</p>
<p id="kubernetesapi__p8472521172810">CCE allows you to use native <a href="https://kubernetes.io/docs/reference/kubernetes-api/" target="_blank" rel="noopener noreferrer">Kubernetes APIs</a> in the following ways:</p>
<ul id="kubernetesapi__ul129695315280"><li id="kubernetesapi__li596915313282"><a href="#kubernetesapi__section41207155509">Calling Kubernetes APIs Through API Gateway</a></li><li id="kubernetesapi__li11831714192814"><a href="#kubernetesapi__section14674391312">Calling Kubernetes APIs Through the API Server</a></li></ul>
</div>
<div class="section" id="kubernetesapi__section41207155509"><h4 class="sectiontitle">Calling Kubernetes APIs Through API Gateway</h4><p id="kubernetesapi__p1777710173595">You can call Kubernetes native APIs through API Gateway using the URL in the format of <strong id="kubernetesapi__b178956281620">https://{<em id="kubernetesapi__i33322331464">clusterid</em>}.Endpoint/<em id="kubernetesapi__i694334415612">uri</em></strong>. In the URL, <em id="kubernetesapi__i111421351869">{clusterid}</em> indicates the cluster ID, and <em id="kubernetesapi__i121431235169">uri</em> indicates the resource path, that is, the path for API access.</p>
<div class="section" id="kubernetesapi__section41207155509"><a name="kubernetesapi__section41207155509"></a><a name="section41207155509"></a><h4 class="sectiontitle">Calling Kubernetes APIs Through API Gateway</h4><p id="kubernetesapi__p1777710173595">You can call Kubernetes native APIs through API Gateway using the URL in the format of <strong id="kubernetesapi__b178956281620">https://{<em id="kubernetesapi__i33322331464">clusterid</em>}.Endpoint/<em id="kubernetesapi__i694334415612">uri</em></strong>. In the URL, <em id="kubernetesapi__i111421351869">{clusterid}</em> indicates the cluster ID, and <em id="kubernetesapi__i121431235169">uri</em> indicates the resource path, that is, the path for API access.</p>
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="kubernetesapi__table7272144324912" frame="border" border="1" rules="all"><caption><b>Table 1 </b>URL parameters</caption><thead align="left"><tr id="kubernetesapi__en-us_topic_0092901339_row12957510145518"><th align="left" class="cellrowborder" valign="top" width="24.529999999999998%" id="mcps1.3.2.3.2.3.1.1"><p id="kubernetesapi__en-us_topic_0092901339_p195751012559">Parameter</p>
</th>
@ -35,7 +32,7 @@
</table>
</div>
</div>
<div class="section" id="kubernetesapi__section14674391312"><h4 class="sectiontitle">Calling Kubernetes APIs Through the API Server</h4><p id="kubernetesapi__p1248519452209">You can use the API server of a Kubernetes cluster to call Kubernetes native APIs.</p>
<div class="section" id="kubernetesapi__section14674391312"><a name="kubernetesapi__section14674391312"></a><a name="section14674391312"></a><h4 class="sectiontitle">Calling Kubernetes APIs Through the API Server</h4><p id="kubernetesapi__p1248519452209">You can use the API server of a Kubernetes cluster to call Kubernetes native APIs.</p>
<ol id="kubernetesapi__ol1420332061712"><li id="kubernetesapi__li1013775412177"><span>Call the <a href="cce_02_0248.html">API for obtaining the cluster certificate</a> to obtain the cluster certificates.</span><p><p id="kubernetesapi__p10926184211419">There are three certificates:</p>
<ul id="kubernetesapi__ul934641310465"><li id="kubernetesapi__li834691314620">ca.crt</li><li id="kubernetesapi__li8347413184614">client.crt</li><li id="kubernetesapi__li1434717138467">client.key</li></ul>
</p></li><li id="kubernetesapi__li14730103613179"><span>Go to the cluster details page and obtain the API server address (private or public network address).</span><p><p id="kubernetesapi__p16832192924218">With the certificates and API server address, you can call Kubernetes native APIs.</p>

6
docs/cce/api-ref/node_storage_example.html
View File

@ -66,7 +66,7 @@ vgcreate ${vgName} ${storageDevice}</pre>
"login": {
"userPassword": {
"username": "root",
"password": "JDYkbzhEbE90ckIkY1c0SWJzRy9WeVIzcDFVbC41NFVqa1pxenE0bW9naERlS2RCWEIyWlhqSlpWSjJrL2NmcmdWeE12NGh4T25DeDhlMTdrREVSM2dicHdZNmYzZXh5dy4="
"password": "******"
}
},
"storage": {
@ -152,7 +152,7 @@ vgcreate ${vgName} ${storageDevice}</pre>
"login": {
"userPassword": {
"username": "root",
"password": "JDYkRmJPckIwRkMkR3RXTkFsNmYvNlAxSDdOTUhYSHZmWjQ0b0ttODRzTDk0L1NzMzRIaHBsQVJkRTZiOGI0WTVJbUtSLlF5aTAuTUpwbGZqdHBTdkYxOU9peGZPV2FUYi4="
"password": "******"
}
},
"storage": {
@ -263,7 +263,7 @@ vgcreate ${vgName} ${storageDevice}</pre>
"login": {
"userPassword": {
"username": "root",
"password": "JDYkbzhEbE90ckIkY1c0SWJzRy9WeVIzcDFVbC41NFVqa1pxenE0bW9naERlS2RCWEIyWlhqSlpWSjJrL2NmcmdWeE12NGh4T25DeDhlMTdrREVSM2dicHdZNmYzZXh5dy4="
"password": "******"
}
},
"storage": {