diff --git a/docs/cci/api-ref/ALL_META.TXT.json b/docs/cci/api-ref/ALL_META.TXT.json new file mode 100644 index 00000000..45799468 --- /dev/null +++ b/docs/cci/api-ref/ALL_META.TXT.json @@ -0,0 +1,869 @@ +[ + { + "dockw":"API Reference" + }, + { + "uri":"cci_02_0009.html", + "node_id":"cci_02_0009.xml", + "product_code":"cci", + "code":"1", + "des":"HUAWEI CLOUD Help Center presents technical documents to help you quickly get started with HUAWEI CLOUD services. The technical documents include Service Overview, Price Details, Purchase Guide, User Guide, API Reference, Best Practices, FAQs, and Videos.", + "doc_type":"api", + "kw":"Calling APIs", + "search_title":"", + "metedata":[ + { + "documenttype":"api", + "prodname":"cci", + "opensource":"true" + } + ], + "title":"Calling APIs", + "githuburl":"" + }, + { + "uri":"cci_02_0003.html", + "node_id":"cci_02_0003.xml", + "product_code":"cci", + "code":"2", + "des":"Requests for calling an API can be authenticated using either of the following methods:AK/SK authentication: Requests are encrypted using AK/SK pairs. AK/SK authenticatio", + "doc_type":"api", + "kw":"Authentication,Calling APIs,API Reference", + "search_title":"", + "metedata":[ + { + "documenttype":"api", + "prodname":"cci", + "opensource":"true" + } + ], + "title":"Authentication", + "githuburl":"" + }, + { + "uri":"cci_02_0011.html", + "node_id":"cci_02_0011.xml", + "product_code":"cci", + "code":"3", + "des":"You can call APIs to create a pod. An Nginx image is used as an example to show how you can create a pod.The Nginx image is from the open-source image center, and the con", + "doc_type":"api", + "kw":"Getting Started,API Reference", + "search_title":"", + "metedata":[ + { + "documenttype":"api", + "prodname":"cci", + "opensource":"true" + } + ], + "title":"Getting Started", + "githuburl":"" + }, + { + "uri":"cci_02_2000.html", + "node_id":"cci_02_2000.xml", + "product_code":"cci", + "code":"4", + "des":"HUAWEI CLOUD Help Center presents technical documents to help you quickly get started with HUAWEI CLOUD services. The technical documents include Service Overview, Price Details, Purchase Guide, User Guide, API Reference, Best Practices, FAQs, and Videos.", + "doc_type":"api", + "kw":"Proprietary APIs", + "search_title":"", + "metedata":[ + { + "documenttype":"api", + "prodname":"cci", + "opensource":"true" + } + ], + "title":"Proprietary APIs", + "githuburl":"" + }, + { + "uri":"listCciV2Namespace.html", + "node_id":"listcciv2namespace.xml", + "product_code":"cci", + "code":"5", + "des":"List or watch objects of kind Namespace.For details, see Calling APIs.GET /apis/cci/v2/namespacesStatus code: 200NoneStatus code: 200OKExample 1\"v1\"Example 2[ {\n \"apiVer", + "doc_type":"api", + "kw":"Listing or Watching Objects of kind Namespace,Proprietary APIs,API Reference", + "search_title":"", + "metedata":[ + { + "opensource":"true", + "documenttype":"api", + "prodname":"cci", + "operation_id":"listCciV2Namespace" + } + ], + "title":"Listing or Watching Objects of kind Namespace", + "githuburl":"" + }, + { + "uri":"createCciV2Namespace.html", + "node_id":"createcciv2namespace.xml", + "product_code":"cci", + "code":"6", + "des":"Create a Namespace.A network must be created in a namespace to define the mapping between this network and a Virtual Private Cloud (VPC). For more information, see \"Names", + "doc_type":"api", + "kw":"Creating a Namespace,Proprietary APIs,API Reference", + "search_title":"", + "metedata":[ + { + "opensource":"true", + "documenttype":"api", + "prodname":"cci", + "operation_id":"createCciV2Namespace" + } + ], + "title":"Creating a Namespace", + "githuburl":"" + }, + { + "uri":"deleteCciV2Namespace.html", + "node_id":"deletecciv2namespace.xml", + "product_code":"cci", + "code":"7", + "des":"Delete a Namespace.For details, see Calling APIs.DELETE /apis/cci/v2/namespaces/{name}Status code: 200Status code: 202NoneStatus code: 200OKStatus code: 404", + "doc_type":"api", + "kw":"Deleting a Namespace,Proprietary APIs,API Reference", + "search_title":"", + "metedata":[ + { + "opensource":"true", + "documenttype":"api", + "prodname":"cci", + "operation_id":"deleteCciV2Namespace" + } + ], + "title":"Deleting a Namespace", + "githuburl":"" + }, + { + "uri":"readCciV2Namespace.html", + "node_id":"readcciv2namespace.xml", + "product_code":"cci", + "code":"8", + "des":"Read the specified Namespace.For details, see Calling APIs.GET /apis/cci/v2/namespaces/{name}Status code: 200NoneStatus code: 200OK", + "doc_type":"api", + "kw":"Reading the Specified Namespace,Proprietary APIs,API Reference", + "search_title":"", + "metedata":[ + { + "opensource":"true", + "documenttype":"api", + "prodname":"cci", + "operation_id":"readCciV2Namespace" + } + ], + "title":"Reading the Specified Namespace", + "githuburl":"" + }, + { + "uri":"listCciV2NamespacedConfigMap.html", + "node_id":"listcciv2namespacedconfigmap.xml", + "product_code":"cci", + "code":"9", + "des":"List or watch objects of kind ConfigMap.For details, see Calling APIs.GET /apis/cci/v2/namespaces/{namespace}/configmapsStatus code: 200NoneStatus code: 200OK", + "doc_type":"api", + "kw":"Listing or Watching Objects of kind ConfigMap,Proprietary APIs,API Reference", + "search_title":"", + "metedata":[ + { + "opensource":"true", + "documenttype":"api", + "prodname":"cci", + "operation_id":"listCciV2NamespacedConfigMap" + } + ], + "title":"Listing or Watching Objects of kind ConfigMap", + "githuburl":"" + }, + { + "uri":"createCciV2NamespacedConfigMap.html", + "node_id":"createcciv2namespacedconfigmap.xml", + "product_code":"cci", + "code":"10", + "des":"Create a ConfigMap.For details, see Calling APIs.POST /apis/cci/v2/namespaces/{namespace}/configmapsStatus code: 200Status code: 201Status code: 202Status code: 201Create", + "doc_type":"api", + "kw":"Creating a ConfigMap,Proprietary APIs,API Reference", + "search_title":"", + "metedata":[ + { + "opensource":"true", + "documenttype":"api", + "prodname":"cci", + "operation_id":"createCciV2NamespacedConfigMap" + } + ], + "title":"Creating a ConfigMap", + "githuburl":"" + }, + { + "uri":"deleteCciV2NamespacedConfigMap.html", + "node_id":"deletecciv2namespacedconfigmap.xml", + "product_code":"cci", + "code":"11", + "des":"Delete a ConfigMap.For details, see Calling APIs.DELETE /apis/cci/v2/namespaces/{namespace}/configmaps/{name}Status code: 200Status code: 202NoneStatus code: 200OK", + "doc_type":"api", + "kw":"Deleting a ConfigMap,Proprietary APIs,API Reference", + "search_title":"", + "metedata":[ + { + "opensource":"true", + "documenttype":"api", + "prodname":"cci", + "operation_id":"deleteCciV2NamespacedConfigMap" + } + ], + "title":"Deleting a ConfigMap", + "githuburl":"" + }, + { + "uri":"readCciV2NamespacedConfigMap.html", + "node_id":"readcciv2namespacedconfigmap.xml", + "product_code":"cci", + "code":"12", + "des":"Read the specified ConfigMap.For details, see Calling APIs.GET /apis/cci/v2/namespaces/{namespace}/configmaps/{name}Status code: 200NoneStatus code: 200OK", + "doc_type":"api", + "kw":"Reading the Specified ConfigMap,Proprietary APIs,API Reference", + "search_title":"", + "metedata":[ + { + "opensource":"true", + "documenttype":"api", + "prodname":"cci", + "operation_id":"readCciV2NamespacedConfigMap" + } + ], + "title":"Reading the Specified ConfigMap", + "githuburl":"" + }, + { + "uri":"replaceCciV2NamespacedConfigMap.html", + "node_id":"replacecciv2namespacedconfigmap.xml", + "product_code":"cci", + "code":"13", + "des":"Replace the specified ConfigMap.The following fields can be updated:metadata.labelsmetadata.annotationsdataFor details, see Calling APIs.PUT /apis/cci/v2/namespaces/{name", + "doc_type":"api", + "kw":"Replacing the Specified ConfigMap,Proprietary APIs,API Reference", + "search_title":"", + "metedata":[ + { + "opensource":"true", + "documenttype":"api", + "prodname":"cci", + "operation_id":"replaceCciV2NamespacedConfigMap" + } + ], + "title":"Replacing the Specified ConfigMap", + "githuburl":"" + }, + { + "uri":"listCciV2NamespacedPod.html", + "node_id":"listcciv2namespacedpod.xml", + "product_code":"cci", + "code":"14", + "des":"List or watch objects of kind Pod.For details, see Calling APIs.GET /apis/cci/v2/namespaces/{namespace}/podsStatus code: 200NoneStatus code: 200OK", + "doc_type":"api", + "kw":"Listing or Watching Objects of kind Pod,Proprietary APIs,API Reference", + "search_title":"", + "metedata":[ + { + "opensource":"true", + "documenttype":"api", + "prodname":"cci", + "operation_id":"listCciV2NamespacedPod" + } + ], + "title":"Listing or Watching Objects of kind Pod", + "githuburl":"" + }, + { + "uri":"createCciV2NamespacedPod.html", + "node_id":"createcciv2namespacedpod.xml", + "product_code":"cci", + "code":"15", + "des":"Create a Pod.For details, see Calling APIs.POST /apis/cci/v2/namespaces/{namespace}/podsStatus code: 200Status code: 201Status code: 202Status code: 201Created", + "doc_type":"api", + "kw":"Creating a Pod,Proprietary APIs,API Reference", + "search_title":"", + "metedata":[ + { + "opensource":"true", + "documenttype":"api", + "prodname":"cci", + "operation_id":"createCciV2NamespacedPod" + } + ], + "title":"Creating a Pod", + "githuburl":"" + }, + { + "uri":"deleteCciV2NamespacedPod.html", + "node_id":"deletecciv2namespacedpod.xml", + "product_code":"cci", + "code":"16", + "des":"Delete a Pod.For details, see Calling APIs.DELETE /apis/cci/v2/namespaces/{namespace}/pods/{name}Status code: 200Status code: 202NoneStatus code: 200OK", + "doc_type":"api", + "kw":"Deleting a Pod,Proprietary APIs,API Reference", + "search_title":"", + "metedata":[ + { + "opensource":"true", + "documenttype":"api", + "prodname":"cci", + "operation_id":"deleteCciV2NamespacedPod" + } + ], + "title":"Deleting a Pod", + "githuburl":"" + }, + { + "uri":"readCciV2NamespacedPod.html", + "node_id":"readcciv2namespacedpod.xml", + "product_code":"cci", + "code":"17", + "des":"Read the specified Pod.For details, see Calling APIs.GET /apis/cci/v2/namespaces/{namespace}/pods/{name}Status code: 200NoneStatus code: 200OK", + "doc_type":"api", + "kw":"Reading the Specified Pod,Proprietary APIs,API Reference", + "search_title":"", + "metedata":[ + { + "opensource":"true", + "documenttype":"api", + "prodname":"cci", + "operation_id":"readCciV2NamespacedPod" + } + ], + "title":"Reading the Specified Pod", + "githuburl":"" + }, + { + "uri":"patchCciV2NamespacedPod.html", + "node_id":"patchcciv2namespacedpod.xml", + "product_code":"cci", + "code":"18", + "des":"Partially update the specified Pod.The following fields can be updated:metadata.generateNamemetadata.labelsmetadata.annotationsspec.initContainers[*].imagespec.containers", + "doc_type":"api", + "kw":"Partially Updating the Specified Pod,Proprietary APIs,API Reference", + "search_title":"", + "metedata":[ + { + "opensource":"true", + "documenttype":"api", + "prodname":"cci", + "operation_id":"patchCciV2NamespacedPod" + } + ], + "title":"Partially Updating the Specified Pod", + "githuburl":"" + }, + { + "uri":"replaceCciV2NamespacedPod.html", + "node_id":"replacecciv2namespacedpod.xml", + "product_code":"cci", + "code":"19", + "des":"Replace the specified Pod.The following fields can be updated:metadata.labelsmetadata.annotationsspec.initContainers[*].imagespec.containers[*].imagespec.activeDeadlineSe", + "doc_type":"api", + "kw":"Replacing the Specified Pod,Proprietary APIs,API Reference", + "search_title":"", + "metedata":[ + { + "opensource":"true", + "documenttype":"api", + "prodname":"cci", + "operation_id":"replaceCciV2NamespacedPod" + } + ], + "title":"Replacing the Specified Pod", + "githuburl":"" + }, + { + "uri":"connectCciV2GetNamespacedPodExec.html", + "node_id":"connectcciv2getnamespacedpodexec.xml", + "product_code":"cci", + "code":"20", + "des":"Connect GET requests to exec of Pod.For details, see Calling APIs.GET /apis/cci/v2/namespaces/{namespace}/pods/{name}/execStatus code: 200NoneNone", + "doc_type":"api", + "kw":"Connecting GET Requests to exec of Pod,Proprietary APIs,API Reference", + "search_title":"", + "metedata":[ + { + "opensource":"true", + "documenttype":"api", + "prodname":"cci", + "operation_id":"connectCciV2GetNamespacedPodExec" + } + ], + "title":"Connecting GET Requests to exec of Pod", + "githuburl":"" + }, + { + "uri":"connectCciV2PostNamespacedPodExec.html", + "node_id":"connectcciv2postnamespacedpodexec.xml", + "product_code":"cci", + "code":"21", + "des":"Connect POST requests to exec of Pod.For details, see Calling APIs.POST /apis/cci/v2/namespaces/{namespace}/pods/{name}/execStatus code: 200NoneNone", + "doc_type":"api", + "kw":"Connecting POST Requests to exec of Pod,Proprietary APIs,API Reference", + "search_title":"", + "metedata":[ + { + "opensource":"true", + "documenttype":"api", + "prodname":"cci", + "operation_id":"connectCciV2PostNamespacedPodExec" + } + ], + "title":"Connecting POST Requests to exec of Pod", + "githuburl":"" + }, + { + "uri":"readCciV2NamespacedPodLog.html", + "node_id":"readcciv2namespacedpodlog.xml", + "product_code":"cci", + "code":"22", + "des":"Read logs of the specified Pod.For details, see Calling APIs.GET /apis/cci/v2/namespaces/{namespace}/pods/{name}/logStatus code: 200NoneNone", + "doc_type":"api", + "kw":"Reading Logs of the Specified Pod,Proprietary APIs,API Reference", + "search_title":"", + "metedata":[ + { + "opensource":"true", + "documenttype":"api", + "prodname":"cci", + "operation_id":"readCciV2NamespacedPodLog" + } + ], + "title":"Reading Logs of the Specified Pod", + "githuburl":"" + }, + { + "uri":"listCciV2NamespacedSecret.html", + "node_id":"listcciv2namespacedsecret.xml", + "product_code":"cci", + "code":"23", + "des":"List or watch objects of kind Secret.For details, see Calling APIs.GET /apis/cci/v2/namespaces/{namespace}/secretsStatus code: 200NoneStatus code: 200OK", + "doc_type":"api", + "kw":"Listing or Watching Objects of kind Secret,Proprietary APIs,API Reference", + "search_title":"", + "metedata":[ + { + "opensource":"true", + "documenttype":"api", + "prodname":"cci", + "operation_id":"listCciV2NamespacedSecret" + } + ], + "title":"Listing or Watching Objects of kind Secret", + "githuburl":"" + }, + { + "uri":"createCciV2NamespacedSecret.html", + "node_id":"createcciv2namespacedsecret.xml", + "product_code":"cci", + "code":"24", + "des":"Create a Secret.For details, see Calling APIs.POST /apis/cci/v2/namespaces/{namespace}/secretsStatus code: 200Status code: 201Status code: 202Status code: 201Created", + "doc_type":"api", + "kw":"Creating a Secret,Proprietary APIs,API Reference", + "search_title":"", + "metedata":[ + { + "opensource":"true", + "documenttype":"api", + "prodname":"cci", + "operation_id":"createCciV2NamespacedSecret" + } + ], + "title":"Creating a Secret", + "githuburl":"" + }, + { + "uri":"deleteCciV2NamespacedSecret.html", + "node_id":"deletecciv2namespacedsecret.xml", + "product_code":"cci", + "code":"25", + "des":"Delete a Secret.For details, see Calling APIs.DELETE /apis/cci/v2/namespaces/{namespace}/secrets/{name}Status code: 200Status code: 202NoneStatus code: 200OK", + "doc_type":"api", + "kw":"Deleting a Secret,Proprietary APIs,API Reference", + "search_title":"", + "metedata":[ + { + "opensource":"true", + "documenttype":"api", + "prodname":"cci", + "operation_id":"deleteCciV2NamespacedSecret" + } + ], + "title":"Deleting a Secret", + "githuburl":"" + }, + { + "uri":"readCciV2NamespacedSecret.html", + "node_id":"readcciv2namespacedsecret.xml", + "product_code":"cci", + "code":"26", + "des":"Read the specified Secret.For details, see Calling APIs.GET /apis/cci/v2/namespaces/{namespace}/secrets/{name}Status code: 200NoneStatus code: 200OK", + "doc_type":"api", + "kw":"Reading the Specified Secret,Proprietary APIs,API Reference", + "search_title":"", + "metedata":[ + { + "opensource":"true", + "documenttype":"api", + "prodname":"cci", + "operation_id":"readCciV2NamespacedSecret" + } + ], + "title":"Reading the Specified Secret", + "githuburl":"" + }, + { + "uri":"replaceCciV2NamespacedSecret.html", + "node_id":"replacecciv2namespacedsecret.xml", + "product_code":"cci", + "code":"27", + "des":"Replace the specified Secret.The following fields can be updated:metadata.labelsmetadata.annotationsdataIf type is set to Opaque, the key and value of data can be updated", + "doc_type":"api", + "kw":"Replacing the Specified Secret,Proprietary APIs,API Reference", + "search_title":"", + "metedata":[ + { + "opensource":"true", + "documenttype":"api", + "prodname":"cci", + "operation_id":"replaceCciV2NamespacedSecret" + } + ], + "title":"Replacing the Specified Secret", + "githuburl":"" + }, + { + "uri":"listYangtseV2NamespacedNetwork.html", + "node_id":"listyangtsev2namespacednetwork.xml", + "product_code":"cci", + "code":"28", + "des":"List or watch objects of kind Network.For details, see Calling APIs.GET /apis/yangtse/v2/namespaces/{namespace}/networksStatus code: 200NoneStatus code: 200OK", + "doc_type":"api", + "kw":"Listing or Watching Objects of kind Network,Proprietary APIs,API Reference", + "search_title":"", + "metedata":[ + { + "opensource":"true", + "documenttype":"api", + "prodname":"cci", + "operation_id":"listYangtseV2NamespacedNetwork" + } + ], + "title":"Listing or Watching Objects of kind Network", + "githuburl":"" + }, + { + "uri":"createYangtseV2NamespacedNetwork.html", + "node_id":"createyangtsev2namespacednetwork.xml", + "product_code":"cci", + "code":"29", + "des":"Create a Network.For details, see Calling APIs.POST /apis/yangtse/v2/namespaces/{namespace}/networksStatus code: 200Status code: 201Status code: 202Status code: 201Create", + "doc_type":"api", + "kw":"Creating a Network,Proprietary APIs,API Reference", + "search_title":"", + "metedata":[ + { + "opensource":"true", + "documenttype":"api", + "prodname":"cci", + "operation_id":"createYangtseV2NamespacedNetwork" + } + ], + "title":"Creating a Network", + "githuburl":"" + }, + { + "uri":"deleteYangtseV2NamespacedNetwork.html", + "node_id":"deleteyangtsev2namespacednetwork.xml", + "product_code":"cci", + "code":"30", + "des":"Delete a Network.For details, see Calling APIs.DELETE /apis/yangtse/v2/namespaces/{namespace}/networks/{name}Status code: 200Status code: 202NoneStatus code: 200OK", + "doc_type":"api", + "kw":"Deleting a Network,Proprietary APIs,API Reference", + "search_title":"", + "metedata":[ + { + "opensource":"true", + "documenttype":"api", + "prodname":"cci", + "operation_id":"deleteYangtseV2NamespacedNetwork" + } + ], + "title":"Deleting a Network", + "githuburl":"" + }, + { + "uri":"readYangtseV2NamespacedNetwork.html", + "node_id":"readyangtsev2namespacednetwork.xml", + "product_code":"cci", + "code":"31", + "des":"Read the specified Network.For details, see Calling APIs.GET /apis/yangtse/v2/namespaces/{namespace}/networks/{name}Status code: 200NoneStatus code: 200OK", + "doc_type":"api", + "kw":"Reading the Specified Network,Proprietary APIs,API Reference", + "search_title":"", + "metedata":[ + { + "opensource":"true", + "documenttype":"api", + "prodname":"cci", + "operation_id":"readYangtseV2NamespacedNetwork" + } + ], + "title":"Reading the Specified Network", + "githuburl":"" + }, + { + "uri":"replaceYangtseV2NamespacedNetwork.html", + "node_id":"replaceyangtsev2namespacednetwork.xml", + "product_code":"cci", + "code":"32", + "des":"Replace the specified Network.For details, see Calling APIs.PUT /apis/yangtse/v2/namespaces/{namespace}/networks/{name}Status code: 200Status code: 201Status code: 200OK", + "doc_type":"api", + "kw":"Replacing the Specified Network,Proprietary APIs,API Reference", + "search_title":"", + "metedata":[ + { + "opensource":"true", + "documenttype":"api", + "prodname":"cci", + "operation_id":"replaceYangtseV2NamespacedNetwork" + } + ], + "title":"Replacing the Specified Network", + "githuburl":"" + }, + { + "uri":"cci_02_0082.html", + "node_id":"cci_02_0082.xml", + "product_code":"cci", + "code":"33", + "des":"HUAWEI CLOUD Help Center presents technical documents to help you quickly get started with HUAWEI CLOUD services. The technical documents include Service Overview, Price Details, Purchase Guide, User Guide, API Reference, Best Practices, FAQs, and Videos.", + "doc_type":"api", + "kw":"Permissions Policies and Supported Actions", + "search_title":"", + "metedata":[ + { + "documenttype":"api", + "prodname":"cci", + "opensource":"true" + } + ], + "title":"Permissions Policies and Supported Actions", + "githuburl":"" + }, + { + "uri":"cci_02_0081.html", + "node_id":"cci_02_0081.xml", + "product_code":"cci", + "code":"34", + "des":"This topic describes fine-grained permissions management for your CCI. If your account does not need individual IAM users, you may skip this topic.You need to add a user ", + "doc_type":"api", + "kw":"Introduction,Permissions Policies and Supported Actions,API Reference", + "search_title":"", + "metedata":[ + { + "documenttype":"api", + "prodname":"cci", + "opensource":"true" + } + ], + "title":"Introduction", + "githuburl":"" + }, + { + "uri":"cci_02_0083.html", + "node_id":"cci_02_0083.xml", + "product_code":"cci", + "code":"35", + "des":"HUAWEI CLOUD Help Center presents technical documents to help you quickly get started with HUAWEI CLOUD services. The technical documents include Service Overview, Price Details, Purchase Guide, User Guide, API Reference, Best Practices, FAQs, and Videos.", + "doc_type":"api", + "kw":"Category of CCI Actions,Permissions Policies and Supported Actions,API Reference", + "search_title":"", + "metedata":[ + { + "documenttype":"api", + "prodname":"cci", + "opensource":"true" + } + ], + "title":"Category of CCI Actions", + "githuburl":"" + }, + { + "uri":"cci_02_0067.html", + "node_id":"cci_02_0067.xml", + "product_code":"cci", + "code":"36", + "des":"HUAWEI CLOUD Help Center presents technical documents to help you quickly get started with HUAWEI CLOUD services. The technical documents include Service Overview, Price Details, Purchase Guide, User Guide, API Reference, Best Practices, FAQs, and Videos.", + "doc_type":"api", + "kw":"Appendix", + "search_title":"", + "metedata":[ + { + "documenttype":"api", + "prodname":"cci", + "opensource":"true" + } + ], + "title":"Appendix", + "githuburl":"" + }, + { + "uri":"pro_ys.html", + "node_id":"pro_ys.xml", + "product_code":"cci", + "code":"37", + "des":"CCI is available in regions listed in Table 1.", + "doc_type":"api", + "kw":"Notes and Constraints,Appendix,API Reference", + "search_title":"", + "metedata":[ + { + "documenttype":"api", + "prodname":"cci", + "opensource":"true" + } + ], + "title":"Notes and Constraints", + "githuburl":"" + }, + { + "uri":"devg_na.html", + "node_id":"devg_na.xml", + "product_code":"cci", + "code":"38", + "des":"A namespace provides a method of allocating resources among multiple users. It applies to scenarios where multiple teams or projects exist.A network is a Kubernetes resou", + "doc_type":"api", + "kw":"Namespace and Network,Appendix,API Reference", + "search_title":"", + "metedata":[ + { + "documenttype":"api", + "prodname":"cci", + "opensource":"true" + } + ], + "title":"Namespace and Network", + "githuburl":"" + }, + { + "uri":"cci_02_0068.html", + "node_id":"cci_02_0068.xml", + "product_code":"cci", + "code":"39", + "des":"HUAWEI CLOUD Help Center presents technical documents to help you quickly get started with HUAWEI CLOUD services. The technical documents include Service Overview, Price Details, Purchase Guide, User Guide, API Reference, Best Practices, FAQs, and Videos.", + "doc_type":"api", + "kw":"Status Codes,Appendix,API Reference", + "search_title":"", + "metedata":[ + { + "documenttype":"api", + "prodname":"cci", + "opensource":"true" + } + ], + "title":"Status Codes", + "githuburl":"" + }, + { + "uri":"ErrorCode.html", + "node_id":"errorcode.xml", + "product_code":"cci", + "code":"40", + "des":"If an error occurs in API calling, no result is returned. Identify the error cause based on the error codes of each API. If an error occurs in API calling, HTTP status co", + "doc_type":"api", + "kw":"Error Codes,Appendix,API Reference", + "search_title":"", + "metedata":[ + { + "documenttype":"api", + "prodname":"cci", + "opensource":"true" + } + ], + "title":"Error Codes", + "githuburl":"" + }, + { + "uri":"cci_02_1001.html", + "node_id":"cci_02_1001.xml", + "product_code":"cci", + "code":"41", + "des":"A project ID is required for some URLs when an API is called. Therefore, you need to obtain a project ID in advance. Two methods are available:Obtain the Project ID by Ca", + "doc_type":"api", + "kw":"Obtaining a Project ID,Appendix,API Reference", + "search_title":"", + "metedata":[ + { + "documenttype":"api", + "prodname":"cci", + "opensource":"true" + } + ], + "title":"Obtaining a Project ID", + "githuburl":"" + }, + { + "uri":"cci_02_1002.html", + "node_id":"cci_02_1002.xml", + "product_code":"cci", + "code":"42", + "des":"An account ID (domain ID) is required for some URLs when an API is called. To obtain an account ID, perform the following operations:Log in to the management console.Clic", + "doc_type":"api", + "kw":"Obtaining an Account ID,Appendix,API Reference", + "search_title":"", + "metedata":[ + { + "documenttype":"api", + "prodname":"cci", + "opensource":"true" + } + ], + "title":"Obtaining an Account ID", + "githuburl":"" + }, + { + "uri":"cci_02_1003.html", + "node_id":"cci_02_1003.xml", + "product_code":"cci", + "code":"43", + "des":"Cloud Container Instance (CCI) supports both images in the container registry and those uploaded to SoftWare Repository for Container (SWR). Where,SWR has synchronized so", + "doc_type":"api", + "kw":"Obtaining a Container Image Address,Appendix,API Reference", + "search_title":"", + "metedata":[ + { + "documenttype":"api", + "prodname":"cci", + "opensource":"true" + } + ], + "title":"Obtaining a Container Image Address", + "githuburl":"" + }, + { + "uri":"en-us_topic_0000001991313061.html", + "node_id":"en-us_topic_0000001991313061.xml", + "product_code":"cci", + "code":"44", + "des":"HUAWEI CLOUD Help Center presents technical documents to help you quickly get started with HUAWEI CLOUD services. The technical documents include Service Overview, Price Details, Purchase Guide, User Guide, API Reference, Best Practices, FAQs, and Videos.", + "doc_type":"api", + "kw":"Change History,API Reference", + "search_title":"", + "metedata":[ + { + "documenttype":"api", + "prodname":"cci", + "opensource":"true" + } + ], + "title":"Change History", + "githuburl":"" + } +] \ No newline at end of file diff --git a/docs/cci/api-ref/CLASS.TXT.json b/docs/cci/api-ref/CLASS.TXT.json new file mode 100644 index 00000000..77bd9fb9 --- /dev/null +++ b/docs/cci/api-ref/CLASS.TXT.json @@ -0,0 +1,398 @@ +[ + { + "desc":"HUAWEI CLOUD Help Center presents technical documents to help you quickly get started with HUAWEI CLOUD services. The technical documents include Service Overview, Price Details, Purchase Guide, User Guide, API Reference, Best Practices, FAQs, and Videos.", + "product_code":"cci", + "title":"Calling APIs", + "uri":"cci_02_0009.html", + "doc_type":"api", + "p_code":"", + "code":"1" + }, + { + "desc":"Requests for calling an API can be authenticated using either of the following methods:AK/SK authentication: Requests are encrypted using AK/SK pairs. AK/SK authenticatio", + "product_code":"cci", + "title":"Authentication", + "uri":"cci_02_0003.html", + "doc_type":"api", + "p_code":"1", + "code":"2" + }, + { + "desc":"You can call APIs to create a pod. An Nginx image is used as an example to show how you can create a pod.The Nginx image is from the open-source image center, and the con", + "product_code":"cci", + "title":"Getting Started", + "uri":"cci_02_0011.html", + "doc_type":"api", + "p_code":"", + "code":"3" + }, + { + "desc":"HUAWEI CLOUD Help Center presents technical documents to help you quickly get started with HUAWEI CLOUD services. The technical documents include Service Overview, Price Details, Purchase Guide, User Guide, API Reference, Best Practices, FAQs, and Videos.", + "product_code":"cci", + "title":"Proprietary APIs", + "uri":"cci_02_2000.html", + "doc_type":"api", + "p_code":"", + "code":"4" + }, + { + "desc":"List or watch objects of kind Namespace.For details, see Calling APIs.GET /apis/cci/v2/namespacesStatus code: 200NoneStatus code: 200OKExample 1\"v1\"Example 2[ {\n \"apiVer", + "product_code":"cci", + "title":"Listing or Watching Objects of kind Namespace", + "uri":"listCciV2Namespace.html", + "doc_type":"api", + "p_code":"4", + "code":"5" + }, + { + "desc":"Create a Namespace.A network must be created in a namespace to define the mapping between this network and a Virtual Private Cloud (VPC). For more information, see \"Names", + "product_code":"cci", + "title":"Creating a Namespace", + "uri":"createCciV2Namespace.html", + "doc_type":"api", + "p_code":"4", + "code":"6" + }, + { + "desc":"Delete a Namespace.For details, see Calling APIs.DELETE /apis/cci/v2/namespaces/{name}Status code: 200Status code: 202NoneStatus code: 200OKStatus code: 404", + "product_code":"cci", + "title":"Deleting a Namespace", + "uri":"deleteCciV2Namespace.html", + "doc_type":"api", + "p_code":"4", + "code":"7" + }, + { + "desc":"Read the specified Namespace.For details, see Calling APIs.GET /apis/cci/v2/namespaces/{name}Status code: 200NoneStatus code: 200OK", + "product_code":"cci", + "title":"Reading the Specified Namespace", + "uri":"readCciV2Namespace.html", + "doc_type":"api", + "p_code":"4", + "code":"8" + }, + { + "desc":"List or watch objects of kind ConfigMap.For details, see Calling APIs.GET /apis/cci/v2/namespaces/{namespace}/configmapsStatus code: 200NoneStatus code: 200OK", + "product_code":"cci", + "title":"Listing or Watching Objects of kind ConfigMap", + "uri":"listCciV2NamespacedConfigMap.html", + "doc_type":"api", + "p_code":"4", + "code":"9" + }, + { + "desc":"Create a ConfigMap.For details, see Calling APIs.POST /apis/cci/v2/namespaces/{namespace}/configmapsStatus code: 200Status code: 201Status code: 202Status code: 201Create", + "product_code":"cci", + "title":"Creating a ConfigMap", + "uri":"createCciV2NamespacedConfigMap.html", + "doc_type":"api", + "p_code":"4", + "code":"10" + }, + { + "desc":"Delete a ConfigMap.For details, see Calling APIs.DELETE /apis/cci/v2/namespaces/{namespace}/configmaps/{name}Status code: 200Status code: 202NoneStatus code: 200OK", + "product_code":"cci", + "title":"Deleting a ConfigMap", + "uri":"deleteCciV2NamespacedConfigMap.html", + "doc_type":"api", + "p_code":"4", + "code":"11" + }, + { + "desc":"Read the specified ConfigMap.For details, see Calling APIs.GET /apis/cci/v2/namespaces/{namespace}/configmaps/{name}Status code: 200NoneStatus code: 200OK", + "product_code":"cci", + "title":"Reading the Specified ConfigMap", + "uri":"readCciV2NamespacedConfigMap.html", + "doc_type":"api", + "p_code":"4", + "code":"12" + }, + { + "desc":"Replace the specified ConfigMap.The following fields can be updated:metadata.labelsmetadata.annotationsdataFor details, see Calling APIs.PUT /apis/cci/v2/namespaces/{name", + "product_code":"cci", + "title":"Replacing the Specified ConfigMap", + "uri":"replaceCciV2NamespacedConfigMap.html", + "doc_type":"api", + "p_code":"4", + "code":"13" + }, + { + "desc":"List or watch objects of kind Pod.For details, see Calling APIs.GET /apis/cci/v2/namespaces/{namespace}/podsStatus code: 200NoneStatus code: 200OK", + "product_code":"cci", + "title":"Listing or Watching Objects of kind Pod", + "uri":"listCciV2NamespacedPod.html", + "doc_type":"api", + "p_code":"4", + "code":"14" + }, + { + "desc":"Create a Pod.For details, see Calling APIs.POST /apis/cci/v2/namespaces/{namespace}/podsStatus code: 200Status code: 201Status code: 202Status code: 201Created", + "product_code":"cci", + "title":"Creating a Pod", + "uri":"createCciV2NamespacedPod.html", + "doc_type":"api", + "p_code":"4", + "code":"15" + }, + { + "desc":"Delete a Pod.For details, see Calling APIs.DELETE /apis/cci/v2/namespaces/{namespace}/pods/{name}Status code: 200Status code: 202NoneStatus code: 200OK", + "product_code":"cci", + "title":"Deleting a Pod", + "uri":"deleteCciV2NamespacedPod.html", + "doc_type":"api", + "p_code":"4", + "code":"16" + }, + { + "desc":"Read the specified Pod.For details, see Calling APIs.GET /apis/cci/v2/namespaces/{namespace}/pods/{name}Status code: 200NoneStatus code: 200OK", + "product_code":"cci", + "title":"Reading the Specified Pod", + "uri":"readCciV2NamespacedPod.html", + "doc_type":"api", + "p_code":"4", + "code":"17" + }, + { + "desc":"Partially update the specified Pod.The following fields can be updated:metadata.generateNamemetadata.labelsmetadata.annotationsspec.initContainers[*].imagespec.containers", + "product_code":"cci", + "title":"Partially Updating the Specified Pod", + "uri":"patchCciV2NamespacedPod.html", + "doc_type":"api", + "p_code":"4", + "code":"18" + }, + { + "desc":"Replace the specified Pod.The following fields can be updated:metadata.labelsmetadata.annotationsspec.initContainers[*].imagespec.containers[*].imagespec.activeDeadlineSe", + "product_code":"cci", + "title":"Replacing the Specified Pod", + "uri":"replaceCciV2NamespacedPod.html", + "doc_type":"api", + "p_code":"4", + "code":"19" + }, + { + "desc":"Connect GET requests to exec of Pod.For details, see Calling APIs.GET /apis/cci/v2/namespaces/{namespace}/pods/{name}/execStatus code: 200NoneNone", + "product_code":"cci", + "title":"Connecting GET Requests to exec of Pod", + "uri":"connectCciV2GetNamespacedPodExec.html", + "doc_type":"api", + "p_code":"4", + "code":"20" + }, + { + "desc":"Connect POST requests to exec of Pod.For details, see Calling APIs.POST /apis/cci/v2/namespaces/{namespace}/pods/{name}/execStatus code: 200NoneNone", + "product_code":"cci", + "title":"Connecting POST Requests to exec of Pod", + "uri":"connectCciV2PostNamespacedPodExec.html", + "doc_type":"api", + "p_code":"4", + "code":"21" + }, + { + "desc":"Read logs of the specified Pod.For details, see Calling APIs.GET /apis/cci/v2/namespaces/{namespace}/pods/{name}/logStatus code: 200NoneNone", + "product_code":"cci", + "title":"Reading Logs of the Specified Pod", + "uri":"readCciV2NamespacedPodLog.html", + "doc_type":"api", + "p_code":"4", + "code":"22" + }, + { + "desc":"List or watch objects of kind Secret.For details, see Calling APIs.GET /apis/cci/v2/namespaces/{namespace}/secretsStatus code: 200NoneStatus code: 200OK", + "product_code":"cci", + "title":"Listing or Watching Objects of kind Secret", + "uri":"listCciV2NamespacedSecret.html", + "doc_type":"api", + "p_code":"4", + "code":"23" + }, + { + "desc":"Create a Secret.For details, see Calling APIs.POST /apis/cci/v2/namespaces/{namespace}/secretsStatus code: 200Status code: 201Status code: 202Status code: 201Created", + "product_code":"cci", + "title":"Creating a Secret", + "uri":"createCciV2NamespacedSecret.html", + "doc_type":"api", + "p_code":"4", + "code":"24" + }, + { + "desc":"Delete a Secret.For details, see Calling APIs.DELETE /apis/cci/v2/namespaces/{namespace}/secrets/{name}Status code: 200Status code: 202NoneStatus code: 200OK", + "product_code":"cci", + "title":"Deleting a Secret", + "uri":"deleteCciV2NamespacedSecret.html", + "doc_type":"api", + "p_code":"4", + "code":"25" + }, + { + "desc":"Read the specified Secret.For details, see Calling APIs.GET /apis/cci/v2/namespaces/{namespace}/secrets/{name}Status code: 200NoneStatus code: 200OK", + "product_code":"cci", + "title":"Reading the Specified Secret", + "uri":"readCciV2NamespacedSecret.html", + "doc_type":"api", + "p_code":"4", + "code":"26" + }, + { + "desc":"Replace the specified Secret.The following fields can be updated:metadata.labelsmetadata.annotationsdataIf type is set to Opaque, the key and value of data can be updated", + "product_code":"cci", + "title":"Replacing the Specified Secret", + "uri":"replaceCciV2NamespacedSecret.html", + "doc_type":"api", + "p_code":"4", + "code":"27" + }, + { + "desc":"List or watch objects of kind Network.For details, see Calling APIs.GET /apis/yangtse/v2/namespaces/{namespace}/networksStatus code: 200NoneStatus code: 200OK", + "product_code":"cci", + "title":"Listing or Watching Objects of kind Network", + "uri":"listYangtseV2NamespacedNetwork.html", + "doc_type":"api", + "p_code":"4", + "code":"28" + }, + { + "desc":"Create a Network.For details, see Calling APIs.POST /apis/yangtse/v2/namespaces/{namespace}/networksStatus code: 200Status code: 201Status code: 202Status code: 201Create", + "product_code":"cci", + "title":"Creating a Network", + "uri":"createYangtseV2NamespacedNetwork.html", + "doc_type":"api", + "p_code":"4", + "code":"29" + }, + { + "desc":"Delete a Network.For details, see Calling APIs.DELETE /apis/yangtse/v2/namespaces/{namespace}/networks/{name}Status code: 200Status code: 202NoneStatus code: 200OK", + "product_code":"cci", + "title":"Deleting a Network", + "uri":"deleteYangtseV2NamespacedNetwork.html", + "doc_type":"api", + "p_code":"4", + "code":"30" + }, + { + "desc":"Read the specified Network.For details, see Calling APIs.GET /apis/yangtse/v2/namespaces/{namespace}/networks/{name}Status code: 200NoneStatus code: 200OK", + "product_code":"cci", + "title":"Reading the Specified Network", + "uri":"readYangtseV2NamespacedNetwork.html", + "doc_type":"api", + "p_code":"4", + "code":"31" + }, + { + "desc":"Replace the specified Network.For details, see Calling APIs.PUT /apis/yangtse/v2/namespaces/{namespace}/networks/{name}Status code: 200Status code: 201Status code: 200OK", + "product_code":"cci", + "title":"Replacing the Specified Network", + "uri":"replaceYangtseV2NamespacedNetwork.html", + "doc_type":"api", + "p_code":"4", + "code":"32" + }, + { + "desc":"HUAWEI CLOUD Help Center presents technical documents to help you quickly get started with HUAWEI CLOUD services. The technical documents include Service Overview, Price Details, Purchase Guide, User Guide, API Reference, Best Practices, FAQs, and Videos.", + "product_code":"cci", + "title":"Permissions Policies and Supported Actions", + "uri":"cci_02_0082.html", + "doc_type":"api", + "p_code":"", + "code":"33" + }, + { + "desc":"This topic describes fine-grained permissions management for your CCI. If your account does not need individual IAM users, you may skip this topic.You need to add a user ", + "product_code":"cci", + "title":"Introduction", + "uri":"cci_02_0081.html", + "doc_type":"api", + "p_code":"33", + "code":"34" + }, + { + "desc":"HUAWEI CLOUD Help Center presents technical documents to help you quickly get started with HUAWEI CLOUD services. The technical documents include Service Overview, Price Details, Purchase Guide, User Guide, API Reference, Best Practices, FAQs, and Videos.", + "product_code":"cci", + "title":"Category of CCI Actions", + "uri":"cci_02_0083.html", + "doc_type":"api", + "p_code":"33", + "code":"35" + }, + { + "desc":"HUAWEI CLOUD Help Center presents technical documents to help you quickly get started with HUAWEI CLOUD services. The technical documents include Service Overview, Price Details, Purchase Guide, User Guide, API Reference, Best Practices, FAQs, and Videos.", + "product_code":"cci", + "title":"Appendix", + "uri":"cci_02_0067.html", + "doc_type":"api", + "p_code":"", + "code":"36" + }, + { + "desc":"CCI is available in regions listed in Table 1.", + "product_code":"cci", + "title":"Notes and Constraints", + "uri":"pro_ys.html", + "doc_type":"api", + "p_code":"36", + "code":"37" + }, + { + "desc":"A namespace provides a method of allocating resources among multiple users. It applies to scenarios where multiple teams or projects exist.A network is a Kubernetes resou", + "product_code":"cci", + "title":"Namespace and Network", + "uri":"devg_na.html", + "doc_type":"api", + "p_code":"36", + "code":"38" + }, + { + "desc":"HUAWEI CLOUD Help Center presents technical documents to help you quickly get started with HUAWEI CLOUD services. The technical documents include Service Overview, Price Details, Purchase Guide, User Guide, API Reference, Best Practices, FAQs, and Videos.", + "product_code":"cci", + "title":"Status Codes", + "uri":"cci_02_0068.html", + "doc_type":"api", + "p_code":"36", + "code":"39" + }, + { + "desc":"If an error occurs in API calling, no result is returned. Identify the error cause based on the error codes of each API. If an error occurs in API calling, HTTP status co", + "product_code":"cci", + "title":"Error Codes", + "uri":"ErrorCode.html", + "doc_type":"api", + "p_code":"36", + "code":"40" + }, + { + "desc":"A project ID is required for some URLs when an API is called. Therefore, you need to obtain a project ID in advance. Two methods are available:Obtain the Project ID by Ca", + "product_code":"cci", + "title":"Obtaining a Project ID", + "uri":"cci_02_1001.html", + "doc_type":"api", + "p_code":"36", + "code":"41" + }, + { + "desc":"An account ID (domain ID) is required for some URLs when an API is called. To obtain an account ID, perform the following operations:Log in to the management console.Clic", + "product_code":"cci", + "title":"Obtaining an Account ID", + "uri":"cci_02_1002.html", + "doc_type":"api", + "p_code":"36", + "code":"42" + }, + { + "desc":"Cloud Container Instance (CCI) supports both images in the container registry and those uploaded to SoftWare Repository for Container (SWR). Where,SWR has synchronized so", + "product_code":"cci", + "title":"Obtaining a Container Image Address", + "uri":"cci_02_1003.html", + "doc_type":"api", + "p_code":"36", + "code":"43" + }, + { + "desc":"HUAWEI CLOUD Help Center presents technical documents to help you quickly get started with HUAWEI CLOUD services. The technical documents include Service Overview, Price Details, Purchase Guide, User Guide, API Reference, Best Practices, FAQs, and Videos.", + "product_code":"cci", + "title":"Change History", + "uri":"en-us_topic_0000001991313061.html", + "doc_type":"api", + "p_code":"", + "code":"44" + } +] \ No newline at end of file diff --git a/docs/cci/api-ref/ErrorCode.html b/docs/cci/api-ref/ErrorCode.html new file mode 100644 index 00000000..5c596c22 --- /dev/null +++ b/docs/cci/api-ref/ErrorCode.html @@ -0,0 +1,1274 @@ + + +

Error Codes

+

If an error occurs in API calling, no result is returned. Identify the error cause based on the error codes of each API. If an error occurs in API calling, HTTP status code 4xx or 5xx is returned. The response body contains the specific error code and information. If you are unable to identify the cause of an error, contact the administrator and provide the error code so that we can help you solve the problem as soon as possible.

+

Format of an Error Response Body

If an error occurs during API calling, the system returns an error code and message to you. The following shows the format of an error response body:

+
{
+    "kind": "Status",
+    "apiVersion": "v1",
+    "metadata": {},
+    "status": "Failure",
+    "message": "namespace name is already exist",
+    "reason": "Conflict",
+    "code": 409,
+    "errorCode": "CCI.02.409101"
+}
+

In the preceding information, code is an HTTP status code, errorCode is an error code, and message describes the error.

+
+

Error Code Description

+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +

Status Code

+

Error Codes

+

Error Message

+

Description

+

Measure

+

400

+

CCI.01.400101

+

request body error

+

Request failed. The request body is invalid.

+

Check the request body based on the API document.

+

400

+

CCI.01.400102

+

provide namespace requested

+

Failed to query namespace details. The namespace to be queried is not specified.

+

Specify the namespace to be queried and try again.

+

400

+

CCI.01.400103

+

missing user token in the request header

+

Failed to create the network. The request header does not contain the X-User-Token.

+

Ensure that the request header contains the X-User-Token.

+

400

+

CCI.01.400104

+

no agency quota found from iam, please enlarge your quota

+

The maximum of IAM agencies has reached.

+

Submit a service ticket to increase your quota.

+

400

+

CCI.01.400105

+

must specify namespace name through fieldSelector, example: fieldSelector=metadata.name=namespaceName

+

The namespace name must be specified using fieldSelector, for example, fieldSelector=metadata.name=namespaceName.

+

Specify the namespace name with fieldSelector.

+

400

+

CCI.01.400106

+

volume import:request body error

+

The request body for importing the volume is invalid.

+

Check the request body based on the volume import API document.

+

400

+

CCI.01.400107

+

enterprise id not valid

+

Invalid enterprise project ID.

+

Modify the enterprise project ID and try again.

+

400

+

CCI.01.400201

+

subnet cidr subnet invalid: within the coverage of VPC, and no more subnets overlap

+

Invalid subnet CIDR block. The subnet CIDR block cannot overlap with other subnets in the VPC.

+

Modify the subnet CIDR block to ensure that it does not overlap with other subnets.

+

400

+

CCI.01.400202

+

project id in network request body invalid

+

Failed to create the network. The Annotation field of the request body does not contain project_id.

+

Modify the Annotation field to ensure that it contains project_id and try again.

+

400

+

CCI.01.400301

+

storage type parameter invalid: nfs/obs/bs

+

Invalid storage class. Supported storage classes are NFS, OBS, and BS.

+

Modify the storage type parameter and try again.

+

400

+

CCI.01.400302

+

storage volume id format invalid: the beginning and end of a numeric letter, which may contain an underline in the middle of the numeric letter

+

Invalid storage volume ID format. The ID can contain only letters, digits, and underscores (_) and must start and end with a digit or a letter.

+

Change the storage volume ID and try again.

+

400

+

CCI.01.400303

+

storage volume id len invalid: no bigger than 64

+

Invalid length of the storage volume ID. The ID can contain a maximum of 64 characters.

+

Change the storage volume ID and try again.

+

400

+

CCI.01.400304

+

storage request body invalid

+

Failed to release the storage volume. The delete_volume field is invalid.

+

Modify the delete_volume field and try again.

+

400

+

CCI.01.400305

+

storage volume not available

+

Failed to import the storage volume. The storage volume status is abnormal.

+

Contact technical support to rectify the storage volume fault and try again.

+

400

+

CCI.01.400306

+

storage volume is not found

+

Failed to import the storage volume. The storage volume does not exist.

+

Ensure that the storage volume to be imported exists and try again.

+

400

+

CCI.01.400307

+

nfs storage class type err,use "nfs-rw"

+

Failed to import the storage volume. The specified NFS storage is not supported. Only storage class nfs-rw is supported.

+

Import nfs-rw.

+

400

+

CCI.01.400308

+

storage volume type err, available: sas/ssd/sata

+

Failed to import the storage volume. The storage specifications are not supported. Supported specifications are SAS, SSD, and SATA.

+

Import a storage volume of supported storage format, for example,

+

SAS, SSD, and SATA.

+

400

+

CCI.01.400309

+

storage volume already provisioned

+

Failed to import the storage volume. The current volume has been imported.

+

Check whether the current volume has been imported.

+

400

+

CCI.01.400401

+

invalid billing request body: unsupported billing status

+

Invalid billing request body. The billing status is not supported.

+

Change it to a supported status.

+

400

+

CCI.01.400402

+

invalid billing request body: unsupported billing resource type

+

Invalid billing request body. The billing resource type is not supported.

+

Change it to a supported resource type.

+

400

+

CCI.01.400403

+

invalid billing request user: inner user can not be freeze or unfreeze

+

Invalid billing request body. The operations on internal users are not supported.

+

Change the user to a non-internal user.

+

400

+

CCI.01.400404

+

invalid billing request body: resourceinfos can not match scene

+

Invalid billing request body. The resourceinfos does not match scene.

+

Change it to a supported scene field.

+

500

+

CCI.01.500101

+

find no cluster endpoint for namespace xxx from icluster response header

+

Failed to query the cluster address by namespace.

+

Contact technical support.

+

403

+

CCI.01.403009

+

your account is in arrears, please recharge

+

Request failed: The account is in arrears.

+

Top up the account.

+

403

+

CCI.01.403010

+

your account has been frozen, please contact customer service

+

Request error: The account has been frozen.

+

Submit a service ticket to contact customer service.

+

403

+

CCI.01.403101

+

only gpu beta users can use gpu in cci

+

Request failed. You have not applied for the GPU OBT.

+

Apply for the GPU OBT.

+

403

+

CCI.01.403102

+

only obs beta users can use obs in cci

+

Request failed. You have not applied for the OBS OBT.

+

Apply for the OBS OBT.

+

403

+

CCI.01.403103

+

user's token can not match auth token for resourceUser's

+

Authentication failed. The domain in the token does not match the requested domain.

+

Ensure that the domain in the token matches that in the request.

+

403

+

CCI.01.403104

+

current user has no right

+

Authentication failed. You do not have the permission to perform this operation.

+

Check whether you have the permission.

+

403

+

CCI.01.403105

+

insufficient operation permission, require cci:namespace:create

+

Failed to create the namespace. You do not have the cci:namespace:create permission.

+

Apply for the namespace create permission from the administrator.

+

403

+

CCI.01.403106

+

insufficient operation permission, require cci:namespace:delete

+

Failed to delete the namespace. You do not have the cci:namespace:delete permission.

+

Apply for the namespace delete permission from the administrator.

+

403

+

CCI.01.403107

+

insufficient operation permission, require cci:namespace:update

+

Failed to update the namespace. You do not have the cci:namespace:update permission.

+

Apply for the namespace update permission from the administrator.

+

403

+

CCI.01.403108

+

insufficient operation permission, require cci:namespace:get

+

Failed to obtain the namespace details. You do not have the cci:namespace:get permission.

+

Apply for the namespace get permission from the administrator.

+

403

+

CCI.01.403109

+

insufficient operation permission, require cci:namespace:list

+

Failed to obtain the namespace list. You do not have the cci:namespace:list permission.

+

Apply for the namespace list permission from the administrator.

+

403

+

CCI.01.403110

+

insufficient operation permission, require cci:namespaceSubResource:create

+

Failed to create the resource. You do not have the cci:namespaceSubResource:create permission.

+

Apply for the namespaceSubResource create permission from the administrator.

+

403

+

CCI.01.403111

+

insufficient operation permission, require cci:namespaceSubResource:delete

+

Failed to delete the resource. You do not have the cci:namespaceSubResource:delete permission.

+

Apply for the namespaceSubResource delete permission from the administrator.

+

403

+

CCI.01.403112

+

insufficient operation permission, require cci:namespaceSubResource:update

+

Failed to update the resource. You do not have the cci:namespaceSubResource:update permission.

+

Apply for the namespaceSubResource update permission from the administrator.

+

403

+

CCI.01.403113

+

insufficient operation permission, require cci:namespaceSubResource:get

+

Failed to obtain the resource details. You do not have the cci:namespaceSubResource:get permission.

+

Apply for the namespaceSubResource get permission from the administrator.

+

403

+

CCI.01.403114

+

insufficient operation permission, require cci:namespaceSubResource:list

+

Failed to obtain the resource list. You do not have the cci:namespaceSubResource:list permission.

+

Apply for the namespaceSubResource list permission from the administrator.

+

404

+

CCI.01.404101

+

no agency found for user

+

Request failed. The queried agency does not exist.

+

Log in to the CCI console, select the corresponding region, and click Agree to authorize CCI to create an agency.

+

401

+

CCI.01.401102

+

user has no agency to cci. Please apply an agency to cci

+

Request failed. You have not authorized the CCI service.

+

Authorize the CCI service first.

+

403

+

CCI.04.403112

+

Chart must have same name and version with original chart

+

Failed to update the chart. The chart version and name must be the same as those in the original chart.

+

Ensure that the chart version and name are the same as those in the original chart.

+

403

+

CCI.04.403124

+

The official chart is forbidden to be downloaded

+

Failed to download the chart. Official charts cannot be downloaded.

+

Contact technical support.

+

403

+

CCI.04.403125

+

Chart is used, can't deleted

+

Failed to delete the chart. The chart is in use.

+

Contact technical support.

+

403

+

CCI.04.403126

+

The chart is deprecated, please select a higher version

+

The selected chart version has expired.

+

Select a later version.

+

403

+

CCI.04.403129

+

Only addon charts have readme.md now, the target chart is not an addon chart

+

Operation failed. The chart associated with the readme.md file is not an add-on chart.

+

Associate it with an add-on chart.

+

403

+

CCI.04.403130

+

Not allowed to update chart belong to other tenant

+

Request failed. You cannot operate the charts of other users.

+

Do not operate the charts of other users.

+

403

+

CCI.04.403131

+

Update release is forbidden:The status of release is not DEPLOYED or FAILED

+

Update failed. Only releases in the Installed or Failed status can be updated.

+

Contact technical support.

+

400

+

CCI.04.400104

+

Validate chart version failed

+

Request failed because the chart version is invalid. The version can contain a maximum of 64 characters and must comply with the SemVer specification, for example, 1.0.0, 1.0.0-alpha, and 1.0.0-alpha+001.

+

Specify a chart version that meets the version format requirements.

+

400

+

CCI.04.400105

+

the ID should not be empty

+

The chart ID cannot be left blank.

+

Enter a correct chart ID.

+

400

+

CCI.04.400111

+

Only addon allowed

+

Request failed. This request supports only add-on charts.

+

Specify an add-on chart.

+

400

+

CCI.04.400112

+

the length of ID is more than 64

+

Request failed. The chart ID cannot contain more than 64 characters.

+

Enter a correct chart ID.

+

400

+

CCI.04.400113

+

Chart ID format is Invalid, must match the regex

+

Request failed. The chart ID format is invalid.

+

Enter a correct chart ID.

+

400

+

CCI.04.400118

+

Validate chart failed

+

Request failed. The chart format is incorrect. The file name extension must be .tgz and the size cannot exceed 2 MB.

+

Specify a chart file with the .tgz extension and less than 2 MB.

+

400

+

CCI.04.400119

+

Chart file not found

+

Request failed. The chart is empty.

+

Specify a chart that is not empty.

+

400

+

CCI.04.400121

+

Chart format is invalid,Chart package name and version must be same with chart name and version

+

The chart package format is invalid. The chart package name and version must be the same as those described in the chart.

+

Specify a chart package whose name and version are the same as those in the chart.

+

400

+

CCI.04.400126

+

No target version selected, select one please

+

Request failed. The add-on version is not specified.

+

Specify an add-on version.

+

400

+

CCI.04.400131

+

Unsupport language

+

Failed to delete the readme file. The language of the request parameters is not supported. Supported language: English

+

Ensure that the language of the readme file is English.

+

400

+

CCI.04.400201

+

Invalid release name

+

Request failed. The release name cannot be left blank.

+

Enter a correct release name.

+

400

+

CCI.04.400202

+

Release name length error

+

Request failed. The release name cannot contain more than 24 characters.

+

Enter a correct release name.

+

400

+

CCI.04.400203

+

Release name not match regex

+

Request failed. The release name format is invalid. The release name can contain only letters, digits, and underscores (_) and must start with a letter and end with a letter or digit.

+

Enter a correct release name.

+

400

+

CCI.04.400214

+

The update action must be either upgrade or rollback

+

Failed to update the release because the requested action is invalid. Supported actions are upgrade and rollback.

+

Change the requested action to upgrade or rollback.

+

400

+

CCI.04.400218

+

Invalid release version

+

Request failed. Invalid release version.

+

Enter a correct version.

+

400

+

CCI.04.400302

+

Failed to Unmarshal

+

Request failed. Invalid request body.

+

Specify a correct request body format.

+

400

+

CCI.04.400304

+

The request body is too large

+

Request failed. The chart package size exceeds 2 MB.

+

Ensure that the size of the chart package is less than 2 MB.

+

400

+

CCI.04.400306

+

Validate chart package failed

+

An error occurred when verifying the chart package.

+

Check whether the format of the YAML files in the package is correct.

+

404

+

CCI.04.404204

+

Release not found

+

Request failed. The release to be queried does not exist.

+

Query the correct application.

+

409

+

CCI.04.409112

+

The chart is already existed in database

+

Failed to upload the chart. The chart name already exists.

+

Change the chart name and try again.

+

409

+

CCI.04.409123

+

The chart name is conflict with public charts

+

Failed to upload the chart. The chart name conflicts with an official chart name.

+

Change the chart name and try again.

+

409

+

CCI.04.409213

+

Release already exists in this cluster

+

Failed to create the release. The release name already exists.

+

Change the release name and try again.

+

400

+

CCI.02.400101

+

ummarshal ERROR: BadNamespaceRequestBody

+

Failed to create the namespace. The request body is incorrect.

+

Rectify the request body error based on the API document.

+

400

+

CCI.02.400102

+

get service account tenant name failed

+

Failed to obtain the tenant name. The tenant is not in the whitelist.

+

Obtain a tenant in the whitelist.

+

400

+

CCI.02.400103

+

Unsupported Content Type

+

The request contains an incorrect text type.

+

Specify a correct text type.

+

400

+

CCI.02.400104

+

ummarshal ERROR: BadQuotaRequestBody

+

Failed to create the quota. The request body is incorrect.

+

Specify a correct request body.

+

400

+

CCI.02.400105

+

update quotas failed

+

Failed to update the quota.

+

Contact technical support.

+

400

+

CCI.02.400106

+

used namespaces exceeds quota, could not create any more

+

Failed to create the namespace. The namespace quota is insufficient.

+

Contact technical support.

+

400

+

CCI.02.400107

+

delete namespace failed, namespace is empty

+

Failed to delete the namespace. The namespace is empty and cannot be deleted.

+

Ensure that the namespace to be deleted is not empty.

+

400

+

CCI.02.400108

+

get flavor info by name failed,flavor name is empty

+

Failed to query flavor information by name. The Name field is empty.

+

Enter a correct value for the Name field.

+

400

+

CCI.02.400109

+

Create namespace failed: NamespaceNameInvalid

+

Failed to create the namespace. The Name field is invalid.

+

Enter a correct value for the Name field.

+

400

+

CCI.02.400110

+

Create namespace failed: NamespaceFlavorInvalid

+

Failed to create the namespace. The Flavor field is invalid.

+

Enter a correct value for the Flavor field.

+

400

+

CCI.02.400111

+

Create namespace failed: NamespaceFlavorMissed

+

Failed to create the namespace. The Flavor field is empty.

+

Enter a correct value for the Flavor field.

+

400

+

CCI.02.400112

+

Create namespace failed: NamespaceDomainIDMissed

+

Failed to create the namespace. The DomainID field is empty.

+

Enter a correct value for the DomainID field.

+

400

+

CCI.02.400113

+

Create namespace failed: NamespaceProjectIDMissed

+

Failed to create the namespace. The ProjectID field is empty.

+

Enter a correct value for the ProjectID field.

+

400

+

CCI.02.400114

+

Get namespace failed: NamespaceProjectIDMissed

+

Failed to query the namespace. The ProjectID field is empty.

+

Enter a correct value for the ProjectID field.

+

400

+

CCI.02.400116

+

Get available cluster info from resourcemanager failed: NoAllocatedCluster

+

Failed to create the namespace. The cluster resource is insufficient. Try again later.

+

Contact technical support.

+

400

+

CCI.02.400117

+

Get namespace failed: PaginationParameterInvalid

+

Failed to query the namespace. The pagination parameter is invalid.

+

Enter a correct pagination parameter.

+

400

+

CCI.02.400118

+

Create namespace failed: EnterpriseProjectIDEmpty

+

Failed to create the namespace. The Enterprise Project ID field is empty.

+

Enter a correct enterprise project ID.

+

400

+

CCI.02.400119

+

Create namespace failed: EnterpriseProjectNotSupported

+

Failed to create the namespace. Enterprise projects are not supported.

+

Contact technical support.

+

404

+

CCI.02.404101

+

flavor not found

+

Failed to query flavor information. The requested flavor does not exist.

+

Query the correct flavor.

+

404

+

CCI.02.404102

+

resourcequota not found

+

Failed to query resource quota information. The requested resource quota does not exist.

+

Query the correct resource quota.

+

404

+

CCI.02.404103

+

quota not found

+

Failed to query quota information. The requested quota does not exist.

+

Query the correct resource quota.

+

409

+

CCI.02.409101

+

namespace name is already exist

+

Failed to create the namespace. The namespace already exists.

+

Change the namespace name and try again.

+

409

+

CCI.02.409102

+

Failed to migrate the namespace

+

Failed to migrate the namespace. The namespace is already on a dedicated node.

+

Select a non-dedicated namespace.

+

500

+

CCI.03.500102

+

Internal error

+

Internal error. An error occurs during interaction with CSB.

+

Contact customer service or try again later.

+

500

+

CCI.03.500101

+

Return error

+

Return error. The return body fails to be converted into the JSON format.

+

Contact customer service or try again later.

+

500

+

CCI.03.500002

+

Database request error

+

Database request error.

+

Contact customer service or try again later.

+

500

+

CCI.03.500001

+

An internal processing error occurs

+

Internal processing error.

+

Contact customer service or try again later.

+

400

+

CCI.03.400105

+

Request error

+

Request error. The package information is not carried.

+

Enter a valid order request.

+

400

+

CCI.03.400106

+

Request failed

+

Request failed. The current user is not eligible to purchase the package.

+

Contact customer service to apply for the purchase permission.

+

400

+

CCI.03.400107

+

Request failed

+

Request failed. The number of packages purchased by the user has reached the upper limit.

+

Purchase again after the current package is used up.

+

400

+

CCI.03.400108

+

Request failed

+

Request failed. The number of packages purchased by the user in the specified period has reached the upper limit.

+

Purchase again in the next period.

+

400

+

CCI.02.400122

+

Failed to migrate the namespace.

+

Failed to migrate the namespace. The namespace status is abnormal.

+

Restore the namespace to the normal status and try again.

+

400

+

CCI.02.400121

+

Failed to migrate the namespace.

+

Failed to migrate the namespace. No dedicated node is available in the namespace.

+

Contact customer service to purchase a dedicated node.

+

400

+

CCI.03.400109

+

Request failed

+

Request failed. The remaining quantity of this package is insufficient.

+

Increase the package quota or reduce the purchase quantity.

+

400

+

CCI.02.400120

+

Failed to migrate the namespace.

+

Failed to migrate the namespace. The on-demand elastic bearer parameter is invalid.

+

Set a valid parameter.

+

400

+

CCI.03.400110

+

Request failed

+

Request failed. The promotion package is invalid.

+

Purchase a valid package.

+

400

+

CCI.03.400111

+

Request failed

+

Request failed. The promotion activity ID is invalid because it is empty or too long.

+

Enter a valid promotion activity ID.

+

400

+

CCI.03.400001

+

The request does not carry a token

+

The request does not carry a token.

+

Enter a valid token in the request body.

+

400

+

CCI.03.400101

+

Request error

+

Request failed. The request body is invalid.

+

Enter a valid request body.

+

400

+

CCI.03.400102

+

Request error

+

Request error. Failed to parse the request body in JSON format.

+

Enter a valid order request.

+

400

+

CCI.03.400103

+

Request failed

+

Request failed. The token does not contain user information.

+

Enter a valid token.

+

400

+

CCI.03.400104

+

Request failed

+

Request failed. The POC package is invalid.

+

Purchase a valid package.

+
+
+
+
+
+
+
Parent topic: Appendix
+
+
+ diff --git a/docs/cci/api-ref/PARAMETERS.txt b/docs/cci/api-ref/PARAMETERS.txt new file mode 100644 index 00000000..6da8d5f0 --- /dev/null +++ b/docs/cci/api-ref/PARAMETERS.txt @@ -0,0 +1,3 @@ +version="" +language="en-us" +type="" \ No newline at end of file diff --git a/docs/cci/api-ref/cci_02_0003.html b/docs/cci/api-ref/cci_02_0003.html new file mode 100644 index 00000000..be5209dc --- /dev/null +++ b/docs/cci/api-ref/cci_02_0003.html @@ -0,0 +1,57 @@ + + +

Authentication

+
Requests for calling an API can be authenticated using either of the following methods: +
+

AK/SK Authentication

AK/SK authentication supports API requests with a body not larger than 12 MB. For API requests with a larger body, token authentication is recommended.

+
+

In AK/SK authentication, AK/SK is used to sign requests and the signature is then added to the requests for authentication.

+ +

In AK/SK authentication, you can use an AK/SK to sign requests based on the signature algorithm or using the signing SDK.

+

The signing SDK is only used for signing requests and is different from the SDKs provided by services.

+
+
+

Token Authentication

The validity period of a token is 24 hours. When using a token for authentication, cache it to prevent frequently calling the IAM API used to obtain a user token.

+
+

A token specifies temporary permissions in a computer system. During API authentication using a token, the token is added to requests to get permissions for calling the API. You can obtain a token by calling the Obtaining User Token API.

+

IMS is a project-level service. When you call the API, set auth.scope in the request body to project.

+

+
{
+    "auth": {
+        "identity": {
+            "methods": [
+                "password"
+            ],
+            "password": {
+                "user": {
+                    "name": "username",   // IAM user name
+                    "password": $ADMIN_PASS,  //IAM user password. You are advised to store it in ciphertext in the configuration file or an environment variable and decrypt it when needed to ensure security.
+                    "domain": {
+                        "name": "domainname"  // Name of the domain to which the IAM user belongs
+                    }
+                }
+            }
+        },
+        "scope": {
+            "project": {
+                "name": "xxxxxxxx"    // Project name
+            }
+        }
+    }
+}
+

After a token is obtained, the X-Auth-Token header field must be added to requests to specify the token when calling other APIs. For example, if the token is ABCDEFJ...., X-Auth-Token: ABCDEFJ.... can be added to a request as follows:

+
1
+2
+3
POST https://{{endpoint}}/v3/auth/projects
+Content-Type: application/json
+X-Auth-Token: ABCDEFJ....
+
+
+
+
+
+
+
Parent topic: Calling APIs
+
+
+ diff --git a/docs/cci/api-ref/cci_02_0009.html b/docs/cci/api-ref/cci_02_0009.html new file mode 100644 index 00000000..ab412e6e --- /dev/null +++ b/docs/cci/api-ref/cci_02_0009.html @@ -0,0 +1,14 @@ + + +

Calling APIs

+

Public 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: https://Endpoint/uri. uri indicates the resource path, that is, the API access path.

+

Public cloud APIs use HTTPS as the transmission protocol. Requests/Responses are transmitted by using JSON messages, with media type represented by Application/json.

+

For details about how to use APIs, see API Usage Guidelines.

+
+
+ +
+ diff --git a/docs/cci/api-ref/cci_02_0011.html b/docs/cci/api-ref/cci_02_0011.html new file mode 100644 index 00000000..5de27d63 --- /dev/null +++ b/docs/cci/api-ref/cci_02_0011.html @@ -0,0 +1,85 @@ + + +

Getting Started

+

Overview

You can call APIs to create a pod. An Nginx image is used as an example to show how you can create a pod.

+

The Nginx image is from the open-source image center, and the container uses 1 vCPU and 2 GiB of memory.

+

For details about how to call APIs, see Calling APIs.

+
+

Procedure

  1. Call the API described in Creating a Namespace to create a namespace.
  2. Call the API described in Creating a Network to create a network, and associate the network with a VPC and subnet.
  3. Call the API described in Creating a Pod to create an Nginx pod.
+
+

Creating an Nginx Pod

  1. Call the API described in Creating a Namespace to create a namespace.

    {
+  "apiVersion": "cci/v2",
+  "kind": "Namespace",
+  "metadata": {
+    "name": "namespace-test"
+  }
+}
    +

    You must specify the following parameters:

    +
    • name: namespace name.
    +

  2. Call the API described in Creating a Network to create a network, and associate the network with a VPC and subnet.

    {
+  "apiVersion": "yangtse/v2",
+  "kind": "Network",
+  "metadata": {
+    "annotations": {
+      "yangtse.io/domain-id": "51ed88507a244b6eb36270c0250fcc96",
+      "yangtse.io/project-id": "a81f079abca74e83b47af9a586048b24"
+    },
+    "name": "test-network",
+    "namespace": "namespace-test"
+  },
+  "spec": {
+    "networkType": "underlay_neutron",
+    "securityGroups": [
+      "470b6a8f-612e-4284-a788-c6900ac32fce"
+    ],
+    "subnets": [
+      {
+        "subnetID": "c6dd31e3-d217-4b31-bb60-eb30322c75b8"
+      }
+    ]
+  }
+}
    +

    You must specify the following parameters:

    +
    • name: name of a network object.
    • securityGroups: security group ID, which can be obtained on the Security Groups page.
    • yangtse.io/domain-id: account ID, which can be obtained by following the procedure in Obtaining an Account ID.
    • yangtse.io/project-id: project ID, which can be obtained by following the procedure in Obtaining a Project ID.
    • subnetID: ID of the subnet in the VPC, which can be obtained on the VPC console or by calling the API for querying subnets.
    +

  3. Call the API described in Creating a Pod to create an Nginx pod.

    In this example, a pod whose name is nginx and specifications are set to 1 vCPU and 2 GiB of memory will be created from the open-source image nginx:stable-alpine-perl. After the API is called, CCI creates a container running nginx.

    +

    +

    +
    {
+  "apiVersion": "cci/v2",
+  "kind": "Pod",
+  "metadata": {
+    "name": "nginx"
+  },
+  "spec": {
+    "containers": [
+      {
+        "image": "nginx:stable-alpine-perl",
+        "name": "container-0",
+        "resources": {
+          "limits": {
+            "cpu": "1",
+            "memory": "2Gi"
+          },
+          "requests": {
+            "cpu": "1",
+            "memory": "2Gi"
+          }
+        }
+      }
+    ],
+    "imagePullSecrets": [
+      {
+        "name": "imagepull-secret"
+      }
+    ]
+  }
+}
    +

    You must specify the following parameters:

    +
    • name: pod name
    • containers: container information
      • image: image used to create containers
      • name: container name
      • resources.limits: resource limits for a container. The resources used by a container cannot exceed the limits.
      • resources.requests: resources requested by a container
      +
    +

    After the pod is created, you can view it on the CCI console.

    +

    +

+
+
+ diff --git a/docs/cci/api-ref/cci_02_0067.html b/docs/cci/api-ref/cci_02_0067.html new file mode 100644 index 00000000..e2f80cb9 --- /dev/null +++ b/docs/cci/api-ref/cci_02_0067.html @@ -0,0 +1,23 @@ + + +

Appendix

+
+
+ +
+ diff --git a/docs/cci/api-ref/cci_02_0068.html b/docs/cci/api-ref/cci_02_0068.html new file mode 100644 index 00000000..d3ad3ca4 --- /dev/null +++ b/docs/cci/api-ref/cci_02_0068.html @@ -0,0 +1,327 @@ + + +

Status Codes

+
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +

Status Code

+

Name

+

Description

+

100

+

Continue

+

The server has received the initial part of the request and the client should continue to send the remaining part.

+

It is issued on a provisional basis while request processing continues. It alerts the client to wait for a final response.

+

101

+

Switching Protocols

+

The requester has asked the server to switch protocols and the server has agreed to do so. The target protocol must be more advanced than the source protocol.

+

For example, the current HTTP protocol is switched to a later version of HTTP.

+

200

+

OK

+

The results of GET, PUT, and POST operations are returned normally.

+

201

+

Created

+

The request has been fulfilled, resulting in the creation of a new resource.

+

202

+

Accepted

+

The request has been accepted for processing, but the processing has not been completed.

+

203

+

Non-Authoritative Information

+

The server successfully processed the request, but is returning information that may be from another source.

+

204

+

NoContent

+

The server has successfully processed the request, but does not return any content.

+

The status code is returned in response to an HTTP OPTIONS request.

+

205

+

Reset Content

+

The server has successfully processed the request, but does not return any content. Unlike a 204 response, this response requires that the requester reset the content.

+

206

+

Partial Content

+

The server has successfully processed a part of the GET request.

+

300

+

Multiple Choices

+

There are multiple options for the requested resource. For example, this code could be used to present a list of resource characteristics and addresses from which the client such as a browser may choose.

+

301

+

Moved Permanently

+

This and all future requests should be permanently directed to the given URI indicated in this response.

+

302

+

Found

+

The requested resource was temporarily moved.

+

303

+

See Other

+

The response to the request can be found under a different URI, and should be retrieved using a GET or POST method.

+

304

+

Not Modified

+

The requested resource has not been modified. In such case, there is no need to retransmit the resource since the client still has a previously-downloaded copy.

+

305

+

Use Proxy

+

The requested resource is available only through a proxy.

+

306

+

Unused

+

This HTTP status code is no longer used.

+

400

+

BadRequest

+

The request is invalid.

+

The client should modify the request instead of re-initiating it.

+

401

+

Unauthorized

+

The authorization information provided by the client is incorrect or invalid.

+

402

+

Payment Required

+

This status code is reserved for future use.

+

403

+

Forbidden

+

The server has received the request and understood it, but the server is refusing to respond to it.

+

The client should modify the request instead of re-initiating it.

+

404

+

NotFound

+

The requested resource cannot be found.

+

The client should modify the request instead of re-initiating it.

+

405

+

MethodNotAllowed

+

A request method is not supported for the requested resource.

+

The client should modify the request instead of re-initiating it.

+

406

+

Not Acceptable

+

The server cannot fulfill the request based on the content characteristics of the request.

+

407

+

Proxy Authentication Required

+

This code is similar to 401, but indicates that the client must first authenticate itself with the proxy.

+

408

+

Request Time-out

+

The server timed out waiting for the request.

+

The client may re-initiate the request without modifications at any later time.

+

409

+

Conflict

+

The request cannot be processed due to a conflict.

+

This status code indicates that the resource that the client attempts to create already exits, or the request fails to be processed because of the update of the conflict request.

+

410

+

Gone

+

The requested resource cannot be found.

+

The status code indicates that the requested resource has been deleted permanently.

+

411

+

Length Required

+

The server refused to process the request because the request does not specify the length of its content.

+

412

+

Precondition Failed

+

The server does not meet one of the preconditions that the requester puts on the request.

+

413

+

Request Entity Too Large

+

The server refuses to process a request because the request entity is too large. The server may disable the connection to prevent the client from sending requests consecutively. If the server temporarily cannot process the request, the response will contain a Retry-After header field.

+

414

+

Request-URI Too Large

+

The URI provided was too long for the server to process.

+

415

+

Unsupported Media Type

+

The server does not support the media type in the request.

+

416

+

Requested range not satisfiable

+

The requested range is invalid.

+

417

+

Expectation Failed

+

The server fails to meet the requirements of the Expect request-header field.

+

422

+

UnprocessableEntity

+

The request is well-formed but is unable to be processed due to semantic errors.

+

429

+

TooManyRequests

+

The client sends excessive requests to the server within a given time (exceeding the limit on the access frequency of the client), or the server receives excessive requests within a given time (beyond its processing capability). In this case, the client should repeat requests after the time specified in the Retry-After header of the response expires.

+

500

+

InternalServerError

+

The server is able to receive the request but it could not understand the request.

+

501

+

Not Implemented

+

The server does not support the requested function.

+

502

+

Bad Gateway

+

The server acting as a gateway or proxy receives an invalid response from a remote server.

+

503

+

ServiceUnavailable

+

The requested service is invalid.

+

The client should modify the request instead of re-initiating it.

+

504

+

ServerTimeout

+

The server could not return a timely response. The response will reach the client only if the request carries a timeout parameter.

+

505

+

HTTP Version not supported

+

The server does not support the HTTP protocol version used in the request.

+
+
+
+
+
+
Parent topic: Appendix
+
+
+ diff --git a/docs/cci/api-ref/cci_02_0081.html b/docs/cci/api-ref/cci_02_0081.html new file mode 100644 index 00000000..2f9c50c1 --- /dev/null +++ b/docs/cci/api-ref/cci_02_0081.html @@ -0,0 +1,23 @@ + + +

Introduction

+

This topic describes fine-grained permissions management for your CCI. If your account does not need individual IAM users, you may skip this topic.

+

You need to add a user to one or more groups, and assign permissions policies to these groups. The user then inherits permissions from the groups it is a member of. This process is called authorization. After authorization, the user can perform specified operations on CCI based on the permissions.

+

You can grant users their permissions by using roles and policies. Roles are a type of service-based, coarse-grained authorization mechanism that defines permissions related to user responsibilities. Policies define API-based permissions for operations on specific resources under certain conditions, allowing for more fine-grained, secure access control of cloud resources.

+

If you want to allow or deny the access to an API, fine-grained authorization is a good choice.

+
+

If you use IAM users in your account to call an API, the IAM users must be granted the required permissions. The permissions required for calling an API are determined by the actions supported by the API. Only users who have been granted permissions allowing the actions can call the API successfully. For example, if an IAM user queries pods using an API, the user must have been granted permissions that allow the CCI:namespaceSubResource:Get action.

+

Supported Actions

CCI provides system-defined policies that can be directly used in IAM. You can also create custom policies and use them to supplement system-defined policies, implementing more refined access control. Operations supported by policies are specific to APIs. The following are common concepts related to policies:

+ +

The check mark (√) and cross symbol (x) indicate that an action takes effect or does not take effect for the corresponding type of projects.

+
+

CCI supports the following actions that can be defined in custom policies:

+ +
+
+
+
+
Parent topic: Permissions Policies and Supported Actions
+
+
+ diff --git a/docs/cci/api-ref/cci_02_0082.html b/docs/cci/api-ref/cci_02_0082.html new file mode 100644 index 00000000..cb48ea0a --- /dev/null +++ b/docs/cci/api-ref/cci_02_0082.html @@ -0,0 +1,13 @@ + + +

Permissions Policies and Supported Actions

+
+
+ +
+ diff --git a/docs/cci/api-ref/cci_02_0083.html b/docs/cci/api-ref/cci_02_0083.html new file mode 100644 index 00000000..d7122a87 --- /dev/null +++ b/docs/cci/api-ref/cci_02_0083.html @@ -0,0 +1,410 @@ + + +

Category of CCI Actions

+
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Table 1 Namespace management actions

Permissions

+

API

+

Action

+

IAM Project

+

Enterprise Project

+

Creating a Namespace

+

POST /apis/cci/v2/namespaces

+

CCI:namespace:create

+

√

+

√

+

Reading a Namespace

+

GET /apis/cci/v2/namespaces/{name}

+

CCI:namespace:get

+

√

+

√

+

Listing Namespaces

+

GET /apis/cci/v2/namespaces

+

CCI:namespace:list

+

√

+

√

+

Deleting a Namespace

+

DELETE /apis/cci/v2/namespaces/{name}

+

CCI:namespace:delete

+

√

+

√

+
+
+ +
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Table 2 Pod management actions

Permissions

+

API

+

Action

+

IAM Project

+

Enterprise Project

+

Creating a Pod

+

POST /apis/cci/v2/namespaces/{namespace}/pods

+

CCI:namespaceSubResource:Create

+

√

+

√

+

Reading a Pod

+

GET /apis/cci/v2/namespaces/{namespace}/pods/{name}

+

CCI:namespaceSubResource:Get

+

√

+

√

+

Reading All Pods Under a Specified Namespace

+

GET /apis/cci/v2/namespaces/{namespace}/pods

+

CCI:namespaceSubResource:List

+

√

+

√

+

Reading Pod Logs

+

GET /apis/cci/v2/namespaces/{namespace}/pods/{name}/log

+

CCI:namespaceSubResource:Get

+

√

+

√

+

Listing All Pods of a User

+

GET /apis/cci/v2/pods

+

cci:namespaceSubResource:List

+

√

+

√

+

Replacing a Pod

+

PUT /apis/cci/v2/namespaces/{namespace}/pods/{name}

+

CCI:namespaceSubResource:Update

+

√

+

√

+

Updating a Pod

+

PATCH /apis/cci/v2/namespaces/{namespace}/pods/{name}

+

CCI:namespaceSubResource:Update

+

√

+

√

+

Deleting a Pod

+

DELETE /apis/cci/v2/namespaces/{namespace}/pods/{name}

+

CCI:namespaceSubResource:Delete

+

√

+

√

+
+
+ +
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Table 3 Network management actions

Permissions

+

API

+

Action

+

IAM Project

+

Enterprise Project

+

Creating a Network

+

POST /apis/yangtse/v2/namespaces/{namespace}/networks

+
  • CCI:network:Create
  • vpc:vpcs:create
  • vpc:ports:create
  • vpc:vpcs:get
  • vpc:subnets:get
  • vpc:publicIps:get
  • vpc:bandwidths:get
  • vpc:ports:get
  • vpc:peerings:get
  • vpc:quotas:list
  • vpc:privateIps:get
  • vpc:securityGroups:get
  • vpc:securityGroupRules:get
  • vpc:networks:get
  • vpc:routers:get
  • vpc:floatingIps:get
  • vpc:firewallRules:get
+

√

+

√

+

Reading a Network

+

GET /apis/yangtse/v2/namespaces/{namespace}/networks/{name}

+

CCI:network:Get

+

√

+

√

+

Listing Networks

+

GET /apis/yangtse/v2/namespaces/{namespace}/networks

+

CCI:network:List

+

√

+

√

+

Deleting a Network

+

DELETE /apis/yangtse/v2/namespaces/{namespace}/networks/{name}

+
  • CCI:network:Delete
  • vpc:vpcs:delete
  • vpc:ports:delete
+

√

+

√

+

Replacing a network

+

PUT

+

/apis/yangtse/v2/namespaces/{namespace}/network

+
  • CCI:network:Update
  • vpc:vpcs:update
  • vpc:ports:update
+

√

+

√

+
+
+ +
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Table 4 ConfigMap management actions

Permissions

+

API

+

Action

+

IAM Project

+

Enterprise Project

+

Creating a ConfigMap

+

POST /apis/cci/v2/namespaces/{namespace}/configmaps

+

CCI:namespaceSubResource:Create

+

√

+

√

+

Reading a ConfigMap

+

GET /apis/cci/v2/namespaces/{namespace}/configmaps/{name}

+

CCI:namespaceSubResource:Get

+

√

+

√

+

Listing ConfigMaps

+

GET /apis/cci/v2/namespaces/{namespace}/configmaps

+

CCI:namespaceSubResource:List

+

√

+

√

+

Replacing a ConfigMap

+

PUT /apis/cci/v2/namespaces/{namespace}/configmaps/{name}

+

CCI:namespaceSubResource:Update

+

√

+

√

+

Updating a ConfigMap

+

PATCH /apis/cci/v2/namespaces/{namespace}/configmaps/{name}

+

CCI:namespaceSubResource:Update

+

√

+

√

+

Deleting a ConfigMap

+

DELETE /apis/cci/v2/namespaces/{namespace}/configmaps/{name}

+

CCI:namespaceSubResource:Delete

+

√

+

√

+
+
+ +
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Table 5 Secret management actions

Permissions

+

API

+

Action

+

IAM Project

+

Enterprise Project

+

Creating a Secret

+

POST /apis/cci/v2/namespaces/{namespace}/secrets

+

CCI:namespaceSubResource:Create

+

√

+

√

+

Querying a secret

+

GET /apis/cci/v2/namespaces/{namespace}/secrets/{name}

+

CCI:namespaceSubResource:Get

+

√

+

√

+

Listing all secrets

+

GET /apis/cci/v2/namespaces/{namespace}/secrets/{name}

+

CCI:namespaceSubResource:List

+

√

+

√

+

Replacing a Secret

+

PUT /apis/cci/v2/namespaces/{namespace}/secrets/{name}

+

CCI:namespaceSubResource:Update

+

√

+

√

+

Updating a Secret

+

PATCH /apis/cci/v2/namespaces/{namespace}/secrets/{name}

+

CCI:namespaceSubResource:Update

+

√

+

√

+

Deleting a Secret

+

DELETE /apis/cci/v2/namespaces/{namespace}/secrets/{name}

+

CCI:namespaceSubResource:Delete

+

√

+

√

+
+
+
+
+
+
Parent topic: Permissions Policies and Supported Actions
+
+
+ diff --git a/docs/cci/api-ref/cci_02_1001.html b/docs/cci/api-ref/cci_02_1001.html new file mode 100644 index 00000000..57cf805b --- /dev/null +++ b/docs/cci/api-ref/cci_02_1001.html @@ -0,0 +1,46 @@ + + +

Obtaining a Project ID

+

Scenarios

A project ID is required for some URLs when an API is called. Therefore, you need to obtain a project ID in advance. Two methods are available:

+ +
+

Obtain the Project ID by Calling an API

You can obtain the project ID by calling the IAM 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. {Endpoint} is the IAM endpoint and can be obtained from Regions and Endpoints.

+

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

+
{
+    "projects": [
+        {
+            "domain_id": "65ewtrgaggshhk1223245sghjlse684b",
+            "is_domain": false,
+            "parent_id": "65ewtrgaggshhk1223245sghjlse684b",
+            "name": "project_name",
+            "description": "",
+            "links": {
+                "next": null,
+                "previous": null,
+                "self": "https://www.example.com/v3/projects/a4adasfjljaaaakla12334jklga9sasfg"
+            },
+            "id": "a4adasfjljaaaakla12334jklga9sasfg",
+            "enabled": true
+        }
+    ],
+    "links": {
+        "next": null,
+        "previous": null,
+        "self": "https://www.example.com/v3/projects"
+    }
+}
+
+

Obtain a Project ID from the Console

A project ID needs to be specified in the URIs of some APIs. Therefore, you need to obtain the project ID before calling APIs. The following procedure describes how to obtain a project ID:
  1. Log in to the management console.
  2. Click the username and select My Credentials from the drop-down list.

    On the My Credentials page, view project IDs in the project list.

    +
    Figure 1 Viewing project IDs
    +

    In multi-project scenarios, expand the region, and obtain your sub-project ID from the Project ID column.

    +
+
+
+
+
+
+
Parent topic: Appendix
+
+
+ diff --git a/docs/cci/api-ref/cci_02_1002.html b/docs/cci/api-ref/cci_02_1002.html new file mode 100644 index 00000000..3430f885 --- /dev/null +++ b/docs/cci/api-ref/cci_02_1002.html @@ -0,0 +1,15 @@ + + +

Obtaining an Account ID

+

An account ID (domain ID) is required for some URLs when an API is called. To obtain an account ID, perform the following operations:

+
  1. Log in to the management console.
  2. Click the username in the upper right corner and choose My Credentials from the drop-down list.

    +
    Figure 1 Obtaining your account ID
    +

    +
+
+
+
+
Parent topic: Appendix
+
+
+ diff --git a/docs/cci/api-ref/cci_02_1003.html b/docs/cci/api-ref/cci_02_1003.html new file mode 100644 index 00000000..ea5aa1a5 --- /dev/null +++ b/docs/cci/api-ref/cci_02_1003.html @@ -0,0 +1,12 @@ + + +

Obtaining a Container Image Address

+

Cloud Container Instance (CCI) supports both images in the container registry and those uploaded to SoftWare Repository for Container (SWR). Where,

+ +
+
+
+
Parent topic: Appendix
+
+
+ diff --git a/docs/cci/api-ref/cci_02_2000.html b/docs/cci/api-ref/cci_02_2000.html new file mode 100644 index 00000000..b8f8898d --- /dev/null +++ b/docs/cci/api-ref/cci_02_2000.html @@ -0,0 +1,65 @@ + + +

Proprietary APIs

+
+
+ +
+ diff --git a/docs/cci/api-ref/connectCciV2GetNamespacedPodExec.html b/docs/cci/api-ref/connectCciV2GetNamespacedPodExec.html new file mode 100644 index 00000000..2161fa28 --- /dev/null +++ b/docs/cci/api-ref/connectCciV2GetNamespacedPodExec.html @@ -0,0 +1,240 @@ + + +

Connecting GET Requests to exec of Pod

+

Function

Connect GET requests to exec of Pod.

+
+

Calling Method

For details, see Calling APIs.

+
+

URI

GET /apis/cci/v2/namespaces/{namespace}/pods/{name}/exec

+ +
+ + + + + + + + + + + + + + + + +
Table 1 Path Parameters

Parameter

+

Mandatory

+

Type

+

Description

+

name

+

Yes

+

String

+

Name of the Pod.ExecOptions

+

namespace

+

Yes

+

String

+

Object name and auth scope, such as for teams and projects.

+
+
+ +
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Table 2 Query Parameters

Parameter

+

Mandatory

+

Type

+

Description

+

command

+

No

+

String

+		  

container

+

No

+

String

+		  

stderr

+

No

+

Boolean

+		  

stdin

+

No

+

Boolean

+		  

stdout

+

No

+

Boolean

+		  

tty

+

No

+

Boolean

+		  
+
+
+

Request Parameters

+
+ + + + + + + + + + + +
Table 3 Request header parameters

Parameter

+

Mandatory

+

Type

+

Description

+

X-Auth-Token

+

Yes

+

String

+

User token.

+

It can be obtained through the IAM API used to obtain a user token. The value of X-Subject-Token in the response header is the user token.

+
+
+
+

Response Parameters

Status code: 200

+ +
+ + + + + + + + + +
Table 4 Response body parameters

Parameter

+

Type

+

Description

+

-

+

String

+		  
+
+
+

Example Requests

None

+
+

Example Responses

None

+
+

Status Codes

+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +

Status Code

+

Description

+

200

+

OK

+

400

+

BadRequest

+

401

+

Unauthorized

+

403

+

Forbidden

+

404

+

NotFound

+

405

+

MethodNotAllowed

+

406

+

NotAcceptable

+

409

+

Conflict

+

415

+

UnsupportedMediaType

+

422

+

Invalid

+

429

+

TooManyRequests

+

500

+

InternalError

+

503

+

ServiceUnavailable

+

504

+

ServerTimeout

+
+
+
+
+
+
+
Parent topic: Proprietary APIs
+
+
+ diff --git a/docs/cci/api-ref/connectCciV2PostNamespacedPodExec.html b/docs/cci/api-ref/connectCciV2PostNamespacedPodExec.html new file mode 100644 index 00000000..48d8ae7d --- /dev/null +++ b/docs/cci/api-ref/connectCciV2PostNamespacedPodExec.html @@ -0,0 +1,249 @@ + + +

Connecting POST Requests to exec of Pod

+

Function

Connect POST requests to exec of Pod.

+
+

Calling Method

For details, see Calling APIs.

+
+

URI

POST /apis/cci/v2/namespaces/{namespace}/pods/{name}/exec

+ +
+ + + + + + + + + + + + + + + + +
Table 1 Path Parameters

Parameter

+

Mandatory

+

Type

+

Description

+

name

+

Yes

+

String

+

Name of the Pod.ExecOptions

+

namespace

+

Yes

+

String

+

Object name and auth scope, such as for teams and projects.

+
+
+ +
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Table 2 Query Parameters

Parameter

+

Mandatory

+

Type

+

Description

+

command

+

No

+

String

+		  

container

+

No

+

String

+		  

stderr

+

No

+

Boolean

+		  

stdin

+

No

+

Boolean

+		  

stdout

+

No

+

Boolean

+		  

tty

+

No

+

Boolean

+		  
+
+
+

Request Parameters

+
+ + + + + + + + + + + + + + + + +
Table 3 Request header parameters

Parameter

+

Mandatory

+

Type

+

Description

+

X-Auth-Token

+

Yes

+

String

+

User token.

+

It can be obtained through the IAM API used to obtain a user token. The value of X-Subject-Token in the response header is the user token.

+

Content-Type

+

Yes

+

String

+

The type of the message body, with a default value of "application/JSON".

+
+
+
+

Response Parameters

Status code: 200

+ +
+ + + + + + + + + +
Table 4 Response body parameters

Parameter

+

Type

+

Description

+

-

+

String

+		  
+
+
+

Example Requests

None

+
+

Example Responses

None

+
+

Status Codes

+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +

Status Code

+

Description

+

200

+

OK

+

400

+

BadRequest

+

401

+

Unauthorized

+

403

+

Forbidden

+

404

+

NotFound

+

405

+

MethodNotAllowed

+

406

+

NotAcceptable

+

409

+

AlreadyExists

+

415

+

UnsupportedMediaType

+

422

+

Invalid

+

429

+

TooManyRequests

+

500

+

InternalError

+

503

+

ServiceUnavailable

+

504

+

ServerTimeout

+
+
+
+
+
+
+
Parent topic: Proprietary APIs
+
+
+ diff --git a/docs/cci/api-ref/createCciV2Namespace.html b/docs/cci/api-ref/createCciV2Namespace.html new file mode 100644 index 00000000..f7fdc620 --- /dev/null +++ b/docs/cci/api-ref/createCciV2Namespace.html @@ -0,0 +1,1881 @@ + + +

Creating a Namespace

+

Function

Create a Namespace.

+

A network must be created in a namespace to define the mapping between this network and a Virtual Private Cloud (VPC). For more information, see "Namespace and Network".

+
+

Calling Method

For details, see Calling APIs.

+
+

URI

POST /apis/cci/v2/namespaces

+ +
+ + + + + + + + + + + + + + + + + + + + + +
Table 1 Query Parameters

Parameter

+

Mandatory

+

Type

+

Description

+

dryRun

+

No

+

String

+

When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed

+

fieldManager

+

No

+

String

+

fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint.

+

pretty

+

No

+

String

+

If 'true', then the output is pretty printed.

+
+
+
+

Request Parameters

+
+ + + + + + + + + + + + + + + + +
Table 2 Request header parameters

Parameter

+

Mandatory

+

Type

+

Description

+

X-Auth-Token

+

Yes

+

String

+

User token.

+

It can be obtained through the IAM API used to obtain a user token. The value of X-Subject-Token in the response header is the user token.

+

Content-Type

+

Yes

+

String

+

The type of the message body, with a default value of "application/JSON".

+
+
+ +
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Table 3 Request body parameters

Parameter

+

Mandatory

+

Type

+

Description

+

apiVersion

+

No

+

String

+

APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#resources

+

kind

+

No

+

String

+

Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds

+

metadata

+

No

+

io.k8s.apimachinery.pkg.apis.meta.v1.ObjectMeta object

+

Standard object's metadata. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata

+

spec

+

No

+

io.cci.otc.api.pkg.apis.versioned.cci.v2.NamespaceSpec object

+

Spec defines the behavior of the Namespace. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#spec-and-status

+

status

+

No

+

io.cci.otc.api.pkg.apis.versioned.cci.v2.NamespaceStatus object

+

Status describes the current status of a Namespace. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#spec-and-status

+
+
+ +
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Table 4 io.k8s.apimachinery.pkg.apis.meta.v1.ObjectMeta

Parameter

+

Mandatory

+

Type

+

Description

+

annotations

+

No

+

Map<String,String>

+

Annotations is an unstructured key value map stored with a resource that may be set by external tools to store and retrieve arbitrary metadata. They are not queryable and should be preserved when modifying objects. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/annotations/

+

clusterName

+

No

+

String

+

The name of the cluster which the object belongs to. This is used to distinguish resources with same name and namespace in different clusters. This field is not set anywhere right now and apiserver is going to ignore it if set in create or update request.

+

creationTimestamp

+

No

+

String

+

CreationTimestamp is a timestamp representing the server time when this object was created. It is not guaranteed to be set in happens-before order across separate operations. Clients may not set this value. It is represented in RFC3339 form and is in UTC.

+

Populated by the system. Read-only. Null for lists. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata

+

deletionGracePeriodSeconds

+

No

+

Long

+

Number of seconds allowed for this object to gracefully terminate before it will be removed from the system. Only set when deletionTimestamp is also set. May only be shortened. Read-only.

+

deletionTimestamp

+

No

+

String

+

DeletionTimestamp is RFC 3339 date and time at which this resource will be deleted. This field is set by the server when a graceful deletion is requested by the user, and is not directly settable by a client. The resource is expected to be deleted (no longer visible from resource lists, and not reachable by name) after the time in this field, once the finalizers list is empty. As long as the finalizers list contains items, deletion is blocked. Once the deletionTimestamp is set, this value may not be unset or be set further into the future, although it may be shortened or the resource may be deleted prior to this time. For example, a user may request that a pod is deleted in 30 seconds. The Kubelet will react by sending a graceful termination signal to the containers in the pod. After that 30 seconds, the Kubelet will send a hard termination signal (SIGKILL) to the container and after cleanup, remove the pod from the API. In the presence of network partitions, this object may still exist after this timestamp, until an administrator or automated process can determine the resource is fully terminated. If not set, graceful deletion of the object has not been requested.

+

Populated by the system when a graceful deletion is requested. Read-only. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata

+

enable

+

No

+

Boolean

+

Enable identifies whether the resource is available

+

finalizers

+

No

+

Array of strings

+

Must be empty before the object is deleted from the registry.

+

Each entry is an identifier for the responsible component that will remove the entry from the list. If the deletionTimestamp of the object is non-nil, entries in this list can only be removed. Finalizers may be processed and removed in any order. Order is NOT enforced because it introduces significant risk of stuck finalizers. finalizers is a shared field, any actor with permission can reorder it. If the finalizer list is processed in order, then this can lead to a situation in which the component responsible for the first finalizer in the list is waiting for a signal (field value, external system, or other) produced by a component responsible for a finalizer later in the list, resulting in a deadlock. Without enforced ordering finalizers are free to order amongst themselves and are not vulnerable to ordering changes in the list.

+

generateName

+

No

+

String

+

GenerateName is an optional prefix, used by the server, to generate a unique name ONLY IF the Name field has not been provided. If this field is used, the name returned to the client will be different than the name passed. This value will also be combined with a unique suffix. The provided value has the same validation rules as the Name field, and may be truncated by the length of the suffix required to make the value unique on the server.

+

If this field is specified and the generated name exists, the server will NOT return a 409 - instead, it will either return 201 Created or 500 with Reason ServerTimeout indicating a unique name could not be found in the time allotted, and the client should retry (optionally after the time indicated in the Retry-After header).

+

Applied only if Name is not specified. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#idempotency

+

generation

+

No

+

Long

+

A sequence number representing a specific generation of the desired state. Populated by the system. Read-only.

+

labels

+

No

+

Map<String,String>

+

Map of string keys and values that can be used to organize and categorize (scope and select) objects. May match selectors of replication controllers and services. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/labels/

+

managedFields

+

No

+

Array of io.k8s.apimachinery.pkg.apis.meta.v1.ManagedFieldsEntry objects

+

ManagedFields maps workflow-id and version to the set of fields that are managed by that workflow. This is mostly for internal housekeeping, and users typically shouldn't need to set or understand this field. A workflow can be the user's name, a controller's name, or the name of a specific applypath like "ci-cd". The set of fields is always in the version that the workflow used when modifying the object.

+

name

+

No

+

String

+

Name must be unique within a namespace. Is required when creating resources, although some resources may allow a client to request the generation of an appropriate name automatically. Name is primarily intended for creation idempotence and configuration definition. Cannot be updated. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names

+

namespace

+

No

+

String

+

Namespace defines the space within which each name must be unique. An empty namespace is equivalent to the "default" namespace, but "default" is the canonical representation. Not all objects are required to be scoped to a namespace - the value of this field for those objects will be empty.

+

Must be a DNS_LABEL. Cannot be updated. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/namespaces/

+

ownerReferences

+

No

+

Array of io.k8s.apimachinery.pkg.apis.meta.v1.OwnerReference objects

+

List of objects depended by this object. If ALL objects in the list have been deleted, this object will be garbage collected. If this object is managed by a controller, then an entry in this list will point to this controller, with the controller field set to true. There cannot be more than one managing controller.

+

resourceVersion

+

No

+

String

+

An opaque value that represents the internal version of this object that can be used by clients to determine when objects have changed. May be used for optimistic concurrency, change detection, and the watch operation on a resource or set of resources. Clients must treat these values as opaque and passed unmodified back to the server. They may only be valid for a particular resource or set of resources.

+

Populated by the system. Read-only. Value must be treated as opaque by clients and . More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#concurrency-control-and-consistency

+

selfLink

+

No

+

String

+

SelfLink is a URL representing this object. Populated by the system. Read-only.

+

DEPRECATED Kubernetes will stop propagating this field in 1.20 release and the field is planned to be removed in 1.21 release.

+

uid

+

No

+

String

+

UID is the unique in time and space value for this object. It is typically generated by the server on successful creation of a resource and is not allowed to change on PUT operations.

+

Populated by the system. Read-only. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#uids

+
+
+ +
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Table 5 io.k8s.apimachinery.pkg.apis.meta.v1.ManagedFieldsEntry

Parameter

+

Mandatory

+

Type

+

Description

+

apiVersion

+

No

+

String

+

APIVersion defines the version of this resource that this field set applies to. The format is "group/version" just like the top-level APIVersion field. It is necessary to track the version of a field set because it cannot be automatically converted.

+

fieldsType

+

No

+

String

+

FieldsType is the discriminator for the different fields format and version. There is currently only one possible value: "FieldsV1"

+

fieldsV1

+

No

+

Object

+

FieldsV1 holds the first JSON version format as described in the "FieldsV1" type.

+

manager

+

No

+

String

+

Manager is an identifier of the workflow managing these fields.

+

operation

+

No

+

String

+

Operation is the type of operation which lead to this ManagedFieldsEntry being created. The only valid values for this field are 'Apply' and 'Update'.

+

time

+

No

+

String

+

Time is timestamp of when these fields were set. It should always be empty if Operation is 'Apply'

+
+
+ +
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Table 6 io.k8s.apimachinery.pkg.apis.meta.v1.OwnerReference

Parameter

+

Mandatory

+

Type

+

Description

+

apiVersion

+

Yes

+

String

+

API version of the referent.

+

blockOwnerDeletion

+

No

+

Boolean

+

If true, AND if the owner has the "foregroundDeletion" finalizer, then the owner cannot be deleted from the key-value store until this reference is removed. Defaults to false. To set this field, a user needs "delete" permission of the owner, otherwise 422 (Unprocessable Entity) will be returned.

+

controller

+

No

+

Boolean

+

If true, this reference points to the managing controller.

+

kind

+

Yes

+

String

+

Kind of the referent. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds

+

name

+

Yes

+

String

+

Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names

+

uid

+

Yes

+

String

+

UID of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#uids

+
+
+ +
+ + + + + + + + + + + +
Table 7 io.cci.otc.api.pkg.apis.versioned.cci.v2.NamespaceSpec

Parameter

+

Mandatory

+

Type

+

Description

+

finalizers

+

No

+

Array of strings

+

Finalizers is an opaque list of values that must be empty to permanently remove object from storage. More info: https://kubernetes.io/docs/tasks/administer-cluster/namespaces/

+
+
+ +
+ + + + + + + + + + + + + + + + +
Table 8 io.cci.otc.api.pkg.apis.versioned.cci.v2.NamespaceStatus

Parameter

+

Mandatory

+

Type

+

Description

+

conditions

+

No

+

Array of io.cci.otc.api.pkg.apis.versioned.cci.v2.NamespaceCondition objects

+

Represents the latest available observations of a namespace's current state.

+

phase

+

No

+

String

+

Phase is the current lifecycle phase of the namespace. More info: https://kubernetes.io/docs/tasks/administer-cluster/namespaces/

+

Possible enum values:

+
  • "Active" means the namespace is available for use in the system
  • "Terminating" means the namespace is undergoing graceful termination
+
+
+ +
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Table 9 io.cci.otc.api.pkg.apis.versioned.cci.v2.NamespaceCondition

Parameter

+

Mandatory

+

Type

+

Description

+

lastTransitionTime

+

No

+

String

+

Time is a wrapper around time. Time which supports correct marshaling to YAML and JSON. Wrappers are provided for many of the factory methods that the time package offers.

+

message

+

No

+

String

+		  

reason

+

No

+

String

+		  

status

+

Yes

+

String

+

Status of the condition, one of True, False, Unknown.

+

type

+

Yes

+

String

+

Type of namespace controller condition.

+
+
+
+

Response Parameters

Status code: 200

+ +
+ + + + + + + + + + + + + + + + + + + + + + + + + +
Table 10 Response body parameters

Parameter

+

Type

+

Description

+

apiVersion

+

String

+

APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#resources

+

kind

+

String

+

Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds

+

metadata

+

io.k8s.apimachinery.pkg.apis.meta.v1.ObjectMeta object

+

Standard object's metadata. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata

+

spec

+

io.cci.otc.api.pkg.apis.versioned.cci.v2.NamespaceSpec object

+

Spec defines the behavior of the Namespace. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#spec-and-status

+

status

+

io.cci.otc.api.pkg.apis.versioned.cci.v2.NamespaceStatus object

+

Status describes the current status of a Namespace. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#spec-and-status

+
+
+ +
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Table 11 io.k8s.apimachinery.pkg.apis.meta.v1.ObjectMeta

Parameter

+

Type

+

Description

+

annotations

+

Map<String,String>

+

Annotations is an unstructured key value map stored with a resource that may be set by external tools to store and retrieve arbitrary metadata. They are not queryable and should be preserved when modifying objects. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/annotations/

+

clusterName

+

String

+

The name of the cluster which the object belongs to. This is used to distinguish resources with same name and namespace in different clusters. This field is not set anywhere right now and apiserver is going to ignore it if set in create or update request.

+

creationTimestamp

+

String

+

CreationTimestamp is a timestamp representing the server time when this object was created. It is not guaranteed to be set in happens-before order across separate operations. Clients may not set this value. It is represented in RFC3339 form and is in UTC.

+

Populated by the system. Read-only. Null for lists. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata

+

deletionGracePeriodSeconds

+

Long

+

Number of seconds allowed for this object to gracefully terminate before it will be removed from the system. Only set when deletionTimestamp is also set. May only be shortened. Read-only.

+

deletionTimestamp

+

String

+

DeletionTimestamp is RFC 3339 date and time at which this resource will be deleted. This field is set by the server when a graceful deletion is requested by the user, and is not directly settable by a client. The resource is expected to be deleted (no longer visible from resource lists, and not reachable by name) after the time in this field, once the finalizers list is empty. As long as the finalizers list contains items, deletion is blocked. Once the deletionTimestamp is set, this value may not be unset or be set further into the future, although it may be shortened or the resource may be deleted prior to this time. For example, a user may request that a pod is deleted in 30 seconds. The Kubelet will react by sending a graceful termination signal to the containers in the pod. After that 30 seconds, the Kubelet will send a hard termination signal (SIGKILL) to the container and after cleanup, remove the pod from the API. In the presence of network partitions, this object may still exist after this timestamp, until an administrator or automated process can determine the resource is fully terminated. If not set, graceful deletion of the object has not been requested.

+

Populated by the system when a graceful deletion is requested. Read-only. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata

+

enable

+

Boolean

+

Enable identifies whether the resource is available.

+

finalizers

+

Array of strings

+

Must be empty before the object is deleted from the registry.

+

Each entry is an identifier for the responsible component that will remove the entry from the list. If the deletionTimestamp of the object is non-nil, entries in this list can only be removed. Finalizers may be processed and removed in any order. Order is NOT enforced because it introduces significant risk of stuck finalizers. finalizers is a shared field, any actor with permission can reorder it. If the finalizer list is processed in order, then this can lead to a situation in which the component responsible for the first finalizer in the list is waiting for a signal (field value, external system, or other) produced by a component responsible for a finalizer later in the list, resulting in a deadlock. Without enforced ordering finalizers are free to order amongst themselves and are not vulnerable to ordering changes in the list.

+

generateName

+

String

+

GenerateName is an optional prefix, used by the server, to generate a unique name ONLY IF the Name field has not been provided. If this field is used, the name returned to the client will be different than the name passed. This value will also be combined with a unique suffix. The provided value has the same validation rules as the Name field, and may be truncated by the length of the suffix required to make the value unique on the server.

+

If this field is specified and the generated name exists, the server will NOT return a 409 - instead, it will either return 201 Created or 500 with Reason ServerTimeout indicating a unique name could not be found in the time allotted, and the client should retry (optionally after the time indicated in the Retry-After header).

+

Applied only if Name is not specified. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#idempotency

+

generation

+

Long

+

A sequence number representing a specific generation of the desired state. Populated by the system. Read-only.

+

labels

+

Map<String,String>

+

Map of string keys and values that can be used to organize and categorize (scope and select) objects. May match selectors of replication controllers and services. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/labels/

+

managedFields

+

Array of io.k8s.apimachinery.pkg.apis.meta.v1.ManagedFieldsEntry objects

+

ManagedFields maps workflow-id and version to the set of fields that are managed by that workflow. This is mostly for internal housekeeping, and users typically shouldn't need to set or understand this field. A workflow can be the user's name, a controller's name, or the name of a specific apply-path like "ci-cd". The set of fields is always in the version that the workflow used when modifying the object.

+

name

+

String

+

Name must be unique within a namespace. Is required when creating resources, although some resources may allow a client to request the generation of an appropriate name automatically. Name is primarily intended for creation idempotence and configuration definition. Cannot be updated. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names

+

namespace

+

String

+

Namespace defines the space within which each name must be unique. An empty namespace is equivalent to the "default" namespace, but "default" is the canonical representation. Not all objects are required to be scoped to a namespace - the value of this field for those objects will be empty.

+

Must be a DNS_LABEL. Cannot be updated. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/namespaces/

+

ownerReferences

+

Array of io.k8s.apimachinery.pkg.apis.meta.v1.OwnerReference objects

+

List of objects depended by this object. If ALL objects in the list have been deleted, this object will be garbage collected. If this object is managed by a controller, then an entry in this list will point to this controller, with the controller field set to true. There cannot be more than one managing controller.

+

resourceVersion

+

String

+

An opaque value that represents the internal version of this object that can be used by clients to determine when objects have changed. May be used for optimistic concurrency, change detection, and the watch operation on a resource or set of resources. Clients must treat these values as opaque and passed unmodified back to the server. They may only be valid for a particular resource or set of resources.

+

Populated by the system. Read-only. Value must be treated as opaque by clients and . More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#concurrency-control-and-consistency

+

selfLink

+

String

+

SelfLink is a URL representing this object. Populated by the system. Read-only.

+

DEPRECATED Kubernetes will stop propagating this field in 1.20 release and the field is planned to be removed in 1.21 release.

+

uid

+

String

+

UID is the unique in time and space value for this object. It is typically generated by the server on successful creation of a resource and is not allowed to change on PUT operations.

+

Populated by the system. Read-only. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#uids

+
+
+ +
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Table 12 io.k8s.apimachinery.pkg.apis.meta.v1.ManagedFieldsEntry

Parameter

+

Type

+

Description

+

apiVersion

+

String

+

APIVersion defines the version of this resource that this field set applies to. The format is "group/version" just like the top-level APIVersion

+

field. It is necessary to track the version of a field set because it cannot

+

be automatically converted.

+

fieldsType

+

String

+

FieldsType is the discriminator for the different fields format and version. There is currently only one possible value: "FieldsV1"

+

fieldsV1

+

Object

+

FieldsV1 holds the first JSON version format as described in the "FieldsV1" type.

+

manager

+

String

+

Manager is an identifier of the workflow managing these fields.

+

operation

+

String

+

Operation is the type of operation which lead to this ManagedFieldsEntry

+

being created. The only valid values for this field are 'Apply' and 'Update'.

+

time

+

String

+

Time is timestamp of when these fields were set. It should always

+

be empty if Operation is 'Apply'

+
+
+ +
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Table 13 io.k8s.apimachinery.pkg.apis.meta.v1.OwnerReference

Parameter

+

Type

+

Description

+

apiVersion

+

String

+

API version of the referent.

+

blockOwnerDeletion

+

Boolean

+

If true, AND if the owner has the "foregroundDeletion" finalizer, then the owner cannot be deleted from the key-value store until this reference is removed. Defaults to false. To set this field, a user needs "delete" permission of the owner, otherwise 422 (Unprocessable Entity) will be returned.

+

controller

+

Boolean

+

If true, this reference points to the managing controller.

+

kind

+

String

+

Kind of the referent. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds

+

name

+

String

+

Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names

+

uid

+

String

+

UID of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#uids

+
+
+ +
+ + + + + + + + + +
Table 14 io.cci.otc.api.pkg.apis.versioned.cci.v2.NamespaceSpec

Parameter

+

Type

+

Description

+

finalizers

+

Array of strings

+

Finalizers is an opaque list of values that must be empty to permanently remove object from storage. More info: https://kubernetes.io/docs/tasks/administer-cluster/namespaces/

+
+
+ +
+ + + + + + + + + + + + + +
Table 15 io.cci.otc.api.pkg.apis.versioned.cci.v2.NamespaceStatus

Parameter

+

Type

+

Description

+

conditions

+

Array of io.cci.otc.api.pkg.apis.versioned.cci.v2.NamespaceCondition objects

+

Represents the latest available observations of a namespace's current state.

+

phase

+

String

+

Phase is the current lifecycle phase of the namespace. More info: https://kubernetes.io/docs/tasks/administer-cluster/namespaces/

+

Possible enum values:

+
  • "Active" means the namespace is available for use in the system
  • "Terminating" means the namespace is undergoing graceful termination
+
+
+ +
+ + + + + + + + + + + + + + + + + + + + + + + + + +
Table 16 io.cci.otc.api.pkg.apis.versioned.cci.v2.NamespaceCondition

Parameter

+

Type

+

Description

+

lastTransitionTime

+

String

+

Time is a wrapper around time.Time which supports correct marshaling to YAML and JSON. Wrappers are provided for many of the factory methods that the time package offers.

+

message

+

String

+		  

reason

+

String

+		  

status

+

String

+

Status of the condition, one of True, False, Unknown.

+

type

+

String

+

Type of namespace controller condition.

+
+
+

Status code: 201

+ +
+ + + + + + + + + + + + + + + + + + + + + + + + + +
Table 17 Response body parameters

Parameter

+

Type

+

Description

+

apiVersion

+

String

+

APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#resources

+

kind

+

String

+

Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds

+

metadata

+

io.k8s.apimachinery.pkg.apis.meta.v1.ObjectMeta object

+

Standard object's metadata. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata

+

spec

+

io.cci.otc.api.pkg.apis.versioned.cci.v2.NamespaceSpec object

+

Spec defines the behavior of the Namespace. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#spec-and-status

+

status

+

io.cci.otc.api.pkg.apis.versioned.cci.v2.NamespaceStatus object

+

Status describes the current status of a Namespace. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#spec-and-status

+
+
+ +
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Table 18 io.k8s.apimachinery.pkg.apis.meta.v1.ObjectMeta

Parameter

+

Type

+

Description

+

annotations

+

Map<String,String>

+

Annotations is an unstructured key value map stored with a resource that may be set by external tools to store and retrieve arbitrary metadata. They are not queryable and should be preserved when modifying objects. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/annotations/

+

clusterName

+

String

+

The name of the cluster which the object belongs to. This is used to distinguish resources with same name and namespace in different clusters. This field is not set anywhere right now and apiserver is going to ignore it if set in create or update request.

+

creationTimestamp

+

String

+

CreationTimestamp is a timestamp representing the server time when this object was created. It is not guaranteed to be set in happens-before order across separate operations. Clients may not set this value. It is represented in RFC3339 form and is in UTC.

+

Populated by the system. Read-only. Null for lists. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata

+

deletionGracePeriodSeconds

+

Long

+

Number of seconds allowed for this object to gracefully terminate

+

before it will be removed from the system. Only set when deletionTimestamp

+

is also set. May only be shortened. Read-only.

+

deletionTimestamp

+

String

+

DeletionTimestamp is RFC 3339 date and time at which this resource will be deleted. This field is set by the server when a graceful deletion is requested by the user, and is not directly settable by a client. The resource is expected to be deleted (no longer visible from resource lists, and not reachable by name) after the time in this field, once the finalizers list is empty. As long as the finalizers list contains items, deletion is blocked. Once the deletionTimestamp is set, this value may not be unset or be set further into the future, although it may be shortened or the resource may be deleted prior to this time. For example, a user may request that a pod is deleted in 30 seconds. The Kubelet will react by sending a graceful termination signal to the containers in the pod. After that 30 seconds, the Kubelet will send a hard termination signal (SIGKILL) to the container and after cleanup, remove the pod from the API. In the presence of network partitions, this object may still exist after this timestamp, until an administrator or automated process can determine the resource is fully terminated. If not set, graceful deletion of the object has not been requested.

+

Populated by the system when a graceful deletion is requested. Read-only. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata

+

enable

+

Boolean

+

Enable identifies whether the resource is available.

+

finalizers

+

Array of strings

+

Must be empty before the object is deleted from the registry.

+

Each entry is an identifier for the responsible component that will remove the entry from the list. If the deletionTimestamp of the object is non-nil, entries in this list can only be removed. Finalizers may be processed and removed in any order. Order is NOT enforced because it introduces significant risk of stuck finalizers. finalizers is a shared field, any actor with permission can reorder it. If the finalizer list is processed in order, then this can lead to a situation in which the component responsible for the first finalizer in the list is waiting for a signal (field value, external system, or other) produced by a component responsible for a finalizer later in the list, resulting in a deadlock. Without enforced ordering finalizers are free to order amongst themselves and are not vulnerable to ordering changes in the list.

+

generateName

+

String

+

GenerateName is an optional prefix, used by the server, to generate a unique name ONLY IF the Name field has not been provided. If this field is used, the name returned to the client will be different than the name passed. This value will also be combined with a unique suffix. The provided value has the same validation rules as the Name field, and may be truncated by the length of the suffix required to make the value unique on the server.

+

If this field is specified and the generated name exists, the server will NOT return a 409 - instead, it will either return 201 Created or 500 with Reason ServerTimeout indicating a unique name could not be found in the time allotted, and the client should retry (optionally after the time indicated in the Retry-After header).

+

Applied only if Name is not specified. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#idempotency

+

generation

+

Long

+

A sequence number representing a specific generation of the desired state. Populated by the system. Read-only.

+

labels

+

Map<String,String>

+

Map of string keys and values that can be used to organize and categorize (scope and select) objects. May match selectors of replication controllers and services. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/labels/

+

managedFields

+

Array of io.k8s.apimachinery.pkg.apis.meta.v1.ManagedFieldsEntry objects

+

ManagedFields maps workflow-id and version to the set of fields that are managed by that workflow. This is mostly for internal housekeeping, and users typically shouldn't need to set or understand this field. A workflow can be the user's name, a controller's name, or the name of a specific apply-path like "ci-cd". The set of fields is always in the version that the workflow used when modifying the object.

+

name

+

String

+

Name must be unique within a namespace. Is required when creating resources, although some resources may allow a client to request the generation of an appropriate name automatically. Name is primarily intended for creation idempotence and configuration definition. Cannot be updated. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names

+

namespace

+

String

+

Namespace defines the space within which each name must be unique. An empty namespace is equivalent to the "default" namespace, but "default" is the canonical representation. Not all objects are required to be scoped to a namespace - the value of this field for those objects will be empty.

+

Must be a DNS_LABEL. Cannot be updated. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/namespaces/

+

ownerReferences

+

Array of io.k8s.apimachinery.pkg.apis.meta.v1.OwnerReference objects

+

List of objects depended by this object. If ALL objects in the

+

list have been deleted, this object will be garbage collected. If this object

+

is managed by a controller, then an entry in this list will point to this

+

controller, with the controller field set to true. There cannot be more

+

than one managing controller.

+

resourceVersion

+

String

+

An opaque value that represents the internal version of this object that can be used by clients to determine when objects have changed. May be used for optimistic concurrency, change detection, and the watch operation on a resource or set of resources. Clients must treat these values as opaque and passed unmodified back to the server. They may only be valid for a particular resource or set of resources.

+

Populated by the system. Read-only. Value must be treated as opaque by clients and . More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#concurrency-control-and-consistency

+

selfLink

+

String

+

SelfLink is a URL representing this object. Populated by the system. Read-only.

+

DEPRECATED Kubernetes will stop propagating this field in 1.20 release and the field is planned to be removed in 1.21 release.

+

uid

+

String

+

UID is the unique in time and space value for this object. It is typically generated by the server on successful creation of a resource and is not allowed to change on PUT operations.

+

Populated by the system. Read-only. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#uids

+
+
+ +
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Table 19 io.k8s.apimachinery.pkg.apis.meta.v1.ManagedFieldsEntry

Parameter

+

Type

+

Description

+

apiVersion

+

String

+

APIVersion defines the version of this resource that this field set applies to. The format is "group/version" just like the top-level APIVersion field. It is necessary to track the version of a field set because it cannot be automatically converted.

+

fieldsType

+

String

+

FieldsType is the discriminator for the different fields format and version. There is currently only one possible value: "FieldsV1"

+

fieldsV1

+

Object

+

FieldsV1 holds the first JSON version format as described in the "FieldsV1" type.

+

manager

+

String

+

Manager is an identifier of the workflow managing these fields.

+

operation

+

String

+

Operation is the type of operation which lead to this ManagedFieldsEntry being created. The only valid values for this field are 'Apply' and 'Update'.

+

time

+

String

+

Time is timestamp of when these fields were set. It should always be empty if Operation is 'Apply'

+
+
+ +
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Table 20 io.k8s.apimachinery.pkg.apis.meta.v1.OwnerReference

Parameter

+

Type

+

Description

+

apiVersion

+

String

+

API version of the referent.

+

blockOwnerDeletion

+

Boolean

+

If true, AND if the owner has the "foregroundDeletion" finalizer, then the owner cannot be deleted from the key-value store until this reference is removed. Defaults to false. To set this field, a user needs "delete" permission of the owner, otherwise 422 (Unprocessable Entity) will be returned.

+

controller

+

Boolean

+

If true, this reference points to the managing controller.

+

kind

+

String

+

Kind of the referent. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds

+

name

+

String

+

Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names

+

uid

+

String

+

UID of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#uids

+
+
+ +
+ + + + + + + + + +
Table 21 io.cci.otc.api.pkg.apis.versioned.cci.v2.NamespaceSpec

Parameter

+

Type

+

Description

+

finalizers

+

Array of strings

+

Finalizers is an opaque list of values that must be empty to permanently remove object from storage. More info: https://kubernetes.io/docs/tasks/administer-cluster/namespaces/

+
+
+ +
+ + + + + + + + + + + + + +
Table 22 io.cci.otc.api.pkg.apis.versioned.cci.v2.NamespaceStatus

Parameter

+

Type

+

Description

+

conditions

+

Array of io.cci.otc.api.pkg.apis.versioned.cci.v2.NamespaceCondition objects

+

Represents the latest available observations of a namespace's current state.

+

phase

+

String

+

Phase is the current lifecycle phase of the namespace. More info: https://kubernetes.io/docs/tasks/administer-cluster/namespaces/

+

Possible enum values:

+
  • "Active" means the namespace is available for use in the system
  • "Terminating" means the namespace is undergoing graceful termination
+
+
+ +
+ + + + + + + + + + + + + + + + + + + + + + + + + +
Table 23 io.cci.otc.api.pkg.apis.versioned.cci.v2.NamespaceCondition

Parameter

+

Type

+

Description

+

lastTransitionTime

+

String

+

Time is a wrapper around time.Time which supports correct marshaling to YAML and JSON. Wrappers are provided for many of the factory methods that the time package offers.

+

message

+

String

+		  

reason

+

String

+		  

status

+

String

+

Status of the condition, one of True, False, Unknown.

+

type

+

String

+

Type of namespace controller condition.

+
+
+

Status code: 202

+ +
+ + + + + + + + + + + + + + + + + + + + + + + + + +
Table 24 Response body parameters

Parameter

+

Type

+

Description

+

apiVersion

+

String

+

APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#resources

+

kind

+

String

+

Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds

+

metadata

+

io.k8s.apimachinery.pkg.apis.meta.v1.ObjectMeta object

+

Standard object's metadata. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata

+

spec

+

io.cci.otc.api.pkg.apis.versioned.cci.v2.NamespaceSpec object

+

Spec defines the behavior of the Namespace. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#spec-and-status

+

status

+

io.cci.otc.api.pkg.apis.versioned.cci.v2.NamespaceStatus object

+

Status describes the current status of a Namespace. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#spec-and-status

+
+
+ +
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Table 25 io.k8s.apimachinery.pkg.apis.meta.v1.ObjectMeta

Parameter

+

Type

+

Description

+

annotations

+

Map<String,String>

+

Annotations is an unstructured key value map stored with a resource that may be set by external tools to store and retrieve arbitrary metadata. They are not queryable and should be preserved when modifying objects. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/annotations/

+

clusterName

+

String

+

The name of the cluster which the object belongs to. This is used to distinguish resources with same name and namespace in different clusters. This field is not set anywhere right now and apiserver is going to ignore it if set in create or update request.

+

creationTimestamp

+

String

+

CreationTimestamp is a timestamp representing the server time when this object was created. It is not guaranteed to be set in happens-before order across separate operations. Clients may not set this value. It is represented in RFC3339 form and is in UTC.

+

Populated by the system. Read-only. Null for lists. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata

+

deletionGracePeriodSeconds

+

Long

+

Number of seconds allowed for this object to gracefully terminate before it will be removed from the system. Only set when deletionTimestamp is also set. May only be shortened. Read-only.

+

deletionTimestamp

+

String

+

DeletionTimestamp is RFC 3339 date and time at which this resource will be deleted. This field is set by the server when a graceful deletion is requested by the user, and is not directly settable by a client. The resource is expected to be deleted (no longer visible from resource lists, and not reachable by name) after the time in this field, once the finalizers list is empty. As long as the finalizers list contains items, deletion is blocked. Once the deletionTimestamp is set, this value may not be unset or be set further into the future, although it may be shortened or the resource may be deleted prior to this time. For example, a user may request that a pod is deleted in 30 seconds. The Kubelet will react by sending a graceful termination signal to the containers in the pod. After that 30 seconds, the Kubelet will send a hard termination signal (SIGKILL) to the container and after cleanup, remove the pod from the API. In the presence of network partitions, this object may still exist after this timestamp, until an administrator or automated process can determine the resource is fully terminated. If not set, graceful deletion of the object has not been requested.

+

Populated by the system when a graceful deletion is requested. Read-only. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata

+

enable

+

Boolean

+

Enable identifies whether the resource is available

+

finalizers

+

Array of strings

+

Must be empty before the object is deleted from the registry.

+

Each entry is an identifier for the responsible component that will remove the entry from the list. If the deletionTimestamp of the object is non-nil, entries in this list can only be removed. Finalizers may be processed and removed in any order. Order is NOT enforced because it introduces significant risk of stuck finalizers. finalizers is a shared field, any actor with permission can reorder it. If the finalizer list is processed in order, then this can lead to a situation in which the component responsible for the first finalizer in the list is waiting for a signal (field value, external system, or other) produced by a component responsible for a finalizer later in the list, resulting in a deadlock. Without enforced ordering finalizers are free to order amongst themselves and are not vulnerable to ordering changes in the list.

+

generateName

+

String

+

GenerateName is an optional prefix, used by the server, to generate a unique name ONLY IF the Name field has not been provided. If this field is used, the name returned to the client will be different than the name passed. This value will also be combined with a unique suffix. The provided value has the same validation rules as the Name field, and may be truncated by the length of the suffix required to make the value unique on the server.

+

If this field is specified and the generated name exists, the server will NOT return a 409 - instead, it will either return 201 Created or 500 with Reason ServerTimeout indicating a unique name could not be found in the time allotted, and the client should retry (optionally after the time indicated in the Retry-After header).

+

Applied only if Name is not specified. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#idempotency

+

generation

+

Long

+

A sequence number representing a specific generation of the desired state. Populated by the system. Read-only.

+

labels

+

Map<String,String>

+

Map of string keys and values that can be used to organize and categorize (scope and select) objects. May match selectors of replication controllers and services. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/labels/

+

managedFields

+

Array of io.k8s.apimachinery.pkg.apis.meta.v1.ManagedFieldsEntry objects

+

ManagedFields maps workflow-id and version to the set of fields that are managed by that workflow. This is mostly for internal housekeeping, and users typically shouldn't need to set or understand this field. A workflow can be the user's name, a controller's name, or the name of a specific apply-path like "ci-cd". The set of fields is always in the version that the workflow used when modifying the object.

+

name

+

String

+

Name must be unique within a namespace. Is required when creating resources, although some resources may allow a client to request the generation of an appropriate name automatically. Name is primarily intended for creation idempotence and configuration definition. Cannot be updated. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names

+

namespace

+

String

+

Namespace defines the space within which each name must be unique. An empty namespace is equivalent to the "default" namespace, but "default" is the canonical representation. Not all objects are required to be scoped to a namespace - the value of this field for those objects will be empty.

+

Must be a DNS_LABEL. Cannot be updated. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/namespaces/

+

ownerReferences

+

Array of io.k8s.apimachinery.pkg.apis.meta.v1.OwnerReference objects

+

List of objects depended by this object. If ALL objects in the list have been deleted, this object will be garbage collected. If this object is managed by a controller, then an entry in this list will point to this controller, with the controller field set to true. There cannot be more than one managing controller.

+

resourceVersion

+

String

+

An opaque value that represents the internal version of this object that can be used by clients to determine when objects have changed. May be used for optimistic concurrency, change detection, and the watch operation on a resource or set of resources. Clients must treat these values as opaque and passed unmodified back to the server. They may only be valid for a particular resource or set of resources.

+

Populated by the system. Read-only. Value must be treated as opaque by clients and . More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#concurrency-control-and-consistency

+

selfLink

+

String

+

SelfLink is a URL representing this object. Populated by the system. Read-only.

+

DEPRECATED Kubernetes will stop propagating this field in 1.20 release and the field is planned to be removed in 1.21 release.

+

uid

+

String

+

UID is the unique in time and space value for this object. It is typically generated by the server on successful creation of a resource and is not allowed to change on PUT operations.

+

Populated by the system. Read-only. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#uids

+
+
+ +
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Table 26 io.k8s.apimachinery.pkg.apis.meta.v1.ManagedFieldsEntry

Parameter

+

Type

+

Description

+

apiVersion

+

String

+

APIVersion defines the version of this resource that this field set applies to. The format is "group/version" just like the top-level APIVersion field. It is necessary to track the version of a field set because it cannot be automatically converted.

+

fieldsType

+

String

+

FieldsType is the discriminator for the different fields format and version. There is currently only one possible value: "FieldsV1"

+

fieldsV1

+

Object

+

FieldsV1 holds the first JSON version format as described in the "FieldsV1" type.

+

manager

+

String

+

Manager is an identifier of the workflow managing these fields.

+

operation

+

String

+

Operation is the type of operation which lead to this ManagedFieldsEntry being created. The only valid values for this field are 'Apply' and 'Update'.

+

time

+

String

+

Time is timestamp of when these fields were set. It should always be empty if Operation is 'Apply'

+
+
+ +
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Table 27 io.k8s.apimachinery.pkg.apis.meta.v1.OwnerReference

Parameter

+

Type

+

Description

+

apiVersion

+

String

+

API version of the referent.

+

blockOwnerDeletion

+

Boolean

+

If true, AND if the owner has the "foregroundDeletion" finalizer, then the owner cannot be deleted from the key-value store until this reference is removed. Defaults to false. To set this field, a user needs "delete" permission of the owner, otherwise 422 (Unprocessable Entity) will be returned.

+

controller

+

Boolean

+

If true, this reference points to the managing controller.

+

kind

+

String

+

Kind of the referent. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds

+

name

+

String

+

Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names

+

uid

+

String

+

UID of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#uids

+
+
+ +
+ + + + + + + + + +
Table 28 io.cci.otc.api.pkg.apis.versioned.cci.v2.NamespaceSpec

Parameter

+

Type

+

Description

+

finalizers

+

Array of strings

+

Finalizers is an opaque list of values that must be empty to permanently remove object from storage. More info: https://kubernetes.io/docs/tasks/administer-cluster/namespaces/

+
+
+ +
+ + + + + + + + + + + + + +
Table 29 io.cci.otc.api.pkg.apis.versioned.cci.v2.NamespaceStatus

Parameter

+

Type

+

Description

+

conditions

+

Array of io.cci.otc.api.pkg.apis.versioned.cci.v2.NamespaceCondition objects

+

Represents the latest available observations of a namespace's current state.

+

phase

+

String

+

Phase is the current lifecycle phase of the namespace. More info: https://kubernetes.io/docs/tasks/administer-cluster/namespaces/

+

Possible enum values:

+
  • "Active" means the namespace is available for use in the system
  • "Terminating" means the namespace is undergoing graceful termination
+
+
+ +
+ + + + + + + + + + + + + + + + + + + + + + + + + +
Table 30 io.cci.otc.api.pkg.apis.versioned.cci.v2.NamespaceCondition

Parameter

+

Type

+

Description

+

lastTransitionTime

+

String

+

Time is a wrapper around time.Time which supports correct marshaling to YAML and JSON. Wrappers are provided for many of the factory methods that the time package offers.

+

message

+

String

+		  

reason

+

String

+		  

status

+

String

+

Status of the condition, one of True, False, Unknown.

+

type

+

String

+

Type of namespace controller condition.

+
+
+
+

Example Requests

{
+  "apiVersion" : "cci/v2",
+  "kind" : "Namespace",
+  "metadata" : {
+    "name" : "test"
+  }
+}
+
+

Example Responses

Status code: 201

+

Created

+
{
+  "apiVersion" : "cci/v2",
+  "kind" : "Namespace",
+  "metadata" : {
+    "annotations" : {
+      "tenant.cci.io/tenant-id" : "08a2*************************c03",
+      "tenant.kubernetes.io/domain-id" : "08a*************************ee60",
+      "tenant.kubernetes.io/domain-name" : "fake-user",
+      "tenant.kubernetes.io/project-id" : "08a2*************************c03",
+      "tenant.kubernetes.io/project-name" : "region1",
+      "volcano.sh/queue-name" : "v5-queue"
+    },
+    "creationTimestamp" : "2024-10-09T11:41:54Z",
+    "labels" : {
+      "kubernetes.io/metadata.name" : "test"
+    },
+    "name" : "test",
+    "resourceVersion" : "391012875",
+    "uid" : "3c746853-0eed-4d16-b634-970e49efe97c"
+  },
+  "spec" : {
+    "finalizers" : [ "kubernetes" ]
+  },
+  "status" : {
+    "phase" : "Active"
+  }
+}
+
+

Status Codes

+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +

Status Code

+

Description

+

200

+

OK

+

201

+

Created

+

202

+

Accepted

+

400

+

BadRequest

+

401

+

Unauthorized

+

403

+

Forbidden

+

404

+

NotFound

+

405

+

MethodNotAllowed

+

406

+

NotAcceptable

+

409

+

AlreadyExists

+

415

+

UnsupportedMediaType

+

422

+

Invalid

+

429

+

TooManyRequests

+

500

+

InternalError

+

503

+

ServiceUnavailable

+

504

+

ServerTimeout

+
+
+
+
+
+
+
Parent topic: Proprietary APIs
+
+
+ diff --git a/docs/cci/api-ref/createCciV2NamespacedConfigMap.html b/docs/cci/api-ref/createCciV2NamespacedConfigMap.html new file mode 100644 index 00000000..a5682838 --- /dev/null +++ b/docs/cci/api-ref/createCciV2NamespacedConfigMap.html @@ -0,0 +1,1545 @@ + + +

Creating a ConfigMap

+

Function

Create a ConfigMap.

+
+

Calling Method

For details, see Calling APIs.

+
+

URI

POST /apis/cci/v2/namespaces/{namespace}/configmaps

+ +
+ + + + + + + + + + + +
Table 1 Path Parameters

Parameter

+

Mandatory

+

Type

+

Description

+

namespace

+

Yes

+

String

+

Object name and auth scope, such as for teams and projects.

+
+
+ +
+ + + + + + + + + + + + + + + + + + + + + +
Table 2 Query Parameters

Parameter

+

Mandatory

+

Type

+

Description

+

dryRun

+

No

+

String

+

When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed

+

fieldManager

+

No

+

String

+

fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint.

+

pretty

+

No

+

String

+

If 'true', then the output is pretty printed.

+
+
+
+

Request Parameters

+
+ + + + + + + + + + + + + + + + +
Table 3 Request header parameters

Parameter

+

Mandatory

+

Type

+

Description

+

X-Auth-Token

+

Yes

+

String

+

User token.

+

It can be obtained through the IAM API used to obtain a user token. The value of X-Subject-Token in the response header is the user token.

+

Content-Type

+

Yes

+

String

+

The type of the message body, with a default value of "application/JSON".

+
+
+ +
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Table 4 Request body parameters

Parameter

+

Mandatory

+

Type

+

Description

+

apiVersion

+

No

+

String

+

apiVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#resources

+

binaryData

+

No

+

Map<String,String>

+

binaryData contains the binary data. Each key must consist of alphanumeric characters, '-', '_' or '.'. BinaryData can contain byte sequences that are not in the UTF-8 range. The keys stored in BinaryData must not overlap with the ones in the Data field, this is enforced during validation process. Using this field will require 1.10+ apiserver and kubelet.

+

+

+

+

data

+

No

+

Map<String,String>

+

Data contains the configuration data. Each key must consist of alphanumeric characters, '-', '_' or '.'. Values with non-UTF-8 byte sequences must use the BinaryData field. The keys stored in Data must not overlap with the keys in the BinaryData field, this is enforced during validation process.

+

immutable

+

No

+

Boolean

+

Immutable, if set to true, ensures that data stored in the ConfigMap cannot be updated (only object metadata can be modified). If not set to true, the field can be modified at any time. Defaulted to nil.

+

kind

+

No

+

String

+

Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds

+

metadata

+

No

+

io.k8s.apimachinery.pkg.apis.meta.v1.ObjectMeta object

+

Standard object's metadata. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata

+
+
+ +
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Table 5 io.k8s.apimachinery.pkg.apis.meta.v1.ObjectMeta

Parameter

+

Mandatory

+

Type

+

Description

+

annotations

+

No

+

Map<String,String>

+

Annotations is an unstructured key value map stored with a resource that may be set by external tools to store and retrieve arbitrary metadata. They are not queryable and should be preserved when modifying objects. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/annotations/

+

clusterName

+

No

+

String

+

The name of the cluster which the object belongs to. This is used to distinguish resources with same name and namespace in different clusters. This field is not set anywhere right now and apiserver is going to ignore it if set in create or update request.

+

creationTimestamp

+

No

+

String

+

CreationTimestamp is a timestamp representing the server time when this object was created. It is not guaranteed to be set in happens-before order across separate operations. Clients may not set this value. It is represented in RFC3339 form and is in UTC.

+

Populated by the system. Read-only. Null for lists. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata

+

deletionGracePeriodSeconds

+

No

+

Long

+

Number of seconds allowed for this object to gracefully terminate

+

before it will be removed from the system. Only set when deletionTimestamp is also set. May only be shortened. Read-only.

+

deletionTimestamp

+

No

+

String

+

DeletionTimestamp is RFC 3339 date and time at which this resource will be deleted. This field is set by the server when a graceful deletion is requested by the user, and is not directly settable by a client. The resource is expected to be deleted (no longer visible from resource lists, and not reachable by name) after the time in this field, once the finalizers list is empty. As long as the finalizers list contains items, deletion is blocked. Once the deletionTimestamp is set, this value may not be unset or be set further into the future, although it may be shortened or the resource may be deleted prior to this time. For example, a user may request that a pod is deleted in 30 seconds. The Kubelet will react by sending a graceful termination signal to the containers in the pod. After that 30 seconds, the Kubelet will send a hard termination signal (SIGKILL) to the container and after cleanup, remove the pod from the API. In the presence of network partitions, this object may still exist after this timestamp, until an administrator or automated process can determine the resource is fully terminated. If not set, graceful deletion of the object has not been requested.

+

Populated by the system when a graceful deletion is requested. Read-only. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata

+

enable

+

No

+

Boolean

+

Enable identifies whether the resource is available.

+

finalizers

+

No

+

Array of strings

+

Must be empty before the object is deleted from the registry.

+

Each entry is an identifier for the responsible component that will remove the entry from the list. If the deletionTimestamp of the object is non-nil,

+

entries in this list can only be removed. Finalizers may be processed and removed in any order. Order is NOT enforced because it introduces significant risk of stuck finalizers. finalizers is a shared field, any actor with permission can reorder it. If the finalizer list is processed in order, then this can

+

lead to a situation in which the component responsible for the first finalizer in the list is waiting for a signal (field value, external system, or other) produced by a component responsible for a finalizer later in the list, resulting in a deadlock. Without enforced ordering finalizers are free to order amongst themselves and are not vulnerable to ordering changes in the list.

+

generateName

+

No

+

String

+

GenerateName is an optional prefix, used by the server, to generate a unique name ONLY IF the Name field has not been provided. If this field is used, the name returned to the client will be different than the name passed. This value will also be combined with a unique suffix. The provided value has the same validation rules as the Name field, and may be truncated by the length of the suffix required to make the value unique on the server.

+

If this field is specified and the generated name exists, the server will NOT return a 409 - instead, it will either return 201 Created or 500 with Reason ServerTimeout indicating a unique name could not be found in the time allotted, and the client should retry (optionally after the time indicated in the Retry-After header).

+

Applied only if Name is not specified. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#idempotency

+

generation

+

No

+

Long

+

A sequence number representing a specific generation of the desired

+

state. Populated by the system. Read-only.

+

labels

+

No

+

Map<String,String>

+

Map of string keys and values that can be used to organize and categorize (scope and select) objects. May match selectors of replication controllers and services. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/labels/

+

managedFields

+

No

+

Array of io.k8s.apimachinery.pkg.apis.meta.v1.ManagedFieldsEntry objects

+

ManagedFields maps workflow-id and version to the set of fields that are managed by that workflow. This is mostly for internal housekeeping, and users typically shouldn't need to set or understand this field. A workflow can be the user's name, a controller's name, or the name of a specific applypath like "ci-cd". The set of fields is always in the version that the workflow used when modifying the object.

+

name

+

No

+

String

+

Name must be unique within a namespace. Is required when creating resources, although some resources may allow a client to request the generation of an appropriate name automatically. Name is primarily intended for creation idempotence and configuration definition. Cannot be updated. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names

+

namespace

+

No

+

String

+

Namespace defines the space within which each name must be unique. An empty namespace is equivalent to the "default" namespace, but "default" is the canonical representation. Not all objects are required to be scoped to a namespace - the value of this field for those objects will be empty.

+

Must be a DNS_LABEL. Cannot be updated. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/namespaces/

+

ownerReferences

+

No

+

Array of io.k8s.apimachinery.pkg.apis.meta.v1.OwnerReference objects

+

List of objects depended by this object. If ALL objects in the list have been deleted, this object will be garbage collected. If this object is managed by a controller, then an entry in this list will point to this controller, with the controller field set to true. There cannot be more than one managing controller.

+

resourceVersion

+

No

+

String

+

An opaque value that represents the internal version of this object that can be used by clients to determine when objects have changed. May be used for optimistic concurrency, change detection, and the watch operation on a resource or set of resources. Clients must treat these values as opaque and passed unmodified back to the server. They may only be valid for a particular resource or set of resources.

+

Populated by the system. Read-only. Value must be treated as opaque by clients and . More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#concurrency-control-and-consistency

+

selfLink

+

No

+

String

+

SelfLink is a URL representing this object. Populated by the system. Read-only.

+

DEPRECATED Kubernetes will stop propagating this field in 1.20 release and the field is planned to be removed in 1.21 release.

+

uid

+

No

+

String

+

UID is the unique in time and space value for this object. It is typically generated by the server on successful creation of a resource and is not allowed to change on PUT operations.

+

Populated by the system. Read-only. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#uids

+
+
+ +
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Table 6 io.k8s.apimachinery.pkg.apis.meta.v1.ManagedFieldsEntry

Parameter

+

Mandatory

+

Type

+

Description

+

apiVersion

+

No

+

String

+

APIVersion defines the version of this resource that this field set applies to. The format is "group/version" just like the top-level APIVersion field. It is necessary to track the version of a field set because it cannot be automatically converted.

+

fieldsType

+

No

+

String

+

FieldsType is the discriminator for the different fields format and version. There is currently only one possible value: "FieldsV1"

+

fieldsV1

+

No

+

Object

+

FieldsV1 holds the first JSON version format as described in the "FieldsV1" type.

+

manager

+

No

+

String

+

Manager is an identifier of the workflow managing these fields.

+

operation

+

No

+

String

+

Operation is the type of operation which lead to this ManagedFieldsEntry being created. The only valid values for this field are 'Apply' and 'Update'.

+

time

+

No

+

String

+

Time is timestamp of when these fields were set. It should always be empty if Operation is 'Apply'.

+
+
+ +
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Table 7 io.k8s.apimachinery.pkg.apis.meta.v1.OwnerReference

Parameter

+

Mandatory

+

Type

+

Description

+

apiVersion

+

Yes

+

String

+

API version of the referent.

+

blockOwnerDeletion

+

No

+

Boolean

+

If true, AND if the owner has the "foregroundDeletion" finalizer, then the owner cannot be deleted from the key-value store until this reference is removed. Defaults to false. To set this field, a user needs "delete"permission of the owner, otherwise 422 (Unprocessable Entity) will be returned.

+

controller

+

No

+

Boolean

+

If true, this reference points to the managing controller.

+

kind

+

Yes

+

String

+

Kind of the referent. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds

+

name

+

Yes

+

String

+

Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names

+

uid

+

Yes

+

String

+

UID of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#uids

+
+
+
+

Response Parameters

Status code: 200

+ +
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Table 8 Response body parameters

Parameter

+

Type

+

Description

+

apiVersion

+

String

+

APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#resources

+

binaryData

+

Map<String,String>

+

BinaryData contains the binary data. Each key must consist of alphanumeric characters, '-', '_' or '.'. BinaryData can contain byte sequences that are not in the UTF-8 range. The keys stored in BinaryData must not overlap with the ones in the Data field, this is enforced during validation process. Using this field will require 1.10+ apiserver and kubelet.

+

data

+

Map<String,String>

+

Data contains the configuration data. Each key must consist of alphanumeric characters, '-', '_' or '.'. Values with non-UTF-8 byte sequences must use the BinaryData field. The keys stored in Data must not overlap with the keys in the BinaryData field, this is enforced during validation process.

+

immutable

+

Boolean

+

Immutable, if set to true, ensures that data stored in the ConfigMap cannot be updated (only object metadata can be modified). If not set to true, the field can be modified at any time. Defaulted to nil.

+

kind

+

String

+

Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds

+

metadata

+

io.k8s.apimachinery.pkg.apis.meta.v1.ObjectMeta object

+

Standard object's metadata. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata

+
+
+ +
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Table 9 io.k8s.apimachinery.pkg.apis.meta.v1.ObjectMeta

Parameter

+

Type

+

Description

+

annotations

+

Map<String,String>

+

Annotations is an unstructured key value map stored with a resource that may be set by external tools to store and retrieve arbitrary metadata. They are not queryable and should be preserved when modifying objects. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/annotations/

+

clusterName

+

String

+

The name of the cluster which the object belongs to. This is used to distinguish resources with same name and namespace in different clusters. This field is not set anywhere right now and apiserver is going to ignore it if set in create or update request.

+

creationTimestamp

+

String

+

CreationTimestamp is a timestamp representing the server time when this object was created. It is not guaranteed to be set in happens-before order across separate operations. Clients may not set this value. It is represented in RFC3339 form and is in UTC.

+

Populated by the system. Read-only. Null for lists. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata

+

deletionGracePeriodSeconds

+

Long

+

Number of seconds allowed for this object to gracefully terminate before it will be removed from the system. Only set when deletionTimestamp is also set. May only be shortened. Read-only.

+

deletionTimestamp

+

String

+

DeletionTimestamp is RFC 3339 date and time at which this resource will be deleted. This field is set by the server when a graceful deletion is requested by the user, and is not directly settable by a client. The resource is expected to be deleted (no longer visible from resource lists, and not reachable by name) after the time in this field, once the finalizers list is empty. As long as the finalizers list contains items, deletion is blocked. Once the deletionTimestamp is set, this value may not be unset or be set further into the future, although it may be shortened or the resource may be deleted prior to this time. For example, a user may request that a pod is deleted in 30 seconds. The Kubelet will react by sending a graceful termination signal to the containers in the pod. After that 30 seconds, the Kubelet will send a hard termination signal (SIGKILL) to the container and after cleanup, remove the pod from the API. In the presence of network partitions, this object may still exist after this timestamp, until an administrator or automated process can determine the resource is fully terminated. If not set, graceful deletion of the object has not been requested.

+

Populated by the system when a graceful deletion is requested. Read-only. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata

+

enable

+

Boolean

+

Enable identifies whether the resource is available.

+

finalizers

+

Array of strings

+

Must be empty before the object is deleted from the registry.

+

Each entry is an identifier for the responsible component that will remove the entry from the list. If the deletionTimestamp of the object is non-nil, entries in this list can only be removed. Finalizers may be processed and removed in any order. Order is NOT enforced because it introduces significant risk of stuck finalizers. finalizers is a shared field, any actor with permission can reorder it. If the finalizer list is processed in order, then this can lead to a situation in which the component responsible for the first finalizer in the list is waiting for a signal (field value, external system, or other) produced by a component responsible for a finalizer later in the list, resulting in a deadlock. Without enforced ordering finalizers are free to order amongst themselves and are not vulnerable to ordering changes in the list.

+

generateName

+

String

+

GenerateName is an optional prefix, used by the server, to generate a unique name ONLY IF the Name field has not been provided. If this field is used, the name returned to the client will be different than the name passed. This value will also be combined with a unique suffix. The provided value has the same validation rules as the Name field, and may be truncated by the length of the suffix required to make the value unique on the server.

+

If this field is specified and the generated name exists, the server will NOT return a 409 - instead, it will either return 201 Created or 500 with Reason ServerTimeout indicating a unique name could not be found in the time allotted, and the client should retry (optionally after the time indicated in the Retry-After header).

+

Applied only if Name is not specified. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#idempotency

+

generation

+

Long

+

A sequence number representing a specific generation of the desired state. Populated by the system. Read-only.

+

labels

+

Map<String,String>

+

Map of string keys and values that can be used to organize and categorize (scope and select) objects. May match selectors of replication controllers and services. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/labels/

+

managedFields

+

Array of io.k8s.apimachinery.pkg.apis.meta.v1.ManagedFieldsEntry objects

+

ManagedFields maps workflow-id and version to the set of fields that are managed by that workflow. This is mostly for internal housekeeping, and users typically shouldn't need to set or understand this field. A workflow can be the user's name, a controller's name, or the name of a specific apply path like "ci-cd". The set of fields is always in the version that the workflow used when modifying the object.

+

name

+

String

+

Name must be unique within a namespace. Is required when creating resources, although some resources may allow a client to request the generation of an appropriate name automatically. Name is primarily intended for creation idempotence and configuration definition. Cannot be updated. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names

+

namespace

+

String

+

Namespace defines the space within which each name must be unique. An empty namespace is equivalent to the "default" namespace, but "default" is the canonical representation. Not all objects are required to be scoped to a namespace - the value of this field for those objects will be empty.

+

Must be a DNS_LABEL. Cannot be updated. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/namespaces/

+

ownerReferences

+

Array of io.k8s.apimachinery.pkg.apis.meta.v1.OwnerReference objects

+

List of objects depended by this object. If ALL objects in the list have been deleted, this object will be garbage collected. If this object is managed by a controller, then an entry in this list will point to this controller, with the controller field set to true. There cannot be more than one managing controller.

+

resourceVersion

+

String

+

An opaque value that represents the internal version of this object that can be used by clients to determine when objects have changed. May be used for optimistic concurrency, change detection, and the watch operation on a resource or set of resources. Clients must treat these values as opaque and passed unmodified back to the server. They may only be valid for a particular resource or set of resources.

+

Populated by the system. Read-only. Value must be treated as opaque by clients and . More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#concurrency-control-and-consistency

+

selfLink

+

String

+

SelfLink is a URL representing this object. Populated by the system. Read-only.

+

DEPRECATED Kubernetes will stop propagating this field in 1.20 release and the field is planned to be removed in 1.21 release.

+

uid

+

String

+

UID is the unique in time and space value for this object. It is typically generated by the server on successful creation of a resource and is not allowed to change on PUT operations.

+

Populated by the system. Read-only. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#uids

+
+
+ +
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Table 10 io.k8s.apimachinery.pkg.apis.meta.v1.ManagedFieldsEntry

Parameter

+

Type

+

Description

+

apiVersion

+

String

+

APIVersion defines the version of this resource that this field set applies to. The format is "group/version" just like the top-level APIVersion field. It is necessary to track the version of a field set because it cannot be automatically converted.

+

fieldsType

+

String

+

FieldsType is the discriminator for the different fields format and version. There is currently only one possible value: "FieldsV1"

+

fieldsV1

+

Object

+

FieldsV1 holds the first JSON version format as described in the "FieldsV1" type.

+

manager

+

String

+

Manager is an identifier of the workflow managing these fields.

+

operation

+

String

+

Operation is the type of operation which lead to this ManagedFieldsEntry being created. The only valid values for this field are 'Apply' and 'Update'.

+

time

+

String

+

Time is timestamp of when these fields were set. It should always be empty if Operation is 'Apply'.

+
+
+ +
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Table 11 io.k8s.apimachinery.pkg.apis.meta.v1.OwnerReference

Parameter

+

Type

+

Description

+

apiVersion

+

String

+

API version of the referent.

+

blockOwnerDeletion

+

Boolean

+

If true, AND if the owner has the "foregroundDeletion" finalizer, then the owner cannot be deleted from the key-value store until this reference is removed. Defaults to false. To set this field, a user needs "delete" permission of the owner, otherwise 422 (Unprocessable Entity) will be returned.

+

controller

+

Boolean

+

If true, this reference points to the managing controller.

+

kind

+

String

+

Kind of the referent. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds

+

name

+

String

+

Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names

+

uid

+

String

+

UID of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#uids

+
+
+

Status code: 201

+ +
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Table 12 Response body parameters

Parameter

+

Type

+

Description

+

apiVersion

+

String

+

APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#resources

+

binaryData

+

Map<String,String>

+

BinaryData contains the binary data. Each key must consist of alphanumeric characters, '-', '_' or '.'. BinaryData can contain byte sequences that are not in the UTF-8 range. The keys stored in BinaryData must not overlap with the ones in the Data field, this is enforced during validation process. Using this field will require 1.10+ apiserver and kubelet.

+

data

+

Map<String,String>

+

Data contains the configuration data. Each key must consist of alphanumeric characters, '-', '_' or '.'. Values with non-UTF-8 byte sequences must use the BinaryData field. The keys stored in Data must not overlap with the keys in the BinaryData field, this is enforced during validation process.

+

immutable

+

Boolean

+

Immutable, if set to true, ensures that data stored in the ConfigMap cannot be updated (only object metadata can be modified). If not set to true, the field can be modified at any time. Defaulted to nil.

+

kind

+

String

+

Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds

+

metadata

+

io.k8s.apimachinery.pkg.apis.meta.v1.ObjectMeta object

+

Standard object's metadata. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata

+
+
+ +
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Table 13 io.k8s.apimachinery.pkg.apis.meta.v1.ObjectMeta

Parameter

+

Type

+

Description

+

annotations

+

Map<String,String>

+

Annotations is an unstructured key value map stored with a resource that may be set by external tools to store and retrieve arbitrary metadata. They are not queryable and should be preserved when modifying objects. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/annotations/

+

clusterName

+

String

+

The name of the cluster which the object belongs to. This is used to distinguish resources with same name and namespace in different clusters. This field is not set anywhere right now and apiserver is going to ignore it if set in create or update request.

+

creationTimestamp

+

String

+

CreationTimestamp is a timestamp representing the server time when this object was created. It is not guaranteed to be set in happens-before order across separate operations. Clients may not set this value. It is represented in RFC3339 form and is in UTC.

+

Populated by the system. Read-only. Null for lists. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata

+

deletionGracePeriodSeconds

+

Long

+

Number of seconds allowed for this object to gracefully terminate before it will be removed from the system. Only set when deletionTimestamp is also set. May only be shortened. Read-only.

+

deletionTimestamp

+

String

+

DeletionTimestamp is RFC 3339 date and time at which this resource will be deleted. This field is set by the server when a graceful deletion is requested by the user, and is not directly settable by a client. The resource is expected to be deleted (no longer visible from resource lists, and not reachable by name) after the time in this field, once the finalizers list is empty. As long as the finalizers list contains items, deletion is blocked. Once the deletionTimestamp is set, this value may not be unset or be set further into the future, although it may be shortened or the resource may be deleted prior to this time. For example, a user may request that a pod is deleted in 30 seconds. The Kubelet will react by sending a graceful termination signal to the containers in the pod. After that 30 seconds, the Kubelet will send a hard termination signal (SIGKILL) to the container and after cleanup, remove the pod from the API. In the presence of network partitions, this object may still exist after this timestamp, until an administrator or automated process can determine the resource is fully terminated. If not set, graceful deletion of the object has not been requested.

+

Populated by the system when a graceful deletion is requested. Read-only. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata

+

enable

+

Boolean

+

Enable identifies whether the resource is available.

+

finalizers

+

Array of strings

+

Must be empty before the object is deleted from the registry.

+

Each entry is an identifier for the responsible component that will remove the entry from the list. If the deletionTimestamp of the object is non-nil, entries in this list can only be removed. Finalizers may be processed and removed in any order. Order is NOT enforced because it introduces significant risk of stuck finalizers. finalizers is a shared field, any actor with permission can reorder it. If the finalizer list is processed in order, then this can lead to a situation in which the component responsible for the first finalizer in the list is waiting for a signal (field value, external system, or other) produced by a component responsible for a finalizer later in the list, resulting in a deadlock. Without enforced ordering finalizers are free to order amongst themselves and are not vulnerable to ordering changes in the list.

+

generateName

+

String

+

GenerateName is an optional prefix, used by the server, to generate a unique name ONLY IF the Name field has not been provided. If this field is used, the name returned to the client will be different than the name passed. This value will also be combined with a unique suffix. The provided value has the same validation rules as the Name field, and may be truncated by the length of the suffix required to make the value unique on the server.

+

If this field is specified and the generated name exists, the server will NOT return a 409 - instead, it will either return 201 Created or 500 with Reason ServerTimeout indicating a unique name could not be found in the time allotted, and the client should retry (optionally after the time indicated in the Retry-After header).

+

Applied only if Name is not specified. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#idempotency

+

generation

+

Long

+

A sequence number representing a specific generation of the desired state. Populated by the system. Read-only.

+

labels

+

Map<String,String>

+

Map of string keys and values that can be used to organize and categorize (scope and select) objects. May match selectors of replication controllers and services. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/labels/

+

managedFields

+

Array of io.k8s.apimachinery.pkg.apis.meta.v1.ManagedFieldsEntry objects

+

ManagedFields maps workflow-id and version to the set of fields that are managed by that workflow. This is mostly for internal housekeeping, and users typically shouldn't need to set or understand this field. A workflow can be the user's name, a controller's name, or the name of a specific apply path like "ci-cd". The set of fields is always in the version that the workflow used when modifying the object.

+

name

+

String

+

Name must be unique within a namespace. Is required when creating resources, although some resources may allow a client to request the generation of an appropriate name automatically. Name is primarily intended for creation idempotence and configuration definition. Cannot be updated. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names

+

namespace

+

String

+

Namespace defines the space within which each name must be unique. An empty namespace is equivalent to the "default" namespace, but "default" is the canonical representation. Not all objects are required to be scoped to a namespace - the value of this field for those objects will be empty.

+

Must be a DNS_LABEL. Cannot be updated. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/namespaces/

+

ownerReferences

+

Array of io.k8s.apimachinery.pkg.apis.meta.v1.OwnerReference objects

+

List of objects depended by this object. If ALL objects in the list have been deleted, this object will be garbage collected. If this object is managed by a controller, then an entry in this list will point to this controller, with the controller field set to true. There cannot be more than one managing controller.

+

resourceVersion

+

String

+

An opaque value that represents the internal version of this object that can be used by clients to determine when objects have changed. May be used for optimistic concurrency, change detection, and the watch operation on a resource or set of resources. Clients must treat these values as opaque and passed unmodified back to the server. They may only be valid for a particular resource or set of resources.

+

Populated by the system. Read-only. Value must be treated as opaque by clients and . More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#concurrency-control-and-consistency

+

selfLink

+

String

+

SelfLink is a URL representing this object. Populated by the system. Read-only.

+

DEPRECATED Kubernetes will stop propagating this field in 1.20 release and the field is planned to be removed in 1.21 release.

+

uid

+

String

+

UID is the unique in time and space value for this object. It is typically generated by the server on successful creation of a resource and is not allowed to change on PUT operations.

+

Populated by the system. Read-only. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#uids

+
+
+ +
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Table 14 io.k8s.apimachinery.pkg.apis.meta.v1.ManagedFieldsEntry

Parameter

+

Type

+

Description

+

apiVersion

+

String

+

APIVersion defines the version of this resource that this field set applies to. The format is "group/version" just like the top-level APIVersion field. It is necessary to track the version of a field set because it cannot be automatically converted.

+

fieldsType

+

String

+

FieldsType is the discriminator for the different fields format and version. There is currently only one possible value: "FieldsV1"

+

fieldsV1

+

Object

+

FieldsV1 holds the first JSON version format as described in the "FieldsV1" type.

+

manager

+

String

+

Manager is an identifier of the workflow managing these fields.

+

operation

+

String

+

Operation is the type of operation which lead to this ManagedFieldsEntry being created. The only valid values for this field are 'Apply' and 'Update'.

+

time

+

String

+

Time is timestamp of when these fields were set. It should always be empty if Operation is 'Apply'.

+
+
+ +
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Table 15 io.k8s.apimachinery.pkg.apis.meta.v1.OwnerReference

Parameter

+

Type

+

Description

+

apiVersion

+

String

+

API version of the referent.

+

blockOwnerDeletion

+

Boolean

+

If true, AND if the owner has the "foregroundDeletion" finalizer, then the owner cannot be deleted from the key-value store until this reference is removed. Defaults to false. To set this field, a user needs "delete" permission of the owner, otherwise 422 (Unprocessable Entity) will be returned.

+

controller

+

Boolean

+

If true, this reference points to the managing controller.

+

kind

+

String

+

Kind of the referent. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds

+

name

+

String

+

Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names

+

uid

+

String

+

UID of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#uids

+
+
+

Status code: 202

+ +
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Table 16 Response body parameters

Parameter

+

Type

+

Description

+

apiVersion

+

String

+

APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#resources

+

binaryData

+

Map<String,String>

+

BinaryData contains the binary data. Each key must consist of alphanumeric characters, '-', '_' or '.'. BinaryData can contain byte sequences that are not in the UTF-8 range. The keys stored in BinaryData must not overlap with the ones in the Data field, this is enforced during validation process. Using this field will require 1.10+ apiserver and kubelet.

+

data

+

Map<String,String>

+

Data contains the configuration data. Each key must consist of alphanumeric characters, '-', '_' or '.'. Values with non-UTF-8 byte sequences must use the BinaryData field. The keys stored in Data must not overlap with the keys in the BinaryData field, this is enforced during validation process.

+

immutable

+

Boolean

+

Immutable, if set to true, ensures that data stored in the ConfigMap cannot be updated (only object metadata can be modified). If not set to true, the field can be modified at any time. Defaulted to nil.

+

kind

+

String

+

Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds

+

metadata

+

io.k8s.apimachinery.pkg.apis.meta.v1.ObjectMeta object

+

Standard object's metadata. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata

+
+
+ +
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Table 17 io.k8s.apimachinery.pkg.apis.meta.v1.ObjectMeta

Parameter

+

Type

+

Description

+

annotations

+

Map<String,String>

+

Annotations is an unstructured key value map stored with a resource that may be set by external tools to store and retrieve arbitrary metadata. They are not queryable and should be preserved when modifying objects. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/annotations/

+

clusterName

+

String

+

The name of the cluster which the object belongs to. This is used to distinguish resources with same name and namespace in different clusters. This field is not set anywhere right now and apiserver is going to ignore it if set in create or update request.

+

creationTimestamp

+

String

+

CreationTimestamp is a timestamp representing the server time when this object was created. It is not guaranteed to be set in happens-before order across separate operations. Clients may not set this value. It is represented in RFC3339 form and is in UTC.

+

Populated by the system. Read-only. Null for lists. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata

+

deletionGracePeriodSeconds

+

Long

+

Number of seconds allowed for this object to gracefully terminate before it will be removed from the system. Only set when deletionTimestamp is also set. May only be shortened. Read-only.

+

deletionTimestamp

+

String

+

DeletionTimestamp is RFC 3339 date and time at which this resource will be deleted. This field is set by the server when a graceful deletion is requested by the user, and is not directly settable by a client. The resource is expected to be deleted (no longer visible from resource lists, and not reachable by name) after the time in this field, once the finalizers list is empty. As long as the finalizers list contains items, deletion is blocked. Once the deletionTimestamp is set, this value may not be unset or be set further into the future, although it may be shortened or the resource may be deleted prior to this time. For example, a user may request that a pod is deleted in 30 seconds. The Kubelet will react by sending a graceful termination signal to the containers in the pod. After that 30 seconds, the Kubelet will send a hard termination signal (SIGKILL) to the container and after cleanup, remove the pod from the API. In the presence of network partitions, this object may still exist after this timestamp, until an administrator or automated process can determine the resource is fully terminated. If not set, graceful deletion of the object has not been requested.

+

Populated by the system when a graceful deletion is requested. Read-only. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata

+

enable

+

Boolean

+

Enable identifies whether the resource is available.

+

finalizers

+

Array of strings

+

Must be empty before the object is deleted from the registry.

+

Each entry is an identifier for the responsible component that will remove the entry from the list. If the deletionTimestamp of the object is non-nil, entries in this list can only be removed. Finalizers may be processed and removed in any order. Order is NOT enforced because it introduces significant risk of stuck finalizers. finalizers is a shared field, any actor with permission can reorder it. If the finalizer list is processed in order, then this can lead to a situation in which the component responsible for the first finalizer in the list is waiting for a signal (field value, external system, or other) produced by a component responsible for a finalizer later in the list, resulting in a deadlock. Without enforced ordering finalizers are free to order amongst themselves and are not vulnerable to ordering changes in the list.

+

generateName

+

String

+

GenerateName is an optional prefix, used by the server, to generate a unique name ONLY IF the Name field has not been provided. If this field is used, the name returned to the client will be different than the name passed. This value will also be combined with a unique suffix. The provided value has the same validation rules as the Name field, and may be truncated by the length of the suffix required to make the value unique on the server.

+

If this field is specified and the generated name exists, the server will NOT return a 409 - instead, it will either return 201 Created or 500 with Reason ServerTimeout indicating a unique name could not be found in the time allotted, and the client should retry (optionally after the time indicated in the Retry-After header).

+

Applied only if Name is not specified. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#idempotency

+

generation

+

Long

+

A sequence number representing a specific generation of the desired state. Populated by the system. Read-only.

+

labels

+

Map<String,String>

+

Map of string keys and values that can be used to organize and categorize (scope and select) objects. May match selectors of replication controllers and services. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/labels/

+

managedFields

+

Array of io.k8s.apimachinery.pkg.apis.meta.v1.ManagedFieldsEntry objects

+

ManagedFields maps workflow-id and version to the set of fields that are managed by that workflow. This is mostly for internal housekeeping, and users typically shouldn't need to set or understand this field. A workflow can be the user's name, a controller's name, or the name of a specific apply path like "ci-cd". The set of fields is always in the version that the workflow used when modifying the object.

+

name

+

String

+

Name must be unique within a namespace. Is required when creating resources, although some resources may allow a client to request the generation of an appropriate name automatically. Name is primarily intended for creation idempotence and configuration definition. Cannot be updated. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names

+

namespace

+

String

+

Namespace defines the space within which each name must be unique. An empty namespace is equivalent to the "default" namespace, but "default" is the canonical representation. Not all objects are required to be scoped to a namespace - the value of this field for those objects will be empty.

+

Must be a DNS_LABEL. Cannot be updated. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/namespaces/

+

ownerReferences

+

Array of io.k8s.apimachinery.pkg.apis.meta.v1.OwnerReference objects

+

List of objects depended by this object. If ALL objects in the list have been deleted, this object will be garbage collected. If this object is managed by a controller, then an entry in this list will point to this controller, with the controller field set to true. There cannot be more than one managing controller.

+

resourceVersion

+

String

+

An opaque value that represents the internal version of this object that can be used by clients to determine when objects have changed. May be used for optimistic concurrency, change detection, and the watch operation on a resource or set of resources. Clients must treat these values as opaque and passed unmodified back to the server. They may only be valid for a particular resource or set of resources.

+

Populated by the system. Read-only. Value must be treated as opaque by clients and . More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#concurrency-control-and-consistency

+

selfLink

+

String

+

SelfLink is a URL representing this object. Populated by the system. Read-only.

+

DEPRECATED Kubernetes will stop propagating this field in 1.20 release and the field is planned to be removed in 1.21 release.

+

uid

+

String

+

UID is the unique in time and space value for this object. It is typically generated by the server on successful creation of a resource and is not allowed to change on PUT operations.

+

Populated by the system. Read-only. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#uids

+
+
+ +
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Table 18 io.k8s.apimachinery.pkg.apis.meta.v1.ManagedFieldsEntry

Parameter

+

Type

+

Description

+

apiVersion

+

String

+

APIVersion defines the version of this resource that this field set applies to. The format is "group/version" just like the top-level APIVersion field. It is necessary to track the version of a field set because it cannot be automatically converted.

+

fieldsType

+

String

+

FieldsType is the discriminator for the different fields format and version. There is currently only one possible value: "FieldsV1"

+

fieldsV1

+

Object

+

FieldsV1 holds the first JSON version format as described in the "FieldsV1" type.

+

manager

+

String

+

Manager is an identifier of the workflow managing these fields.

+

operation

+

String

+

Operation is the type of operation which lead to this ManagedFieldsEntry being created. The only valid values for this field are 'Apply' and 'Update'.

+

time

+

String

+

Time is timestamp of when these fields were set. It should always be empty if Operation is 'Apply'

+
+
+ +
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Table 19 io.k8s.apimachinery.pkg.apis.meta.v1.OwnerReference

Parameter

+

Type

+

Description

+

apiVersion

+

String

+

API version of the referent.

+

blockOwnerDeletion

+

Boolean

+

If true, AND if the owner has the "foregroundDeletion" finalizer, then the owner cannot be deleted from the key-value store until this reference is removed. Defaults to false. To set this field, a user needs "delete" permission of the owner, otherwise 422 (Unprocessable Entity) will be returned.

+

controller

+

Boolean

+

If true, this reference points to the managing controller.

+

kind

+

String

+

Kind of the referent. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds

+

name

+

String

+

Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names

+

uid

+

String

+

UID of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#uids

+
+
+
+

Example Requests

{
+  "apiVersion" : "cci/v2",
+  "data" : {
+    "key1" : "value1",
+    "key2" : "value2"
+  },
+  "kind" : "ConfigMap",
+  "metadata" : {
+    "labels" : {
+      "usage" : "just-for-test"
+    },
+    "name" : "test-cm"
+  }
+}
+
+

Example Responses

Status code: 201

+

Created

+
{
+  "apiVersion" : "cci/v2",
+  "data" : {
+    "key1" : "value1",
+    "key2" : "value2"
+  },
+  "kind" : "ConfigMap",
+  "metadata" : {
+    "annotations" : {
+      "tenant.cci.io/tenant-id" : "08a2*************************c03"
+    },
+    "creationTimestamp" : "2024-10-09T12:05:03Z",
+    "labels" : {
+      "sys_enterprise_project_id" : "0",
+      "tenant.cci.io/tenant-id" : "08a2*************************c03",
+      "tenant.kubernetes.io/domain-id" : "08a*************************ee60",
+      "tenant.kubernetes.io/project-id" : "08a2*************************c03",
+      "usage" : "just-for-test"
+    },
+    "name" : "test-cm",
+    "namespace" : "wbtest4",
+    "resourceVersion" : "391020615",
+    "uid" : "7c6f7981-78bb-42ff-b659-b8b4cbcbab5e"
+  }
+}
+
+

Status Codes

+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +

Status Code

+

Description

+

200

+

OK

+

201

+

Created

+

202

+

Accepted

+

400

+

BadRequest

+

401

+

Unauthorized

+

403

+

Forbidden

+

404

+

NotFound

+

405

+

MethodNotAllowed

+

406

+

NotAcceptable

+

409

+

AlreadyExists

+

415

+

UnsupportedMediaType

+

422

+

Invalid

+

429

+

TooManyRequests

+

500

+

InternalError

+

503

+

ServiceUnavailable

+

504

+

ServerTimeout

+
+
+
+
+
+
+
Parent topic: Proprietary APIs
+
+
+ diff --git a/docs/cci/api-ref/createCciV2NamespacedPod.html b/docs/cci/api-ref/createCciV2NamespacedPod.html new file mode 100644 index 00000000..108b589d --- /dev/null +++ b/docs/cci/api-ref/createCciV2NamespacedPod.html @@ -0,0 +1,14623 @@ + + +

Creating a Pod

+

Function

Create a Pod.

+
+

Calling Method

For details, see Calling APIs.

+
+

URI

POST /apis/cci/v2/namespaces/{namespace}/pods

+ +
+ + + + + + + + + + + +
Table 1 Path Parameters

Parameter

+

Mandatory

+

Type

+

Description

+

namespace

+

Yes

+

String

+

Object name and auth scope, such as for teams and projects.

+
+
+ +
+ + + + + + + + + + + + + + + + + + + + + +
Table 2 Query Parameters

Parameter

+

Mandatory

+

Type

+

Description

+

dryRun

+

No

+

String

+

When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed

+

fieldManager

+

No

+

String

+

fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint.

+

pretty

+

No

+

String

+

If 'true', then the output is pretty printed.

+
+
+
+

Request Parameters

+
+ + + + + + + + + + + + + + + + +
Table 3 Request header parameters

Parameter

+

Mandatory

+

Type

+

Description

+

X-Auth-Token

+

Yes

+

String

+

User token.

+

It can be obtained through the IAM API used to obtain a user token. The value of X-Subject-Token in the response header is the user token.

+

Content-Type

+

Yes

+

String

+

The type of the message body, with a default value of "application/JSON".

+
+
+ +
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Table 4 Request body parameters

Parameter

+

Mandatory

+

Type

+

Description

+

apiVersion

+

No

+

String

+

APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#resources

+

kind

+

No

+

String

+

Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds

+

metadata

+

No

+

io.k8s.apimachinery.pkg.apis.meta.v1.ObjectMeta object

+

Standard object's metadata. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata

+

spec

+

No

+

io.cci.otc.api.pkg.apis.versioned.cci.v2.PodSpec object

+

Specification of the desired behavior of the pod. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#spec-and-status

+

status

+

No

+

io.cci.otc.api.pkg.apis.versioned.cci.v2.PodStatus object

+

Most recently observed status of the pod. This data may not be up to date. Populated by the system. Read-only. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#spec-and-status

+
+
+ +
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Table 5 io.cci.otc.api.pkg.apis.versioned.cci.v2.PodSpec

Parameter

+

Mandatory

+

Type

+

Description

+

activeDeadlineSeconds

+

No

+

Long

+

Optional duration in seconds the pod may be active on the node relative to StartTime before the system will actively try to mark it failed and kill associated containers. Value must be a positive integer.

+

affinity

+

No

+

io.cci.otc.api.pkg.apis.versioned.cci.v2.Affinity object

+

If specified, the pod's scheduling constraints

+

containers

+

Yes

+

Array of io.cci.otc.api.pkg.apis.versioned.cci.v2.Container objects

+

List of containers belonging to the pod. Containers cannot currently be added or removed. There must be at least one container in a Pod. Cannot be updated.

+

dnsConfig

+

No

+

io.cci.otc.api.pkg.apis.versioned.cci.v2.PodDNSConfig object

+

Specifies the DNS parameters of a pod. Parameters specified here will be merged to the generated DNS configuration based on DNSPolicy.

+

dnsPolicy

+

No

+

String

+

Set DNS policy for the pod. Defaults to "ClusterFirst". Valid values are 'ClusterFirstWithHostNet', 'ClusterFirst', 'Default' or 'None'. DNS parameters given in DNSConfig will be merged with the policy selected with DNSPolicy. To have DNS options set along with hostNetwork, you have to specify DNS policy explicitly to 'ClusterFirstWithHostNet'.

+

Possible enum values:

+
  • "ClusterFirst" indicates that the pod should use cluster DNS first unless hostNetwork is true, if it is available, then fall back on the default (as determined by kubelet) DNS settings.
  • "ClusterFirstWithHostNet" indicates that the pod should use cluster DNS first, if it is available, then fall back on the default (as determined by kubelet) DNS settings.
  • "Default" indicates that the pod should use the default (as determined by kubelet) DNS settings.
  • "None" indicates that the pod should use empty DNS settings. DNS parameters such as nameservers and search paths should be defined via DNSConfig.
+

ephemeralContainers

+

No

+

Array of io.cci.otc.api.pkg.apis.versioned.cci.v2.EphemeralContainer objects

+

List of ephemeral containers run in this pod. Ephemeral containers may be run in an existing pod to perform user-initiated actions such as debugging. This list cannot be specified when creating a pod, and it cannot be modified by updating the pod spec. In order to add an ephemeral container to an existing pod, use the pod's ephemeralcontainers subresource.

+

hostAliases

+

No

+

Array of io.cci.otc.api.pkg.apis.versioned.cci.v2.HostAlias objects

+

HostAliases is an optional list of hosts and IPs that will be injected into the pod's hosts file if specified. This is only valid for non-hostNetwork pods.

+

hostname

+

No

+

String

+

Specifies the hostname of the Pod If not specified, the pod's hostname will be set to a system-defined value.

+

imagePullSecrets

+

No

+

Array of io.cci.otc.api.pkg.apis.versioned.cci.v2.LocalObjectReference objects

+

ImagePullSecrets is an optional list of references to secrets in the same namespace to use for pulling any of the images used by this PodSpec. If specified, these secrets will be passed to individual puller implementations for them to use. More info: https://kubernetes.io/docs/concepts/containers/images#specifying-imagepullsecrets-on-a-pod

+

initContainers

+

No

+

Array of io.cci.otc.api.pkg.apis.versioned.cci.v2.Container objects

+

List of initialization containers belonging to the pod. Init containers are executed in order prior to containers being started. If any init container fails, the pod is considered to have failed and is handled according to its restartPolicy. The name for an init container or normal container must be unique among all containers. Init containers may not have Lifecycle actions, Readiness probes, Liveness probes, or Startup probes. The resourceRequirements of an init container are taken into account during scheduling by finding the highest request/limit for each resource type, and then using the max of of that value or the sum of the normal containers. Limits are applied to init containers in a similar fashion. Init containers cannot currently be added or removed. Cannot be updated. More info: https://kubernetes.io/docs/concepts/workloads/pods/init-containers/

+

nodeName

+

No

+

String

+

NodeName is a request to schedule this pod onto a specific node.

+

If it is non-empty, the scheduler simply schedules this pod onto that node, assuming that it fits resource requirements.

+

overhead

+

No

+

Map<String,String>

+

Overhead represents the resource overhead associated with running a pod for a given RuntimeClass. This field will be autopopulated at admission time by the RuntimeClass admission controller. If the RuntimeClass admission controller is enabled, overhead must not be set in Pod create requests. The RuntimeClass admission controller will reject Pod create requests which have the overhead already set. If RuntimeClass is configured and selected in the PodSpec, Overhead will be set to the value defined in the corresponding RuntimeClass, otherwise it will remain unset and treated as zero. More info: https://git.k8s.io/enhancements/keps/sig-node/688-pod-overhead/README.md

+

readinessGates

+

No

+

Array of io.cci.otc.api.pkg.apis.versioned.cci.v2.PodReadinessGate objects

+

If specified, all readiness gates will be evaluated for pod readiness. A pod is ready when all its containers are ready AND all conditions specified in the readiness gates have status equal to "True" More info: https://git.k8s.io/enhancements/keps/sig-network/580-pod-readiness-gates

+

restartPolicy

+

No

+

String

+

Restart policy for all containers within the pod. One of Always, OnFailure, Never. Default to Always. More info: https://kubernetes.io/docs/concepts/workloads/pods/pod-lifecycle/#restart-policy

+

Possible enum values:

+
  • "Always"
  • "Never"
  • "OnFailure"
+

schedulerName

+

No

+

String

+

If specified, the pod will be dispatched by specified scheduler.

+

If not specified, the pod will be dispatched by default scheduler.

+

securityContext

+

No

+

io.cci.otc.api.pkg.apis.versioned.cci.v2.PodSecurityContext object

+

SecurityContext holds pod-level security attributes and common container settings. Optional: Defaults to empty. See type description for default values of each field.

+

setHostnameAsFQDN

+

No

+

Boolean

+

If true the pod's hostname will be configured as the pod's FQDN, rather than the leaf name (the default). In Linux containers, this means setting the FQDN in the hostname field of the kernel (the nodename field of struct utsname). In Windows containers, this means setting the registry value of hostname for the registry key HKEY_LOCAL_MACHINE\SYSTEM\CurrentControlSet\Services\Tcpip\Parameters to FQDN. If a pod does not have FQDN, this has no effect. Default to false.

+

shareProcessNamespace

+

No

+

Boolean

+

Share a single process namespace between all of the containers in a pod. When this is set containers will be able to view and signal processes from other containers in the same pod, and the first process in each container will not be assigned PID 1. HostPID and ShareProcessNamespace cannot both be set. Optional: Default to false.

+

terminationGracePeriodSeconds

+

No

+

Long

+

Optional duration in seconds the pod needs to terminate gracefully.

+

May be decreased in delete request. Value must be non-negative integer.

+

The value zero indicates stop immediately via the kill signal (no opportunity to shut down). If this value is nil, the default grace period will be used instead. The grace period is the duration in seconds after the processes running in the pod are sent a termination signal and the time when the processes are forcibly halted with a kill signal. Set this value longer than the expected cleanup time for your process. Defaults to 30 seconds.

+

topologySpreadConstraints

+

No

+

Array of io.cci.otc.api.pkg.apis.versioned.cci.v2.TopologySpreadConstraint objects

+

TopologySpreadConstraints describes how a group of pods ought to spread across topology domains. Scheduler will schedule pods in a way which abides by the constraints. All topologySpreadConstraints are ANDed.

+

volumes

+

No

+

Array of io.cci.otc.api.pkg.apis.versioned.cci.v2.Volume objects

+

List of volumes that can be mounted by containers belonging to the pod. More info: https://kubernetes.io/docs/concepts/storage/volumes

+
+
+ +
+ + + + + + + + + + + + + + + + +
Table 6 io.cci.otc.api.pkg.apis.versioned.cci.v2.Affinity

Parameter

+

Mandatory

+

Type

+

Description

+

nodeAffinity

+

No

+

io.cci.otc.api.pkg.apis.versioned.cci.v2.NodeAffinity object

+

Describes node affinity scheduling rules for the pod.

+

podAntiAffinity

+

No

+

io.cci.otc.api.pkg.apis.versioned.cci.v2.PodAntiAffinity object

+

Describes pod anti-affinity scheduling rules (e.g. avoid putting this pod in the same zone, etc. as some other pod(s)).

+
+
+ +
+ + + + + + + + + + + +
Table 7 io.cci.otc.api.pkg.apis.versioned.cci.v2.NodeAffinity

Parameter

+

Mandatory

+

Type

+

Description

+

requiredDuringSchedulingIgnoredDuringExecution

+

No

+

io.cci.otc.api.pkg.apis.versioned.cci.v2.NodeSelector object

+

If the affinity requirements specified by this field are not met at scheduling time, the pod will not be scheduled onto the node. If the affinity requirements specified by this field cease to be met at some point during pod execution (e.g. due to an update), the system may or may not try to eventually evict the pod from its node.

+
+
+ +
+ + + + + + + + + + + +
Table 8 io.cci.otc.api.pkg.apis.versioned.cci.v2.NodeSelector

Parameter

+

Mandatory

+

Type

+

Description

+

nodeSelectorTerms

+

Yes

+

Array of io.cci.otc.api.pkg.apis.versioned.cci.v2.NodeSelectorTerm objects

+

Required. A list of node selector terms. The terms are ORed.

+
+
+ +
+ + + + + + + + + + + +
Table 9 io.cci.otc.api.pkg.apis.versioned.cci.v2.NodeSelectorTerm

Parameter

+

Mandatory

+

Type

+

Description

+

matchExpressions

+

No

+

Array of io.cci.otc.api.pkg.apis.versioned.cci.v2.NodeSelectorRequirement objects

+

A list of node selector requirements by node's labels.

+
+
+ +
+ + + + + + + + + + + + + + + + + + + + + +
Table 10 io.cci.otc.api.pkg.apis.versioned.cci.v2.NodeSelectorRequirement

Parameter

+

Mandatory

+

Type

+

Description

+

key

+

Yes

+

String

+

The label key that the selector applies to.

+

operator

+

Yes

+

String

+

Represents a key's relationship to a set of values. Valid operators are In, NotIn, Exists, DoesNotExist. Gt, and Lt.

+

Possible enum values:

+
  • "DoesNotExist"
  • "Exists"
  • "Gt"
  • "In"
  • "Lt"
  • "NotIn"
+

values

+

No

+

Array of strings

+

An array of string values. If the operator is In or NotIn, the values array must be non-empty. If the operator is Exists or DoesNotExist, the values array must be empty. If the operator is Gt or Lt, the values array must have a single element, which will be interpreted as an integer.

+

This array is replaced during a strategic merge patch.

+
+
+ +
+ + + + + + + + + + + + + + + + +
Table 11 io.cci.otc.api.pkg.apis.versioned.cci.v2.PodAntiAffinity

Parameter

+

Mandatory

+

Type

+

Description

+

preferredDuringSchedulingIgnoredDuringExecution

+

No

+

Array of io.cci.otc.api.pkg.apis.versioned.cci.v2.WeightedPodAffinityTerm objects

+

The scheduler will prefer to schedule pods to nodes that satisfy the anti-affinity expressions specified by this field, but it may choose a node that violates one or more of the expressions. The node that is most preferred is the one with the greatest sum of weights, i.e. for each node that meets all of the scheduling requirements (resource request, requiredDuringScheduling anti-affinity expressions, etc.), compute a sum by iterating through the elements of this field and adding "weight" to the sum if the node has pods which matches the corresponding podAffinityTerm; the node(s) with the highest sum are the most preferred.

+

requiredDuringSchedulingIgnoredDuringExecution

+

No

+

Array of io.cci.otc.api.pkg.apis.versioned.cci.v2.PodAffinityTerm objects

+

If the anti-affinity requirements specified by this field are not met at scheduling time, the pod will not be scheduled onto the node.

+

If the anti-affinity requirements specified by this field cease to be met at some point during pod execution (e.g. due to a pod label update), the system may or may not try to eventually evict the pod from its node. When there are multiple elements, the lists of nodes corresponding to each podAffinityTerm are intersected, i.e. all terms must be satisfied.

+
+
+ +
+ + + + + + + + + + + + + + + + +
Table 12 io.cci.otc.api.pkg.apis.versioned.cci.v2.WeightedPodAffinityTerm

Parameter

+

Mandatory

+

Type

+

Description

+

podAffinityTerm

+

Yes

+

io.cci.otc.api.pkg.apis.versioned.cci.v2.PodAffinityTerm object

+

Required. A pod affinity term, associated with the corresponding weight.

+

weight

+

Yes

+

Integer

+

weight associated with matching the corresponding podAffinityTerm, in the range 1-100.

+
+
+ +
+ + + + + + + + + + + + + + + + + + + + + +
Table 13 io.cci.otc.api.pkg.apis.versioned.cci.v2.PodAffinityTerm

Parameter

+

Mandatory

+

Type

+

Description

+

labelSelector

+

No

+

io.k8s.apimachinery.pkg.apis.meta.v1.LabelSelector object

+

A label query over a set of resources, in this case pods.

+

namespaces

+

No

+

Array of strings

+

namespaces specifies a static list of namespace names that the term applies to. The term is applied to the union of the namespaces listed in this field and the ones selected by namespaceSelector. null or empty namespaces list and null namespaceSelector means "this pod's namespace".

+

topologyKey

+

Yes

+

String

+

This pod should be co-located (affinity) or not co-located (anti-affinity) with the pods matching the labelSelector in the specified namespaces, where co-located is defined as running on a node whose value of the label with key topologyKey matches that of any node on which any of the selected pods is running. Empty topologyKey is not allowed.

+
+
+ +
+ + + + + + + + + + + + + + + + + + + + + +
Table 14 io.cci.otc.api.pkg.apis.versioned.cci.v2.PodDNSConfig

Parameter

+

Mandatory

+

Type

+

Description

+

nameservers

+

No

+

Array of strings

+

A list of DNS name server IP addresses. This will be appended to the base nameservers generated from DNSPolicy. Duplicated nameservers will be removed.

+

options

+

No

+

Array of io.cci.otc.api.pkg.apis.versioned.cci.v2.PodDNSConfigOption objects

+

A list of DNS resolver options. This will be merged with the base options generated from DNSPolicy. Duplicated entries will be removed.

+

Resolution options given in Options will override those that appear in the base DNSPolicy.

+

searches

+

No

+

Array of strings

+

A list of DNS search domains for host-name lookup. This will be appended to the base search paths generated from DNSPolicy. Duplicated search paths will be removed.

+
+
+ +
+ + + + + + + + + + + + + + + + +
Table 15 io.cci.otc.api.pkg.apis.versioned.cci.v2.PodDNSConfigOption

Parameter

+

Mandatory

+

Type

+

Description

+

name

+

No

+

String

+

Required.

+

value

+

No

+

String

+		  
+
+ +
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Table 16 io.cci.otc.api.pkg.apis.versioned.cci.v2.EphemeralContainer

Parameter

+

Mandatory

+

Type

+

Description

+

args

+

No

+

Array of strings

+

Arguments to the entrypoint. The image's CMD is used if this is not provided. Variable references $(VAR_NAME) are expanded using the container's environment. If a variable cannot be resolved, the reference in the input string will be unchanged. Double $$ are reduced to a single $, which allows for escaping the $(VAR_NAME) syntax: i.e. "$$(VAR_NAME)" will produce the string literal "$(VAR_NAME)". Escaped references will never be expanded, regardless of whether the variable exists or not. Cannot be updated. More info: https://kubernetes.io/docs/tasks/inject-data-application/define-command-argument-container/#running-a-command-in-a-shell

+

command

+

No

+

Array of strings

+

Entrypoint array. Not executed within a shell. The image's ENTRYPOINT is used if this is not provided. Variable references $(VAR_NAME) are expanded using the container's environment. If a variable cannot be resolved, the reference in the input string will be unchanged. Double $$ are reduced to a single $, which allows for escaping the $(VAR_NAME) syntax: i.e. "$$(VAR_NAME)" will produce the string literal "$(VAR_NAME)". Escaped references will never be expanded, regardless of whether the variable exists or not. Cannot be updated. More info: https://kubernetes.io/docs/tasks/inject-data-application/define-command-argument-container/#running-a-command-in-a-shell

+

env

+

No

+

Array of io.cci.otc.api.pkg.apis.versioned.cci.v2.EnvVar objects

+

List of environment variables to set in the container. Cannot be updated.

+

envFrom

+

No

+

Array of io.cci.otc.api.pkg.apis.versioned.cci.v2.EnvFromSource objects

+

List of sources to populate environment variables in the container.

+

The keys defined within a source must be a C_IDENTIFIER. All invalid keys will be reported as an event when the container is starting. When a key exists in multiple sources, the value associated with the last source will take precedence. Values defined by an Env with a duplicate key will take precedence. Cannot be updated.

+

image

+

No

+

String

+

Container image name. More info: https://kubernetes.io/docs/concepts/containers/images

+

lifecycle

+

No

+

io.cci.otc.api.pkg.apis.versioned.cci.v2.Lifecycle object

+

Lifecycle is not allowed for ephemeral containers.

+

livenessProbe

+

No

+

io.cci.otc.api.pkg.apis.versioned.cci.v2.Probe object

+

Probes are not allowed for ephemeral containers.

+

name

+

Yes

+

String

+

Name of the ephemeral container specified as a DNS_LABEL. This name must be unique among all containers, init containers and ephemeral containers.

+

ports

+

No

+

Array of io.cci.otc.api.pkg.apis.versioned.cci.v2.ContainerPort objects

+

Ports are not allowed for ephemeral containers.

+

readinessProbe

+

No

+

io.cci.otc.api.pkg.apis.versioned.cci.v2.Probe object

+

Probes are not allowed for ephemeral containers.

+

resources

+

No

+

io.cci.otc.api.pkg.apis.versioned.cci.v2.ResourceRequirements object

+

Resources are not allowed for ephemeral containers. Ephemeral containers use spare resources already allocated to the pod.

+

securityContext

+

No

+

io.cci.otc.api.pkg.apis.versioned.cci.v2.SecurityContext object

+

Optional: SecurityContext defines the security options the ephemeral container should be run with. If set, the fields of SecurityContext override the equivalent fields of PodSecurityContext.

+

startupProbe

+

No

+

io.cci.otc.api.pkg.apis.versioned.cci.v2.Probe object

+

Probes are not allowed for ephemeral containers.

+

stdin

+

No

+

Boolean

+

Whether this container should allocate a buffer for stdin in the container runtime. If this is not set, reads from stdin in the container will always result in EOF. Default is false.

+

stdinOnce

+

No

+

Boolean

+

Whether the container runtime should close the stdin channel after it has been opened by a single attach. When stdin is true the stdin stream will remain open across multiple attach sessions. If stdinOnce is set to true, stdin is opened on container start, is empty until the first client attaches to stdin, and then remains open and accepts data until the client disconnects, at which time stdin is closed and remains closed until the container is restarted. If this flag is false, a container processes that reads from stdin will never receive an EOF. Default is false

+

targetContainerName

+

No

+

String

+

If set, the name of the container from PodSpec that this ephemeral container targets. The ephemeral container will be run in the namespaces (IPC, PID, etc) of this container. If not set then the ephemeral container uses the namespaces configured in the Pod spec.

+

The container runtime must implement support for this feature. If the runtime does not support namespace targeting then the result of setting this field is undefined.

+

terminationMessagePath

+

No

+

String

+

Optional: Path at which the file to which the container's termination message will be written is mounted into the container's filesystem. Message written is intended to be brief final status, such as an assertion failure message. Will be truncated by the node if greater than 4096 bytes. The total message length across all containers will be limited to 12kb. Defaults to /dev/termination-log. Cannot be updated.

+

terminationMessagePolicy

+

No

+

String

+

Indicate how the termination message should be populated. File will use the contents of terminationMessagePath to populate the container status message on both success and failure. FallbackToLogsOnError will use the last chunk of container log output if the termination message file is empty and the container exited with an error. The log output is limited to 2048 bytes or 80 lines, whichever is smaller. Defaults to File. Cannot be updated.

+

Possible enum values:

+
  • "FallbackToLogsOnError" will read the most recent contents of the container logs for the container status message when the container exits with an error and the terminationMessagePath has no contents.
  • "File" is the default behavior and will set the container status message to the contents of the container's terminationMessagePath when the container exits.
+

tty

+

No

+

Boolean

+

Whether this container should allocate a TTY for itself, also requires 'stdin' to be true. Default is false.

+

volumeMounts

+

No

+

Array of io.cci.otc.api.pkg.apis.versioned.cci.v2.VolumeMount objects

+

Pod volumes to mount into the container's filesystem. Subpath mounts are not allowed for ephemeral containers. Cannot be updated.

+

workingDir

+

No

+

String

+

Container's working directory. If not specified, the container runtime's default will be used, which might be configured in the container image. Cannot be updated.

+
+
+ +
+ + + + + + + + + + + + + + + + +
Table 17 io.cci.otc.api.pkg.apis.versioned.cci.v2.HostAlias

Parameter

+

Mandatory

+

Type

+

Description

+

hostnames

+

No

+

Array of strings

+

Hostnames for the above IP address.

+

ip

+

No

+

String

+

IP address of the host file entry.

+
+
+ +
+ + + + + + + + + + + +
Table 18 io.cci.otc.api.pkg.apis.versioned.cci.v2.LocalObjectReference

Parameter

+

Mandatory

+

Type

+

Description

+

name

+

No

+

String

+

Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names

+
+
+ +
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Table 19 io.cci.otc.api.pkg.apis.versioned.cci.v2.Container

Parameter

+

Mandatory

+

Type

+

Description

+

args

+

No

+

Array of strings

+

Arguments to the entrypoint. The container image's CMD is used if this is not provided. Variable references $(VAR_NAME) are expanded using the container's environment. If a variable cannot be resolved, the reference in the input string will be unchanged. Double $$ are reduced to a single $, which allows for escaping the $(VAR_NAME) syntax: i.e. "$$(VAR_NAME)" will produce the string literal "$(VAR_NAME)". Escaped references will never be expanded, regardless of whether the variable exists or not. Cannot be updated. More info: https://kubernetes.io/docs/tasks/inject-data-application/define-command-argument-container/#running-a-command-in-a-shell

+

command

+

No

+

Array of strings

+

Entrypoint array. Not executed within a shell. The container image's ENTRYPOINT is used if this is not provided. Variable references $(VAR_NAME) are expanded using the container's environment. If a variable cannot be resolved, the reference in the input string will be unchanged. Double $$ are reduced to a single $, which allows for escaping the $(VAR_NAME) syntax: i.e. "$$(VAR_NAME)" will produce the string literal "$(VAR_NAME)". Escaped references will never be expanded, regardless of whether the variable exists or not. Cannot be updated. More info: https://kubernetes.io/docs/tasks/inject-data-application/define-command-argument-container/#running-a-command-in-a-shell

+

env

+

No

+

Array of io.cci.otc.api.pkg.apis.versioned.cci.v2.EnvVar objects

+

List of environment variables to set in the container. Cannot be updated.

+

envFrom

+

No

+

Array of io.cci.otc.api.pkg.apis.versioned.cci.v2.EnvFromSource objects

+

List of sources to populate environment variables in the container.

+

The keys defined within a source must be a C_IDENTIFIER. All invalid keys will be reported as an event when the container is starting. When a key exists in multiple sources, the value associated with the last source will take precedence. Values defined by an Env with a duplicate key will take precedence. Cannot be updated.

+

image

+

No

+

String

+

Container image name. More info: https://kubernetes.io/docs/concepts/containers/images This field is optional to allow higher level config management to default or override container images in workload controllers like Deployments and StatefulSets.

+

lifecycle

+

No

+

io.cci.otc.api.pkg.apis.versioned.cci.v2.Lifecycle object

+

Actions that the management system should take in response to container lifecycle events. Cannot be updated.

+

livenessProbe

+

No

+

io.cci.otc.api.pkg.apis.versioned.cci.v2.Probe object

+

Periodic probe of container liveness. Container will be restarted if the probe fails. Cannot be updated. More info: https://kubernetes.io/docs/concepts/workloads/pods/pod-lifecycle#container-probes

+

name

+

Yes

+

String

+

Name of the container specified as a DNS_LABEL. Each container in a pod must have a unique name (DNS_LABEL). Cannot be updated.

+

ports

+

No

+

Array of io.cci.otc.api.pkg.apis.versioned.cci.v2.ContainerPort objects

+

List of ports to expose from the container. Not specifying a port here DOES NOT prevent that port from being exposed. Any port which is listening on the default "0.0.0.0" address inside a container will be accessible from the network. Modifying this array with strategic merge patch may corrupt the data. For more information See https://github.com/kubernetes/kubernetes/issues/108255.

+

Cannot be updated.

+

readinessProbe

+

No

+

io.cci.otc.api.pkg.apis.versioned.cci.v2.Probe object

+

Periodic probe of container service readiness. Container will be removed from service endpoints if the probe fails. Cannot be updated. More info: https://kubernetes.io/docs/concepts/workloads/pods/pod-lifecycle#container-probes

+

resources

+

No

+

io.cci.otc.api.pkg.apis.versioned.cci.v2.ResourceRequirements object

+

Compute Resources required by this container. Cannot be updated. More info: https://kubernetes.io/docs/concepts/configuration/manage-resources-containers/

+

securityContext

+

No

+

io.cci.otc.api.pkg.apis.versioned.cci.v2.SecurityContext object

+

SecurityContext defines the security options the container should be run with. If set, the fields of SecurityContext override the equivalent fields of PodSecurityContext. More info: https://kubernetes.io/docs/tasks/configure-pod-container/security-context/

+

startupProbe

+

No

+

io.cci.otc.api.pkg.apis.versioned.cci.v2.Probe object

+

StartupProbe indicates that the Pod has successfully initialized. If specified, no other probes are executed until this completes successfully. If this probe fails, the Pod will be restarted, just as if the livenessProbe failed. This can be used to provide different probe parameters at the beginning of a Pod's lifecycle, when it might take a long time to load data or warm a cache, than during steady-state operation. This cannot be updated. More info: https://kubernetes.io/docs/concepts/workloads/pods/pod-lifecycle#container-probes

+

stdin

+

No

+

Boolean

+

Whether this container should allocate a buffer for stdin in the container runtime. If this is not set, reads from stdin in the container will always result in EOF. Default is false.

+

stdinOnce

+

No

+

Boolean

+

Whether the container runtime should close the stdin channel after it has been opened by a single attach. When stdin is true the stdin stream will remain open across multiple attach sessions. If stdinOnce is set to true, stdin is opened on container start, is empty until the first client attaches to stdin, and then remains open and accepts data until the client disconnects, at which time stdin is closed and remains closed until the container is restarted. If this flag is false, a container processes that reads from stdin will never receive an EOF. Default is false

+

terminationMessagePath

+

No

+

String

+

Optional: Path at which the file to which the container's termination message will be written is mounted into the container's filesystem. Message written is intended to be brief final status, such as an assertion failure message. Will be truncated by the node if greater than 4096 bytes. The total message length across all containers will be limited to 12kb. Defaults to /dev/termination-log. Cannot be updated.

+

terminationMessagePolicy

+

No

+

String

+

Indicate how the termination message should be populated. File will use the contents of terminationMessagePath to populate the container status message on both success and failure. FallbackToLogsOnError will use the last chunk of container log output if the termination message file is empty and the container exited with an error. The log output is limited to 2048 bytes or 80 lines, whichever is smaller. Defaults to File. Cannot be updated.

+

Possible enum values:

+
  • "FallbackToLogsOnError" will read the most recent contents of the container logs for the container status message when the container exits with an error and the terminationMessagePath has no contents.
  • "File" is the default behavior and will set the container status message to the contents of the container's terminationMessagePath when the container exits.
+

tty

+

No

+

Boolean

+

Whether this container should allocate a TTY for itself, also requires 'stdin' to be true. Default is false.

+

volumeMounts

+

No

+

Array of io.cci.otc.api.pkg.apis.versioned.cci.v2.VolumeMount objects

+

Pod volumes to mount into the container's filesystem. Cannot be updated.

+

workingDir

+

No

+

String

+

Container's working directory. If not specified, the container runtime's default will be used, which might be configured in the container image. Cannot be updated.

+
+
+ +
+ + + + + + + + + + + + + + + + + + + + + +
Table 20 io.cci.otc.api.pkg.apis.versioned.cci.v2.EnvVar

Parameter

+

Mandatory

+

Type

+

Description

+

name

+

Yes

+

String

+

Name of the environment variable. Must be a C_IDENTIFIER.

+

value

+

No

+

String

+

Variable references $(VAR_NAME) are expanded using the previously defined environment variables in the container and any service environment variables. If a variable cannot be resolved, the reference in the input string will be unchanged. Double $$ are reduced to a single $, which allows for escaping the $(VAR_NAME) syntax: i.e. "$$(VAR_NAME)" will produce the string literal "$(VAR_NAME)". Escaped references will never be expanded, regardless of whether the variable exists or not. Defaults to "".

+

valueFrom

+

No

+

io.cci.otc.api.pkg.apis.versioned.cci.v2.EnvVarSource object

+

Source for the environment variable's value. Cannot be used if value is not empty.

+
+
+ +
+ + + + + + + + + + + + + + + + + + + + + + + + + + +
Table 21 io.cci.otc.api.pkg.apis.versioned.cci.v2.EnvVarSource

Parameter

+

Mandatory

+

Type

+

Description

+

configMapKeyRef

+

No

+

io.cci.otc.api.pkg.apis.versioned.cci.v2.ConfigMapKeySelector object

+

Selects a key of a ConfigMap.

+

fieldRef

+

No

+

io.cci.otc.api.pkg.apis.versioned.cci.v2.ObjectFieldSelector object

+

Selects a field of the pod: supports metadata.name, metadata.namespace, metadata.labels['<KEY>'], metadata.annotations['<KEY>'], spec.nodeName, spec.serviceAccountName, status.hostIP, status.podIP, status.podIPs.

+

resourceFieldRef

+

No

+

io.cci.otc.api.pkg.apis.versioned.cci.v2.ResourceFieldSelector object

+

Selects a resource of the container: only resources limits and requests (limits.cpu, limits.memory, limits.ephemeral-storage, requests.cpu, requests.memory and requests.ephemeral-storage) are currently supported.

+

secretKeyRef

+

No

+

io.cci.otc.api.pkg.apis.versioned.cci.v2.SecretKeySelector object

+

Selects a key of a secret in the pod's namespace

+
+
+ +
+ + + + + + + + + + + + + + + + + + + + + +
Table 22 io.cci.otc.api.pkg.apis.versioned.cci.v2.ConfigMapKeySelector

Parameter

+

Mandatory

+

Type

+

Description

+

key

+

Yes

+

String

+

The key to select.

+

name

+

No

+

String

+

Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names

+

optional

+

No

+

Boolean

+

Specify whether the ConfigMap or its key must be defined

+
+
+ +
+ + + + + + + + + + + + + + + + + + + + + +
Table 23 io.cci.otc.api.pkg.apis.versioned.cci.v2.SecretKeySelector

Parameter

+

Mandatory

+

Type

+

Description

+

key

+

Yes

+

String

+

The key of the secret to select from. Must be a valid secret key.

+

name

+

No

+

String

+

Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names

+

optional

+

No

+

Boolean

+

Specify whether the Secret or its key must be defined

+
+
+ +
+ + + + + + + + + + + + + + + + + + + + + +
Table 24 io.cci.otc.api.pkg.apis.versioned.cci.v2.EnvFromSource

Parameter

+

Mandatory

+

Type

+

Description

+

configMapRef

+

No

+

io.cci.otc.api.pkg.apis.versioned.cci.v2.ConfigMapEnvSource object

+

The ConfigMap to select from

+

prefix

+

No

+

String

+

An optional identifier to prepend to each key in the ConfigMap.

+

Must be a C_IDENTIFIER.

+

secretRef

+

No

+

io.cci.otc.api.pkg.apis.versioned.cci.v2.SecretEnvSource object

+

The Secret to select from

+
+
+ +
+ + + + + + + + + + + + + + + + +
Table 25 io.cci.otc.api.pkg.apis.versioned.cci.v2.ConfigMapEnvSource

Parameter

+

Mandatory

+

Type

+

Description

+

name

+

No

+

String

+

Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names

+

optional

+

No

+

Boolean

+

Specify whether the ConfigMap must be defined

+
+
+ +
+ + + + + + + + + + + + + + + + +
Table 26 io.cci.otc.api.pkg.apis.versioned.cci.v2.SecretEnvSource

Parameter

+

Mandatory

+

Type

+

Description

+

name

+

No

+

String

+

Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names

+

optional

+

No

+

Boolean

+

Specify whether the Secret must be defined

+
+
+ +
+ + + + + + + + + + + + + + + + +
Table 27 io.cci.otc.api.pkg.apis.versioned.cci.v2.Lifecycle

Parameter

+

Mandatory

+

Type

+

Description

+

postStart

+

No

+

io.cci.otc.api.pkg.apis.versioned.cci.v2.LifecycleHandler object

+

PostStart is called immediately after a container is created. If the handler fails, the container is terminated and restarted according to its restart policy. Other management of the container blocks until the hook completes. More info: https://kubernetes.io/docs/concepts/containers/container-lifecycle-hooks/#container-hooks

+

preStop

+

No

+

io.cci.otc.api.pkg.apis.versioned.cci.v2.LifecycleHandler object

+

PreStop is called immediately before a container is terminated due to an API request or management event such as liveness/startup probe failure, preemption, resource contention, etc. The handler is not called if the container crashes or exits. The Pod's termination grace period countdown begins before the PreStop hook is executed. Regardless of the outcome of the handler, the container will eventually terminate within the Pod's termination grace period (unless delayed by finalizers). Other management of the container blocks until the hook completes or until the termination grace period is reached. More info: https://kubernetes.io/docs/concepts/containers/container-lifecycle-hooks/#container-hooks

+
+
+ +
+ + + + + + + + + + + + + + + + +
Table 28 io.cci.otc.api.pkg.apis.versioned.cci.v2.LifecycleHandler

Parameter

+

Mandatory

+

Type

+

Description

+

exec

+

No

+

io.cci.otc.api.pkg.apis.versioned.cci.v2.ExecAction object

+

Exec specifies the action to take.

+

httpGet

+

No

+

io.cci.otc.api.pkg.apis.versioned.cci.v2.HTTPGetAction object

+

HTTPGet specifies the http request to perform.

+
+
+ +
+ + + + + + + + + + + + + + + + + + + + + +
Table 29 io.cci.otc.api.pkg.apis.versioned.cci.v2.ContainerPort

Parameter

+

Mandatory

+

Type

+

Description

+

containerPort

+

Yes

+

Integer

+

Number of port to expose on the pod's IP address. This must be a valid port number, 0 < x < 65536.

+

name

+

No

+

String

+

If specified, this must be an IANA_SVC_NAME and unique within the pod. Each named port in a pod must have a unique name. Name for the port that can be referred to by services.

+

protocol

+

No

+

String

+

Protocol for port. Must be UDP, TCP, or SCTP. Defaults to "TCP".

+

Possible enum values:

+
  • "SCTP" is the SCTP protocol.
  • "TCP" is the TCP protocol.
  • "UDP" is the UDP protocol.
+
+
+ +
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Table 30 io.cci.otc.api.pkg.apis.versioned.cci.v2.SecurityContext

Parameter

+

Mandatory

+

Type

+

Description

+

capabilities

+

No

+

io.cci.otc.api.pkg.apis.versioned.cci.v2.Capabilities object

+

The capabilities to add/drop when running containers. Defaults to the default set of capabilities granted by the container runtime. Note that this field cannot be set when spec.os.name is windows.

+

procMount

+

No

+

String

+

procMount denotes the type of proc mount to use for the containers.

+

The default is DefaultProcMount which uses the container runtime defaults for readonly paths and masked paths. This requires the ProcMountType feature flag to be enabled. Note that this field cannot be set when spec.os.name is windows.

+

readOnlyRootFilesystem

+

No

+

Boolean

+

Whether this container has a read-only root filesystem. Default is false. Note that this field cannot be set when spec.os.name is windows.

+

runAsGroup

+

No

+

Long

+

The GID to run the entrypoint of the container process. Uses runtime default if unset. May also be set in PodSecurityContext. If set in both SecurityContext and PodSecurityContext, the value specified in SecurityContext takes precedence. Note that this field cannot be set when spec.os.name is windows.

+

runAsNonRoot

+

No

+

Boolean

+

Indicates that the container must run as a non-root user. If true, the Kubelet will validate the image at runtime to ensure that it does not run as UID 0 (root) and fail to start the container if it does. If unset or false, no such validation will be performed. May also be set in PodSecurityContext. If set in both SecurityContext and PodSecurityContext, the value specified in SecurityContext takes precedence.

+

runAsUser

+

No

+

Long

+

The UID to run the entrypoint of the container process. Defaults to user specified in image metadata if unspecified. May also be set in PodSecurityContext. If set in both SecurityContext and PodSecurityContext, the value specified in SecurityContext takes precedence. Note that this field cannot be set when spec.os.name is windows.

+
+
+ +
+ + + + + + + + + + + + + + + + +
Table 31 io.cci.otc.api.pkg.apis.versioned.cci.v2.Capabilities

Parameter

+

Mandatory

+

Type

+

Description

+

add

+

No

+

Array of strings

+

Added capabilities

+

drop

+

No

+

Array of strings

+

Removed capabilities

+
+
+ +
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Table 32 io.cci.otc.api.pkg.apis.versioned.cci.v2.Probe

Parameter

+

Mandatory

+

Type

+

Description

+

exec

+

No

+

io.cci.otc.api.pkg.apis.versioned.cci.v2.ExecAction object

+

Exec specifies the action to take.

+

failureThreshold

+

No

+

Integer

+

Minimum consecutive failures for the probe to be considered failed after having succeeded. Defaults to 3. Minimum value is 1.

+

httpGet

+

No

+

io.cci.otc.api.pkg.apis.versioned.cci.v2.HTTPGetAction object

+

HTTPGet specifies the http request to perform.

+

initialDelaySeconds

+

No

+

Integer

+

Number of seconds after the container has started before liveness probes are initiated. More info: https://kubernetes.io/docs/concepts/workloads/pods/pod-lifecycle#container-probes

+

periodSeconds

+

No

+

Integer

+

How often (in seconds) to perform the probe. Default to 10 seconds.

+

Minimum value is 1.

+

successThreshold

+

No

+

Integer

+

Minimum consecutive successes for the probe to be considered successful after having failed. Defaults to 1. Must be 1 for liveness and startup. Minimum value is 1.

+

tcpSocket

+

No

+

io.cci.otc.api.pkg.apis.versioned.cci.v2.TCPSocketAction object

+

TCPSocket specifies an action involving a TCP port.

+

terminationGracePeriodSeconds

+

No

+

Long

+

Optional duration in seconds the pod needs to terminate gracefully upon probe failure. The grace period is the duration in seconds after the processes running in the pod are sent a termination signal and the time when the processes are forcibly halted with a kill signal. Set this value longer than the expected cleanup time for your process. If this value is nil, the pod's terminationGracePeriodSeconds will be used. Otherwise, this value overrides the value provided by the pod spec. Value must be non-negative integer. The value zero indicates stop immediately via the kill signal (no opportunity to shut down). This is a beta field and requires enabling ProbeTerminationGracePeriod feature gate. Minimum value is 1. spec.terminationGracePeriodSeconds is used if unset.

+

timeoutSeconds

+

No

+

Integer

+

Number of seconds after which the probe times out. Defaults to 1 second. Minimum value is 1. More info: https://kubernetes.io/docs/concepts/workloads/pods/pod-lifecycle#container-probes

+
+
+ +
+ + + + + + + + + + + +
Table 33 io.cci.otc.api.pkg.apis.versioned.cci.v2.ExecAction

Parameter

+

Mandatory

+

Type

+

Description

+

command

+

No

+

Array of strings

+

Command is the command line to execute inside the container, the working directory for the command is root ('/') in the container's filesystem. The command is simply exec'd, it is not run inside a shell, so traditional shell instructions ('|', etc) won't work. To use a shell, you need to explicitly call out to that shell. Exit status of 0 is treated as live/healthy and non-zero is unhealthy.

+
+
+ +
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Table 34 io.cci.otc.api.pkg.apis.versioned.cci.v2.HTTPGetAction

Parameter

+

Mandatory

+

Type

+

Description

+

host

+

No

+

String

+

Host name to connect to, defaults to the pod IP. You probably want to set "Host" in httpHeaders instead.

+

httpHeaders

+

No

+

Array of io.cci.otc.api.pkg.apis.versioned.cci.v2.HTTPHeader objects

+

Custom headers to set in the request. HTTP allows repeated headers.

+

path

+

No

+

String

+

Path to access on the HTTP server.

+

port

+

Yes

+

String

+

Name or number of the port to access on the container. Number must be in the range 1 to 65535. Name must be an IANA_SVC_NAME.

+

scheme

+

No

+

String

+

Scheme to use for connecting to the host. Defaults to HTTP.

+

Possible enum values:

+
  • "HTTP" means that the scheme used will be http://
  • "HTTPS" means that the scheme used will be https://
+
+
+ +
+ + + + + + + + + + + + + + + + +
Table 35 io.cci.otc.api.pkg.apis.versioned.cci.v2.HTTPHeader

Parameter

+

Mandatory

+

Type

+

Description

+

name

+

Yes

+

String

+

The header field name

+

value

+

Yes

+

String

+

The header field value

+
+
+ +
+ + + + + + + + + + + + + + + + +
Table 36 io.cci.otc.api.pkg.apis.versioned.cci.v2.TCPSocketAction

Parameter

+

Mandatory

+

Type

+

Description

+

host

+

No

+

String

+

Optional: Host name to connect to, defaults to the pod IP.

+

port

+

Yes

+

String

+

Number or name of the port to access on the container. Number must be in the range 1 to 65535. Name must be an IANA_SVC_NAME.

+
+
+ +
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Table 37 io.cci.otc.api.pkg.apis.versioned.cci.v2.VolumeMount

Parameter

+

Mandatory

+

Type

+

Description

+

extendPathMode

+

No

+

String

+

Extend the volume path by appending the pod metadata to the path according to specified pattern. which provide a way of directory isolation and help prevent the writing conflict between different pods.

+

mountPath

+

Yes

+

String

+

Path within the container at which the volume should be mounted. Must not contain ':'.

+

name

+

Yes

+

String

+

This must match the Name of a Volume.

+

readOnly

+

No

+

Boolean

+

Mounted read-only if true, read-write otherwise (false or unspecified).

+

Defaults to false.

+

subPath

+

No

+

String

+

Path within the volume from which the container's volume should be mounted. Defaults to "" (volume's root).

+

subPathExpr

+

No

+

String

+

Expanded path within the volume from which the container's volume should be mounted. Behaves similarly to SubPath but environment variable references $(VAR_NAME) are expanded using the container's environment. Defaults to "" (volume's root). SubPathExpr and SubPath are mutually exclusive.

+
+
+ +
+ + + + + + + + + + + +
Table 38 io.cci.otc.api.pkg.apis.versioned.cci.v2.PodReadinessGate

Parameter

+

Mandatory

+

Type

+

Description

+

conditionType

+

Yes

+

String

+

ConditionType refers to a condition in the pod's condition list with matching type.

+
+
+ +
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Table 39 io.cci.otc.api.pkg.apis.versioned.cci.v2.PodSecurityContext

Parameter

+

Mandatory

+

Type

+

Description

+

fsGroup

+

No

+

Long

+

A special supplemental group that applies to all containers in a pod. Some volume types allow the Kubelet to change the ownership of that volume to be owned by the pod:

+
  1. The owning GID will be the FSGroup 2. The setgid bit is set (new files created in the volume will be owned by FSGroup) 3. The permission bits are OR'd with rw-rw----
+

If unset, the Kubelet will not modify the ownership and permissions of any volume. Note that this field cannot be set when spec.os.name is windows.

+

fsGroupChangePolicy

+

No

+

String

+

fsGroupChangePolicy defines behavior of changing ownership and permission of the volume before being exposed inside Pod. This field will only apply to volume types which support fsGroup based ownership(and permissions). It will have no effect on ephemeral volume types such as: secret, configmaps and emptydir. Valid values are "OnRootMismatch" and "Always". If not specified, "Always" is used. Note that this field cannot be set when spec.os.name is windows.

+

runAsGroup

+

No

+

Long

+

The GID to run the entrypoint of the container process. Uses runtime default if unset. May also be set in SecurityContext. If set in both SecurityContext and PodSecurityContext, the value specified in SecurityContext takes precedence for that container. Note that this field cannot be set when spec.os.name is windows.

+

runAsNonRoot

+

No

+

Boolean

+

Indicates that the container must run as a non-root user. If true, the Kubelet will validate the image at runtime to ensure that it does not run as UID 0 (root) and fail to start the container if it does. If unset or false, no such validation will be performed. May also be set in SecurityContext. If set in both SecurityContext and PodSecurityContext, the value specified in SecurityContext takes precedence.

+

runAsUser

+

No

+

Long

+

The UID to run the entrypoint of the container process. Defaults to user specified in image metadata if unspecified. May also be set in SecurityContext. If set in both SecurityContext and PodSecurityContext, the value specified in SecurityContext takes precedence for that container. Note that this field cannot be set when spec.os.name is windows.

+

supplementalGroups

+

No

+

Array of longs

+

A list of groups applied to the first process run in each container, in addition to the container's primary GID. If unspecified, no groups will be added to any container. Note that this field cannot be set when spec.os.name is windows.

+

sysctls

+

No

+

Array of io.cci.otc.api.pkg.apis.versioned.cci.v2.Sysctl objects

+

Sysctls hold a list of namespaced sysctls used for the pod. Pods with unsupported sysctls (by the container runtime) might fail to launch.

+

Note that this field cannot be set when spec.os.name is windows.

+
+
+ +
+ + + + + + + + + + + + + + + + +
Table 40 io.cci.otc.api.pkg.apis.versioned.cci.v2.Sysctl

Parameter

+

Mandatory

+

Type

+

Description

+

name

+

Yes

+

String

+

Name of a property to set

+

value

+

Yes

+

String

+

Value of a property to set

+
+
+ +
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Table 41 io.cci.otc.api.pkg.apis.versioned.cci.v2.TopologySpreadConstraint

Parameter

+

Mandatory

+

Type

+

Description

+

labelSelector

+

No

+

io.k8s.apimachinery.pkg.apis.meta.v1.LabelSelector object

+

LabelSelector is used to find matching pods. Pods that match this label selector are counted to determine the number of pods in their corresponding topology domain.

+

matchLabelKeys

+

No

+

Array of strings

+

MatchLabelKeys is a set of pod label keys to select the pods over which spreading will be calculated. The keys are used to lookup values from the incoming pod labels, those key-value labels are ANDed with labelSelector to select the group of existing pods over which spreading will be calculated for the incoming pod. Keys that don't exist in the incoming pod labels will be ignored. A null or empty list means only match against labelSelector.

+

maxSkew

+

Yes

+

Integer

+

MaxSkew describes the degree to which pods may be unevenly distributed. When whenUnsatisfiable=DoNotSchedule, it is the maximum permitted difference between the number of matching pods in the target topology and the global minimum. The global minimum is the minimum number of matching pods in an eligible domain or zero if the number of eligible domains is less than MinDomains. For example, in a 3-zone cluster, MaxSkew is set to 1, and pods with the same labelSelector spread as 2/2/1: In this case, the global minimum is 1. | zone1 | zone2 | zone3 | | P P | P P | P | - if MaxSkew is 1, incoming pod can only be scheduled to zone3 to become 2/2/2; scheduling it onto zone1(zone2) would make the ActualSkew(3-1) on zone1(zone2) violate MaxSkew(1). - if MaxSkew is 2, incoming pod can be scheduled onto any zone. When whenUnsatisfiable=ScheduleAnyway, it is used to give higher precedence to topologies that satisfy it. It's a required field. Default value is 1 and 0 is not allowed.

+

minDomains

+

No

+

Integer

+

MinDomains indicates a minimum number of eligible domains. When the number of eligible domains with matching topology keys is less than minDomains, Pod Topology Spread treats "global minimum" as 0, and then the calculation of Skew is performed. And when the number of eligible domains with matching topology keys equals or greater than minDomains, this value has no effect on scheduling. As a result, when the number of eligible domains is less than minDomains, scheduler won't schedule more than maxSkew Pods to those domains. If value is nil, the constraint behaves as if MinDomains is equal to 1. Valid values are integers greater than 0. When value is not nil, WhenUnsatisfiable must be DoNotSchedule.

+

For example, in a 3-zone cluster, MaxSkew is set to 2, MinDomains is set to 5 and pods with the same labelSelector spread as 2/2/2: | zone1 | zone2 | zone3 | | P P | P P | P P | The number of domains is less than 5(MinDomains), so "global minimum" is treated as 0. In this situation, new pod with the same labelSelector cannot be scheduled, because computed skew will be 3(3 - 0) if new Pod is scheduled to any of the three zones, it will violate MaxSkew.

+

This is a beta field and requires the MinDomainsInPodTopologySpread feature gate to be enabled (enabled by default).

+

nodeAffinityPolicy

+

No

+

String

+

NodeAffinityPolicy indicates how we will treat Pod's nodeAffinity/nodeSelector when calculating pod topology spread skew. Options are: - Honor: only nodes matching nodeAffinity/nodeSelector are included in the calculations. - Ignore: nodeAffinity/nodeSelector are ignored. All nodes are included in the calculations.

+

If this value is nil, the behavior is equivalent to the Honor policy. This is a alpha-level feature enabled by the NodeInclusionPolicyInPodTopologySpread feature flag.

+

nodeTaintsPolicy

+

No

+

String

+

NodeTaintsPolicy indicates how we will treat node taints when calculating pod topology spread skew. Options are: - Honor: nodes without taints, along with tainted nodes for which the incoming pod has a toleration, are included. - Ignore: node taints are ignored. All nodes are included.

+

If this value is nil, the behavior is equivalent to the Ignore policy. This is a alpha-level feature enabled by the NodeInclusionPolicyInPodTopologySpread feature flag.

+

topologyKey

+

Yes

+

String

+

TopologyKey is the key of node labels. Nodes that have a label with this key and identical values are considered to be in the same topology.

+

We consider each <key, value> as a "bucket", and try to put balanced number of pods into each bucket. We define a domain as a particular instance of a topology. Also, we define an eligible domain as a domain whose nodes meet the requirements of nodeAffinityPolicy and nodeTaintsPolicy. e.g. If TopologyKey is "kubernetes.io/hostname", each Node is a domain of that topology. And, if TopologyKey is "topology.kubernetes.io/zone", each zone is a domain of that topology. It's a required field.

+

whenUnsatisfiable

+

Yes

+

String

+

WhenUnsatisfiable indicates how to deal with a pod if it doesn't satisfy the spread constraint. - DoNotSchedule (default) tells the scheduler not to schedule it. - ScheduleAnyway tells the scheduler to schedule the pod in any location, but giving higher precedence to topologies that would help reduce the skew.

+

A constraint is considered "Unsatisfiable" for an incoming pod if and only if every possible node assignment for that pod would violate "MaxSkew" on some topology. For example, in a 3-zone cluster, MaxSkew is set to 1, and pods with the same labelSelector spread as 3/1/1: | zone1 | zone2 | zone3 | | P P P | P | P | If WhenUnsatisfiable is set to DoNotSchedule, incoming pod can only be scheduled to zone2(zone3) to become 3/2/1(3/1/2) as ActualSkew(2-1) on zone2(zone3) satisfies MaxSkew(1). In other words, the cluster can still be imbalanced, but scheduler won't make it more imbalanced. It's a required field.

+

Possible enum values:

+
  • "DoNotSchedule" instructs the scheduler not to schedule the pod when constraints are not satisfied.
  • "ScheduleAnyway" instructs the scheduler to schedule the pod even if constraints are not satisfied.
+
+
+ +
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Table 42 io.cci.otc.api.pkg.apis.versioned.cci.v2.Volume

Parameter

+

Mandatory

+

Type

+

Description

+

configMap

+

No

+

io.cci.otc.api.pkg.apis.versioned.cci.v2.ConfigMapVolumeSource object

+

configMap represents a configMap that should populate this volume

+

downwardAPI

+

No

+

io.cci.otc.api.pkg.apis.versioned.cci.v2.DownwardAPIVolumeSource object

+

downwardAPI represents downward API about the pod that should populate this volume

+

emptyDir

+

No

+

io.cci.otc.api.pkg.apis.versioned.cci.v2.EmptyDirVolumeSource object

+

emptyDir represents a temporary directory that shares a pod's lifetime. More info: https://kubernetes.io/docs/concepts/storage/volumes#emptydir

+

ephemeral

+

No

+

io.cci.otc.api.pkg.apis.versioned.cci.v2.EphemeralVolumeSource object

+

ephemeral represents a volume that is handled by a cluster storage driver. The volume's lifecycle is tied to the pod that defines it - it will be created before the pod starts, and deleted when the pod is removed.

+

Use this if:

+

a) the volume is only needed while the pod runs,

+

b) features of normal volumes like restoring from snapshot or capacity tracking are needed,

+

c) the storage driver is specified through a storage class, and d) the storage driver supports dynamic volume provisioning through a PersistentVolumeClaim (see EphemeralVolumeSource for more information on the connection between this volume type and PersistentVolumeClaim).

+

Use PersistentVolumeClaim or one of the vendor-specific APIs for volumes that persist for longer than the lifecycle of an individual pod.

+

Use CSI for light-weight local ephemeral volumes if the CSI driver is meant to be used that way - see the documentation of the driver for more information.

+

A pod can use both types of ephemeral volumes and persistent volumes at the same time.

+

name

+

Yes

+

String

+

name of the volume. Must be a DNS_LABEL and unique within the pod. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names

+

nfs

+

No

+

io.cci.otc.api.pkg.apis.versioned.cci.v2.NFSVolumeSource object

+

nfs represents an NFS mount on the host that shares a pod's lifetime More info: https://kubernetes.io/docs/concepts/storage/volumes#nfs

+

persistentVolumeClaim

+

No

+

io.cci.otc.api.pkg.apis.versioned.cci.v2.PersistentVolumeClaimVolumeSource object

+

persistentVolumeClaimVolumeSource represents a reference to a PersistentVolumeClaim in the same namespace. More info: https://kubernetes.io/docs/concepts/storage/persistent-volumes#persistentvolumeclaims

+

projected

+

No

+

io.cci.otc.api.pkg.apis.versioned.cci.v2.ProjectedVolumeSource object

+

projected items for all in one resources secrets, configmaps, and downward API

+

secret

+

No

+

io.cci.otc.api.pkg.apis.versioned.cci.v2.SecretVolumeSource object

+

secret represents a secret that should populate this volume. More info: https://kubernetes.io/docs/concepts/storage/volumes#secret

+
+
+ +
+ + + + + + + + + + + + + + + + + + + + + + + + + + +
Table 43 io.cci.otc.api.pkg.apis.versioned.cci.v2.ConfigMapVolumeSource

Parameter

+

Mandatory

+

Type

+

Description

+

defaultMode

+

No

+

Integer

+

defaultMode is optional: mode bits used to set permissions on created files by default. Must be an octal value between 0000 and 0777 or a decimal value between 0 and 511. YAML accepts both octal and decimal values, JSON requires decimal values for mode bits. Defaults to 0644. Directories within the path are not affected by this setting. This might be in conflict with other options that affect the file mode, like fsGroup, and the result can be other mode bits set.

+

items

+

No

+

Array of io.cci.otc.api.pkg.apis.versioned.cci.v2.KeyToPath objects

+

items if unspecified, each key-value pair in the Data field of the referenced ConfigMap will be projected into the volume as a file whose name is the key and content is the value. If specified, the listed keys will be projected into the specified paths, and unlisted keys will not be present. If a key is specified which is not present in the ConfigMap, the volume setup will error unless it is marked optional. Paths must be relative and may not contain the '..' path or start with '..'.

+

name

+

No

+

String

+

Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names

+

optional

+

No

+

Boolean

+

optional specify whether the ConfigMap or its keys must be defined

+
+
+ +
+ + + + + + + + + + + + + + + + +
Table 44 io.cci.otc.api.pkg.apis.versioned.cci.v2.DownwardAPIVolumeSource

Parameter

+

Mandatory

+

Type

+

Description

+

defaultMode

+

No

+

Integer

+

Optional: mode bits to use on created files by default. Must be a Optional: mode bits used to set permissions on created files by default. Must be an octal value between 0000 and 0777 or a decimal value between 0 and 511. YAML accepts both octal and decimal values, JSON requires decimal values for mode bits. Defaults to 0644. Directories within the path are not affected by this setting. This might be in conflict with other options that affect the file mode, like fsGroup, and the result can be other mode bits set.

+

items

+

No

+

Array of io.cci.otc.api.pkg.apis.versioned.cci.v2.DownwardAPIVolumeFile objects

+

Items is a list of downward API volume file

+
+
+ +
+ + + + + + + + + + + + + + + + +
Table 45 io.cci.otc.api.pkg.apis.versioned.cci.v2.EmptyDirVolumeSource

Parameter

+

Mandatory

+

Type

+

Description

+

medium

+

No

+

String

+

medium represents what type of storage medium should back this directory. The default is "" which means to use the node's default medium. Must be an empty string (default) or Memory. More info: https://kubernetes.io/docs/concepts/storage/volumes#emptydir

+

sizeLimit

+

No

+

String

+

sizeLimit is the total amount of local storage required for this EmptyDir volume. The size limit is also applicable for memory medium. The maximum usage on memory medium EmptyDir would be the minimum value between the SizeLimit specified here and the sum of memory limits of all containers in a pod. The default is nil which means that the limit is undefined. More info: http://kubernetes.io/docs/user-guide/volumes#emptydir

+
+
+ +
+ + + + + + + + + + + +
Table 46 io.cci.otc.api.pkg.apis.versioned.cci.v2.EphemeralVolumeSource

Parameter

+

Mandatory

+

Type

+

Description

+

volumeClaimTemplate

+

No

+

io.cci.otc.api.pkg.apis.versioned.cci.v2.PersistentVolumeClaimTemplate object

+

Will be used to create a stand-alone PVC to provision the volume. The pod in which this EphemeralVolumeSource is embedded will be the owner of the PVC, i.e. the PVC will be deleted together with the pod. The name of the PVC will be <pod name>-<volume name> where <volume name> is the name from the PodSpec.Volumes array entry. Pod validation will reject the pod if the concatenated name is not valid for a PVC (for example, too long).

+

An existing PVC with that name that is not owned by the pod will not be used for the pod to avoid using an unrelated volume by mistake. Starting the pod is then blocked until the unrelated PVC is removed. If such a pre-created PVC is meant to be used by the pod, the PVC has to updated with an owner reference to the pod once the pod exists. Normally this should not be necessary, but it may be useful when manually reconstructing a broken cluster.

+

This field is read-only and no changes will be made by Kubernetes to the PVC after it has been created.

+

Required, must not be nil.

+
+
+ +
+ + + + + + + + + + + + + + + + +
Table 47 io.cci.otc.api.pkg.apis.versioned.cci.v2.PersistentVolumeClaimTemplate

Parameter

+

Mandatory

+

Type

+

Description

+

metadata

+

No

+

io.k8s.apimachinery.pkg.apis.meta.v1.ObjectMeta object

+

May contain labels and annotations that will be copied into the PVC when creating it. No other fields are allowed and will be rejected during validation.

+

spec

+

Yes

+

io.cci.otc.api.pkg.apis.versioned.cci.v2.PersistentVolumeClaimSpec object

+

The specification for the PersistentVolumeClaim. The entire content is copied unchanged into the PVC that gets created from this template. The same fields as in a PersistentVolumeClaim are also valid here.

+
+
+ +
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Table 48 io.k8s.apimachinery.pkg.apis.meta.v1.ObjectMeta

Parameter

+

Mandatory

+

Type

+

Description

+

annotations

+

No

+

Map<String,String>

+

Annotations is an unstructured key value map stored with a resource that may be set by external tools to store and retrieve arbitrary metadata. They are not queryable and should be preserved when modifying objects. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/annotations/

+

clusterName

+

No

+

String

+

The name of the cluster which the object belongs to. This is used to distinguish resources with same name and namespace in different clusters. This field is not set anywhere right now and apiserver is going to ignore it if set in create or update request.

+

creationTimestamp

+

No

+

String

+

CreationTimestamp is a timestamp representing the server time when this object was created. It is not guaranteed to be set in happens-before order across separate operations. Clients may not set this value. It is represented in RFC3339 form and is in UTC.

+

Populated by the system. Read-only. Null for lists. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata

+

deletionGracePeriodSeconds

+

No

+

Long

+

Number of seconds allowed for this object to gracefully terminate before it will be removed from the system. Only set when deletionTimestamp is also set. May only be shortened. Read-only.

+

deletionTimestamp

+

No

+

String

+

DeletionTimestamp is RFC 3339 date and time at which this resource will be deleted. This field is set by the server when a graceful deletion is requested by the user, and is not directly settable by a client. The resource is expected to be deleted (no longer visible from resource lists, and not reachable by name) after the time in this field, once the finalizers list is empty. As long as the finalizers list contains items, deletion is blocked. Once the deletionTimestamp is set, this value may not be unset or be set further into the future, although it may be shortened or the resource may be deleted prior to this time. For example, a user may request that a pod is deleted in 30 seconds. The Kubelet will react by sending a graceful termination signal to the containers in the pod. After that 30 seconds, the Kubelet will send a hard termination signal (SIGKILL) to the container and after cleanup, remove the pod from the API. In the presence of network partitions, this object may still exist after this timestamp, until an administrator or automated process can determine the resource is fully terminated. If not set, graceful deletion of the object has not been requested.

+

Populated by the system when a graceful deletion is requested. Read-only. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata

+

enable

+

No

+

Boolean

+

Enable identifies whether the resource is available

+

finalizers

+

No

+

Array of strings

+

Must be empty before the object is deleted from the registry.

+

Each entry is an identifier for the responsible component that will remove the entry from the list. If the deletionTimestamp of the object is non-nil, entries in this list can only be removed. Finalizers may be processed and removed in any order. Order is NOT enforced because it introduces significant risk of stuck finalizers. finalizers is a shared field, any actor with permission can reorder it. If the finalizer list is processed in order, then this can lead to a situation in which the component responsible for the first finalizer in the list is waiting for a signal (field value, external system, or other) produced by a component responsible for a finalizer later in the list, resulting in a deadlock. Without enforced ordering finalizers are free to order amongst themselves and are not vulnerable to ordering changes in the list.

+

generateName

+

No

+

String

+

GenerateName is an optional prefix, used by the server, to generate a unique name ONLY IF the Name field has not been provided. If this field is used, the name returned to the client will be different than the name passed. This value will also be combined with a unique suffix. The provided value has the same validation rules as the Name field, and may be truncated by the length of the suffix required to make the value unique on the server.

+

If this field is specified and the generated name exists, the server will NOT return a 409 - instead, it will either return 201 Created or 500 with Reason ServerTimeout indicating a unique name could not be found in the time allotted, and the client should retry (optionally after the time indicated in the Retry-After header).

+

Applied only if Name is not specified. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#idempotency

+

generation

+

No

+

Long

+

A sequence number representing a specific generation of the desired state. Populated by the system. Read-only.

+

labels

+

No

+

Map<String,String>

+

Map of string keys and values that can be used to organize and categorize (scope and select) objects. May match selectors of replication controllers and services. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/labels/

+

managedFields

+

No

+

Array of io.k8s.apimachinery.pkg.apis.meta.v1.ManagedFieldsEntry objects

+

ManagedFields maps workflow-id and version to the set of fields that are managed by that workflow. This is mostly for internal housekeeping, and users typically shouldn't need to set or understand this field. A workflow can be the user's name, a controller's name, or the name of a specific apply path like "ci-cd". The set of fields is always in the version that the workflow used when modifying the object.

+

name

+

No

+

String

+

Name must be unique within a namespace. Is required when creating resources, although some resources may allow a client to request the generation of an appropriate name automatically. Name is primarily intended for creation idempotence and configuration definition. Cannot be updated. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names

+

namespace

+

No

+

String

+

Namespace defines the space within which each name must be unique. An empty namespace is equivalent to the "default" namespace, but "default" is the canonical representation. Not all objects are required to be scoped to a namespace - the value of this field for those objects will be empty.

+

Must be a DNS_LABEL. Cannot be updated. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/namespaces/

+

ownerReferences

+

No

+

Array of io.k8s.apimachinery.pkg.apis.meta.v1.OwnerReference objects

+

List of objects depended by this object. If ALL objects in the list have been deleted, this object will be garbage collected. If this object is managed by a controller, then an entry in this list will point to this controller, with the controller field set to true. There cannot be more than one managing controller.

+

resourceVersion

+

No

+

String

+

An opaque value that represents the internal version of this object that can be used by clients to determine when objects have changed. May be used for optimistic concurrency, change detection, and the watch operation on a resource or set of resources. Clients must treat these values as opaque and passed unmodified back to the server. They may only be valid for a particular resource or set of resources.

+

Populated by the system. Read-only. Value must be treated as opaque by clients and . More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#concurrency-control-and-consistency

+

selfLink

+

No

+

String

+

SelfLink is a URL representing this object. Populated by the system. Read-only.

+

DEPRECATED Kubernetes will stop propagating this field in 1.20 release and the field is planned to be removed in 1.21 release.

+

uid

+

No

+

String

+

UID is the unique in time and space value for this object. It is typically generated by the server on successful creation of a resource and is not allowed to change on PUT operations.

+

Populated by the system. Read-only. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#uids

+
+
+ +
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Table 49 io.k8s.apimachinery.pkg.apis.meta.v1.ManagedFieldsEntry

Parameter

+

Mandatory

+

Type

+

Description

+

apiVersion

+

No

+

String

+

APIVersion defines the version of this resource that this field set applies to. The format is "group/version" just like the top-level APIVersion field. It is necessary to track the version of a field set because it cannot be automatically converted.

+

fieldsType

+

No

+

String

+

FieldsType is the discriminator for the different fields format and version. There is currently only one possible value: "FieldsV1"

+

fieldsV1

+

No

+

Object

+

FieldsV1 holds the first JSON version format as described in the "FieldsV1" type.

+

manager

+

No

+

String

+

Manager is an identifier of the workflow managing these fields.

+

operation

+

No

+

String

+

Operation is the type of operation which lead to this ManagedFieldsEntry being created. The only valid values for this field are 'Apply' and 'Update'.

+

time

+

No

+

String

+

Time is timestamp of when these fields were set. It should always be empty if Operation is 'Apply'

+
+
+ +
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Table 50 io.k8s.apimachinery.pkg.apis.meta.v1.OwnerReference

Parameter

+

Mandatory

+

Type

+

Description

+

apiVersion

+

Yes

+

String

+

API version of the referent.

+

blockOwnerDeletion

+

No

+

Boolean

+

If true, AND if the owner has the "foregroundDeletion" finalizer, then the owner cannot be deleted from the key-value store until this reference is removed. Defaults to false. To set this field, a user needs "delete" permission of the owner, otherwise 422 (Unprocessable Entity) will be returned.

+

controller

+

No

+

Boolean

+

If true, this reference points to the managing controller.

+

kind

+

Yes

+

String

+

Kind of the referent. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds

+

name

+

Yes

+

String

+

Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names

+

uid

+

Yes

+

String

+

UID of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#uids

+
+
+ +
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Table 51 io.cci.otc.api.pkg.apis.versioned.cci.v2.PersistentVolumeClaimSpec

Parameter

+

Mandatory

+

Type

+

Description

+

accessModes

+

No

+

Array of strings

+

accessModes contains the desired access modes the volume should have. More info: https://kubernetes.io/docs/concepts/storage/persistent-volumes#access-modes-1

+

dataSource

+

No

+

io.cci.otc.api.pkg.apis.versioned.cci.v2.TypedLocalObjectReference object

+

dataSource field can be used to specify either: * An existing VolumeSnapshot object (snapshot.storage.k8s.io/VolumeSnapshot) * An existing PVC (PersistentVolumeClaim) If the provisioner or an external controller can support the specified data source, it will create a new volume based on the contents of the specified data source. If the AnyVolumeDataSource feature gate is enabled, this field will always have the same contents as the DataSourceRef field.

+

dataSourceRef

+

No

+

io.cci.otc.api.pkg.apis.versioned.cci.v2.TypedLocalObjectReference object

+

dataSourceRef specifies the object from which to populate the volume with data, if a non-empty volume is desired. This may be any local object from a non-empty API group (non core object) or a PersistentVolumeClaim object. When this field is specified, volume binding will only succeed if the type of the specified object matches some installed volume populator or dynamic provisioner. This field will replace the functionality of the DataSource field and as such if both fields are non-empty, they must have the same value. For backwards compatibility, both fields (DataSource and DataSourceRef) will be set to the same value automatically if one of them is empty and the other is non-empty. There are two important differences between DataSource and DataSourceRef: * While DataSource only allows two specific types of objects, DataSourceRef

+

allows any non-core object, as well as PersistentVolumeClaim objects.

+
  • While DataSource ignores disallowed values (dropping them), DataSourceRef

    preserves all values, and generates an error if a disallowed value is

    +

    specified.

    +

    (Beta) Using this field requires the AnyVolumeDataSource feature gate to be enabled.

    +
+

resources

+

No

+

io.cci.otc.api.pkg.apis.versioned.cci.v2.ResourceRequirements object

+

resources represents the minimum resources the volume should have. If RecoverVolumeExpansionFailure feature is enabled users are allowed to specify resource requirements that are lower than previous value but must still be higher than capacity recorded in the status field of the claim. More info: https://kubernetes.io/docs/concepts/storage/persistent-volumes#resources

+

selector

+

No

+

io.k8s.apimachinery.pkg.apis.meta.v1.LabelSelector object

+

selector is a label query over volumes to consider for binding.

+

storageClassName

+

No

+

String

+

storageClassName is the name of the StorageClass required by the claim. More info: https://kubernetes.io/docs/concepts/storage/persistent-volumes#class-1

+

volumeMode

+

No

+

String

+

volumeMode defines what type of volume is required by the claim.

+

Value of Filesystem is implied when not included in claim spec.

+

volumeName

+

No

+

String

+

volumeName is the binding reference to the PersistentVolume backing this claim.

+
+
+ +
+ + + + + + + + + + + + + + + + + + + + + +
Table 52 io.cci.otc.api.pkg.apis.versioned.cci.v2.TypedLocalObjectReference

Parameter

+

Mandatory

+

Type

+

Description

+

apiGroup

+

No

+

String

+

APIGroup is the group for the resource being referenced. If APIGroup is not specified, the specified Kind must be in the core API group. For any other third-party types, APIGroup is required.

+

kind

+

Yes

+

String

+

Kind is the type of resource being referenced

+

name

+

Yes

+

String

+

Name is the name of resource being referenced

+
+
+ +
+ + + + + + + + + + + + + + + + +
Table 53 io.cci.otc.api.pkg.apis.versioned.cci.v2.ResourceRequirements

Parameter

+

Mandatory

+

Type

+

Description

+

limits

+

No

+

Map<String,String>

+

Limits describes the maximum amount of compute resources allowed. More info: https://kubernetes.io/docs/concepts/configuration/manage-resources-containers/

+

requests

+

No

+

Map<String,String>

+

Requests describes the minimum amount of compute resources required. If Requests is omitted for a container, it defaults to Limits if that is explicitly specified, otherwise to an implementation-defined value. More info: https://kubernetes.io/docs/concepts/configuration/manage-resources-containers/

+
+
+ +
+ + + + + + + + + + + +
Table 54 io.k8s.apimachinery.pkg.api.resource.Quantity

Parameter

+

Mandatory

+

Type

+

Description

+

-

+

No

+

String

+

Quantity is a fixed-point representation of a number. It provides convenient marshaling/unmarshaling in JSON and YAML, in addition to String() and AsInt64() accessors.

+

The serialization format is:

+

[/topic/body/section/table/tgroup/tbody/row/entry/p/br {""})(br] ::= [/topic/body/section/table/tgroup/tbody/row/entry/p/br {""})(br][/topic/body/section/table/tgroup/tbody/row/entry/p/br {""})(br]

+

(Note that [/topic/body/section/table/tgroup/tbody/row/entry/p/br {""})(br] may be empty, from the "" case in [/topic/body/section/table/tgroup/tbody/row/entry/p/br {""})(br].)

+

[/topic/body/section/table/tgroup/tbody/row/entry/p/br {""})(br] ::= 0 | 1 | ... | 9 [/topic/body/section/table/tgroup/tbody/row/entry/p/br {""})(br] ::= [/topic/body/section/table/tgroup/tbody/row/entry/p/br {""})(br] | [/topic/body/section/table/tgroup/tbody/row/entry/p/br {""})(br][/topic/body/section/table/tgroup/tbody/row/entry/p/br {""})(br][/topic/body/section/table/tgroup/tbody/row/entry/p/br {""})(br] ::= [/topic/body/section/table/tgroup/tbody/row/entry/p/br {""})(br] | [/topic/body/section/table/tgroup/tbody/row/entry/p/br {""})(br].[/topic/body/section/table/tgroup/tbody/row/entry/p/br {""})(br] | [/topic/body/section/table/tgroup/tbody/row/entry/p/br {""})(br]. | .[/topic/body/section/table/tgroup/tbody/row/entry/p/br {""})(br][/topic/body/section/table/tgroup/tbody/row/entry/p/br {""})(br] ::= "+" | "-" [/topic/body/section/table/tgroup/tbody/row/entry/p/br {""})(br] ::= [/topic/body/section/table/tgroup/tbody/row/entry/p/br {""})(br] | [/topic/body/section/table/tgroup/tbody/row/entry/p/br {""})(br][/topic/body/section/table/tgroup/tbody/row/entry/p/br {""})(br][/topic/body/section/table/tgroup/tbody/row/entry/p/br {""})(br] ::= [/topic/body/section/table/tgroup/tbody/row/entry/p/br {""})(br] | [/topic/body/section/table/tgroup/tbody/row/entry/p/br {""})(br] | [/topic/body/section/table/tgroup/tbody/row/entry/p/br {""})(br][/topic/body/section/table/tgroup/tbody/row/entry/p/br {""})(br] ::= Ki | Mi | Gi | Ti | Pi | Ei

+

(International System of units; See: http://physics.nist.gov/cuu/Units/binary.html)

+

[/topic/body/section/table/tgroup/tbody/row/entry/p/br {""})(br] ::= m | "" | k | M | G | T | P | E

+

(Note that 1024 = 1Ki but 1000 = 1k; I didn't choose the capitalization.)

+

[/topic/body/section/table/tgroup/tbody/row/entry/p/br {""})(br] ::= "e" [/topic/body/section/table/tgroup/tbody/row/entry/p/br {""})(br] | "E" [/topic/body/section/table/tgroup/tbody/row/entry/p/br {""})(br]

+

No matter which of the three exponent forms is used, no quantity may represent a number greater than 2^63-1 in magnitude, nor may it have more than 3 decimal places. Numbers larger or more precise will be capped or rounded up. (E.g.: 0.1m will rounded up to 1m.) This may be extended in the future if we require larger or smaller quantities.

+

When a Quantity is parsed from a string, it will remember the type of suffix it had, and will use the same type again when it is serialized.

+

Before serializing, Quantity will be put in "canonical form". This means that Exponent/suffix will be adjusted up or down (with a corresponding increase or decrease in Mantissa) such that:

+

a. No precision is lost

+

b. No fractional digits will be emitted

+

c. The exponent (or suffix) is as large as possible.

+

The sign will be omitted unless the number is negative.

+

Examples:

+

1.5 will be serialized as "1500m"

+

1.5Gi will be serialized as "1536Mi"

+

Note that the quantity will NEVER be internally represented by a floating point number. That is the whole point of this exercise.

+

Non-canonical values will still parse as long as they are well formed, but will be re-emitted in their canonical form. (So always use canonical form, or don't diff.)

+

This format is intended to make it difficult to use these numbers without writing some sort of special handling code in the hopes that that will cause implementors to also use a fixed point implementation.

+
+
+ +
+ + + + + + + + + + + + + + + + +
Table 55 io.k8s.apimachinery.pkg.apis.meta.v1.LabelSelector

Parameter

+

Mandatory

+

Type

+

Description

+

matchExpressions

+

No

+

Array of io.k8s.apimachinery.pkg.apis.meta.v1.LabelSelectorRequirement objects

+

matchExpressions is a list of label selector requirements. The requirements are ANDed.

+

matchLabels

+

No

+

Map<String,String>

+

matchLabels is a map of {key,value} pairs. A single {key,value} in the matchLabels map is equivalent to an element of matchExpressions, whose key field is "key", the operator is "In", and the values array contains only "value". The requirements are ANDed.

+
+
+ +
+ + + + + + + + + + + + + + + + + + + + + +
Table 56 io.k8s.apimachinery.pkg.apis.meta.v1.LabelSelectorRequirement

Parameter

+

Mandatory

+

Type

+

Description

+

key

+

Yes

+

String

+

key is the label key that the selector applies to.

+

operator

+

Yes

+

String

+

operator represents a key's relationship to a set of values.

+

Valid operators are In, NotIn, Exists and DoesNotExist.

+

values

+

No

+

Array of strings

+

values is an array of string values. If the operator is In or

+

NotIn, the values array must be non-empty. If the operator is Exists or

+

DoesNotExist, the values array must be empty. This array is replaced during

+

a strategic merge patch.

+
+
+ +
+ + + + + + + + + + + + + + + + + + + + + +
Table 57 io.cci.otc.api.pkg.apis.versioned.cci.v2.NFSVolumeSource

Parameter

+

Mandatory

+

Type

+

Description

+

path

+

Yes

+

String

+

path that is exported by the NFS server. More info: https://kubernetes.io/docs/concepts/storage/volumes#nfs

+

readOnly

+

No

+

Boolean

+

readOnly here will force the NFS export to be mounted with read-only permissions. Defaults to false. More info: https://kubernetes.io/docs/concepts/storage/volumes#nfs

+

server

+

Yes

+

String

+

server is the hostname or IP address of the NFS server. More info: https://kubernetes.io/docs/concepts/storage/volumes#nfs

+
+
+ +
+ + + + + + + + + + + + + + + + +
Table 58 io.cci.otc.api.pkg.apis.versioned.cci.v2.PersistentVolumeClaimVolumeSource

Parameter

+

Mandatory

+

Type

+

Description

+

claimName

+

Yes

+

String

+

claimName is the name of a PersistentVolumeClaim in the same namespace as the pod using this volume. More info: https://kubernetes.io/docs/concepts/storage/persistent-volumes#persistentvolumeclaims

+

readOnly

+

No

+

Boolean

+

readOnly Will force the ReadOnly setting in VolumeMounts. Default

+

false.

+
+
+ +
+ + + + + + + + + + + + + + + + +
Table 59 io.cci.otc.api.pkg.apis.versioned.cci.v2.ProjectedVolumeSource

Parameter

+

Mandatory

+

Type

+

Description

+

defaultMode

+

No

+

Integer

+

defaultMode are the mode bits used to set permissions on created

+

files by default. Must be an octal value between 0000 and 0777 or a decimal

+

value between 0 and 511. YAML accepts both octal and decimal values, JSON

+

requires decimal values for mode bits. Directories within the path are not

+

affected by this setting. This might be in conflict with other options that

+

affect the file mode, like fsGroup, and the result can be other mode bits

+

set.

+

sources

+

No

+

Array of io.cci.otc.api.pkg.apis.versioned.cci.v2.VolumeProjection objects

+

sources is the list of volume projections

+
+
+ +
+ + + + + + + + + + + + + + + + + + + + + +
Table 60 io.cci.otc.api.pkg.apis.versioned.cci.v2.VolumeProjection

Parameter

+

Mandatory

+

Type

+

Description

+

configMap

+

No

+

io.cci.otc.api.pkg.apis.versioned.cci.v2.ConfigMapProjection object

+

configMap information about the configMap data to project

+

downwardAPI

+

No

+

io.cci.otc.api.pkg.apis.versioned.cci.v2.DownwardAPIProjection object

+

downwardAPI information about the downwardAPI data to project

+

secret

+

No

+

io.cci.otc.api.pkg.apis.versioned.cci.v2.SecretProjection object

+

secret information about the secret data to project

+
+
+ +
+ + + + + + + + + + + + + + + + + + + + + +
Table 61 io.cci.otc.api.pkg.apis.versioned.cci.v2.ConfigMapProjection

Parameter

+

Mandatory

+

Type

+

Description

+

items

+

No

+

Array of io.cci.otc.api.pkg.apis.versioned.cci.v2.KeyToPath objects

+

items if unspecified, each key-value pair in the Data field of

+

the referenced ConfigMap will be projected into the volume as a file whose

+

name is the key and content is the value. If specified, the listed keys

+

will be projected into the specified paths, and unlisted keys will not be

+

present. If a key is specified which is not present in the ConfigMap, the

+

volume setup will error unless it is marked optional. Paths must be relative

+

and may not contain the '..' path or start with '..'.

+

name

+

No

+

String

+

Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names

+

optional

+

No

+

Boolean

+

optional specify whether the ConfigMap or its keys must be defined

+
+
+ +
+ + + + + + + + + + + +
Table 62 io.cci.otc.api.pkg.apis.versioned.cci.v2.DownwardAPIProjection

Parameter

+

Mandatory

+

Type

+

Description

+

items

+

No

+

Array of io.cci.otc.api.pkg.apis.versioned.cci.v2.DownwardAPIVolumeFile objects

+

Items is a list of DownwardAPIVolume file

+
+
+ +
+ + + + + + + + + + + + + + + + + + + + + + + + + + +
Table 63 io.cci.otc.api.pkg.apis.versioned.cci.v2.DownwardAPIVolumeFile

Parameter

+

Mandatory

+

Type

+

Description

+

fieldRef

+

No

+

io.cci.otc.api.pkg.apis.versioned.cci.v2.ObjectFieldSelector object

+

Required: Selects a field of the pod: only annotations, labels, name and namespace are supported.

+

mode

+

No

+

Integer

+

Optional: mode bits used to set permissions on this file, must be an octal value between 0000 and 0777 or a decimal value between 0 and 511. YAML accepts both octal and decimal values, JSON requires decimal values for mode bits. If not specified, the volume defaultMode will be used. This might be in conflict with other options that affect the file mode, like fsGroup, and the result can be other mode bits set.

+

path

+

Yes

+

String

+

Required: Path is the relative path name of the file to be created. Must not be absolute or contain the '..' path. Must be utf-8 encoded. The first item of the relative path must not start with '..'

+

resourceFieldRef

+

No

+

io.cci.otc.api.pkg.apis.versioned.cci.v2.ResourceFieldSelector object

+

Selects a resource of the container: only resources limits and requests (limits.cpu, limits.memory, requests.cpu and requests.memory) are currently supported.

+
+
+ +
+ + + + + + + + + + + + + + + + +
Table 64 io.cci.otc.api.pkg.apis.versioned.cci.v2.ObjectFieldSelector

Parameter

+

Mandatory

+

Type

+

Description

+

apiVersion

+

No

+

String

+

Version of the schema the FieldPath is written in terms of, defaults

+

to "v1".

+

fieldPath

+

Yes

+

String

+

Path of the field to select in the specified API version.

+
+
+ +
+ + + + + + + + + + + + + + + + + + + + + +
Table 65 io.cci.otc.api.pkg.apis.versioned.cci.v2.ResourceFieldSelector

Parameter

+

Mandatory

+

Type

+

Description

+

containerName

+

No

+

String

+

Container name: required for volumes, optional for env vars

+

divisor

+

No

+

String

+

Specifies the output format of the exposed resources, defaults

+

to "1"

+

resource

+

Yes

+

String

+

Required: resource to select

+
+
+ +
+ + + + + + + + + + + + + + + + + + + + + +
Table 66 io.cci.otc.api.pkg.apis.versioned.cci.v2.SecretProjection

Parameter

+

Mandatory

+

Type

+

Description

+

items

+

No

+

Array of io.cci.otc.api.pkg.apis.versioned.cci.v2.KeyToPath objects

+

items if unspecified, each key-value pair in the Data field of

+

the referenced Secret will be projected into the volume as a file whose

+

name is the key and content is the value. If specified, the listed keys

+

will be projected into the specified paths, and unlisted keys will not be

+

present. If a key is specified which is not present in the Secret, the volume

+

setup will error unless it is marked optional. Paths must be relative and

+

may not contain the '..' path or start with '..'.

+

name

+

No

+

String

+

Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names

+

optional

+

No

+

Boolean

+

optional field specify whether the Secret or its key must be

+

defined

+
+
+ +
+ + + + + + + + + + + + + + + + + + + + + + + + + + +
Table 67 io.cci.otc.api.pkg.apis.versioned.cci.v2.SecretVolumeSource

Parameter

+

Mandatory

+

Type

+

Description

+

defaultMode

+

No

+

Integer

+

defaultMode is Optional: mode bits used to set permissions on created files by default. Must be an octal value between 0000 and 0777 or a decimal value between 0 and 511. YAML accepts both octal and decimal values, JSON requires decimal values for mode bits. Defaults to 0644. Directories within the path are not affected by this setting. This might be in conflict with other options that affect the file mode, like fsGroup, and the result can be other mode bits set.

+

items

+

No

+

Array of io.cci.otc.api.pkg.apis.versioned.cci.v2.KeyToPath objects

+

items If unspecified, each key-value pair in the Data field of

+

the referenced Secret will be projected into the volume as a file whose

+

name is the key and content is the value. If specified, the listed keys

+

will be projected into the specified paths, and unlisted keys will not be

+

present. If a key is specified which is not present in the Secret, the volume

+

setup will error unless it is marked optional. Paths must be relative and

+

may not contain the '..' path or start with '..'.

+

optional

+

No

+

Boolean

+

optional field specify whether the Secret or its keys must be

+

defined

+

secretName

+

No

+

String

+

secretName is the name of the secret in the pod's namespace to use. More info: https://kubernetes.io/docs/concepts/storage/volumes#secret

+
+
+ +
+ + + + + + + + + + + + + + + + + + + + + +
Table 68 io.cci.otc.api.pkg.apis.versioned.cci.v2.KeyToPath

Parameter

+

Mandatory

+

Type

+

Description

+

key

+

Yes

+

String

+

key is the key to project.

+

mode

+

No

+

Integer

+

mode is Optional: mode bits used to set permissions on this file. Must be an octal value between 0000 and 0777 or a decimal value between 0 and 511. YAML accepts both octal and decimal values, JSON requires decimal values for mode bits. If not specified, the volume defaultMode will be used. This might be in conflict with other options that affect the file mode, like fsGroup, and the result can be other mode bits set.

+

path

+

Yes

+

String

+

path is the relative path of the file to map the key to. May

+

not be an absolute path. May not contain the path element '..'. May not

+

start with the string '..'.

+
+
+ +
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Table 69 io.cci.otc.api.pkg.apis.versioned.cci.v2.PodStatus

Parameter

+

Mandatory

+

Type

+

Description

+

conditions

+

No

+

Array of io.cci.otc.api.pkg.apis.versioned.cci.v2.PodCondition objects

+

Current service state of pod. More info: https://kubernetes.io/docs/concepts/workloads/pods/pod-lifecycle#pod-conditions

+

containerStatuses

+

No

+

Array of io.cci.otc.api.pkg.apis.versioned.cci.v2.ContainerStatus objects

+

The list has one entry per container in the manifest. More info: https://kubernetes.io/docs/concepts/workloads/pods/pod-lifecycle#pod-and-container-status

+

ephemeralContainerStatuses

+

No

+

Array of io.cci.otc.api.pkg.apis.versioned.cci.v2.ContainerStatus objects

+

Status for any ephemeral containers that have run in this pod.

+

hostIP

+

No

+

String

+

IP address of the host to which the pod is assigned. Empty if

+

not yet scheduled.

+

initContainerStatuses

+

No

+

Array of io.cci.otc.api.pkg.apis.versioned.cci.v2.ContainerStatus objects

+

The list has one entry per init container in the manifest. The most recent successful init container will have ready = true, the most recently started container will have startTime set. More info: https://kubernetes.io/docs/concepts/workloads/pods/pod-lifecycle#pod-and-container-status

+

message

+

No

+

String

+

A human readable message indicating details about why the pod

+

is in this condition.

+

nominatedNodeName

+

No

+

String

+

nominatedNodeName is set only when this pod preempts other pods

+

on the node, but it cannot be scheduled right away as preemption victims

+

receive their graceful termination periods. This field does not guarantee

+

that the pod will be scheduled on this node. Scheduler may decide to place

+

the pod elsewhere if other nodes become available sooner. Scheduler may

+

also decide to give the resources on this node to a higher priority pod

+

that is created after preemption. As a result, this field may be different

+

than PodSpec.nodeName when the pod is scheduled.

+

phase

+

No

+

String

+

The phase of a Pod is a simple, high-level summary of where the Pod is in its lifecycle. The conditions array, the reason and message fields, and the individual container status arrays contain more detail about the pod's status. There are five possible phase values:

+

Pending: The pod has been accepted by the Kubernetes system, but one or more of the container images has not been created. This includes time before being scheduled as well as time spent downloading images over the network, which could take a while. Running: The pod has been bound to a node, and all of the containers have been created. At least one container is still running, or is in the process of starting or restarting. Succeeded: All containers in the pod have terminated in success, and will not be restarted. Failed: All containers in the pod have terminated, and at least one container has terminated in failure. The container either exited with non-zero status or was terminated by the system. Unknown: For some reason the state of the pod could not be obtained, typically due to an error in communicating with the host of the pod.

+

More info: https://kubernetes.io/docs/concepts/workloads/pods/pod-lifecycle#pod-phase

+

Possible enum values:

+
  • "Failed" means that all containers in the pod have terminated, and at least one container has terminated in a failure (exited with a non-zero exit code or was stopped by the system).
  • "Pending" means the pod has been accepted by the system, but one or more of the containers has not been started. This includes time before being bound to a node, as well as time spent pulling images onto the host.
  • "Running" means the pod has been bound to a node and all of the containers have been started. At least one container is still running or is in the process of being restarted.
  • "Succeeded" means that all containers in the pod have voluntarily terminated with a container exit code of 0, and the system is not going to restart any of these containers.
  • "Unknown" means that for some reason the state of the pod could not be obtained, typically due to an error in communicating with the host of the pod. Deprecated: It isn't being set since 2015 (74da3b14b0c0f658b3bb8d2def5094686d0e9095)
+

podIP

+

No

+

String

+

IP address allocated to the pod. Routable at least within the

+

cluster. Empty if not yet allocated.

+

podIPs

+

No

+

Array of io.cci.otc.api.pkg.apis.versioned.cci.v2.PodIP objects

+

podIPs holds the IP addresses allocated to the pod. If this field

+

is specified, the 0th entry must match the podIP field. Pods may be allocated

+

at most 1 value for each of IPv4 and IPv6. This list is empty if no IPs

+

have been allocated yet.

+

qosClass

+

No

+

String

+

The Quality of Service (QOS) classification assigned to the pod based on resource requirements See PodQOSClass type for available QOS classes More info: https://git.k8s.io/community/contributors/design-proposals/node/resource-qos.md

+

Possible enum values:

+
  • "BestEffort" is the BestEffort qos class.
  • "Burstable" is the Burstable qos class.
  • "Guaranteed" is the Guaranteed qos class.
+

reason

+

No

+

String

+

A brief CamelCase message indicating details about why the pod

+

is in this state. e.g. 'Evicted'

+

startTime

+

No

+

String

+

RFC 3339 date and time at which the object was acknowledged by

+

the Kubelet. This is before the Kubelet pulled the container image(s) for

+

the pod.

+
+
+ +
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Table 70 io.cci.otc.api.pkg.apis.versioned.cci.v2.PodCondition

Parameter

+

Mandatory

+

Type

+

Description

+

lastProbeTime

+

No

+

String

+

Last time we probed the condition.

+

lastTransitionTime

+

No

+

String

+

Last time the condition transitioned from one status to another.

+

message

+

No

+

String

+

Human-readable message indicating details about last transition.

+

reason

+

No

+

String

+

Unique, one-word, CamelCase reason for the condition's last transition.

+

status

+

Yes

+

String

+

Status is the status of the condition. Can be True, False, Unknown. More info: https://kubernetes.io/docs/concepts/workloads/pods/pod-lifecycle#pod-conditions

+

type

+

Yes

+

String

+

Type is the type of the condition. More info: https://kubernetes.io/docs/concepts/workloads/pods/pod-lifecycle#pod-conditions

+
+
+ +
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Table 71 io.cci.otc.api.pkg.apis.versioned.cci.v2.ContainerStatus

Parameter

+

Mandatory

+

Type

+

Description

+

containerID

+

No

+

String

+

Container's ID in the format '[/topic/body/section/table/tgroup/tbody/row/entry/p/br {""})(br]://<container_id>'.

+

image

+

Yes

+

String

+

The image the container is running. More info: https://kubernetes.io/docs/concepts/containers/images.

+

imageID

+

Yes

+

String

+

ImageID of the container's image.

+

lastState

+

No

+

io.cci.otc.api.pkg.apis.versioned.cci.v2.ContainerState object

+

Details about the container's last termination condition.

+

name

+

Yes

+

String

+

This must be a DNS_LABEL. Each container in a pod must have a

+

unique name. Cannot be updated.

+

ready

+

Yes

+

Boolean

+

Specifies whether the container has passed its readiness probe.

+

restartCount

+

Yes

+

Integer

+

The number of times the container has been restarted.

+

started

+

No

+

Boolean

+

Specifies whether the container has passed its startup probe.

+

Initialized as false, becomes true after startupProbe is considered successful.

+

Resets to false when the container is restarted, or if kubelet loses state

+

temporarily. Is always true when no startupProbe is defined.

+

state

+

No

+

io.cci.otc.api.pkg.apis.versioned.cci.v2.ContainerState object

+

Details about the container's current condition.

+
+
+ +
+ + + + + + + + + + + + + + + + + + + + + +
Table 72 io.cci.otc.api.pkg.apis.versioned.cci.v2.ContainerState

Parameter

+

Mandatory

+

Type

+

Description

+

running

+

No

+

io.cci.otc.api.pkg.apis.versioned.cci.v2.ContainerStateRunning object

+

Details about a running container

+

terminated

+

No

+

io.cci.otc.api.pkg.apis.versioned.cci.v2.ContainerStateTerminated object

+

Details about a terminated container

+

waiting

+

No

+

io.cci.otc.api.pkg.apis.versioned.cci.v2.ContainerStateWaiting object

+

Details about a waiting container

+
+
+ +
+ + + + + + + + + + + +
Table 73 io.cci.otc.api.pkg.apis.versioned.cci.v2.ContainerStateRunning

Parameter

+

Mandatory

+

Type

+

Description

+

startedAt

+

No

+

String

+

Time at which the container was last (re-)started

+
+
+ +
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Table 74 io.cci.otc.api.pkg.apis.versioned.cci.v2.ContainerStateTerminated

Parameter

+

Mandatory

+

Type

+

Description

+

containerID

+

No

+

String

+

Container's ID in the format '[/topic/body/section/table/tgroup/tbody/row/entry/p/br {""})(br]://<container_id>'

+

exitCode

+

Yes

+

Integer

+

Exit status from the last termination of the container

+

finishedAt

+

No

+

String

+

Time at which the container last terminated

+

message

+

No

+

String

+

Message regarding the last termination of the container

+

reason

+

No

+

String

+

(brief) reason from the last termination of the container

+

signal

+

No

+

Integer

+

Signal from the last termination of the container

+

startedAt

+

No

+

String

+

Time at which previous execution of the container started

+
+
+ +
+ + + + + + + + + + + + + + + + +
Table 75 io.cci.otc.api.pkg.apis.versioned.cci.v2.ContainerStateWaiting

Parameter

+

Mandatory

+

Type

+

Description

+

message

+

No

+

String

+

Message regarding why the container is not yet running.

+

reason

+

No

+

String

+

(brief) reason the container is not yet running.

+
+
+ +
+ + + + + + + + + + + +
Table 76 io.cci.otc.api.pkg.apis.versioned.cci.v2.PodIP

Parameter

+

Mandatory

+

Type

+

Description

+

ip

+

No

+

String

+

ip is an IP address (IPv4 or IPv6) assigned to the pod

+
+
+
+

Response Parameters

Status code: 200

+ +
+ + + + + + + + + + + + + + + + + + + + + + + + + +
Table 77 Response body parameters

Parameter

+

Type

+

Description

+

apiVersion

+

String

+

APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#resources

+

kind

+

String

+

Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds

+

metadata

+

io.k8s.apimachinery.pkg.apis.meta.v1.ObjectMeta object

+

Standard object's metadata. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata

+

spec

+

io.cci.otc.api.pkg.apis.versioned.cci.v2.PodSpec object

+

Specification of the desired behavior of the pod. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#spec-and-status

+

status

+

io.cci.otc.api.pkg.apis.versioned.cci.v2.PodStatus object

+

Most recently observed status of the pod. This data may not be up to date. Populated by the system. Read-only. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#spec-and-status

+
+
+ +
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Table 78 io.cci.otc.api.pkg.apis.versioned.cci.v2.PodSpec

Parameter

+

Type

+

Description

+

activeDeadlineSeconds

+

Long

+

Optional duration in seconds the pod may be active on the node

+

relative to StartTime before the system will actively try to mark it failed

+

and kill associated containers. Value must be a positive integer.

+

affinity

+

io.cci.otc.api.pkg.apis.versioned.cci.v2.Affinity object

+

If specified, the pod's scheduling constraints

+

containers

+

Array of io.cci.otc.api.pkg.apis.versioned.cci.v2.Container objects

+

List of containers belonging to the pod. Containers cannot currently

+

be added or removed. There must be at least one container in a Pod. Cannot

+

be updated.

+

dnsConfig

+

io.cci.otc.api.pkg.apis.versioned.cci.v2.PodDNSConfig object

+

Specifies the DNS parameters of a pod. Parameters specified here

+

will be merged to the generated DNS configuration based on DNSPolicy.

+

dnsPolicy

+

String

+

Set DNS policy for the pod. Defaults to "ClusterFirst". Valid values are 'ClusterFirstWithHostNet', 'ClusterFirst', 'Default' or 'None'. DNS parameters given in DNSConfig will be merged with the policy selected with DNSPolicy. To have DNS options set along with hostNetwork, you have to specify DNS policy explicitly to 'ClusterFirstWithHostNet'.

+

Possible enum values:

+
  • "ClusterFirst" indicates that the pod should use cluster DNS first unless hostNetwork is true, if it is available, then fall back on the default (as determined by kubelet) DNS settings.
  • "ClusterFirstWithHostNet" indicates that the pod should use cluster DNS first, if it is available, then fall back on the default (as determined by kubelet) DNS settings.
  • "Default" indicates that the pod should use the default (as determined by kubelet) DNS settings.
  • "None" indicates that the pod should use empty DNS settings. DNS parameters such as nameservers and search paths should be defined via DNSConfig.
+

ephemeralContainers

+

Array of io.cci.otc.api.pkg.apis.versioned.cci.v2.EphemeralContainer objects

+

List of ephemeral containers run in this pod. Ephemeral containers

+

may be run in an existing pod to perform user-initiated actions such as

+

debugging. This list cannot be specified when creating a pod, and it cannot

+

be modified by updating the pod spec. In order to add an ephemeral container

+

to an existing pod, use the pod's ephemeralcontainers subresource.

+

hostAliases

+

Array of io.cci.otc.api.pkg.apis.versioned.cci.v2.HostAlias objects

+

HostAliases is an optional list of hosts and IPs that will be

+

injected into the pod's hosts file if specified. This is only valid for

+

non-hostNetwork pods.

+

hostname

+

String

+

Specifies the hostname of the Pod If not specified, the pod's

+

hostname will be set to a system-defined value.

+

imagePullSecrets

+

Array of io.cci.otc.api.pkg.apis.versioned.cci.v2.LocalObjectReference objects

+

ImagePullSecrets is an optional list of references to secrets in the same namespace to use for pulling any of the images used by this PodSpec. If specified, these secrets will be passed to individual puller implementations for them to use. More info: https://kubernetes.io/docs/concepts/containers/images#specifying-imagepullsecrets-on-a-pod

+

initContainers

+

Array of io.cci.otc.api.pkg.apis.versioned.cci.v2.Container objects

+

List of initialization containers belonging to the pod. Init containers are executed in order prior to containers being started. If any init container fails, the pod is considered to have failed and is handled according to its restartPolicy. The name for an init container or normal container must be unique among all containers. Init containers may not have Lifecycle actions, Readiness probes, Liveness probes, or Startup probes. The resourceRequirements of an init container are taken into account during scheduling by finding the highest request/limit for each resource type, and then using the max of of that value or the sum of the normal containers. Limits are applied to init containers in a similar fashion. Init containers cannot currently be added or removed. Cannot be updated. More info: https://kubernetes.io/docs/concepts/workloads/pods/init-containers/

+

nodeName

+

String

+

NodeName is a request to schedule this pod onto a specific node.

+

If it is non-empty, the scheduler simply schedules this pod onto that node,

+

assuming that it fits resource requirements.

+

overhead

+

Map<String,String>

+

Overhead represents the resource overhead associated with running a pod for a given RuntimeClass. This field will be autopopulated at admission time by the RuntimeClass admission controller. If the RuntimeClass admission controller is enabled, overhead must not be set in Pod create requests. The RuntimeClass admission controller will reject Pod create requests which have the overhead already set. If RuntimeClass is configured and selected in the PodSpec, Overhead will be set to the value defined in the corresponding RuntimeClass, otherwise it will remain unset and treated as zero. More info: https://git.k8s.io/enhancements/keps/sig-node/688-pod-overhead/README.md

+

readinessGates

+

Array of io.cci.otc.api.pkg.apis.versioned.cci.v2.PodReadinessGate objects

+

If specified, all readiness gates will be evaluated for pod readiness. A pod is ready when all its containers are ready AND all conditions specified in the readiness gates have status equal to "True" More info: https://git.k8s.io/enhancements/keps/sig-network/580-pod-readiness-gates

+

restartPolicy

+

String

+

Restart policy for all containers within the pod. One of Always, OnFailure, Never. Default to Always. More info: https://kubernetes.io/docs/concepts/workloads/pods/pod-lifecycle/#restart-policy

+

Possible enum values:

+
  • "Always"
  • "Never"
  • "OnFailure"
+

schedulerName

+

String

+

If specified, the pod will be dispatched by specified scheduler.

+

If not specified, the pod will be dispatched by default scheduler.

+

securityContext

+

io.cci.otc.api.pkg.apis.versioned.cci.v2.PodSecurityContext object

+

SecurityContext holds pod-level security attributes and common container settings. Optional: Defaults to empty. See type description for default values of each field.

+

setHostnameAsFQDN

+

Boolean

+

If true the pod's hostname will be configured as the pod's FQDN,

+

rather than the leaf name (the default). In Linux containers, this means

+

setting the FQDN in the hostname field of the kernel (the nodename field

+

of struct utsname). In Windows containers, this means setting the registry

+

value of hostname for the registry key HKEY_LOCAL_MACHINE\SYSTEM\CurrentControlSet\Services\Tcpip\Parameters

+

to FQDN. If a pod does not have FQDN, this has no effect. Default to false.

+

shareProcessNamespace

+

Boolean

+

Share a single process namespace between all of the containers in a pod. When this is set containers will be able to view and signal processes from other containers in the same pod, and the first process in each container will not be assigned PID 1. HostPID and ShareProcessNamespace cannot both be set. Optional: Default to false.

+

terminationGracePeriodSeconds

+

Long

+

Optional duration in seconds the pod needs to terminate gracefully.

+

May be decreased in delete request. Value must be non-negative integer.

+

The value zero indicates stop immediately via the kill signal (no opportunity

+

to shut down). If this value is nil, the default grace period will be used

+

instead. The grace period is the duration in seconds after the processes

+

running in the pod are sent a termination signal and the time when the processes

+

are forcibly halted with a kill signal. Set this value longer than the expected

+

cleanup time for your process. Defaults to 30 seconds.

+

topologySpreadConstraints

+

Array of io.cci.otc.api.pkg.apis.versioned.cci.v2.TopologySpreadConstraint objects

+

TopologySpreadConstraints describes how a group of pods ought

+

to spread across topology domains. Scheduler will schedule pods in a way

+

which abides by the constraints. All topologySpreadConstraints are ANDed.

+

volumes

+

Array of io.cci.otc.api.pkg.apis.versioned.cci.v2.Volume objects

+

List of volumes that can be mounted by containers belonging to the pod. More info: https://kubernetes.io/docs/concepts/storage/volumes

+
+
+ +
+ + + + + + + + + + + + + +
Table 79 io.cci.otc.api.pkg.apis.versioned.cci.v2.Affinity

Parameter

+

Type

+

Description

+

nodeAffinity

+

io.cci.otc.api.pkg.apis.versioned.cci.v2.NodeAffinity object

+

Describes node affinity scheduling rules for the pod.

+

podAntiAffinity

+

io.cci.otc.api.pkg.apis.versioned.cci.v2.PodAntiAffinity object

+

Describes pod anti-affinity scheduling rules (e.g. avoid putting

+

this pod in the same zone, etc. as some other pod(s)).

+
+
+ +
+ + + + + + + + + +
Table 80 io.cci.otc.api.pkg.apis.versioned.cci.v2.NodeAffinity

Parameter

+

Type

+

Description

+

requiredDuringSchedulingIgnoredDuringExecution

+

io.cci.otc.api.pkg.apis.versioned.cci.v2.NodeSelector object

+

If the affinity requirements specified by this field are not

+

met at scheduling time, the pod will not be scheduled onto the node. If

+

the affinity requirements specified by this field cease to be met at some

+

point during pod execution (e.g. due to an update), the system may or may

+

not try to eventually evict the pod from its node.

+
+
+ +
+ + + + + + + + + +
Table 81 io.cci.otc.api.pkg.apis.versioned.cci.v2.NodeSelector

Parameter

+

Type

+

Description

+

nodeSelectorTerms

+

Array of io.cci.otc.api.pkg.apis.versioned.cci.v2.NodeSelectorTerm objects

+

Required. A list of node selector terms. The terms are ORed.

+
+
+ +
+ + + + + + + + + +
Table 82 io.cci.otc.api.pkg.apis.versioned.cci.v2.NodeSelectorTerm

Parameter

+

Type

+

Description

+

matchExpressions

+

Array of io.cci.otc.api.pkg.apis.versioned.cci.v2.NodeSelectorRequirement objects

+

A list of node selector requirements by node's labels.

+
+
+ +
+ + + + + + + + + + + + + + + + + +
Table 83 io.cci.otc.api.pkg.apis.versioned.cci.v2.NodeSelectorRequirement

Parameter

+

Type

+

Description

+

key

+

String

+

The label key that the selector applies to.

+

operator

+

String

+

Represents a key's relationship to a set of values. Valid operators are In, NotIn, Exists, DoesNotExist. Gt, and Lt.

+

Possible enum values:

+
  • "DoesNotExist"
  • "Exists"
  • "Gt"
  • "In"
  • "Lt"
  • "NotIn"
+

values

+

Array of strings

+

An array of string values. If the operator is In or NotIn, the

+

values array must be non-empty. If the operator is Exists or DoesNotExist,

+

the values array must be empty. If the operator is Gt or Lt, the values

+

array must have a single element, which will be interpreted as an integer.

+

This array is replaced during a strategic merge patch.

+
+
+ +
+ + + + + + + + + + + + + +
Table 84 io.cci.otc.api.pkg.apis.versioned.cci.v2.PodAntiAffinity

Parameter

+

Type

+

Description

+

preferredDuringSchedulingIgnoredDuringExecution

+

Array of io.cci.otc.api.pkg.apis.versioned.cci.v2.WeightedPodAffinityTerm objects

+

The scheduler will prefer to schedule pods to nodes that satisfy

+

the anti-affinity expressions specified by this field, but it may choose

+

a node that violates one or more of the expressions. The node that is most

+

preferred is the one with the greatest sum of weights, i.e. for each node

+

that meets all of the scheduling requirements (resource request, requiredDuringScheduling

+

anti-affinity expressions, etc.), compute a sum by iterating through the

+

elements of this field and adding "weight" to the sum if the node has pods

+

which matches the corresponding podAffinityTerm; the node(s) with the highest

+

sum are the most preferred.

+

requiredDuringSchedulingIgnoredDuringExecution

+

Array of io.cci.otc.api.pkg.apis.versioned.cci.v2.PodAffinityTerm objects

+

If the anti-affinity requirements specified by this field are

+

not met at scheduling time, the pod will not be scheduled onto the node.

+

If the anti-affinity requirements specified by this field cease to be met

+

at some point during pod execution (e.g. due to a pod label update), the

+

system may or may not try to eventually evict the pod from its node. When

+

there are multiple elements, the lists of nodes corresponding to each podAffinityTerm

+

are intersected, i.e. all terms must be satisfied.

+
+
+ +
+ + + + + + + + + + + + + +
Table 85 io.cci.otc.api.pkg.apis.versioned.cci.v2.WeightedPodAffinityTerm

Parameter

+

Type

+

Description

+

podAffinityTerm

+

io.cci.otc.api.pkg.apis.versioned.cci.v2.PodAffinityTerm object

+

Required. A pod affinity term, associated with the corresponding

+

weight.

+

weight

+

Integer

+

weight associated with matching the corresponding podAffinityTerm,

+

in the range 1-100.

+
+
+ +
+ + + + + + + + + + + + + + + + + +
Table 86 io.cci.otc.api.pkg.apis.versioned.cci.v2.PodAffinityTerm

Parameter

+

Type

+

Description

+

labelSelector

+

io.k8s.apimachinery.pkg.apis.meta.v1.LabelSelector object

+

A label query over a set of resources, in this case pods.

+

namespaces

+

Array of strings

+

namespaces specifies a static list of namespace names that the

+

term applies to. The term is applied to the union of the namespaces listed

+

in this field and the ones selected by namespaceSelector. null or empty

+

namespaces list and null namespaceSelector means "this pod's namespace".

+

topologyKey

+

String

+

This pod should be co-located (affinity) or not co-located (anti-affinity)

+

with the pods matching the labelSelector in the specified namespaces, where

+

co-located is defined as running on a node whose value of the label with

+

key topologyKey matches that of any node on which any of the selected pods

+

is running. Empty topologyKey is not allowed.

+
+
+ +
+ + + + + + + + + + + + + + + + + +
Table 87 io.cci.otc.api.pkg.apis.versioned.cci.v2.PodDNSConfig

Parameter

+

Type

+

Description

+

nameservers

+

Array of strings

+

A list of DNS name server IP addresses. This will be appended

+

to the base nameservers generated from DNSPolicy. Duplicated nameservers

+

will be removed.

+

options

+

Array of io.cci.otc.api.pkg.apis.versioned.cci.v2.PodDNSConfigOption objects

+

A list of DNS resolver options. This will be merged with the

+

base options generated from DNSPolicy. Duplicated entries will be removed.

+

Resolution options given in Options will override those that appear in the

+

base DNSPolicy.

+

searches

+

Array of strings

+

A list of DNS search domains for host-name lookup. This will

+

be appended to the base search paths generated from DNSPolicy. Duplicated

+

search paths will be removed.

+
+
+ +
+ + + + + + + + + + + + + +
Table 88 io.cci.otc.api.pkg.apis.versioned.cci.v2.PodDNSConfigOption

Parameter

+

Type

+

Description

+

name

+

String

+

Required.

+

value

+

String

+		  
+
+ +
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Table 89 io.cci.otc.api.pkg.apis.versioned.cci.v2.EphemeralContainer

Parameter

+

Type

+

Description

+

args

+

Array of strings

+

Arguments to the entrypoint. The image's CMD is used if this is not provided. Variable references $(VAR_NAME) are expanded using the container's environment. If a variable cannot be resolved, the reference in the input string will be unchanged. Double $$ are reduced to a single $, which allows for escaping the $(VAR_NAME) syntax: i.e. "$$(VAR_NAME)" will produce the string literal "$(VAR_NAME)". Escaped references will never be expanded, regardless of whether the variable exists or not. Cannot be updated. More info: https://kubernetes.io/docs/tasks/inject-data-application/define-command-argument-container/#running-a-command-in-a-shell

+

command

+

Array of strings

+

Entrypoint array. Not executed within a shell. The image's ENTRYPOINT is used if this is not provided. Variable references $(VAR_NAME) are expanded using the container's environment. If a variable cannot be resolved, the reference in the input string will be unchanged. Double $$ are reduced to a single $, which allows for escaping the $(VAR_NAME) syntax: i.e. "$$(VAR_NAME)" will produce the string literal "$(VAR_NAME)". Escaped references will never be expanded, regardless of whether the variable exists or not. Cannot be updated. More info: https://kubernetes.io/docs/tasks/inject-data-application/define-command-argument-container/#running-a-command-in-a-shell

+

env

+

Array of io.cci.otc.api.pkg.apis.versioned.cci.v2.EnvVar objects

+

List of environment variables to set in the container. Cannot

+

be updated.

+

envFrom

+

Array of io.cci.otc.api.pkg.apis.versioned.cci.v2.EnvFromSource objects

+

List of sources to populate environment variables in the container.

+

The keys defined within a source must be a C_IDENTIFIER. All invalid keys

+

will be reported as an event when the container is starting. When a key

+

exists in multiple sources, the value associated with the last source will

+

take precedence. Values defined by an Env with a duplicate key will take

+

precedence. Cannot be updated.

+

image

+

String

+

Container image name. More info: https://kubernetes.io/docs/concepts/containers/images

+

lifecycle

+

io.cci.otc.api.pkg.apis.versioned.cci.v2.Lifecycle object

+

Lifecycle is not allowed for ephemeral containers.

+

livenessProbe

+

io.cci.otc.api.pkg.apis.versioned.cci.v2.Probe object

+

Probes are not allowed for ephemeral containers.

+

name

+

String

+

Name of the ephemeral container specified as a DNS_LABEL. This

+

name must be unique among all containers, init containers and ephemeral

+

containers.

+

ports

+

Array of io.cci.otc.api.pkg.apis.versioned.cci.v2.ContainerPort objects

+

Ports are not allowed for ephemeral containers.

+

readinessProbe

+

io.cci.otc.api.pkg.apis.versioned.cci.v2.Probe object

+

Probes are not allowed for ephemeral containers.

+

resources

+

io.cci.otc.api.pkg.apis.versioned.cci.v2.ResourceRequirements object

+

Resources are not allowed for ephemeral containers. Ephemeral

+

containers use spare resources already allocated to the pod.

+

securityContext

+

io.cci.otc.api.pkg.apis.versioned.cci.v2.SecurityContext object

+

Optional: SecurityContext defines the security options the ephemeral container should be run with. If set, the fields of SecurityContext override the equivalent fields of PodSecurityContext.

+

startupProbe

+

io.cci.otc.api.pkg.apis.versioned.cci.v2.Probe object

+

Probes are not allowed for ephemeral containers.

+

stdin

+

Boolean

+

Whether this container should allocate a buffer for stdin in

+

the container runtime. If this is not set, reads from stdin in the container

+

will always result in EOF. Default is false.

+

stdinOnce

+

Boolean

+

Whether the container runtime should close the stdin channel

+

after it has been opened by a single attach. When stdin is true the stdin

+

stream will remain open across multiple attach sessions. If stdinOnce is

+

set to true, stdin is opened on container start, is empty until the first

+

client attaches to stdin, and then remains open and accepts data until the

+

client disconnects, at which time stdin is closed and remains closed until

+

the container is restarted. If this flag is false, a container processes

+

that reads from stdin will never receive an EOF. Default is false

+

targetContainerName

+

String

+

If set, the name of the container from PodSpec that this ephemeral container targets. The ephemeral container will be run in the namespaces (IPC, PID, etc) of this container. If not set then the ephemeral container uses the namespaces configured in the Pod spec.

+

The container runtime must implement support for this feature. If the runtime does not support namespace targeting then the result of setting this field is undefined.

+

terminationMessagePath

+

String

+

Optional: Path at which the file to which the container's termination message will be written is mounted into the container's filesystem. Message written is intended to be brief final status, such as an assertion failure message. Will be truncated by the node if greater than 4096 bytes. The total message length across all containers will be limited to 12kb. Defaults to /dev/termination-log. Cannot be updated.

+

terminationMessagePolicy

+

String

+

Indicate how the termination message should be populated. File will use the contents of terminationMessagePath to populate the container status message on both success and failure. FallbackToLogsOnError will use the last chunk of container log output if the termination message file is empty and the container exited with an error. The log output is limited to 2048 bytes or 80 lines, whichever is smaller. Defaults to File. Cannot be updated.

+

Possible enum values:

+
  • "FallbackToLogsOnError" will read the most recent contents of the container logs for the container status message when the container exits with an error and the terminationMessagePath has no contents.
  • "File" is the default behavior and will set the container status message to the contents of the container's terminationMessagePath when the container exits.
+

tty

+

Boolean

+

Whether this container should allocate a TTY for itself, also

+

requires 'stdin' to be true. Default is false.

+

volumeMounts

+

Array of io.cci.otc.api.pkg.apis.versioned.cci.v2.VolumeMount objects

+

Pod volumes to mount into the container's filesystem. Subpath

+

mounts are not allowed for ephemeral containers. Cannot be updated.

+

workingDir

+

String

+

Container's working directory. If not specified, the container

+

runtime's default will be used, which might be configured in the container

+

image. Cannot be updated.

+
+
+ +
+ + + + + + + + + + + + + +
Table 90 io.cci.otc.api.pkg.apis.versioned.cci.v2.HostAlias

Parameter

+

Type

+

Description

+

hostnames

+

Array of strings

+

Hostnames for the above IP address.

+

ip

+

String

+

IP address of the host file entry.

+
+
+ +
+ + + + + + + + + +
Table 91 io.cci.otc.api.pkg.apis.versioned.cci.v2.LocalObjectReference

Parameter

+

Type

+

Description

+

name

+

String

+

Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names

+
+
+ +
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Table 92 io.cci.otc.api.pkg.apis.versioned.cci.v2.Container

Parameter

+

Type

+

Description

+

args

+

Array of strings

+

Arguments to the entrypoint. The container image's CMD is used if this is not provided. Variable references $(VAR_NAME) are expanded using the container's environment. If a variable cannot be resolved, the reference in the input string will be unchanged. Double $$ are reduced to a single $, which allows for escaping the $(VAR_NAME) syntax: i.e. "$$(VAR_NAME)" will produce the string literal "$(VAR_NAME)". Escaped references will never be expanded, regardless of whether the variable exists or not. Cannot be updated. More info: https://kubernetes.io/docs/tasks/inject-data-application/define-command-argument-container/#running-a-command-in-a-shell

+

command

+

Array of strings

+

Entrypoint array. Not executed within a shell. The container image's ENTRYPOINT is used if this is not provided. Variable references $(VAR_NAME) are expanded using the container's environment. If a variable cannot be resolved, the reference in the input string will be unchanged. Double $$ are reduced to a single $, which allows for escaping the $(VAR_NAME) syntax: i.e. "$$(VAR_NAME)" will produce the string literal "$(VAR_NAME)". Escaped references will never be expanded, regardless of whether the variable exists or not. Cannot be updated. More info: https://kubernetes.io/docs/tasks/inject-data-application/define-command-argument-container/#running-a-command-in-a-shell

+

env

+

Array of io.cci.otc.api.pkg.apis.versioned.cci.v2.EnvVar objects

+

List of environment variables to set in the container. Cannot

+

be updated.

+

envFrom

+

Array of io.cci.otc.api.pkg.apis.versioned.cci.v2.EnvFromSource objects

+

List of sources to populate environment variables in the container.

+

The keys defined within a source must be a C_IDENTIFIER. All invalid keys

+

will be reported as an event when the container is starting. When a key

+

exists in multiple sources, the value associated with the last source will

+

take precedence. Values defined by an Env with a duplicate key will take

+

precedence. Cannot be updated.

+

image

+

String

+

Container image name. More info: https://kubernetes.io/docs/concepts/containers/images This field is optional to allow higher level config management to default or override container images in workload controllers like Deployments and StatefulSets.

+

lifecycle

+

io.cci.otc.api.pkg.apis.versioned.cci.v2.Lifecycle object

+

Actions that the management system should take in response to

+

container lifecycle events. Cannot be updated.

+

livenessProbe

+

io.cci.otc.api.pkg.apis.versioned.cci.v2.Probe object

+

Periodic probe of container liveness. Container will be restarted if the probe fails. Cannot be updated. More info: https://kubernetes.io/docs/concepts/workloads/pods/pod-lifecycle#container-probes

+

name

+

String

+

Name of the container specified as a DNS_LABEL. Each container

+

in a pod must have a unique name (DNS_LABEL). Cannot be updated.

+

ports

+

Array of io.cci.otc.api.pkg.apis.versioned.cci.v2.ContainerPort objects

+

List of ports to expose from the container. Not specifying a

+

port here DOES NOT prevent that port from being exposed. Any port which

+

is listening on the default "0.0.0.0" address inside a container will be

+

accessible from the network. Modifying this array with strategic merge patch

+

may corrupt the data. For more information See https://github.com/kubernetes/kubernetes/issues/108255.

+

Cannot be updated.

+

readinessProbe

+

io.cci.otc.api.pkg.apis.versioned.cci.v2.Probe object

+

Periodic probe of container service readiness. Container will be removed from service endpoints if the probe fails. Cannot be updated. More info: https://kubernetes.io/docs/concepts/workloads/pods/pod-lifecycle#container-probes

+

resources

+

io.cci.otc.api.pkg.apis.versioned.cci.v2.ResourceRequirements object

+

Compute Resources required by this container. Cannot be updated. More info: https://kubernetes.io/docs/concepts/configuration/manage-resources-containers/

+

securityContext

+

io.cci.otc.api.pkg.apis.versioned.cci.v2.SecurityContext object

+

SecurityContext defines the security options the container should be run with. If set, the fields of SecurityContext override the equivalent fields of PodSecurityContext. More info: https://kubernetes.io/docs/tasks/configure-pod-container/security-context/

+

startupProbe

+

io.cci.otc.api.pkg.apis.versioned.cci.v2.Probe object

+

StartupProbe indicates that the Pod has successfully initialized. If specified, no other probes are executed until this completes successfully. If this probe fails, the Pod will be restarted, just as if the livenessProbe failed. This can be used to provide different probe parameters at the beginning of a Pod's lifecycle, when it might take a long time to load data or warm a cache, than during steady-state operation. This cannot be updated. More info: https://kubernetes.io/docs/concepts/workloads/pods/pod-lifecycle#container-probes

+

stdin

+

Boolean

+

Whether this container should allocate a buffer for stdin in

+

the container runtime. If this is not set, reads from stdin in the container

+

will always result in EOF. Default is false.

+

stdinOnce

+

Boolean

+

Whether the container runtime should close the stdin channel

+

after it has been opened by a single attach. When stdin is true the stdin

+

stream will remain open across multiple attach sessions. If stdinOnce is

+

set to true, stdin is opened on container start, is empty until the first

+

client attaches to stdin, and then remains open and accepts data until the

+

client disconnects, at which time stdin is closed and remains closed until

+

the container is restarted. If this flag is false, a container processes

+

that reads from stdin will never receive an EOF. Default is false

+

terminationMessagePath

+

String

+

Optional: Path at which the file to which the container's termination message will be written is mounted into the container's filesystem. Message written is intended to be brief final status, such as an assertion failure message. Will be truncated by the node if greater than 4096 bytes. The total message length across all containers will be limited to 12kb. Defaults to /dev/termination-log. Cannot be updated.

+

terminationMessagePolicy

+

String

+

Indicate how the termination message should be populated. File will use the contents of terminationMessagePath to populate the container status message on both success and failure. FallbackToLogsOnError will use the last chunk of container log output if the termination message file is empty and the container exited with an error. The log output is limited to 2048 bytes or 80 lines, whichever is smaller. Defaults to File. Cannot be updated.

+

Possible enum values:

+
  • "FallbackToLogsOnError" will read the most recent contents of the container logs for the container status message when the container exits with an error and the terminationMessagePath has no contents.
  • "File" is the default behavior and will set the container status message to the contents of the container's terminationMessagePath when the container exits.
+

tty

+

Boolean

+

Whether this container should allocate a TTY for itself, also

+

requires 'stdin' to be true. Default is false.

+

volumeMounts

+

Array of io.cci.otc.api.pkg.apis.versioned.cci.v2.VolumeMount objects

+

Pod volumes to mount into the container's filesystem. Cannot

+

be updated.

+

workingDir

+

String

+

Container's working directory. If not specified, the container

+

runtime's default will be used, which might be configured in the container

+

image. Cannot be updated.

+
+
+ +
+ + + + + + + + + + + + + + + + + +
Table 93 io.cci.otc.api.pkg.apis.versioned.cci.v2.EnvVar

Parameter

+

Type

+

Description

+

name

+

String

+

Name of the environment variable. Must be a C_IDENTIFIER.

+

value

+

String

+

Variable references $(VAR_NAME) are expanded using the previously defined environment variables in the container and any service environment variables. If a variable cannot be resolved, the reference in the input string will be unchanged. Double $$ are reduced to a single $, which allows for escaping the $(VAR_NAME) syntax: i.e. "$$(VAR_NAME)" will produce the string literal "$(VAR_NAME)". Escaped references will never be expanded, regardless of whether the variable exists or not. Defaults to "".

+

valueFrom

+

io.cci.otc.api.pkg.apis.versioned.cci.v2.EnvVarSource object

+

Source for the environment variable's value. Cannot be used if

+

value is not empty.

+
+
+ +
+ + + + + + + + + + + + + + + + + + + + + +
Table 94 io.cci.otc.api.pkg.apis.versioned.cci.v2.EnvVarSource

Parameter

+

Type

+

Description

+

configMapKeyRef

+

io.cci.otc.api.pkg.apis.versioned.cci.v2.ConfigMapKeySelector object

+

Selects a key of a ConfigMap.

+

fieldRef

+

io.cci.otc.api.pkg.apis.versioned.cci.v2.ObjectFieldSelector object

+

Selects a field of the pod: supports metadata.name, metadata.namespace, metadata.labels['<KEY>'], metadata.annotations['<KEY>'], spec.nodeName, spec.serviceAccountName, status.hostIP, status.podIP, status.podIPs.

+

resourceFieldRef

+

io.cci.otc.api.pkg.apis.versioned.cci.v2.ResourceFieldSelector object

+

Selects a resource of the container: only resources limits and requests (limits.cpu, limits.memory, limits.ephemeral-storage, requests.cpu, requests.memory and requests.ephemeral-storage) are currently supported.

+

secretKeyRef

+

io.cci.otc.api.pkg.apis.versioned.cci.v2.SecretKeySelector object

+

Selects a key of a secret in the pod's namespace

+
+
+ +
+ + + + + + + + + + + + + + + + + +
Table 95 io.cci.otc.api.pkg.apis.versioned.cci.v2.ConfigMapKeySelector

Parameter

+

Type

+

Description

+

key

+

String

+

The key to select.

+

name

+

String

+

Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names

+

optional

+

Boolean

+

Specify whether the ConfigMap or its key must be defined

+
+
+ +
+ + + + + + + + + + + + + + + + + +
Table 96 io.cci.otc.api.pkg.apis.versioned.cci.v2.SecretKeySelector

Parameter

+

Type

+

Description

+

key

+

String

+

The key of the secret to select from. Must be a valid secret

+

key.

+

name

+

String

+

Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names

+

optional

+

Boolean

+

Specify whether the Secret or its key must be defined

+
+
+ +
+ + + + + + + + + + + + + + + + + +
Table 97 io.cci.otc.api.pkg.apis.versioned.cci.v2.EnvFromSource

Parameter

+

Type

+

Description

+

configMapRef

+

io.cci.otc.api.pkg.apis.versioned.cci.v2.ConfigMapEnvSource object

+

The ConfigMap to select from

+

prefix

+

String

+

An optional identifier to prepend to each key in the ConfigMap.

+

Must be a C_IDENTIFIER.

+

secretRef

+

io.cci.otc.api.pkg.apis.versioned.cci.v2.SecretEnvSource object

+

The Secret to select from

+
+
+ +
+ + + + + + + + + + + + + +
Table 98 io.cci.otc.api.pkg.apis.versioned.cci.v2.ConfigMapEnvSource

Parameter

+

Type

+

Description

+

name

+

String

+

Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names

+

optional

+

Boolean

+

Specify whether the ConfigMap must be defined

+
+
+ +
+ + + + + + + + + + + + + +
Table 99 io.cci.otc.api.pkg.apis.versioned.cci.v2.SecretEnvSource

Parameter

+

Type

+

Description

+

name

+

String

+

Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names

+

optional

+

Boolean

+

Specify whether the Secret must be defined

+
+
+ +
+ + + + + + + + + + + + + +
Table 100 io.cci.otc.api.pkg.apis.versioned.cci.v2.Lifecycle

Parameter

+

Type

+

Description

+

postStart

+

io.cci.otc.api.pkg.apis.versioned.cci.v2.LifecycleHandler object

+

PostStart is called immediately after a container is created. If the handler fails, the container is terminated and restarted according to its restart policy. Other management of the container blocks until the hook completes. More info: https://kubernetes.io/docs/concepts/containers/container-lifecycle-hooks/#container-hooks

+

preStop

+

io.cci.otc.api.pkg.apis.versioned.cci.v2.LifecycleHandler object

+

PreStop is called immediately before a container is terminated due to an API request or management event such as liveness/startup probe failure, preemption, resource contention, etc. The handler is not called if the container crashes or exits. The Pod's termination grace period countdown begins before the PreStop hook is executed. Regardless of the outcome of the handler, the container will eventually terminate within the Pod's termination grace period (unless delayed by finalizers). Other management of the container blocks until the hook completes or until the termination grace period is reached. More info: https://kubernetes.io/docs/concepts/containers/container-lifecycle-hooks/#container-hooks

+
+
+ +
+ + + + + + + + + + + + + +
Table 101 io.cci.otc.api.pkg.apis.versioned.cci.v2.LifecycleHandler

Parameter

+

Type

+

Description

+

exec

+

io.cci.otc.api.pkg.apis.versioned.cci.v2.ExecAction object

+

Exec specifies the action to take.

+

httpGet

+

io.cci.otc.api.pkg.apis.versioned.cci.v2.HTTPGetAction object

+

HTTPGet specifies the http request to perform.

+
+
+ +
+ + + + + + + + + + + + + + + + + +
Table 102 io.cci.otc.api.pkg.apis.versioned.cci.v2.ContainerPort

Parameter

+

Type

+

Description

+

containerPort

+

Integer

+

Number of port to expose on the pod's IP address. This must be

+

a valid port number, 0 < x < 65536.

+

name

+

String

+

If specified, this must be an IANA_SVC_NAME and unique within

+

the pod. Each named port in a pod must have a unique name. Name for the

+

port that can be referred to by services.

+

protocol

+

String

+

Protocol for port. Must be UDP, TCP, or SCTP. Defaults to "TCP".

+

Possible enum values:

+
  • "SCTP" is the SCTP protocol.
  • "TCP" is the TCP protocol.
  • "UDP" is the UDP protocol.
+
+
+ +
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Table 103 io.cci.otc.api.pkg.apis.versioned.cci.v2.SecurityContext

Parameter

+

Type

+

Description

+

capabilities

+

io.cci.otc.api.pkg.apis.versioned.cci.v2.Capabilities object

+

The capabilities to add/drop when running containers. Defaults

+

to the default set of capabilities granted by the container runtime. Note

+

that this field cannot be set when spec.os.name is windows.

+

procMount

+

String

+

procMount denotes the type of proc mount to use for the containers.

+

The default is DefaultProcMount which uses the container runtime defaults

+

for readonly paths and masked paths. This requires the ProcMountType feature

+

flag to be enabled. Note that this field cannot be set when spec.os.name

+

is windows.

+

readOnlyRootFilesystem

+

Boolean

+

Whether this container has a read-only root filesystem. Default

+

is false. Note that this field cannot be set when spec.os.name is windows.

+

runAsGroup

+

Long

+

The GID to run the entrypoint of the container process. Uses

+

runtime default if unset. May also be set in PodSecurityContext. If set

+

in both SecurityContext and PodSecurityContext, the value specified in SecurityContext

+

takes precedence. Note that this field cannot be set when spec.os.name is

+

windows.

+

runAsNonRoot

+

Boolean

+

Indicates that the container must run as a non-root user. If

+

true, the Kubelet will validate the image at runtime to ensure that it does

+

not run as UID 0 (root) and fail to start the container if it does. If unset

+

or false, no such validation will be performed. May also be set in PodSecurityContext. If

+

set in both SecurityContext and PodSecurityContext, the value specified

+

in SecurityContext takes precedence.

+

runAsUser

+

Long

+

The UID to run the entrypoint of the container process. Defaults

+

to user specified in image metadata if unspecified. May also be set in PodSecurityContext. If

+

set in both SecurityContext and PodSecurityContext, the value specified

+

in SecurityContext takes precedence. Note that this field cannot be set

+

when spec.os.name is windows.

+
+
+ +
+ + + + + + + + + + + + + +
Table 104 io.cci.otc.api.pkg.apis.versioned.cci.v2.Capabilities

Parameter

+

Type

+

Description

+

add

+

Array of strings

+

Added capabilities

+

drop

+

Array of strings

+

Removed capabilities

+
+
+ +
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Table 105 io.cci.otc.api.pkg.apis.versioned.cci.v2.Probe

Parameter

+

Type

+

Description

+

exec

+

io.cci.otc.api.pkg.apis.versioned.cci.v2.ExecAction object

+

Exec specifies the action to take.

+

failureThreshold

+

Integer

+

Minimum consecutive failures for the probe to be considered failed

+

after having succeeded. Defaults to 3. Minimum value is 1.

+

httpGet

+

io.cci.otc.api.pkg.apis.versioned.cci.v2.HTTPGetAction object

+

HTTPGet specifies the http request to perform.

+

initialDelaySeconds

+

Integer

+

Number of seconds after the container has started before liveness probes are initiated. More info: https://kubernetes.io/docs/concepts/workloads/pods/pod-lifecycle#container-probes

+

periodSeconds

+

Integer

+

How often (in seconds) to perform the probe. Default to 10 seconds.

+

Minimum value is 1.

+

successThreshold

+

Integer

+

Minimum consecutive successes for the probe to be considered

+

successful after having failed. Defaults to 1. Must be 1 for liveness and

+

startup. Minimum value is 1.

+

tcpSocket

+

io.cci.otc.api.pkg.apis.versioned.cci.v2.TCPSocketAction object

+

TCPSocket specifies an action involving a TCP port.

+

terminationGracePeriodSeconds

+

Long

+

Optional duration in seconds the pod needs to terminate gracefully

+

upon probe failure. The grace period is the duration in seconds after the

+

processes running in the pod are sent a termination signal and the time

+

when the processes are forcibly halted with a kill signal. Set this value

+

longer than the expected cleanup time for your process. If this value is

+

nil, the pod's terminationGracePeriodSeconds will be used. Otherwise, this

+

value overrides the value provided by the pod spec. Value must be non-negative

+

integer. The value zero indicates stop immediately via the kill signal (no

+

opportunity to shut down). This is a beta field and requires enabling ProbeTerminationGracePeriod

+

feature gate. Minimum value is 1. spec.terminationGracePeriodSeconds is

+

used if unset.

+

timeoutSeconds

+

Integer

+

Number of seconds after which the probe times out. Defaults to 1 second. Minimum value is 1. More info: https://kubernetes.io/docs/concepts/workloads/pods/pod-lifecycle#container-probes

+
+
+ +
+ + + + + + + + + +
Table 106 io.cci.otc.api.pkg.apis.versioned.cci.v2.ExecAction

Parameter

+

Type

+

Description

+

command

+

Array of strings

+

Command is the command line to execute inside the container,

+

the working directory for the command is root ('/') in the container's

+

filesystem. The command is simply exec'd, it is not run inside a shell,

+

so traditional shell instructions ('|', etc) won't work. To use a shell,

+

you need to explicitly call out to that shell. Exit status of 0 is treated

+

as live/healthy and non-zero is unhealthy.

+
+
+ +
+ + + + + + + + + + + + + + + + + + + + + + + + + +
Table 107 io.cci.otc.api.pkg.apis.versioned.cci.v2.HTTPGetAction

Parameter

+

Type

+

Description

+

host

+

String

+

Host name to connect to, defaults to the pod IP. You probably

+

want to set "Host" in httpHeaders instead.

+

httpHeaders

+

Array of io.cci.otc.api.pkg.apis.versioned.cci.v2.HTTPHeader objects

+

Custom headers to set in the request. HTTP allows repeated headers.

+

path

+

String

+

Path to access on the HTTP server.

+

port

+

String

+

Name or number of the port to access on the container. Number

+

must be in the range 1 to 65535. Name must be an IANA_SVC_NAME.

+

scheme

+

String

+

Scheme to use for connecting to the host. Defaults to HTTP.

+

Possible enum values:

+
  • "HTTP" means that the scheme used will be http://
  • "HTTPS" means that the scheme used will be https://
+
+
+ +
+ + + + + + + + + + + + + +
Table 108 io.cci.otc.api.pkg.apis.versioned.cci.v2.HTTPHeader

Parameter

+

Type

+

Description

+

name

+

String

+

The header field name

+

value

+

String

+

The header field value

+
+
+ +
+ + + + + + + + + + + + + +
Table 109 io.cci.otc.api.pkg.apis.versioned.cci.v2.TCPSocketAction

Parameter

+

Type

+

Description

+

host

+

String

+

Optional: Host name to connect to, defaults to the pod IP.

+

port

+

String

+

Number or name of the port to access on the container. Number

+

must be in the range 1 to 65535. Name must be an IANA_SVC_NAME.

+
+
+ +
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Table 110 io.cci.otc.api.pkg.apis.versioned.cci.v2.VolumeMount

Parameter

+

Type

+

Description

+

extendPathMode

+

String

+

Extend the volume path by appending the pod metadata to the path

+

according to specified pattern. which provide a way of directory isolation

+

and help prevent the writing conflict between different pods.

+

mountPath

+

String

+

Path within the container at which the volume should be mounted. Must

+

not contain ':'.

+

name

+

String

+

This must match the Name of a Volume.

+

readOnly

+

Boolean

+

Mounted read-only if true, read-write otherwise (false or unspecified).

+

Defaults to false.

+

subPath

+

String

+

Path within the volume from which the container's volume should

+

be mounted. Defaults to "" (volume's root).

+

subPathExpr

+

String

+

Expanded path within the volume from which the container's volume

+

should be mounted. Behaves similarly to SubPath but environment variable

+

references $(VAR_NAME) are expanded using the container's environment. Defaults

+

to "" (volume's root). SubPathExpr and SubPath are mutually exclusive.

+
+
+ +
+ + + + + + + + + +
Table 111 io.cci.otc.api.pkg.apis.versioned.cci.v2.PodReadinessGate

Parameter

+

Type

+

Description

+

conditionType

+

String

+

ConditionType refers to a condition in the pod's condition list

+

with matching type.

+
+
+ +
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Table 112 io.cci.otc.api.pkg.apis.versioned.cci.v2.PodSecurityContext

Parameter

+

Type

+

Description

+

fsGroup

+

Long

+

A special supplemental group that applies to all containers in a pod. Some volume types allow the Kubelet to change the ownership of that volume to be owned by the pod:

+
  1. The owning GID will be the FSGroup 2. The setgid bit is set (new files created in the volume will be owned by FSGroup) 3. The permission bits are OR'd with rw-rw----
+

If unset, the Kubelet will not modify the ownership and permissions of any volume. Note that this field cannot be set when spec.os.name is windows.

+

fsGroupChangePolicy

+

String

+

fsGroupChangePolicy defines behavior of changing ownership and permission of the volume before being exposed inside Pod. This field will only apply to volume types which support fsGroup based ownership(and permissions). It will have no effect on ephemeral volume types such as: secret, configmaps and emptydir. Valid values are "OnRootMismatch" and "Always". If not specified, "Always" is used. Note that this field cannot be set when spec.os.name is windows.

+

runAsGroup

+

Long

+

The GID to run the entrypoint of the container process. Uses

+

runtime default if unset. May also be set in SecurityContext. If set in

+

both SecurityContext and PodSecurityContext, the value specified in SecurityContext

+

takes precedence for that container. Note that this field cannot be set

+

when spec.os.name is windows.

+

runAsNonRoot

+

Boolean

+

Indicates that the container must run as a non-root user. If

+

true, the Kubelet will validate the image at runtime to ensure that it does

+

not run as UID 0 (root) and fail to start the container if it does. If unset

+

or false, no such validation will be performed. May also be set in SecurityContext. If

+

set in both SecurityContext and PodSecurityContext, the value specified

+

in SecurityContext takes precedence.

+

runAsUser

+

Long

+

The UID to run the entrypoint of the container process. Defaults

+

to user specified in image metadata if unspecified. May also be set in SecurityContext. If

+

set in both SecurityContext and PodSecurityContext, the value specified

+

in SecurityContext takes precedence for that container. Note that this field

+

cannot be set when spec.os.name is windows.

+

supplementalGroups

+

Array of longs

+

A list of groups applied to the first process run in each container,

+

in addition to the container's primary GID. If unspecified, no groups will

+

be added to any container. Note that this field cannot be set when spec.os.name

+

is windows.

+

sysctls

+

Array of io.cci.otc.api.pkg.apis.versioned.cci.v2.Sysctl objects

+

Sysctls hold a list of namespaced sysctls used for the pod. Pods

+

with unsupported sysctls (by the container runtime) might fail to launch.

+

Note that this field cannot be set when spec.os.name is windows.

+
+
+ +
+ + + + + + + + + + + + + +
Table 113 io.cci.otc.api.pkg.apis.versioned.cci.v2.Sysctl

Parameter

+

Type

+

Description

+

name

+

String

+

Name of a property to set

+

value

+

String

+

Value of a property to set

+
+
+ +
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Table 114 io.cci.otc.api.pkg.apis.versioned.cci.v2.TopologySpreadConstraint

Parameter

+

Type

+

Description

+

labelSelector

+

io.k8s.apimachinery.pkg.apis.meta.v1.LabelSelector object

+

LabelSelector is used to find matching pods. Pods that match

+

this label selector are counted to determine the number of pods in their

+

corresponding topology domain.

+

matchLabelKeys

+

Array of strings

+

MatchLabelKeys is a set of pod label keys to select the pods

+

over which spreading will be calculated. The keys are used to lookup values

+

from the incoming pod labels, those key-value labels are ANDed with labelSelector

+

to select the group of existing pods over which spreading will be calculated

+

for the incoming pod. Keys that don't exist in the incoming pod labels will

+

be ignored. A null or empty list means only match against labelSelector.

+

maxSkew

+

Integer

+

MaxSkew describes the degree to which pods may be unevenly distributed. When whenUnsatisfiable=DoNotSchedule, it is the maximum permitted difference between the number of matching pods in the target topology and the global minimum. The global minimum is the minimum number of matching pods in an eligible domain or zero if the number of eligible domains is less than MinDomains. For example, in a 3-zone cluster, MaxSkew is set to 1, and pods with the same labelSelector spread as 2/2/1: In this case, the global minimum is 1. | zone1 | zone2 | zone3 | | P P | P P | P | - if MaxSkew is 1, incoming pod can only be scheduled to zone3 to become 2/2/2; scheduling it onto zone1(zone2) would make the ActualSkew(3-1) on zone1(zone2) violate MaxSkew(1). - if MaxSkew is 2, incoming pod can be scheduled onto any zone. When whenUnsatisfiable=ScheduleAnyway, it is used to give higher precedence to topologies that satisfy it. It's a required field. Default value is 1 and 0 is not allowed.

+

minDomains

+

Integer

+

MinDomains indicates a minimum number of eligible domains. When the number of eligible domains with matching topology keys is less than minDomains, Pod Topology Spread treats "global minimum" as 0, and then the calculation of Skew is performed. And when the number of eligible domains with matching topology keys equals or greater than minDomains, this value has no effect on scheduling. As a result, when the number of eligible domains is less than minDomains, scheduler won't schedule more than maxSkew Pods to those domains. If value is nil, the constraint behaves as if MinDomains is equal to 1. Valid values are integers greater than 0. When value is not nil, WhenUnsatisfiable must be DoNotSchedule.

+

For example, in a 3-zone cluster, MaxSkew is set to 2, MinDomains is set to 5 and pods with the same labelSelector spread as 2/2/2: | zone1 | zone2 | zone3 | | P P | P P | P P | The number of domains is less than 5(MinDomains), so "global minimum" is treated as 0. In this situation, new pod with the same labelSelector cannot be scheduled, because computed skew will be 3(3 - 0) if new Pod is scheduled to any of the three zones, it will violate MaxSkew.

+

This is a beta field and requires the MinDomainsInPodTopologySpread feature gate to be enabled (enabled by default).

+

nodeAffinityPolicy

+

String

+

NodeAffinityPolicy indicates how we will treat Pod's nodeAffinity/nodeSelector when calculating pod topology spread skew. Options are: - Honor: only nodes matching nodeAffinity/nodeSelector are included in the calculations. - Ignore: nodeAffinity/nodeSelector are ignored. All nodes are included in the calculations.

+

If this value is nil, the behavior is equivalent to the Honor policy. This is a alpha-level feature enabled by the NodeInclusionPolicyInPodTopologySpread feature flag.

+

nodeTaintsPolicy

+

String

+

NodeTaintsPolicy indicates how we will treat node taints when calculating pod topology spread skew. Options are: - Honor: nodes without taints, along with tainted nodes for which the incoming pod has a toleration, are included. - Ignore: node taints are ignored. All nodes are included.

+

If this value is nil, the behavior is equivalent to the Ignore policy. This is a alpha-level feature enabled by the NodeInclusionPolicyInPodTopologySpread feature flag.

+

topologyKey

+

String

+

TopologyKey is the key of node labels. Nodes that have a label

+

with this key and identical values are considered to be in the same topology.

+

We consider each <key, value> as a "bucket", and try to put balanced number

+

of pods into each bucket. We define a domain as a particular instance of

+

a topology. Also, we define an eligible domain as a domain whose nodes meet

+

the requirements of nodeAffinityPolicy and nodeTaintsPolicy. e.g. If TopologyKey

+

is "kubernetes.io/hostname", each Node is a domain of that topology. And,

+

if TopologyKey is "topology.kubernetes.io/zone", each zone is a domain of

+

that topology. It's a required field.

+

whenUnsatisfiable

+

String

+

WhenUnsatisfiable indicates how to deal with a pod if it doesn't satisfy the spread constraint. - DoNotSchedule (default) tells the scheduler not to schedule it. - ScheduleAnyway tells the scheduler to schedule the pod in any location,

+

but giving higher precedence to topologies that would help reduce the

+

skew.

+

A constraint is considered "Unsatisfiable" for an incoming pod if and only if every possible node assignment for that pod would violate "MaxSkew" on some topology. For example, in a 3-zone cluster, MaxSkew is set to 1, and pods with the same labelSelector spread as 3/1/1: | zone1 | zone2 | zone3 | | P P P | P | P | If WhenUnsatisfiable is set to DoNotSchedule, incoming pod can only be scheduled to zone2(zone3) to become 3/2/1(3/1/2) as ActualSkew(2-1) on zone2(zone3) satisfies MaxSkew(1). In other words, the cluster can still be imbalanced, but scheduler won't make it more imbalanced. It's a required field.

+

Possible enum values:

+
  • "DoNotSchedule" instructs the scheduler not to schedule the pod when constraints are not satisfied.
  • "ScheduleAnyway" instructs the scheduler to schedule the pod even if constraints are not satisfied.
+
+
+ +
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Table 115 io.cci.otc.api.pkg.apis.versioned.cci.v2.Volume

Parameter

+

Type

+

Description

+

configMap

+

io.cci.otc.api.pkg.apis.versioned.cci.v2.ConfigMapVolumeSource object

+

configMap represents a configMap that should populate this volume

+

downwardAPI

+

io.cci.otc.api.pkg.apis.versioned.cci.v2.DownwardAPIVolumeSource object

+

downwardAPI represents downward API about the pod that should

+

populate this volume

+

emptyDir

+

io.cci.otc.api.pkg.apis.versioned.cci.v2.EmptyDirVolumeSource object

+

emptyDir represents a temporary directory that shares a pod's lifetime. More info: https://kubernetes.io/docs/concepts/storage/volumes#emptydir

+

ephemeral

+

io.cci.otc.api.pkg.apis.versioned.cci.v2.EphemeralVolumeSource object

+

ephemeral represents a volume that is handled by a cluster storage driver. The volume's lifecycle is tied to the pod that defines it - it will be created before the pod starts, and deleted when the pod is removed.

+

Use this if: a) the volume is only needed while the pod runs, b) features of normal volumes like restoring from snapshot or capacity

+

tracking are needed,

+

c) the storage driver is specified through a storage class, and d) the storage driver supports dynamic volume provisioning through

+

a PersistentVolumeClaim (see EphemeralVolumeSource for more

+

information on the connection between this volume type

+

and PersistentVolumeClaim).

+

Use PersistentVolumeClaim or one of the vendor-specific APIs for volumes that persist for longer than the lifecycle of an individual pod.

+

Use CSI for light-weight local ephemeral volumes if the CSI driver is meant to be used that way - see the documentation of the driver for more information.

+

A pod can use both types of ephemeral volumes and persistent volumes at the same time.

+

name

+

String

+

name of the volume. Must be a DNS_LABEL and unique within the pod. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names

+

nfs

+

io.cci.otc.api.pkg.apis.versioned.cci.v2.NFSVolumeSource object

+

nfs represents an NFS mount on the host that shares a pod's lifetime More info: https://kubernetes.io/docs/concepts/storage/volumes#nfs

+

persistentVolumeClaim

+

io.cci.otc.api.pkg.apis.versioned.cci.v2.PersistentVolumeClaimVolumeSource object

+

persistentVolumeClaimVolumeSource represents a reference to a PersistentVolumeClaim in the same namespace. More info: https://kubernetes.io/docs/concepts/storage/persistent-volumes#persistentvolumeclaims

+

projected

+

io.cci.otc.api.pkg.apis.versioned.cci.v2.ProjectedVolumeSource object

+

projected items for all in one resources secrets, configmaps,

+

and downward API

+

secret

+

io.cci.otc.api.pkg.apis.versioned.cci.v2.SecretVolumeSource object

+

secret represents a secret that should populate this volume. More info: https://kubernetes.io/docs/concepts/storage/volumes#secret

+
+
+ +
+ + + + + + + + + + + + + + + + + + + + + +
Table 116 io.cci.otc.api.pkg.apis.versioned.cci.v2.ConfigMapVolumeSource

Parameter

+

Type

+

Description

+

defaultMode

+

Integer

+

defaultMode is optional: mode bits used to set permissions on created files by default. Must be an octal value between 0000 and 0777 or a decimal value between 0 and 511. YAML accepts both octal and decimal values, JSON requires decimal values for mode bits. Defaults to 0644. Directories within the path are not affected by this setting. This might be in conflict with other options that affect the file mode, like fsGroup, and the result can be other mode bits set.

+

items

+

Array of io.cci.otc.api.pkg.apis.versioned.cci.v2.KeyToPath objects

+

items if unspecified, each key-value pair in the Data field of

+

the referenced ConfigMap will be projected into the volume as a file whose

+

name is the key and content is the value. If specified, the listed keys

+

will be projected into the specified paths, and unlisted keys will not be

+

present. If a key is specified which is not present in the ConfigMap, the

+

volume setup will error unless it is marked optional. Paths must be relative

+

and may not contain the '..' path or start with '..'.

+

name

+

String

+

Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names

+

optional

+

Boolean

+

optional specify whether the ConfigMap or its keys must be defined

+
+
+ +
+ + + + + + + + + + + + + +
Table 117 io.cci.otc.api.pkg.apis.versioned.cci.v2.DownwardAPIVolumeSource

Parameter

+

Type

+

Description

+

defaultMode

+

Integer

+

Optional: mode bits to use on created files by default. Must be a Optional: mode bits used to set permissions on created files by default. Must be an octal value between 0000 and 0777 or a decimal value between 0 and 511. YAML accepts both octal and decimal values, JSON requires decimal values for mode bits. Defaults to 0644. Directories within the path are not affected by this setting. This might be in conflict with other options that affect the file mode, like fsGroup, and the result can be other mode bits set.

+

items

+

Array of io.cci.otc.api.pkg.apis.versioned.cci.v2.DownwardAPIVolumeFile objects

+

Items is a list of downward API volume file

+
+
+ +
+ + + + + + + + + + + + + +
Table 118 io.cci.otc.api.pkg.apis.versioned.cci.v2.EmptyDirVolumeSource

Parameter

+

Type

+

Description

+

medium

+

String

+

medium represents what type of storage medium should back this directory. The default is "" which means to use the node's default medium. Must be an empty string (default) or Memory. More info: https://kubernetes.io/docs/concepts/storage/volumes#emptydir

+

sizeLimit

+

String

+

sizeLimit is the total amount of local storage required for this EmptyDir volume. The size limit is also applicable for memory medium. The maximum usage on memory medium EmptyDir would be the minimum value between the SizeLimit specified here and the sum of memory limits of all containers in a pod. The default is nil which means that the limit is undefined. More info: http://kubernetes.io/docs/user-guide/volumes#emptydir

+
+
+ +
+ + + + + + + + + +
Table 119 io.cci.otc.api.pkg.apis.versioned.cci.v2.EphemeralVolumeSource

Parameter

+

Type

+

Description

+

volumeClaimTemplate

+

io.cci.otc.api.pkg.apis.versioned.cci.v2.PersistentVolumeClaimTemplate object

+

Will be used to create a stand-alone PVC to provision the volume. The pod in which this EphemeralVolumeSource is embedded will be the owner of the PVC, i.e. the PVC will be deleted together with the pod. The name of the PVC will be <pod name>-<volume name> where <volume name> is the name from the PodSpec.Volumes array entry. Pod validation will reject the pod if the concatenated name is not valid for a PVC (for example, too long).

+

An existing PVC with that name that is not owned by the pod will not be used for the pod to avoid using an unrelated volume by mistake. Starting the pod is then blocked until the unrelated PVC is removed. If such a pre-created PVC is meant to be used by the pod, the PVC has to updated with an owner reference to the pod once the pod exists. Normally this should not be necessary, but it may be useful when manually reconstructing a broken cluster.

+

This field is read-only and no changes will be made by Kubernetes to the PVC after it has been created.

+

Required, must not be nil.

+
+
+ +
+ + + + + + + + + + + + + +
Table 120 io.cci.otc.api.pkg.apis.versioned.cci.v2.PersistentVolumeClaimTemplate

Parameter

+

Type

+

Description

+

metadata

+

io.k8s.apimachinery.pkg.apis.meta.v1.ObjectMeta object

+

May contain labels and annotations that will be copied into the

+

PVC when creating it. No other fields are allowed and will be rejected during

+

validation.

+

spec

+

io.cci.otc.api.pkg.apis.versioned.cci.v2.PersistentVolumeClaimSpec object

+

The specification for the PersistentVolumeClaim. The entire content

+

is copied unchanged into the PVC that gets created from this template. The

+

same fields as in a PersistentVolumeClaim are also valid here.

+
+
+ +
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Table 121 io.k8s.apimachinery.pkg.apis.meta.v1.ObjectMeta

Parameter

+

Type

+

Description

+

annotations

+

Map<String,String>

+

Annotations is an unstructured key value map stored with a resource that may be set by external tools to store and retrieve arbitrary metadata. They are not queryable and should be preserved when modifying objects. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/annotations/

+

clusterName

+

String

+

The name of the cluster which the object belongs to. This is

+

used to distinguish resources with same name and namespace in different

+

clusters. This field is not set anywhere right now and apiserver is going

+

to ignore it if set in create or update request.

+

creationTimestamp

+

String

+

CreationTimestamp is a timestamp representing the server time when this object was created. It is not guaranteed to be set in happens-before order across separate operations. Clients may not set this value. It is represented in RFC3339 form and is in UTC.

+

Populated by the system. Read-only. Null for lists. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata

+

deletionGracePeriodSeconds

+

Long

+

Number of seconds allowed for this object to gracefully terminate

+

before it will be removed from the system. Only set when deletionTimestamp

+

is also set. May only be shortened. Read-only.

+

deletionTimestamp

+

String

+

DeletionTimestamp is RFC 3339 date and time at which this resource will be deleted. This field is set by the server when a graceful deletion is requested by the user, and is not directly settable by a client. The resource is expected to be deleted (no longer visible from resource lists, and not reachable by name) after the time in this field, once the finalizers list is empty. As long as the finalizers list contains items, deletion is blocked. Once the deletionTimestamp is set, this value may not be unset or be set further into the future, although it may be shortened or the resource may be deleted prior to this time. For example, a user may request that a pod is deleted in 30 seconds. The Kubelet will react by sending a graceful termination signal to the containers in the pod. After that 30 seconds, the Kubelet will send a hard termination signal (SIGKILL) to the container and after cleanup, remove the pod from the API. In the presence of network partitions, this object may still exist after this timestamp, until an administrator or automated process can determine the resource is fully terminated. If not set, graceful deletion of the object has not been requested.

+

Populated by the system when a graceful deletion is requested. Read-only. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata

+

enable

+

Boolean

+

Enable identifies whether the resource is available

+

finalizers

+

Array of strings

+

Must be empty before the object is deleted from the registry.

+

Each entry is an identifier for the responsible component that will remove

+

the entry from the list. If the deletionTimestamp of the object is non-nil,

+

entries in this list can only be removed. Finalizers may be processed and

+

removed in any order. Order is NOT enforced because it introduces significant

+

risk of stuck finalizers. finalizers is a shared field, any actor with permission

+

can reorder it. If the finalizer list is processed in order, then this can

+

lead to a situation in which the component responsible for the first finalizer

+

in the list is waiting for a signal (field value, external system, or other)

+

produced by a component responsible for a finalizer later in the list, resulting

+

in a deadlock. Without enforced ordering finalizers are free to order amongst

+

themselves and are not vulnerable to ordering changes in the list.

+

generateName

+

String

+

GenerateName is an optional prefix, used by the server, to generate a unique name ONLY IF the Name field has not been provided. If this field is used, the name returned to the client will be different than the name passed. This value will also be combined with a unique suffix. The provided value has the same validation rules as the Name field, and may be truncated by the length of the suffix required to make the value unique on the server.

+

If this field is specified and the generated name exists, the server will NOT return a 409 - instead, it will either return 201 Created or 500 with Reason ServerTimeout indicating a unique name could not be found in the time allotted, and the client should retry (optionally after the time indicated in the Retry-After header).

+

Applied only if Name is not specified. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#idempotency

+

generation

+

Long

+

A sequence number representing a specific generation of the desired

+

state. Populated by the system. Read-only.

+

labels

+

Map<String,String>

+

Map of string keys and values that can be used to organize and categorize (scope and select) objects. May match selectors of replication controllers and services. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/labels/

+

managedFields

+

Array of io.k8s.apimachinery.pkg.apis.meta.v1.ManagedFieldsEntry objects

+

ManagedFields maps workflow-id and version to the set of fields

+

that are managed by that workflow. This is mostly for internal housekeeping,

+

and users typically shouldn't need to set or understand this field. A workflow

+

can be the user's name, a controller's name, or the name of a specific apply

+

path like "ci-cd". The set of fields is always in the version that the workflow

+

used when modifying the object.

+

name

+

String

+

Name must be unique within a namespace. Is required when creating resources, although some resources may allow a client to request the generation of an appropriate name automatically. Name is primarily intended for creation idempotence and configuration definition. Cannot be updated. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names

+

namespace

+

String

+

Namespace defines the space within which each name must be unique. An empty namespace is equivalent to the "default" namespace, but "default" is the canonical representation. Not all objects are required to be scoped to a namespace - the value of this field for those objects will be empty.

+

Must be a DNS_LABEL. Cannot be updated. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/namespaces/

+

ownerReferences

+

Array of io.k8s.apimachinery.pkg.apis.meta.v1.OwnerReference objects

+

List of objects depended by this object. If ALL objects in the

+

list have been deleted, this object will be garbage collected. If this object

+

is managed by a controller, then an entry in this list will point to this

+

controller, with the controller field set to true. There cannot be more

+

than one managing controller.

+

resourceVersion

+

String

+

An opaque value that represents the internal version of this object that can be used by clients to determine when objects have changed. May be used for optimistic concurrency, change detection, and the watch operation on a resource or set of resources. Clients must treat these values as opaque and passed unmodified back to the server. They may only be valid for a particular resource or set of resources.

+

Populated by the system. Read-only. Value must be treated as opaque by clients and . More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#concurrency-control-and-consistency

+

selfLink

+

String

+

SelfLink is a URL representing this object. Populated by the system. Read-only.

+

DEPRECATED Kubernetes will stop propagating this field in 1.20 release and the field is planned to be removed in 1.21 release.

+

uid

+

String

+

UID is the unique in time and space value for this object. It is typically generated by the server on successful creation of a resource and is not allowed to change on PUT operations.

+

Populated by the system. Read-only. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#uids

+
+
+ +
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Table 122 io.k8s.apimachinery.pkg.apis.meta.v1.ManagedFieldsEntry

Parameter

+

Type

+

Description

+

apiVersion

+

String

+

APIVersion defines the version of this resource that this field

+

set applies to. The format is "group/version" just like the top-level APIVersion

+

field. It is necessary to track the version of a field set because it cannot

+

be automatically converted.

+

fieldsType

+

String

+

FieldsType is the discriminator for the different fields format and version. There is currently only one possible value: "FieldsV1"

+

fieldsV1

+

Object

+

FieldsV1 holds the first JSON version format as described in

+

the "FieldsV1" type.

+

manager

+

String

+

Manager is an identifier of the workflow managing these fields.

+

operation

+

String

+

Operation is the type of operation which lead to this ManagedFieldsEntry

+

being created. The only valid values for this field are 'Apply' and 'Update'.

+

time

+

String

+

Time is timestamp of when these fields were set. It should always

+

be empty if Operation is 'Apply'

+
+
+ +
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Table 123 io.k8s.apimachinery.pkg.apis.meta.v1.OwnerReference

Parameter

+

Type

+

Description

+

apiVersion

+

String

+

API version of the referent.

+

blockOwnerDeletion

+

Boolean

+

If true, AND if the owner has the "foregroundDeletion" finalizer,

+

then the owner cannot be deleted from the key-value store until this reference

+

is removed. Defaults to false. To set this field, a user needs "delete"

+

permission of the owner, otherwise 422 (Unprocessable Entity) will be returned.

+

controller

+

Boolean

+

If true, this reference points to the managing controller.

+

kind

+

String

+

Kind of the referent. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds

+

name

+

String

+

Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names

+

uid

+

String

+

UID of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#uids

+
+
+ +
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Table 124 io.cci.otc.api.pkg.apis.versioned.cci.v2.PersistentVolumeClaimSpec

Parameter

+

Type

+

Description

+

accessModes

+

Array of strings

+

accessModes contains the desired access modes the volume should have. More info: https://kubernetes.io/docs/concepts/storage/persistent-volumes#access-modes-1

+

dataSource

+

io.cci.otc.api.pkg.apis.versioned.cci.v2.TypedLocalObjectReference object

+

dataSource field can be used to specify either: * An existing VolumeSnapshot object (snapshot.storage.k8s.io/VolumeSnapshot) * An existing PVC (PersistentVolumeClaim) If the provisioner or an external controller can support the specified data source, it will create a new volume based on the contents of the specified data source. If the AnyVolumeDataSource feature gate is enabled, this field will always have the same contents as the DataSourceRef field.

+

dataSourceRef

+

io.cci.otc.api.pkg.apis.versioned.cci.v2.TypedLocalObjectReference object

+

dataSourceRef specifies the object from which to populate the volume with data, if a non-empty volume is desired. This may be any local object from a non-empty API group (non core object) or a PersistentVolumeClaim object. When this field is specified, volume binding will only succeed if the type of the specified object matches some installed volume populator or dynamic provisioner. This field will replace the functionality of the DataSource field and as such if both fields are non-empty, they must have the same value. For backwards compatibility, both fields (DataSource and DataSourceRef) will be set to the same value automatically if one of them is empty and the other is non-empty. There are two important differences between DataSource and DataSourceRef: * While DataSource only allows two specific types of objects, DataSourceRef

+

allows any non-core object, as well as PersistentVolumeClaim objects.

+
  • While DataSource ignores disallowed values (dropping them), DataSourceRef

    preserves all values, and generates an error if a disallowed value is

    +

    specified.

    +

    (Beta) Using this field requires the AnyVolumeDataSource feature gate to be enabled.

    +
+

resources

+

io.cci.otc.api.pkg.apis.versioned.cci.v2.ResourceRequirements object

+

resources represents the minimum resources the volume should have. If RecoverVolumeExpansionFailure feature is enabled users are allowed to specify resource requirements that are lower than previous value but must still be higher than capacity recorded in the status field of the claim. More info: https://kubernetes.io/docs/concepts/storage/persistent-volumes#resources

+

selector

+

io.k8s.apimachinery.pkg.apis.meta.v1.LabelSelector object

+

selector is a label query over volumes to consider for binding.

+

storageClassName

+

String

+

storageClassName is the name of the StorageClass required by the claim. More info: https://kubernetes.io/docs/concepts/storage/persistent-volumes#class-1

+

volumeMode

+

String

+

volumeMode defines what type of volume is required by the claim.

+

Value of Filesystem is implied when not included in claim spec.

+

volumeName

+

String

+

volumeName is the binding reference to the PersistentVolume backing

+

this claim.

+
+
+ +
+ + + + + + + + + + + + + + + + + +
Table 125 io.cci.otc.api.pkg.apis.versioned.cci.v2.TypedLocalObjectReference

Parameter

+

Type

+

Description

+

apiGroup

+

String

+

APIGroup is the group for the resource being referenced. If APIGroup

+

is not specified, the specified Kind must be in the core API group. For

+

any other third-party types, APIGroup is required.

+

kind

+

String

+

Kind is the type of resource being referenced

+

name

+

String

+

Name is the name of resource being referenced

+
+
+ +
+ + + + + + + + + + + + + +
Table 126 io.cci.otc.api.pkg.apis.versioned.cci.v2.ResourceRequirements

Parameter

+

Type

+

Description

+

limits

+

Map<String,String>

+

Limits describes the maximum amount of compute resources allowed. More info: https://kubernetes.io/docs/concepts/configuration/manage-resources-containers/

+

requests

+

Map<String,String>

+

Requests describes the minimum amount of compute resources required. If Requests is omitted for a container, it defaults to Limits if that is explicitly specified, otherwise to an implementation-defined value. More info: https://kubernetes.io/docs/concepts/configuration/manage-resources-containers/

+
+
+ +
+ + + + + + + + + +
Table 127 io.k8s.apimachinery.pkg.api.resource.Quantity

Parameter

+

Type

+

Description

+

-

+

String

+

Quantity is a fixed-point representation of a number. It provides convenient marshaling/unmarshaling in JSON and YAML, in addition to String() and AsInt64() accessors.

+

The serialization format is:

+

[/topic/body/section/table/tgroup/tbody/row/entry/p/br {""})(br] ::= [/topic/body/section/table/tgroup/tbody/row/entry/p/br {""})(br][/topic/body/section/table/tgroup/tbody/row/entry/p/br {""})(br]

+

(Note that [/topic/body/section/table/tgroup/tbody/row/entry/p/br {""})(br] may be empty, from the "" case in [/topic/body/section/table/tgroup/tbody/row/entry/p/br {""})(br].)

+

[/topic/body/section/table/tgroup/tbody/row/entry/p/br {""})(br] ::= 0 | 1 | ... | 9 [/topic/body/section/table/tgroup/tbody/row/entry/p/br {""})(br] ::= [/topic/body/section/table/tgroup/tbody/row/entry/p/br {""})(br] | [/topic/body/section/table/tgroup/tbody/row/entry/p/br {""})(br][/topic/body/section/table/tgroup/tbody/row/entry/p/br {""})(br][/topic/body/section/table/tgroup/tbody/row/entry/p/br {""})(br] ::= [/topic/body/section/table/tgroup/tbody/row/entry/p/br {""})(br] | [/topic/body/section/table/tgroup/tbody/row/entry/p/br {""})(br].[/topic/body/section/table/tgroup/tbody/row/entry/p/br {""})(br] | [/topic/body/section/table/tgroup/tbody/row/entry/p/br {""})(br]. | .[/topic/body/section/table/tgroup/tbody/row/entry/p/br {""})(br][/topic/body/section/table/tgroup/tbody/row/entry/p/br {""})(br] ::= "+" | "-" [/topic/body/section/table/tgroup/tbody/row/entry/p/br {""})(br] ::= [/topic/body/section/table/tgroup/tbody/row/entry/p/br {""})(br] | [/topic/body/section/table/tgroup/tbody/row/entry/p/br {""})(br][/topic/body/section/table/tgroup/tbody/row/entry/p/br {""})(br][/topic/body/section/table/tgroup/tbody/row/entry/p/br {""})(br] ::= [/topic/body/section/table/tgroup/tbody/row/entry/p/br {""})(br] | [/topic/body/section/table/tgroup/tbody/row/entry/p/br {""})(br] | [/topic/body/section/table/tgroup/tbody/row/entry/p/br {""})(br][/topic/body/section/table/tgroup/tbody/row/entry/p/br {""})(br] ::= Ki | Mi | Gi | Ti | Pi | Ei

+

(International System of units; See: http://physics.nist.gov/cuu/Units/binary.html)

+

[/topic/body/section/table/tgroup/tbody/row/entry/p/br {""})(br] ::= m | "" | k | M | G | T | P | E

+

(Note that 1024 = 1Ki but 1000 = 1k; I didn't choose the capitalization.)

+

[/topic/body/section/table/tgroup/tbody/row/entry/p/br {""})(br] ::= "e" [/topic/body/section/table/tgroup/tbody/row/entry/p/br {""})(br] | "E" [/topic/body/section/table/tgroup/tbody/row/entry/p/br {""})(br]

+

No matter which of the three exponent forms is used, no quantity may represent a number greater than 2^63-1 in magnitude, nor may it have more than 3 decimal places. Numbers larger or more precise will be capped or rounded up. (E.g.: 0.1m will rounded up to 1m.) This may be extended in the future if we require larger or smaller quantities.

+

When a Quantity is parsed from a string, it will remember the type of suffix it had, and will use the same type again when it is serialized.

+

Before serializing, Quantity will be put in "canonical form". This means that Exponent/suffix will be adjusted up or down (with a corresponding increase or decrease in Mantissa) such that:

+

a. No precision is lost

+

b. No fractional digits will be emitted

+

c. The exponent (or suffix) is as large as possible.

+

The sign will be omitted unless the number is negative.

+

Examples:

+

1.5 will be serialized as "1500m"

+

1.5Gi will be serialized as "1536Mi"

+

Note that the quantity will NEVER be internally represented by a floating point number. That is the whole point of this exercise.

+

Non-canonical values will still parse as long as they are well formed, but will be re-emitted in their canonical form. (So always use canonical form, or don't diff.)

+

This format is intended to make it difficult to use these numbers without writing some sort of special handling code in the hopes that that will cause implementors to also use a fixed point implementation.

+
+
+ +
+ + + + + + + + + + + + + +
Table 128 io.k8s.apimachinery.pkg.apis.meta.v1.LabelSelector

Parameter

+

Type

+

Description

+

matchExpressions

+

Array of io.k8s.apimachinery.pkg.apis.meta.v1.LabelSelectorRequirement objects

+

matchExpressions is a list of label selector requirements. The

+

requirements are ANDed.

+

matchLabels

+

Map<String,String>

+

matchLabels is a map of {key,value} pairs. A single {key,value}

+

in the matchLabels map is equivalent to an element of matchExpressions,

+

whose key field is "key", the operator is "In", and the values array contains

+

only "value". The requirements are ANDed.

+
+
+ +
+ + + + + + + + + + + + + + + + + +
Table 129 io.k8s.apimachinery.pkg.apis.meta.v1.LabelSelectorRequirement

Parameter

+

Type

+

Description

+

key

+

String

+

key is the label key that the selector applies to.

+

operator

+

String

+

operator represents a key's relationship to a set of values.

+

Valid operators are In, NotIn, Exists and DoesNotExist.

+

values

+

Array of strings

+

values is an array of string values. If the operator is In or

+

NotIn, the values array must be non-empty. If the operator is Exists or

+

DoesNotExist, the values array must be empty. This array is replaced during

+

a strategic merge patch.

+
+
+ +
+ + + + + + + + + + + + + + + + + +
Table 130 io.cci.otc.api.pkg.apis.versioned.cci.v2.NFSVolumeSource

Parameter

+

Type

+

Description

+

path

+

String

+

path that is exported by the NFS server. More info: https://kubernetes.io/docs/concepts/storage/volumes#nfs

+

readOnly

+

Boolean

+

readOnly here will force the NFS export to be mounted with read-only permissions. Defaults to false. More info: https://kubernetes.io/docs/concepts/storage/volumes#nfs

+

server

+

String

+

server is the hostname or IP address of the NFS server. More info: https://kubernetes.io/docs/concepts/storage/volumes#nfs

+
+
+ +
+ + + + + + + + + + + + + +
Table 131 io.cci.otc.api.pkg.apis.versioned.cci.v2.PersistentVolumeClaimVolumeSource

Parameter

+

Type

+

Description

+

claimName

+

String

+

claimName is the name of a PersistentVolumeClaim in the same namespace as the pod using this volume. More info: https://kubernetes.io/docs/concepts/storage/persistent-volumes#persistentvolumeclaims

+

readOnly

+

Boolean

+

readOnly Will force the ReadOnly setting in VolumeMounts. Default

+

false.

+
+
+ +
+ + + + + + + + + + + + + +
Table 132 io.cci.otc.api.pkg.apis.versioned.cci.v2.ProjectedVolumeSource

Parameter

+

Type

+

Description

+

defaultMode

+

Integer

+

defaultMode are the mode bits used to set permissions on created

+

files by default. Must be an octal value between 0000 and 0777 or a decimal

+

value between 0 and 511. YAML accepts both octal and decimal values, JSON

+

requires decimal values for mode bits. Directories within the path are not

+

affected by this setting. This might be in conflict with other options that

+

affect the file mode, like fsGroup, and the result can be other mode bits

+

set.

+

sources

+

Array of io.cci.otc.api.pkg.apis.versioned.cci.v2.VolumeProjection objects

+

sources is the list of volume projections

+
+
+ +
+ + + + + + + + + + + + + + + + + +
Table 133 io.cci.otc.api.pkg.apis.versioned.cci.v2.VolumeProjection

Parameter

+

Type

+

Description

+

configMap

+

io.cci.otc.api.pkg.apis.versioned.cci.v2.ConfigMapProjection object

+

configMap information about the configMap data to project

+

downwardAPI

+

io.cci.otc.api.pkg.apis.versioned.cci.v2.DownwardAPIProjection object

+

downwardAPI information about the downwardAPI data to project

+

secret

+

io.cci.otc.api.pkg.apis.versioned.cci.v2.SecretProjection object

+

secret information about the secret data to project

+
+
+ +
+ + + + + + + + + + + + + + + + + +
Table 134 io.cci.otc.api.pkg.apis.versioned.cci.v2.ConfigMapProjection

Parameter

+

Type

+

Description

+

items

+

Array of io.cci.otc.api.pkg.apis.versioned.cci.v2.KeyToPath objects

+

items if unspecified, each key-value pair in the Data field of

+

the referenced ConfigMap will be projected into the volume as a file whose

+

name is the key and content is the value. If specified, the listed keys

+

will be projected into the specified paths, and unlisted keys will not be

+

present. If a key is specified which is not present in the ConfigMap, the

+

volume setup will error unless it is marked optional. Paths must be relative

+

and may not contain the '..' path or start with '..'.

+

name

+

String

+

Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names

+

optional

+

Boolean

+

optional specify whether the ConfigMap or its keys must be defined

+
+
+ +
+ + + + + + + + + +
Table 135 io.cci.otc.api.pkg.apis.versioned.cci.v2.DownwardAPIProjection

Parameter

+

Type

+

Description

+

items

+

Array of io.cci.otc.api.pkg.apis.versioned.cci.v2.DownwardAPIVolumeFile objects

+

Items is a list of DownwardAPIVolume file

+
+
+ +
+ + + + + + + + + + + + + + + + + + + + + +
Table 136 io.cci.otc.api.pkg.apis.versioned.cci.v2.DownwardAPIVolumeFile

Parameter

+

Type

+

Description

+

fieldRef

+

io.cci.otc.api.pkg.apis.versioned.cci.v2.ObjectFieldSelector object

+

Required: Selects a field of the pod: only annotations, labels, name and namespace are supported.

+

mode

+

Integer

+

Optional: mode bits used to set permissions on this file, must be an octal value between 0000 and 0777 or a decimal value between 0 and 511. YAML accepts both octal and decimal values, JSON requires decimal values for mode bits. If not specified, the volume defaultMode will be used. This might be in conflict with other options that affect the file mode, like fsGroup, and the result can be other mode bits set.

+

path

+

String

+

Required: Path is the relative path name of the file to be created. Must not be absolute or contain the '..' path. Must be utf-8 encoded. The first item of the relative path must not start with '..'

+

resourceFieldRef

+

io.cci.otc.api.pkg.apis.versioned.cci.v2.ResourceFieldSelector object

+

Selects a resource of the container: only resources limits and requests (limits.cpu, limits.memory, requests.cpu and requests.memory) are currently supported.

+
+
+ +
+ + + + + + + + + + + + + +
Table 137 io.cci.otc.api.pkg.apis.versioned.cci.v2.ObjectFieldSelector

Parameter

+

Type

+

Description

+

apiVersion

+

String

+

Version of the schema the FieldPath is written in terms of, defaults

+

to "v1".

+

fieldPath

+

String

+

Path of the field to select in the specified API version.

+
+
+ +
+ + + + + + + + + + + + + + + + + +
Table 138 io.cci.otc.api.pkg.apis.versioned.cci.v2.ResourceFieldSelector

Parameter

+

Type

+

Description

+

containerName

+

String

+

Container name: required for volumes, optional for env vars

+

divisor

+

String

+

Specifies the output format of the exposed resources, defaults

+

to "1"

+

resource

+

String

+

Required: resource to select

+
+
+ +
+ + + + + + + + + + + + + + + + + +
Table 139 io.cci.otc.api.pkg.apis.versioned.cci.v2.SecretProjection

Parameter

+

Type

+

Description

+

items

+

Array of io.cci.otc.api.pkg.apis.versioned.cci.v2.KeyToPath objects

+

items if unspecified, each key-value pair in the Data field of

+

the referenced Secret will be projected into the volume as a file whose

+

name is the key and content is the value. If specified, the listed keys

+

will be projected into the specified paths, and unlisted keys will not be

+

present. If a key is specified which is not present in the Secret, the volume

+

setup will error unless it is marked optional. Paths must be relative and

+

may not contain the '..' path or start with '..'.

+

name

+

String

+

Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names

+

optional

+

Boolean

+

optional field specify whether the Secret or its key must be

+

defined

+
+
+ +
+ + + + + + + + + + + + + + + + + + + + + +
Table 140 io.cci.otc.api.pkg.apis.versioned.cci.v2.SecretVolumeSource

Parameter

+

Type

+

Description

+

defaultMode

+

Integer

+

defaultMode is Optional: mode bits used to set permissions on created files by default. Must be an octal value between 0000 and 0777 or a decimal value between 0 and 511. YAML accepts both octal and decimal values, JSON requires decimal values for mode bits. Defaults to 0644. Directories within the path are not affected by this setting. This might be in conflict with other options that affect the file mode, like fsGroup, and the result can be other mode bits set.

+

items

+

Array of io.cci.otc.api.pkg.apis.versioned.cci.v2.KeyToPath objects

+

items If unspecified, each key-value pair in the Data field of

+

the referenced Secret will be projected into the volume as a file whose

+

name is the key and content is the value. If specified, the listed keys

+

will be projected into the specified paths, and unlisted keys will not be

+

present. If a key is specified which is not present in the Secret, the volume

+

setup will error unless it is marked optional. Paths must be relative and

+

may not contain the '..' path or start with '..'.

+

optional

+

Boolean

+

optional field specify whether the Secret or its keys must be

+

defined

+

secretName

+

String

+

secretName is the name of the secret in the pod's namespace to use. More info: https://kubernetes.io/docs/concepts/storage/volumes#secret

+
+
+ +
+ + + + + + + + + + + + + + + + + +
Table 141 io.cci.otc.api.pkg.apis.versioned.cci.v2.KeyToPath

Parameter

+

Type

+

Description

+

key

+

String

+

key is the key to project.

+

mode

+

Integer

+

mode is Optional: mode bits used to set permissions on this file. Must be an octal value between 0000 and 0777 or a decimal value between 0 and 511. YAML accepts both octal and decimal values, JSON requires decimal values for mode bits. If not specified, the volume defaultMode will be used. This might be in conflict with other options that affect the file mode, like fsGroup, and the result can be other mode bits set.

+

path

+

String

+

path is the relative path of the file to map the key to. May

+

not be an absolute path. May not contain the path element '..'. May not

+

start with the string '..'.

+
+
+ +
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Table 142 io.cci.otc.api.pkg.apis.versioned.cci.v2.PodStatus

Parameter

+

Type

+

Description

+

conditions

+

Array of io.cci.otc.api.pkg.apis.versioned.cci.v2.PodCondition objects

+

Current service state of pod. More info: https://kubernetes.io/docs/concepts/workloads/pods/pod-lifecycle#pod-conditions

+

containerStatuses

+

Array of io.cci.otc.api.pkg.apis.versioned.cci.v2.ContainerStatus objects

+

The list has one entry per container in the manifest. More info: https://kubernetes.io/docs/concepts/workloads/pods/pod-lifecycle#pod-and-container-status

+

ephemeralContainerStatuses

+

Array of io.cci.otc.api.pkg.apis.versioned.cci.v2.ContainerStatus objects

+

Status for any ephemeral containers that have run in this pod.

+

hostIP

+

String

+

IP address of the host to which the pod is assigned. Empty if

+

not yet scheduled.

+

initContainerStatuses

+

Array of io.cci.otc.api.pkg.apis.versioned.cci.v2.ContainerStatus objects

+

The list has one entry per init container in the manifest. The most recent successful init container will have ready = true, the most recently started container will have startTime set. More info: https://kubernetes.io/docs/concepts/workloads/pods/pod-lifecycle#pod-and-container-status

+

message

+

String

+

A human readable message indicating details about why the pod

+

is in this condition.

+

nominatedNodeName

+

String

+

nominatedNodeName is set only when this pod preempts other pods

+

on the node, but it cannot be scheduled right away as preemption victims

+

receive their graceful termination periods. This field does not guarantee

+

that the pod will be scheduled on this node. Scheduler may decide to place

+

the pod elsewhere if other nodes become available sooner. Scheduler may

+

also decide to give the resources on this node to a higher priority pod

+

that is created after preemption. As a result, this field may be different

+

than PodSpec.nodeName when the pod is scheduled.

+

phase

+

String

+

The phase of a Pod is a simple, high-level summary of where the Pod is in its lifecycle. The conditions array, the reason and message fields, and the individual container status arrays contain more detail about the pod's status. There are five possible phase values:

+

Pending: The pod has been accepted by the Kubernetes system, but one or more of the container images has not been created. This includes time before being scheduled as well as time spent downloading images over the network, which could take a while. Running: The pod has been bound to a node, and all of the containers have been created. At least one container is still running, or is in the process of starting or restarting. Succeeded: All containers in the pod have terminated in success, and will not be restarted. Failed: All containers in the pod have terminated, and at least one container has terminated in failure. The container either exited with non-zero status or was terminated by the system. Unknown: For some reason the state of the pod could not be obtained, typically due to an error in communicating with the host of the pod.

+

More info: https://kubernetes.io/docs/concepts/workloads/pods/pod-lifecycle#pod-phase

+

Possible enum values:

+
  • "Failed" means that all containers in the pod have terminated, and at least one container has terminated in a failure (exited with a non-zero exit code or was stopped by the system).
  • "Pending" means the pod has been accepted by the system, but one or more of the containers has not been started. This includes time before being bound to a node, as well as time spent pulling images onto the host.
  • "Running" means the pod has been bound to a node and all of the containers have been started. At least one container is still running or is in the process of being restarted.
  • "Succeeded" means that all containers in the pod have voluntarily terminated with a container exit code of 0, and the system is not going to restart any of these containers.
  • "Unknown" means that for some reason the state of the pod could not be obtained, typically due to an error in communicating with the host of the pod. Deprecated: It isn't being set since 2015 (74da3b14b0c0f658b3bb8d2def5094686d0e9095)
+

podIP

+

String

+

IP address allocated to the pod. Routable at least within the

+

cluster. Empty if not yet allocated.

+

podIPs

+

Array of io.cci.otc.api.pkg.apis.versioned.cci.v2.PodIP objects

+

podIPs holds the IP addresses allocated to the pod. If this field

+

is specified, the 0th entry must match the podIP field. Pods may be allocated

+

at most 1 value for each of IPv4 and IPv6. This list is empty if no IPs

+

have been allocated yet.

+

qosClass

+

String

+

The Quality of Service (QOS) classification assigned to the pod based on resource requirements See PodQOSClass type for available QOS classes More info: https://git.k8s.io/community/contributors/design-proposals/node/resource-qos.md

+

Possible enum values:

+
  • "BestEffort" is the BestEffort qos class.
  • "Burstable" is the Burstable qos class.
  • "Guaranteed" is the Guaranteed qos class.
+

reason

+

String

+

A brief CamelCase message indicating details about why the pod

+

is in this state. e.g. 'Evicted'

+

startTime

+

String

+

RFC 3339 date and time at which the object was acknowledged by

+

the Kubelet. This is before the Kubelet pulled the container image(s) for

+

the pod.

+
+
+ +
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Table 143 io.cci.otc.api.pkg.apis.versioned.cci.v2.PodCondition

Parameter

+

Type

+

Description

+

lastProbeTime

+

String

+

Last time we probed the condition.

+

lastTransitionTime

+

String

+

Last time the condition transitioned from one status to another.

+

message

+

String

+

Human-readable message indicating details about last transition.

+

reason

+

String

+

Unique, one-word, CamelCase reason for the condition's last transition.

+

status

+

String

+

Status is the status of the condition. Can be True, False, Unknown. More info: https://kubernetes.io/docs/concepts/workloads/pods/pod-lifecycle#pod-conditions

+

type

+

String

+

Type is the type of the condition. More info: https://kubernetes.io/docs/concepts/workloads/pods/pod-lifecycle#pod-conditions

+
+
+ +
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Table 144 io.cci.otc.api.pkg.apis.versioned.cci.v2.ContainerStatus

Parameter

+

Type

+

Description

+

containerID

+

String

+

Container's ID in the format '[/topic/body/section/table/tgroup/tbody/row/entry/p/br {""})(br]://<container_id>'.

+

image

+

String

+

The image the container is running. More info: https://kubernetes.io/docs/concepts/containers/images.

+

imageID

+

String

+

ImageID of the container's image.

+

lastState

+

io.cci.otc.api.pkg.apis.versioned.cci.v2.ContainerState object

+

Details about the container's last termination condition.

+

name

+

String

+

This must be a DNS_LABEL. Each container in a pod must have a

+

unique name. Cannot be updated.

+

ready

+

Boolean

+

Specifies whether the container has passed its readiness probe.

+

restartCount

+

Integer

+

The number of times the container has been restarted.

+

started

+

Boolean

+

Specifies whether the container has passed its startup probe.

+

Initialized as false, becomes true after startupProbe is considered successful.

+

Resets to false when the container is restarted, or if kubelet loses state

+

temporarily. Is always true when no startupProbe is defined.

+

state

+

io.cci.otc.api.pkg.apis.versioned.cci.v2.ContainerState object

+

Details about the container's current condition.

+
+
+ +
+ + + + + + + + + + + + + + + + + +
Table 145 io.cci.otc.api.pkg.apis.versioned.cci.v2.ContainerState

Parameter

+

Type

+

Description

+

running

+

io.cci.otc.api.pkg.apis.versioned.cci.v2.ContainerStateRunning object

+

Details about a running container

+

terminated

+

io.cci.otc.api.pkg.apis.versioned.cci.v2.ContainerStateTerminated object

+

Details about a terminated container

+

waiting

+

io.cci.otc.api.pkg.apis.versioned.cci.v2.ContainerStateWaiting object

+

Details about a waiting container

+
+
+ +
+ + + + + + + + + +
Table 146 io.cci.otc.api.pkg.apis.versioned.cci.v2.ContainerStateRunning

Parameter

+

Type

+

Description

+

startedAt

+

String

+

Time at which the container was last (re-)started

+
+
+ +
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Table 147 io.cci.otc.api.pkg.apis.versioned.cci.v2.ContainerStateTerminated

Parameter

+

Type

+

Description

+

containerID

+

String

+

Container's ID in the format '[/topic/body/section/table/tgroup/tbody/row/entry/p/br {""})(br]://<container_id>'

+

exitCode

+

Integer

+

Exit status from the last termination of the container

+

finishedAt

+

String

+

Time at which the container last terminated

+

message

+

String

+

Message regarding the last termination of the container

+

reason

+

String

+

(brief) reason from the last termination of the container

+

signal

+

Integer

+

Signal from the last termination of the container

+

startedAt

+

String

+

Time at which previous execution of the container started

+
+
+ +
+ + + + + + + + + + + + + +
Table 148 io.cci.otc.api.pkg.apis.versioned.cci.v2.ContainerStateWaiting

Parameter

+

Type

+

Description

+

message

+

String

+

Message regarding why the container is not yet running.

+

reason

+

String

+

(brief) reason the container is not yet running.

+
+
+ +
+ + + + + + + + + +
Table 149 io.cci.otc.api.pkg.apis.versioned.cci.v2.PodIP

Parameter

+

Type

+

Description

+

ip

+

String

+

ip is an IP address (IPv4 or IPv6) assigned to the pod

+
+
+

Status code: 201

+ +
+ + + + + + + + + + + + + + + + + + + + + + + + + +
Table 150 Response body parameters

Parameter

+

Type

+

Description

+

apiVersion

+

String

+

APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#resources

+

kind

+

String

+

Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds

+

metadata

+

io.k8s.apimachinery.pkg.apis.meta.v1.ObjectMeta object

+

Standard object's metadata. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata

+

spec

+

io.cci.otc.api.pkg.apis.versioned.cci.v2.PodSpec object

+

Specification of the desired behavior of the pod. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#spec-and-status

+

status

+

io.cci.otc.api.pkg.apis.versioned.cci.v2.PodStatus object

+

Most recently observed status of the pod. This data may not be up to date. Populated by the system. Read-only. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#spec-and-status

+
+
+ +
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Table 151 io.cci.otc.api.pkg.apis.versioned.cci.v2.PodSpec

Parameter

+

Type

+

Description

+

activeDeadlineSeconds

+

Long

+

Optional duration in seconds the pod may be active on the node

+

relative to StartTime before the system will actively try to mark it failed

+

and kill associated containers. Value must be a positive integer.

+

affinity

+

io.cci.otc.api.pkg.apis.versioned.cci.v2.Affinity object

+

If specified, the pod's scheduling constraints

+

containers

+

Array of io.cci.otc.api.pkg.apis.versioned.cci.v2.Container objects

+

List of containers belonging to the pod. Containers cannot currently

+

be added or removed. There must be at least one container in a Pod. Cannot

+

be updated.

+

dnsConfig

+

io.cci.otc.api.pkg.apis.versioned.cci.v2.PodDNSConfig object

+

Specifies the DNS parameters of a pod. Parameters specified here

+

will be merged to the generated DNS configuration based on DNSPolicy.

+

dnsPolicy

+

String

+

Set DNS policy for the pod. Defaults to "ClusterFirst". Valid values are 'ClusterFirstWithHostNet', 'ClusterFirst', 'Default' or 'None'. DNS parameters given in DNSConfig will be merged with the policy selected with DNSPolicy. To have DNS options set along with hostNetwork, you have to specify DNS policy explicitly to 'ClusterFirstWithHostNet'.

+

Possible enum values:

+
  • "ClusterFirst" indicates that the pod should use cluster DNS first unless hostNetwork is true, if it is available, then fall back on the default (as determined by kubelet) DNS settings.
  • "ClusterFirstWithHostNet" indicates that the pod should use cluster DNS first, if it is available, then fall back on the default (as determined by kubelet) DNS settings.
  • "Default" indicates that the pod should use the default (as determined by kubelet) DNS settings.
  • "None" indicates that the pod should use empty DNS settings. DNS parameters such as nameservers and search paths should be defined via DNSConfig.
+

ephemeralContainers

+

Array of io.cci.otc.api.pkg.apis.versioned.cci.v2.EphemeralContainer objects

+

List of ephemeral containers run in this pod. Ephemeral containers

+

may be run in an existing pod to perform user-initiated actions such as

+

debugging. This list cannot be specified when creating a pod, and it cannot

+

be modified by updating the pod spec. In order to add an ephemeral container

+

to an existing pod, use the pod's ephemeralcontainers subresource.

+

hostAliases

+

Array of io.cci.otc.api.pkg.apis.versioned.cci.v2.HostAlias objects

+

HostAliases is an optional list of hosts and IPs that will be

+

injected into the pod's hosts file if specified. This is only valid for

+

non-hostNetwork pods.

+

hostname

+

String

+

Specifies the hostname of the Pod If not specified, the pod's

+

hostname will be set to a system-defined value.

+

imagePullSecrets

+

Array of io.cci.otc.api.pkg.apis.versioned.cci.v2.LocalObjectReference objects

+

ImagePullSecrets is an optional list of references to secrets in the same namespace to use for pulling any of the images used by this PodSpec. If specified, these secrets will be passed to individual puller implementations for them to use. More info: https://kubernetes.io/docs/concepts/containers/images#specifying-imagepullsecrets-on-a-pod

+

initContainers

+

Array of io.cci.otc.api.pkg.apis.versioned.cci.v2.Container objects

+

List of initialization containers belonging to the pod. Init containers are executed in order prior to containers being started. If any init container fails, the pod is considered to have failed and is handled according to its restartPolicy. The name for an init container or normal container must be unique among all containers. Init containers may not have Lifecycle actions, Readiness probes, Liveness probes, or Startup probes. The resourceRequirements of an init container are taken into account during scheduling by finding the highest request/limit for each resource type, and then using the max of of that value or the sum of the normal containers. Limits are applied to init containers in a similar fashion. Init containers cannot currently be added or removed. Cannot be updated. More info: https://kubernetes.io/docs/concepts/workloads/pods/init-containers/

+

nodeName

+

String

+

NodeName is a request to schedule this pod onto a specific node.

+

If it is non-empty, the scheduler simply schedules this pod onto that node,

+

assuming that it fits resource requirements.

+

overhead

+

Map<String,String>

+

Overhead represents the resource overhead associated with running a pod for a given RuntimeClass. This field will be autopopulated at admission time by the RuntimeClass admission controller. If the RuntimeClass admission controller is enabled, overhead must not be set in Pod create requests. The RuntimeClass admission controller will reject Pod create requests which have the overhead already set. If RuntimeClass is configured and selected in the PodSpec, Overhead will be set to the value defined in the corresponding RuntimeClass, otherwise it will remain unset and treated as zero. More info: https://git.k8s.io/enhancements/keps/sig-node/688-pod-overhead/README.md

+

readinessGates

+

Array of io.cci.otc.api.pkg.apis.versioned.cci.v2.PodReadinessGate objects

+

If specified, all readiness gates will be evaluated for pod readiness. A pod is ready when all its containers are ready AND all conditions specified in the readiness gates have status equal to "True" More info: https://git.k8s.io/enhancements/keps/sig-network/580-pod-readiness-gates

+

restartPolicy

+

String

+

Restart policy for all containers within the pod. One of Always, OnFailure, Never. Default to Always. More info: https://kubernetes.io/docs/concepts/workloads/pods/pod-lifecycle/#restart-policy

+

Possible enum values:

+
  • "Always"
  • "Never"
  • "OnFailure"
+

schedulerName

+

String

+

If specified, the pod will be dispatched by specified scheduler.

+

If not specified, the pod will be dispatched by default scheduler.

+

securityContext

+

io.cci.otc.api.pkg.apis.versioned.cci.v2.PodSecurityContext object

+

SecurityContext holds pod-level security attributes and common container settings. Optional: Defaults to empty. See type description for default values of each field.

+

setHostnameAsFQDN

+

Boolean

+

If true the pod's hostname will be configured as the pod's FQDN,

+

rather than the leaf name (the default). In Linux containers, this means

+

setting the FQDN in the hostname field of the kernel (the nodename field

+

of struct utsname). In Windows containers, this means setting the registry

+

value of hostname for the registry key HKEY_LOCAL_MACHINE\SYSTEM\CurrentControlSet\Services\Tcpip\Parameters

+

to FQDN. If a pod does not have FQDN, this has no effect. Default to false.

+

shareProcessNamespace

+

Boolean

+

Share a single process namespace between all of the containers in a pod. When this is set containers will be able to view and signal processes from other containers in the same pod, and the first process in each container will not be assigned PID 1. HostPID and ShareProcessNamespace cannot both be set. Optional: Default to false.

+

terminationGracePeriodSeconds

+

Long

+

Optional duration in seconds the pod needs to terminate gracefully.

+

May be decreased in delete request. Value must be non-negative integer.

+

The value zero indicates stop immediately via the kill signal (no opportunity

+

to shut down). If this value is nil, the default grace period will be used

+

instead. The grace period is the duration in seconds after the processes

+

running in the pod are sent a termination signal and the time when the processes

+

are forcibly halted with a kill signal. Set this value longer than the expected

+

cleanup time for your process. Defaults to 30 seconds.

+

topologySpreadConstraints

+

Array of io.cci.otc.api.pkg.apis.versioned.cci.v2.TopologySpreadConstraint objects

+

TopologySpreadConstraints describes how a group of pods ought

+

to spread across topology domains. Scheduler will schedule pods in a way

+

which abides by the constraints. All topologySpreadConstraints are ANDed.

+

volumes

+

Array of io.cci.otc.api.pkg.apis.versioned.cci.v2.Volume objects

+

List of volumes that can be mounted by containers belonging to the pod. More info: https://kubernetes.io/docs/concepts/storage/volumes

+
+
+ +
+ + + + + + + + + + + + + +
Table 152 io.cci.otc.api.pkg.apis.versioned.cci.v2.Affinity

Parameter

+

Type

+

Description

+

nodeAffinity

+

io.cci.otc.api.pkg.apis.versioned.cci.v2.NodeAffinity object

+

Describes node affinity scheduling rules for the pod.

+

podAntiAffinity

+

io.cci.otc.api.pkg.apis.versioned.cci.v2.PodAntiAffinity object

+

Describes pod anti-affinity scheduling rules (e.g. avoid putting

+

this pod in the same zone, etc. as some other pod(s)).

+
+
+ +
+ + + + + + + + + +
Table 153 io.cci.otc.api.pkg.apis.versioned.cci.v2.NodeAffinity

Parameter

+

Type

+

Description

+

requiredDuringSchedulingIgnoredDuringExecution

+

io.cci.otc.api.pkg.apis.versioned.cci.v2.NodeSelector object

+

If the affinity requirements specified by this field are not

+

met at scheduling time, the pod will not be scheduled onto the node. If

+

the affinity requirements specified by this field cease to be met at some

+

point during pod execution (e.g. due to an update), the system may or may

+

not try to eventually evict the pod from its node.

+
+
+ +
+ + + + + + + + + +
Table 154 io.cci.otc.api.pkg.apis.versioned.cci.v2.NodeSelector

Parameter

+

Type

+

Description

+

nodeSelectorTerms

+

Array of io.cci.otc.api.pkg.apis.versioned.cci.v2.NodeSelectorTerm objects

+

Required. A list of node selector terms. The terms are ORed.

+
+
+ +
+ + + + + + + + + +
Table 155 io.cci.otc.api.pkg.apis.versioned.cci.v2.NodeSelectorTerm

Parameter

+

Type

+

Description

+

matchExpressions

+

Array of io.cci.otc.api.pkg.apis.versioned.cci.v2.NodeSelectorRequirement objects

+

A list of node selector requirements by node's labels.

+
+
+ +
+ + + + + + + + + + + + + + + + + +
Table 156 io.cci.otc.api.pkg.apis.versioned.cci.v2.NodeSelectorRequirement

Parameter

+

Type

+

Description

+

key

+

String

+

The label key that the selector applies to.

+

operator

+

String

+

Represents a key's relationship to a set of values. Valid operators are In, NotIn, Exists, DoesNotExist. Gt, and Lt.

+

Possible enum values:

+
  • "DoesNotExist"
  • "Exists"
  • "Gt"
  • "In"
  • "Lt"
  • "NotIn"
+

values

+

Array of strings

+

An array of string values. If the operator is In or NotIn, the

+

values array must be non-empty. If the operator is Exists or DoesNotExist,

+

the values array must be empty. If the operator is Gt or Lt, the values

+

array must have a single element, which will be interpreted as an integer.

+

This array is replaced during a strategic merge patch.

+
+
+ +
+ + + + + + + + + + + + + +
Table 157 io.cci.otc.api.pkg.apis.versioned.cci.v2.PodAntiAffinity

Parameter

+

Type

+

Description

+

preferredDuringSchedulingIgnoredDuringExecution

+

Array of io.cci.otc.api.pkg.apis.versioned.cci.v2.WeightedPodAffinityTerm objects

+

The scheduler will prefer to schedule pods to nodes that satisfy

+

the anti-affinity expressions specified by this field, but it may choose

+

a node that violates one or more of the expressions. The node that is most

+

preferred is the one with the greatest sum of weights, i.e. for each node

+

that meets all of the scheduling requirements (resource request, requiredDuringScheduling

+

anti-affinity expressions, etc.), compute a sum by iterating through the

+

elements of this field and adding "weight" to the sum if the node has pods

+

which matches the corresponding podAffinityTerm; the node(s) with the highest

+

sum are the most preferred.

+

requiredDuringSchedulingIgnoredDuringExecution

+

Array of io.cci.otc.api.pkg.apis.versioned.cci.v2.PodAffinityTerm objects

+

If the anti-affinity requirements specified by this field are

+

not met at scheduling time, the pod will not be scheduled onto the node.

+

If the anti-affinity requirements specified by this field cease to be met

+

at some point during pod execution (e.g. due to a pod label update), the

+

system may or may not try to eventually evict the pod from its node. When

+

there are multiple elements, the lists of nodes corresponding to each podAffinityTerm

+

are intersected, i.e. all terms must be satisfied.

+
+
+ +
+ + + + + + + + + + + + + +
Table 158 io.cci.otc.api.pkg.apis.versioned.cci.v2.WeightedPodAffinityTerm

Parameter

+

Type

+

Description

+

podAffinityTerm

+

io.cci.otc.api.pkg.apis.versioned.cci.v2.PodAffinityTerm object

+

Required. A pod affinity term, associated with the corresponding

+

weight.

+

weight

+

Integer

+

weight associated with matching the corresponding podAffinityTerm,

+

in the range 1-100.

+
+
+ +
+ + + + + + + + + + + + + + + + + +
Table 159 io.cci.otc.api.pkg.apis.versioned.cci.v2.PodAffinityTerm

Parameter

+

Type

+

Description

+

labelSelector

+

io.k8s.apimachinery.pkg.apis.meta.v1.LabelSelector object

+

A label query over a set of resources, in this case pods.

+

namespaces

+

Array of strings

+

namespaces specifies a static list of namespace names that the

+

term applies to. The term is applied to the union of the namespaces listed

+

in this field and the ones selected by namespaceSelector. null or empty

+

namespaces list and null namespaceSelector means "this pod's namespace".

+

topologyKey

+

String

+

This pod should be co-located (affinity) or not co-located (anti-affinity)

+

with the pods matching the labelSelector in the specified namespaces, where

+

co-located is defined as running on a node whose value of the label with

+

key topologyKey matches that of any node on which any of the selected pods

+

is running. Empty topologyKey is not allowed.

+
+
+ +
+ + + + + + + + + + + + + + + + + +
Table 160 io.cci.otc.api.pkg.apis.versioned.cci.v2.PodDNSConfig

Parameter

+

Type

+

Description

+

nameservers

+

Array of strings

+

A list of DNS name server IP addresses. This will be appended

+

to the base nameservers generated from DNSPolicy. Duplicated nameservers

+

will be removed.

+

options

+

Array of io.cci.otc.api.pkg.apis.versioned.cci.v2.PodDNSConfigOption objects

+

A list of DNS resolver options. This will be merged with the

+

base options generated from DNSPolicy. Duplicated entries will be removed.

+

Resolution options given in Options will override those that appear in the

+

base DNSPolicy.

+

searches

+

Array of strings

+

A list of DNS search domains for host-name lookup. This will

+

be appended to the base search paths generated from DNSPolicy. Duplicated

+

search paths will be removed.

+
+
+ +
+ + + + + + + + + + + + + +
Table 161 io.cci.otc.api.pkg.apis.versioned.cci.v2.PodDNSConfigOption

Parameter

+

Type

+

Description

+

name

+

String

+

Required.

+

value

+

String

+		  
+
+ +
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Table 162 io.cci.otc.api.pkg.apis.versioned.cci.v2.EphemeralContainer

Parameter

+

Type

+

Description

+

args

+

Array of strings

+

Arguments to the entrypoint. The image's CMD is used if this is not provided. Variable references $(VAR_NAME) are expanded using the container's environment. If a variable cannot be resolved, the reference in the input string will be unchanged. Double $$ are reduced to a single $, which allows for escaping the $(VAR_NAME) syntax: i.e. "$$(VAR_NAME)" will produce the string literal "$(VAR_NAME)". Escaped references will never be expanded, regardless of whether the variable exists or not. Cannot be updated. More info: https://kubernetes.io/docs/tasks/inject-data-application/define-command-argument-container/#running-a-command-in-a-shell

+

command

+

Array of strings

+

Entrypoint array. Not executed within a shell. The image's ENTRYPOINT is used if this is not provided. Variable references $(VAR_NAME) are expanded using the container's environment. If a variable cannot be resolved, the reference in the input string will be unchanged. Double $$ are reduced to a single $, which allows for escaping the $(VAR_NAME) syntax: i.e. "$$(VAR_NAME)" will produce the string literal "$(VAR_NAME)". Escaped references will never be expanded, regardless of whether the variable exists or not. Cannot be updated. More info: https://kubernetes.io/docs/tasks/inject-data-application/define-command-argument-container/#running-a-command-in-a-shell

+

env

+

Array of io.cci.otc.api.pkg.apis.versioned.cci.v2.EnvVar objects

+

List of environment variables to set in the container. Cannot

+

be updated.

+

envFrom

+

Array of io.cci.otc.api.pkg.apis.versioned.cci.v2.EnvFromSource objects

+

List of sources to populate environment variables in the container.

+

The keys defined within a source must be a C_IDENTIFIER. All invalid keys

+

will be reported as an event when the container is starting. When a key

+

exists in multiple sources, the value associated with the last source will

+

take precedence. Values defined by an Env with a duplicate key will take

+

precedence. Cannot be updated.

+

image

+

String

+

Container image name. More info: https://kubernetes.io/docs/concepts/containers/images

+

lifecycle

+

io.cci.otc.api.pkg.apis.versioned.cci.v2.Lifecycle object

+

Lifecycle is not allowed for ephemeral containers.

+

livenessProbe

+

io.cci.otc.api.pkg.apis.versioned.cci.v2.Probe object

+

Probes are not allowed for ephemeral containers.

+

name

+

String

+

Name of the ephemeral container specified as a DNS_LABEL. This

+

name must be unique among all containers, init containers and ephemeral

+

containers.

+

ports

+

Array of io.cci.otc.api.pkg.apis.versioned.cci.v2.ContainerPort objects

+

Ports are not allowed for ephemeral containers.

+

readinessProbe

+

io.cci.otc.api.pkg.apis.versioned.cci.v2.Probe object

+

Probes are not allowed for ephemeral containers.

+

resources

+

io.cci.otc.api.pkg.apis.versioned.cci.v2.ResourceRequirements object

+

Resources are not allowed for ephemeral containers. Ephemeral

+

containers use spare resources already allocated to the pod.

+

securityContext

+

io.cci.otc.api.pkg.apis.versioned.cci.v2.SecurityContext object

+

Optional: SecurityContext defines the security options the ephemeral container should be run with. If set, the fields of SecurityContext override the equivalent fields of PodSecurityContext.

+

startupProbe

+

io.cci.otc.api.pkg.apis.versioned.cci.v2.Probe object

+

Probes are not allowed for ephemeral containers.

+

stdin

+

Boolean

+

Whether this container should allocate a buffer for stdin in

+

the container runtime. If this is not set, reads from stdin in the container

+

will always result in EOF. Default is false.

+

stdinOnce

+

Boolean

+

Whether the container runtime should close the stdin channel

+

after it has been opened by a single attach. When stdin is true the stdin

+

stream will remain open across multiple attach sessions. If stdinOnce is

+

set to true, stdin is opened on container start, is empty until the first

+

client attaches to stdin, and then remains open and accepts data until the

+

client disconnects, at which time stdin is closed and remains closed until

+

the container is restarted. If this flag is false, a container processes

+

that reads from stdin will never receive an EOF. Default is false

+

targetContainerName

+

String

+

If set, the name of the container from PodSpec that this ephemeral container targets. The ephemeral container will be run in the namespaces (IPC, PID, etc) of this container. If not set then the ephemeral container uses the namespaces configured in the Pod spec.

+

The container runtime must implement support for this feature. If the runtime does not support namespace targeting then the result of setting this field is undefined.

+

terminationMessagePath

+

String

+

Optional: Path at which the file to which the container's termination message will be written is mounted into the container's filesystem. Message written is intended to be brief final status, such as an assertion failure message. Will be truncated by the node if greater than 4096 bytes. The total message length across all containers will be limited to 12kb. Defaults to /dev/termination-log. Cannot be updated.

+

terminationMessagePolicy

+

String

+

Indicate how the termination message should be populated. File will use the contents of terminationMessagePath to populate the container status message on both success and failure. FallbackToLogsOnError will use the last chunk of container log output if the termination message file is empty and the container exited with an error. The log output is limited to 2048 bytes or 80 lines, whichever is smaller. Defaults to File. Cannot be updated.

+

Possible enum values:

+
  • "FallbackToLogsOnError" will read the most recent contents of the container logs for the container status message when the container exits with an error and the terminationMessagePath has no contents.
  • "File" is the default behavior and will set the container status message to the contents of the container's terminationMessagePath when the container exits.
+

tty

+

Boolean

+

Whether this container should allocate a TTY for itself, also

+

requires 'stdin' to be true. Default is false.

+

volumeMounts

+

Array of io.cci.otc.api.pkg.apis.versioned.cci.v2.VolumeMount objects

+

Pod volumes to mount into the container's filesystem. Subpath

+

mounts are not allowed for ephemeral containers. Cannot be updated.

+

workingDir

+

String

+

Container's working directory. If not specified, the container

+

runtime's default will be used, which might be configured in the container

+

image. Cannot be updated.

+
+
+ +
+ + + + + + + + + + + + + +
Table 163 io.cci.otc.api.pkg.apis.versioned.cci.v2.HostAlias

Parameter

+

Type

+

Description

+

hostnames

+

Array of strings

+

Hostnames for the above IP address.

+

ip

+

String

+

IP address of the host file entry.

+
+
+ +
+ + + + + + + + + +
Table 164 io.cci.otc.api.pkg.apis.versioned.cci.v2.LocalObjectReference

Parameter

+

Type

+

Description

+

name

+

String

+

Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names

+
+
+ +
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Table 165 io.cci.otc.api.pkg.apis.versioned.cci.v2.Container

Parameter

+

Type

+

Description

+

args

+

Array of strings

+

Arguments to the entrypoint. The container image's CMD is used if this is not provided. Variable references $(VAR_NAME) are expanded using the container's environment. If a variable cannot be resolved, the reference in the input string will be unchanged. Double $$ are reduced to a single $, which allows for escaping the $(VAR_NAME) syntax: i.e. "$$(VAR_NAME)" will produce the string literal "$(VAR_NAME)". Escaped references will never be expanded, regardless of whether the variable exists or not. Cannot be updated. More info: https://kubernetes.io/docs/tasks/inject-data-application/define-command-argument-container/#running-a-command-in-a-shell

+

command

+

Array of strings

+

Entrypoint array. Not executed within a shell. The container image's ENTRYPOINT is used if this is not provided. Variable references $(VAR_NAME) are expanded using the container's environment. If a variable cannot be resolved, the reference in the input string will be unchanged. Double $$ are reduced to a single $, which allows for escaping the $(VAR_NAME) syntax: i.e. "$$(VAR_NAME)" will produce the string literal "$(VAR_NAME)". Escaped references will never be expanded, regardless of whether the variable exists or not. Cannot be updated. More info: https://kubernetes.io/docs/tasks/inject-data-application/define-command-argument-container/#running-a-command-in-a-shell

+

env

+

Array of io.cci.otc.api.pkg.apis.versioned.cci.v2.EnvVar objects

+

List of environment variables to set in the container. Cannot

+

be updated.

+

envFrom

+

Array of io.cci.otc.api.pkg.apis.versioned.cci.v2.EnvFromSource objects

+

List of sources to populate environment variables in the container.

+

The keys defined within a source must be a C_IDENTIFIER. All invalid keys

+

will be reported as an event when the container is starting. When a key

+

exists in multiple sources, the value associated with the last source will

+

take precedence. Values defined by an Env with a duplicate key will take

+

precedence. Cannot be updated.

+

image

+

String

+

Container image name. More info: https://kubernetes.io/docs/concepts/containers/images This field is optional to allow higher level config management to default or override container images in workload controllers like Deployments and StatefulSets.

+

lifecycle

+

io.cci.otc.api.pkg.apis.versioned.cci.v2.Lifecycle object

+

Actions that the management system should take in response to

+

container lifecycle events. Cannot be updated.

+

livenessProbe

+

io.cci.otc.api.pkg.apis.versioned.cci.v2.Probe object

+

Periodic probe of container liveness. Container will be restarted if the probe fails. Cannot be updated. More info: https://kubernetes.io/docs/concepts/workloads/pods/pod-lifecycle#container-probes

+

name

+

String

+

Name of the container specified as a DNS_LABEL. Each container

+

in a pod must have a unique name (DNS_LABEL). Cannot be updated.

+

ports

+

Array of io.cci.otc.api.pkg.apis.versioned.cci.v2.ContainerPort objects

+

List of ports to expose from the container. Not specifying a

+

port here DOES NOT prevent that port from being exposed. Any port which

+

is listening on the default "0.0.0.0" address inside a container will be

+

accessible from the network. Modifying this array with strategic merge patch

+

may corrupt the data. For more information See https://github.com/kubernetes/kubernetes/issues/108255.

+

Cannot be updated.

+

readinessProbe

+

io.cci.otc.api.pkg.apis.versioned.cci.v2.Probe object

+

Periodic probe of container service readiness. Container will be removed from service endpoints if the probe fails. Cannot be updated. More info: https://kubernetes.io/docs/concepts/workloads/pods/pod-lifecycle#container-probes

+

resources

+

io.cci.otc.api.pkg.apis.versioned.cci.v2.ResourceRequirements object

+

Compute Resources required by this container. Cannot be updated. More info: https://kubernetes.io/docs/concepts/configuration/manage-resources-containers/

+

securityContext

+

io.cci.otc.api.pkg.apis.versioned.cci.v2.SecurityContext object

+

SecurityContext defines the security options the container should be run with. If set, the fields of SecurityContext override the equivalent fields of PodSecurityContext. More info: https://kubernetes.io/docs/tasks/configure-pod-container/security-context/

+

startupProbe

+

io.cci.otc.api.pkg.apis.versioned.cci.v2.Probe object

+

StartupProbe indicates that the Pod has successfully initialized. If specified, no other probes are executed until this completes successfully. If this probe fails, the Pod will be restarted, just as if the livenessProbe failed. This can be used to provide different probe parameters at the beginning of a Pod's lifecycle, when it might take a long time to load data or warm a cache, than during steady-state operation. This cannot be updated. More info: https://kubernetes.io/docs/concepts/workloads/pods/pod-lifecycle#container-probes

+

stdin

+

Boolean

+

Whether this container should allocate a buffer for stdin in

+

the container runtime. If this is not set, reads from stdin in the container

+

will always result in EOF. Default is false.

+

stdinOnce

+

Boolean

+

Whether the container runtime should close the stdin channel

+

after it has been opened by a single attach. When stdin is true the stdin

+

stream will remain open across multiple attach sessions. If stdinOnce is

+

set to true, stdin is opened on container start, is empty until the first

+

client attaches to stdin, and then remains open and accepts data until the

+

client disconnects, at which time stdin is closed and remains closed until

+

the container is restarted. If this flag is false, a container processes

+

that reads from stdin will never receive an EOF. Default is false

+

terminationMessagePath

+

String

+

Optional: Path at which the file to which the container's termination message will be written is mounted into the container's filesystem. Message written is intended to be brief final status, such as an assertion failure message. Will be truncated by the node if greater than 4096 bytes. The total message length across all containers will be limited to 12kb. Defaults to /dev/termination-log. Cannot be updated.

+

terminationMessagePolicy

+

String

+

Indicate how the termination message should be populated. File will use the contents of terminationMessagePath to populate the container status message on both success and failure. FallbackToLogsOnError will use the last chunk of container log output if the termination message file is empty and the container exited with an error. The log output is limited to 2048 bytes or 80 lines, whichever is smaller. Defaults to File. Cannot be updated.

+

Possible enum values:

+
  • "FallbackToLogsOnError" will read the most recent contents of the container logs for the container status message when the container exits with an error and the terminationMessagePath has no contents.
  • "File" is the default behavior and will set the container status message to the contents of the container's terminationMessagePath when the container exits.
+

tty

+

Boolean

+

Whether this container should allocate a TTY for itself, also

+

requires 'stdin' to be true. Default is false.

+

volumeMounts

+

Array of io.cci.otc.api.pkg.apis.versioned.cci.v2.VolumeMount objects

+

Pod volumes to mount into the container's filesystem. Cannot

+

be updated.

+

workingDir

+

String

+

Container's working directory. If not specified, the container

+

runtime's default will be used, which might be configured in the container

+

image. Cannot be updated.

+
+
+ +
+ + + + + + + + + + + + + + + + + +
Table 166 io.cci.otc.api.pkg.apis.versioned.cci.v2.EnvVar

Parameter

+

Type

+

Description

+

name

+

String

+

Name of the environment variable. Must be a C_IDENTIFIER.

+

value

+

String

+

Variable references $(VAR_NAME) are expanded using the previously defined environment variables in the container and any service environment variables. If a variable cannot be resolved, the reference in the input string will be unchanged. Double $$ are reduced to a single $, which allows for escaping the $(VAR_NAME) syntax: i.e. "$$(VAR_NAME)" will produce the string literal "$(VAR_NAME)". Escaped references will never be expanded, regardless of whether the variable exists or not. Defaults to "".

+

valueFrom

+

io.cci.otc.api.pkg.apis.versioned.cci.v2.EnvVarSource object

+

Source for the environment variable's value. Cannot be used if

+

value is not empty.

+
+
+ +
+ + + + + + + + + + + + + + + + + + + + + +
Table 167 io.cci.otc.api.pkg.apis.versioned.cci.v2.EnvVarSource

Parameter

+

Type

+

Description

+

configMapKeyRef

+

io.cci.otc.api.pkg.apis.versioned.cci.v2.ConfigMapKeySelector object

+

Selects a key of a ConfigMap.

+

fieldRef

+

io.cci.otc.api.pkg.apis.versioned.cci.v2.ObjectFieldSelector object

+

Selects a field of the pod: supports metadata.name, metadata.namespace, metadata.labels['<KEY>'], metadata.annotations['<KEY>'], spec.nodeName, spec.serviceAccountName, status.hostIP, status.podIP, status.podIPs.

+

resourceFieldRef

+

io.cci.otc.api.pkg.apis.versioned.cci.v2.ResourceFieldSelector object

+

Selects a resource of the container: only resources limits and requests (limits.cpu, limits.memory, limits.ephemeral-storage, requests.cpu, requests.memory and requests.ephemeral-storage) are currently supported.

+

secretKeyRef

+

io.cci.otc.api.pkg.apis.versioned.cci.v2.SecretKeySelector object

+

Selects a key of a secret in the pod's namespace

+
+
+ +
+ + + + + + + + + + + + + + + + + +
Table 168 io.cci.otc.api.pkg.apis.versioned.cci.v2.ConfigMapKeySelector

Parameter

+

Type

+

Description

+

key

+

String

+

The key to select.

+

name

+

String

+

Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names

+

optional

+

Boolean

+

Specify whether the ConfigMap or its key must be defined

+
+
+ +
+ + + + + + + + + + + + + + + + + +
Table 169 io.cci.otc.api.pkg.apis.versioned.cci.v2.SecretKeySelector

Parameter

+

Type

+

Description

+

key

+

String

+

The key of the secret to select from. Must be a valid secret

+

key.

+

name

+

String

+

Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names

+

optional

+

Boolean

+

Specify whether the Secret or its key must be defined

+
+
+ +
+ + + + + + + + + + + + + + + + + +
Table 170 io.cci.otc.api.pkg.apis.versioned.cci.v2.EnvFromSource

Parameter

+

Type

+

Description

+

configMapRef

+

io.cci.otc.api.pkg.apis.versioned.cci.v2.ConfigMapEnvSource object

+

The ConfigMap to select from

+

prefix

+

String

+

An optional identifier to prepend to each key in the ConfigMap.

+

Must be a C_IDENTIFIER.

+

secretRef

+

io.cci.otc.api.pkg.apis.versioned.cci.v2.SecretEnvSource object

+

The Secret to select from

+
+
+ +
+ + + + + + + + + + + + + +
Table 171 io.cci.otc.api.pkg.apis.versioned.cci.v2.ConfigMapEnvSource

Parameter

+

Type

+

Description

+

name

+

String

+

Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names

+

optional

+

Boolean

+

Specify whether the ConfigMap must be defined

+
+
+ +
+ + + + + + + + + + + + + +
Table 172 io.cci.otc.api.pkg.apis.versioned.cci.v2.SecretEnvSource

Parameter

+

Type

+

Description

+

name

+

String

+

Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names

+

optional

+

Boolean

+

Specify whether the Secret must be defined

+
+
+ +
+ + + + + + + + + + + + + +
Table 173 io.cci.otc.api.pkg.apis.versioned.cci.v2.Lifecycle

Parameter

+

Type

+

Description

+

postStart

+

io.cci.otc.api.pkg.apis.versioned.cci.v2.LifecycleHandler object

+

PostStart is called immediately after a container is created. If the handler fails, the container is terminated and restarted according to its restart policy. Other management of the container blocks until the hook completes. More info: https://kubernetes.io/docs/concepts/containers/container-lifecycle-hooks/#container-hooks

+

preStop

+

io.cci.otc.api.pkg.apis.versioned.cci.v2.LifecycleHandler object

+

PreStop is called immediately before a container is terminated due to an API request or management event such as liveness/startup probe failure, preemption, resource contention, etc. The handler is not called if the container crashes or exits. The Pod's termination grace period countdown begins before the PreStop hook is executed. Regardless of the outcome of the handler, the container will eventually terminate within the Pod's termination grace period (unless delayed by finalizers). Other management of the container blocks until the hook completes or until the termination grace period is reached. More info: https://kubernetes.io/docs/concepts/containers/container-lifecycle-hooks/#container-hooks

+
+
+ +
+ + + + + + + + + + + + + +
Table 174 io.cci.otc.api.pkg.apis.versioned.cci.v2.LifecycleHandler

Parameter

+

Type

+

Description

+

exec

+

io.cci.otc.api.pkg.apis.versioned.cci.v2.ExecAction object

+

Exec specifies the action to take.

+

httpGet

+

io.cci.otc.api.pkg.apis.versioned.cci.v2.HTTPGetAction object

+

HTTPGet specifies the http request to perform.

+
+
+ +
+ + + + + + + + + + + + + + + + + +
Table 175 io.cci.otc.api.pkg.apis.versioned.cci.v2.ContainerPort

Parameter

+

Type

+

Description

+

containerPort

+

Integer

+

Number of port to expose on the pod's IP address. This must be

+

a valid port number, 0 < x < 65536.

+

name

+

String

+

If specified, this must be an IANA_SVC_NAME and unique within

+

the pod. Each named port in a pod must have a unique name. Name for the

+

port that can be referred to by services.

+

protocol

+

String

+

Protocol for port. Must be UDP, TCP, or SCTP. Defaults to "TCP".

+

Possible enum values:

+
  • "SCTP" is the SCTP protocol.
  • "TCP" is the TCP protocol.
  • "UDP" is the UDP protocol.
+
+
+ +
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Table 176 io.cci.otc.api.pkg.apis.versioned.cci.v2.SecurityContext

Parameter

+

Type

+

Description

+

capabilities

+

io.cci.otc.api.pkg.apis.versioned.cci.v2.Capabilities object

+

The capabilities to add/drop when running containers. Defaults

+

to the default set of capabilities granted by the container runtime. Note

+

that this field cannot be set when spec.os.name is windows.

+

procMount

+

String

+

procMount denotes the type of proc mount to use for the containers.

+

The default is DefaultProcMount which uses the container runtime defaults

+

for readonly paths and masked paths. This requires the ProcMountType feature

+

flag to be enabled. Note that this field cannot be set when spec.os.name

+

is windows.

+

readOnlyRootFilesystem

+

Boolean

+

Whether this container has a read-only root filesystem. Default

+

is false. Note that this field cannot be set when spec.os.name is windows.

+

runAsGroup

+

Long

+

The GID to run the entrypoint of the container process. Uses

+

runtime default if unset. May also be set in PodSecurityContext. If set

+

in both SecurityContext and PodSecurityContext, the value specified in SecurityContext

+

takes precedence. Note that this field cannot be set when spec.os.name is

+

windows.

+

runAsNonRoot

+

Boolean

+

Indicates that the container must run as a non-root user. If

+

true, the Kubelet will validate the image at runtime to ensure that it does

+

not run as UID 0 (root) and fail to start the container if it does. If unset

+

or false, no such validation will be performed. May also be set in PodSecurityContext. If

+

set in both SecurityContext and PodSecurityContext, the value specified

+

in SecurityContext takes precedence.

+

runAsUser

+

Long

+

The UID to run the entrypoint of the container process. Defaults

+

to user specified in image metadata if unspecified. May also be set in PodSecurityContext. If

+

set in both SecurityContext and PodSecurityContext, the value specified

+

in SecurityContext takes precedence. Note that this field cannot be set

+

when spec.os.name is windows.

+
+
+ +
+ + + + + + + + + + + + + +
Table 177 io.cci.otc.api.pkg.apis.versioned.cci.v2.Capabilities

Parameter

+

Type

+

Description

+

add

+

Array of strings

+

Added capabilities

+

drop

+

Array of strings

+

Removed capabilities

+
+
+ +
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Table 178 io.cci.otc.api.pkg.apis.versioned.cci.v2.Probe

Parameter

+

Type

+

Description

+

exec

+

io.cci.otc.api.pkg.apis.versioned.cci.v2.ExecAction object

+

Exec specifies the action to take.

+

failureThreshold

+

Integer

+

Minimum consecutive failures for the probe to be considered failed

+

after having succeeded. Defaults to 3. Minimum value is 1.

+

httpGet

+

io.cci.otc.api.pkg.apis.versioned.cci.v2.HTTPGetAction object

+

HTTPGet specifies the http request to perform.

+

initialDelaySeconds

+

Integer

+

Number of seconds after the container has started before liveness probes are initiated. More info: https://kubernetes.io/docs/concepts/workloads/pods/pod-lifecycle#container-probes

+

periodSeconds

+

Integer

+

How often (in seconds) to perform the probe. Default to 10 seconds.

+

Minimum value is 1.

+

successThreshold

+

Integer

+

Minimum consecutive successes for the probe to be considered

+

successful after having failed. Defaults to 1. Must be 1 for liveness and

+

startup. Minimum value is 1.

+

tcpSocket

+

io.cci.otc.api.pkg.apis.versioned.cci.v2.TCPSocketAction object

+

TCPSocket specifies an action involving a TCP port.

+

terminationGracePeriodSeconds

+

Long

+

Optional duration in seconds the pod needs to terminate gracefully

+

upon probe failure. The grace period is the duration in seconds after the

+

processes running in the pod are sent a termination signal and the time

+

when the processes are forcibly halted with a kill signal. Set this value

+

longer than the expected cleanup time for your process. If this value is

+

nil, the pod's terminationGracePeriodSeconds will be used. Otherwise, this

+

value overrides the value provided by the pod spec. Value must be non-negative

+

integer. The value zero indicates stop immediately via the kill signal (no

+

opportunity to shut down). This is a beta field and requires enabling ProbeTerminationGracePeriod

+

feature gate. Minimum value is 1. spec.terminationGracePeriodSeconds is

+

used if unset.

+

timeoutSeconds

+

Integer

+

Number of seconds after which the probe times out. Defaults to 1 second. Minimum value is 1. More info: https://kubernetes.io/docs/concepts/workloads/pods/pod-lifecycle#container-probes

+
+
+ +
+ + + + + + + + + +
Table 179 io.cci.otc.api.pkg.apis.versioned.cci.v2.ExecAction

Parameter

+

Type

+

Description

+

command

+

Array of strings

+

Command is the command line to execute inside the container,

+

the working directory for the command is root ('/') in the container's

+

filesystem. The command is simply exec'd, it is not run inside a shell,

+

so traditional shell instructions ('|', etc) won't work. To use a shell,

+

you need to explicitly call out to that shell. Exit status of 0 is treated

+

as live/healthy and non-zero is unhealthy.

+
+
+ +
+ + + + + + + + + + + + + + + + + + + + + + + + + +
Table 180 io.cci.otc.api.pkg.apis.versioned.cci.v2.HTTPGetAction

Parameter

+

Type

+

Description

+

host

+

String

+

Host name to connect to, defaults to the pod IP. You probably

+

want to set "Host" in httpHeaders instead.

+

httpHeaders

+

Array of io.cci.otc.api.pkg.apis.versioned.cci.v2.HTTPHeader objects

+

Custom headers to set in the request. HTTP allows repeated headers.

+

path

+

String

+

Path to access on the HTTP server.

+

port

+

String

+

Name or number of the port to access on the container. Number

+

must be in the range 1 to 65535. Name must be an IANA_SVC_NAME.

+

scheme

+

String

+

Scheme to use for connecting to the host. Defaults to HTTP.

+

Possible enum values:

+
  • "HTTP" means that the scheme used will be http://
  • "HTTPS" means that the scheme used will be https://
+
+
+ +
+ + + + + + + + + + + + + +
Table 181 io.cci.otc.api.pkg.apis.versioned.cci.v2.HTTPHeader

Parameter

+

Type

+

Description

+

name

+

String

+

The header field name

+

value

+

String

+

The header field value

+
+
+ +
+ + + + + + + + + + + + + +
Table 182 io.cci.otc.api.pkg.apis.versioned.cci.v2.TCPSocketAction

Parameter

+

Type

+

Description

+

host

+

String

+

Optional: Host name to connect to, defaults to the pod IP.

+

port

+

String

+

Number or name of the port to access on the container. Number

+

must be in the range 1 to 65535. Name must be an IANA_SVC_NAME.

+
+
+ +
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Table 183 io.cci.otc.api.pkg.apis.versioned.cci.v2.VolumeMount

Parameter

+

Type

+

Description

+

extendPathMode

+

String

+

Extend the volume path by appending the pod metadata to the path

+

according to specified pattern. which provide a way of directory isolation

+

and help prevent the writing conflict between different pods.

+

mountPath

+

String

+

Path within the container at which the volume should be mounted. Must

+

not contain ':'.

+

name

+

String

+

This must match the Name of a Volume.

+

readOnly

+

Boolean

+

Mounted read-only if true, read-write otherwise (false or unspecified).

+

Defaults to false.

+

subPath

+

String

+

Path within the volume from which the container's volume should

+

be mounted. Defaults to "" (volume's root).

+

subPathExpr

+

String

+

Expanded path within the volume from which the container's volume

+

should be mounted. Behaves similarly to SubPath but environment variable

+

references $(VAR_NAME) are expanded using the container's environment. Defaults

+

to "" (volume's root). SubPathExpr and SubPath are mutually exclusive.

+
+
+ +
+ + + + + + + + + +
Table 184 io.cci.otc.api.pkg.apis.versioned.cci.v2.PodReadinessGate

Parameter

+

Type

+

Description

+

conditionType

+

String

+

ConditionType refers to a condition in the pod's condition list

+

with matching type.

+
+
+ +
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Table 185 io.cci.otc.api.pkg.apis.versioned.cci.v2.PodSecurityContext

Parameter

+

Type

+

Description

+

fsGroup

+

Long

+

A special supplemental group that applies to all containers in a pod. Some volume types allow the Kubelet to change the ownership of that volume to be owned by the pod:

+
  1. The owning GID will be the FSGroup 2. The setgid bit is set (new files created in the volume will be owned by FSGroup) 3. The permission bits are OR'd with rw-rw----
+

If unset, the Kubelet will not modify the ownership and permissions of any volume. Note that this field cannot be set when spec.os.name is windows.

+

fsGroupChangePolicy

+

String

+

fsGroupChangePolicy defines behavior of changing ownership and permission of the volume before being exposed inside Pod. This field will only apply to volume types which support fsGroup based ownership(and permissions). It will have no effect on ephemeral volume types such as: secret, configmaps and emptydir. Valid values are "OnRootMismatch" and "Always". If not specified, "Always" is used. Note that this field cannot be set when spec.os.name is windows.

+

runAsGroup

+

Long

+

The GID to run the entrypoint of the container process. Uses

+

runtime default if unset. May also be set in SecurityContext. If set in

+

both SecurityContext and PodSecurityContext, the value specified in SecurityContext

+

takes precedence for that container. Note that this field cannot be set

+

when spec.os.name is windows.

+

runAsNonRoot

+

Boolean

+

Indicates that the container must run as a non-root user. If

+

true, the Kubelet will validate the image at runtime to ensure that it does

+

not run as UID 0 (root) and fail to start the container if it does. If unset

+

or false, no such validation will be performed. May also be set in SecurityContext. If

+

set in both SecurityContext and PodSecurityContext, the value specified

+

in SecurityContext takes precedence.

+

runAsUser

+

Long

+

The UID to run the entrypoint of the container process. Defaults

+

to user specified in image metadata if unspecified. May also be set in SecurityContext. If

+

set in both SecurityContext and PodSecurityContext, the value specified

+

in SecurityContext takes precedence for that container. Note that this field

+

cannot be set when spec.os.name is windows.

+

supplementalGroups

+

Array of longs

+

A list of groups applied to the first process run in each container,

+

in addition to the container's primary GID. If unspecified, no groups will

+

be added to any container. Note that this field cannot be set when spec.os.name

+

is windows.

+

sysctls

+

Array of io.cci.otc.api.pkg.apis.versioned.cci.v2.Sysctl objects

+

Sysctls hold a list of namespaced sysctls used for the pod. Pods

+

with unsupported sysctls (by the container runtime) might fail to launch.

+

Note that this field cannot be set when spec.os.name is windows.

+
+
+ +
+ + + + + + + + + + + + + +
Table 186 io.cci.otc.api.pkg.apis.versioned.cci.v2.Sysctl

Parameter

+

Type

+

Description

+

name

+

String

+

Name of a property to set

+

value

+

String

+

Value of a property to set

+
+
+ +
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Table 187 io.cci.otc.api.pkg.apis.versioned.cci.v2.TopologySpreadConstraint

Parameter

+

Type

+

Description

+

labelSelector

+

io.k8s.apimachinery.pkg.apis.meta.v1.LabelSelector object

+

LabelSelector is used to find matching pods. Pods that match

+

this label selector are counted to determine the number of pods in their

+

corresponding topology domain.

+

matchLabelKeys

+

Array of strings

+

MatchLabelKeys is a set of pod label keys to select the pods

+

over which spreading will be calculated. The keys are used to lookup values

+

from the incoming pod labels, those key-value labels are ANDed with labelSelector

+

to select the group of existing pods over which spreading will be calculated

+

for the incoming pod. Keys that don't exist in the incoming pod labels will

+

be ignored. A null or empty list means only match against labelSelector.

+

maxSkew

+

Integer

+

MaxSkew describes the degree to which pods may be unevenly distributed. When whenUnsatisfiable=DoNotSchedule, it is the maximum permitted difference between the number of matching pods in the target topology and the global minimum. The global minimum is the minimum number of matching pods in an eligible domain or zero if the number of eligible domains is less than MinDomains. For example, in a 3-zone cluster, MaxSkew is set to 1, and pods with the same labelSelector spread as 2/2/1: In this case, the global minimum is 1. | zone1 | zone2 | zone3 | | P P | P P | P | - if MaxSkew is 1, incoming pod can only be scheduled to zone3 to become 2/2/2; scheduling it onto zone1(zone2) would make the ActualSkew(3-1) on zone1(zone2) violate MaxSkew(1). - if MaxSkew is 2, incoming pod can be scheduled onto any zone. When whenUnsatisfiable=ScheduleAnyway, it is used to give higher precedence to topologies that satisfy it. It's a required field. Default value is 1 and 0 is not allowed.

+

minDomains

+

Integer

+

MinDomains indicates a minimum number of eligible domains. When the number of eligible domains with matching topology keys is less than minDomains, Pod Topology Spread treats "global minimum" as 0, and then the calculation of Skew is performed. And when the number of eligible domains with matching topology keys equals or greater than minDomains, this value has no effect on scheduling. As a result, when the number of eligible domains is less than minDomains, scheduler won't schedule more than maxSkew Pods to those domains. If value is nil, the constraint behaves as if MinDomains is equal to 1. Valid values are integers greater than 0. When value is not nil, WhenUnsatisfiable must be DoNotSchedule.

+

For example, in a 3-zone cluster, MaxSkew is set to 2, MinDomains is set to 5 and pods with the same labelSelector spread as 2/2/2: | zone1 | zone2 | zone3 | | P P | P P | P P | The number of domains is less than 5(MinDomains), so "global minimum" is treated as 0. In this situation, new pod with the same labelSelector cannot be scheduled, because computed skew will be 3(3 - 0) if new Pod is scheduled to any of the three zones, it will violate MaxSkew.

+

This is a beta field and requires the MinDomainsInPodTopologySpread feature gate to be enabled (enabled by default).

+

nodeAffinityPolicy

+

String

+

NodeAffinityPolicy indicates how we will treat Pod's nodeAffinity/nodeSelector when calculating pod topology spread skew. Options are: - Honor: only nodes matching nodeAffinity/nodeSelector are included in the calculations. - Ignore: nodeAffinity/nodeSelector are ignored. All nodes are included in the calculations.

+

If this value is nil, the behavior is equivalent to the Honor policy. This is a alpha-level feature enabled by the NodeInclusionPolicyInPodTopologySpread feature flag.

+

nodeTaintsPolicy

+

String

+

NodeTaintsPolicy indicates how we will treat node taints when calculating pod topology spread skew. Options are: - Honor: nodes without taints, along with tainted nodes for which the incoming pod has a toleration, are included. - Ignore: node taints are ignored. All nodes are included.

+

If this value is nil, the behavior is equivalent to the Ignore policy. This is a alpha-level feature enabled by the NodeInclusionPolicyInPodTopologySpread feature flag.

+

topologyKey

+

String

+

TopologyKey is the key of node labels. Nodes that have a label

+

with this key and identical values are considered to be in the same topology.

+

We consider each <key, value> as a "bucket", and try to put balanced number

+

of pods into each bucket. We define a domain as a particular instance of

+

a topology. Also, we define an eligible domain as a domain whose nodes meet

+

the requirements of nodeAffinityPolicy and nodeTaintsPolicy. e.g. If TopologyKey

+

is "kubernetes.io/hostname", each Node is a domain of that topology. And,

+

if TopologyKey is "topology.kubernetes.io/zone", each zone is a domain of

+

that topology. It's a required field.

+

whenUnsatisfiable

+

String

+

WhenUnsatisfiable indicates how to deal with a pod if it doesn't satisfy the spread constraint. - DoNotSchedule (default) tells the scheduler not to schedule it. - ScheduleAnyway tells the scheduler to schedule the pod in any location,

+

but giving higher precedence to topologies that would help reduce the

+

skew.

+

A constraint is considered "Unsatisfiable" for an incoming pod if and only if every possible node assignment for that pod would violate "MaxSkew" on some topology. For example, in a 3-zone cluster, MaxSkew is set to 1, and pods with the same labelSelector spread as 3/1/1: | zone1 | zone2 | zone3 | | P P P | P | P | If WhenUnsatisfiable is set to DoNotSchedule, incoming pod can only be scheduled to zone2(zone3) to become 3/2/1(3/1/2) as ActualSkew(2-1) on zone2(zone3) satisfies MaxSkew(1). In other words, the cluster can still be imbalanced, but scheduler won't make it more imbalanced. It's a required field.

+

Possible enum values:

+
  • "DoNotSchedule" instructs the scheduler not to schedule the pod when constraints are not satisfied.
  • "ScheduleAnyway" instructs the scheduler to schedule the pod even if constraints are not satisfied.
+
+
+ +
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Table 188 io.cci.otc.api.pkg.apis.versioned.cci.v2.Volume

Parameter

+

Type

+

Description

+

configMap

+

io.cci.otc.api.pkg.apis.versioned.cci.v2.ConfigMapVolumeSource object

+

configMap represents a configMap that should populate this volume

+

downwardAPI

+

io.cci.otc.api.pkg.apis.versioned.cci.v2.DownwardAPIVolumeSource object

+

downwardAPI represents downward API about the pod that should

+

populate this volume

+

emptyDir

+

io.cci.otc.api.pkg.apis.versioned.cci.v2.EmptyDirVolumeSource object

+

emptyDir represents a temporary directory that shares a pod's lifetime. More info: https://kubernetes.io/docs/concepts/storage/volumes#emptydir

+

ephemeral

+

io.cci.otc.api.pkg.apis.versioned.cci.v2.EphemeralVolumeSource object

+

ephemeral represents a volume that is handled by a cluster storage driver. The volume's lifecycle is tied to the pod that defines it - it will be created before the pod starts, and deleted when the pod is removed.

+

Use this if: a) the volume is only needed while the pod runs, b) features of normal volumes like restoring from snapshot or capacity

+

tracking are needed,

+

c) the storage driver is specified through a storage class, and d) the storage driver supports dynamic volume provisioning through

+

a PersistentVolumeClaim (see EphemeralVolumeSource for more

+

information on the connection between this volume type

+

and PersistentVolumeClaim).

+

Use PersistentVolumeClaim or one of the vendor-specific APIs for volumes that persist for longer than the lifecycle of an individual pod.

+

Use CSI for light-weight local ephemeral volumes if the CSI driver is meant to be used that way - see the documentation of the driver for more information.

+

A pod can use both types of ephemeral volumes and persistent volumes at the same time.

+

name

+

String

+

name of the volume. Must be a DNS_LABEL and unique within the pod. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names

+

nfs

+

io.cci.otc.api.pkg.apis.versioned.cci.v2.NFSVolumeSource object

+

nfs represents an NFS mount on the host that shares a pod's lifetime More info: https://kubernetes.io/docs/concepts/storage/volumes#nfs

+

persistentVolumeClaim

+

io.cci.otc.api.pkg.apis.versioned.cci.v2.PersistentVolumeClaimVolumeSource object

+

persistentVolumeClaimVolumeSource represents a reference to a PersistentVolumeClaim in the same namespace. More info: https://kubernetes.io/docs/concepts/storage/persistent-volumes#persistentvolumeclaims

+

projected

+

io.cci.otc.api.pkg.apis.versioned.cci.v2.ProjectedVolumeSource object

+

projected items for all in one resources secrets, configmaps,

+

and downward API

+

secret

+

io.cci.otc.api.pkg.apis.versioned.cci.v2.SecretVolumeSource object

+

secret represents a secret that should populate this volume. More info: https://kubernetes.io/docs/concepts/storage/volumes#secret

+
+
+ +
+ + + + + + + + + + + + + + + + + + + + + +
Table 189 io.cci.otc.api.pkg.apis.versioned.cci.v2.ConfigMapVolumeSource

Parameter

+

Type

+

Description

+

defaultMode

+

Integer

+

defaultMode is optional: mode bits used to set permissions on created files by default. Must be an octal value between 0000 and 0777 or a decimal value between 0 and 511. YAML accepts both octal and decimal values, JSON requires decimal values for mode bits. Defaults to 0644. Directories within the path are not affected by this setting. This might be in conflict with other options that affect the file mode, like fsGroup, and the result can be other mode bits set.

+

items

+

Array of io.cci.otc.api.pkg.apis.versioned.cci.v2.KeyToPath objects

+

items if unspecified, each key-value pair in the Data field of

+

the referenced ConfigMap will be projected into the volume as a file whose

+

name is the key and content is the value. If specified, the listed keys

+

will be projected into the specified paths, and unlisted keys will not be

+

present. If a key is specified which is not present in the ConfigMap, the

+

volume setup will error unless it is marked optional. Paths must be relative

+

and may not contain the '..' path or start with '..'.

+

name

+

String

+

Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names

+

optional

+

Boolean

+

optional specify whether the ConfigMap or its keys must be defined

+
+
+ +
+ + + + + + + + + + + + + +
Table 190 io.cci.otc.api.pkg.apis.versioned.cci.v2.DownwardAPIVolumeSource

Parameter

+

Type

+

Description

+

defaultMode

+

Integer

+

Optional: mode bits to use on created files by default. Must be a Optional: mode bits used to set permissions on created files by default. Must be an octal value between 0000 and 0777 or a decimal value between 0 and 511. YAML accepts both octal and decimal values, JSON requires decimal values for mode bits. Defaults to 0644. Directories within the path are not affected by this setting. This might be in conflict with other options that affect the file mode, like fsGroup, and the result can be other mode bits set.

+

items

+

Array of io.cci.otc.api.pkg.apis.versioned.cci.v2.DownwardAPIVolumeFile objects

+

Items is a list of downward API volume file

+
+
+ +
+ + + + + + + + + + + + + +
Table 191 io.cci.otc.api.pkg.apis.versioned.cci.v2.EmptyDirVolumeSource

Parameter

+

Type

+

Description

+

medium

+

String

+

medium represents what type of storage medium should back this directory. The default is "" which means to use the node's default medium. Must be an empty string (default) or Memory. More info: https://kubernetes.io/docs/concepts/storage/volumes#emptydir

+

sizeLimit

+

String

+

sizeLimit is the total amount of local storage required for this EmptyDir volume. The size limit is also applicable for memory medium. The maximum usage on memory medium EmptyDir would be the minimum value between the SizeLimit specified here and the sum of memory limits of all containers in a pod. The default is nil which means that the limit is undefined. More info: http://kubernetes.io/docs/user-guide/volumes#emptydir

+
+
+ +
+ + + + + + + + + +
Table 192 io.cci.otc.api.pkg.apis.versioned.cci.v2.EphemeralVolumeSource

Parameter

+

Type

+

Description

+

volumeClaimTemplate

+

io.cci.otc.api.pkg.apis.versioned.cci.v2.PersistentVolumeClaimTemplate object

+

Will be used to create a stand-alone PVC to provision the volume. The pod in which this EphemeralVolumeSource is embedded will be the owner of the PVC, i.e. the PVC will be deleted together with the pod. The name of the PVC will be <pod name>-<volume name> where <volume name> is the name from the PodSpec.Volumes array entry. Pod validation will reject the pod if the concatenated name is not valid for a PVC (for example, too long).

+

An existing PVC with that name that is not owned by the pod will not be used for the pod to avoid using an unrelated volume by mistake. Starting the pod is then blocked until the unrelated PVC is removed. If such a pre-created PVC is meant to be used by the pod, the PVC has to updated with an owner reference to the pod once the pod exists. Normally this should not be necessary, but it may be useful when manually reconstructing a broken cluster.

+

This field is read-only and no changes will be made by Kubernetes to the PVC after it has been created.

+

Required, must not be nil.

+
+
+ +
+ + + + + + + + + + + + + +
Table 193 io.cci.otc.api.pkg.apis.versioned.cci.v2.PersistentVolumeClaimTemplate

Parameter

+

Type

+

Description

+

metadata

+

io.k8s.apimachinery.pkg.apis.meta.v1.ObjectMeta object

+

May contain labels and annotations that will be copied into the

+

PVC when creating it. No other fields are allowed and will be rejected during

+

validation.

+

spec

+

io.cci.otc.api.pkg.apis.versioned.cci.v2.PersistentVolumeClaimSpec object

+

The specification for the PersistentVolumeClaim. The entire content

+

is copied unchanged into the PVC that gets created from this template. The

+

same fields as in a PersistentVolumeClaim are also valid here.

+
+
+ +
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Table 194 io.k8s.apimachinery.pkg.apis.meta.v1.ObjectMeta

Parameter

+

Type

+

Description

+

annotations

+

Map<String,String>

+

Annotations is an unstructured key value map stored with a resource that may be set by external tools to store and retrieve arbitrary metadata. They are not queryable and should be preserved when modifying objects. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/annotations/

+

clusterName

+

String

+

The name of the cluster which the object belongs to. This is

+

used to distinguish resources with same name and namespace in different

+

clusters. This field is not set anywhere right now and apiserver is going

+

to ignore it if set in create or update request.

+

creationTimestamp

+

String

+

CreationTimestamp is a timestamp representing the server time when this object was created. It is not guaranteed to be set in happens-before order across separate operations. Clients may not set this value. It is represented in RFC3339 form and is in UTC.

+

Populated by the system. Read-only. Null for lists. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata

+

deletionGracePeriodSeconds

+

Long

+

Number of seconds allowed for this object to gracefully terminate

+

before it will be removed from the system. Only set when deletionTimestamp

+

is also set. May only be shortened. Read-only.

+

deletionTimestamp

+

String

+

DeletionTimestamp is RFC 3339 date and time at which this resource will be deleted. This field is set by the server when a graceful deletion is requested by the user, and is not directly settable by a client. The resource is expected to be deleted (no longer visible from resource lists, and not reachable by name) after the time in this field, once the finalizers list is empty. As long as the finalizers list contains items, deletion is blocked. Once the deletionTimestamp is set, this value may not be unset or be set further into the future, although it may be shortened or the resource may be deleted prior to this time. For example, a user may request that a pod is deleted in 30 seconds. The Kubelet will react by sending a graceful termination signal to the containers in the pod. After that 30 seconds, the Kubelet will send a hard termination signal (SIGKILL) to the container and after cleanup, remove the pod from the API. In the presence of network partitions, this object may still exist after this timestamp, until an administrator or automated process can determine the resource is fully terminated. If not set, graceful deletion of the object has not been requested.

+

Populated by the system when a graceful deletion is requested. Read-only. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata

+

enable

+

Boolean

+

Enable identifies whether the resource is available

+

finalizers

+

Array of strings

+

Must be empty before the object is deleted from the registry.

+

Each entry is an identifier for the responsible component that will remove

+

the entry from the list. If the deletionTimestamp of the object is non-nil,

+

entries in this list can only be removed. Finalizers may be processed and

+

removed in any order. Order is NOT enforced because it introduces significant

+

risk of stuck finalizers. finalizers is a shared field, any actor with permission

+

can reorder it. If the finalizer list is processed in order, then this can

+

lead to a situation in which the component responsible for the first finalizer

+

in the list is waiting for a signal (field value, external system, or other)

+

produced by a component responsible for a finalizer later in the list, resulting

+

in a deadlock. Without enforced ordering finalizers are free to order amongst

+

themselves and are not vulnerable to ordering changes in the list.

+

generateName

+

String

+

GenerateName is an optional prefix, used by the server, to generate a unique name ONLY IF the Name field has not been provided. If this field is used, the name returned to the client will be different than the name passed. This value will also be combined with a unique suffix. The provided value has the same validation rules as the Name field, and may be truncated by the length of the suffix required to make the value unique on the server.

+

If this field is specified and the generated name exists, the server will NOT return a 409 - instead, it will either return 201 Created or 500 with Reason ServerTimeout indicating a unique name could not be found in the time allotted, and the client should retry (optionally after the time indicated in the Retry-After header).

+

Applied only if Name is not specified. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#idempotency

+

generation

+

Long

+

A sequence number representing a specific generation of the desired

+

state. Populated by the system. Read-only.

+

labels

+

Map<String,String>

+

Map of string keys and values that can be used to organize and categorize (scope and select) objects. May match selectors of replication controllers and services. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/labels/

+

managedFields

+

Array of io.k8s.apimachinery.pkg.apis.meta.v1.ManagedFieldsEntry objects

+

ManagedFields maps workflow-id and version to the set of fields

+

that are managed by that workflow. This is mostly for internal housekeeping,

+

and users typically shouldn't need to set or understand this field. A workflow

+

can be the user's name, a controller's name, or the name of a specific apply

+

path like "ci-cd". The set of fields is always in the version that the workflow

+

used when modifying the object.

+

name

+

String

+

Name must be unique within a namespace. Is required when creating resources, although some resources may allow a client to request the generation of an appropriate name automatically. Name is primarily intended for creation idempotence and configuration definition. Cannot be updated. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names

+

namespace

+

String

+

Namespace defines the space within which each name must be unique. An empty namespace is equivalent to the "default" namespace, but "default" is the canonical representation. Not all objects are required to be scoped to a namespace - the value of this field for those objects will be empty.

+

Must be a DNS_LABEL. Cannot be updated. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/namespaces/

+

ownerReferences

+

Array of io.k8s.apimachinery.pkg.apis.meta.v1.OwnerReference objects

+

List of objects depended by this object. If ALL objects in the

+

list have been deleted, this object will be garbage collected. If this object

+

is managed by a controller, then an entry in this list will point to this

+

controller, with the controller field set to true. There cannot be more

+

than one managing controller.

+

resourceVersion

+

String

+

An opaque value that represents the internal version of this object that can be used by clients to determine when objects have changed. May be used for optimistic concurrency, change detection, and the watch operation on a resource or set of resources. Clients must treat these values as opaque and passed unmodified back to the server. They may only be valid for a particular resource or set of resources.

+

Populated by the system. Read-only. Value must be treated as opaque by clients and . More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#concurrency-control-and-consistency

+

selfLink

+

String

+

SelfLink is a URL representing this object. Populated by the system. Read-only.

+

DEPRECATED Kubernetes will stop propagating this field in 1.20 release and the field is planned to be removed in 1.21 release.

+

uid

+

String

+

UID is the unique in time and space value for this object. It is typically generated by the server on successful creation of a resource and is not allowed to change on PUT operations.

+

Populated by the system. Read-only. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#uids

+
+
+ +
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Table 195 io.k8s.apimachinery.pkg.apis.meta.v1.ManagedFieldsEntry

Parameter

+

Type

+

Description

+

apiVersion

+

String

+

APIVersion defines the version of this resource that this field

+

set applies to. The format is "group/version" just like the top-level APIVersion

+

field. It is necessary to track the version of a field set because it cannot

+

be automatically converted.

+

fieldsType

+

String

+

FieldsType is the discriminator for the different fields format and version. There is currently only one possible value: "FieldsV1"

+

fieldsV1

+

Object

+

FieldsV1 holds the first JSON version format as described in

+

the "FieldsV1" type.

+

manager

+

String

+

Manager is an identifier of the workflow managing these fields.

+

operation

+

String

+

Operation is the type of operation which lead to this ManagedFieldsEntry

+

being created. The only valid values for this field are 'Apply' and 'Update'.

+

time

+

String

+

Time is timestamp of when these fields were set. It should always

+

be empty if Operation is 'Apply'

+
+
+ +
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Table 196 io.k8s.apimachinery.pkg.apis.meta.v1.OwnerReference

Parameter

+

Type

+

Description

+

apiVersion

+

String

+

API version of the referent.

+

blockOwnerDeletion

+

Boolean

+

If true, AND if the owner has the "foregroundDeletion" finalizer,

+

then the owner cannot be deleted from the key-value store until this reference

+

is removed. Defaults to false. To set this field, a user needs "delete"

+

permission of the owner, otherwise 422 (Unprocessable Entity) will be returned.

+

controller

+

Boolean

+

If true, this reference points to the managing controller.

+

kind

+

String

+

Kind of the referent. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds

+

name

+

String

+

Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names

+

uid

+

String

+

UID of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#uids

+
+
+ +
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Table 197 io.cci.otc.api.pkg.apis.versioned.cci.v2.PersistentVolumeClaimSpec

Parameter

+

Type

+

Description

+

accessModes

+

Array of strings

+

accessModes contains the desired access modes the volume should have. More info: https://kubernetes.io/docs/concepts/storage/persistent-volumes#access-modes-1

+

dataSource

+

io.cci.otc.api.pkg.apis.versioned.cci.v2.TypedLocalObjectReference object

+

dataSource field can be used to specify either: * An existing VolumeSnapshot object (snapshot.storage.k8s.io/VolumeSnapshot) * An existing PVC (PersistentVolumeClaim) If the provisioner or an external controller can support the specified data source, it will create a new volume based on the contents of the specified data source. If the AnyVolumeDataSource feature gate is enabled, this field will always have the same contents as the DataSourceRef field.

+

dataSourceRef

+

io.cci.otc.api.pkg.apis.versioned.cci.v2.TypedLocalObjectReference object

+

dataSourceRef specifies the object from which to populate the volume with data, if a non-empty volume is desired. This may be any local object from a non-empty API group (non core object) or a PersistentVolumeClaim object. When this field is specified, volume binding will only succeed if the type of the specified object matches some installed volume populator or dynamic provisioner. This field will replace the functionality of the DataSource field and as such if both fields are non-empty, they must have the same value. For backwards compatibility, both fields (DataSource and DataSourceRef) will be set to the same value automatically if one of them is empty and the other is non-empty. There are two important differences between DataSource and DataSourceRef: * While DataSource only allows two specific types of objects, DataSourceRef

+

allows any non-core object, as well as PersistentVolumeClaim objects.

+
  • While DataSource ignores disallowed values (dropping them), DataSourceRef

    preserves all values, and generates an error if a disallowed value is

    +

    specified.

    +

    (Beta) Using this field requires the AnyVolumeDataSource feature gate to be enabled.

    +
+

resources

+

io.cci.otc.api.pkg.apis.versioned.cci.v2.ResourceRequirements object

+

resources represents the minimum resources the volume should have. If RecoverVolumeExpansionFailure feature is enabled users are allowed to specify resource requirements that are lower than previous value but must still be higher than capacity recorded in the status field of the claim. More info: https://kubernetes.io/docs/concepts/storage/persistent-volumes#resources

+

selector

+

io.k8s.apimachinery.pkg.apis.meta.v1.LabelSelector object

+

selector is a label query over volumes to consider for binding.

+

storageClassName

+

String

+

storageClassName is the name of the StorageClass required by the claim. More info: https://kubernetes.io/docs/concepts/storage/persistent-volumes#class-1

+

volumeMode

+

String

+

volumeMode defines what type of volume is required by the claim.

+

Value of Filesystem is implied when not included in claim spec.

+

volumeName

+

String

+

volumeName is the binding reference to the PersistentVolume backing

+

this claim.

+
+
+ +
+ + + + + + + + + + + + + + + + + +
Table 198 io.cci.otc.api.pkg.apis.versioned.cci.v2.TypedLocalObjectReference

Parameter

+

Type

+

Description

+

apiGroup

+

String

+

APIGroup is the group for the resource being referenced. If APIGroup

+

is not specified, the specified Kind must be in the core API group. For

+

any other third-party types, APIGroup is required.

+

kind

+

String

+

Kind is the type of resource being referenced

+

name

+

String

+

Name is the name of resource being referenced

+
+
+ +
+ + + + + + + + + + + + + +
Table 199 io.cci.otc.api.pkg.apis.versioned.cci.v2.ResourceRequirements

Parameter

+

Type

+

Description

+

limits

+

Map<String,String>

+

Limits describes the maximum amount of compute resources allowed. More info: https://kubernetes.io/docs/concepts/configuration/manage-resources-containers/

+

requests

+

Map<String,String>

+

Requests describes the minimum amount of compute resources required. If Requests is omitted for a container, it defaults to Limits if that is explicitly specified, otherwise to an implementation-defined value. More info: https://kubernetes.io/docs/concepts/configuration/manage-resources-containers/

+
+
+ +
+ + + + + + + + + +
Table 200 io.k8s.apimachinery.pkg.api.resource.Quantity

Parameter

+

Type

+

Description

+

-

+

String

+

Quantity is a fixed-point representation of a number. It provides convenient marshaling/unmarshaling in JSON and YAML, in addition to String() and AsInt64() accessors.

+

The serialization format is:

+

[/topic/body/section/table/tgroup/tbody/row/entry/p/br {""})(br] ::= [/topic/body/section/table/tgroup/tbody/row/entry/p/br {""})(br][/topic/body/section/table/tgroup/tbody/row/entry/p/br {""})(br]

+

(Note that [/topic/body/section/table/tgroup/tbody/row/entry/p/br {""})(br] may be empty, from the "" case in [/topic/body/section/table/tgroup/tbody/row/entry/p/br {""})(br].)

+

[/topic/body/section/table/tgroup/tbody/row/entry/p/br {""})(br] ::= 0 | 1 | ... | 9 [/topic/body/section/table/tgroup/tbody/row/entry/p/br {""})(br] ::= [/topic/body/section/table/tgroup/tbody/row/entry/p/br {""})(br] | [/topic/body/section/table/tgroup/tbody/row/entry/p/br {""})(br][/topic/body/section/table/tgroup/tbody/row/entry/p/br {""})(br][/topic/body/section/table/tgroup/tbody/row/entry/p/br {""})(br] ::= [/topic/body/section/table/tgroup/tbody/row/entry/p/br {""})(br] | [/topic/body/section/table/tgroup/tbody/row/entry/p/br {""})(br].[/topic/body/section/table/tgroup/tbody/row/entry/p/br {""})(br] | [/topic/body/section/table/tgroup/tbody/row/entry/p/br {""})(br]. | .[/topic/body/section/table/tgroup/tbody/row/entry/p/br {""})(br][/topic/body/section/table/tgroup/tbody/row/entry/p/br {""})(br] ::= "+" | "-" [/topic/body/section/table/tgroup/tbody/row/entry/p/br {""})(br] ::= [/topic/body/section/table/tgroup/tbody/row/entry/p/br {""})(br] | [/topic/body/section/table/tgroup/tbody/row/entry/p/br {""})(br][/topic/body/section/table/tgroup/tbody/row/entry/p/br {""})(br][/topic/body/section/table/tgroup/tbody/row/entry/p/br {""})(br] ::= [/topic/body/section/table/tgroup/tbody/row/entry/p/br {""})(br] | [/topic/body/section/table/tgroup/tbody/row/entry/p/br {""})(br] | [/topic/body/section/table/tgroup/tbody/row/entry/p/br {""})(br][/topic/body/section/table/tgroup/tbody/row/entry/p/br {""})(br] ::= Ki | Mi | Gi | Ti | Pi | Ei

+

(International System of units; See: http://physics.nist.gov/cuu/Units/binary.html)

+

[/topic/body/section/table/tgroup/tbody/row/entry/p/br {""})(br] ::= m | "" | k | M | G | T | P | E

+

(Note that 1024 = 1Ki but 1000 = 1k; I didn't choose the capitalization.)

+

[/topic/body/section/table/tgroup/tbody/row/entry/p/br {""})(br] ::= "e" [/topic/body/section/table/tgroup/tbody/row/entry/p/br {""})(br] | "E" [/topic/body/section/table/tgroup/tbody/row/entry/p/br {""})(br]

+

No matter which of the three exponent forms is used, no quantity may represent a number greater than 2^63-1 in magnitude, nor may it have more than 3 decimal places. Numbers larger or more precise will be capped or rounded up. (E.g.: 0.1m will rounded up to 1m.) This may be extended in the future if we require larger or smaller quantities.

+

When a Quantity is parsed from a string, it will remember the type of suffix it had, and will use the same type again when it is serialized.

+

Before serializing, Quantity will be put in "canonical form". This means that Exponent/suffix will be adjusted up or down (with a corresponding increase or decrease in Mantissa) such that:

+

a. No precision is lost

+

b. No fractional digits will be emitted

+

c. The exponent (or suffix) is as large as possible.

+

The sign will be omitted unless the number is negative.

+

Examples:

+

1.5 will be serialized as "1500m"

+

1.5Gi will be serialized as "1536Mi"

+

Note that the quantity will NEVER be internally represented by a floating point number. That is the whole point of this exercise.

+

Non-canonical values will still parse as long as they are well formed, but will be re-emitted in their canonical form. (So always use canonical form, or don't diff.)

+

This format is intended to make it difficult to use these numbers without writing some sort of special handling code in the hopes that that will cause implementors to also use a fixed point implementation.

+
+
+ +
+ + + + + + + + + + + + + +
Table 201 io.k8s.apimachinery.pkg.apis.meta.v1.LabelSelector

Parameter

+

Type

+

Description

+

matchExpressions

+

Array of io.k8s.apimachinery.pkg.apis.meta.v1.LabelSelectorRequirement objects

+

matchExpressions is a list of label selector requirements. The

+

requirements are ANDed.

+

matchLabels

+

Map<String,String>

+

matchLabels is a map of {key,value} pairs. A single {key,value}

+

in the matchLabels map is equivalent to an element of matchExpressions,

+

whose key field is "key", the operator is "In", and the values array contains

+

only "value". The requirements are ANDed.

+
+
+ +
+ + + + + + + + + + + + + + + + + +
Table 202 io.k8s.apimachinery.pkg.apis.meta.v1.LabelSelectorRequirement

Parameter

+

Type

+

Description

+

key

+

String

+

key is the label key that the selector applies to.

+

operator

+

String

+

operator represents a key's relationship to a set of values.

+

Valid operators are In, NotIn, Exists and DoesNotExist.

+

values

+

Array of strings

+

values is an array of string values. If the operator is In or

+

NotIn, the values array must be non-empty. If the operator is Exists or

+

DoesNotExist, the values array must be empty. This array is replaced during

+

a strategic merge patch.

+
+
+ +
+ + + + + + + + + + + + + + + + + +
Table 203 io.cci.otc.api.pkg.apis.versioned.cci.v2.NFSVolumeSource

Parameter

+

Type

+

Description

+

path

+

String

+

path that is exported by the NFS server. More info: https://kubernetes.io/docs/concepts/storage/volumes#nfs

+

readOnly

+

Boolean

+

readOnly here will force the NFS export to be mounted with read-only permissions. Defaults to false. More info: https://kubernetes.io/docs/concepts/storage/volumes#nfs

+

server

+

String

+

server is the hostname or IP address of the NFS server. More info: https://kubernetes.io/docs/concepts/storage/volumes#nfs

+
+
+ +
+ + + + + + + + + + + + + +
Table 204 io.cci.otc.api.pkg.apis.versioned.cci.v2.PersistentVolumeClaimVolumeSource

Parameter

+

Type

+

Description

+

claimName

+

String

+

claimName is the name of a PersistentVolumeClaim in the same namespace as the pod using this volume. More info: https://kubernetes.io/docs/concepts/storage/persistent-volumes#persistentvolumeclaims

+

readOnly

+

Boolean

+

readOnly Will force the ReadOnly setting in VolumeMounts. Default

+

false.

+
+
+ +
+ + + + + + + + + + + + + +
Table 205 io.cci.otc.api.pkg.apis.versioned.cci.v2.ProjectedVolumeSource

Parameter

+

Type

+

Description

+

defaultMode

+

Integer

+

defaultMode are the mode bits used to set permissions on created

+

files by default. Must be an octal value between 0000 and 0777 or a decimal

+

value between 0 and 511. YAML accepts both octal and decimal values, JSON

+

requires decimal values for mode bits. Directories within the path are not

+

affected by this setting. This might be in conflict with other options that

+

affect the file mode, like fsGroup, and the result can be other mode bits

+

set.

+

sources

+

Array of io.cci.otc.api.pkg.apis.versioned.cci.v2.VolumeProjection objects

+

sources is the list of volume projections

+
+
+ +
+ + + + + + + + + + + + + + + + + +
Table 206 io.cci.otc.api.pkg.apis.versioned.cci.v2.VolumeProjection

Parameter

+

Type

+

Description

+

configMap

+

io.cci.otc.api.pkg.apis.versioned.cci.v2.ConfigMapProjection object

+

configMap information about the configMap data to project

+

downwardAPI

+

io.cci.otc.api.pkg.apis.versioned.cci.v2.DownwardAPIProjection object

+

downwardAPI information about the downwardAPI data to project

+

secret

+

io.cci.otc.api.pkg.apis.versioned.cci.v2.SecretProjection object

+

secret information about the secret data to project

+
+
+ +
+ + + + + + + + + + + + + + + + + +
Table 207 io.cci.otc.api.pkg.apis.versioned.cci.v2.ConfigMapProjection

Parameter

+

Type

+

Description

+

items

+

Array of io.cci.otc.api.pkg.apis.versioned.cci.v2.KeyToPath objects

+

items if unspecified, each key-value pair in the Data field of

+

the referenced ConfigMap will be projected into the volume as a file whose

+

name is the key and content is the value. If specified, the listed keys

+

will be projected into the specified paths, and unlisted keys will not be

+

present. If a key is specified which is not present in the ConfigMap, the

+

volume setup will error unless it is marked optional. Paths must be relative

+

and may not contain the '..' path or start with '..'.

+

name

+

String

+

Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names

+

optional

+

Boolean

+

optional specify whether the ConfigMap or its keys must be defined

+
+
+ +
+ + + + + + + + + +
Table 208 io.cci.otc.api.pkg.apis.versioned.cci.v2.DownwardAPIProjection

Parameter

+

Type

+

Description

+

items

+

Array of io.cci.otc.api.pkg.apis.versioned.cci.v2.DownwardAPIVolumeFile objects

+

Items is a list of DownwardAPIVolume file

+
+
+ +
+ + + + + + + + + + + + + + + + + + + + + +
Table 209 io.cci.otc.api.pkg.apis.versioned.cci.v2.DownwardAPIVolumeFile

Parameter

+

Type

+

Description

+

fieldRef

+

io.cci.otc.api.pkg.apis.versioned.cci.v2.ObjectFieldSelector object

+

Required: Selects a field of the pod: only annotations, labels, name and namespace are supported.

+

mode

+

Integer

+

Optional: mode bits used to set permissions on this file, must be an octal value between 0000 and 0777 or a decimal value between 0 and 511. YAML accepts both octal and decimal values, JSON requires decimal values for mode bits. If not specified, the volume defaultMode will be used. This might be in conflict with other options that affect the file mode, like fsGroup, and the result can be other mode bits set.

+

path

+

String

+

Required: Path is the relative path name of the file to be created. Must not be absolute or contain the '..' path. Must be utf-8 encoded. The first item of the relative path must not start with '..'

+

resourceFieldRef

+

io.cci.otc.api.pkg.apis.versioned.cci.v2.ResourceFieldSelector object

+

Selects a resource of the container: only resources limits and requests (limits.cpu, limits.memory, requests.cpu and requests.memory) are currently supported.

+
+
+ +
+ + + + + + + + + + + + + +
Table 210 io.cci.otc.api.pkg.apis.versioned.cci.v2.ObjectFieldSelector

Parameter

+

Type

+

Description

+

apiVersion

+

String

+

Version of the schema the FieldPath is written in terms of, defaults

+

to "v1".

+

fieldPath

+

String

+

Path of the field to select in the specified API version.

+
+
+ +
+ + + + + + + + + + + + + + + + + +
Table 211 io.cci.otc.api.pkg.apis.versioned.cci.v2.ResourceFieldSelector

Parameter

+

Type

+

Description

+

containerName

+

String

+

Container name: required for volumes, optional for env vars

+

divisor

+

String

+

Specifies the output format of the exposed resources, defaults

+

to "1"

+

resource

+

String

+

Required: resource to select

+
+
+ +
+ + + + + + + + + + + + + + + + + +
Table 212 io.cci.otc.api.pkg.apis.versioned.cci.v2.SecretProjection

Parameter

+

Type

+

Description

+

items

+

Array of io.cci.otc.api.pkg.apis.versioned.cci.v2.KeyToPath objects

+

items if unspecified, each key-value pair in the Data field of

+

the referenced Secret will be projected into the volume as a file whose

+

name is the key and content is the value. If specified, the listed keys

+

will be projected into the specified paths, and unlisted keys will not be

+

present. If a key is specified which is not present in the Secret, the volume

+

setup will error unless it is marked optional. Paths must be relative and

+

may not contain the '..' path or start with '..'.

+

name

+

String

+

Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names

+

optional

+

Boolean

+

optional field specify whether the Secret or its key must be

+

defined

+
+
+ +
+ + + + + + + + + + + + + + + + + + + + + +
Table 213 io.cci.otc.api.pkg.apis.versioned.cci.v2.SecretVolumeSource

Parameter

+

Type

+

Description

+

defaultMode

+

Integer

+

defaultMode is Optional: mode bits used to set permissions on created files by default. Must be an octal value between 0000 and 0777 or a decimal value between 0 and 511. YAML accepts both octal and decimal values, JSON requires decimal values for mode bits. Defaults to 0644. Directories within the path are not affected by this setting. This might be in conflict with other options that affect the file mode, like fsGroup, and the result can be other mode bits set.

+

items

+

Array of io.cci.otc.api.pkg.apis.versioned.cci.v2.KeyToPath objects

+

items If unspecified, each key-value pair in the Data field of

+

the referenced Secret will be projected into the volume as a file whose

+

name is the key and content is the value. If specified, the listed keys

+

will be projected into the specified paths, and unlisted keys will not be

+

present. If a key is specified which is not present in the Secret, the volume

+

setup will error unless it is marked optional. Paths must be relative and

+

may not contain the '..' path or start with '..'.

+

optional

+

Boolean

+

optional field specify whether the Secret or its keys must be

+

defined

+

secretName

+

String

+

secretName is the name of the secret in the pod's namespace to use. More info: https://kubernetes.io/docs/concepts/storage/volumes#secret

+
+
+ +
+ + + + + + + + + + + + + + + + + +
Table 214 io.cci.otc.api.pkg.apis.versioned.cci.v2.KeyToPath

Parameter

+

Type

+

Description

+

key

+

String

+

key is the key to project.

+

mode

+

Integer

+

mode is Optional: mode bits used to set permissions on this file. Must be an octal value between 0000 and 0777 or a decimal value between 0 and 511. YAML accepts both octal and decimal values, JSON requires decimal values for mode bits. If not specified, the volume defaultMode will be used. This might be in conflict with other options that affect the file mode, like fsGroup, and the result can be other mode bits set.

+

path

+

String

+

path is the relative path of the file to map the key to. May

+

not be an absolute path. May not contain the path element '..'. May not

+

start with the string '..'.

+
+
+ +
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Table 215 io.cci.otc.api.pkg.apis.versioned.cci.v2.PodStatus

Parameter

+

Type

+

Description

+

conditions

+

Array of io.cci.otc.api.pkg.apis.versioned.cci.v2.PodCondition objects

+

Current service state of pod. More info: https://kubernetes.io/docs/concepts/workloads/pods/pod-lifecycle#pod-conditions

+

containerStatuses

+

Array of io.cci.otc.api.pkg.apis.versioned.cci.v2.ContainerStatus objects

+

The list has one entry per container in the manifest. More info: https://kubernetes.io/docs/concepts/workloads/pods/pod-lifecycle#pod-and-container-status

+

ephemeralContainerStatuses

+

Array of io.cci.otc.api.pkg.apis.versioned.cci.v2.ContainerStatus objects

+

Status for any ephemeral containers that have run in this pod.

+

hostIP

+

String

+

IP address of the host to which the pod is assigned. Empty if

+

not yet scheduled.

+

initContainerStatuses

+

Array of io.cci.otc.api.pkg.apis.versioned.cci.v2.ContainerStatus objects

+

The list has one entry per init container in the manifest. The most recent successful init container will have ready = true, the most recently started container will have startTime set. More info: https://kubernetes.io/docs/concepts/workloads/pods/pod-lifecycle#pod-and-container-status

+

message

+

String

+

A human readable message indicating details about why the pod

+

is in this condition.

+

nominatedNodeName

+

String

+

nominatedNodeName is set only when this pod preempts other pods

+

on the node, but it cannot be scheduled right away as preemption victims

+

receive their graceful termination periods. This field does not guarantee

+

that the pod will be scheduled on this node. Scheduler may decide to place

+

the pod elsewhere if other nodes become available sooner. Scheduler may

+

also decide to give the resources on this node to a higher priority pod

+

that is created after preemption. As a result, this field may be different

+

than PodSpec.nodeName when the pod is scheduled.

+

phase

+

String

+

The phase of a Pod is a simple, high-level summary of where the Pod is in its lifecycle. The conditions array, the reason and message fields, and the individual container status arrays contain more detail about the pod's status. There are five possible phase values:

+

Pending: The pod has been accepted by the Kubernetes system, but one or more of the container images has not been created. This includes time before being scheduled as well as time spent downloading images over the network, which could take a while. Running: The pod has been bound to a node, and all of the containers have been created. At least one container is still running, or is in the process of starting or restarting. Succeeded: All containers in the pod have terminated in success, and will not be restarted. Failed: All containers in the pod have terminated, and at least one container has terminated in failure. The container either exited with non-zero status or was terminated by the system. Unknown: For some reason the state of the pod could not be obtained, typically due to an error in communicating with the host of the pod.

+

More info: https://kubernetes.io/docs/concepts/workloads/pods/pod-lifecycle#pod-phase

+

Possible enum values:

+
  • "Failed" means that all containers in the pod have terminated, and at least one container has terminated in a failure (exited with a non-zero exit code or was stopped by the system).
  • "Pending" means the pod has been accepted by the system, but one or more of the containers has not been started. This includes time before being bound to a node, as well as time spent pulling images onto the host.
  • "Running" means the pod has been bound to a node and all of the containers have been started. At least one container is still running or is in the process of being restarted.
  • "Succeeded" means that all containers in the pod have voluntarily terminated with a container exit code of 0, and the system is not going to restart any of these containers.
  • "Unknown" means that for some reason the state of the pod could not be obtained, typically due to an error in communicating with the host of the pod. Deprecated: It isn't being set since 2015 (74da3b14b0c0f658b3bb8d2def5094686d0e9095)
+

podIP

+

String

+

IP address allocated to the pod. Routable at least within the

+

cluster. Empty if not yet allocated.

+

podIPs

+

Array of io.cci.otc.api.pkg.apis.versioned.cci.v2.PodIP objects

+

podIPs holds the IP addresses allocated to the pod. If this field

+

is specified, the 0th entry must match the podIP field. Pods may be allocated

+

at most 1 value for each of IPv4 and IPv6. This list is empty if no IPs

+

have been allocated yet.

+

qosClass

+

String

+

The Quality of Service (QOS) classification assigned to the pod based on resource requirements See PodQOSClass type for available QOS classes More info: https://git.k8s.io/community/contributors/design-proposals/node/resource-qos.md

+

Possible enum values:

+
  • "BestEffort" is the BestEffort qos class.
  • "Burstable" is the Burstable qos class.
  • "Guaranteed" is the Guaranteed qos class.
+

reason

+

String

+

A brief CamelCase message indicating details about why the pod

+

is in this state. e.g. 'Evicted'

+

startTime

+

String

+

RFC 3339 date and time at which the object was acknowledged by

+

the Kubelet. This is before the Kubelet pulled the container image(s) for

+

the pod.

+
+
+ +
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Table 216 io.cci.otc.api.pkg.apis.versioned.cci.v2.PodCondition

Parameter

+

Type

+

Description

+

lastProbeTime

+

String

+

Last time we probed the condition.

+

lastTransitionTime

+

String

+

Last time the condition transitioned from one status to another.

+

message

+

String

+

Human-readable message indicating details about last transition.

+

reason

+

String

+

Unique, one-word, CamelCase reason for the condition's last transition.

+

status

+

String

+

Status is the status of the condition. Can be True, False, Unknown. More info: https://kubernetes.io/docs/concepts/workloads/pods/pod-lifecycle#pod-conditions

+

type

+

String

+

Type is the type of the condition. More info: https://kubernetes.io/docs/concepts/workloads/pods/pod-lifecycle#pod-conditions

+
+
+ +
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Table 217 io.cci.otc.api.pkg.apis.versioned.cci.v2.ContainerStatus

Parameter

+

Type

+

Description

+

containerID

+

String

+

Container's ID in the format '[/topic/body/section/table/tgroup/tbody/row/entry/p/br {""})(br]://<container_id>'.

+

image

+

String

+

The image the container is running. More info: https://kubernetes.io/docs/concepts/containers/images.

+

imageID

+

String

+

ImageID of the container's image.

+

lastState

+

io.cci.otc.api.pkg.apis.versioned.cci.v2.ContainerState object

+

Details about the container's last termination condition.

+

name

+

String

+

This must be a DNS_LABEL. Each container in a pod must have a

+

unique name. Cannot be updated.

+

ready

+

Boolean

+

Specifies whether the container has passed its readiness probe.

+

restartCount

+

Integer

+

The number of times the container has been restarted.

+

started

+

Boolean

+

Specifies whether the container has passed its startup probe.

+

Initialized as false, becomes true after startupProbe is considered successful.

+

Resets to false when the container is restarted, or if kubelet loses state

+

temporarily. Is always true when no startupProbe is defined.

+

state

+

io.cci.otc.api.pkg.apis.versioned.cci.v2.ContainerState object

+

Details about the container's current condition.

+
+
+ +
+ + + + + + + + + + + + + + + + + +
Table 218 io.cci.otc.api.pkg.apis.versioned.cci.v2.ContainerState

Parameter

+

Type

+

Description

+

running

+

io.cci.otc.api.pkg.apis.versioned.cci.v2.ContainerStateRunning object

+

Details about a running container

+

terminated

+

io.cci.otc.api.pkg.apis.versioned.cci.v2.ContainerStateTerminated object

+

Details about a terminated container

+

waiting

+

io.cci.otc.api.pkg.apis.versioned.cci.v2.ContainerStateWaiting object

+

Details about a waiting container

+
+
+ +
+ + + + + + + + + +
Table 219 io.cci.otc.api.pkg.apis.versioned.cci.v2.ContainerStateRunning

Parameter

+

Type

+

Description

+

startedAt

+

String

+

Time at which the container was last (re-)started

+
+
+ +
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Table 220 io.cci.otc.api.pkg.apis.versioned.cci.v2.ContainerStateTerminated

Parameter

+

Type

+

Description

+

containerID

+

String

+

Container's ID in the format '[/topic/body/section/table/tgroup/tbody/row/entry/p/br {""})(br]://<container_id>'

+

exitCode

+

Integer

+

Exit status from the last termination of the container

+

finishedAt

+

String

+

Time at which the container last terminated

+

message

+

String

+

Message regarding the last termination of the container

+

reason

+

String

+

(brief) reason from the last termination of the container

+

signal

+

Integer

+

Signal from the last termination of the container

+

startedAt

+

String

+

Time at which previous execution of the container started

+
+
+ +
+ + + + + + + + + + + + + +
Table 221 io.cci.otc.api.pkg.apis.versioned.cci.v2.ContainerStateWaiting

Parameter

+

Type

+

Description

+

message

+

String

+

Message regarding why the container is not yet running.

+

reason

+

String

+

(brief) reason the container is not yet running.

+
+
+ +
+ + + + + + + + + +
Table 222 io.cci.otc.api.pkg.apis.versioned.cci.v2.PodIP

Parameter

+

Type

+

Description

+

ip

+

String

+

ip is an IP address (IPv4 or IPv6) assigned to the pod

+
+
+

Status code: 202

+ +
+ + + + + + + + + + + + + + + + + + + + + + + + + +
Table 223 Response body parameters

Parameter

+

Type

+

Description

+

apiVersion

+

String

+

APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#resources

+

kind

+

String

+

Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds

+

metadata

+

io.k8s.apimachinery.pkg.apis.meta.v1.ObjectMeta object

+

Standard object's metadata. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata

+

spec

+

io.cci.otc.api.pkg.apis.versioned.cci.v2.PodSpec object

+

Specification of the desired behavior of the pod. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#spec-and-status

+

status

+

io.cci.otc.api.pkg.apis.versioned.cci.v2.PodStatus object

+

Most recently observed status of the pod. This data may not be up to date. Populated by the system. Read-only. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#spec-and-status

+
+
+ +
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Table 224 io.cci.otc.api.pkg.apis.versioned.cci.v2.PodSpec

Parameter

+

Type

+

Description

+

activeDeadlineSeconds

+

Long

+

Optional duration in seconds the pod may be active on the node

+

relative to StartTime before the system will actively try to mark it failed

+

and kill associated containers. Value must be a positive integer.

+

affinity

+

io.cci.otc.api.pkg.apis.versioned.cci.v2.Affinity object

+

If specified, the pod's scheduling constraints

+

containers

+

Array of io.cci.otc.api.pkg.apis.versioned.cci.v2.Container objects

+

List of containers belonging to the pod. Containers cannot currently

+

be added or removed. There must be at least one container in a Pod. Cannot

+

be updated.

+

dnsConfig

+

io.cci.otc.api.pkg.apis.versioned.cci.v2.PodDNSConfig object

+

Specifies the DNS parameters of a pod. Parameters specified here

+

will be merged to the generated DNS configuration based on DNSPolicy.

+

dnsPolicy

+

String

+

Set DNS policy for the pod. Defaults to "ClusterFirst". Valid values are 'ClusterFirstWithHostNet', 'ClusterFirst', 'Default' or 'None'. DNS parameters given in DNSConfig will be merged with the policy selected with DNSPolicy. To have DNS options set along with hostNetwork, you have to specify DNS policy explicitly to 'ClusterFirstWithHostNet'.

+

Possible enum values:

+
  • "ClusterFirst" indicates that the pod should use cluster DNS first unless hostNetwork is true, if it is available, then fall back on the default (as determined by kubelet) DNS settings.
  • "ClusterFirstWithHostNet" indicates that the pod should use cluster DNS first, if it is available, then fall back on the default (as determined by kubelet) DNS settings.
  • "Default" indicates that the pod should use the default (as determined by kubelet) DNS settings.
  • "None" indicates that the pod should use empty DNS settings. DNS parameters such as nameservers and search paths should be defined via DNSConfig.
+

ephemeralContainers

+

Array of io.cci.otc.api.pkg.apis.versioned.cci.v2.EphemeralContainer objects

+

List of ephemeral containers run in this pod. Ephemeral containers

+

may be run in an existing pod to perform user-initiated actions such as

+

debugging. This list cannot be specified when creating a pod, and it cannot

+

be modified by updating the pod spec. In order to add an ephemeral container

+

to an existing pod, use the pod's ephemeralcontainers subresource.

+

hostAliases

+

Array of io.cci.otc.api.pkg.apis.versioned.cci.v2.HostAlias objects

+

HostAliases is an optional list of hosts and IPs that will be

+

injected into the pod's hosts file if specified. This is only valid for

+

non-hostNetwork pods.

+

hostname

+

String

+

Specifies the hostname of the Pod If not specified, the pod's

+

hostname will be set to a system-defined value.

+

imagePullSecrets

+

Array of io.cci.otc.api.pkg.apis.versioned.cci.v2.LocalObjectReference objects

+

ImagePullSecrets is an optional list of references to secrets in the same namespace to use for pulling any of the images used by this PodSpec. If specified, these secrets will be passed to individual puller implementations for them to use. More info: https://kubernetes.io/docs/concepts/containers/images#specifying-imagepullsecrets-on-a-pod

+

initContainers

+

Array of io.cci.otc.api.pkg.apis.versioned.cci.v2.Container objects

+

List of initialization containers belonging to the pod. Init containers are executed in order prior to containers being started. If any init container fails, the pod is considered to have failed and is handled according to its restartPolicy. The name for an init container or normal container must be unique among all containers. Init containers may not have Lifecycle actions, Readiness probes, Liveness probes, or Startup probes. The resourceRequirements of an init container are taken into account during scheduling by finding the highest request/limit for each resource type, and then using the max of of that value or the sum of the normal containers. Limits are applied to init containers in a similar fashion. Init containers cannot currently be added or removed. Cannot be updated. More info: https://kubernetes.io/docs/concepts/workloads/pods/init-containers/

+

nodeName

+

String

+

NodeName is a request to schedule this pod onto a specific node.

+

If it is non-empty, the scheduler simply schedules this pod onto that node,

+

assuming that it fits resource requirements.

+

overhead

+

Map<String,String>

+

Overhead represents the resource overhead associated with running a pod for a given RuntimeClass. This field will be autopopulated at admission time by the RuntimeClass admission controller. If the RuntimeClass admission controller is enabled, overhead must not be set in Pod create requests. The RuntimeClass admission controller will reject Pod create requests which have the overhead already set. If RuntimeClass is configured and selected in the PodSpec, Overhead will be set to the value defined in the corresponding RuntimeClass, otherwise it will remain unset and treated as zero. More info: https://git.k8s.io/enhancements/keps/sig-node/688-pod-overhead/README.md

+

readinessGates

+

Array of io.cci.otc.api.pkg.apis.versioned.cci.v2.PodReadinessGate objects

+

If specified, all readiness gates will be evaluated for pod readiness. A pod is ready when all its containers are ready AND all conditions specified in the readiness gates have status equal to "True" More info: https://git.k8s.io/enhancements/keps/sig-network/580-pod-readiness-gates

+

restartPolicy

+

String

+

Restart policy for all containers within the pod. One of Always, OnFailure, Never. Default to Always. More info: https://kubernetes.io/docs/concepts/workloads/pods/pod-lifecycle/#restart-policy

+

Possible enum values:

+
  • "Always"
  • "Never"
  • "OnFailure"
+

schedulerName

+

String

+

If specified, the pod will be dispatched by specified scheduler.

+

If not specified, the pod will be dispatched by default scheduler.

+

securityContext

+

io.cci.otc.api.pkg.apis.versioned.cci.v2.PodSecurityContext object

+

SecurityContext holds pod-level security attributes and common container settings. Optional: Defaults to empty. See type description for default values of each field.

+

setHostnameAsFQDN

+

Boolean

+

If true the pod's hostname will be configured as the pod's FQDN,

+

rather than the leaf name (the default). In Linux containers, this means

+

setting the FQDN in the hostname field of the kernel (the nodename field

+

of struct utsname). In Windows containers, this means setting the registry

+

value of hostname for the registry key HKEY_LOCAL_MACHINE\SYSTEM\CurrentControlSet\Services\Tcpip\Parameters

+

to FQDN. If a pod does not have FQDN, this has no effect. Default to false.

+

shareProcessNamespace

+

Boolean

+

Share a single process namespace between all of the containers in a pod. When this is set containers will be able to view and signal processes from other containers in the same pod, and the first process in each container will not be assigned PID 1. HostPID and ShareProcessNamespace cannot both be set. Optional: Default to false.

+

terminationGracePeriodSeconds

+

Long

+

Optional duration in seconds the pod needs to terminate gracefully.

+

May be decreased in delete request. Value must be non-negative integer.

+

The value zero indicates stop immediately via the kill signal (no opportunity

+

to shut down). If this value is nil, the default grace period will be used

+

instead. The grace period is the duration in seconds after the processes

+

running in the pod are sent a termination signal and the time when the processes

+

are forcibly halted with a kill signal. Set this value longer than the expected

+

cleanup time for your process. Defaults to 30 seconds.

+

topologySpreadConstraints

+

Array of io.cci.otc.api.pkg.apis.versioned.cci.v2.TopologySpreadConstraint objects

+

TopologySpreadConstraints describes how a group of pods ought

+

to spread across topology domains. Scheduler will schedule pods in a way

+

which abides by the constraints. All topologySpreadConstraints are ANDed.

+

volumes

+

Array of io.cci.otc.api.pkg.apis.versioned.cci.v2.Volume objects

+

List of volumes that can be mounted by containers belonging to the pod. More info: https://kubernetes.io/docs/concepts/storage/volumes

+
+
+ +
+ + + + + + + + + + + + + +
Table 225 io.cci.otc.api.pkg.apis.versioned.cci.v2.Affinity

Parameter

+

Type

+

Description

+

nodeAffinity

+

io.cci.otc.api.pkg.apis.versioned.cci.v2.NodeAffinity object

+

Describes node affinity scheduling rules for the pod.

+

podAntiAffinity

+

io.cci.otc.api.pkg.apis.versioned.cci.v2.PodAntiAffinity object

+

Describes pod anti-affinity scheduling rules (e.g. avoid putting

+

this pod in the same zone, etc. as some other pod(s)).

+
+
+ +
+ + + + + + + + + +
Table 226 io.cci.otc.api.pkg.apis.versioned.cci.v2.NodeAffinity

Parameter

+

Type

+

Description

+

requiredDuringSchedulingIgnoredDuringExecution

+

io.cci.otc.api.pkg.apis.versioned.cci.v2.NodeSelector object

+

If the affinity requirements specified by this field are not

+

met at scheduling time, the pod will not be scheduled onto the node. If

+

the affinity requirements specified by this field cease to be met at some

+

point during pod execution (e.g. due to an update), the system may or may

+

not try to eventually evict the pod from its node.

+
+
+ +
+ + + + + + + + + +
Table 227 io.cci.otc.api.pkg.apis.versioned.cci.v2.NodeSelector

Parameter

+

Type

+

Description

+

nodeSelectorTerms

+

Array of io.cci.otc.api.pkg.apis.versioned.cci.v2.NodeSelectorTerm objects

+

Required. A list of node selector terms. The terms are ORed.

+
+
+ +
+ + + + + + + + + +
Table 228 io.cci.otc.api.pkg.apis.versioned.cci.v2.NodeSelectorTerm

Parameter

+

Type

+

Description

+

matchExpressions

+

Array of io.cci.otc.api.pkg.apis.versioned.cci.v2.NodeSelectorRequirement objects

+

A list of node selector requirements by node's labels.

+
+
+ +
+ + + + + + + + + + + + + + + + + +
Table 229 io.cci.otc.api.pkg.apis.versioned.cci.v2.NodeSelectorRequirement

Parameter

+

Type

+

Description

+

key

+

String

+

The label key that the selector applies to.

+

operator

+

String

+

Represents a key's relationship to a set of values. Valid operators are In, NotIn, Exists, DoesNotExist. Gt, and Lt.

+

Possible enum values:

+
  • "DoesNotExist"
  • "Exists"
  • "Gt"
  • "In"
  • "Lt"
  • "NotIn"
+

values

+

Array of strings

+

An array of string values. If the operator is In or NotIn, the

+

values array must be non-empty. If the operator is Exists or DoesNotExist,

+

the values array must be empty. If the operator is Gt or Lt, the values

+

array must have a single element, which will be interpreted as an integer.

+

This array is replaced during a strategic merge patch.

+
+
+ +
+ + + + + + + + + + + + + +
Table 230 io.cci.otc.api.pkg.apis.versioned.cci.v2.PodAntiAffinity

Parameter

+

Type

+

Description

+

preferredDuringSchedulingIgnoredDuringExecution

+

Array of io.cci.otc.api.pkg.apis.versioned.cci.v2.WeightedPodAffinityTerm objects

+

The scheduler will prefer to schedule pods to nodes that satisfy

+

the anti-affinity expressions specified by this field, but it may choose

+

a node that violates one or more of the expressions. The node that is most

+

preferred is the one with the greatest sum of weights, i.e. for each node

+

that meets all of the scheduling requirements (resource request, requiredDuringScheduling

+

anti-affinity expressions, etc.), compute a sum by iterating through the

+

elements of this field and adding "weight" to the sum if the node has pods

+

which matches the corresponding podAffinityTerm; the node(s) with the highest

+

sum are the most preferred.

+

requiredDuringSchedulingIgnoredDuringExecution

+

Array of io.cci.otc.api.pkg.apis.versioned.cci.v2.PodAffinityTerm objects

+

If the anti-affinity requirements specified by this field are

+

not met at scheduling time, the pod will not be scheduled onto the node.

+

If the anti-affinity requirements specified by this field cease to be met

+

at some point during pod execution (e.g. due to a pod label update), the

+

system may or may not try to eventually evict the pod from its node. When

+

there are multiple elements, the lists of nodes corresponding to each podAffinityTerm

+

are intersected, i.e. all terms must be satisfied.

+
+
+ +
+ + + + + + + + + + + + + +
Table 231 io.cci.otc.api.pkg.apis.versioned.cci.v2.WeightedPodAffinityTerm

Parameter

+

Type

+

Description

+

podAffinityTerm

+

io.cci.otc.api.pkg.apis.versioned.cci.v2.PodAffinityTerm object

+

Required. A pod affinity term, associated with the corresponding

+

weight.

+

weight

+

Integer

+

weight associated with matching the corresponding podAffinityTerm,

+

in the range 1-100.

+
+
+ +
+ + + + + + + + + + + + + + + + + +
Table 232 io.cci.otc.api.pkg.apis.versioned.cci.v2.PodAffinityTerm

Parameter

+

Type

+

Description

+

labelSelector

+

io.k8s.apimachinery.pkg.apis.meta.v1.LabelSelector object

+

A label query over a set of resources, in this case pods.

+

namespaces

+

Array of strings

+

namespaces specifies a static list of namespace names that the

+

term applies to. The term is applied to the union of the namespaces listed

+

in this field and the ones selected by namespaceSelector. null or empty

+

namespaces list and null namespaceSelector means "this pod's namespace".

+

topologyKey

+

String

+

This pod should be co-located (affinity) or not co-located (anti-affinity)

+

with the pods matching the labelSelector in the specified namespaces, where

+

co-located is defined as running on a node whose value of the label with

+

key topologyKey matches that of any node on which any of the selected pods

+

is running. Empty topologyKey is not allowed.

+
+
+ +
+ + + + + + + + + + + + + + + + + +
Table 233 io.cci.otc.api.pkg.apis.versioned.cci.v2.PodDNSConfig

Parameter

+

Type

+

Description

+

nameservers

+

Array of strings

+

A list of DNS name server IP addresses. This will be appended

+

to the base nameservers generated from DNSPolicy. Duplicated nameservers

+

will be removed.

+

options

+

Array of io.cci.otc.api.pkg.apis.versioned.cci.v2.PodDNSConfigOption objects

+

A list of DNS resolver options. This will be merged with the

+

base options generated from DNSPolicy. Duplicated entries will be removed.

+

Resolution options given in Options will override those that appear in the

+

base DNSPolicy.

+

searches

+

Array of strings

+

A list of DNS search domains for host-name lookup. This will

+

be appended to the base search paths generated from DNSPolicy. Duplicated

+

search paths will be removed.

+
+
+ +
+ + + + + + + + + + + + + +
Table 234 io.cci.otc.api.pkg.apis.versioned.cci.v2.PodDNSConfigOption

Parameter

+

Type

+

Description

+

name

+

String

+

Required.

+

value

+

String

+		  
+
+ +
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Table 235 io.cci.otc.api.pkg.apis.versioned.cci.v2.EphemeralContainer

Parameter

+

Type

+

Description

+

args

+

Array of strings

+

Arguments to the entrypoint. The image's CMD is used if this is not provided. Variable references $(VAR_NAME) are expanded using the container's environment. If a variable cannot be resolved, the reference in the input string will be unchanged. Double $$ are reduced to a single $, which allows for escaping the $(VAR_NAME) syntax: i.e. "$$(VAR_NAME)" will produce the string literal "$(VAR_NAME)". Escaped references will never be expanded, regardless of whether the variable exists or not. Cannot be updated. More info: https://kubernetes.io/docs/tasks/inject-data-application/define-command-argument-container/#running-a-command-in-a-shell

+

command

+

Array of strings

+

Entrypoint array. Not executed within a shell. The image's ENTRYPOINT is used if this is not provided. Variable references $(VAR_NAME) are expanded using the container's environment. If a variable cannot be resolved, the reference in the input string will be unchanged. Double $$ are reduced to a single $, which allows for escaping the $(VAR_NAME) syntax: i.e. "$$(VAR_NAME)" will produce the string literal "$(VAR_NAME)". Escaped references will never be expanded, regardless of whether the variable exists or not. Cannot be updated. More info: https://kubernetes.io/docs/tasks/inject-data-application/define-command-argument-container/#running-a-command-in-a-shell

+

env

+

Array of io.cci.otc.api.pkg.apis.versioned.cci.v2.EnvVar objects

+

List of environment variables to set in the container. Cannot

+

be updated.

+

envFrom

+

Array of io.cci.otc.api.pkg.apis.versioned.cci.v2.EnvFromSource objects

+

List of sources to populate environment variables in the container.

+

The keys defined within a source must be a C_IDENTIFIER. All invalid keys

+

will be reported as an event when the container is starting. When a key

+

exists in multiple sources, the value associated with the last source will

+

take precedence. Values defined by an Env with a duplicate key will take

+

precedence. Cannot be updated.

+

image

+

String

+

Container image name. More info: https://kubernetes.io/docs/concepts/containers/images

+

lifecycle

+

io.cci.otc.api.pkg.apis.versioned.cci.v2.Lifecycle object

+

Lifecycle is not allowed for ephemeral containers.

+

livenessProbe

+

io.cci.otc.api.pkg.apis.versioned.cci.v2.Probe object

+

Probes are not allowed for ephemeral containers.

+

name

+

String

+

Name of the ephemeral container specified as a DNS_LABEL. This

+

name must be unique among all containers, init containers and ephemeral

+

containers.

+

ports

+

Array of io.cci.otc.api.pkg.apis.versioned.cci.v2.ContainerPort objects

+

Ports are not allowed for ephemeral containers.

+

readinessProbe

+

io.cci.otc.api.pkg.apis.versioned.cci.v2.Probe object

+

Probes are not allowed for ephemeral containers.

+

resources

+

io.cci.otc.api.pkg.apis.versioned.cci.v2.ResourceRequirements object

+

Resources are not allowed for ephemeral containers. Ephemeral

+

containers use spare resources already allocated to the pod.

+

securityContext

+

io.cci.otc.api.pkg.apis.versioned.cci.v2.SecurityContext object

+

Optional: SecurityContext defines the security options the ephemeral container should be run with. If set, the fields of SecurityContext override the equivalent fields of PodSecurityContext.

+

startupProbe

+

io.cci.otc.api.pkg.apis.versioned.cci.v2.Probe object

+

Probes are not allowed for ephemeral containers.

+

stdin

+

Boolean

+

Whether this container should allocate a buffer for stdin in

+

the container runtime. If this is not set, reads from stdin in the container

+

will always result in EOF. Default is false.

+

stdinOnce

+

Boolean

+

Whether the container runtime should close the stdin channel

+

after it has been opened by a single attach. When stdin is true the stdin

+

stream will remain open across multiple attach sessions. If stdinOnce is

+

set to true, stdin is opened on container start, is empty until the first

+

client attaches to stdin, and then remains open and accepts data until the

+

client disconnects, at which time stdin is closed and remains closed until

+

the container is restarted. If this flag is false, a container processes

+

that reads from stdin will never receive an EOF. Default is false

+

targetContainerName

+

String

+

If set, the name of the container from PodSpec that this ephemeral container targets. The ephemeral container will be run in the namespaces (IPC, PID, etc) of this container. If not set then the ephemeral container uses the namespaces configured in the Pod spec.

+

The container runtime must implement support for this feature. If the runtime does not support namespace targeting then the result of setting this field is undefined.

+

terminationMessagePath

+

String

+

Optional: Path at which the file to which the container's termination message will be written is mounted into the container's filesystem. Message written is intended to be brief final status, such as an assertion failure message. Will be truncated by the node if greater than 4096 bytes. The total message length across all containers will be limited to 12kb. Defaults to /dev/termination-log. Cannot be updated.

+

terminationMessagePolicy

+

String

+

Indicate how the termination message should be populated. File will use the contents of terminationMessagePath to populate the container status message on both success and failure. FallbackToLogsOnError will use the last chunk of container log output if the termination message file is empty and the container exited with an error. The log output is limited to 2048 bytes or 80 lines, whichever is smaller. Defaults to File. Cannot be updated.

+

Possible enum values:

+
  • "FallbackToLogsOnError" will read the most recent contents of the container logs for the container status message when the container exits with an error and the terminationMessagePath has no contents.
  • "File" is the default behavior and will set the container status message to the contents of the container's terminationMessagePath when the container exits.
+

tty

+

Boolean

+

Whether this container should allocate a TTY for itself, also

+

requires 'stdin' to be true. Default is false.

+

volumeMounts

+

Array of io.cci.otc.api.pkg.apis.versioned.cci.v2.VolumeMount objects

+

Pod volumes to mount into the container's filesystem. Subpath

+

mounts are not allowed for ephemeral containers. Cannot be updated.

+

workingDir

+

String

+

Container's working directory. If not specified, the container

+

runtime's default will be used, which might be configured in the container

+

image. Cannot be updated.

+
+
+ +
+ + + + + + + + + + + + + +
Table 236 io.cci.otc.api.pkg.apis.versioned.cci.v2.HostAlias

Parameter

+

Type

+

Description

+

hostnames

+

Array of strings

+

Hostnames for the above IP address.

+

ip

+

String

+

IP address of the host file entry.

+
+
+ +
+ + + + + + + + + +
Table 237 io.cci.otc.api.pkg.apis.versioned.cci.v2.LocalObjectReference

Parameter

+

Type

+

Description

+

name

+

String

+

Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names

+
+
+ +
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Table 238 io.cci.otc.api.pkg.apis.versioned.cci.v2.Container

Parameter

+

Type

+

Description

+

args

+

Array of strings

+

Arguments to the entrypoint. The container image's CMD is used if this is not provided. Variable references $(VAR_NAME) are expanded using the container's environment. If a variable cannot be resolved, the reference in the input string will be unchanged. Double $$ are reduced to a single $, which allows for escaping the $(VAR_NAME) syntax: i.e. "$$(VAR_NAME)" will produce the string literal "$(VAR_NAME)". Escaped references will never be expanded, regardless of whether the variable exists or not. Cannot be updated. More info: https://kubernetes.io/docs/tasks/inject-data-application/define-command-argument-container/#running-a-command-in-a-shell

+

command

+

Array of strings

+

Entrypoint array. Not executed within a shell. The container image's ENTRYPOINT is used if this is not provided. Variable references $(VAR_NAME) are expanded using the container's environment. If a variable cannot be resolved, the reference in the input string will be unchanged. Double $$ are reduced to a single $, which allows for escaping the $(VAR_NAME) syntax: i.e. "$$(VAR_NAME)" will produce the string literal "$(VAR_NAME)". Escaped references will never be expanded, regardless of whether the variable exists or not. Cannot be updated. More info: https://kubernetes.io/docs/tasks/inject-data-application/define-command-argument-container/#running-a-command-in-a-shell

+

env

+

Array of io.cci.otc.api.pkg.apis.versioned.cci.v2.EnvVar objects

+

List of environment variables to set in the container. Cannot

+

be updated.

+

envFrom

+

Array of io.cci.otc.api.pkg.apis.versioned.cci.v2.EnvFromSource objects

+

List of sources to populate environment variables in the container.

+

The keys defined within a source must be a C_IDENTIFIER. All invalid keys

+

will be reported as an event when the container is starting. When a key

+

exists in multiple sources, the value associated with the last source will

+

take precedence. Values defined by an Env with a duplicate key will take

+

precedence. Cannot be updated.

+

image

+

String

+

Container image name. More info: https://kubernetes.io/docs/concepts/containers/images This field is optional to allow higher level config management to default or override container images in workload controllers like Deployments and StatefulSets.

+

lifecycle

+

io.cci.otc.api.pkg.apis.versioned.cci.v2.Lifecycle object

+

Actions that the management system should take in response to

+

container lifecycle events. Cannot be updated.

+

livenessProbe

+

io.cci.otc.api.pkg.apis.versioned.cci.v2.Probe object

+

Periodic probe of container liveness. Container will be restarted if the probe fails. Cannot be updated. More info: https://kubernetes.io/docs/concepts/workloads/pods/pod-lifecycle#container-probes

+

name

+

String

+

Name of the container specified as a DNS_LABEL. Each container

+

in a pod must have a unique name (DNS_LABEL). Cannot be updated.

+

ports

+

Array of io.cci.otc.api.pkg.apis.versioned.cci.v2.ContainerPort objects

+

List of ports to expose from the container. Not specifying a

+

port here DOES NOT prevent that port from being exposed. Any port which

+

is listening on the default "0.0.0.0" address inside a container will be

+

accessible from the network. Modifying this array with strategic merge patch

+

may corrupt the data. For more information See https://github.com/kubernetes/kubernetes/issues/108255.

+

Cannot be updated.

+

readinessProbe

+

io.cci.otc.api.pkg.apis.versioned.cci.v2.Probe object

+

Periodic probe of container service readiness. Container will be removed from service endpoints if the probe fails. Cannot be updated. More info: https://kubernetes.io/docs/concepts/workloads/pods/pod-lifecycle#container-probes

+

resources

+

io.cci.otc.api.pkg.apis.versioned.cci.v2.ResourceRequirements object

+

Compute Resources required by this container. Cannot be updated. More info: https://kubernetes.io/docs/concepts/configuration/manage-resources-containers/

+

securityContext

+

io.cci.otc.api.pkg.apis.versioned.cci.v2.SecurityContext object

+

SecurityContext defines the security options the container should be run with. If set, the fields of SecurityContext override the equivalent fields of PodSecurityContext. More info: https://kubernetes.io/docs/tasks/configure-pod-container/security-context/

+

startupProbe

+

io.cci.otc.api.pkg.apis.versioned.cci.v2.Probe object

+

StartupProbe indicates that the Pod has successfully initialized. If specified, no other probes are executed until this completes successfully. If this probe fails, the Pod will be restarted, just as if the livenessProbe failed. This can be used to provide different probe parameters at the beginning of a Pod's lifecycle, when it might take a long time to load data or warm a cache, than during steady-state operation. This cannot be updated. More info: https://kubernetes.io/docs/concepts/workloads/pods/pod-lifecycle#container-probes

+

stdin

+

Boolean

+

Whether this container should allocate a buffer for stdin in

+

the container runtime. If this is not set, reads from stdin in the container

+

will always result in EOF. Default is false.

+

stdinOnce

+

Boolean

+

Whether the container runtime should close the stdin channel

+

after it has been opened by a single attach. When stdin is true the stdin

+

stream will remain open across multiple attach sessions. If stdinOnce is

+

set to true, stdin is opened on container start, is empty until the first

+

client attaches to stdin, and then remains open and accepts data until the

+

client disconnects, at which time stdin is closed and remains closed until

+

the container is restarted. If this flag is false, a container processes

+

that reads from stdin will never receive an EOF. Default is false

+

terminationMessagePath

+

String

+

Optional: Path at which the file to which the container's termination message will be written is mounted into the container's filesystem. Message written is intended to be brief final status, such as an assertion failure message. Will be truncated by the node if greater than 4096 bytes. The total message length across all containers will be limited to 12kb. Defaults to /dev/termination-log. Cannot be updated.

+

terminationMessagePolicy

+

String

+

Indicate how the termination message should be populated. File will use the contents of terminationMessagePath to populate the container status message on both success and failure. FallbackToLogsOnError will use the last chunk of container log output if the termination message file is empty and the container exited with an error. The log output is limited to 2048 bytes or 80 lines, whichever is smaller. Defaults to File. Cannot be updated.

+

Possible enum values:

+
  • "FallbackToLogsOnError" will read the most recent contents of the container logs for the container status message when the container exits with an error and the terminationMessagePath has no contents.
  • "File" is the default behavior and will set the container status message to the contents of the container's terminationMessagePath when the container exits.
+

tty

+

Boolean

+

Whether this container should allocate a TTY for itself, also

+

requires 'stdin' to be true. Default is false.

+

volumeMounts

+

Array of io.cci.otc.api.pkg.apis.versioned.cci.v2.VolumeMount objects

+

Pod volumes to mount into the container's filesystem. Cannot

+

be updated.

+

workingDir

+

String

+

Container's working directory. If not specified, the container

+

runtime's default will be used, which might be configured in the container

+

image. Cannot be updated.

+
+
+ +
+ + + + + + + + + + + + + + + + + +
Table 239 io.cci.otc.api.pkg.apis.versioned.cci.v2.EnvVar

Parameter

+

Type

+

Description

+

name

+

String

+

Name of the environment variable. Must be a C_IDENTIFIER.

+

value

+

String

+

Variable references $(VAR_NAME) are expanded using the previously defined environment variables in the container and any service environment variables. If a variable cannot be resolved, the reference in the input string will be unchanged. Double $$ are reduced to a single $, which allows for escaping the $(VAR_NAME) syntax: i.e. "$$(VAR_NAME)" will produce the string literal "$(VAR_NAME)". Escaped references will never be expanded, regardless of whether the variable exists or not. Defaults to "".

+

valueFrom

+

io.cci.otc.api.pkg.apis.versioned.cci.v2.EnvVarSource object

+

Source for the environment variable's value. Cannot be used if

+

value is not empty.

+
+
+ +
+ + + + + + + + + + + + + + + + + + + + + +
Table 240 io.cci.otc.api.pkg.apis.versioned.cci.v2.EnvVarSource

Parameter

+

Type

+

Description

+

configMapKeyRef

+

io.cci.otc.api.pkg.apis.versioned.cci.v2.ConfigMapKeySelector object

+

Selects a key of a ConfigMap.

+

fieldRef

+

io.cci.otc.api.pkg.apis.versioned.cci.v2.ObjectFieldSelector object

+

Selects a field of the pod: supports metadata.name, metadata.namespace, metadata.labels['<KEY>'], metadata.annotations['<KEY>'], spec.nodeName, spec.serviceAccountName, status.hostIP, status.podIP, status.podIPs.

+

resourceFieldRef

+

io.cci.otc.api.pkg.apis.versioned.cci.v2.ResourceFieldSelector object

+

Selects a resource of the container: only resources limits and requests (limits.cpu, limits.memory, limits.ephemeral-storage, requests.cpu, requests.memory and requests.ephemeral-storage) are currently supported.

+

secretKeyRef

+

io.cci.otc.api.pkg.apis.versioned.cci.v2.SecretKeySelector object

+

Selects a key of a secret in the pod's namespace

+
+
+ +
+ + + + + + + + + + + + + + + + + +
Table 241 io.cci.otc.api.pkg.apis.versioned.cci.v2.ConfigMapKeySelector

Parameter

+

Type

+

Description

+

key

+

String

+

The key to select.

+

name

+

String

+

Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names

+

optional

+

Boolean

+

Specify whether the ConfigMap or its key must be defined

+
+
+ +
+ + + + + + + + + + + + + + + + + +
Table 242 io.cci.otc.api.pkg.apis.versioned.cci.v2.SecretKeySelector

Parameter

+

Type

+

Description

+

key

+

String

+

The key of the secret to select from. Must be a valid secret

+

key.

+

name

+

String

+

Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names

+

optional

+

Boolean

+

Specify whether the Secret or its key must be defined

+
+
+ +
+ + + + + + + + + + + + + + + + + +
Table 243 io.cci.otc.api.pkg.apis.versioned.cci.v2.EnvFromSource

Parameter

+

Type

+

Description

+

configMapRef

+

io.cci.otc.api.pkg.apis.versioned.cci.v2.ConfigMapEnvSource object

+

The ConfigMap to select from

+

prefix

+

String

+

An optional identifier to prepend to each key in the ConfigMap.

+

Must be a C_IDENTIFIER.

+

secretRef

+

io.cci.otc.api.pkg.apis.versioned.cci.v2.SecretEnvSource object

+

The Secret to select from

+
+
+ +
+ + + + + + + + + + + + + +
Table 244 io.cci.otc.api.pkg.apis.versioned.cci.v2.ConfigMapEnvSource

Parameter

+

Type

+

Description

+

name

+

String

+

Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names

+

optional

+

Boolean

+

Specify whether the ConfigMap must be defined

+
+
+ +
+ + + + + + + + + + + + + +
Table 245 io.cci.otc.api.pkg.apis.versioned.cci.v2.SecretEnvSource

Parameter

+

Type

+

Description

+

name

+

String

+

Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names

+

optional

+

Boolean

+

Specify whether the Secret must be defined

+
+
+ +
+ + + + + + + + + + + + + +
Table 246 io.cci.otc.api.pkg.apis.versioned.cci.v2.Lifecycle

Parameter

+

Type

+

Description

+

postStart

+

io.cci.otc.api.pkg.apis.versioned.cci.v2.LifecycleHandler object

+

PostStart is called immediately after a container is created. If the handler fails, the container is terminated and restarted according to its restart policy. Other management of the container blocks until the hook completes. More info: https://kubernetes.io/docs/concepts/containers/container-lifecycle-hooks/#container-hooks

+

preStop

+

io.cci.otc.api.pkg.apis.versioned.cci.v2.LifecycleHandler object

+

PreStop is called immediately before a container is terminated due to an API request or management event such as liveness/startup probe failure, preemption, resource contention, etc. The handler is not called if the container crashes or exits. The Pod's termination grace period countdown begins before the PreStop hook is executed. Regardless of the outcome of the handler, the container will eventually terminate within the Pod's termination grace period (unless delayed by finalizers). Other management of the container blocks until the hook completes or until the termination grace period is reached. More info: https://kubernetes.io/docs/concepts/containers/container-lifecycle-hooks/#container-hooks

+
+
+ +
+ + + + + + + + + + + + + +
Table 247 io.cci.otc.api.pkg.apis.versioned.cci.v2.LifecycleHandler

Parameter

+

Type

+

Description

+

exec

+

io.cci.otc.api.pkg.apis.versioned.cci.v2.ExecAction object

+

Exec specifies the action to take.

+

httpGet

+

io.cci.otc.api.pkg.apis.versioned.cci.v2.HTTPGetAction object

+

HTTPGet specifies the http request to perform.

+
+
+ +
+ + + + + + + + + + + + + + + + + +
Table 248 io.cci.otc.api.pkg.apis.versioned.cci.v2.ContainerPort

Parameter

+

Type

+

Description

+

containerPort

+

Integer

+

Number of port to expose on the pod's IP address. This must be

+

a valid port number, 0 < x < 65536.

+

name

+

String

+

If specified, this must be an IANA_SVC_NAME and unique within

+

the pod. Each named port in a pod must have a unique name. Name for the

+

port that can be referred to by services.

+

protocol

+

String

+

Protocol for port. Must be UDP, TCP, or SCTP. Defaults to "TCP".

+

Possible enum values:

+
  • "SCTP" is the SCTP protocol.
  • "TCP" is the TCP protocol.
  • "UDP" is the UDP protocol.
+
+
+ +
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Table 249 io.cci.otc.api.pkg.apis.versioned.cci.v2.SecurityContext

Parameter

+

Type

+

Description

+

capabilities

+

io.cci.otc.api.pkg.apis.versioned.cci.v2.Capabilities object

+

The capabilities to add/drop when running containers. Defaults

+

to the default set of capabilities granted by the container runtime. Note

+

that this field cannot be set when spec.os.name is windows.

+

procMount

+

String

+

procMount denotes the type of proc mount to use for the containers.

+

The default is DefaultProcMount which uses the container runtime defaults

+

for readonly paths and masked paths. This requires the ProcMountType feature

+

flag to be enabled. Note that this field cannot be set when spec.os.name

+

is windows.

+

readOnlyRootFilesystem

+

Boolean

+

Whether this container has a read-only root filesystem. Default

+

is false. Note that this field cannot be set when spec.os.name is windows.

+

runAsGroup

+

Long

+

The GID to run the entrypoint of the container process. Uses

+

runtime default if unset. May also be set in PodSecurityContext. If set

+

in both SecurityContext and PodSecurityContext, the value specified in SecurityContext

+

takes precedence. Note that this field cannot be set when spec.os.name is

+

windows.

+

runAsNonRoot

+

Boolean

+

Indicates that the container must run as a non-root user. If

+

true, the Kubelet will validate the image at runtime to ensure that it does

+

not run as UID 0 (root) and fail to start the container if it does. If unset

+

or false, no such validation will be performed. May also be set in PodSecurityContext. If

+

set in both SecurityContext and PodSecurityContext, the value specified

+

in SecurityContext takes precedence.

+

runAsUser

+

Long

+

The UID to run the entrypoint of the container process. Defaults

+

to user specified in image metadata if unspecified. May also be set in PodSecurityContext. If

+

set in both SecurityContext and PodSecurityContext, the value specified

+

in SecurityContext takes precedence. Note that this field cannot be set

+

when spec.os.name is windows.

+
+
+ +
+ + + + + + + + + + + + + +
Table 250 io.cci.otc.api.pkg.apis.versioned.cci.v2.Capabilities

Parameter

+

Type

+

Description

+

add

+

Array of strings

+

Added capabilities

+

drop

+

Array of strings

+

Removed capabilities

+
+
+ +
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Table 251 io.cci.otc.api.pkg.apis.versioned.cci.v2.Probe

Parameter

+

Type

+

Description

+

exec

+

io.cci.otc.api.pkg.apis.versioned.cci.v2.ExecAction object

+

Exec specifies the action to take.

+

failureThreshold

+

Integer

+

Minimum consecutive failures for the probe to be considered failed

+

after having succeeded. Defaults to 3. Minimum value is 1.

+

httpGet

+

io.cci.otc.api.pkg.apis.versioned.cci.v2.HTTPGetAction object

+

HTTPGet specifies the http request to perform.

+

initialDelaySeconds

+

Integer

+

Number of seconds after the container has started before liveness probes are initiated. More info: https://kubernetes.io/docs/concepts/workloads/pods/pod-lifecycle#container-probes

+

periodSeconds

+

Integer

+

How often (in seconds) to perform the probe. Default to 10 seconds.

+

Minimum value is 1.

+

successThreshold

+

Integer

+

Minimum consecutive successes for the probe to be considered

+

successful after having failed. Defaults to 1. Must be 1 for liveness and

+

startup. Minimum value is 1.

+

tcpSocket

+

io.cci.otc.api.pkg.apis.versioned.cci.v2.TCPSocketAction object

+

TCPSocket specifies an action involving a TCP port.

+

terminationGracePeriodSeconds

+

Long

+

Optional duration in seconds the pod needs to terminate gracefully

+

upon probe failure. The grace period is the duration in seconds after the

+

processes running in the pod are sent a termination signal and the time

+

when the processes are forcibly halted with a kill signal. Set this value

+

longer than the expected cleanup time for your process. If this value is

+

nil, the pod's terminationGracePeriodSeconds will be used. Otherwise, this

+

value overrides the value provided by the pod spec. Value must be non-negative

+

integer. The value zero indicates stop immediately via the kill signal (no

+

opportunity to shut down). This is a beta field and requires enabling ProbeTerminationGracePeriod

+

feature gate. Minimum value is 1. spec.terminationGracePeriodSeconds is

+

used if unset.

+

timeoutSeconds

+

Integer

+

Number of seconds after which the probe times out. Defaults to 1 second. Minimum value is 1. More info: https://kubernetes.io/docs/concepts/workloads/pods/pod-lifecycle#container-probes

+
+
+ +
+ + + + + + + + + +
Table 252 io.cci.otc.api.pkg.apis.versioned.cci.v2.ExecAction

Parameter

+

Type

+

Description

+

command

+

Array of strings

+

Command is the command line to execute inside the container,

+

the working directory for the command is root ('/') in the container's

+

filesystem. The command is simply exec'd, it is not run inside a shell,

+

so traditional shell instructions ('|', etc) won't work. To use a shell,

+

you need to explicitly call out to that shell. Exit status of 0 is treated

+

as live/healthy and non-zero is unhealthy.

+
+
+ +
+ + + + + + + + + + + + + + + + + + + + + + + + + +
Table 253 io.cci.otc.api.pkg.apis.versioned.cci.v2.HTTPGetAction

Parameter

+

Type

+

Description

+

host

+

String

+

Host name to connect to, defaults to the pod IP. You probably

+

want to set "Host" in httpHeaders instead.

+

httpHeaders

+

Array of io.cci.otc.api.pkg.apis.versioned.cci.v2.HTTPHeader objects

+

Custom headers to set in the request. HTTP allows repeated headers.

+

path

+

String

+

Path to access on the HTTP server.

+

port

+

String

+

Name or number of the port to access on the container. Number

+

must be in the range 1 to 65535. Name must be an IANA_SVC_NAME.

+

scheme

+

String

+

Scheme to use for connecting to the host. Defaults to HTTP.

+

Possible enum values:

+
  • "HTTP" means that the scheme used will be http://
  • "HTTPS" means that the scheme used will be https://
+
+
+ +
+ + + + + + + + + + + + + +
Table 254 io.cci.otc.api.pkg.apis.versioned.cci.v2.HTTPHeader

Parameter

+

Type

+

Description

+

name

+

String

+

The header field name

+

value

+

String

+

The header field value

+
+
+ +
+ + + + + + + + + + + + + +
Table 255 io.cci.otc.api.pkg.apis.versioned.cci.v2.TCPSocketAction

Parameter

+

Type

+

Description

+

host

+

String

+

Optional: Host name to connect to, defaults to the pod IP.

+

port

+

String

+

Number or name of the port to access on the container. Number

+

must be in the range 1 to 65535. Name must be an IANA_SVC_NAME.

+
+
+ +
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Table 256 io.cci.otc.api.pkg.apis.versioned.cci.v2.VolumeMount

Parameter

+

Type

+

Description

+

extendPathMode

+

String

+

Extend the volume path by appending the pod metadata to the path

+

according to specified pattern. which provide a way of directory isolation

+

and help prevent the writing conflict between different pods.

+

mountPath

+

String

+

Path within the container at which the volume should be mounted. Must

+

not contain ':'.

+

name

+

String

+

This must match the Name of a Volume.

+

readOnly

+

Boolean

+

Mounted read-only if true, read-write otherwise (false or unspecified).

+

Defaults to false.

+

subPath

+

String

+

Path within the volume from which the container's volume should

+

be mounted. Defaults to "" (volume's root).

+

subPathExpr

+

String

+

Expanded path within the volume from which the container's volume

+

should be mounted. Behaves similarly to SubPath but environment variable

+

references $(VAR_NAME) are expanded using the container's environment. Defaults

+

to "" (volume's root). SubPathExpr and SubPath are mutually exclusive.

+
+
+ +
+ + + + + + + + + +
Table 257 io.cci.otc.api.pkg.apis.versioned.cci.v2.PodReadinessGate

Parameter

+

Type

+

Description

+

conditionType

+

String

+

ConditionType refers to a condition in the pod's condition list

+

with matching type.

+
+
+ +
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Table 258 io.cci.otc.api.pkg.apis.versioned.cci.v2.PodSecurityContext

Parameter

+

Type

+

Description

+

fsGroup

+

Long

+

A special supplemental group that applies to all containers in a pod. Some volume types allow the Kubelet to change the ownership of that volume to be owned by the pod:

+
  1. The owning GID will be the FSGroup 2. The setgid bit is set (new files created in the volume will be owned by FSGroup) 3. The permission bits are OR'd with rw-rw----
+

If unset, the Kubelet will not modify the ownership and permissions of any volume. Note that this field cannot be set when spec.os.name is windows.

+

fsGroupChangePolicy

+

String

+

fsGroupChangePolicy defines behavior of changing ownership and permission of the volume before being exposed inside Pod. This field will only apply to volume types which support fsGroup based ownership(and permissions). It will have no effect on ephemeral volume types such as: secret, configmaps and emptydir. Valid values are "OnRootMismatch" and "Always". If not specified, "Always" is used. Note that this field cannot be set when spec.os.name is windows.

+

runAsGroup

+

Long

+

The GID to run the entrypoint of the container process. Uses

+

runtime default if unset. May also be set in SecurityContext. If set in

+

both SecurityContext and PodSecurityContext, the value specified in SecurityContext

+

takes precedence for that container. Note that this field cannot be set

+

when spec.os.name is windows.

+

runAsNonRoot

+

Boolean

+

Indicates that the container must run as a non-root user. If

+

true, the Kubelet will validate the image at runtime to ensure that it does

+

not run as UID 0 (root) and fail to start the container if it does. If unset

+

or false, no such validation will be performed. May also be set in SecurityContext. If

+

set in both SecurityContext and PodSecurityContext, the value specified

+

in SecurityContext takes precedence.

+

runAsUser

+

Long

+

The UID to run the entrypoint of the container process. Defaults

+

to user specified in image metadata if unspecified. May also be set in SecurityContext. If

+

set in both SecurityContext and PodSecurityContext, the value specified

+

in SecurityContext takes precedence for that container. Note that this field

+

cannot be set when spec.os.name is windows.

+

supplementalGroups

+

Array of longs

+

A list of groups applied to the first process run in each container,

+

in addition to the container's primary GID. If unspecified, no groups will

+

be added to any container. Note that this field cannot be set when spec.os.name

+

is windows.

+

sysctls

+

Array of io.cci.otc.api.pkg.apis.versioned.cci.v2.Sysctl objects

+

Sysctls hold a list of namespaced sysctls used for the pod. Pods

+

with unsupported sysctls (by the container runtime) might fail to launch.

+

Note that this field cannot be set when spec.os.name is windows.

+
+
+ +
+ + + + + + + + + + + + + +
Table 259 io.cci.otc.api.pkg.apis.versioned.cci.v2.Sysctl

Parameter

+

Type

+

Description

+

name

+

String

+

Name of a property to set

+

value

+

String

+

Value of a property to set

+
+
+ +
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Table 260 io.cci.otc.api.pkg.apis.versioned.cci.v2.TopologySpreadConstraint

Parameter

+

Type

+

Description

+

labelSelector

+

io.k8s.apimachinery.pkg.apis.meta.v1.LabelSelector object

+

LabelSelector is used to find matching pods. Pods that match

+

this label selector are counted to determine the number of pods in their

+

corresponding topology domain.

+

matchLabelKeys

+

Array of strings

+

MatchLabelKeys is a set of pod label keys to select the pods

+

over which spreading will be calculated. The keys are used to lookup values

+

from the incoming pod labels, those key-value labels are ANDed with labelSelector

+

to select the group of existing pods over which spreading will be calculated

+

for the incoming pod. Keys that don't exist in the incoming pod labels will

+

be ignored. A null or empty list means only match against labelSelector.

+

maxSkew

+

Integer

+

MaxSkew describes the degree to which pods may be unevenly distributed. When whenUnsatisfiable=DoNotSchedule, it is the maximum permitted difference between the number of matching pods in the target topology and the global minimum. The global minimum is the minimum number of matching pods in an eligible domain or zero if the number of eligible domains is less than MinDomains. For example, in a 3-zone cluster, MaxSkew is set to 1, and pods with the same labelSelector spread as 2/2/1: In this case, the global minimum is 1. | zone1 | zone2 | zone3 | | P P | P P | P | - if MaxSkew is 1, incoming pod can only be scheduled to zone3 to become 2/2/2; scheduling it onto zone1(zone2) would make the ActualSkew(3-1) on zone1(zone2) violate MaxSkew(1). - if MaxSkew is 2, incoming pod can be scheduled onto any zone. When whenUnsatisfiable=ScheduleAnyway, it is used to give higher precedence to topologies that satisfy it. It's a required field. Default value is 1 and 0 is not allowed.

+

minDomains

+

Integer

+

MinDomains indicates a minimum number of eligible domains. When the number of eligible domains with matching topology keys is less than minDomains, Pod Topology Spread treats "global minimum" as 0, and then the calculation of Skew is performed. And when the number of eligible domains with matching topology keys equals or greater than minDomains, this value has no effect on scheduling. As a result, when the number of eligible domains is less than minDomains, scheduler won't schedule more than maxSkew Pods to those domains. If value is nil, the constraint behaves as if MinDomains is equal to 1. Valid values are integers greater than 0. When value is not nil, WhenUnsatisfiable must be DoNotSchedule.

+

For example, in a 3-zone cluster, MaxSkew is set to 2, MinDomains is set to 5 and pods with the same labelSelector spread as 2/2/2: | zone1 | zone2 | zone3 | | P P | P P | P P | The number of domains is less than 5(MinDomains), so "global minimum" is treated as 0. In this situation, new pod with the same labelSelector cannot be scheduled, because computed skew will be 3(3 - 0) if new Pod is scheduled to any of the three zones, it will violate MaxSkew.

+

This is a beta field and requires the MinDomainsInPodTopologySpread feature gate to be enabled (enabled by default).

+

nodeAffinityPolicy

+

String

+

NodeAffinityPolicy indicates how we will treat Pod's nodeAffinity/nodeSelector when calculating pod topology spread skew. Options are: - Honor: only nodes matching nodeAffinity/nodeSelector are included in the calculations. - Ignore: nodeAffinity/nodeSelector are ignored. All nodes are included in the calculations.

+

If this value is nil, the behavior is equivalent to the Honor policy. This is a alpha-level feature enabled by the NodeInclusionPolicyInPodTopologySpread feature flag.

+

nodeTaintsPolicy

+

String

+

NodeTaintsPolicy indicates how we will treat node taints when calculating pod topology spread skew. Options are: - Honor: nodes without taints, along with tainted nodes for which the incoming pod has a toleration, are included. - Ignore: node taints are ignored. All nodes are included.

+

If this value is nil, the behavior is equivalent to the Ignore policy. This is a alpha-level feature enabled by the NodeInclusionPolicyInPodTopologySpread feature flag.

+

topologyKey

+

String

+

TopologyKey is the key of node labels. Nodes that have a label

+

with this key and identical values are considered to be in the same topology.

+

We consider each <key, value> as a "bucket", and try to put balanced number

+

of pods into each bucket. We define a domain as a particular instance of

+

a topology. Also, we define an eligible domain as a domain whose nodes meet

+

the requirements of nodeAffinityPolicy and nodeTaintsPolicy. e.g. If TopologyKey

+

is "kubernetes.io/hostname", each Node is a domain of that topology. And,

+

if TopologyKey is "topology.kubernetes.io/zone", each zone is a domain of

+

that topology. It's a required field.

+

whenUnsatisfiable

+

String

+

WhenUnsatisfiable indicates how to deal with a pod if it doesn't satisfy the spread constraint. - DoNotSchedule (default) tells the scheduler not to schedule it. - ScheduleAnyway tells the scheduler to schedule the pod in any location,

+

but giving higher precedence to topologies that would help reduce the

+

skew.

+

A constraint is considered "Unsatisfiable" for an incoming pod if and only if every possible node assignment for that pod would violate "MaxSkew" on some topology. For example, in a 3-zone cluster, MaxSkew is set to 1, and pods with the same labelSelector spread as 3/1/1: | zone1 | zone2 | zone3 | | P P P | P | P | If WhenUnsatisfiable is set to DoNotSchedule, incoming pod can only be scheduled to zone2(zone3) to become 3/2/1(3/1/2) as ActualSkew(2-1) on zone2(zone3) satisfies MaxSkew(1). In other words, the cluster can still be imbalanced, but scheduler won't make it more imbalanced. It's a required field.

+

Possible enum values:

+
  • "DoNotSchedule" instructs the scheduler not to schedule the pod when constraints are not satisfied.
  • "ScheduleAnyway" instructs the scheduler to schedule the pod even if constraints are not satisfied.
+
+
+ +
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Table 261 io.cci.otc.api.pkg.apis.versioned.cci.v2.Volume

Parameter

+

Type

+

Description

+

configMap

+

io.cci.otc.api.pkg.apis.versioned.cci.v2.ConfigMapVolumeSource object

+

configMap represents a configMap that should populate this volume

+

downwardAPI

+

io.cci.otc.api.pkg.apis.versioned.cci.v2.DownwardAPIVolumeSource object

+

downwardAPI represents downward API about the pod that should

+

populate this volume

+

emptyDir

+

io.cci.otc.api.pkg.apis.versioned.cci.v2.EmptyDirVolumeSource object

+

emptyDir represents a temporary directory that shares a pod's lifetime. More info: https://kubernetes.io/docs/concepts/storage/volumes#emptydir

+

ephemeral

+

io.cci.otc.api.pkg.apis.versioned.cci.v2.EphemeralVolumeSource object

+

ephemeral represents a volume that is handled by a cluster storage driver. The volume's lifecycle is tied to the pod that defines it - it will be created before the pod starts, and deleted when the pod is removed.

+

Use this if: a) the volume is only needed while the pod runs, b) features of normal volumes like restoring from snapshot or capacity

+

tracking are needed,

+

c) the storage driver is specified through a storage class, and d) the storage driver supports dynamic volume provisioning through

+

a PersistentVolumeClaim (see EphemeralVolumeSource for more

+

information on the connection between this volume type

+

and PersistentVolumeClaim).

+

Use PersistentVolumeClaim or one of the vendor-specific APIs for volumes that persist for longer than the lifecycle of an individual pod.

+

Use CSI for light-weight local ephemeral volumes if the CSI driver is meant to be used that way - see the documentation of the driver for more information.

+

A pod can use both types of ephemeral volumes and persistent volumes at the same time.

+

name

+

String

+

name of the volume. Must be a DNS_LABEL and unique within the pod. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names

+

nfs

+

io.cci.otc.api.pkg.apis.versioned.cci.v2.NFSVolumeSource object

+

nfs represents an NFS mount on the host that shares a pod's lifetime More info: https://kubernetes.io/docs/concepts/storage/volumes#nfs

+

persistentVolumeClaim

+

io.cci.otc.api.pkg.apis.versioned.cci.v2.PersistentVolumeClaimVolumeSource object

+

persistentVolumeClaimVolumeSource represents a reference to a PersistentVolumeClaim in the same namespace. More info: https://kubernetes.io/docs/concepts/storage/persistent-volumes#persistentvolumeclaims

+

projected

+

io.cci.otc.api.pkg.apis.versioned.cci.v2.ProjectedVolumeSource object

+

projected items for all in one resources secrets, configmaps,

+

and downward API

+

secret

+

io.cci.otc.api.pkg.apis.versioned.cci.v2.SecretVolumeSource object

+

secret represents a secret that should populate this volume. More info: https://kubernetes.io/docs/concepts/storage/volumes#secret

+
+
+ +
+ + + + + + + + + + + + + + + + + + + + + +
Table 262 io.cci.otc.api.pkg.apis.versioned.cci.v2.ConfigMapVolumeSource

Parameter

+

Type

+

Description

+

defaultMode

+

Integer

+

defaultMode is optional: mode bits used to set permissions on created files by default. Must be an octal value between 0000 and 0777 or a decimal value between 0 and 511. YAML accepts both octal and decimal values, JSON requires decimal values for mode bits. Defaults to 0644. Directories within the path are not affected by this setting. This might be in conflict with other options that affect the file mode, like fsGroup, and the result can be other mode bits set.

+

items

+

Array of io.cci.otc.api.pkg.apis.versioned.cci.v2.KeyToPath objects

+

items if unspecified, each key-value pair in the Data field of

+

the referenced ConfigMap will be projected into the volume as a file whose

+

name is the key and content is the value. If specified, the listed keys

+

will be projected into the specified paths, and unlisted keys will not be

+

present. If a key is specified which is not present in the ConfigMap, the

+

volume setup will error unless it is marked optional. Paths must be relative

+

and may not contain the '..' path or start with '..'.

+

name

+

String

+

Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names

+

optional

+

Boolean

+

optional specify whether the ConfigMap or its keys must be defined

+
+
+ +
+ + + + + + + + + + + + + +
Table 263 io.cci.otc.api.pkg.apis.versioned.cci.v2.DownwardAPIVolumeSource

Parameter

+

Type

+

Description

+

defaultMode

+

Integer

+

Optional: mode bits to use on created files by default. Must be a Optional: mode bits used to set permissions on created files by default. Must be an octal value between 0000 and 0777 or a decimal value between 0 and 511. YAML accepts both octal and decimal values, JSON requires decimal values for mode bits. Defaults to 0644. Directories within the path are not affected by this setting. This might be in conflict with other options that affect the file mode, like fsGroup, and the result can be other mode bits set.

+

items

+

Array of io.cci.otc.api.pkg.apis.versioned.cci.v2.DownwardAPIVolumeFile objects

+

Items is a list of downward API volume file

+
+
+ +
+ + + + + + + + + + + + + +
Table 264 io.cci.otc.api.pkg.apis.versioned.cci.v2.EmptyDirVolumeSource

Parameter

+

Type

+

Description

+

medium

+

String

+

medium represents what type of storage medium should back this directory. The default is "" which means to use the node's default medium. Must be an empty string (default) or Memory. More info: https://kubernetes.io/docs/concepts/storage/volumes#emptydir

+

sizeLimit

+

String

+

sizeLimit is the total amount of local storage required for this EmptyDir volume. The size limit is also applicable for memory medium. The maximum usage on memory medium EmptyDir would be the minimum value between the SizeLimit specified here and the sum of memory limits of all containers in a pod. The default is nil which means that the limit is undefined. More info: http://kubernetes.io/docs/user-guide/volumes#emptydir

+
+
+ +
+ + + + + + + + + +
Table 265 io.cci.otc.api.pkg.apis.versioned.cci.v2.EphemeralVolumeSource

Parameter

+

Type

+

Description

+

volumeClaimTemplate

+

io.cci.otc.api.pkg.apis.versioned.cci.v2.PersistentVolumeClaimTemplate object

+

Will be used to create a stand-alone PVC to provision the volume. The pod in which this EphemeralVolumeSource is embedded will be the owner of the PVC, i.e. the PVC will be deleted together with the pod. The name of the PVC will be <pod name>-<volume name> where <volume name> is the name from the PodSpec.Volumes array entry. Pod validation will reject the pod if the concatenated name is not valid for a PVC (for example, too long).

+

An existing PVC with that name that is not owned by the pod will not be used for the pod to avoid using an unrelated volume by mistake. Starting the pod is then blocked until the unrelated PVC is removed. If such a pre-created PVC is meant to be used by the pod, the PVC has to updated with an owner reference to the pod once the pod exists. Normally this should not be necessary, but it may be useful when manually reconstructing a broken cluster.

+

This field is read-only and no changes will be made by Kubernetes to the PVC after it has been created.

+

Required, must not be nil.

+
+
+ +
+ + + + + + + + + + + + + +
Table 266 io.cci.otc.api.pkg.apis.versioned.cci.v2.PersistentVolumeClaimTemplate

Parameter

+

Type

+

Description

+

metadata

+

io.k8s.apimachinery.pkg.apis.meta.v1.ObjectMeta object

+

May contain labels and annotations that will be copied into the

+

PVC when creating it. No other fields are allowed and will be rejected during

+

validation.

+

spec

+

io.cci.otc.api.pkg.apis.versioned.cci.v2.PersistentVolumeClaimSpec object

+

The specification for the PersistentVolumeClaim. The entire content

+

is copied unchanged into the PVC that gets created from this template. The

+

same fields as in a PersistentVolumeClaim are also valid here.

+
+
+ +
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Table 267 io.k8s.apimachinery.pkg.apis.meta.v1.ObjectMeta

Parameter

+

Type

+

Description

+

annotations

+

Map<String,String>

+

Annotations is an unstructured key value map stored with a resource that may be set by external tools to store and retrieve arbitrary metadata. They are not queryable and should be preserved when modifying objects. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/annotations/

+

clusterName

+

String

+

The name of the cluster which the object belongs to. This is

+

used to distinguish resources with same name and namespace in different

+

clusters. This field is not set anywhere right now and apiserver is going

+

to ignore it if set in create or update request.

+

creationTimestamp

+

String

+

CreationTimestamp is a timestamp representing the server time when this object was created. It is not guaranteed to be set in happens-before order across separate operations. Clients may not set this value. It is represented in RFC3339 form and is in UTC.

+

Populated by the system. Read-only. Null for lists. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata

+

deletionGracePeriodSeconds

+

Long

+

Number of seconds allowed for this object to gracefully terminate

+

before it will be removed from the system. Only set when deletionTimestamp

+

is also set. May only be shortened. Read-only.

+

deletionTimestamp

+

String

+

DeletionTimestamp is RFC 3339 date and time at which this resource will be deleted. This field is set by the server when a graceful deletion is requested by the user, and is not directly settable by a client. The resource is expected to be deleted (no longer visible from resource lists, and not reachable by name) after the time in this field, once the finalizers list is empty. As long as the finalizers list contains items, deletion is blocked. Once the deletionTimestamp is set, this value may not be unset or be set further into the future, although it may be shortened or the resource may be deleted prior to this time. For example, a user may request that a pod is deleted in 30 seconds. The Kubelet will react by sending a graceful termination signal to the containers in the pod. After that 30 seconds, the Kubelet will send a hard termination signal (SIGKILL) to the container and after cleanup, remove the pod from the API. In the presence of network partitions, this object may still exist after this timestamp, until an administrator or automated process can determine the resource is fully terminated. If not set, graceful deletion of the object has not been requested.

+

Populated by the system when a graceful deletion is requested. Read-only. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata

+

enable

+

Boolean

+

Enable identifies whether the resource is available

+

finalizers

+

Array of strings

+

Must be empty before the object is deleted from the registry.

+

Each entry is an identifier for the responsible component that will remove

+

the entry from the list. If the deletionTimestamp of the object is non-nil,

+

entries in this list can only be removed. Finalizers may be processed and

+

removed in any order. Order is NOT enforced because it introduces significant

+

risk of stuck finalizers. finalizers is a shared field, any actor with permission

+

can reorder it. If the finalizer list is processed in order, then this can

+

lead to a situation in which the component responsible for the first finalizer

+

in the list is waiting for a signal (field value, external system, or other)

+

produced by a component responsible for a finalizer later in the list, resulting

+

in a deadlock. Without enforced ordering finalizers are free to order amongst

+

themselves and are not vulnerable to ordering changes in the list.

+

generateName

+

String

+

GenerateName is an optional prefix, used by the server, to generate a unique name ONLY IF the Name field has not been provided. If this field is used, the name returned to the client will be different than the name passed. This value will also be combined with a unique suffix. The provided value has the same validation rules as the Name field, and may be truncated by the length of the suffix required to make the value unique on the server.

+

If this field is specified and the generated name exists, the server will NOT return a 409 - instead, it will either return 201 Created or 500 with Reason ServerTimeout indicating a unique name could not be found in the time allotted, and the client should retry (optionally after the time indicated in the Retry-After header).

+

Applied only if Name is not specified. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#idempotency

+

generation

+

Long

+

A sequence number representing a specific generation of the desired

+

state. Populated by the system. Read-only.

+

labels

+

Map<String,String>

+

Map of string keys and values that can be used to organize and categorize (scope and select) objects. May match selectors of replication controllers and services. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/labels/

+

managedFields

+

Array of io.k8s.apimachinery.pkg.apis.meta.v1.ManagedFieldsEntry objects

+

ManagedFields maps workflow-id and version to the set of fields

+

that are managed by that workflow. This is mostly for internal housekeeping,

+

and users typically shouldn't need to set or understand this field. A workflow

+

can be the user's name, a controller's name, or the name of a specific apply

+

path like "ci-cd". The set of fields is always in the version that the workflow

+

used when modifying the object.

+

name

+

String

+

Name must be unique within a namespace. Is required when creating resources, although some resources may allow a client to request the generation of an appropriate name automatically. Name is primarily intended for creation idempotence and configuration definition. Cannot be updated. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names

+

namespace

+

String

+

Namespace defines the space within which each name must be unique. An empty namespace is equivalent to the "default" namespace, but "default" is the canonical representation. Not all objects are required to be scoped to a namespace - the value of this field for those objects will be empty.

+

Must be a DNS_LABEL. Cannot be updated. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/namespaces/

+

ownerReferences

+

Array of io.k8s.apimachinery.pkg.apis.meta.v1.OwnerReference objects

+

List of objects depended by this object. If ALL objects in the

+

list have been deleted, this object will be garbage collected. If this object

+

is managed by a controller, then an entry in this list will point to this

+

controller, with the controller field set to true. There cannot be more

+

than one managing controller.

+

resourceVersion

+

String

+

An opaque value that represents the internal version of this object that can be used by clients to determine when objects have changed. May be used for optimistic concurrency, change detection, and the watch operation on a resource or set of resources. Clients must treat these values as opaque and passed unmodified back to the server. They may only be valid for a particular resource or set of resources.

+

Populated by the system. Read-only. Value must be treated as opaque by clients and . More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#concurrency-control-and-consistency

+

selfLink

+

String

+

SelfLink is a URL representing this object. Populated by the system. Read-only.

+

DEPRECATED Kubernetes will stop propagating this field in 1.20 release and the field is planned to be removed in 1.21 release.

+

uid

+

String

+

UID is the unique in time and space value for this object. It is typically generated by the server on successful creation of a resource and is not allowed to change on PUT operations.

+

Populated by the system. Read-only. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#uids

+
+
+ +
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Table 268 io.k8s.apimachinery.pkg.apis.meta.v1.ManagedFieldsEntry

Parameter

+

Type

+

Description

+

apiVersion

+

String

+

APIVersion defines the version of this resource that this field

+

set applies to. The format is "group/version" just like the top-level APIVersion

+

field. It is necessary to track the version of a field set because it cannot

+

be automatically converted.

+

fieldsType

+

String

+

FieldsType is the discriminator for the different fields format and version. There is currently only one possible value: "FieldsV1"

+

fieldsV1

+

Object

+

FieldsV1 holds the first JSON version format as described in

+

the "FieldsV1" type.

+

manager

+

String

+

Manager is an identifier of the workflow managing these fields.

+

operation

+

String

+

Operation is the type of operation which lead to this ManagedFieldsEntry

+

being created. The only valid values for this field are 'Apply' and 'Update'.

+

time

+

String

+

Time is timestamp of when these fields were set. It should always

+

be empty if Operation is 'Apply'

+
+
+ +
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Table 269 io.k8s.apimachinery.pkg.apis.meta.v1.OwnerReference

Parameter

+

Type

+

Description

+

apiVersion

+

String

+

API version of the referent.

+

blockOwnerDeletion

+

Boolean

+

If true, AND if the owner has the "foregroundDeletion" finalizer,

+

then the owner cannot be deleted from the key-value store until this reference

+

is removed. Defaults to false. To set this field, a user needs "delete"

+

permission of the owner, otherwise 422 (Unprocessable Entity) will be returned.

+

controller

+

Boolean

+

If true, this reference points to the managing controller.

+

kind

+

String

+

Kind of the referent. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds

+

name

+

String

+

Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names

+

uid

+

String

+

UID of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#uids

+
+
+ +
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Table 270 io.cci.otc.api.pkg.apis.versioned.cci.v2.PersistentVolumeClaimSpec

Parameter

+

Type

+

Description

+

accessModes

+

Array of strings

+

accessModes contains the desired access modes the volume should have. More info: https://kubernetes.io/docs/concepts/storage/persistent-volumes#access-modes-1

+

dataSource

+

io.cci.otc.api.pkg.apis.versioned.cci.v2.TypedLocalObjectReference object

+

dataSource field can be used to specify either: * An existing VolumeSnapshot object (snapshot.storage.k8s.io/VolumeSnapshot) * An existing PVC (PersistentVolumeClaim) If the provisioner or an external controller can support the specified data source, it will create a new volume based on the contents of the specified data source. If the AnyVolumeDataSource feature gate is enabled, this field will always have the same contents as the DataSourceRef field.

+

dataSourceRef

+

io.cci.otc.api.pkg.apis.versioned.cci.v2.TypedLocalObjectReference object

+

dataSourceRef specifies the object from which to populate the volume with data, if a non-empty volume is desired. This may be any local object from a non-empty API group (non core object) or a PersistentVolumeClaim object. When this field is specified, volume binding will only succeed if the type of the specified object matches some installed volume populator or dynamic provisioner. This field will replace the functionality of the DataSource field and as such if both fields are non-empty, they must have the same value. For backwards compatibility, both fields (DataSource and DataSourceRef) will be set to the same value automatically if one of them is empty and the other is non-empty. There are two important differences between DataSource and DataSourceRef: * While DataSource only allows two specific types of objects, DataSourceRef

+

allows any non-core object, as well as PersistentVolumeClaim objects.

+
  • While DataSource ignores disallowed values (dropping them), DataSourceRef

    preserves all values, and generates an error if a disallowed value is

    +

    specified.

    +

    (Beta) Using this field requires the AnyVolumeDataSource feature gate to be enabled.

    +
+

resources

+

io.cci.otc.api.pkg.apis.versioned.cci.v2.ResourceRequirements object

+

resources represents the minimum resources the volume should have. If RecoverVolumeExpansionFailure feature is enabled users are allowed to specify resource requirements that are lower than previous value but must still be higher than capacity recorded in the status field of the claim. More info: https://kubernetes.io/docs/concepts/storage/persistent-volumes#resources

+

selector

+

io.k8s.apimachinery.pkg.apis.meta.v1.LabelSelector object

+

selector is a label query over volumes to consider for binding.

+

storageClassName

+

String

+

storageClassName is the name of the StorageClass required by the claim. More info: https://kubernetes.io/docs/concepts/storage/persistent-volumes#class-1

+

volumeMode

+

String

+

volumeMode defines what type of volume is required by the claim.

+

Value of Filesystem is implied when not included in claim spec.

+

volumeName

+

String

+

volumeName is the binding reference to the PersistentVolume backing

+

this claim.

+
+
+ +
+ + + + + + + + + + + + + + + + + +
Table 271 io.cci.otc.api.pkg.apis.versioned.cci.v2.TypedLocalObjectReference

Parameter

+

Type

+

Description

+

apiGroup

+

String

+

APIGroup is the group for the resource being referenced. If APIGroup

+

is not specified, the specified Kind must be in the core API group. For

+

any other third-party types, APIGroup is required.

+

kind

+

String

+

Kind is the type of resource being referenced

+

name

+

String

+

Name is the name of resource being referenced

+
+
+ +
+ + + + + + + + + + + + + +
Table 272 io.cci.otc.api.pkg.apis.versioned.cci.v2.ResourceRequirements

Parameter

+

Type

+

Description

+

limits

+

Map<String,String>

+

Limits describes the maximum amount of compute resources allowed. More info: https://kubernetes.io/docs/concepts/configuration/manage-resources-containers/

+

requests

+

Map<String,String>

+

Requests describes the minimum amount of compute resources required. If Requests is omitted for a container, it defaults to Limits if that is explicitly specified, otherwise to an implementation-defined value. More info: https://kubernetes.io/docs/concepts/configuration/manage-resources-containers/

+
+
+ +
+ + + + + + + + + +
Table 273 io.k8s.apimachinery.pkg.api.resource.Quantity

Parameter

+

Type

+

Description

+

-

+

String

+

Quantity is a fixed-point representation of a number. It provides convenient marshaling/unmarshaling in JSON and YAML, in addition to String() and AsInt64() accessors.

+

The serialization format is:

+

[/topic/body/section/table/tgroup/tbody/row/entry/p/br {""})(br] ::= [/topic/body/section/table/tgroup/tbody/row/entry/p/br {""})(br][/topic/body/section/table/tgroup/tbody/row/entry/p/br {""})(br]

+

(Note that [/topic/body/section/table/tgroup/tbody/row/entry/p/br {""})(br] may be empty, from the "" case in [/topic/body/section/table/tgroup/tbody/row/entry/p/br {""})(br].)

+

[/topic/body/section/table/tgroup/tbody/row/entry/p/br {""})(br] ::= 0 | 1 | ... | 9 [/topic/body/section/table/tgroup/tbody/row/entry/p/br {""})(br] ::= [/topic/body/section/table/tgroup/tbody/row/entry/p/br {""})(br] | [/topic/body/section/table/tgroup/tbody/row/entry/p/br {""})(br][/topic/body/section/table/tgroup/tbody/row/entry/p/br {""})(br][/topic/body/section/table/tgroup/tbody/row/entry/p/br {""})(br] ::= [/topic/body/section/table/tgroup/tbody/row/entry/p/br {""})(br] | [/topic/body/section/table/tgroup/tbody/row/entry/p/br {""})(br].[/topic/body/section/table/tgroup/tbody/row/entry/p/br {""})(br] | [/topic/body/section/table/tgroup/tbody/row/entry/p/br {""})(br]. | .[/topic/body/section/table/tgroup/tbody/row/entry/p/br {""})(br][/topic/body/section/table/tgroup/tbody/row/entry/p/br {""})(br] ::= "+" | "-" [/topic/body/section/table/tgroup/tbody/row/entry/p/br {""})(br] ::= [/topic/body/section/table/tgroup/tbody/row/entry/p/br {""})(br] | [/topic/body/section/table/tgroup/tbody/row/entry/p/br {""})(br][/topic/body/section/table/tgroup/tbody/row/entry/p/br {""})(br][/topic/body/section/table/tgroup/tbody/row/entry/p/br {""})(br] ::= [/topic/body/section/table/tgroup/tbody/row/entry/p/br {""})(br] | [/topic/body/section/table/tgroup/tbody/row/entry/p/br {""})(br] | [/topic/body/section/table/tgroup/tbody/row/entry/p/br {""})(br][/topic/body/section/table/tgroup/tbody/row/entry/p/br {""})(br] ::= Ki | Mi | Gi | Ti | Pi | Ei

+

(International System of units; See: http://physics.nist.gov/cuu/Units/binary.html)

+

[/topic/body/section/table/tgroup/tbody/row/entry/p/br {""})(br] ::= m | "" | k | M | G | T | P | E

+

(Note that 1024 = 1Ki but 1000 = 1k; I didn't choose the capitalization.)

+

[/topic/body/section/table/tgroup/tbody/row/entry/p/br {""})(br] ::= "e" [/topic/body/section/table/tgroup/tbody/row/entry/p/br {""})(br] | "E" [/topic/body/section/table/tgroup/tbody/row/entry/p/br {""})(br]

+

No matter which of the three exponent forms is used, no quantity may represent a number greater than 2^63-1 in magnitude, nor may it have more than 3 decimal places. Numbers larger or more precise will be capped or rounded up. (E.g.: 0.1m will rounded up to 1m.) This may be extended in the future if we require larger or smaller quantities.

+

When a Quantity is parsed from a string, it will remember the type of suffix it had, and will use the same type again when it is serialized.

+

Before serializing, Quantity will be put in "canonical form". This means that Exponent/suffix will be adjusted up or down (with a corresponding increase or decrease in Mantissa) such that:

+

a. No precision is lost

+

b. No fractional digits will be emitted

+

c. The exponent (or suffix) is as large as possible.

+

The sign will be omitted unless the number is negative.

+

Examples:

+

1.5 will be serialized as "1500m"

+

1.5Gi will be serialized as "1536Mi"

+

Note that the quantity will NEVER be internally represented by a floating point number. That is the whole point of this exercise.

+

Non-canonical values will still parse as long as they are well formed, but will be re-emitted in their canonical form. (So always use canonical form, or don't diff.)

+

This format is intended to make it difficult to use these numbers without writing some sort of special handling code in the hopes that that will cause implementors to also use a fixed point implementation.

+
+
+ +
+ + + + + + + + + + + + + +
Table 274 io.k8s.apimachinery.pkg.apis.meta.v1.LabelSelector

Parameter

+

Type

+

Description

+

matchExpressions

+

Array of io.k8s.apimachinery.pkg.apis.meta.v1.LabelSelectorRequirement objects

+

matchExpressions is a list of label selector requirements. The

+

requirements are ANDed.

+

matchLabels

+

Map<String,String>

+

matchLabels is a map of {key,value} pairs. A single {key,value}

+

in the matchLabels map is equivalent to an element of matchExpressions,

+

whose key field is "key", the operator is "In", and the values array contains

+

only "value". The requirements are ANDed.

+
+
+ +
+ + + + + + + + + + + + + + + + + +
Table 275 io.k8s.apimachinery.pkg.apis.meta.v1.LabelSelectorRequirement

Parameter

+

Type

+

Description

+

key

+

String

+

key is the label key that the selector applies to.

+

operator

+

String

+

operator represents a key's relationship to a set of values.

+

Valid operators are In, NotIn, Exists and DoesNotExist.

+

values

+

Array of strings

+

values is an array of string values. If the operator is In or

+

NotIn, the values array must be non-empty. If the operator is Exists or

+

DoesNotExist, the values array must be empty. This array is replaced during

+

a strategic merge patch.

+
+
+ +
+ + + + + + + + + + + + + + + + + +
Table 276 io.cci.otc.api.pkg.apis.versioned.cci.v2.NFSVolumeSource

Parameter

+

Type

+

Description

+

path

+

String

+

path that is exported by the NFS server. More info: https://kubernetes.io/docs/concepts/storage/volumes#nfs

+

readOnly

+

Boolean

+

readOnly here will force the NFS export to be mounted with read-only permissions. Defaults to false. More info: https://kubernetes.io/docs/concepts/storage/volumes#nfs

+

server

+

String

+

server is the hostname or IP address of the NFS server. More info: https://kubernetes.io/docs/concepts/storage/volumes#nfs

+
+
+ +
+ + + + + + + + + + + + + +
Table 277 io.cci.otc.api.pkg.apis.versioned.cci.v2.PersistentVolumeClaimVolumeSource

Parameter

+

Type

+

Description

+

claimName

+

String

+

claimName is the name of a PersistentVolumeClaim in the same namespace as the pod using this volume. More info: https://kubernetes.io/docs/concepts/storage/persistent-volumes#persistentvolumeclaims

+

readOnly

+

Boolean

+

readOnly Will force the ReadOnly setting in VolumeMounts. Default

+

false.

+
+
+ +
+ + + + + + + + + + + + + +
Table 278 io.cci.otc.api.pkg.apis.versioned.cci.v2.ProjectedVolumeSource

Parameter

+

Type

+

Description

+

defaultMode

+

Integer

+

defaultMode are the mode bits used to set permissions on created

+

files by default. Must be an octal value between 0000 and 0777 or a decimal

+

value between 0 and 511. YAML accepts both octal and decimal values, JSON

+

requires decimal values for mode bits. Directories within the path are not

+

affected by this setting. This might be in conflict with other options that

+

affect the file mode, like fsGroup, and the result can be other mode bits

+

set.

+

sources

+

Array of io.cci.otc.api.pkg.apis.versioned.cci.v2.VolumeProjection objects

+

sources is the list of volume projections

+
+
+ +
+ + + + + + + + + + + + + + + + + +
Table 279 io.cci.otc.api.pkg.apis.versioned.cci.v2.VolumeProjection

Parameter

+

Type

+

Description

+

configMap

+

io.cci.otc.api.pkg.apis.versioned.cci.v2.ConfigMapProjection object

+

configMap information about the configMap data to project

+

downwardAPI

+

io.cci.otc.api.pkg.apis.versioned.cci.v2.DownwardAPIProjection object

+

downwardAPI information about the downwardAPI data to project

+

secret

+

io.cci.otc.api.pkg.apis.versioned.cci.v2.SecretProjection object

+

secret information about the secret data to project

+
+
+ +
+ + + + + + + + + + + + + + + + + +
Table 280 io.cci.otc.api.pkg.apis.versioned.cci.v2.ConfigMapProjection

Parameter

+

Type

+

Description

+

items

+

Array of io.cci.otc.api.pkg.apis.versioned.cci.v2.KeyToPath objects

+

items if unspecified, each key-value pair in the Data field of

+

the referenced ConfigMap will be projected into the volume as a file whose

+

name is the key and content is the value. If specified, the listed keys

+

will be projected into the specified paths, and unlisted keys will not be

+

present. If a key is specified which is not present in the ConfigMap, the

+

volume setup will error unless it is marked optional. Paths must be relative

+

and may not contain the '..' path or start with '..'.

+

name

+

String

+

Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names

+

optional

+

Boolean

+

optional specify whether the ConfigMap or its keys must be defined

+
+
+ +
+ + + + + + + + + +
Table 281 io.cci.otc.api.pkg.apis.versioned.cci.v2.DownwardAPIProjection

Parameter

+

Type

+

Description

+

items

+

Array of io.cci.otc.api.pkg.apis.versioned.cci.v2.DownwardAPIVolumeFile objects

+

Items is a list of DownwardAPIVolume file

+
+
+ +
+ + + + + + + + + + + + + + + + + + + + + +
Table 282 io.cci.otc.api.pkg.apis.versioned.cci.v2.DownwardAPIVolumeFile

Parameter

+

Type

+

Description

+

fieldRef

+

io.cci.otc.api.pkg.apis.versioned.cci.v2.ObjectFieldSelector object

+

Required: Selects a field of the pod: only annotations, labels, name and namespace are supported.

+

mode

+

Integer

+

Optional: mode bits used to set permissions on this file, must be an octal value between 0000 and 0777 or a decimal value between 0 and 511. YAML accepts both octal and decimal values, JSON requires decimal values for mode bits. If not specified, the volume defaultMode will be used. This might be in conflict with other options that affect the file mode, like fsGroup, and the result can be other mode bits set.

+

path

+

String

+

Required: Path is the relative path name of the file to be created. Must not be absolute or contain the '..' path. Must be utf-8 encoded. The first item of the relative path must not start with '..'

+

resourceFieldRef

+

io.cci.otc.api.pkg.apis.versioned.cci.v2.ResourceFieldSelector object

+

Selects a resource of the container: only resources limits and requests (limits.cpu, limits.memory, requests.cpu and requests.memory) are currently supported.

+
+
+ +
+ + + + + + + + + + + + + +
Table 283 io.cci.otc.api.pkg.apis.versioned.cci.v2.ObjectFieldSelector

Parameter

+

Type

+

Description

+

apiVersion

+

String

+

Version of the schema the FieldPath is written in terms of, defaults

+

to "v1".

+

fieldPath

+

String

+

Path of the field to select in the specified API version.

+
+
+ +
+ + + + + + + + + + + + + + + + + +
Table 284 io.cci.otc.api.pkg.apis.versioned.cci.v2.ResourceFieldSelector

Parameter

+

Type

+

Description

+

containerName

+

String

+

Container name: required for volumes, optional for env vars

+

divisor

+

String

+

Specifies the output format of the exposed resources, defaults

+

to "1"

+

resource

+

String

+

Required: resource to select

+
+
+ +
+ + + + + + + + + + + + + + + + + +
Table 285 io.cci.otc.api.pkg.apis.versioned.cci.v2.SecretProjection

Parameter

+

Type

+

Description

+

items

+

Array of io.cci.otc.api.pkg.apis.versioned.cci.v2.KeyToPath objects

+

items if unspecified, each key-value pair in the Data field of

+

the referenced Secret will be projected into the volume as a file whose

+

name is the key and content is the value. If specified, the listed keys

+

will be projected into the specified paths, and unlisted keys will not be

+

present. If a key is specified which is not present in the Secret, the volume

+

setup will error unless it is marked optional. Paths must be relative and

+

may not contain the '..' path or start with '..'.

+

name

+

String

+

Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names

+

optional

+

Boolean

+

optional field specify whether the Secret or its key must be

+

defined

+
+
+ +
+ + + + + + + + + + + + + + + + + + + + + +
Table 286 io.cci.otc.api.pkg.apis.versioned.cci.v2.SecretVolumeSource

Parameter

+

Type

+

Description

+

defaultMode

+

Integer

+

defaultMode is Optional: mode bits used to set permissions on created files by default. Must be an octal value between 0000 and 0777 or a decimal value between 0 and 511. YAML accepts both octal and decimal values, JSON requires decimal values for mode bits. Defaults to 0644. Directories within the path are not affected by this setting. This might be in conflict with other options that affect the file mode, like fsGroup, and the result can be other mode bits set.

+

items

+

Array of io.cci.otc.api.pkg.apis.versioned.cci.v2.KeyToPath objects

+

items If unspecified, each key-value pair in the Data field of

+

the referenced Secret will be projected into the volume as a file whose

+

name is the key and content is the value. If specified, the listed keys

+

will be projected into the specified paths, and unlisted keys will not be

+

present. If a key is specified which is not present in the Secret, the volume

+

setup will error unless it is marked optional. Paths must be relative and

+

may not contain the '..' path or start with '..'.

+

optional

+

Boolean

+

optional field specify whether the Secret or its keys must be

+

defined

+

secretName

+

String

+

secretName is the name of the secret in the pod's namespace to use. More info: https://kubernetes.io/docs/concepts/storage/volumes#secret

+
+
+ +
+ + + + + + + + + + + + + + + + + +
Table 287 io.cci.otc.api.pkg.apis.versioned.cci.v2.KeyToPath

Parameter

+

Type

+

Description

+

key

+

String

+

key is the key to project.

+

mode

+

Integer

+

mode is Optional: mode bits used to set permissions on this file. Must be an octal value between 0000 and 0777 or a decimal value between 0 and 511. YAML accepts both octal and decimal values, JSON requires decimal values for mode bits. If not specified, the volume defaultMode will be used. This might be in conflict with other options that affect the file mode, like fsGroup, and the result can be other mode bits set.

+

path

+

String

+

path is the relative path of the file to map the key to. May

+

not be an absolute path. May not contain the path element '..'. May not

+

start with the string '..'.

+
+
+ +
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Table 288 io.cci.otc.api.pkg.apis.versioned.cci.v2.PodStatus

Parameter

+

Type

+

Description

+

conditions

+

Array of io.cci.otc.api.pkg.apis.versioned.cci.v2.PodCondition objects

+

Current service state of pod. More info: https://kubernetes.io/docs/concepts/workloads/pods/pod-lifecycle#pod-conditions

+

containerStatuses

+

Array of io.cci.otc.api.pkg.apis.versioned.cci.v2.ContainerStatus objects

+

The list has one entry per container in the manifest. More info: https://kubernetes.io/docs/concepts/workloads/pods/pod-lifecycle#pod-and-container-status

+

ephemeralContainerStatuses

+

Array of io.cci.otc.api.pkg.apis.versioned.cci.v2.ContainerStatus objects

+

Status for any ephemeral containers that have run in this pod.

+

hostIP

+

String

+

IP address of the host to which the pod is assigned. Empty if

+

not yet scheduled.

+

initContainerStatuses

+

Array of io.cci.otc.api.pkg.apis.versioned.cci.v2.ContainerStatus objects

+

The list has one entry per init container in the manifest. The most recent successful init container will have ready = true, the most recently started container will have startTime set. More info: https://kubernetes.io/docs/concepts/workloads/pods/pod-lifecycle#pod-and-container-status

+

message

+

String

+

A human readable message indicating details about why the pod

+

is in this condition.

+

nominatedNodeName

+

String

+

nominatedNodeName is set only when this pod preempts other pods

+

on the node, but it cannot be scheduled right away as preemption victims

+

receive their graceful termination periods. This field does not guarantee

+

that the pod will be scheduled on this node. Scheduler may decide to place

+

the pod elsewhere if other nodes become available sooner. Scheduler may

+

also decide to give the resources on this node to a higher priority pod

+

that is created after preemption. As a result, this field may be different

+

than PodSpec.nodeName when the pod is scheduled.

+

phase

+

String

+

The phase of a Pod is a simple, high-level summary of where the Pod is in its lifecycle. The conditions array, the reason and message fields, and the individual container status arrays contain more detail about the pod's status. There are five possible phase values:

+

Pending: The pod has been accepted by the Kubernetes system, but one or more of the container images has not been created. This includes time before being scheduled as well as time spent downloading images over the network, which could take a while. Running: The pod has been bound to a node, and all of the containers have been created. At least one container is still running, or is in the process of starting or restarting. Succeeded: All containers in the pod have terminated in success, and will not be restarted. Failed: All containers in the pod have terminated, and at least one container has terminated in failure. The container either exited with non-zero status or was terminated by the system. Unknown: For some reason the state of the pod could not be obtained, typically due to an error in communicating with the host of the pod.

+

More info: https://kubernetes.io/docs/concepts/workloads/pods/pod-lifecycle#pod-phase

+

Possible enum values:

+
  • "Failed" means that all containers in the pod have terminated, and at least one container has terminated in a failure (exited with a non-zero exit code or was stopped by the system).
  • "Pending" means the pod has been accepted by the system, but one or more of the containers has not been started. This includes time before being bound to a node, as well as time spent pulling images onto the host.
  • "Running" means the pod has been bound to a node and all of the containers have been started. At least one container is still running or is in the process of being restarted.
  • "Succeeded" means that all containers in the pod have voluntarily terminated with a container exit code of 0, and the system is not going to restart any of these containers.
  • "Unknown" means that for some reason the state of the pod could not be obtained, typically due to an error in communicating with the host of the pod. Deprecated: It isn't being set since 2015 (74da3b14b0c0f658b3bb8d2def5094686d0e9095)
+

podIP

+

String

+

IP address allocated to the pod. Routable at least within the

+

cluster. Empty if not yet allocated.

+

podIPs

+

Array of io.cci.otc.api.pkg.apis.versioned.cci.v2.PodIP objects

+

podIPs holds the IP addresses allocated to the pod. If this field

+

is specified, the 0th entry must match the podIP field. Pods may be allocated

+

at most 1 value for each of IPv4 and IPv6. This list is empty if no IPs

+

have been allocated yet.

+

qosClass

+

String

+

The Quality of Service (QOS) classification assigned to the pod based on resource requirements See PodQOSClass type for available QOS classes More info: https://git.k8s.io/community/contributors/design-proposals/node/resource-qos.md

+

Possible enum values:

+
  • "BestEffort" is the BestEffort qos class.
  • "Burstable" is the Burstable qos class.
  • "Guaranteed" is the Guaranteed qos class.
+

reason

+

String

+

A brief CamelCase message indicating details about why the pod

+

is in this state. e.g. 'Evicted'

+

startTime

+

String

+

RFC 3339 date and time at which the object was acknowledged by

+

the Kubelet. This is before the Kubelet pulled the container image(s) for

+

the pod.

+
+
+ +
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Table 289 io.cci.otc.api.pkg.apis.versioned.cci.v2.PodCondition

Parameter

+

Type

+

Description

+

lastProbeTime

+

String

+

Last time we probed the condition.

+

lastTransitionTime

+

String

+

Last time the condition transitioned from one status to another.

+

message

+

String

+

Human-readable message indicating details about last transition.

+

reason

+

String

+

Unique, one-word, CamelCase reason for the condition's last transition.

+

status

+

String

+

Status is the status of the condition. Can be True, False, Unknown. More info: https://kubernetes.io/docs/concepts/workloads/pods/pod-lifecycle#pod-conditions

+

type

+

String

+

Type is the type of the condition. More info: https://kubernetes.io/docs/concepts/workloads/pods/pod-lifecycle#pod-conditions

+
+
+ +
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Table 290 io.cci.otc.api.pkg.apis.versioned.cci.v2.ContainerStatus

Parameter

+

Type

+

Description

+

containerID

+

String

+

Container's ID in the format '[/topic/body/section/table/tgroup/tbody/row/entry/p/br {""})(br]://<container_id>'.

+

image

+

String

+

The image the container is running. More info: https://kubernetes.io/docs/concepts/containers/images.

+

imageID

+

String

+

ImageID of the container's image.

+

lastState

+

io.cci.otc.api.pkg.apis.versioned.cci.v2.ContainerState object

+

Details about the container's last termination condition.

+

name

+

String

+

This must be a DNS_LABEL. Each container in a pod must have a

+

unique name. Cannot be updated.

+

ready

+

Boolean

+

Specifies whether the container has passed its readiness probe.

+

restartCount

+

Integer

+

The number of times the container has been restarted.

+

started

+

Boolean

+

Specifies whether the container has passed its startup probe.

+

Initialized as false, becomes true after startupProbe is considered successful.

+

Resets to false when the container is restarted, or if kubelet loses state

+

temporarily. Is always true when no startupProbe is defined.

+

state

+

io.cci.otc.api.pkg.apis.versioned.cci.v2.ContainerState object

+

Details about the container's current condition.

+
+
+ +
+ + + + + + + + + + + + + + + + + +
Table 291 io.cci.otc.api.pkg.apis.versioned.cci.v2.ContainerState

Parameter

+

Type

+

Description

+

running

+

io.cci.otc.api.pkg.apis.versioned.cci.v2.ContainerStateRunning object

+

Details about a running container

+

terminated

+

io.cci.otc.api.pkg.apis.versioned.cci.v2.ContainerStateTerminated object

+

Details about a terminated container

+

waiting

+

io.cci.otc.api.pkg.apis.versioned.cci.v2.ContainerStateWaiting object

+

Details about a waiting container

+
+
+ +
+ + + + + + + + + +
Table 292 io.cci.otc.api.pkg.apis.versioned.cci.v2.ContainerStateRunning

Parameter

+

Type

+

Description

+

startedAt

+

String

+

Time at which the container was last (re-)started

+
+
+ +
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Table 293 io.cci.otc.api.pkg.apis.versioned.cci.v2.ContainerStateTerminated

Parameter

+

Type

+

Description

+

containerID

+

String

+

Container's ID in the format '[/topic/body/section/table/tgroup/tbody/row/entry/p/br {""})(br]://<container_id>'

+

exitCode

+

Integer

+

Exit status from the last termination of the container

+

finishedAt

+

String

+

Time at which the container last terminated

+

message

+

String

+

Message regarding the last termination of the container

+

reason

+

String

+

(brief) reason from the last termination of the container

+

signal

+

Integer

+

Signal from the last termination of the container

+

startedAt

+

String

+

Time at which previous execution of the container started

+
+
+ +
+ + + + + + + + + + + + + +
Table 294 io.cci.otc.api.pkg.apis.versioned.cci.v2.ContainerStateWaiting

Parameter

+

Type

+

Description

+

message

+

String

+

Message regarding why the container is not yet running.

+

reason

+

String

+

(brief) reason the container is not yet running.

+
+
+ +
+ + + + + + + + + +
Table 295 io.cci.otc.api.pkg.apis.versioned.cci.v2.PodIP

Parameter

+

Type

+

Description

+

ip

+

String

+

ip is an IP address (IPv4 or IPv6) assigned to the pod

+
+
+
+

Example Requests

{
+  "apiVersion" : "v1",
+  "kind" : "Pod",
+  "metadata" : {
+    "annotations" : {
+      "resource.cci.io/pod-size-specs" : "2.00_4.0"
+    },
+    "name" : "test"
+  },
+  "spec" : {
+    "containers" : [ {
+      "env" : [ {
+        "name" : "ENV1",
+        "value" : "false"
+      }, {
+        "name" : "ENV2",
+        "value" : "xxx"
+      } ],
+      "image" : "nginx:latest",
+      "imagePullPolicy" : "IfNotPresent",
+      "name" : "deploy-example",
+      "resources" : {
+        "limits" : {
+          "cpu" : "500m",
+          "memory" : "1Gi"
+        },
+        "requests" : {
+          "cpu" : "500m",
+          "memory" : "1Gi"
+        }
+      },
+      "terminationMessagePath" : "/dev/termination-log",
+      "terminationMessagePolicy" : "File"
+    } ],
+    "dnsPolicy" : "Default",
+    "enableServiceLinks" : false,
+    "imagePullSecrets" : [ {
+      "name" : "imagepull-secret"
+    } ],
+    "restartPolicy" : "Always",
+    "securityContext" : { },
+    "terminationGracePeriodSeconds" : 30
+  }
+}
+
+

Example Responses

Status code: 201

+

Created

+
{
+  "apiVersion" : "cci/v2",
+  "kind" : "Pod",
+  "metadata" : {
+    "annotations" : {
+      "openvessel.io/monitoring-aominfo" : "08a2*************************c03:4257ecf3-7c47-43a3-86d2-d2b4d4aa3a20",
+      "resource.cci.io/pod-size-specs" : "2.00_4.0",
+      "resource.cci.io/size" : "2.00_4.0",
+      "tenant.cci.io/tenant-id" : "08a2*************************c03"
+    },
+    "creationTimestamp" : "2024-10-09T16:11:23Z",
+    "finalizers" : [ "billing.kubernetes.io/podbilling-finalizer" ],
+    "labels" : {
+      "sys_enterprise_project_id" : "0",
+      "tenant.cci.io/tenant-id" : "08a2*************************c03",
+      "tenant.kubernetes.io/domain-id" : "08a*************************ee60",
+      "tenant.kubernetes.io/project-id" : "08a2*************************c03"
+    },
+    "name" : "test",
+    "namespace" : "test-api",
+    "resourceVersion" : "391095523",
+    "uid" : "ade5799e-9371-4c9f-ab77-0472e97211f8"
+  },
+  "spec" : {
+    "containers" : [ {
+      "env" : [ {
+        "name" : "ENV1",
+        "value" : "false"
+      }, {
+        "name" : "ENV2",
+        "value" : "xxx"
+      } ],
+      "image" : "nginx:latest",
+      "name" : "deploy-example",
+      "resources" : {
+        "limits" : {
+          "cpu" : "500m",
+          "memory" : "1Gi"
+        },
+        "requests" : {
+          "cpu" : "500m",
+          "memory" : "1Gi"
+        }
+      },
+      "terminationMessagePath" : "/dev/termination-log",
+      "terminationMessagePolicy" : "File"
+    } ],
+    "dnsPolicy" : "Default",
+    "imagePullSecrets" : [ {
+      "name" : "imagepull-secret"
+    } ],
+    "restartPolicy" : "Always",
+    "schedulerName" : "volcano",
+    "securityContext" : { },
+    "terminationGracePeriodSeconds" : 30
+  },
+  "status" : {
+    "phase" : "Pending",
+    "qosClass" : "Guaranteed"
+  }
+}
+
+

Status Codes

+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +

Status Code

+

Description

+

200

+

OK

+

201

+

Created

+

202

+

Accepted

+

400

+

BadRequest

+

401

+

Unauthorized

+

403

+

Forbidden

+

404

+

NotFound

+

405

+

MethodNotAllowed

+

406

+

NotAcceptable

+

409

+

AlreadyExists

+

415

+

UnsupportedMediaType

+

422

+

Invalid

+

429

+

TooManyRequests

+

500

+

InternalError

+

503

+

ServiceUnavailable

+

504

+

ServerTimeout

+
+
+
+
+
+
+
Parent topic: Proprietary APIs
+
+
+ diff --git a/docs/cci/api-ref/createCciV2NamespacedSecret.html b/docs/cci/api-ref/createCciV2NamespacedSecret.html new file mode 100644 index 00000000..0242e2a1 --- /dev/null +++ b/docs/cci/api-ref/createCciV2NamespacedSecret.html @@ -0,0 +1,1734 @@ + + +

Creating a Secret

+

Function

Create a Secret.

+
+

Calling Method

For details, see Calling APIs.

+
+

URI

POST /apis/cci/v2/namespaces/{namespace}/secrets

+ +
+ + + + + + + + + + + +
Table 1 Path Parameters

Parameter

+

Mandatory

+

Type

+

Description

+

namespace

+

Yes

+

String

+

Object name and auth scope, such as for teams and projects.

+
+
+ +
+ + + + + + + + + + + + + + + + + + + + + +
Table 2 Query Parameters

Parameter

+

Mandatory

+

Type

+

Description

+

dryRun

+

No

+

String

+

When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed

+

fieldManager

+

No

+

String

+

fieldManager is a name associated with the actor or entity that

+

is making these changes. The value must be less than or 128 characters long,

+

and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint.

+

pretty

+

No

+

String

+

If 'true', then the output is pretty printed.

+
+
+
+

Request Parameters

+
+ + + + + + + + + + + + + + + + +
Table 3 Request header parameters

Parameter

+

Mandatory

+

Type

+

Description

+

X-Auth-Token

+

Yes

+

String

+

User token.

+

It can be obtained through the IAM API used to obtain a user token. The value of X-Subject-Token in the response header is the user token.

+

Content-Type

+

Yes

+

String

+

The type of the message body, with a default value of "application/JSON".

+
+
+ +
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Table 4 Request body parameters

Parameter

+

Mandatory

+

Type

+

Description

+

apiVersion

+

No

+

String

+

APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#resources

+

data

+

No

+

Map<String,String>

+

Data contains the secret data. Each key must consist of alphanumeric

+

characters, '-', '_' or '.'. The serialized form of the secret data is a

+

base64 encoded string, representing the arbitrary (possibly non-string)

+

data value here. Described in https://tools.ietf.org/html/rfc4648#section-4

+

immutable

+

No

+

Boolean

+

Immutable, if set to true, ensures that data stored in the Secret

+

cannot be updated (only object metadata can be modified). If not set to

+

true, the field can be modified at any time. Defaulted to nil.

+

kind

+

No

+

String

+

Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds

+

metadata

+

No

+

io.k8s.apimachinery.pkg.apis.meta.v1.ObjectMeta object

+

Standard object's metadata. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata

+

stringData

+

No

+

Map<String,String>

+

stringData allows specifying non-binary secret data in string

+

form. It is provided as a write-only input field for convenience. All keys

+

and values are merged into the data field on write, overwriting any existing

+

values. The stringData field is never output when reading from the API.

+

type

+

No

+

String

+

Used to facilitate programmatic handling of secret data. More info: https://kubernetes.io/docs/concepts/configuration/secret/#secret-types

+
+
+ +
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Table 5 io.k8s.apimachinery.pkg.apis.meta.v1.ObjectMeta

Parameter

+

Mandatory

+

Type

+

Description

+

annotations

+

No

+

Map<String,String>

+

Annotations is an unstructured key value map stored with a resource that may be set by external tools to store and retrieve arbitrary metadata. They are not queryable and should be preserved when modifying objects. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/annotations/

+

clusterName

+

No

+

String

+

The name of the cluster which the object belongs to. This is

+

used to distinguish resources with same name and namespace in different

+

clusters. This field is not set anywhere right now and apiserver is going

+

to ignore it if set in create or update request.

+

creationTimestamp

+

No

+

String

+

CreationTimestamp is a timestamp representing the server time when this object was created. It is not guaranteed to be set in happens-before order across separate operations. Clients may not set this value. It is represented in RFC3339 form and is in UTC.

+

Populated by the system. Read-only. Null for lists. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata

+

deletionGracePeriodSeconds

+

No

+

Long

+

Number of seconds allowed for this object to gracefully terminate

+

before it will be removed from the system. Only set when deletionTimestamp

+

is also set. May only be shortened. Read-only.

+

deletionTimestamp

+

No

+

String

+

DeletionTimestamp is RFC 3339 date and time at which this resource will be deleted. This field is set by the server when a graceful deletion is requested by the user, and is not directly settable by a client. The resource is expected to be deleted (no longer visible from resource lists, and not reachable by name) after the time in this field, once the finalizers list is empty. As long as the finalizers list contains items, deletion is blocked. Once the deletionTimestamp is set, this value may not be unset or be set further into the future, although it may be shortened or the resource may be deleted prior to this time. For example, a user may request that a pod is deleted in 30 seconds. The Kubelet will react by sending a graceful termination signal to the containers in the pod. After that 30 seconds, the Kubelet will send a hard termination signal (SIGKILL) to the container and after cleanup, remove the pod from the API. In the presence of network partitions, this object may still exist after this timestamp, until an administrator or automated process can determine the resource is fully terminated. If not set, graceful deletion of the object has not been requested.

+

Populated by the system when a graceful deletion is requested. Read-only. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata

+

enable

+

No

+

Boolean

+

Enable identifies whether the resource is available

+

finalizers

+

No

+

Array of strings

+

Must be empty before the object is deleted from the registry.

+

Each entry is an identifier for the responsible component that will remove

+

the entry from the list. If the deletionTimestamp of the object is non-nil,

+

entries in this list can only be removed. Finalizers may be processed and

+

removed in any order. Order is NOT enforced because it introduces significant

+

risk of stuck finalizers. finalizers is a shared field, any actor with permission

+

can reorder it. If the finalizer list is processed in order, then this can

+

lead to a situation in which the component responsible for the first finalizer

+

in the list is waiting for a signal (field value, external system, or other)

+

produced by a component responsible for a finalizer later in the list, resulting

+

in a deadlock. Without enforced ordering finalizers are free to order amongst

+

themselves and are not vulnerable to ordering changes in the list.

+

generateName

+

No

+

String

+

GenerateName is an optional prefix, used by the server, to generate a unique name ONLY IF the Name field has not been provided. If this field is used, the name returned to the client will be different than the name passed. This value will also be combined with a unique suffix. The provided value has the same validation rules as the Name field, and may be truncated by the length of the suffix required to make the value unique on the server.

+

If this field is specified and the generated name exists, the server will NOT return a 409 - instead, it will either return 201 Created or 500 with Reason ServerTimeout indicating a unique name could not be found in the time allotted, and the client should retry (optionally after the time indicated in the Retry-After header).

+

Applied only if Name is not specified. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#idempotency

+

generation

+

No

+

Long

+

A sequence number representing a specific generation of the desired

+

state. Populated by the system. Read-only.

+

labels

+

No

+

Map<String,String>

+

Map of string keys and values that can be used to organize and categorize (scope and select) objects. May match selectors of replication controllers and services. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/labels/

+

managedFields

+

No

+

Array of io.k8s.apimachinery.pkg.apis.meta.v1.ManagedFieldsEntry objects

+

ManagedFields maps workflow-id and version to the set of fields

+

that are managed by that workflow. This is mostly for internal housekeeping,

+

and users typically shouldn't need to set or understand this field. A workflow

+

can be the user's name, a controller's name, or the name of a specific apply

+

path like "ci-cd". The set of fields is always in the version that the workflow

+

used when modifying the object.

+

name

+

No

+

String

+

Name must be unique within a namespace. Is required when creating resources, although some resources may allow a client to request the generation of an appropriate name automatically. Name is primarily intended for creation idempotence and configuration definition. Cannot be updated. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names

+

namespace

+

No

+

String

+

Namespace defines the space within which each name must be unique. An empty namespace is equivalent to the "default" namespace, but "default" is the canonical representation. Not all objects are required to be scoped to a namespace - the value of this field for those objects will be empty.

+

Must be a DNS_LABEL. Cannot be updated. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/namespaces/

+

ownerReferences

+

No

+

Array of io.k8s.apimachinery.pkg.apis.meta.v1.OwnerReference objects

+

List of objects depended by this object. If ALL objects in the

+

list have been deleted, this object will be garbage collected. If this object

+

is managed by a controller, then an entry in this list will point to this

+

controller, with the controller field set to true. There cannot be more

+

than one managing controller.

+

resourceVersion

+

No

+

String

+

An opaque value that represents the internal version of this object that can be used by clients to determine when objects have changed. May be used for optimistic concurrency, change detection, and the watch operation on a resource or set of resources. Clients must treat these values as opaque and passed unmodified back to the server. They may only be valid for a particular resource or set of resources.

+

Populated by the system. Read-only. Value must be treated as opaque by clients and . More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#concurrency-control-and-consistency

+

selfLink

+

No

+

String

+

SelfLink is a URL representing this object. Populated by the system. Read-only.

+

DEPRECATED Kubernetes will stop propagating this field in 1.20 release and the field is planned to be removed in 1.21 release.

+

uid

+

No

+

String

+

UID is the unique in time and space value for this object. It is typically generated by the server on successful creation of a resource and is not allowed to change on PUT operations.

+

Populated by the system. Read-only. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#uids

+
+
+ +
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Table 6 io.k8s.apimachinery.pkg.apis.meta.v1.ManagedFieldsEntry

Parameter

+

Mandatory

+

Type

+

Description

+

apiVersion

+

No

+

String

+

APIVersion defines the version of this resource that this field

+

set applies to. The format is "group/version" just like the top-level APIVersion

+

field. It is necessary to track the version of a field set because it cannot

+

be automatically converted.

+

fieldsType

+

No

+

String

+

FieldsType is the discriminator for the different fields format and version. There is currently only one possible value: "FieldsV1"

+

fieldsV1

+

No

+

Object

+

FieldsV1 holds the first JSON version format as described in

+

the "FieldsV1" type.

+

manager

+

No

+

String

+

Manager is an identifier of the workflow managing these fields.

+

operation

+

No

+

String

+

Operation is the type of operation which lead to this ManagedFieldsEntry

+

being created. The only valid values for this field are 'Apply' and 'Update'.

+

time

+

No

+

String

+

Time is timestamp of when these fields were set. It should always

+

be empty if Operation is 'Apply'

+
+
+ +
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Table 7 io.k8s.apimachinery.pkg.apis.meta.v1.OwnerReference

Parameter

+

Mandatory

+

Type

+

Description

+

apiVersion

+

Yes

+

String

+

API version of the referent.

+

blockOwnerDeletion

+

No

+

Boolean

+

If true, AND if the owner has the "foregroundDeletion" finalizer,

+

then the owner cannot be deleted from the key-value store until this reference

+

is removed. Defaults to false. To set this field, a user needs "delete"

+

permission of the owner, otherwise 422 (Unprocessable Entity) will be returned.

+

controller

+

No

+

Boolean

+

If true, this reference points to the managing controller.

+

kind

+

Yes

+

String

+

Kind of the referent. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds

+

name

+

Yes

+

String

+

Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names

+

uid

+

Yes

+

String

+

UID of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#uids

+
+
+
+

Response Parameters

Status code: 200

+ +
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Table 8 Response body parameters

Parameter

+

Type

+

Description

+

apiVersion

+

String

+

APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#resources

+

data

+

Map<String,String>

+

Data contains the secret data. Each key must consist of alphanumeric

+

characters, '-', '_' or '.'. The serialized form of the secret data is a

+

base64 encoded string, representing the arbitrary (possibly non-string)

+

data value here. Described in https://tools.ietf.org/html/rfc4648#section-4

+

immutable

+

Boolean

+

Immutable, if set to true, ensures that data stored in the Secret

+

cannot be updated (only object metadata can be modified). If not set to

+

true, the field can be modified at any time. Defaulted to nil.

+

kind

+

String

+

Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds

+

metadata

+

io.k8s.apimachinery.pkg.apis.meta.v1.ObjectMeta object

+

Standard object's metadata. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata

+

stringData

+

Map<String,String>

+

stringData allows specifying non-binary secret data in string

+

form. It is provided as a write-only input field for convenience. All keys

+

and values are merged into the data field on write, overwriting any existing

+

values. The stringData field is never output when reading from the API.

+

type

+

String

+

Used to facilitate programmatic handling of secret data. More info: https://kubernetes.io/docs/concepts/configuration/secret/#secret-types

+
+
+ +
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Table 9 io.k8s.apimachinery.pkg.apis.meta.v1.ObjectMeta

Parameter

+

Type

+

Description

+

annotations

+

Map<String,String>

+

Annotations is an unstructured key value map stored with a resource that may be set by external tools to store and retrieve arbitrary metadata. They are not queryable and should be preserved when modifying objects. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/annotations/

+

clusterName

+

String

+

The name of the cluster which the object belongs to. This is

+

used to distinguish resources with same name and namespace in different

+

clusters. This field is not set anywhere right now and apiserver is going

+

to ignore it if set in create or update request.

+

creationTimestamp

+

String

+

CreationTimestamp is a timestamp representing the server time when this object was created. It is not guaranteed to be set in happens-before order across separate operations. Clients may not set this value. It is represented in RFC3339 form and is in UTC.

+

Populated by the system. Read-only. Null for lists. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata

+

deletionGracePeriodSeconds

+

Long

+

Number of seconds allowed for this object to gracefully terminate

+

before it will be removed from the system. Only set when deletionTimestamp

+

is also set. May only be shortened. Read-only.

+

deletionTimestamp

+

String

+

DeletionTimestamp is RFC 3339 date and time at which this resource will be deleted. This field is set by the server when a graceful deletion is requested by the user, and is not directly settable by a client. The resource is expected to be deleted (no longer visible from resource lists, and not reachable by name) after the time in this field, once the finalizers list is empty. As long as the finalizers list contains items, deletion is blocked. Once the deletionTimestamp is set, this value may not be unset or be set further into the future, although it may be shortened or the resource may be deleted prior to this time. For example, a user may request that a pod is deleted in 30 seconds. The Kubelet will react by sending a graceful termination signal to the containers in the pod. After that 30 seconds, the Kubelet will send a hard termination signal (SIGKILL) to the container and after cleanup, remove the pod from the API. In the presence of network partitions, this object may still exist after this timestamp, until an administrator or automated process can determine the resource is fully terminated. If not set, graceful deletion of the object has not been requested.

+

Populated by the system when a graceful deletion is requested. Read-only. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata

+

enable

+

Boolean

+

Enable identifies whether the resource is available

+

finalizers

+

Array of strings

+

Must be empty before the object is deleted from the registry.

+

Each entry is an identifier for the responsible component that will remove

+

the entry from the list. If the deletionTimestamp of the object is non-nil,

+

entries in this list can only be removed. Finalizers may be processed and

+

removed in any order. Order is NOT enforced because it introduces significant

+

risk of stuck finalizers. finalizers is a shared field, any actor with permission

+

can reorder it. If the finalizer list is processed in order, then this can

+

lead to a situation in which the component responsible for the first finalizer

+

in the list is waiting for a signal (field value, external system, or other)

+

produced by a component responsible for a finalizer later in the list, resulting

+

in a deadlock. Without enforced ordering finalizers are free to order amongst

+

themselves and are not vulnerable to ordering changes in the list.

+

generateName

+

String

+

GenerateName is an optional prefix, used by the server, to generate a unique name ONLY IF the Name field has not been provided. If this field is used, the name returned to the client will be different than the name passed. This value will also be combined with a unique suffix. The provided value has the same validation rules as the Name field, and may be truncated by the length of the suffix required to make the value unique on the server.

+

If this field is specified and the generated name exists, the server will NOT return a 409 - instead, it will either return 201 Created or 500 with Reason ServerTimeout indicating a unique name could not be found in the time allotted, and the client should retry (optionally after the time indicated in the Retry-After header).

+

Applied only if Name is not specified. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#idempotency

+

generation

+

Long

+

A sequence number representing a specific generation of the desired

+

state. Populated by the system. Read-only.

+

labels

+

Map<String,String>

+

Map of string keys and values that can be used to organize and categorize (scope and select) objects. May match selectors of replication controllers and services. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/labels/

+

managedFields

+

Array of io.k8s.apimachinery.pkg.apis.meta.v1.ManagedFieldsEntry objects

+

ManagedFields maps workflow-id and version to the set of fields

+

that are managed by that workflow. This is mostly for internal housekeeping,

+

and users typically shouldn't need to set or understand this field. A workflow

+

can be the user's name, a controller's name, or the name of a specific apply

+

path like "ci-cd". The set of fields is always in the version that the workflow

+

used when modifying the object.

+

name

+

String

+

Name must be unique within a namespace. Is required when creating resources, although some resources may allow a client to request the generation of an appropriate name automatically. Name is primarily intended for creation idempotence and configuration definition. Cannot be updated. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names

+

namespace

+

String

+

Namespace defines the space within which each name must be unique. An empty namespace is equivalent to the "default" namespace, but "default" is the canonical representation. Not all objects are required to be scoped to a namespace - the value of this field for those objects will be empty.

+

Must be a DNS_LABEL. Cannot be updated. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/namespaces/

+

ownerReferences

+

Array of io.k8s.apimachinery.pkg.apis.meta.v1.OwnerReference objects

+

List of objects depended by this object. If ALL objects in the

+

list have been deleted, this object will be garbage collected. If this object

+

is managed by a controller, then an entry in this list will point to this

+

controller, with the controller field set to true. There cannot be more

+

than one managing controller.

+

resourceVersion

+

String

+

An opaque value that represents the internal version of this object that can be used by clients to determine when objects have changed. May be used for optimistic concurrency, change detection, and the watch operation on a resource or set of resources. Clients must treat these values as opaque and passed unmodified back to the server. They may only be valid for a particular resource or set of resources.

+

Populated by the system. Read-only. Value must be treated as opaque by clients and . More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#concurrency-control-and-consistency

+

selfLink

+

String

+

SelfLink is a URL representing this object. Populated by the system. Read-only.

+

DEPRECATED Kubernetes will stop propagating this field in 1.20 release and the field is planned to be removed in 1.21 release.

+

uid

+

String

+

UID is the unique in time and space value for this object. It is typically generated by the server on successful creation of a resource and is not allowed to change on PUT operations.

+

Populated by the system. Read-only. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#uids

+
+
+ +
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Table 10 io.k8s.apimachinery.pkg.apis.meta.v1.ManagedFieldsEntry

Parameter

+

Type

+

Description

+

apiVersion

+

String

+

APIVersion defines the version of this resource that this field

+

set applies to. The format is "group/version" just like the top-level APIVersion

+

field. It is necessary to track the version of a field set because it cannot

+

be automatically converted.

+

fieldsType

+

String

+

FieldsType is the discriminator for the different fields format and version. There is currently only one possible value: "FieldsV1"

+

fieldsV1

+

Object

+

FieldsV1 holds the first JSON version format as described in

+

the "FieldsV1" type.

+

manager

+

String

+

Manager is an identifier of the workflow managing these fields.

+

operation

+

String

+

Operation is the type of operation which lead to this ManagedFieldsEntry

+

being created. The only valid values for this field are 'Apply' and 'Update'.

+

time

+

String

+

Time is timestamp of when these fields were set. It should always

+

be empty if Operation is 'Apply'

+
+
+ +
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Table 11 io.k8s.apimachinery.pkg.apis.meta.v1.OwnerReference

Parameter

+

Type

+

Description

+

apiVersion

+

String

+

API version of the referent.

+

blockOwnerDeletion

+

Boolean

+

If true, AND if the owner has the "foregroundDeletion" finalizer,

+

then the owner cannot be deleted from the key-value store until this reference

+

is removed. Defaults to false. To set this field, a user needs "delete"

+

permission of the owner, otherwise 422 (Unprocessable Entity) will be returned.

+

controller

+

Boolean

+

If true, this reference points to the managing controller.

+

kind

+

String

+

Kind of the referent. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds

+

name

+

String

+

Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names

+

uid

+

String

+

UID of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#uids

+
+
+

Status code: 201

+ +
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Table 12 Response body parameters

Parameter

+

Type

+

Description

+

apiVersion

+

String

+

APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#resources

+

data

+

Map<String,String>

+

Data contains the secret data. Each key must consist of alphanumeric

+

characters, '-', '_' or '.'. The serialized form of the secret data is a

+

base64 encoded string, representing the arbitrary (possibly non-string)

+

data value here. Described in https://tools.ietf.org/html/rfc4648#section-4

+

immutable

+

Boolean

+

Immutable, if set to true, ensures that data stored in the Secret

+

cannot be updated (only object metadata can be modified). If not set to

+

true, the field can be modified at any time. Defaulted to nil.

+

kind

+

String

+

Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds

+

metadata

+

io.k8s.apimachinery.pkg.apis.meta.v1.ObjectMeta object

+

Standard object's metadata. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata

+

stringData

+

Map<String,String>

+

stringData allows specifying non-binary secret data in string

+

form. It is provided as a write-only input field for convenience. All keys

+

and values are merged into the data field on write, overwriting any existing

+

values. The stringData field is never output when reading from the API.

+

type

+

String

+

Used to facilitate programmatic handling of secret data. More info: https://kubernetes.io/docs/concepts/configuration/secret/#secret-types

+
+
+ +
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Table 13 io.k8s.apimachinery.pkg.apis.meta.v1.ObjectMeta

Parameter

+

Type

+

Description

+

annotations

+

Map<String,String>

+

Annotations is an unstructured key value map stored with a resource that may be set by external tools to store and retrieve arbitrary metadata. They are not queryable and should be preserved when modifying objects. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/annotations/

+

clusterName

+

String

+

The name of the cluster which the object belongs to. This is

+

used to distinguish resources with same name and namespace in different

+

clusters. This field is not set anywhere right now and apiserver is going

+

to ignore it if set in create or update request.

+

creationTimestamp

+

String

+

CreationTimestamp is a timestamp representing the server time when this object was created. It is not guaranteed to be set in happens-before order across separate operations. Clients may not set this value. It is represented in RFC3339 form and is in UTC.

+

Populated by the system. Read-only. Null for lists. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata

+

deletionGracePeriodSeconds

+

Long

+

Number of seconds allowed for this object to gracefully terminate

+

before it will be removed from the system. Only set when deletionTimestamp

+

is also set. May only be shortened. Read-only.

+

deletionTimestamp

+

String

+

DeletionTimestamp is RFC 3339 date and time at which this resource will be deleted. This field is set by the server when a graceful deletion is requested by the user, and is not directly settable by a client. The resource is expected to be deleted (no longer visible from resource lists, and not reachable by name) after the time in this field, once the finalizers list is empty. As long as the finalizers list contains items, deletion is blocked. Once the deletionTimestamp is set, this value may not be unset or be set further into the future, although it may be shortened or the resource may be deleted prior to this time. For example, a user may request that a pod is deleted in 30 seconds. The Kubelet will react by sending a graceful termination signal to the containers in the pod. After that 30 seconds, the Kubelet will send a hard termination signal (SIGKILL) to the container and after cleanup, remove the pod from the API. In the presence of network partitions, this object may still exist after this timestamp, until an administrator or automated process can determine the resource is fully terminated. If not set, graceful deletion of the object has not been requested.

+

Populated by the system when a graceful deletion is requested. Read-only. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata

+

enable

+

Boolean

+

Enable identifies whether the resource is available

+

finalizers

+

Array of strings

+

Must be empty before the object is deleted from the registry.

+

Each entry is an identifier for the responsible component that will remove

+

the entry from the list. If the deletionTimestamp of the object is non-nil,

+

entries in this list can only be removed. Finalizers may be processed and

+

removed in any order. Order is NOT enforced because it introduces significant

+

risk of stuck finalizers. finalizers is a shared field, any actor with permission

+

can reorder it. If the finalizer list is processed in order, then this can

+

lead to a situation in which the component responsible for the first finalizer

+

in the list is waiting for a signal (field value, external system, or other)

+

produced by a component responsible for a finalizer later in the list, resulting

+

in a deadlock. Without enforced ordering finalizers are free to order amongst

+

themselves and are not vulnerable to ordering changes in the list.

+

generateName

+

String

+

GenerateName is an optional prefix, used by the server, to generate a unique name ONLY IF the Name field has not been provided. If this field is used, the name returned to the client will be different than the name passed. This value will also be combined with a unique suffix. The provided value has the same validation rules as the Name field, and may be truncated by the length of the suffix required to make the value unique on the server.

+

If this field is specified and the generated name exists, the server will NOT return a 409 - instead, it will either return 201 Created or 500 with Reason ServerTimeout indicating a unique name could not be found in the time allotted, and the client should retry (optionally after the time indicated in the Retry-After header).

+

Applied only if Name is not specified. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#idempotency

+

generation

+

Long

+

A sequence number representing a specific generation of the desired

+

state. Populated by the system. Read-only.

+

labels

+

Map<String,String>

+

Map of string keys and values that can be used to organize and categorize (scope and select) objects. May match selectors of replication controllers and services. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/labels/

+

managedFields

+

Array of io.k8s.apimachinery.pkg.apis.meta.v1.ManagedFieldsEntry objects

+

ManagedFields maps workflow-id and version to the set of fields

+

that are managed by that workflow. This is mostly for internal housekeeping,

+

and users typically shouldn't need to set or understand this field. A workflow

+

can be the user's name, a controller's name, or the name of a specific apply

+

path like "ci-cd". The set of fields is always in the version that the workflow

+

used when modifying the object.

+

name

+

String

+

Name must be unique within a namespace. Is required when creating resources, although some resources may allow a client to request the generation of an appropriate name automatically. Name is primarily intended for creation idempotence and configuration definition. Cannot be updated. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names

+

namespace

+

String

+

Namespace defines the space within which each name must be unique. An empty namespace is equivalent to the "default" namespace, but "default" is the canonical representation. Not all objects are required to be scoped to a namespace - the value of this field for those objects will be empty.

+

Must be a DNS_LABEL. Cannot be updated. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/namespaces/

+

ownerReferences

+

Array of io.k8s.apimachinery.pkg.apis.meta.v1.OwnerReference objects

+

List of objects depended by this object. If ALL objects in the

+

list have been deleted, this object will be garbage collected. If this object

+

is managed by a controller, then an entry in this list will point to this

+

controller, with the controller field set to true. There cannot be more

+

than one managing controller.

+

resourceVersion

+

String

+

An opaque value that represents the internal version of this object that can be used by clients to determine when objects have changed. May be used for optimistic concurrency, change detection, and the watch operation on a resource or set of resources. Clients must treat these values as opaque and passed unmodified back to the server. They may only be valid for a particular resource or set of resources.

+

Populated by the system. Read-only. Value must be treated as opaque by clients and . More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#concurrency-control-and-consistency

+

selfLink

+

String

+

SelfLink is a URL representing this object. Populated by the system. Read-only.

+

DEPRECATED Kubernetes will stop propagating this field in 1.20 release and the field is planned to be removed in 1.21 release.

+

uid

+

String

+

UID is the unique in time and space value for this object. It is typically generated by the server on successful creation of a resource and is not allowed to change on PUT operations.

+

Populated by the system. Read-only. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#uids

+
+
+ +
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Table 14 io.k8s.apimachinery.pkg.apis.meta.v1.ManagedFieldsEntry

Parameter

+

Type

+

Description

+

apiVersion

+

String

+

APIVersion defines the version of this resource that this field

+

set applies to. The format is "group/version" just like the top-level APIVersion

+

field. It is necessary to track the version of a field set because it cannot

+

be automatically converted.

+

fieldsType

+

String

+

FieldsType is the discriminator for the different fields format and version. There is currently only one possible value: "FieldsV1"

+

fieldsV1

+

Object

+

FieldsV1 holds the first JSON version format as described in

+

the "FieldsV1" type.

+

manager

+

String

+

Manager is an identifier of the workflow managing these fields.

+

operation

+

String

+

Operation is the type of operation which lead to this ManagedFieldsEntry

+

being created. The only valid values for this field are 'Apply' and 'Update'.

+

time

+

String

+

Time is timestamp of when these fields were set. It should always

+

be empty if Operation is 'Apply'

+
+
+ +
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Table 15 io.k8s.apimachinery.pkg.apis.meta.v1.OwnerReference

Parameter

+

Type

+

Description

+

apiVersion

+

String

+

API version of the referent.

+

blockOwnerDeletion

+

Boolean

+

If true, AND if the owner has the "foregroundDeletion" finalizer,

+

then the owner cannot be deleted from the key-value store until this reference

+

is removed. Defaults to false. To set this field, a user needs "delete"

+

permission of the owner, otherwise 422 (Unprocessable Entity) will be returned.

+

controller

+

Boolean

+

If true, this reference points to the managing controller.

+

kind

+

String

+

Kind of the referent. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds

+

name

+

String

+

Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names

+

uid

+

String

+

UID of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#uids

+
+
+

Status code: 202

+ +
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Table 16 Response body parameters

Parameter

+

Type

+

Description

+

apiVersion

+

String

+

APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#resources

+

data

+

Map<String,String>

+

Data contains the secret data. Each key must consist of alphanumeric

+

characters, '-', '_' or '.'. The serialized form of the secret data is a

+

base64 encoded string, representing the arbitrary (possibly non-string)

+

data value here. Described in https://tools.ietf.org/html/rfc4648#section-4

+

immutable

+

Boolean

+

Immutable, if set to true, ensures that data stored in the Secret

+

cannot be updated (only object metadata can be modified). If not set to

+

true, the field can be modified at any time. Defaulted to nil.

+

kind

+

String

+

Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds

+

metadata

+

io.k8s.apimachinery.pkg.apis.meta.v1.ObjectMeta object

+

Standard object's metadata. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata

+

stringData

+

Map<String,String>

+

stringData allows specifying non-binary secret data in string

+

form. It is provided as a write-only input field for convenience. All keys

+

and values are merged into the data field on write, overwriting any existing

+

values. The stringData field is never output when reading from the API.

+

type

+

String

+

Used to facilitate programmatic handling of secret data. More info: https://kubernetes.io/docs/concepts/configuration/secret/#secret-types

+
+
+ +
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Table 17 io.k8s.apimachinery.pkg.apis.meta.v1.ObjectMeta

Parameter

+

Type

+

Description

+

annotations

+

Map<String,String>

+

Annotations is an unstructured key value map stored with a resource that may be set by external tools to store and retrieve arbitrary metadata. They are not queryable and should be preserved when modifying objects. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/annotations/

+

clusterName

+

String

+

The name of the cluster which the object belongs to. This is

+

used to distinguish resources with same name and namespace in different

+

clusters. This field is not set anywhere right now and apiserver is going

+

to ignore it if set in create or update request.

+

creationTimestamp

+

String

+

CreationTimestamp is a timestamp representing the server time when this object was created. It is not guaranteed to be set in happens-before order across separate operations. Clients may not set this value. It is represented in RFC3339 form and is in UTC.

+

Populated by the system. Read-only. Null for lists. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata

+

deletionGracePeriodSeconds

+

Long

+

Number of seconds allowed for this object to gracefully terminate

+

before it will be removed from the system. Only set when deletionTimestamp

+

is also set. May only be shortened. Read-only.

+

deletionTimestamp

+

String

+

DeletionTimestamp is RFC 3339 date and time at which this resource will be deleted. This field is set by the server when a graceful deletion is requested by the user, and is not directly settable by a client. The resource is expected to be deleted (no longer visible from resource lists, and not reachable by name) after the time in this field, once the finalizers list is empty. As long as the finalizers list contains items, deletion is blocked. Once the deletionTimestamp is set, this value may not be unset or be set further into the future, although it may be shortened or the resource may be deleted prior to this time. For example, a user may request that a pod is deleted in 30 seconds. The Kubelet will react by sending a graceful termination signal to the containers in the pod. After that 30 seconds, the Kubelet will send a hard termination signal (SIGKILL) to the container and after cleanup, remove the pod from the API. In the presence of network partitions, this object may still exist after this timestamp, until an administrator or automated process can determine the resource is fully terminated. If not set, graceful deletion of the object has not been requested.

+

Populated by the system when a graceful deletion is requested. Read-only. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata

+

enable

+

Boolean

+

Enable identifies whether the resource is available

+

finalizers

+

Array of strings

+

Must be empty before the object is deleted from the registry.

+

Each entry is an identifier for the responsible component that will remove

+

the entry from the list. If the deletionTimestamp of the object is non-nil,

+

entries in this list can only be removed. Finalizers may be processed and

+

removed in any order. Order is NOT enforced because it introduces significant

+

risk of stuck finalizers. finalizers is a shared field, any actor with permission

+

can reorder it. If the finalizer list is processed in order, then this can

+

lead to a situation in which the component responsible for the first finalizer

+

in the list is waiting for a signal (field value, external system, or other)

+

produced by a component responsible for a finalizer later in the list, resulting

+

in a deadlock. Without enforced ordering finalizers are free to order amongst

+

themselves and are not vulnerable to ordering changes in the list.

+

generateName

+

String

+

GenerateName is an optional prefix, used by the server, to generate a unique name ONLY IF the Name field has not been provided. If this field is used, the name returned to the client will be different than the name passed. This value will also be combined with a unique suffix. The provided value has the same validation rules as the Name field, and may be truncated by the length of the suffix required to make the value unique on the server.

+

If this field is specified and the generated name exists, the server will NOT return a 409 - instead, it will either return 201 Created or 500 with Reason ServerTimeout indicating a unique name could not be found in the time allotted, and the client should retry (optionally after the time indicated in the Retry-After header).

+

Applied only if Name is not specified. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#idempotency

+

generation

+

Long

+

A sequence number representing a specific generation of the desired

+

state. Populated by the system. Read-only.

+

labels

+

Map<String,String>

+

Map of string keys and values that can be used to organize and categorize (scope and select) objects. May match selectors of replication controllers and services. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/labels/

+

managedFields

+

Array of io.k8s.apimachinery.pkg.apis.meta.v1.ManagedFieldsEntry objects

+

ManagedFields maps workflow-id and version to the set of fields

+

that are managed by that workflow. This is mostly for internal housekeeping,

+

and users typically shouldn't need to set or understand this field. A workflow

+

can be the user's name, a controller's name, or the name of a specific apply

+

path like "ci-cd". The set of fields is always in the version that the workflow

+

used when modifying the object.

+

name

+

String

+

Name must be unique within a namespace. Is required when creating resources, although some resources may allow a client to request the generation of an appropriate name automatically. Name is primarily intended for creation idempotence and configuration definition. Cannot be updated. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names

+

namespace

+

String

+

Namespace defines the space within which each name must be unique. An empty namespace is equivalent to the "default" namespace, but "default" is the canonical representation. Not all objects are required to be scoped to a namespace - the value of this field for those objects will be empty.

+

Must be a DNS_LABEL. Cannot be updated. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/namespaces/

+

ownerReferences

+

Array of io.k8s.apimachinery.pkg.apis.meta.v1.OwnerReference objects

+

List of objects depended by this object. If ALL objects in the

+

list have been deleted, this object will be garbage collected. If this object

+

is managed by a controller, then an entry in this list will point to this

+

controller, with the controller field set to true. There cannot be more

+

than one managing controller.

+

resourceVersion

+

String

+

An opaque value that represents the internal version of this object that can be used by clients to determine when objects have changed. May be used for optimistic concurrency, change detection, and the watch operation on a resource or set of resources. Clients must treat these values as opaque and passed unmodified back to the server. They may only be valid for a particular resource or set of resources.

+

Populated by the system. Read-only. Value must be treated as opaque by clients and . More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#concurrency-control-and-consistency

+

selfLink

+

String

+

SelfLink is a URL representing this object. Populated by the system. Read-only.

+

DEPRECATED Kubernetes will stop propagating this field in 1.20 release and the field is planned to be removed in 1.21 release.

+

uid

+

String

+

UID is the unique in time and space value for this object. It is typically generated by the server on successful creation of a resource and is not allowed to change on PUT operations.

+

Populated by the system. Read-only. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#uids

+
+
+ +
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Table 18 io.k8s.apimachinery.pkg.apis.meta.v1.ManagedFieldsEntry

Parameter

+

Type

+

Description

+

apiVersion

+

String

+

APIVersion defines the version of this resource that this field

+

set applies to. The format is "group/version" just like the top-level APIVersion

+

field. It is necessary to track the version of a field set because it cannot

+

be automatically converted.

+

fieldsType

+

String

+

FieldsType is the discriminator for the different fields format and version. There is currently only one possible value: "FieldsV1"

+

fieldsV1

+

Object

+

FieldsV1 holds the first JSON version format as described in

+

the "FieldsV1" type.

+

manager

+

String

+

Manager is an identifier of the workflow managing these fields.

+

operation

+

String

+

Operation is the type of operation which lead to this ManagedFieldsEntry

+

being created. The only valid values for this field are 'Apply' and 'Update'.

+

time

+

String

+

Time is timestamp of when these fields were set. It should always

+

be empty if Operation is 'Apply'

+
+
+ +
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Table 19 io.k8s.apimachinery.pkg.apis.meta.v1.OwnerReference

Parameter

+

Type

+

Description

+

apiVersion

+

String

+

API version of the referent.

+

blockOwnerDeletion

+

Boolean

+

If true, AND if the owner has the "foregroundDeletion" finalizer,

+

then the owner cannot be deleted from the key-value store until this reference

+

is removed. Defaults to false. To set this field, a user needs "delete"

+

permission of the owner, otherwise 422 (Unprocessable Entity) will be returned.

+

controller

+

Boolean

+

If true, this reference points to the managing controller.

+

kind

+

String

+

Kind of the referent. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds

+

name

+

String

+

Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names

+

uid

+

String

+

UID of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#uids

+
+
+
+

Example Requests

{
+  "apiVersion" : "cci/v2",
+  "data" : {
+    "key" : "eHh4Cg=="
+  },
+  "kind" : "Secret",
+  "metadata" : {
+    "name" : "test-secret"
+  }
+}
+
+

Example Responses

Status code: 201

+

Created

+
{
+  "apiVersion" : "cci/v2",
+  "data" : {
+    "key" : "eHh4Cg=="
+  },
+  "kind" : "Secret",
+  "metadata" : {
+    "annotations" : {
+      "secret.cci.io/namespace-uid" : "8fd96f2d-ecfa-4e4f-8f5f-4070766d333c",
+      "tenant.cci.io/tenant-id" : "08a2*************************c03"
+    },
+    "creationTimestamp" : "2024-10-09T17:13:08Z",
+    "labels" : {
+      "sys_enterprise_project_id" : "0",
+      "tenant.cci.io/tenant-id" : "08a2*************************c03",
+      "tenant.kubernetes.io/domain-id" : "08a*************************ee60",
+      "tenant.kubernetes.io/project-id" : "08a2*************************c03"
+    },
+    "name" : "test-secret",
+    "namespace" : "test-api",
+    "resourceVersion" : "391114527",
+    "uid" : "77d8dedc-b7ae-40a1-b9a6-6f37cca2c4d1"
+  },
+  "type" : "Opaque"
+}
+
+

Status Codes

+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +

Status Code

+

Description

+

200

+

OK

+

201

+

Created

+

202

+

Accepted

+

400

+

BadRequest

+

401

+

Unauthorized

+

403

+

Forbidden

+

404

+

NotFound

+

405

+

MethodNotAllowed

+

406

+

NotAcceptable

+

409

+

AlreadyExists

+

415

+

UnsupportedMediaType

+

422

+

Invalid

+

429

+

TooManyRequests

+

500

+

InternalError

+

503

+

ServiceUnavailable

+

504

+

ServerTimeout

+
+
+
+
+
+
+
Parent topic: Proprietary APIs
+
+
+ diff --git a/docs/cci/api-ref/createYangtseV2NamespacedNetwork.html b/docs/cci/api-ref/createYangtseV2NamespacedNetwork.html new file mode 100644 index 00000000..7450335b --- /dev/null +++ b/docs/cci/api-ref/createYangtseV2NamespacedNetwork.html @@ -0,0 +1,2292 @@ + + +

Creating a Network

+

Function

Create a Network.

+
+

Calling Method

For details, see Calling APIs.

+
+

URI

POST /apis/yangtse/v2/namespaces/{namespace}/networks

+ +
+ + + + + + + + + + + +
Table 1 Path Parameters

Parameter

+

Mandatory

+

Type

+

Description

+

namespace

+

Yes

+

String

+

Object name and auth scope, such as for teams and projects.

+
+
+ +
+ + + + + + + + + + + + + + + + + + + + + + + + + + +
Table 2 Query Parameters

Parameter

+

Mandatory

+

Type

+

Description

+

dryRun

+

No

+

String

+

When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed

+

fieldManager

+

No

+

String

+

fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint.

+

fieldValidation

+

No

+

String

+

fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields, provided that the ServerSideFieldValidation feature gate is also enabled. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23 and is the default behavior when the ServerSideFieldValidation feature gate is disabled. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default when the ServerSideFieldValidation feature gate is enabled. - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered.

+

pretty

+

No

+

String

+

If 'true', then the output is pretty printed.

+
+
+
+

Request Parameters

+
+ + + + + + + + + + + + + + + + +
Table 3 Request header parameters

Parameter

+

Mandatory

+

Type

+

Description

+

X-Auth-Token

+

Yes

+

String

+

User token.

+

It can be obtained through the IAM API used to obtain a user token. The value of X-Subject-Token in the response header is the user token.

+

Content-Type

+

Yes

+

String

+

The type of the message body, with a default value of "application/JSON".

+
+
+ +
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Table 4 Request body parameters

Parameter

+

Mandatory

+

Type

+

Description

+

apiVersion

+

No

+

String

+

APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#resources

+

kind

+

No

+

String

+

Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds

+

metadata

+

No

+

io.k8s.apimachinery.pkg.apis.meta.v1.ObjectMeta object

+

ObjectMeta is metadata that all persisted resources must have, which includes all objects users must create.

+

spec

+

No

+

com.otc.paas-core.yangtse.pkg.apis.yangtse.v2.NetworkSpec object

+

Specification of the desired behavior of network.

+

status

+

No

+

com.otc.paas-core.yangtse.pkg.apis.yangtse.v2.NetworkStatus object

+

Most recently observed status of the network.

+
+
+ +
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Table 5 io.k8s.apimachinery.pkg.apis.meta.v1.ObjectMeta

Parameter

+

Mandatory

+

Type

+

Description

+

annotations

+

No

+

Map<String,String>

+

Annotations is an unstructured key value map stored with a resource that may be set by external tools to store and retrieve arbitrary metadata. They are not queryable and should be preserved when modifying objects. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/annotations/

+

clusterName

+

No

+

String

+

The name of the cluster which the object belongs to. This is used to distinguish resources with same name and namespace in different clusters. This field is not set anywhere right now and apiserver is going

+

to ignore it if set in create or update request.

+

creationTimestamp

+

No

+

String

+

CreationTimestamp is a timestamp representing the server time when this object was created. It is not guaranteed to be set in happens-before order across separate operations. Clients may not set this value. It is represented in RFC3339 form and is in UTC.

+

Populated by the system. Read-only. Null for lists. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata

+

deletionGracePeriodSeconds

+

No

+

Long

+

Number of seconds allowed for this object to gracefully terminate before it will be removed from the system. Only set when deletionTimestamp is also set. May only be shortened. Read-only.

+

deletionTimestamp

+

No

+

String

+

DeletionTimestamp is RFC 3339 date and time at which this resource will be deleted. This field is set by the server when a graceful deletion is requested by the user, and is not directly settable by a client. The resource is expected to be deleted (no longer visible from resource lists, and not reachable by name) after the time in this field, once the finalizers list is empty. As long as the finalizers list contains items, deletion is blocked. Once the deletionTimestamp is set, this value may not be unset or be set further into the future, although it may be shortened or the resource may be deleted prior to this time. For example, a user may request that a pod is deleted in 30 seconds. The Kubelet will react by sending a graceful termination signal to the containers in the pod. After that 30 seconds, the Kubelet will send a hard termination signal (SIGKILL) to the container and after cleanup, remove the pod from the API. In the presence of network partitions, this object may still exist after this timestamp, until an administrator or automated process can determine the resource is fully terminated. If not set, graceful deletion of the object has not been requested.

+

Populated by the system when a graceful deletion is requested. Read-only. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata

+

enable

+

No

+

Boolean

+

Enable identifies whether the resource is available.

+

finalizers

+

No

+

Array of strings

+

Must be empty before the object is deleted from the registry.

+

Each entry is an identifier for the responsible component that will remove the entry from the list. If the deletionTimestamp of the object is non-nil, entries in this list can only be removed. Finalizers may be processed and removed in any order. Order is NOT enforced because it introduces significant risk of stuck finalizers. finalizers is a shared field, any actor with permission can reorder it. If the finalizer list is processed in order, then this can lead to a situation in which the component responsible for the first finalizer in the list is waiting for a signal (field value, external system, or other) produced by a component responsible for a finalizer later in the list, resulting in a deadlock. Without enforced ordering finalizers are free to order amongst themselves and are not vulnerable to ordering changes in the list.

+

generateName

+

No

+

String

+

GenerateName is an optional prefix, used by the server, to generate a unique name ONLY IF the Name field has not been provided. If this field is used, the name returned to the client will be different than the name passed. This value will also be combined with a unique suffix. The provided value has the same validation rules as the Name field, and may be truncated by the length of the suffix required to make the value unique on the server.

+

If this field is specified and the generated name exists, the server will NOT return a 409 - instead, it will either return 201 Created or 500 with Reason ServerTimeout indicating a unique name could not be found in the time allotted, and the client should retry (optionally after the time indicated in the Retry-After header).

+

Applied only if Name is not specified. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#idempotency

+

generation

+

No

+

Long

+

A sequence number representing a specific generation of the desired state. Populated by the system. Read-only.

+

labels

+

No

+

Map<String,String>

+

Map of string keys and values that can be used to organize and categorize (scope and select) objects. May match selectors of replication controllers and services. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/labels/

+

managedFields

+

No

+

Array of io.k8s.apimachinery.pkg.apis.meta.v1.ManagedFieldsEntry objects

+

ManagedFields maps workflow-id and version to the set of fields that are managed by that workflow. This is mostly for internal housekeeping, and users typically shouldn't need to set or understand this field. A workflow can be the user's name, a controller's name, or the name of a specific apply path like "ci-cd". The set of fields is always in the version that the workflow used when modifying the object.

+

name

+

No

+

String

+

Name must be unique within a namespace. Is required when creating resources, although some resources may allow a client to request the generation of an appropriate name automatically. Name is primarily intended for creation idempotence and configuration definition. Cannot be updated. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names

+

namespace

+

No

+

String

+

Namespace defines the space within which each name must be unique. An empty namespace is equivalent to the "default" namespace, but "default" is the canonical representation. Not all objects are required to be scoped to a namespace - the value of this field for those objects will be empty.

+

Must be a DNS_LABEL. Cannot be updated. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/namespaces/

+

ownerReferences

+

No

+

Array of io.k8s.apimachinery.pkg.apis.meta.v1.OwnerReference objects

+

List of objects depended by this object. If ALL objects in the list have been deleted, this object will be garbage collected. If this object is managed by a controller, then an entry in this list will point to this controller, with the controller field set to true. There cannot be more than one managing controller.

+

resourceVersion

+

No

+

String

+

An opaque value that represents the internal version of this object that can be used by clients to determine when objects have changed. May be used for optimistic concurrency, change detection, and the watch operation on a resource or set of resources. Clients must treat these values as opaque and passed unmodified back to the server. They may only be valid for a particular resource or set of resources.

+

Populated by the system. Read-only. Value must be treated as opaque by clients and . More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#concurrency-control-and-consistency

+

selfLink

+

No

+

String

+

SelfLink is a URL representing this object. Populated by the system. Read-only.

+

DEPRECATED Kubernetes will stop propagating this field in 1.20 release and the field is planned to be removed in 1.21 release.

+

uid

+

No

+

String

+

UID is the unique in time and space value for this object. It is typically generated by the server on successful creation of a resource and is not allowed to change on PUT operations.

+

Populated by the system. Read-only. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#uids

+
+
+ +
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Table 6 io.k8s.apimachinery.pkg.apis.meta.v1.ManagedFieldsEntry

Parameter

+

Mandatory

+

Type

+

Description

+

apiVersion

+

No

+

String

+

APIVersion defines the version of this resource that this field set applies to. The format is "group/version" just like the top-level APIVersion field. It is necessary to track the version of a field set because it cannot be automatically converted.

+

fieldsType

+

No

+

String

+

FieldsType is the discriminator for the different fields format and version. There is currently only one possible value: "FieldsV1".

+

fieldsV1

+

No

+

Object

+

FieldsV1 holds the first JSON version format as described in the "FieldsV1" type.

+

manager

+

No

+

String

+

Manager is an identifier of the workflow managing these fields.

+

operation

+

No

+

String

+

Operation is the type of operation which lead to this ManagedFieldsEntry being created. The only valid values for this field are 'Apply' and 'Update'.

+

time

+

No

+

String

+

Time is timestamp of when these fields were set. It should always be empty if Operation is 'Apply'

+
+
+ +
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Table 7 io.k8s.apimachinery.pkg.apis.meta.v1.OwnerReference

Parameter

+

Mandatory

+

Type

+

Description

+

apiVersion

+

Yes

+

String

+

API version of the referent.

+

blockOwnerDeletion

+

No

+

Boolean

+

If true, AND if the owner has the "foregroundDeletion" finalizer, then the owner cannot be deleted from the key-value store until this reference is removed. Defaults to false. To set this field, a user needs "delete" permission of the owner, otherwise 422 (Unprocessable Entity) will be returned.

+

controller

+

No

+

Boolean

+

If true, this reference points to the managing controller.

+

kind

+

Yes

+

String

+

Kind of the referent. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds

+

name

+

Yes

+

String

+

Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names

+

uid

+

Yes

+

String

+

UID of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#uids

+
+
+ +
+ + + + + + + + + + + + + + + + + + + + + + + + + + +
Table 8 com.otc.paas-core.yangtse.pkg.apis.yangtse.v2.NetworkSpec

Parameter

+

Mandatory

+

Type

+

Description

+

ipFamilies

+

No

+

Array of strings

+

IPFamilies of Network, can be "IPv4" or "IPv6".

+

networkType

+

No

+

String

+

Type of network, only support "underlay-neutron".

+

securityGroups

+

No

+

Array of strings

+

SecurityGroups of the network. NOTE: 1. nil means not enable security group; 2. [""] means enable security group but deny all; 3. ["xxx,yyy"] means enable security group and allow with security group ids;

+

subnets

+

No

+

Array of com.otc.paas-core.yangtse.pkg.apis.yangtse.v2.SubnetConf objects

+

Describes the subnets of the network.

+
+
+ +
+ + + + + + + + + + + +
Table 9 com.otc.paas-core.yangtse.pkg.apis.yangtse.v2.SubnetConf

Parameter

+

Mandatory

+

Type

+

Description

+

subnetID

+

No

+

String

+

SubnetID subnetV4ID of the subnet.

+
+
+ +
+ + + + + + + + + + + + + + + + + + + + + +
Table 10 com.otc.paas-core.yangtse.pkg.apis.yangtse.v2.NetworkStatus

Parameter

+

Mandatory

+

Type

+

Description

+

conditions

+

No

+

Array of io.k8s.apimachinery.pkg.apis.meta.v1.Condition objects

+

Conditions describe the current conditions of the Network.

+

status

+

No

+

String

+

Status of network, can be "Ready" or "Failed" or "IPInsufficient".

+

subnetAttrs

+

No

+

Array of com.otc.paas-core.yangtse.pkg.apis.yangtse.v2.SubnetAttr objects

+

SubnetAttrs describe the current subnet information of the Network.

+
+
+ +
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Table 11 io.k8s.apimachinery.pkg.apis.meta.v1.Condition

Parameter

+

Mandatory

+

Type

+

Description

+

lastTransitionTime

+

Yes

+

String

+

lastTransitionTime is the last time the condition transitioned from one status to another. This should be when the underlying condition changed. If that is not known, then using the time when the API field changed is acceptable.

+

message

+

Yes

+

String

+

message is a human readable message indicating details about the transition. This may be an empty string.

+

observedGeneration

+

No

+

Long

+

observedGeneration represents the .metadata.generation that the condition was set based upon. For instance, if .metadata.generation is currently 12, but the .status.conditions[x].observedGeneration is 9, the condition is out of date with respect to the current state of the instance.

+

reason

+

Yes

+

String

+

reason contains a programmatic identifier indicating the reason for the condition's last transition. Producers of specific condition types may define expected values and meanings for this field, and whether the values are considered a guaranteed API. The value should be a CamelCase string. This field may not be empty.

+

status

+

Yes

+

String

+

status of the condition, one of True, False, Unknown.

+

type

+

Yes

+

String

+

type of condition in CamelCase or in foo.example.com/CamelCase.

+
+
+ +
+ + + + + + + + + + + + + + + + + + + + + +
Table 12 com.otc.paas-core.yangtse.pkg.apis.yangtse.v2.SubnetAttr

Parameter

+

Mandatory

+

Type

+

Description

+

networkID

+

No

+

String

+		  

subnetV4ID

+

No

+

String

+		  

subnetV6ID

+

No

+

String

+		  
+
+
+

Response Parameters

Status code: 200

+ +
+ + + + + + + + + + + + + + + + + + + + + + + + + +
Table 13 Response body parameters

Parameter

+

Type

+

Description

+

apiVersion

+

String

+

APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#resources

+

kind

+

String

+

Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds

+

metadata

+

io.k8s.apimachinery.pkg.apis.meta.v1.ObjectMeta object

+

ObjectMeta is metadata that all persisted resources must have, which includes all objects users must create.

+

spec

+

com.otc.paas-core.yangtse.pkg.apis.yangtse.v2.NetworkSpec object

+

Specification of the desired behavior of network.

+

status

+

com.otc.paas-core.yangtse.pkg.apis.yangtse.v2.NetworkStatus object

+

Most recently observed status of the network.

+
+
+ +
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Table 14 io.k8s.apimachinery.pkg.apis.meta.v1.ObjectMeta

Parameter

+

Type

+

Description

+

annotations

+

Map<String,String>

+

Annotations is an unstructured key value map stored with a resource that may be set by external tools to store and retrieve arbitrary metadata. They are not queryable and should be preserved when modifying objects. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/annotations/

+

clusterName

+

String

+

The name of the cluster which the object belongs to. This is used to distinguish resources with same name and namespace in different clusters. This field is not set anywhere right now and apiserver is going to ignore it if set in create or update request.

+

creationTimestamp

+

String

+

CreationTimestamp is a timestamp representing the server time when this object was created. It is not guaranteed to be set in happens-before order across separate operations. Clients may not set this value. It is represented in RFC3339 form and is in UTC.

+

Populated by the system. Read-only. Null for lists. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata

+

deletionGracePeriodSeconds

+

Long

+

Number of seconds allowed for this object to gracefully terminate before it will be removed from the system. Only set when deletionTimestamp is also set. May only be shortened. Read-only.

+

deletionTimestamp

+

String

+

DeletionTimestamp is RFC 3339 date and time at which this resource will be deleted. This field is set by the server when a graceful deletion is requested by the user, and is not directly settable by a client. The resource is expected to be deleted (no longer visible from resource lists, and not reachable by name) after the time in this field, once the finalizers list is empty. As long as the finalizers list contains items, deletion is blocked. Once the deletionTimestamp is set, this value may not be unset or be set further into the future, although it may be shortened or the resource may be deleted prior to this time. For example, a user may request that a pod is deleted in 30 seconds. The Kubelet will react by sending a graceful termination signal to the containers in the pod. After that 30 seconds, the Kubelet will send a hard termination signal (SIGKILL) to the container and after cleanup, remove the pod from the API. In the presence of network partitions, this object may still exist after this timestamp, until an administrator or automated process can determine the resource is fully terminated. If not set, graceful deletion of the object has not been requested.

+

Populated by the system when a graceful deletion is requested. Read-only. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata

+

enable

+

Boolean

+

Enable identifies whether the resource is available.

+

finalizers

+

Array of strings

+

Must be empty before the object is deleted from the registry.

+

Each entry is an identifier for the responsible component that will remove the entry from the list. If the deletionTimestamp of the object is non-nil, entries in this list can only be removed. Finalizers may be processed and removed in any order. Order is NOT enforced because it introduces significant risk of stuck finalizers. finalizers is a shared field, any actor with permission can reorder it. If the finalizer list is processed in order, then this can lead to a situation in which the component responsible for the first finalizer in the list is waiting for a signal (field value, external system, or other) produced by a component responsible for a finalizer later in the list, resulting in a deadlock. Without enforced ordering finalizers are free to order amongst themselves and are not vulnerable to ordering changes in the list.

+

generateName

+

String

+

GenerateName is an optional prefix, used by the server, to generate a unique name ONLY IF the Name field has not been provided. If this field is used, the name returned to the client will be different than the name passed. This value will also be combined with a unique suffix. The provided value has the same validation rules as the Name field, and may be truncated by the length of the suffix required to make the value unique on the server.

+

If this field is specified and the generated name exists, the server will NOT return a 409 - instead, it will either return 201 Created or 500 with Reason ServerTimeout indicating a unique name could not be found in the time allotted, and the client should retry (optionally after the time indicated in the Retry-After header).

+

Applied only if Name is not specified. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#idempotency

+

generation

+

Long

+

A sequence number representing a specific generation of the desired state. Populated by the system. Read-only.

+

labels

+

Map<String,String>

+

Map of string keys and values that can be used to organize and categorize (scope and select) objects. May match selectors of replication controllers and services. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/labels/

+

managedFields

+

Array of io.k8s.apimachinery.pkg.apis.meta.v1.ManagedFieldsEntry objects

+

ManagedFields maps workflow-id and version to the set of fields that are managed by that workflow. This is mostly for internal housekeeping, and users typically shouldn't need to set or understand this field. A workflow can be the user's name, a controller's name, or the name of a specific apply path like "ci-cd". The set of fields is always in the version that the workflow used when modifying the object.

+

name

+

String

+

Name must be unique within a namespace. Is required when creating resources, although some resources may allow a client to request the generation of an appropriate name automatically. Name is primarily intended for creation idempotence and configuration definition. Cannot be updated. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names

+

namespace

+

String

+

Namespace defines the space within which each name must be unique. An empty namespace is equivalent to the "default" namespace, but "default" is the canonical representation. Not all objects are required to be scoped to a namespace - the value of this field for those objects will be empty.

+

Must be a DNS_LABEL. Cannot be updated. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/namespaces/

+

ownerReferences

+

Array of io.k8s.apimachinery.pkg.apis.meta.v1.OwnerReference objects

+

List of objects depended by this object. If ALL objects in the list have been deleted, this object will be garbage collected. If this object is managed by a controller, then an entry in this list will point to this controller, with the controller field set to true. There cannot be more than one managing controller.

+

resourceVersion

+

String

+

An opaque value that represents the internal version of this object that can be used by clients to determine when objects have changed. May be used for optimistic concurrency, change detection, and the watch operation on a resource or set of resources. Clients must treat these values as opaque and passed unmodified back to the server. They may only be valid for a particular resource or set of resources.

+

Populated by the system. Read-only. Value must be treated as opaque by clients and . More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#concurrency-control-and-consistency

+

selfLink

+

String

+

SelfLink is a URL representing this object. Populated by the system. Read-only.

+

DEPRECATED Kubernetes will stop propagating this field in 1.20 release and the field is planned to be removed in 1.21 release.

+

uid

+

String

+

UID is the unique in time and space value for this object. It is typically generated by the server on successful creation of a resource and is not allowed to change on PUT operations.

+

Populated by the system. Read-only. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#uids

+
+
+ +
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Table 15 io.k8s.apimachinery.pkg.apis.meta.v1.ManagedFieldsEntry

Parameter

+

Type

+

Description

+

apiVersion

+

String

+

APIVersion defines the version of this resource that this field set applies to. The format is "group/version" just like the top-level APIVersion field. It is necessary to track the version of a field set because it cannot be automatically converted.

+

fieldsType

+

String

+

FieldsType is the discriminator for the different fields format and version. There is currently only one possible value: "FieldsV1"

+

fieldsV1

+

Object

+

FieldsV1 holds the first JSON version format as described in the "FieldsV1" type.

+

manager

+

String

+

Manager is an identifier of the workflow managing these fields.

+

operation

+

String

+

Operation is the type of operation which lead to this ManagedFieldsEntry being created. The only valid values for this field are 'Apply' and 'Update'.

+

time

+

String

+

Time is timestamp of when these fields were set. It should always be empty if Operation is 'Apply'

+
+
+ +
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Table 16 io.k8s.apimachinery.pkg.apis.meta.v1.OwnerReference

Parameter

+

Type

+

Description

+

apiVersion

+

String

+

API version of the referent.

+

blockOwnerDeletion

+

Boolean

+

If true, AND if the owner has the "foregroundDeletion" finalizer, then the owner cannot be deleted from the key-value store until this reference is removed. Defaults to false. To set this field, a user needs "delete" permission of the owner, otherwise 422 (Unprocessable Entity) will be returned.

+

controller

+

Boolean

+

If true, this reference points to the managing controller.

+

kind

+

String

+

Kind of the referent. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds

+

name

+

String

+

Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names

+

uid

+

String

+

UID of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#uids

+
+
+ +
+ + + + + + + + + + + + + + + + + + + + + +
Table 17 com.otc.paas-core.yangtse.pkg.apis.yangtse.v2.NetworkSpec

Parameter

+

Type

+

Description

+

ipFamilies

+

Array of strings

+

IPFamilies of Network, can be "IPv4" or "IPv6".

+

networkType

+

String

+

Type of network, only support "underlay-neutron".

+

securityGroups

+

Array of strings

+

SecurityGroups of the network. NOTE: 1. nil means not enable security group; 2. [""] means enable security group but deny all; 3. ["xxx,yyy"] means enable security group and allow with security group ids;

+

subnets

+

Array of com.otc.paas-core.yangtse.pkg.apis.yangtse.v2.SubnetConf objects

+

Describes the subnets of the network.

+
+
+ +
+ + + + + + + + + +
Table 18 com.otc.paas-core.yangtse.pkg.apis.yangtse.v2.SubnetConf

Parameter

+

Type

+

Description

+

subnetID

+

String

+

SubnetID subnetV4ID of the subnet.

+
+
+ +
+ + + + + + + + + + + + + + + + + +
Table 19 com.otc.paas-core.yangtse.pkg.apis.yangtse.v2.NetworkStatus

Parameter

+

Type

+

Description

+

conditions

+

Array of io.k8s.apimachinery.pkg.apis.meta.v1.Condition objects

+

Conditions describe the current conditions of the Network.

+

status

+

String

+

Status of network, can be "Ready" or "Failed" or "IPInsufficient".

+

subnetAttrs

+

Array of com.otc.paas-core.yangtse.pkg.apis.yangtse.v2.SubnetAttr objects

+

SubnetAttrs describe the current subnet information of the Network.

+
+
+ +
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Table 20 io.k8s.apimachinery.pkg.apis.meta.v1.Condition

Parameter

+

Type

+

Description

+

lastTransitionTime

+

String

+

lastTransitionTime is the last time the condition transitioned from one status to another. This should be when the underlying condition changed. If that is not known, then using the time when the API field changed is acceptable.

+

message

+

String

+

message is a human readable message indicating details about the transition. This may be an empty string.

+

observedGeneration

+

Long

+

observedGeneration represents the .metadata.generation that the condition was set based upon. For instance, if .metadata.generation is currently 12, but the .status.conditions[x].observedGeneration is 9, the condition is out of date with respect to the current state of the instance.

+

reason

+

String

+

reason contains a programmatic identifier indicating the reason for the condition's last transition. Producers of specific condition types may define expected values and meanings for this field, and whether the values are considered a guaranteed API. The value should be a CamelCase string. This field may not be empty.

+

status

+

String

+

status of the condition, one of True, False, Unknown.

+

type

+

String

+

type of condition in CamelCase or in foo.example.com/CamelCase.

+
+
+ +
+ + + + + + + + + + + + + + + + + +
Table 21 com.otc.paas-core.yangtse.pkg.apis.yangtse.v2.SubnetAttr

Parameter

+

Type

+

Description

+

networkID

+

String

+		  

subnetV4ID

+

String

+		  

subnetV6ID

+

String

+		  
+
+

Status code: 201

+ +
+ + + + + + + + + + + + + + + + + + + + + + + + + +
Table 22 Response body parameters

Parameter

+

Type

+

Description

+

apiVersion

+

String

+

APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#resources

+

kind

+

String

+

Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds

+

metadata

+

io.k8s.apimachinery.pkg.apis.meta.v1.ObjectMeta object

+

ObjectMeta is metadata that all persisted resources must have, which includes all objects users must create.

+

spec

+

com.otc.paas-core.yangtse.pkg.apis.yangtse.v2.NetworkSpec object

+

Specification of the desired behavior of network.

+

status

+

com.otc.paas-core.yangtse.pkg.apis.yangtse.v2.NetworkStatus object

+

Most recently observed status of the network.

+
+
+ +
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Table 23 io.k8s.apimachinery.pkg.apis.meta.v1.ObjectMeta

Parameter

+

Type

+

Description

+

annotations

+

Map<String,String>

+

Annotations is an unstructured key value map stored with a resource that may be set by external tools to store and retrieve arbitrary metadata. They are not queryable and should be preserved when modifying objects. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/annotations/

+

clusterName

+

String

+

The name of the cluster which the object belongs to. This is used to distinguish resources with same name and namespace in different clusters. This field is not set anywhere right now and apiserver is going to ignore it if set in create or update request.

+

creationTimestamp

+

String

+

CreationTimestamp is a timestamp representing the server time when this object was created. It is not guaranteed to be set in happens-before order across separate operations. Clients may not set this value. It is represented in RFC3339 form and is in UTC.

+

Populated by the system. Read-only. Null for lists. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata

+

deletionGracePeriodSeconds

+

Long

+

Number of seconds allowed for this object to gracefully terminate before it will be removed from the system. Only set when deletionTimestamp is also set. May only be shortened. Read-only.

+

deletionTimestamp

+

String

+

DeletionTimestamp is RFC 3339 date and time at which this resource will be deleted. This field is set by the server when a graceful deletion is requested by the user, and is not directly settable by a client. The resource is expected to be deleted (no longer visible from resource lists, and not reachable by name) after the time in this field, once the finalizers list is empty. As long as the finalizers list contains items, deletion is blocked. Once the deletionTimestamp is set, this value may not be unset or be set further into the future, although it may be shortened or the resource may be deleted prior to this time. For example, a user may request that a pod is deleted in 30 seconds. The Kubelet will react by sending a graceful termination signal to the containers in the pod. After that 30 seconds, the Kubelet will send a hard termination signal (SIGKILL) to the container and after cleanup, remove the pod from the API. In the presence of network partitions, this object may still exist after this timestamp, until an administrator or automated process can determine the resource is fully terminated. If not set, graceful deletion of the object has not been requested.

+

Populated by the system when a graceful deletion is requested. Read-only. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata

+

enable

+

Boolean

+

Enable identifies whether the resource is available.

+

finalizers

+

Array of strings

+

Must be empty before the object is deleted from the registry.

+

Each entry is an identifier for the responsible component that will remove the entry from the list. If the deletionTimestamp of the object is non-nil, entries in this list can only be removed. Finalizers may be processed and removed in any order. Order is NOT enforced because it introduces significant risk of stuck finalizers. finalizers is a shared field, any actor with permission can reorder it. If the finalizer list is processed in order, then this can lead to a situation in which the component responsible for the first finalizer in the list is waiting for a signal (field value, external system, or other) produced by a component responsible for a finalizer later in the list, resulting in a deadlock. Without enforced ordering finalizers are free to order amongst themselves and are not vulnerable to ordering changes in the list.

+

generateName

+

String

+

GenerateName is an optional prefix, used by the server, to generate a unique name ONLY IF the Name field has not been provided. If this field is used, the name returned to the client will be different than the name passed. This value will also be combined with a unique suffix. The provided value has the same validation rules as the Name field, and may be truncated by the length of the suffix required to make the value unique on the server.

+

If this field is specified and the generated name exists, the server will NOT return a 409 - instead, it will either return 201 Created or 500 with Reason ServerTimeout indicating a unique name could not be found in the time allotted, and the client should retry (optionally after the time indicated in the Retry-After header).

+

Applied only if Name is not specified. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#idempotency

+

generation

+

Long

+

A sequence number representing a specific generation of the desired state. Populated by the system. Read-only.

+

labels

+

Map<String,String>

+

Map of string keys and values that can be used to organize and categorize (scope and select) objects. May match selectors of replication controllers and services. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/labels/

+

managedFields

+

Array of io.k8s.apimachinery.pkg.apis.meta.v1.ManagedFieldsEntry objects

+

ManagedFields maps workflow-id and version to the set of fields that are managed by that workflow. This is mostly for internal housekeeping, and users typically shouldn't need to set or understand this field. A workflow can be the user's name, a controller's name, or the name of a specific apply path like "ci-cd". The set of fields is always in the version that the workflow used when modifying the object.

+

name

+

String

+

Name must be unique within a namespace. Is required when creating resources, although some resources may allow a client to request the generation of an appropriate name automatically. Name is primarily intended for creation idempotence and configuration definition. Cannot be updated. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names

+

namespace

+

String

+

Namespace defines the space within which each name must be unique. An empty namespace is equivalent to the "default" namespace, but "default" is the canonical representation. Not all objects are required to be scoped to a namespace - the value of this field for those objects will be empty.

+

Must be a DNS_LABEL. Cannot be updated. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/namespaces/

+

ownerReferences

+

Array of io.k8s.apimachinery.pkg.apis.meta.v1.OwnerReference objects

+

List of objects depended by this object. If ALL objects in the list have been deleted, this object will be garbage collected. If this object is managed by a controller, then an entry in this list will point to this controller, with the controller field set to true. There cannot be more than one managing controller.

+

resourceVersion

+

String

+

An opaque value that represents the internal version of this object that can be used by clients to determine when objects have changed. May be used for optimistic concurrency, change detection, and the watch operation on a resource or set of resources. Clients must treat these values as opaque and passed unmodified back to the server. They may only be valid for a particular resource or set of resources.

+

Populated by the system. Read-only. Value must be treated as opaque by clients and . More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#concurrency-control-and-consistency

+

selfLink

+

String

+

SelfLink is a URL representing this object. Populated by the system. Read-only.

+

DEPRECATED Kubernetes will stop propagating this field in 1.20 release and the field is planned to be removed in 1.21 release.

+

uid

+

String

+

UID is the unique in time and space value for this object. It is typically generated by the server on successful creation of a resource and is not allowed to change on PUT operations.

+

Populated by the system. Read-only. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#uids

+
+
+ +
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Table 24 io.k8s.apimachinery.pkg.apis.meta.v1.ManagedFieldsEntry

Parameter

+

Type

+

Description

+

apiVersion

+

String

+

APIVersion defines the version of this resource that this field set applies to. The format is "group/version" just like the top-level APIVersion field. It is necessary to track the version of a field set because it cannot be automatically converted.

+

fieldsType

+

String

+

FieldsType is the discriminator for the different fields format and version. There is currently only one possible value: "FieldsV1".

+

fieldsV1

+

Object

+

FieldsV1 holds the first JSON version format as described in the "FieldsV1" type.

+

manager

+

String

+

Manager is an identifier of the workflow managing these fields.

+

operation

+

String

+

Operation is the type of operation which lead to this ManagedFieldsEntry being created. The only valid values for this field are 'Apply' and 'Update'.

+

time

+

String

+

Time is timestamp of when these fields were set. It should always be empty if Operation is 'Apply'.

+
+
+ +
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Table 25 io.k8s.apimachinery.pkg.apis.meta.v1.OwnerReference

Parameter

+

Type

+

Description

+

apiVersion

+

String

+

API version of the referent.

+

blockOwnerDeletion

+

Boolean

+

If true, AND if the owner has the "foregroundDeletion" finalizer, then the owner cannot be deleted from the key-value store until this reference is removed. Defaults to false. To set this field, a user needs "delete" permission of the owner, otherwise 422 (Unprocessable Entity) will be returned.

+

controller

+

Boolean

+

If true, this reference points to the managing controller.

+

kind

+

String

+

Kind of the referent. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds

+

name

+

String

+

Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names

+

uid

+

String

+

UID of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#uids

+
+
+ +
+ + + + + + + + + + + + + + + + + + + + + +
Table 26 com.otc.paas-core.yangtse.pkg.apis.yangtse.v2.NetworkSpec

Parameter

+

Type

+

Description

+

ipFamilies

+

Array of strings

+

IPFamilies of Network, can be "IPv4" or "IPv6".

+

networkType

+

String

+

Type of network, only support "underlay-neutron".

+

securityGroups

+

Array of strings

+

SecurityGroups of the network. NOTE: 1. nil means not enable security group; 2. [""] means enable security group but deny all; 3. ["xxx,yyy"] means enable security group and allow with security group ids;

+

subnets

+

Array of com.otc.paas-core.yangtse.pkg.apis.yangtse.v2.SubnetConf objects

+

Describes the subnets of the network.

+
+
+ +
+ + + + + + + + + +
Table 27 com.otc.paas-core.yangtse.pkg.apis.yangtse.v2.SubnetConf

Parameter

+

Type

+

Description

+

subnetID

+

String

+

SubnetID subnetV4ID of the subnet.

+
+
+ +
+ + + + + + + + + + + + + + + + + +
Table 28 com.otc.paas-core.yangtse.pkg.apis.yangtse.v2.NetworkStatus

Parameter

+

Type

+

Description

+

conditions

+

Array of io.k8s.apimachinery.pkg.apis.meta.v1.Condition objects

+

Conditions describe the current conditions of the Network.

+

status

+

String

+

Status of network, can be "Ready" or "Failed" or "IPInsufficient".

+

subnetAttrs

+

Array of com.otc.paas-core.yangtse.pkg.apis.yangtse.v2.SubnetAttr objects

+

SubnetAttrs describe the current subnet information of the Network.

+
+
+ +
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Table 29 io.k8s.apimachinery.pkg.apis.meta.v1.Condition

Parameter

+

Type

+

Description

+

lastTransitionTime

+

String

+

lastTransitionTime is the last time the condition transitioned from one status to another. This should be when the underlying condition changed. If that is not known, then using the time when the API field changed is acceptable.

+

message

+

String

+

message is a human readable message indicating details about the transition. This may be an empty string.

+

observedGeneration

+

Long

+

observedGeneration represents the .metadata.generation that the condition was set based upon. For instance, if .metadata.generation is currently 12, but the .status.conditions[x].observedGeneration is 9, the condition is out of date with respect to the current state of the instance.

+

reason

+

String

+

reason contains a programmatic identifier indicating the reason for the condition's last transition. Producers of specific condition types may define expected values and meanings for this field, and whether the values are considered a guaranteed API. The value should be a CamelCase string. This field may not be empty.

+

status

+

String

+

status of the condition, one of True, False, Unknown.

+

type

+

String

+

type of condition in CamelCase or in foo.example.com/CamelCase.

+
+
+ +
+ + + + + + + + + + + + + + + + + +
Table 30 com.otc.paas-core.yangtse.pkg.apis.yangtse.v2.SubnetAttr

Parameter

+

Type

+

Description

+

networkID

+

String

+		  

subnetV4ID

+

String

+		  

subnetV6ID

+

String

+		  
+
+

Status code: 202

+ +
+ + + + + + + + + + + + + + + + + + + + + + + + + +
Table 31 Response body parameters

Parameter

+

Type

+

Description

+

apiVersion

+

String

+

APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#resources

+

kind

+

String

+

Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds

+

metadata

+

io.k8s.apimachinery.pkg.apis.meta.v1.ObjectMeta object

+

ObjectMeta is metadata that all persisted resources must have, which includes all objects users must create.

+

spec

+

com.otc.paas-core.yangtse.pkg.apis.yangtse.v2.NetworkSpec object

+

Specification of the desired behavior of network.

+

status

+

com.otc.paas-core.yangtse.pkg.apis.yangtse.v2.NetworkStatus object

+

Most recently observed status of the network.

+
+
+ +
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Table 32 io.k8s.apimachinery.pkg.apis.meta.v1.ObjectMeta

Parameter

+

Type

+

Description

+

annotations

+

Map<String,String>

+

Annotations is an unstructured key value map stored with a resource that may be set by external tools to store and retrieve arbitrary metadata. They are not queryable and should be preserved when modifying objects. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/annotations/

+

clusterName

+

String

+

The name of the cluster which the object belongs to. This is used to distinguish resources with same name and namespace in different clusters. This field is not set anywhere right now and apiserver is going to ignore it if set in create or update request.

+

creationTimestamp

+

String

+

CreationTimestamp is a timestamp representing the server time when this object was created. It is not guaranteed to be set in happens-before order across separate operations. Clients may not set this value. It is represented in RFC3339 form and is in UTC.

+

Populated by the system. Read-only. Null for lists. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata

+

deletionGracePeriodSeconds

+

Long

+

Number of seconds allowed for this object to gracefully terminate before it will be removed from the system. Only set when deletionTimestamp is also set. May only be shortened. Read-only.

+

deletionTimestamp

+

String

+

DeletionTimestamp is RFC 3339 date and time at which this resource will be deleted. This field is set by the server when a graceful deletion is requested by the user, and is not directly settable by a client. The resource is expected to be deleted (no longer visible from resource lists, and not reachable by name) after the time in this field, once the finalizers list is empty. As long as the finalizers list contains items, deletion is blocked. Once the deletionTimestamp is set, this value may not be unset or be set further into the future, although it may be shortened or the resource may be deleted prior to this time. For example, a user may request that a pod is deleted in 30 seconds. The Kubelet will react by sending a graceful termination signal to the containers in the pod. After that 30 seconds, the Kubelet will send a hard termination signal (SIGKILL) to the container and after cleanup, remove the pod from the API. In the presence of network partitions, this object may still exist after this timestamp, until an administrator or automated process can determine the resource is fully terminated. If not set, graceful deletion of the object has not been requested.

+

Populated by the system when a graceful deletion is requested. Read-only. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata

+

enable

+

Boolean

+

Enable identifies whether the resource is available.

+

finalizers

+

Array of strings

+

Must be empty before the object is deleted from the registry.

+

Each entry is an identifier for the responsible component that will remove the entry from the list. If the deletionTimestamp of the object is non-nil, entries in this list can only be removed. Finalizers may be processed and removed in any order. Order is NOT enforced because it introduces significant risk of stuck finalizers. finalizers is a shared field, any actor with permission can reorder it. If the finalizer list is processed in order, then this can lead to a situation in which the component responsible for the first finalizer in the list is waiting for a signal (field value, external system, or other) produced by a component responsible for a finalizer later in the list, resulting in a deadlock. Without enforced ordering finalizers are free to order amongst themselves and are not vulnerable to ordering changes in the list.

+

generateName

+

String

+

GenerateName is an optional prefix, used by the server, to generate a unique name ONLY IF the Name field has not been provided. If this field is used, the name returned to the client will be different than the name passed. This value will also be combined with a unique suffix. The provided value has the same validation rules as the Name field, and may be truncated by the length of the suffix required to make the value unique on the server.

+

If this field is specified and the generated name exists, the server will NOT return a 409 - instead, it will either return 201 Created or 500 with Reason ServerTimeout indicating a unique name could not be found in the time allotted, and the client should retry (optionally after the time indicated in the Retry-After header).

+

Applied only if Name is not specified. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#idempotency

+

generation

+

Long

+

A sequence number representing a specific generation of the desired state. Populated by the system. Read-only.

+

labels

+

Map<String,String>

+

Map of string keys and values that can be used to organize and categorize (scope and select) objects. May match selectors of replication controllers and services. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/labels/

+

managedFields

+

Array of io.k8s.apimachinery.pkg.apis.meta.v1.ManagedFieldsEntry objects

+

ManagedFields maps workflow-id and version to the set of fields that are managed by that workflow. This is mostly for internal housekeeping, and users typically shouldn't need to set or understand this field. A workflow can be the user's name, a controller's name, or the name of a specific apply path like "ci-cd". The set of fields is always in the version that the workflow used when modifying the object.

+

name

+

String

+

Name must be unique within a namespace. Is required when creating resources, although some resources may allow a client to request the generation of an appropriate name automatically. Name is primarily intended for creation idempotence and configuration definition. Cannot be updated. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names

+

namespace

+

String

+

Namespace defines the space within which each name must be unique. An empty namespace is equivalent to the "default" namespace, but "default" is the canonical representation. Not all objects are required to be scoped to a namespace - the value of this field for those objects will be empty.

+

Must be a DNS_LABEL. Cannot be updated. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/namespaces/

+

ownerReferences

+

Array of io.k8s.apimachinery.pkg.apis.meta.v1.OwnerReference objects

+

List of objects depended by this object. If ALL objects in the list have been deleted, this object will be garbage collected. If this object is managed by a controller, then an entry in this list will point to this controller, with the controller field set to true. There cannot be more than one managing controller.

+

resourceVersion

+

String

+

An opaque value that represents the internal version of this object that can be used by clients to determine when objects have changed. May be used for optimistic concurrency, change detection, and the watch operation on a resource or set of resources. Clients must treat these values as opaque and passed unmodified back to the server. They may only be valid for a particular resource or set of resources.

+

Populated by the system. Read-only. Value must be treated as opaque by clients and . More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#concurrency-control-and-consistency

+

selfLink

+

String

+

SelfLink is a URL representing this object. Populated by the system. Read-only.

+

DEPRECATED Kubernetes will stop propagating this field in 1.20 release and the field is planned to be removed in 1.21 release.

+

uid

+

String

+

UID is the unique in time and space value for this object. It is typically generated by the server on successful creation of a resource and is not allowed to change on PUT operations.

+

Populated by the system. Read-only. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#uids

+
+
+ +
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Table 33 io.k8s.apimachinery.pkg.apis.meta.v1.ManagedFieldsEntry

Parameter

+

Type

+

Description

+

apiVersion

+

String

+

APIVersion defines the version of this resource that this field set applies to. The format is "group/version" just like the top-level APIVersion field. It is necessary to track the version of a field set because it cannot be automatically converted.

+

fieldsType

+

String

+

FieldsType is the discriminator for the different fields format and version. There is currently only one possible value: "FieldsV1".

+

fieldsV1

+

Object

+

FieldsV1 holds the first JSON version format as described in the "FieldsV1" type.

+

manager

+

String

+

Manager is an identifier of the workflow managing these fields.

+

operation

+

String

+

Operation is the type of operation which lead to this ManagedFieldsEntry being created. The only valid values for this field are 'Apply' and 'Update'.

+

time

+

String

+

Time is timestamp of when these fields were set. It should always be empty if Operation is 'Apply'.

+
+
+ +
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Table 34 io.k8s.apimachinery.pkg.apis.meta.v1.OwnerReference

Parameter

+

Type

+

Description

+

apiVersion

+

String

+

API version of the referent.

+

blockOwnerDeletion

+

Boolean

+

If true, AND if the owner has the "foregroundDeletion" finalizer, then the owner cannot be deleted from the key-value store until this reference is removed. Defaults to false. To set this field, a user needs "delete" permission of the owner, otherwise 422 (Unprocessable Entity) will be returned.

+

controller

+

Boolean

+

If true, this reference points to the managing controller.

+

kind

+

String

+

Kind of the referent. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds

+

name

+

String

+

Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names

+

uid

+

String

+

UID of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#uids

+
+
+ +
+ + + + + + + + + + + + + + + + + + + + + +
Table 35 com.otc.paas-core.yangtse.pkg.apis.yangtse.v2.NetworkSpec

Parameter

+

Type

+

Description

+

ipFamilies

+

Array of strings

+

IPFamilies of Network, can be "IPv4" or "IPv6".

+

networkType

+

String

+

Type of network, only support "underlay-neutron".

+

securityGroups

+

Array of strings

+

SecurityGroups of the network. NOTE: 1. nil means not enable security group; 2. [""] means enable security group but deny all; 3. ["xxx,yyy"] means enable security group and allow with security group ids;

+

subnets

+

Array of com.otc.paas-core.yangtse.pkg.apis.yangtse.v2.SubnetConf objects

+

Describes the subnets of the network.

+
+
+ +
+ + + + + + + + + +
Table 36 com.otc.paas-core.yangtse.pkg.apis.yangtse.v2.SubnetConf

Parameter

+

Type

+

Description

+

subnetID

+

String

+

SubnetID subnetV4ID of the subnet.

+
+
+ +
+ + + + + + + + + + + + + + + + + +
Table 37 com.otc.paas-core.yangtse.pkg.apis.yangtse.v2.NetworkStatus

Parameter

+

Type

+

Description

+

conditions

+

Array of io.k8s.apimachinery.pkg.apis.meta.v1.Condition objects

+

Conditions describe the current conditions of the Network.

+

status

+

String

+

Status of network, can be "Ready" or "Failed" or "IPInsufficient".

+

subnetAttrs

+

Array of com.otc.paas-core.yangtse.pkg.apis.yangtse.v2.SubnetAttr objects

+

SubnetAttrs describe the current subnet information of the Network.

+
+
+ +
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Table 38 io.k8s.apimachinery.pkg.apis.meta.v1.Condition

Parameter

+

Type

+

Description

+

lastTransitionTime

+

String

+

lastTransitionTime is the last time the condition transitioned from one status to another. This should be when the underlying condition changed. If that is not known, then using the time when the API field changed is acceptable.

+

message

+

String

+

message is a human readable message indicating details about the transition. This may be an empty string.

+

observedGeneration

+

Long

+

observedGeneration represents the .metadata.generation that the condition was set based upon. For instance, if .metadata.generation is currently 12, but the .status.conditions[x].observedGeneration is 9, the condition is out of date with respect to the current state of the instance.

+

reason

+

String

+

reason contains a programmatic identifier indicating the reason for the condition's last transition. Producers of specific condition types may define expected values and meanings for this field, and whether the values are considered a guaranteed API. The value should be a CamelCase string. This field may not be empty.

+

status

+

String

+

status of the condition, one of True, False, Unknown.

+

type

+

String

+

type of condition in CamelCase or in foo.example.com/CamelCase.

+
+
+ +
+ + + + + + + + + + + + + + + + + +
Table 39 com.otc.paas-core.yangtse.pkg.apis.yangtse.v2.SubnetAttr

Parameter

+

Type

+

Description

+

networkID

+

String

+		  

subnetV4ID

+

String

+		  

subnetV6ID

+

String

+		  
+
+
+

Example Requests

{
+  "apiVersion" : "yangtse/v2",
+  "kind" : "Network",
+  "metadata" : {
+    "annotations" : {
+      "yangtse.io/domain-id" : "08a*************************ee60",
+      "yangtse.io/project-id" : "08a2*************************c03",
+      "yangtse.io/warm-pool-recycle-interval" : "1",
+      "yangtse.io/warm-pool-size" : "10"
+    },
+    "name" : "test-api"
+  },
+  "spec" : {
+    "networkType" : "underlay_neutron",
+    "securityGroups" : [ "4120c2f9-3a1d-453e-9b64-f51b92861e26" ],
+    "subnets" : [ {
+      "subnetID" : "2eb62e19-cf1a-4741-90cc-90fb127b20ab"
+    } ]
+  }
+}
+
+

Example Responses

Status code: 201

+

Created

+
{
+  "apiVersion" : "yangtse/v2",
+  "kind" : "Network",
+  "metadata" : {
+    "annotations" : {
+      "yangtse.io/domain-id" : "08a*************************ee60",
+      "yangtse.io/project-id" : "08a2*************************c03",
+      "yangtse.io/warm-pool-recycle-interval" : "1",
+      "yangtse.io/warm-pool-size" : "10"
+    },
+    "creationTimestamp" : "2024-03-25T09:27:52Z",
+    "finalizers" : [ "yangtse.io/network-cleanup" ],
+    "name" : "test-api",
+    "namespace" : "test-api",
+    "resourceVersion" : "17365331",
+    "uid" : "70c20697-a233-4405-b512-ebec1d3c58d0"
+  },
+  "spec" : {
+    "networkType" : "underlay_neutron",
+    "securityGroups" : [ "4120c2f9-3a1d-453e-9b64-f51b92861e26" ],
+    "subnets" : [ {
+      "subnetID" : "2eb62e19-cf1a-4741-90cc-90fb127b20ab"
+    } ]
+  },
+  "status" : {
+    "conditions" : [ {
+      "lastTransitionTime" : "2024-03-25T09:27:53Z",
+      "message" : "",
+      "reason" : "",
+      "status" : "True",
+      "type" : "NetworkSynced"
+    }, {
+      "lastTransitionTime" : "2024-08-12T15:40:03Z",
+      "message" : "",
+      "reason" : "",
+      "status" : "True",
+      "type" : "NetworkExternalDependenciesSynced"
+    } ],
+    "status" : "Ready",
+    "subnetAttrs" : [ {
+      "networkID" : "377b6228-d2a7-47ab-bdb0-f7fc59802198",
+      "subnetV4ID" : "2eb62e19-cf1a-4741-90cc-90fb127b20ab"
+    } ]
+  }
+}
+
+

Status Codes

+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +

Status Code

+

Description

+

200

+

OK

+

201

+

Created

+

202

+

Accepted

+

400

+

BadRequest

+

401

+

Unauthorized

+

403

+

Forbidden

+

404

+

NotFound

+

405

+

MethodNotAllowed

+

406

+

NotAcceptable

+

409

+

AlreadyExists

+

415

+

UnsupportedMediaType

+

422

+

Invalid

+

429

+

TooManyRequests

+

500

+

InternalError

+

503

+

ServiceUnavailable

+

504

+

ServerTimeout

+
+
+
+
+
+
+
Parent topic: Proprietary APIs
+
+
+ diff --git a/docs/cci/api-ref/deleteCciV2Namespace.html b/docs/cci/api-ref/deleteCciV2Namespace.html new file mode 100644 index 00000000..d857b58a --- /dev/null +++ b/docs/cci/api-ref/deleteCciV2Namespace.html @@ -0,0 +1,794 @@ + + +

Deleting a Namespace

+

Function

Delete a Namespace.

+
+

Calling Method

For details, see Calling APIs.

+
+

URI

DELETE /apis/cci/v2/namespaces/{name}

+ +
+ + + + + + + + + + + +
Table 1 Path Parameters

Parameter

+

Mandatory

+

Type

+

Description

+

name

+

Yes

+

String

+

Name of the Namespace

+
+
+ +
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Table 2 Query Parameters

Parameter

+

Mandatory

+

Type

+

Description

+

dryRun

+

No

+

String

+

When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed

+

gracePeriodSeconds

+

No

+

Integer

+

The duration in seconds before the object should be deleted.

+

Value must be non-negative integer. The value zero indicates delete immediately.

+

If this value is nil, the default grace period for the specified type will be used. Defaults to a per object value if not specified. zero means delete immediately.

+

orphanDependents

+

No

+

Boolean

+

Deprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the "orphan" finalizer will be added to/removed from the object's finalizers list. Either this field or PropagationPolicy may be set, but not both.

+

propagationPolicy

+

No

+

String

+

Whether and how garbage collection will be performed. Either this field or OrphanDependents may be set, but not both. The default policy is decided by the existing finalizer set in the metadata.finalizers and the resource-specific default policy. Acceptable values are: 'Orphan' - orphan the dependents; 'Background' - allow the garbage collector to delete the dependents in the background; 'Foreground' - a cascading policy that deletes all dependents in the foreground.

+

pretty

+

No

+

String

+

If 'true', then the output is pretty printed.

+
+
+
+

Request Parameters

+
+ + + + + + + + + + + + + + + + +
Table 3 Request header parameters

Parameter

+

Mandatory

+

Type

+

Description

+

X-Auth-Token

+

Yes

+

String

+

User token.

+

It can be obtained through the IAM API used to obtain a user token. The value of X-Subject-Token in the response header is the user token.

+

Content-Type

+

Yes

+

String

+

The type of the message body, with a default value of "application/JSON".

+
+
+ +
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Table 4 Request body parameters

Parameter

+

Mandatory

+

Type

+

Description

+

apiVersion

+

No

+

String

+

APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#resources

+

dryRun

+

No

+

Array of strings

+

When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed

+

gracePeriodSeconds

+

No

+

Long

+

The duration in seconds before the object should be deleted.

+

Value must be non-negative integer. The value zero indicates delete immediately.

+

If this value is nil, the default grace period for the specified type will be used. Defaults to a per object value if not specified. zero means delete immediately.

+

kind

+

No

+

String

+

Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds

+

orphanDependents

+

No

+

Boolean

+

Deprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the "orphan" finalizer will be added to/removed from the object's finalizers list. Either this field or PropagationPolicy may be set, but not both.

+

preconditions

+

No

+

io.k8s.apimachinery.pkg.apis.meta.v1.Preconditions object

+

Must be fulfilled before a deletion is carried out. If not possible, a 409 Conflict status will be returned.

+

propagationPolicy

+

No

+

String

+

Whether and how garbage collection will be performed. Either this field or OrphanDependents may be set, but not both. The default policy is decided by the existing finalizer set in the metadata.finalizers and the resource-specific default policy. Acceptable values are: 'Orphan' - orphan the dependents; 'Background' - allow the garbage collector to delete the dependents in the background; 'Foreground' - a cascading policy that deletes all dependents in the foreground.

+
+
+ +
+ + + + + + + + + + + + + + + + +
Table 5 io.k8s.apimachinery.pkg.apis.meta.v1.Preconditions

Parameter

+

Mandatory

+

Type

+

Description

+

resourceVersion

+

No

+

String

+

Specifies the target ResourceVersion.

+

uid

+

No

+

String

+

Specifies the target UID.

+
+
+
+

Response Parameters

Status code: 200

+ +
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Table 6 Response body parameters

Parameter

+

Type

+

Description

+

apiVersion

+

String

+

APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#resources

+

code

+

Integer

+

Suggested HTTP return code for this status, 0 if not set.

+

details

+

io.k8s.apimachinery.pkg.apis.meta.v1.StatusDetails object

+

Extended data associated with the reason. Each reason may define its own extended details. This field is optional and the data returned is not guaranteed to conform to any schema except that defined by the reason type.

+

kind

+

String

+

Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds

+

message

+

String

+

A human-readable description of the status of this operation.

+

metadata

+

io.k8s.apimachinery.pkg.apis.meta.v1.ListMeta object

+

Standard list metadata. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds

+

reason

+

String

+

A machine-readable description of why this operation is in the "Failure" status. If this value is empty there is no information available.

+

A Reason clarifies an HTTP status code but does not override it.

+

status

+

String

+

Status of the operation. One of: "Success" or "Failure". More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#spec-and-status

+
+
+ +
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Table 7 io.k8s.apimachinery.pkg.apis.meta.v1.StatusDetails

Parameter

+

Type

+

Description

+

causes

+

Array of io.k8s.apimachinery.pkg.apis.meta.v1.StatusCause objects

+

The Causes array includes more details associated with the StatusReason failure. Not all StatusReasons may provide detailed causes.

+

group

+

String

+

The group attribute of the resource associated with the status StatusReason.

+

kind

+

String

+

The kind attribute of the resource associated with the status StatusReason. On some operations may differ from the requested resource Kind. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds

+

name

+

String

+

The name attribute of the resource associated with the status StatusReason (when there is a single name which can be described).

+

retryAfterSeconds

+

Integer

+

If specified, the time in seconds before the operation should

+

be retried. Some errors may indicate the client must take an alternate action

+
  • for those errors this field may indicate how long to wait before taking

    the alternate action.

    +
+

uid

+

String

+

UID of the resource (when there is a single resource which can be described). More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#uids

+
+
+ +
+ + + + + + + + + + + + + + + + + +
Table 8 io.k8s.apimachinery.pkg.apis.meta.v1.StatusCause

Parameter

+

Type

+

Description

+

field

+

String

+

The field of the resource that has caused this error, as named by its JSON serialization. May include dot and postfix notation for nested attributes. Arrays are zero-indexed. Fields may appear more than once in an array of causes due to fields having multiple errors. Optional.

+

Examples:

+

"name" - the field "name" on the current resource

+

"items[0].name" - the field "name" on the first array entry in "items"

+

message

+

String

+

A human-readable description of the cause of the error. This field may be presented as-is to a reader.

+

reason

+

String

+

A machine-readable description of the cause of the error. If this value is empty there is no information available.

+
+
+ +
+ + + + + + + + + + + + + + + + + + + + + +
Table 9 io.k8s.apimachinery.pkg.apis.meta.v1.ListMeta

Parameter

+

Type

+

Description

+

continue

+

String

+

continue may be set if the user set a limit on the number of

+

items returned, and indicates that the server has more data available. The

+

value is opaque and may be used to issue another request to the endpoint

+

that served this list to retrieve the next set of available objects. Continuing

+

a consistent list may not be possible if the server configuration has changed

+

or more than a few minutes have passed. The resourceVersion field returned

+

when using this continue value will be identical to the value in the first

+

response, unless you have received this token from an error message.

+

remainingItemCount

+

Long

+

remainingItemCount is the number of subsequent items in the list which are not included in this list response. If the list request contained label or field selectors, then the number of remaining items is unknown and the field will be left unset and omitted during serialization. If the list is complete (either because it is not chunking or because this is the last chunk), then there are no more remaining items and this field will be left unset and omitted during serialization. Servers older than v1.15 do not set this field. The intended use of the remainingItemCount is estimating the size of a collection. Clients should not rely on the remainingItemCount to be set or to be exact.

+

resourceVersion

+

String

+

String that identifies the server's internal version of this object that can be used by clients to determine when objects have changed. Value must be treated as opaque by clients and passed unmodified back to the server. Populated by the system. Read-only. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#concurrency-control-and-consistency

+

selfLink

+

String

+

selfLink is a URL representing this object. Populated by the system. Read-only.

+

DEPRECATED Kubernetes will stop propagating this field in 1.20 release and the field is planned to be removed in 1.21 release.

+
+
+

Status code: 202

+ +
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Table 10 Response body parameters

Parameter

+

Type

+

Description

+

apiVersion

+

String

+

APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#resources

+

code

+

Integer

+

Suggested HTTP return code for this status, 0 if not set.

+

details

+

io.k8s.apimachinery.pkg.apis.meta.v1.StatusDetails object

+

Extended data associated with the reason. Each reason may define its own extended details. This field is optional and the data returned is not guaranteed to conform to any schema except that defined by the reasontype.

+

kind

+

String

+

Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds

+

message

+

String

+

A human-readable description of the status of this operation.

+

metadata

+

io.k8s.apimachinery.pkg.apis.meta.v1.ListMeta object

+

Standard list metadata. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds

+

reason

+

String

+

A machine-readable description of why this operation is in the "Failure" status. If this value is empty there is no information available.

+

A Reason clarifies an HTTP status code but does not override it.

+

status

+

String

+

Status of the operation. One of: "Success" or "Failure". More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#spec-and-status

+
+
+ +
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Table 11 io.k8s.apimachinery.pkg.apis.meta.v1.StatusDetails

Parameter

+

Type

+

Description

+

causes

+

Array of io.k8s.apimachinery.pkg.apis.meta.v1.StatusCause objects

+

The Causes array includes more details associated with the StatusReason failure. Not all StatusReasons may provide detailed causes.

+

group

+

String

+

The group attribute of the resource associated with the status StatusReason.

+

kind

+

String

+

The kind attribute of the resource associated with the status StatusReason. On some operations may differ from the requested resource Kind. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds

+

name

+

String

+

The name attribute of the resource associated with the status StatusReason (when there is a single name which can be described).

+

retryAfterSeconds

+

Integer

+

If specified, the time in seconds before the operation should

+

be retried. Some errors may indicate the client must take an alternate action

+
  • for those errors this field may indicate how long to wait before taking

    the alternate action.

    +
+

uid

+

String

+

UID of the resource. (when there is a single resource which can be described). More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#uids

+
+
+ +
+ + + + + + + + + + + + + + + + + +
Table 12 io.k8s.apimachinery.pkg.apis.meta.v1.StatusCause

Parameter

+

Type

+

Description

+

field

+

String

+

The field of the resource that has caused this error, as named by its JSON serialization. May include dot and postfix notation for nested attributes. Arrays are zero-indexed. Fields may appear more than once in an array of causes due to fields having multiple errors. Optional.

+

Examples:

+

"name" - the field "name" on the current resource

+

"items[0].name" - the field "name" on the first array entry in "items"

+

message

+

String

+

A human-readable description of the cause of the error. This field may be presented as-is to a reader.

+

reason

+

String

+

A machine-readable description of the cause of the error. If this value is empty there is no information available.

+
+
+ +
+ + + + + + + + + + + + + + + + + + + + + +
Table 13 io.k8s.apimachinery.pkg.apis.meta.v1.ListMeta

Parameter

+

Type

+

Description

+

continue

+

String

+

continue may be set if the user set a limit on the number of items returned, and indicates that the server has more data available. The value is opaque and may be used to issue another request to the endpoint that served this list to retrieve the next set of available objects. Continuing a consistent list may not be possible if the server configuration has changed or more than a few minutes have passed. The resourceVersion field returned when using this continue value will be identical to the value in the first response, unless you have received this token from an error message.

+

remainingItemCount

+

Long

+

remainingItemCount is the number of subsequent items in the list which are not included in this list response. If the list request contained label or field selectors, then the number of remaining items is unknown and the field will be left unset and omitted during serialization. If the list is complete (either because it is not chunking or because this is the last chunk), then there are no more remaining items and this field will be left unset and omitted during serialization. Servers older than v1.15 do not set this field. The intended use of the remainingItemCount is estimating the size of a collection. Clients should not rely on the remainingItemCount to be set or to be exact.

+

resourceVersion

+

String

+

String that identifies the server's internal version of this object that can be used by clients to determine when objects have changed. Value must be treated as opaque by clients and passed unmodified back to the server. Populated by the system. Read-only. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#concurrency-control-and-consistency

+

selfLink

+

String

+

selfLink is a URL representing this object. Populated by the system. Read-only.

+

DEPRECATED Kubernetes will stop propagating this field in 1.20 release and the field is planned to be removed in 1.21 release.

+
+
+
+

Example Requests

None

+
+

Example Responses

Status code: 200

+

OK

+
{
+  "apiVersion" : "cci/v2",
+  "kind" : "Namespace",
+  "metadata" : {
+    "annotations" : {
+      "tenant.cci.io/tenant-id" : "08a2*************************c03",
+      "tenant.kubernetes.io/domain-id" : "08a*************************ee60",
+      "tenant.kubernetes.io/domain-name" : "fake-user",
+      "tenant.kubernetes.io/project-id" : "08a2*************************c03",
+      "tenant.kubernetes.io/project-name" : "region1",
+      "volcano.sh/queue-name" : "v5-queue"
+    },
+    "creationTimestamp" : "2024-10-09T11:50:45Z",
+    "deletionTimestamp" : "2024-10-09T11:55:42Z",
+    "labels" : {
+      "kubernetes.io/metadata.name" : "test"
+    },
+    "name" : "test",
+    "resourceVersion" : "391017723",
+    "uid" : "5a8f7966-70cb-41c6-bec7-46f37eda4973"
+  },
+  "spec" : {
+    "finalizers" : [ "kubernetes" ]
+  },
+  "status" : {
+    "phase" : "Terminating"
+  }
+}
+

Status code: 404

+
{
+  "apiVersion" : "v1",
+  "code" : 404,
+  "details" : {
+    "group" : "cci",
+    "kind" : "namespaces",
+    "name" : "test"
+  },
+  "kind" : "Status",
+  "message" : "namespaces.cci \"test\" not found",
+  "metadata" : { },
+  "reason" : "NotFound",
+  "status" : "Failure"
+}
+
+

Status Codes

+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +

Status Code

+

Description

+

200

+

OK

+

202

+

Accepted

+

400

+

BadRequest

+

401

+

Unauthorized

+

403

+

Forbidden

+

404

+		  

405

+

MethodNotAllowed

+

406

+

NotAcceptable

+

409

+

Conflict

+

415

+

UnsupportedMediaType

+

422

+

Invalid

+

429

+

TooManyRequests

+

500

+

InternalError

+

503

+

ServiceUnavailable

+

504

+

ServerTimeout

+
+
+
+
+
+
+
Parent topic: Proprietary APIs
+
+
+ diff --git a/docs/cci/api-ref/deleteCciV2NamespacedConfigMap.html b/docs/cci/api-ref/deleteCciV2NamespacedConfigMap.html new file mode 100644 index 00000000..67789b3e --- /dev/null +++ b/docs/cci/api-ref/deleteCciV2NamespacedConfigMap.html @@ -0,0 +1,978 @@ + + +

Deleting a ConfigMap

+

Function

Delete a ConfigMap.

+
+

Calling Method

For details, see Calling APIs.

+
+

URI

DELETE /apis/cci/v2/namespaces/{namespace}/configmaps/{name}

+ +
+ + + + + + + + + + + + + + + + +
Table 1 Path Parameters

Parameter

+

Mandatory

+

Type

+

Description

+

name

+

Yes

+

String

+

NName of the ConfigMap..

+

namespace

+

Yes

+

String

+

Object name and auth scope, such as for teams and projects.

+
+
+ +
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Table 2 Query Parameters

Parameter

+

Mandatory

+

Type

+

Description

+

dryRun

+

No

+

String

+

When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed.

+

gracePeriodSeconds

+

No

+

Integer

+

The duration in seconds before the object should be deleted.

+

Value must be non-negative integer. The value zero indicates delete immediately.

+

If this value is nil, the default grace period for the specified type will be used. Defaults to a per object value if not specified. zero means delete immediately.

+

orphanDependents

+

No

+

Boolean

+

Deprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the "orphan" finalizer will be added to/removed from the object's finalizers list. Either this field or PropagationPolicy may be set, but not both.

+

propagationPolicy

+

No

+

String

+

Whether and how garbage collection will be performed. Either this field or OrphanDependents may be set, but not both. The default policy is decided by the existing finalizer set in the metadata.finalizers and the resource-specific default policy. Acceptable values are: 'Orphan' - orphan the dependents; 'Background' - allow the garbage collector to delete the dependents in the background; 'Foreground' - a cascading policy that deletes all dependents in the foreground.

+

pretty

+

No

+

String

+

If 'true', then the output is pretty printed.

+
+
+
+

Request Parameters

+
+ + + + + + + + + + + + + + + + +
Table 3 Request header parameters

Parameter

+

Mandatory

+

Type

+

Description

+

X-Auth-Token

+

Yes

+

String

+

User Token.

+

It can be obtained through the IAM API used to obtain a user token. The value of X-Subject-Token in the response header is the user token.

+

Content-Type

+

Yes

+

String

+

The type of the message body, with a default value of "application/JSON".

+
+
+ +
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Table 4 Request body parameters

Parameter

+

Mandatory

+

Type

+

Description

+

apiVersion

+

No

+

String

+

APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#resources

+

dryRun

+

No

+

Array of strings

+

When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed

+

gracePeriodSeconds

+

No

+

Long

+

The duration in seconds before the object should be deleted.

+

Value must be non-negative integer. The value zero indicates delete immediately.

+

If this value is nil, the default grace period for the specified type will be used. Defaults to a per object value if not specified. zero means delete immediately.

+

kind

+

No

+

String

+

Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds

+

orphanDependents

+

No

+

Boolean

+

Deprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the "orphan" finalizer will be added to/removed from the object's finalizers list. Either this field or PropagationPolicy may be set, but not both.

+

preconditions

+

No

+

io.k8s.apimachinery.pkg.apis.meta.v1.Preconditions object

+

Must be fulfilled before a deletion is carried out. If not possible, a 409 Conflict status will be returned.

+

propagationPolicy

+

No

+

String

+

Whether and how garbage collection will be performed. Either this field or OrphanDependents may be set, but not both. The default policy is decided by the existing finalizer set in the metadata.finalizers and the resource-specific default policy. Acceptable values are: 'Orphan' - orphan the dependents; 'Background' - allow the garbage collector to delete the dependents in the background; 'Foreground' - a cascading policy that deletes all dependents in the foreground.

+
+
+ +
+ + + + + + + + + + + + + + + + +
Table 5 io.k8s.apimachinery.pkg.apis.meta.v1.Preconditions

Parameter

+

Mandatory

+

Type

+

Description

+

resourceVersion

+

No

+

String

+

Specifies the target ResourceVersion.

+

uid

+

No

+

String

+

Specifies the target UID.

+
+
+
+

Response Parameters

Status code: 200

+ +
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Table 6 Response body parameters

Parameter

+

Type

+

Description

+

apiVersion

+

String

+

APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#resources

+

binaryData

+

Map<String,String>

+

BinaryData contains the binary data. Each key must consist of alphanumeric characters, '-', '_' or '.'. BinaryData can contain byte sequences that are not in the UTF-8 range. The keys stored in BinaryData must not overlap with the ones in the Data field, this is enforced during validation process. Using this field will require 1.10+ apiserver and kubelet.

+

data

+

Map<String,String>

+

Data contains the configuration data. Each key must consist of alphanumeric characters, '-', '_' or '.'. Values with non-UTF-8 byte sequences must use the BinaryData field. The keys stored in Data must not overlap with the keys in the BinaryData field, this is enforced during validation process.

+

immutable

+

Boolean

+

Immutable, if set to true, ensures that data stored in the ConfigMap cannot be updated (only object metadata can be modified). If not set to true, the field can be modified at any time. Defaulted to nil.

+

kind

+

String

+

Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds

+

metadata

+

io.k8s.apimachinery.pkg.apis.meta.v1.ObjectMeta object

+

Standard object's metadata. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata

+
+
+ +
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Table 7 io.k8s.apimachinery.pkg.apis.meta.v1.ObjectMeta

Parameter

+

Type

+

Description

+

annotations

+

Map<String,String>

+

Annotations is an unstructured key value map stored with a resource that may be set by external tools to store and retrieve arbitrary metadata. They are not queryable and should be preserved when modifying objects. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/annotations/

+

clusterName

+

String

+

The name of the cluster which the object belongs to. This is used to distinguish resources with same name and namespace in different clusters. This field is not set anywhere right now and apiserver is going to ignore it if set in create or update request.

+

creationTimestamp

+

String

+

CreationTimestamp is a timestamp representing the server time when this object was created. It is not guaranteed to be set in happens-before order across separate operations. Clients may not set this value. It is represented in RFC3339 form and is in UTC.

+

Populated by the system. Read-only. Null for lists. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata

+

deletionGracePeriodSeconds

+

Long

+

Number of seconds allowed for this object to gracefully terminate before it will be removed from the system. Only set when deletionTimestamp is also set. May only be shortened. Read-only.

+

deletionTimestamp

+

String

+

DeletionTimestamp is RFC 3339 date and time at which this resource will be deleted. This field is set by the server when a graceful deletion is requested by the user, and is not directly settable by a client. The resource is expected to be deleted (no longer visible from resource lists, and not reachable by name) after the time in this field, once the finalizers list is empty. As long as the finalizers list contains items, deletion is blocked. Once the deletionTimestamp is set, this value may not be unset or be set further into the future, although it may be shortened or the resource may be deleted prior to this time. For example, a user may request that a pod is deleted in 30 seconds. The Kubelet will react by sending a graceful termination signal to the containers in the pod. After that 30 seconds, the Kubelet will send a hard termination signal (SIGKILL) to the container and after cleanup, remove the pod from the API. In the presence of network partitions, this object may still exist after this timestamp, until an administrator or automated process can determine the resource is fully terminated. If not set, graceful deletion of the object has not been requested.

+

Populated by the system when a graceful deletion is requested. Read-only. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata

+

enable

+

Boolean

+

Enable identify whether the resource is available

+

finalizers

+

Array of strings

+

Must be empty before the object is deleted from the registry.

+

Each entry is an identifier for the responsible component that will remove the entry from the list. If the deletionTimestamp of the object is non-nil, entries in this list can only be removed. Finalizers may be processed and removed in any order. Order is NOT enforced because it introduces significant risk of stuck finalizers. finalizers is a shared field, any actor with permission can reorder it. If the finalizer list is processed in order, then this can lead to a situation in which the component responsible for the first finalizer in the list is waiting for a signal (field value, external system, or other) produced by a component responsible for a finalizer later in the list, resulting in a deadlock. Without enforced ordering finalizers are free to order amongst themselves and are not vulnerable to ordering changes in the list.

+

generateName

+

String

+

GenerateName is an optional prefix, used by the server, to generate a unique name ONLY IF the Name field has not been provided. If this field is used, the name returned to the client will be different than the name passed. This value will also be combined with a unique suffix. The provided value has the same validation rules as the Name field, and may be truncated by the length of the suffix required to make the value unique on the server.

+

If this field is specified and the generated name exists, the server will NOT return a 409 - instead, it will either return 201 Created or 500 with Reason ServerTimeout indicating a unique name could not be found in the time allotted, and the client should retry (optionally after the time indicated in the Retry-After header).

+

Applied only if Name is not specified. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#idempotency

+

generation

+

Long

+

A sequence number representing a specific generation of the desired state. Populated by the system. Read-only.

+

labels

+

Map<String,String>

+

Map of string keys and values that can be used to organize and categorize (scope and select) objects. May match selectors of replication controllers and services. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/labels/

+

managedFields

+

Array of io.k8s.apimachinery.pkg.apis.meta.v1.ManagedFieldsEntry objects

+

ManagedFields maps workflow-id and version to the set of fields that are managed by that workflow. This is mostly for internal housekeeping, and users typically shouldn't need to set or understand this field. A workflow can be the user's name, a controller's name, or the name of a specific apply path like "ci-cd". The set of fields is always in the version that the workflow used when modifying the object.

+

name

+

String

+

Name must be unique within a namespace. Is required when creating resources, although some resources may allow a client to request the generation of an appropriate name automatically. Name is primarily intended for creation idempotence and configuration definition. Cannot be updated. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names

+

namespace

+

String

+

Namespace defines the space within which each name must be unique. An empty namespace is equivalent to the "default" namespace, but "default" is the canonical representation. Not all objects are required to be scoped to a namespace - the value of this field for those objects will be empty.

+

Must be a DNS_LABEL. Cannot be updated. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/namespaces/

+

ownerReferences

+

Array of io.k8s.apimachinery.pkg.apis.meta.v1.OwnerReference objects

+

List of objects depended by this object. If ALL objects in the list have been deleted, this object will be garbage collected. If this object is managed by a controller, then an entry in this list will point to this controller, with the controller field set to true. There cannot be more than one managing controller.

+

resourceVersion

+

String

+

An opaque value that represents the internal version of this object that can be used by clients to determine when objects have changed. May be used for optimistic concurrency, change detection, and the watch operation on a resource or set of resources. Clients must treat these values as opaque and passed unmodified back to the server. They may only be valid for a particular resource or set of resources.

+

Populated by the system. Read-only. Value must be treated as opaque by clients and . More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#concurrency-control-and-consistency

+

selfLink

+

String

+

SelfLink is a URL representing this object. Populated by the system. Read-only.

+

DEPRECATED Kubernetes will stop propagating this field in 1.20 release and the field is planned to be removed in 1.21 release.

+

uid

+

String

+

UID is the unique in time and space value for this object. It is typically generated by the server on successful creation of a resource and is not allowed to change on PUT operations.

+

Populated by the system. Read-only. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#uids

+
+
+ +
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Table 8 io.k8s.apimachinery.pkg.apis.meta.v1.ManagedFieldsEntry

Parameter

+

Type

+

Description

+

apiVersion

+

String

+

APIVersion defines the version of this resource that this field set applies to. The format is "group/version" just like the top-level APIVersion field. It is necessary to track the version of a field set because it cannot be automatically converted.

+

fieldsType

+

String

+

FieldsType is the discriminator for the different fields format and version. There is currently only one possible value: "FieldsV1"

+

fieldsV1

+

Object

+

FieldsV1 holds the first JSON version format as described in the "FieldsV1" type.

+

manager

+

String

+

Manager is an identifier of the workflow managing these fields.

+

operation

+

String

+

Operation is the type of operation which lead to this ManagedFieldsEntry being created. The only valid values for this field are 'Apply' and 'Update'.

+

time

+

String

+

Time is timestamp of when these fields were set. It should always be empty if Operation is 'Apply'.

+
+
+ +
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Table 9 io.k8s.apimachinery.pkg.apis.meta.v1.OwnerReference

Parameter

+

Type

+

Description

+

apiVersion

+

String

+

API version of the referent.

+

blockOwnerDeletion

+

Boolean

+

If true, AND if the owner has the "foregroundDeletion" finalizer, then the owner cannot be deleted from the key-value store until this reference is removed. Defaults to false. To set this field, a user needs "delete" permission of the owner, otherwise 422 (Unprocessable Entity) will be returned.

+

controller

+

Boolean

+

If true, this reference points to the managing controller.

+

kind

+

String

+

Kind of the referent. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds

+

name

+

String

+

Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names

+

uid

+

String

+

UID of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#uids

+
+
+

Status code: 202

+ +
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Table 10 Response body parameters

Parameter

+

Type

+

Description

+

apiVersion

+

String

+

APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#resources

+

binaryData

+

Map<String,String>

+

BinaryData contains the binary data. Each key must consist of alphanumeric characters, '-', '_' or '.'. BinaryData can contain byte sequences that are not in the UTF-8 range. The keys stored in BinaryData must not overlap with the ones in the Data field, this is enforced during validation process. Using this field will require 1.10+ apiserver and kubelet.

+

data

+

Map<String,String>

+

Data contains the configuration data. Each key must consist of alphanumeric characters, '-', '_' or '.'. Values with non-UTF-8 byte sequences must use the BinaryData field. The keys stored in Data must not overlap with the keys in the BinaryData field, this is enforced during validation process.

+

immutable

+

Boolean

+

Immutable, if set to true, ensures that data stored in the ConfigMap cannot be updated (only object metadata can be modified). If not set to true, the field can be modified at any time. Defaulted to nil.

+

kind

+

String

+

Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds

+

metadata

+

io.k8s.apimachinery.pkg.apis.meta.v1.ObjectMeta object

+

Standard object's metadata. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata

+
+
+ +
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Table 11 io.k8s.apimachinery.pkg.apis.meta.v1.ObjectMeta

Parameter

+

Type

+

Description

+

annotations

+

Map<String,String>

+

Annotations is an unstructured key value map stored with a resource that may be set by external tools to store and retrieve arbitrary metadata. They are not queryable and should be preserved when modifying objects. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/annotations/

+

clusterName

+

String

+

The name of the cluster which the object belongs to. This is used to distinguish resources with same name and namespace in different clusters. This field is not set anywhere right now and apiserver is going to ignore it if set in create or update request.

+

creationTimestamp

+

String

+

CreationTimestamp is a timestamp representing the server time when this object was created. It is not guaranteed to be set in happens-before order across separate operations. Clients may not set this value. It is represented in RFC3339 form and is in UTC.

+

Populated by the system. Read-only. Null for lists. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata

+

deletionGracePeriodSeconds

+

Long

+

Number of seconds allowed for this object to gracefully terminate before it will be removed from the system. Only set when deletionTimestamp is also set. May only be shortened. Read-only.

+

deletionTimestamp

+

String

+

DeletionTimestamp is RFC 3339 date and time at which this resource will be deleted. This field is set by the server when a graceful deletion is requested by the user, and is not directly settable by a client. The resource is expected to be deleted (no longer visible from resource lists, and not reachable by name) after the time in this field, once the finalizers list is empty. As long as the finalizers list contains items, deletion is blocked. Once the deletionTimestamp is set, this value may not be unset or be set further into the future, although it may be shortened or the resource may be deleted prior to this time. For example, a user may request that a pod is deleted in 30 seconds. The Kubelet will react by sending a graceful termination signal to the containers in the pod. After that 30 seconds, the Kubelet will send a hard termination signal (SIGKILL) to the container and after cleanup, remove the pod from the API. In the presence of network partitions, this object may still exist after this timestamp, until an administrator or automated process can determine the resource is fully terminated. If not set, graceful deletion of the object has not been requested.

+

Populated by the system when a graceful deletion is requested. Read-only. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata

+

enable

+

Boolean

+

Enable identifies whether the resource is available.

+

finalizers

+

Array of strings

+

Must be empty before the object is deleted from the registry.

+

Each entry is an identifier for the responsible component that will remove the entry from the list. If the deletionTimestamp of the object is non-nil, entries in this list can only be removed. Finalizers may be processed and removed in any order. Order is NOT enforced because it introduces significant risk of stuck finalizers. finalizers is a shared field, any actor with permission can reorder it. If the finalizer list is processed in order, then this can lead to a situation in which the component responsible for the first finalizer in the list is waiting for a signal (field value, external system, or other) produced by a component responsible for a finalizer later in the list, resulting in a deadlock. Without enforced ordering finalizers are free to order amongst themselves and are not vulnerable to ordering changes in the list.

+

generateName

+

String

+

GenerateName is an optional prefix, used by the server, to generate a unique name ONLY IF the Name field has not been provided. If this field is used, the name returned to the client will be different than the name passed. This value will also be combined with a unique suffix. The provided value has the same validation rules as the Name field, and may be truncated by the length of the suffix required to make the value unique on the server.

+

If this field is specified and the generated name exists, the server will NOT return a 409 - instead, it will either return 201 Created or 500 with Reason ServerTimeout indicating a unique name could not be found in the time allotted, and the client should retry (optionally after the time indicated in the Retry-After header).

+

Applied only if Name is not specified. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#idempotency

+

generation

+

Long

+

A sequence number representing a specific generation of the desired state. Populated by the system. Read-only.

+

labels

+

Map<String,String>

+

Map of string keys and values that can be used to organize and categorize (scope and select) objects. May match selectors of replication controllers and services. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/labels/

+

managedFields

+

Array of io.k8s.apimachinery.pkg.apis.meta.v1.ManagedFieldsEntry objects

+

ManagedFields maps workflow-id and version to the set of fields that are managed by that workflow. This is mostly for internal housekeeping, and users typically shouldn't need to set or understand this field. A workflow can be the user's name, a controller's name, or the name of a specific apply path like "ci-cd". The set of fields is always in the version that the workflow used when modifying the object.

+

name

+

String

+

Name must be unique within a namespace. Is required when creating resources, although some resources may allow a client to request the generation of an appropriate name automatically. Name is primarily intended for creation idempotence and configuration definition. Cannot be updated. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names

+

namespace

+

String

+

Namespace defines the space within which each name must be unique. An empty namespace is equivalent to the "default" namespace, but "default" is the canonical representation. Not all objects are required to be scoped to a namespace - the value of this field for those objects will be empty.

+

Must be a DNS_LABEL. Cannot be updated. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/namespaces/

+

ownerReferences

+

Array of io.k8s.apimachinery.pkg.apis.meta.v1.OwnerReference objects

+

List of objects depended by this object. If ALL objects in the list have been deleted, this object will be garbage collected. If this object is managed by a controller, then an entry in this list will point to this controller, with the controller field set to true. There cannot be more than one managing controller.

+

resourceVersion

+

String

+

An opaque value that represents the internal version of this object that can be used by clients to determine when objects have changed. May be used for optimistic concurrency, change detection, and the watch operation on a resource or set of resources. Clients must treat these values as opaque and passed unmodified back to the server. They may only be valid for a particular resource or set of resources.

+

Populated by the system. Read-only. Value must be treated as opaque by clients and . More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#concurrency-control-and-consistency

+

selfLink

+

String

+

SelfLink is a URL representing this object. Populated by the system. Read-only.

+

DEPRECATED Kubernetes will stop propagating this field in 1.20 release and the field is planned to be removed in 1.21 release.

+

uid

+

String

+

UID is the unique in time and space value for this object. It is typically generated by the server on successful creation of a resource and is not allowed to change on PUT operations.

+

Populated by the system. Read-only. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#uids

+
+
+ +
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Table 12 io.k8s.apimachinery.pkg.apis.meta.v1.ManagedFieldsEntry

Parameter

+

Type

+

Description

+

apiVersion

+

String

+

APIVersion defines the version of this resource that this field set applies to. The format is "group/version" just like the top-level APIVersion field. It is necessary to track the version of a field set because it cannot be automatically converted.

+

fieldsType

+

String

+

FieldsType is the discriminator for the different fields format and version. There is currently only one possible value: "FieldsV1"

+

fieldsV1

+

Object

+

FieldsV1 holds the first JSON version format as described in the "FieldsV1" type.

+

manager

+

String

+

Manager is an identifier of the workflow managing these fields.

+

operation

+

String

+

Operation is the type of operation which lead to this ManagedFieldsEntry being created. The only valid values for this field are 'Apply' and 'Update'.

+

time

+

String

+

Time is timestamp of when these fields were set. It should always be empty if Operation is 'Apply'.

+
+
+ +
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Table 13 io.k8s.apimachinery.pkg.apis.meta.v1.OwnerReference

Parameter

+

Type

+

Description

+

apiVersion

+

String

+

API version of the referent.

+

blockOwnerDeletion

+

Boolean

+

If true, AND if the owner has the "foregroundDeletion" finalizer, then the owner cannot be deleted from the key-value store until this reference is removed. Defaults to false. To set this field, a user needs "delete" permission of the owner, otherwise 422 (Unprocessable Entity) will be returned.

+

controller

+

Boolean

+

If true, this reference points to the managing controller.

+

kind

+

String

+

Kind of the referent. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds

+

name

+

String

+

Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names

+

uid

+

String

+

UID of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#uids

+
+
+
+

Example Requests

None

+
+

Example Responses

Status code: 200

+

OK

+
{
+  "apiVersion" : "cci/v2",
+  "data" : {
+    "key1" : "value1",
+    "key2" : "value2",
+    "key3" : "value2"
+  },
+  "kind" : "ConfigMap",
+  "metadata" : {
+    "annotations" : {
+      "tenant.cci.io/tenant-id" : "08a2*************************c03"
+    },
+    "creationTimestamp" : "2024-10-09T12:05:03Z",
+    "labels" : {
+      "sys_enterprise_project_id" : "0",
+      "tenant.cci.io/tenant-id" : "08a2*************************c03",
+      "tenant.kubernetes.io/domain-id" : "08a*************************ee60",
+      "tenant.kubernetes.io/project-id" : "08a2*************************c03",
+      "usage" : "just-for-test"
+    },
+    "name" : "test-cm",
+    "namespace" : "wbtest4",
+    "resourceVersion" : "391025175",
+    "uid" : "7c6f7981-78bb-42ff-b659-b8b4cbcbab5e"
+  }
+}
+
+

Status Codes

+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +

Status Code

+

Description

+

200

+

OK

+

202

+

Accepted

+

400

+

BadRequest

+

401

+

Unauthorized

+

403

+

Forbidden

+

404

+

NotFound

+

405

+

MethodNotAllowed

+

406

+

NotAcceptable

+

409

+

Conflict

+

415

+

UnsupportedMediaType

+

422

+

Invalid

+

429

+

TooManyRequests

+

500

+

InternalError

+

503

+

ServiceUnavailable

+

504

+

ServerTimeout

+
+
+
+
+
+
+
Parent topic: Proprietary APIs
+
+
+ diff --git a/docs/cci/api-ref/deleteCciV2NamespacedPod.html b/docs/cci/api-ref/deleteCciV2NamespacedPod.html new file mode 100644 index 00000000..f4de7e50 --- /dev/null +++ b/docs/cci/api-ref/deleteCciV2NamespacedPod.html @@ -0,0 +1,7357 @@ + + +

Deleting a Pod

+

Function

Delete a Pod.

+
+

Calling Method

For details, see Calling APIs.

+
+

URI

DELETE /apis/cci/v2/namespaces/{namespace}/pods/{name}

+ +
+ + + + + + + + + + + + + + + + +
Table 1 Path Parameters

Parameter

+

Mandatory

+

Type

+

Description

+

name

+

Yes

+

String

+

Name of the Pod.

+

namespace

+

Yes

+

String

+

Object name and auth scope, such as for teams and projects.

+
+
+ +
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Table 2 Query Parameters

Parameter

+

Mandatory

+

Type

+

Description

+

dryRun

+

No

+

String

+

When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed

+

gracePeriodSeconds

+

No

+

Integer

+

The duration in seconds before the object should be deleted.

+

Value must be non-negative integer. The value zero indicates delete immediately.

+

If this value is nil, the default grace period for the specified type will

+

be used. Defaults to a per object value if not specified. zero means delete

+

immediately.

+

orphanDependents

+

No

+

Boolean

+

Deprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the "orphan" finalizer will be added to/removed from the object's finalizers list. Either this field or PropagationPolicy may be set, but not both.

+

propagationPolicy

+

No

+

String

+

Whether and how garbage collection will be performed. Either this field or OrphanDependents may be set, but not both. The default policy is decided by the existing finalizer set in the metadata.finalizers and the resource-specific default policy. Acceptable values are: 'Orphan' - orphan the dependents; 'Background' - allow the garbage collector to delete the dependents in the background; 'Foreground' - a cascading policy that deletes all dependents in the foreground.

+

pretty

+

No

+

String

+

If 'true', then the output is pretty printed.

+
+
+
+

Request Parameters

+
+ + + + + + + + + + + + + + + + +
Table 3 Request header parameters

Parameter

+

Mandatory

+

Type

+

Description

+

X-Auth-Token

+

Yes

+

String

+

User token.

+

It can be obtained through the IAM API used to obtain a user token. The value of X-Subject-Token in the response header is the user token.

+

Content-Type

+

Yes

+

String

+

The type of the message body, with a default value of "application/JSON".

+
+
+ +
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Table 4 Request body parameters

Parameter

+

Mandatory

+

Type

+

Description

+

apiVersion

+

No

+

String

+

APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#resources

+

dryRun

+

No

+

Array of strings

+

When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed

+

gracePeriodSeconds

+

No

+

Long

+

The duration in seconds before the object should be deleted.

+

Value must be non-negative integer. The value zero indicates delete immediately.

+

If this value is nil, the default grace period for the specified type will

+

be used. Defaults to a per object value if not specified. zero means delete

+

immediately.

+

kind

+

No

+

String

+

Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds

+

orphanDependents

+

No

+

Boolean

+

Deprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the "orphan" finalizer will be added to/removed from the object's finalizers list. Either this field or PropagationPolicy may be set, but not both.

+

preconditions

+

No

+

io.k8s.apimachinery.pkg.apis.meta.v1.Preconditions object

+

Must be fulfilled before a deletion is carried out. If not possible,

+

a 409 Conflict status will be returned.

+

propagationPolicy

+

No

+

String

+

Whether and how garbage collection will be performed. Either this field or OrphanDependents may be set, but not both. The default policy is decided by the existing finalizer set in the metadata.finalizers and the resource-specific default policy. Acceptable values are: 'Orphan' - orphan the dependents; 'Background' - allow the garbage collector to delete the dependents in the background; 'Foreground' - a cascading policy that deletes all dependents in the foreground.

+
+
+ +
+ + + + + + + + + + + + + + + + +
Table 5 io.k8s.apimachinery.pkg.apis.meta.v1.Preconditions

Parameter

+

Mandatory

+

Type

+

Description

+

resourceVersion

+

No

+

String

+

Specifies the target ResourceVersion

+

uid

+

No

+

String

+

Specifies the target UID.

+
+
+
+

Response Parameters

Status code: 200

+ +
+ + + + + + + + + + + + + + + + + + + + + + + + + +
Table 6 Response body parameters

Parameter

+

Type

+

Description

+

apiVersion

+

String

+

APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#resources

+

kind

+

String

+

Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds

+

metadata

+

io.k8s.apimachinery.pkg.apis.meta.v1.ObjectMeta object

+

Standard object's metadata. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata

+

spec

+

io.cci.otc.api.pkg.apis.versioned.cci.v2.PodSpec object

+

Specification of the desired behavior of the pod. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#spec-and-status

+

status

+

io.cci.otc.api.pkg.apis.versioned.cci.v2.PodStatus object

+

Most recently observed status of the pod. This data may not be up to date. Populated by the system. Read-only. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#spec-and-status

+
+
+ +
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Table 7 io.cci.otc.api.pkg.apis.versioned.cci.v2.PodSpec

Parameter

+

Type

+

Description

+

activeDeadlineSeconds

+

Long

+

Optional duration in seconds the pod may be active on the node

+

relative to StartTime before the system will actively try to mark it failed

+

and kill associated containers. Value must be a positive integer.

+

affinity

+

io.cci.otc.api.pkg.apis.versioned.cci.v2.Affinity object

+

If specified, the pod's scheduling constraints

+

containers

+

Array of io.cci.otc.api.pkg.apis.versioned.cci.v2.Container objects

+

List of containers belonging to the pod. Containers cannot currently

+

be added or removed. There must be at least one container in a Pod. Cannot

+

be updated.

+

dnsConfig

+

io.cci.otc.api.pkg.apis.versioned.cci.v2.PodDNSConfig object

+

Specifies the DNS parameters of a pod. Parameters specified here

+

will be merged to the generated DNS configuration based on DNSPolicy.

+

dnsPolicy

+

String

+

Set DNS policy for the pod. Defaults to "ClusterFirst". Valid values are 'ClusterFirstWithHostNet', 'ClusterFirst', 'Default' or 'None'. DNS parameters given in DNSConfig will be merged with the policy selected with DNSPolicy. To have DNS options set along with hostNetwork, you have to specify DNS policy explicitly to 'ClusterFirstWithHostNet'.

+

Possible enum values:

+
  • "ClusterFirst" indicates that the pod should use cluster DNS first unless hostNetwork is true, if it is available, then fall back on the default (as determined by kubelet) DNS settings.
  • "ClusterFirstWithHostNet" indicates that the pod should use cluster DNS first, if it is available, then fall back on the default (as determined by kubelet) DNS settings.
  • "Default" indicates that the pod should use the default (as determined by kubelet) DNS settings.
  • "None" indicates that the pod should use empty DNS settings. DNS parameters such as nameservers and search paths should be defined via DNSConfig.
+

ephemeralContainers

+

Array of io.cci.otc.api.pkg.apis.versioned.cci.v2.EphemeralContainer objects

+

List of ephemeral containers run in this pod. Ephemeral containers

+

may be run in an existing pod to perform user-initiated actions such as

+

debugging. This list cannot be specified when creating a pod, and it cannot

+

be modified by updating the pod spec. In order to add an ephemeral container

+

to an existing pod, use the pod's ephemeralcontainers subresource.

+

hostAliases

+

Array of io.cci.otc.api.pkg.apis.versioned.cci.v2.HostAlias objects

+

HostAliases is an optional list of hosts and IPs that will be

+

injected into the pod's hosts file if specified. This is only valid for

+

non-hostNetwork pods.

+

hostname

+

String

+

Specifies the hostName of the Pod. If not specified, the pod's

+

hostname will be set to a system-defined value.

+

imagePullSecrets

+

Array of io.cci.otc.api.pkg.apis.versioned.cci.v2.LocalObjectReference objects

+

ImagePullSecrets is an optional list of references to secrets in the same namespace to use for pulling any of the images used by this PodSpec. If specified, these secrets will be passed to individual puller implementations for them to use. More info: https://kubernetes.io/docs/concepts/containers/images#specifying-imagepullsecrets-on-a-pod

+

initContainers

+

Array of io.cci.otc.api.pkg.apis.versioned.cci.v2.Container objects

+

List of initialization containers belonging to the pod. Init containers are executed in order prior to containers being started. If any init container fails, the pod is considered to have failed and is handled according to its restartPolicy. The name for an init container or normal container must be unique among all containers. Init containers may not have Lifecycle actions, Readiness probes, Liveness probes, or Startup probes. The resourceRequirements of an init container are taken into account during scheduling by finding the highest request/limit for each resource type, and then using the max of of that value or the sum of the normal containers. Limits are applied to init containers in a similar fashion. Init containers cannot currently be added or removed. Cannot be updated. More info: https://kubernetes.io/docs/concepts/workloads/pods/init-containers/

+

nodeName

+

String

+

NodeName is a request to schedule this pod onto a specific node.

+

If it is non-empty, the scheduler simply schedules this pod onto that node,

+

assuming that it fits resource requirements.

+

overhead

+

Map<String,String>

+

Overhead represents the resource overhead associated with running a pod for a given RuntimeClass. This field will be autopopulated at admission time by the RuntimeClass admission controller. If the RuntimeClass admission controller is enabled, overhead must not be set in Pod create requests. The RuntimeClass admission controller will reject Pod create requests which have the overhead already set. If RuntimeClass is configured and selected in the PodSpec, Overhead will be set to the value defined in the corresponding RuntimeClass, otherwise it will remain unset and treated as zero. More info: https://git.k8s.io/enhancements/keps/sig-node/688-pod-overhead/README.md

+

readinessGates

+

Array of io.cci.otc.api.pkg.apis.versioned.cci.v2.PodReadinessGate objects

+

If specified, all readiness gates will be evaluated for pod readiness. A pod is ready when all its containers are ready AND all conditions specified in the readiness gates have status equal to "True" More info: https://git.k8s.io/enhancements/keps/sig-network/580-pod-readiness-gates

+

restartPolicy

+

String

+

Restart policy for all containers within the pod. One of Always, OnFailure, Never. Default to Always. More info: https://kubernetes.io/docs/concepts/workloads/pods/pod-lifecycle/#restart-policy

+

Possible enum values:

+
  • "Always"
  • "Never"
  • "OnFailure"
+

schedulerName

+

String

+

If specified, the pod will be dispatched by specified scheduler.

+

If not specified, the pod will be dispatched by default scheduler.

+

securityContext

+

io.cci.otc.api.pkg.apis.versioned.cci.v2.PodSecurityContext object

+

SecurityContext holds pod-level security attributes and common container settings. Optional: Defaults to empty. See type description for default values of each field.

+

setHostnameAsFQDN

+

Boolean

+

If true the pod's hostname will be configured as the pod's FQDN,

+

rather than the leaf name (the default). In Linux containers, this means

+

setting the FQDN in the hostname field of the kernel (the nodename field

+

of struct utsname). In Windows containers, this means setting the registry

+

value of hostname for the registry key HKEY_LOCAL_MACHINE\SYSTEM\CurrentControlSet\Services\Tcpip\Parameters

+

to FQDN. If a pod does not have FQDN, this has no effect. Default to false.

+

shareProcessNamespace

+

Boolean

+

Share a single process namespace between all of the containers in a pod. When this is set containers will be able to view and signal processes from other containers in the same pod, and the first process in each container will not be assigned PID 1. HostPID and ShareProcessNamespace cannot both be set. Optional: Default to false.

+

terminationGracePeriodSeconds

+

Long

+

Optional duration in seconds the pod needs to terminate gracefully.

+

May be decreased in delete request. Value must be non-negative integer.

+

The value zero indicates stop immediately via the kill signal (no opportunity

+

to shut down). If this value is nil, the default grace period will be used

+

instead. The grace period is the duration in seconds after the processes

+

running in the pod are sent a termination signal and the time when the processes

+

are forcibly halted with a kill signal. Set this value longer than the expected

+

cleanup time for your process. Defaults to 30 seconds.

+

topologySpreadConstraints

+

Array of io.cci.otc.api.pkg.apis.versioned.cci.v2.TopologySpreadConstraint objects

+

TopologySpreadConstraints describes how a group of pods ought

+

to spread across topology domains. Scheduler will schedule pods in a way

+

which abides by the constraints. All topologySpreadConstraints are ANDed.

+

volumes

+

Array of io.cci.otc.api.pkg.apis.versioned.cci.v2.Volume objects

+

List of volumes that can be mounted by containers belonging to the pod. More info: https://kubernetes.io/docs/concepts/storage/volumes

+
+
+ +
+ + + + + + + + + + + + + +
Table 8 io.cci.otc.api.pkg.apis.versioned.cci.v2.Affinity

Parameter

+

Type

+

Description

+

nodeAffinity

+

io.cci.otc.api.pkg.apis.versioned.cci.v2.NodeAffinity object

+

Describes node affinity scheduling rules for the pod.

+

podAntiAffinity

+

io.cci.otc.api.pkg.apis.versioned.cci.v2.PodAntiAffinity object

+

Describes pod anti-affinity scheduling rules (e.g. avoid putting

+

this pod in the same zone, etc. as some other pod(s)).

+
+
+ +
+ + + + + + + + + +
Table 9 io.cci.otc.api.pkg.apis.versioned.cci.v2.NodeAffinity

Parameter

+

Type

+

Description

+

requiredDuringSchedulingIgnoredDuringExecution

+

io.cci.otc.api.pkg.apis.versioned.cci.v2.NodeSelector object

+

If the affinity requirements specified by this field are not

+

met at scheduling time, the pod will not be scheduled onto the node. If

+

the affinity requirements specified by this field cease to be met at some

+

point during pod execution (e.g. due to an update), the system may or may

+

not try to eventually evict the pod from its node.

+
+
+ +
+ + + + + + + + + +
Table 10 io.cci.otc.api.pkg.apis.versioned.cci.v2.NodeSelector

Parameter

+

Type

+

Description

+

nodeSelectorTerms

+

Array of io.cci.otc.api.pkg.apis.versioned.cci.v2.NodeSelectorTerm objects

+

Required. A list of node selector terms. The terms are ORed.

+
+
+ +
+ + + + + + + + + +
Table 11 io.cci.otc.api.pkg.apis.versioned.cci.v2.NodeSelectorTerm

Parameter

+

Type

+

Description

+

matchExpressions

+

Array of io.cci.otc.api.pkg.apis.versioned.cci.v2.NodeSelectorRequirement objects

+

A list of node selector requirements by node's labels.

+
+
+ +
+ + + + + + + + + + + + + + + + + +
Table 12 io.cci.otc.api.pkg.apis.versioned.cci.v2.NodeSelectorRequirement

Parameter

+

Type

+

Description

+

key

+

String

+

The label key that the selector applies to.

+

operator

+

String

+

Represents a key's relationship to a set of values. Valid operators are In, NotIn, Exists, DoesNotExist. Gt, and Lt.

+

Possible enum values:

+
  • "DoesNotExist"
  • "Exists"
  • "Gt"
  • "In"
  • "Lt"
  • "NotIn"
+

values

+

Array of strings

+

An array of string values. If the operator is In or NotIn, the

+

values array must be non-empty. If the operator is Exists or DoesNotExist,

+

the values array must be empty. If the operator is Gt or Lt, the values

+

array must have a single element, which will be interpreted as an integer.

+

This array is replaced during a strategic merge patch.

+
+
+ +
+ + + + + + + + + + + + + +
Table 13 io.cci.otc.api.pkg.apis.versioned.cci.v2.PodAntiAffinity

Parameter

+

Type

+

Description

+

preferredDuringSchedulingIgnoredDuringExecution

+

Array of io.cci.otc.api.pkg.apis.versioned.cci.v2.WeightedPodAffinityTerm objects

+

The scheduler will prefer to schedule pods to nodes that satisfy

+

the anti-affinity expressions specified by this field, but it may choose

+

a node that violates one or more of the expressions. The node that is most

+

preferred is the one with the greatest sum of weights, i.e. for each node

+

that meets all of the scheduling requirements (resource request, requiredDuringScheduling

+

anti-affinity expressions, etc.), compute a sum by iterating through the

+

elements of this field and adding "weight" to the sum if the node has pods

+

which matches the corresponding podAffinityTerm; the node(s) with the highest

+

sum are the most preferred.

+

requiredDuringSchedulingIgnoredDuringExecution

+

Array of io.cci.otc.api.pkg.apis.versioned.cci.v2.PodAffinityTerm objects

+

If the anti-affinity requirements specified by this field are

+

not met at scheduling time, the pod will not be scheduled onto the node.

+

If the anti-affinity requirements specified by this field cease to be met

+

at some point during pod execution (e.g. due to a pod label update), the

+

system may or may not try to eventually evict the pod from its node. When

+

there are multiple elements, the lists of nodes corresponding to each podAffinityTerm

+

are intersected, i.e. all terms must be satisfied.

+
+
+ +
+ + + + + + + + + + + + + +
Table 14 io.cci.otc.api.pkg.apis.versioned.cci.v2.WeightedPodAffinityTerm

Parameter

+

Type

+

Description

+

podAffinityTerm

+

io.cci.otc.api.pkg.apis.versioned.cci.v2.PodAffinityTerm object

+

Required. A pod affinity term, associated with the corresponding

+

weight.

+

weight

+

Integer

+

weight associated with matching the corresponding podAffinityTerm,

+

in the range 1-100.

+
+
+ +
+ + + + + + + + + + + + + + + + + +
Table 15 io.cci.otc.api.pkg.apis.versioned.cci.v2.PodAffinityTerm

Parameter

+

Type

+

Description

+

labelSelector

+

io.k8s.apimachinery.pkg.apis.meta.v1.LabelSelector object

+

A label query over a set of resources, in this case pods.

+

namespaces

+

Array of strings

+

namespaces specifies a static list of namespace names that the

+

term applies to. The term is applied to the union of the namespaces listed

+

in this field and the ones selected by namespaceSelector. null or empty

+

namespaces list and null namespaceSelector means "this pod's namespace".

+

topologyKey

+

String

+

This pod should be co-located (affinity) or not co-located (anti-affinity)

+

with the pods matching the labelSelector in the specified namespaces, where

+

co-located is defined as running on a node whose value of the label with

+

key topologyKey matches that of any node on which any of the selected pods

+

is running. Empty topologyKey is not allowed.

+
+
+ +
+ + + + + + + + + + + + + + + + + +
Table 16 io.cci.otc.api.pkg.apis.versioned.cci.v2.PodDNSConfig

Parameter

+

Type

+

Description

+

nameservers

+

Array of strings

+

A list of DNS name server IP addresses. This will be appended

+

to the base nameservers generated from DNSPolicy. Duplicated nameservers

+

will be removed.

+

options

+

Array of io.cci.otc.api.pkg.apis.versioned.cci.v2.PodDNSConfigOption objects

+

A list of DNS resolver options. This will be merged with the

+

base options generated from DNSPolicy. Duplicated entries will be removed.

+

Resolution options given in Options will override those that appear in the

+

base DNSPolicy.

+

searches

+

Array of strings

+

A list of DNS search domains for host-name lookup. This will

+

be appended to the base search paths generated from DNSPolicy. Duplicated

+

search paths will be removed.

+
+
+ +
+ + + + + + + + + + + + + +
Table 17 io.cci.otc.api.pkg.apis.versioned.cci.v2.PodDNSConfigOption

Parameter

+

Type

+

Description

+

name

+

String

+

Required.

+

value

+

String

+		  
+
+ +
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Table 18 io.cci.otc.api.pkg.apis.versioned.cci.v2.EphemeralContainer

Parameter

+

Type

+

Description

+

args

+

Array of strings

+

Arguments to the entrypoint. The image's CMD is used if this is not provided. Variable references $(VAR_NAME) are expanded using the container's environment. If a variable cannot be resolved, the reference in the input string will be unchanged. Double $$ are reduced to a single $, which allows for escaping the $(VAR_NAME) syntax: i.e. "$$(VAR_NAME)" will produce the string literal "$(VAR_NAME)". Escaped references will never be expanded, regardless of whether the variable exists or not. Cannot be updated. More info: https://kubernetes.io/docs/tasks/inject-data-application/define-command-argument-container/#running-a-command-in-a-shell

+

command

+

Array of strings

+

Entrypoint array. Not executed within a shell. The image's ENTRYPOINT is used if this is not provided. Variable references $(VAR_NAME) are expanded using the container's environment. If a variable cannot be resolved, the reference in the input string will be unchanged. Double $$ are reduced to a single $, which allows for escaping the $(VAR_NAME) syntax: i.e. "$$(VAR_NAME)" will produce the string literal "$(VAR_NAME)". Escaped references will never be expanded, regardless of whether the variable exists or not. Cannot be updated. More info: https://kubernetes.io/docs/tasks/inject-data-application/define-command-argument-container/#running-a-command-in-a-shell

+

env

+

Array of io.cci.otc.api.pkg.apis.versioned.cci.v2.EnvVar objects

+

List of environment variables to set in the container. Cannot

+

be updated.

+

envFrom

+

Array of io.cci.otc.api.pkg.apis.versioned.cci.v2.EnvFromSource objects

+

List of sources to populate environment variables in the container.

+

The keys defined within a source must be a C_IDENTIFIER. All invalid keys

+

will be reported as an event when the container is starting. When a key

+

exists in multiple sources, the value associated with the last source will

+

take precedence. Values defined by an Env with a duplicate key will take

+

precedence. Cannot be updated.

+

image

+

String

+

Container image name. More info: https://kubernetes.io/docs/concepts/containers/images

+

lifecycle

+

io.cci.otc.api.pkg.apis.versioned.cci.v2.Lifecycle object

+

Lifecycle is not allowed for ephemeral containers.

+

livenessProbe

+

io.cci.otc.api.pkg.apis.versioned.cci.v2.Probe object

+

Probes are not allowed for ephemeral containers.

+

name

+

String

+

Name of the ephemeral container specified as a DNS_LABEL. This

+

name must be unique among all containers, init containers and ephemeral

+

containers.

+

ports

+

Array of io.cci.otc.api.pkg.apis.versioned.cci.v2.ContainerPort objects

+

Ports are not allowed for ephemeral containers.

+

readinessProbe

+

io.cci.otc.api.pkg.apis.versioned.cci.v2.Probe object

+

Probes are not allowed for ephemeral containers.

+

resources

+

io.cci.otc.api.pkg.apis.versioned.cci.v2.ResourceRequirements object

+

Resources are not allowed for ephemeral containers. Ephemeral

+

containers use spare resources already allocated to the pod.

+

securityContext

+

io.cci.otc.api.pkg.apis.versioned.cci.v2.SecurityContext object

+

Optional: SecurityContext defines the security options the ephemeral container should be run with. If set, the fields of SecurityContext override the equivalent fields of PodSecurityContext.

+

startupProbe

+

io.cci.otc.api.pkg.apis.versioned.cci.v2.Probe object

+

Probes are not allowed for ephemeral containers.

+

stdin

+

Boolean

+

Whether this container should allocate a buffer for stdin in

+

the container runtime. If this is not set, reads from stdin in the container

+

will always result in EOF. Default is false.

+

stdinOnce

+

Boolean

+

Whether the container runtime should close the stdin channel

+

after it has been opened by a single attach. When stdin is true the stdin

+

stream will remain open across multiple attach sessions. If stdinOnce is

+

set to true, stdin is opened on container start, is empty until the first

+

client attaches to stdin, and then remains open and accepts data until the

+

client disconnects, at which time stdin is closed and remains closed until

+

the container is restarted. If this flag is false, a container processes

+

that reads from stdin will never receive an EOF. Default is false

+

targetContainerName

+

String

+

If set, the name of the container from PodSpec that this ephemeral container targets. The ephemeral container will be run in the namespaces (IPC, PID, etc) of this container. If not set then the ephemeral container uses the namespaces configured in the Pod spec.

+

The container runtime must implement support for this feature. If the runtime does not support namespace targeting then the result of setting this field is undefined.

+

terminationMessagePath

+

String

+

Optional: Path at which the file to which the container's termination message will be written is mounted into the container's filesystem. Message written is intended to be brief final status, such as an assertion failure message. Will be truncated by the node if greater than 4096 bytes. The total message length across all containers will be limited to 12kb. Defaults to /dev/termination-log. Cannot be updated.

+

terminationMessagePolicy

+

String

+

Indicate how the termination message should be populated. File will use the contents of terminationMessagePath to populate the container status message on both success and failure. FallbackToLogsOnError will use the last chunk of container log output if the termination message file is empty and the container exited with an error. The log output is limited to 2048 bytes or 80 lines, whichever is smaller. Defaults to File. Cannot be updated.

+

Possible enum values:

+
  • "FallbackToLogsOnError" will read the most recent contents of the container logs for the container status message when the container exits with an error and the terminationMessagePath has no contents.
  • "File" is the default behavior and will set the container status message to the contents of the container's terminationMessagePath when the container exits.
+

tty

+

Boolean

+

Whether this container should allocate a TTY for itself, also

+

requires 'stdin' to be true. Default is false.

+

volumeMounts

+

Array of io.cci.otc.api.pkg.apis.versioned.cci.v2.VolumeMount objects

+

Pod volumes to mount into the container's filesystem. Subpath

+

mounts are not allowed for ephemeral containers. Cannot be updated.

+

workingDir

+

String

+

Container's working directory. If not specified, the container

+

runtime's default will be used, which might be configured in the container

+

image. Cannot be updated.

+
+
+ +
+ + + + + + + + + + + + + +
Table 19 io.cci.otc.api.pkg.apis.versioned.cci.v2.HostAlias

Parameter

+

Type

+

Description

+

hostnames

+

Array of strings

+

Hostnames for the above IP address.

+

ip

+

String

+

IP address of the host file entry.

+
+
+ +
+ + + + + + + + + +
Table 20 io.cci.otc.api.pkg.apis.versioned.cci.v2.LocalObjectReference

Parameter

+

Type

+

Description

+

name

+

String

+

Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names

+
+
+ +
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Table 21 io.cci.otc.api.pkg.apis.versioned.cci.v2.Container

Parameter

+

Type

+

Description

+

args

+

Array of strings

+

Arguments to the entrypoint. The container image's CMD is used if this is not provided. Variable references $(VAR_NAME) are expanded using the container's environment. If a variable cannot be resolved, the reference in the input string will be unchanged. Double $$ are reduced to a single $, which allows for escaping the $(VAR_NAME) syntax: i.e. "$$(VAR_NAME)" will produce the string literal "$(VAR_NAME)". Escaped references will never be expanded, regardless of whether the variable exists or not. Cannot be updated. More info: https://kubernetes.io/docs/tasks/inject-data-application/define-command-argument-container/#running-a-command-in-a-shell

+

command

+

Array of strings

+

Entrypoint array. Not executed within a shell. The container image's ENTRYPOINT is used if this is not provided. Variable references $(VAR_NAME) are expanded using the container's environment. If a variable cannot be resolved, the reference in the input string will be unchanged. Double $$ are reduced to a single $, which allows for escaping the $(VAR_NAME) syntax: i.e. "$$(VAR_NAME)" will produce the string literal "$(VAR_NAME)". Escaped references will never be expanded, regardless of whether the variable exists or not. Cannot be updated. More info: https://kubernetes.io/docs/tasks/inject-data-application/define-command-argument-container/#running-a-command-in-a-shell

+

env

+

Array of io.cci.otc.api.pkg.apis.versioned.cci.v2.EnvVar objects

+

List of environment variables to set in the container. Cannot

+

be updated.

+

envFrom

+

Array of io.cci.otc.api.pkg.apis.versioned.cci.v2.EnvFromSource objects

+

List of sources to populate environment variables in the container.

+

The keys defined within a source must be a C_IDENTIFIER. All invalid keys

+

will be reported as an event when the container is starting. When a key

+

exists in multiple sources, the value associated with the last source will

+

take precedence. Values defined by an Env with a duplicate key will take

+

precedence. Cannot be updated.

+

image

+

String

+

Container image name. More info: https://kubernetes.io/docs/concepts/containers/images This field is optional to allow higher level config management to default or override container images in workload controllers like Deployments and StatefulSets.

+

lifecycle

+

io.cci.otc.api.pkg.apis.versioned.cci.v2.Lifecycle object

+

Actions that the management system should take in response to

+

container lifecycle events. Cannot be updated.

+

livenessProbe

+

io.cci.otc.api.pkg.apis.versioned.cci.v2.Probe object

+

Periodic probe of container liveness. Container will be restarted if the probe fails. Cannot be updated. More info: https://kubernetes.io/docs/concepts/workloads/pods/pod-lifecycle#container-probes

+

name

+

String

+

Name of the container specified as a DNS_LABEL. Each container

+

in a pod must have a unique name (DNS_LABEL). Cannot be updated.

+

ports

+

Array of io.cci.otc.api.pkg.apis.versioned.cci.v2.ContainerPort objects

+

List of ports to expose from the container. Not specifying a

+

port here DOES NOT prevent that port from being exposed. Any port which

+

is listening on the default "0.0.0.0" address inside a container will be

+

accessible from the network. Modifying this array with strategic merge patch

+

may corrupt the data. For more information See https://github.com/kubernetes/kubernetes/issues/108255.

+

Cannot be updated.

+

readinessProbe

+

io.cci.otc.api.pkg.apis.versioned.cci.v2.Probe object

+

Periodic probe of container service readiness. Container will be removed from service endpoints if the probe fails. Cannot be updated. More info: https://kubernetes.io/docs/concepts/workloads/pods/pod-lifecycle#container-probes

+

resources

+

io.cci.otc.api.pkg.apis.versioned.cci.v2.ResourceRequirements object

+

Compute Resources required by this container. Cannot be updated. More info: https://kubernetes.io/docs/concepts/configuration/manage-resources-containers/

+

securityContext

+

io.cci.otc.api.pkg.apis.versioned.cci.v2.SecurityContext object

+

SecurityContext defines the security options the container should be run with. If set, the fields of SecurityContext override the equivalent fields of PodSecurityContext. More info: https://kubernetes.io/docs/tasks/configure-pod-container/security-context/

+

startupProbe

+

io.cci.otc.api.pkg.apis.versioned.cci.v2.Probe object

+

StartupProbe indicates that the Pod has successfully initialized. If specified, no other probes are executed until this completes successfully. If this probe fails, the Pod will be restarted, just as if the livenessProbe failed. This can be used to provide different probe parameters at the beginning of a Pod's lifecycle, when it might take a long time to load data or warm a cache, than during steady-state operation. This cannot be updated. More info: https://kubernetes.io/docs/concepts/workloads/pods/pod-lifecycle#container-probes

+

stdin

+

Boolean

+

Whether this container should allocate a buffer for stdin in

+

the container runtime. If this is not set, reads from stdin in the container

+

will always result in EOF. Default is false.

+

stdinOnce

+

Boolean

+

Whether the container runtime should close the stdin channel

+

after it has been opened by a single attach. When stdin is true the stdin

+

stream will remain open across multiple attach sessions. If stdinOnce is

+

set to true, stdin is opened on container start, is empty until the first

+

client attaches to stdin, and then remains open and accepts data until the

+

client disconnects, at which time stdin is closed and remains closed until

+

the container is restarted. If this flag is false, a container processes

+

that reads from stdin will never receive an EOF. Default is false

+

terminationMessagePath

+

String

+

Optional: Path at which the file to which the container's termination message will be written is mounted into the container's filesystem. Message written is intended to be brief final status, such as an assertion failure message. Will be truncated by the node if greater than 4096 bytes. The total message length across all containers will be limited to 12kb. Defaults to /dev/termination-log. Cannot be updated.

+

terminationMessagePolicy

+

String

+

Indicate how the termination message should be populated. File will use the contents of terminationMessagePath to populate the container status message on both success and failure. FallbackToLogsOnError will use the last chunk of container log output if the termination message file is empty and the container exited with an error. The log output is limited to 2048 bytes or 80 lines, whichever is smaller. Defaults to File. Cannot be updated.

+

Possible enum values:

+
  • "FallbackToLogsOnError" will read the most recent contents of the container logs for the container status message when the container exits with an error and the terminationMessagePath has no contents.
  • "File" is the default behavior and will set the container status message to the contents of the container's terminationMessagePath when the container exits.
+

tty

+

Boolean

+

Whether this container should allocate a TTY for itself, also

+

requires 'stdin' to be true. Default is false.

+

volumeMounts

+

Array of io.cci.otc.api.pkg.apis.versioned.cci.v2.VolumeMount objects

+

Pod volumes to mount into the container's filesystem. Cannot

+

be updated.

+

workingDir

+

String

+

Container's working directory. If not specified, the container

+

runtime's default will be used, which might be configured in the container

+

image. Cannot be updated.

+
+
+ +
+ + + + + + + + + + + + + + + + + +
Table 22 io.cci.otc.api.pkg.apis.versioned.cci.v2.EnvVar

Parameter

+

Type

+

Description

+

name

+

String

+

Name of the environment variable. Must be a C_IDENTIFIER.

+

value

+

String

+

Variable references $(VAR_NAME) are expanded using the previously defined environment variables in the container and any service environment variables. If a variable cannot be resolved, the reference in the input string will be unchanged. Double $$ are reduced to a single $, which allows for escaping the $(VAR_NAME) syntax: i.e. "$$(VAR_NAME)" will produce the string literal "$(VAR_NAME)". Escaped references will never be expanded, regardless of whether the variable exists or not. Defaults to "".

+

valueFrom

+

io.cci.otc.api.pkg.apis.versioned.cci.v2.EnvVarSource object

+

Source for the environment variable's value. Cannot be used if

+

value is not empty.

+
+
+ +
+ + + + + + + + + + + + + + + + + + + + + +
Table 23 io.cci.otc.api.pkg.apis.versioned.cci.v2.EnvVarSource

Parameter

+

Type

+

Description

+

configMapKeyRef

+

io.cci.otc.api.pkg.apis.versioned.cci.v2.ConfigMapKeySelector object

+

Selects a key of a ConfigMap.

+

fieldRef

+

io.cci.otc.api.pkg.apis.versioned.cci.v2.ObjectFieldSelector object

+

Selects a field of the pod: supports metadata.name, metadata.namespace, metadata.labels['<KEY>'], metadata.annotations['<KEY>'], spec.nodeName, spec.serviceAccountName, status.hostIP, status.podIP, status.podIPs.

+

resourceFieldRef

+

io.cci.otc.api.pkg.apis.versioned.cci.v2.ResourceFieldSelector object

+

Selects a resource of the container: only resources limits and requests (limits.cpu, limits.memory, limits.ephemeral-storage, requests.cpu, requests.memory and requests.ephemeral-storage) are currently supported.

+

secretKeyRef

+

io.cci.otc.api.pkg.apis.versioned.cci.v2.SecretKeySelector object

+

Selects a key of a secret in the pod's namespace

+
+
+ +
+ + + + + + + + + + + + + + + + + +
Table 24 io.cci.otc.api.pkg.apis.versioned.cci.v2.ConfigMapKeySelector

Parameter

+

Type

+

Description

+

key

+

String

+

The key to select.

+

name

+

String

+

Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names

+

optional

+

Boolean

+

Specify whether the ConfigMap or its key must be defined

+
+
+ +
+ + + + + + + + + + + + + + + + + +
Table 25 io.cci.otc.api.pkg.apis.versioned.cci.v2.SecretKeySelector

Parameter

+

Type

+

Description

+

key

+

String

+

The key of the secret to select from. Must be a valid secret

+

key.

+

name

+

String

+

Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names

+

optional

+

Boolean

+

Specify whether the Secret or its key must be defined

+
+
+ +
+ + + + + + + + + + + + + + + + + +
Table 26 io.cci.otc.api.pkg.apis.versioned.cci.v2.EnvFromSource

Parameter

+

Type

+

Description

+

configMapRef

+

io.cci.otc.api.pkg.apis.versioned.cci.v2.ConfigMapEnvSource object

+

The ConfigMap to select from

+

prefix

+

String

+

An optional identifier to prepend to each key in the ConfigMap.

+

Must be a C_IDENTIFIER.

+

secretRef

+

io.cci.otc.api.pkg.apis.versioned.cci.v2.SecretEnvSource object

+

The Secret to select from

+
+
+ +
+ + + + + + + + + + + + + +
Table 27 io.cci.otc.api.pkg.apis.versioned.cci.v2.ConfigMapEnvSource

Parameter

+

Type

+

Description

+

name

+

String

+

Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names

+

optional

+

Boolean

+

Specify whether the ConfigMap must be defined

+
+
+ +
+ + + + + + + + + + + + + +
Table 28 io.cci.otc.api.pkg.apis.versioned.cci.v2.SecretEnvSource

Parameter

+

Type

+

Description

+

name

+

String

+

Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names

+

optional

+

Boolean

+

Specify whether the Secret must be defined

+
+
+ +
+ + + + + + + + + + + + + +
Table 29 io.cci.otc.api.pkg.apis.versioned.cci.v2.Lifecycle

Parameter

+

Type

+

Description

+

postStart

+

io.cci.otc.api.pkg.apis.versioned.cci.v2.LifecycleHandler object

+

PostStart is called immediately after a container is created. If the handler fails, the container is terminated and restarted according to its restart policy. Other management of the container blocks until the hook completes. More info: https://kubernetes.io/docs/concepts/containers/container-lifecycle-hooks/#container-hooks

+

preStop

+

io.cci.otc.api.pkg.apis.versioned.cci.v2.LifecycleHandler object

+

PreStop is called immediately before a container is terminated due to an API request or management event such as liveness/startup probe failure, preemption, resource contention, etc. The handler is not called if the container crashes or exits. The Pod's termination grace period countdown begins before the PreStop hook is executed. Regardless of the outcome of the handler, the container will eventually terminate within the Pod's termination grace period (unless delayed by finalizers). Other management of the container blocks until the hook completes or until the termination grace period is reached. More info: https://kubernetes.io/docs/concepts/containers/container-lifecycle-hooks/#container-hooks

+
+
+ +
+ + + + + + + + + + + + + +
Table 30 io.cci.otc.api.pkg.apis.versioned.cci.v2.LifecycleHandler

Parameter

+

Type

+

Description

+

exec

+

io.cci.otc.api.pkg.apis.versioned.cci.v2.ExecAction object

+

Exec specifies the action to take.

+

httpGet

+

io.cci.otc.api.pkg.apis.versioned.cci.v2.HTTPGetAction object

+

HTTPGet specifies the http request to perform.

+
+
+ +
+ + + + + + + + + + + + + + + + + +
Table 31 io.cci.otc.api.pkg.apis.versioned.cci.v2.ContainerPort

Parameter

+

Type

+

Description

+

containerPort

+

Integer

+

Number of port to expose on the pod's IP address. This must be

+

a valid port number, 0 < x < 65536.

+

name

+

String

+

If specified, this must be an IANA_SVC_NAME and unique within

+

the pod. Each named port in a pod must have a unique name. Name for the

+

port that can be referred to by services.

+

protocol

+

String

+

Protocol for port. Must be UDP, TCP, or SCTP. Defaults to "TCP".

+

Possible enum values:

+
  • "SCTP" is the SCTP protocol.
  • "TCP" is the TCP protocol.
  • "UDP" is the UDP protocol.
+
+
+ +
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Table 32 io.cci.otc.api.pkg.apis.versioned.cci.v2.SecurityContext

Parameter

+

Type

+

Description

+

capabilities

+

io.cci.otc.api.pkg.apis.versioned.cci.v2.Capabilities object

+

The capabilities to add/drop when running containers. Defaults

+

to the default set of capabilities granted by the container runtime. Note

+

that this field cannot be set when spec.os.name is windows.

+

procMount

+

String

+

procMount denotes the type of proc mount to use for the containers.

+

The default is DefaultProcMount which uses the container runtime defaults

+

for readonly paths and masked paths. This requires the ProcMountType feature

+

flag to be enabled. Note that this field cannot be set when spec.os.name

+

is windows.

+

readOnlyRootFilesystem

+

Boolean

+

Whether this container has a read-only root filesystem. Default

+

is false. Note that this field cannot be set when spec.os.name is windows.

+

runAsGroup

+

Long

+

The GID to run the entrypoint of the container process. Uses

+

runtime default if unset. May also be set in PodSecurityContext. If set

+

in both SecurityContext and PodSecurityContext, the value specified in SecurityContext

+

takes precedence. Note that this field cannot be set when spec.os.name is

+

windows.

+

runAsNonRoot

+

Boolean

+

Indicates that the container must run as a non-root user. If

+

true, the Kubelet will validate the image at runtime to ensure that it does

+

not run as UID 0 (root) and fail to start the container if it does. If unset

+

or false, no such validation will be performed. May also be set in PodSecurityContext. If

+

set in both SecurityContext and PodSecurityContext, the value specified

+

in SecurityContext takes precedence.

+

runAsUser

+

Long

+

The UID to run the entrypoint of the container process. Defaults

+

to user specified in image metadata if unspecified. May also be set in PodSecurityContext. If

+

set in both SecurityContext and PodSecurityContext, the value specified

+

in SecurityContext takes precedence. Note that this field cannot be set

+

when spec.os.name is windows.

+
+
+ +
+ + + + + + + + + + + + + +
Table 33 io.cci.otc.api.pkg.apis.versioned.cci.v2.Capabilities

Parameter

+

Type

+

Description

+

add

+

Array of strings

+

Added capabilities

+

drop

+

Array of strings

+

Removed capabilities

+
+
+ +
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Table 34 io.cci.otc.api.pkg.apis.versioned.cci.v2.Probe

Parameter

+

Type

+

Description

+

exec

+

io.cci.otc.api.pkg.apis.versioned.cci.v2.ExecAction object

+

Exec specifies the action to take.

+

failureThreshold

+

Integer

+

Minimum consecutive failures for the probe to be considered failed

+

after having succeeded. Defaults to 3. Minimum value is 1.

+

httpGet

+

io.cci.otc.api.pkg.apis.versioned.cci.v2.HTTPGetAction object

+

HTTPGet specifies the http request to perform.

+

initialDelaySeconds

+

Integer

+

Number of seconds after the container has started before liveness probes are initiated. More info: https://kubernetes.io/docs/concepts/workloads/pods/pod-lifecycle#container-probes

+

periodSeconds

+

Integer

+

How often (in seconds) to perform the probe. Default to 10 seconds.

+

Minimum value is 1.

+

successThreshold

+

Integer

+

Minimum consecutive successes for the probe to be considered

+

successful after having failed. Defaults to 1. Must be 1 for liveness and

+

startup. Minimum value is 1.

+

tcpSocket

+

io.cci.otc.api.pkg.apis.versioned.cci.v2.TCPSocketAction object

+

TCPSocket specifies an action involving a TCP port.

+

terminationGracePeriodSeconds

+

Long

+

Optional duration in seconds the pod needs to terminate gracefully

+

upon probe failure. The grace period is the duration in seconds after the

+

processes running in the pod are sent a termination signal and the time

+

when the processes are forcibly halted with a kill signal. Set this value

+

longer than the expected cleanup time for your process. If this value is

+

nil, the pod's terminationGracePeriodSeconds will be used. Otherwise, this

+

value overrides the value provided by the pod spec. Value must be non-negative

+

integer. The value zero indicates stop immediately via the kill signal (no

+

opportunity to shut down). This is a beta field and requires enabling ProbeTerminationGracePeriod

+

feature gate. Minimum value is 1. spec.terminationGracePeriodSeconds is

+

used if unset.

+

timeoutSeconds

+

Integer

+

Number of seconds after which the probe times out. Defaults to 1 second. Minimum value is 1. More info: https://kubernetes.io/docs/concepts/workloads/pods/pod-lifecycle#container-probes

+
+
+ +
+ + + + + + + + + +
Table 35 io.cci.otc.api.pkg.apis.versioned.cci.v2.ExecAction

Parameter

+

Type

+

Description

+

command

+

Array of strings

+

Command is the command line to execute inside the container,

+

the working directory for the command is root ('/') in the container's

+

filesystem. The command is simply exec'd, it is not run inside a shell,

+

so traditional shell instructions ('|', etc) won't work. To use a shell,

+

you need to explicitly call out to that shell. Exit status of 0 is treated

+

as live/healthy and non-zero is unhealthy.

+
+
+ +
+ + + + + + + + + + + + + + + + + + + + + + + + + +
Table 36 io.cci.otc.api.pkg.apis.versioned.cci.v2.HTTPGetAction

Parameter

+

Type

+

Description

+

host

+

String

+

Host name to connect to, defaults to the pod IP. You probably

+

want to set "Host" in httpHeaders instead.

+

httpHeaders

+

Array of io.cci.otc.api.pkg.apis.versioned.cci.v2.HTTPHeader objects

+

Custom headers to set in the request. HTTP allows repeated headers.

+

path

+

String

+

Path to access on the HTTP server.

+

port

+

String

+

Name or number of the port to access on the container. Number

+

must be in the range 1 to 65535. Name must be an IANA_SVC_NAME.

+

scheme

+

String

+

Scheme to use for connecting to the host. Defaults to HTTP.

+

Possible enum values:

+
  • "HTTP" means that the scheme used will be http://
  • "HTTPS" means that the scheme used will be https://
+
+
+ +
+ + + + + + + + + + + + + +
Table 37 io.cci.otc.api.pkg.apis.versioned.cci.v2.HTTPHeader

Parameter

+

Type

+

Description

+

name

+

String

+

The header field name

+

value

+

String

+

The header field value

+
+
+ +
+ + + + + + + + + + + + + +
Table 38 io.cci.otc.api.pkg.apis.versioned.cci.v2.TCPSocketAction

Parameter

+

Type

+

Description

+

host

+

String

+

Optional: Host name to connect to, defaults to the pod IP.

+

port

+

String

+

Number or name of the port to access on the container. Number

+

must be in the range 1 to 65535. Name must be an IANA_SVC_NAME.

+
+
+ +
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Table 39 io.cci.otc.api.pkg.apis.versioned.cci.v2.VolumeMount

Parameter

+

Type

+

Description

+

extendPathMode

+

String

+

Extend the volume path by appending the pod metadata to the path

+

according to specified pattern. which provide a way of directory isolation

+

and help prevent the writing conflict between different pods.

+

mountPath

+

String

+

Path within the container at which the volume should be mounted. Must

+

not contain ':'.

+

name

+

String

+

This must match the Name of a Volume.

+

readOnly

+

Boolean

+

Mounted read-only if true, read-write otherwise (false or unspecified).

+

Defaults to false.

+

subPath

+

String

+

Path within the volume from which the container's volume should

+

be mounted. Defaults to "" (volume's root).

+

subPathExpr

+

String

+

Expanded path within the volume from which the container's volume

+

should be mounted. Behaves similarly to SubPath but environment variable

+

references $(VAR_NAME) are expanded using the container's environment. Defaults

+

to "" (volume's root). SubPathExpr and SubPath are mutually exclusive.

+
+
+ +
+ + + + + + + + + +
Table 40 io.cci.otc.api.pkg.apis.versioned.cci.v2.PodReadinessGate

Parameter

+

Type

+

Description

+

conditionType

+

String

+

ConditionType refers to a condition in the pod's condition list

+

with matching type.

+
+
+ +
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Table 41 io.cci.otc.api.pkg.apis.versioned.cci.v2.PodSecurityContext

Parameter

+

Type

+

Description

+

fsGroup

+

Long

+

A special supplemental group that applies to all containers in a pod. Some volume types allow the Kubelet to change the ownership of that volume to be owned by the pod:

+
  1. The owning GID will be the FSGroup 2. The setgid bit is set (new files created in the volume will be owned by FSGroup) 3. The permission bits are OR'd with rw-rw----
+

If unset, the Kubelet will not modify the ownership and permissions of any volume. Note that this field cannot be set when spec.os.name is windows.

+

fsGroupChangePolicy

+

String

+

fsGroupChangePolicy defines behavior of changing ownership and permission of the volume before being exposed inside Pod. This field will only apply to volume types which support fsGroup based ownership(and permissions). It will have no effect on ephemeral volume types such as: secret, configmaps and emptydir. Valid values are "OnRootMismatch" and "Always". If not specified, "Always" is used. Note that this field cannot be set when spec.os.name is windows.

+

runAsGroup

+

Long

+

The GID to run the entrypoint of the container process. Uses

+

runtime default if unset. May also be set in SecurityContext. If set in

+

both SecurityContext and PodSecurityContext, the value specified in SecurityContext

+

takes precedence for that container. Note that this field cannot be set

+

when spec.os.name is windows.

+

runAsNonRoot

+

Boolean

+

Indicates that the container must run as a non-root user. If

+

true, the Kubelet will validate the image at runtime to ensure that it does

+

not run as UID 0 (root) and fail to start the container if it does. If unset

+

or false, no such validation will be performed. May also be set in SecurityContext. If

+

set in both SecurityContext and PodSecurityContext, the value specified

+

in SecurityContext takes precedence.

+

runAsUser

+

Long

+

The UID to run the entrypoint of the container process. Defaults

+

to user specified in image metadata if unspecified. May also be set in SecurityContext. If

+

set in both SecurityContext and PodSecurityContext, the value specified

+

in SecurityContext takes precedence for that container. Note that this field

+

cannot be set when spec.os.name is windows.

+

supplementalGroups

+

Array of longs

+

A list of groups applied to the first process run in each container,

+

in addition to the container's primary GID. If unspecified, no groups will

+

be added to any container. Note that this field cannot be set when spec.os.name

+

is windows.

+

sysctls

+

Array of io.cci.otc.api.pkg.apis.versioned.cci.v2.Sysctl objects

+

Sysctls hold a list of namespaced sysctls used for the pod. Pods

+

with unsupported sysctls (by the container runtime) might fail to launch.

+

Note that this field cannot be set when spec.os.name is windows.

+
+
+ +
+ + + + + + + + + + + + + +
Table 42 io.cci.otc.api.pkg.apis.versioned.cci.v2.Sysctl

Parameter

+

Type

+

Description

+

name

+

String

+

Name of a property to set

+

value

+

String

+

Value of a property to set

+
+
+ +
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Table 43 io.cci.otc.api.pkg.apis.versioned.cci.v2.TopologySpreadConstraint

Parameter

+

Type

+

Description

+

labelSelector

+

io.k8s.apimachinery.pkg.apis.meta.v1.LabelSelector object

+

LabelSelector is used to find matching pods. Pods that match

+

this label selector are counted to determine the number of pods in their

+

corresponding topology domain.

+

matchLabelKeys

+

Array of strings

+

MatchLabelKeys is a set of pod label keys to select the pods

+

over which spreading will be calculated. The keys are used to lookup values

+

from the incoming pod labels, those key-value labels are ANDed with labelSelector

+

to select the group of existing pods over which spreading will be calculated

+

for the incoming pod. Keys that don't exist in the incoming pod labels will

+

be ignored. A null or empty list means only match against labelSelector.

+

maxSkew

+

Integer

+

MaxSkew describes the degree to which pods may be unevenly distributed. When whenUnsatisfiable=DoNotSchedule, it is the maximum permitted difference between the number of matching pods in the target topology and the global minimum. The global minimum is the minimum number of matching pods in an eligible domain or zero if the number of eligible domains is less than MinDomains. For example, in a 3-zone cluster, MaxSkew is set to 1, and pods with the same labelSelector spread as 2/2/1: In this case, the global minimum is 1. | zone1 | zone2 | zone3 | | P P | P P | P | - if MaxSkew is 1, incoming pod can only be scheduled to zone3 to become 2/2/2; scheduling it onto zone1(zone2) would make the ActualSkew(3-1) on zone1(zone2) violate MaxSkew(1). - if MaxSkew is 2, incoming pod can be scheduled onto any zone. When whenUnsatisfiable=ScheduleAnyway, it is used to give higher precedence to topologies that satisfy it. It's a required field. Default value is 1 and 0 is not allowed.

+

minDomains

+

Integer

+

MinDomains indicates a minimum number of eligible domains. When the number of eligible domains with matching topology keys is less than minDomains, Pod Topology Spread treats "global minimum" as 0, and then the calculation of Skew is performed. And when the number of eligible domains with matching topology keys equals or greater than minDomains, this value has no effect on scheduling. As a result, when the number of eligible domains is less than minDomains, scheduler won't schedule more than maxSkew Pods to those domains. If value is nil, the constraint behaves as if MinDomains is equal to 1. Valid values are integers greater than 0. When value is not nil, WhenUnsatisfiable must be DoNotSchedule.

+

For example, in a 3-zone cluster, MaxSkew is set to 2, MinDomains is set to 5 and pods with the same labelSelector spread as 2/2/2: | zone1 | zone2 | zone3 | | P P | P P | P P | The number of domains is less than 5(MinDomains), so "global minimum" is treated as 0. In this situation, new pod with the same labelSelector cannot be scheduled, because computed skew will be 3(3 - 0) if new Pod is scheduled to any of the three zones, it will violate MaxSkew.

+

This is a beta field and requires the MinDomainsInPodTopologySpread feature gate to be enabled (enabled by default).

+

nodeAffinityPolicy

+

String

+

NodeAffinityPolicy indicates how we will treat Pod's nodeAffinity/nodeSelector when calculating pod topology spread skew. Options are: - Honor: only nodes matching nodeAffinity/nodeSelector are included in the calculations. - Ignore: nodeAffinity/nodeSelector are ignored. All nodes are included in the calculations.

+

If this value is nil, the behavior is equivalent to the Honor policy. This is a alpha-level feature enabled by the NodeInclusionPolicyInPodTopologySpread feature flag.

+

nodeTaintsPolicy

+

String

+

NodeTaintsPolicy indicates how we will treat node taints when calculating pod topology spread skew. Options are: - Honor: nodes without taints, along with tainted nodes for which the incoming pod has a toleration, are included. - Ignore: node taints are ignored. All nodes are included.

+

If this value is nil, the behavior is equivalent to the Ignore policy. This is a alpha-level feature enabled by the NodeInclusionPolicyInPodTopologySpread feature flag.

+

topologyKey

+

String

+

TopologyKey is the key of node labels. Nodes that have a label

+

with this key and identical values are considered to be in the same topology.

+

We consider each <key, value> as a "bucket", and try to put balanced number

+

of pods into each bucket. We define a domain as a particular instance of

+

a topology. Also, we define an eligible domain as a domain whose nodes meet

+

the requirements of nodeAffinityPolicy and nodeTaintsPolicy. e.g. If TopologyKey

+

is "kubernetes.io/hostname", each Node is a domain of that topology. And,

+

if TopologyKey is "topology.kubernetes.io/zone", each zone is a domain of

+

that topology. It's a required field.

+

whenUnsatisfiable

+

String

+

WhenUnsatisfiable indicates how to deal with a pod if it doesn't satisfy the spread constraint. - DoNotSchedule (default) tells the scheduler not to schedule it. - ScheduleAnyway tells the scheduler to schedule the pod in any location,

+

but giving higher precedence to topologies that would help reduce the

+

skew.

+

A constraint is considered "Unsatisfiable" for an incoming pod if and only if every possible node assignment for that pod would violate "MaxSkew" on some topology. For example, in a 3-zone cluster, MaxSkew is set to 1, and pods with the same labelSelector spread as 3/1/1: | zone1 | zone2 | zone3 | | P P P | P | P | If WhenUnsatisfiable is set to DoNotSchedule, incoming pod can only be scheduled to zone2(zone3) to become 3/2/1(3/1/2) as ActualSkew(2-1) on zone2(zone3) satisfies MaxSkew(1). In other words, the cluster can still be imbalanced, but scheduler won't make it more imbalanced. It's a required field.

+

Possible enum values:

+
  • "DoNotSchedule" instructs the scheduler not to schedule the pod when constraints are not satisfied.
  • "ScheduleAnyway" instructs the scheduler to schedule the pod even if constraints are not satisfied.
+
+
+ +
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Table 44 io.cci.otc.api.pkg.apis.versioned.cci.v2.Volume

Parameter

+

Type

+

Description

+

configMap

+

io.cci.otc.api.pkg.apis.versioned.cci.v2.ConfigMapVolumeSource object

+

configMap represents a configMap that should populate this volume

+

downwardAPI

+

io.cci.otc.api.pkg.apis.versioned.cci.v2.DownwardAPIVolumeSource object

+

downwardAPI represents downward API about the pod that should

+

populate this volume

+

emptyDir

+

io.cci.otc.api.pkg.apis.versioned.cci.v2.EmptyDirVolumeSource object

+

emptyDir represents a temporary directory that shares a pod's lifetime. More info: https://kubernetes.io/docs/concepts/storage/volumes#emptydir

+

ephemeral

+

io.cci.otc.api.pkg.apis.versioned.cci.v2.EphemeralVolumeSource object

+

ephemeral represents a volume that is handled by a cluster storage driver. The volume's lifecycle is tied to the pod that defines it - it will be created before the pod starts, and deleted when the pod is removed.

+

Use this if: a) the volume is only needed while the pod runs, b) features of normal volumes like restoring from snapshot or capacity

+

tracking are needed,

+

c) the storage driver is specified through a storage class, and d) the storage driver supports dynamic volume provisioning through

+

a PersistentVolumeClaim (see EphemeralVolumeSource for more

+

information on the connection between this volume type

+

and PersistentVolumeClaim).

+

Use PersistentVolumeClaim or one of the vendor-specific APIs for volumes that persist for longer than the lifecycle of an individual pod.

+

Use CSI for light-weight local ephemeral volumes if the CSI driver is meant to be used that way - see the documentation of the driver for more information.

+

A pod can use both types of ephemeral volumes and persistent volumes at the same time.

+

name

+

String

+

name of the volume. Must be a DNS_LABEL and unique within the pod. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names

+

nfs

+

io.cci.otc.api.pkg.apis.versioned.cci.v2.NFSVolumeSource object

+

nfs represents an NFS mount on the host that shares a pod's lifetime More info: https://kubernetes.io/docs/concepts/storage/volumes#nfs

+

persistentVolumeClaim

+

io.cci.otc.api.pkg.apis.versioned.cci.v2.PersistentVolumeClaimVolumeSource object

+

persistentVolumeClaimVolumeSource represents a reference to a PersistentVolumeClaim in the same namespace. More info: https://kubernetes.io/docs/concepts/storage/persistent-volumes#persistentvolumeclaims

+

projected

+

io.cci.otc.api.pkg.apis.versioned.cci.v2.ProjectedVolumeSource object

+

projected items for all in one resources secrets, configmaps,

+

and downward API

+

secret

+

io.cci.otc.api.pkg.apis.versioned.cci.v2.SecretVolumeSource object

+

secret represents a secret that should populate this volume. More info: https://kubernetes.io/docs/concepts/storage/volumes#secret

+
+
+ +
+ + + + + + + + + + + + + + + + + + + + + +
Table 45 io.cci.otc.api.pkg.apis.versioned.cci.v2.ConfigMapVolumeSource

Parameter

+

Type

+

Description

+

defaultMode

+

Integer

+

defaultMode is optional: mode bits used to set permissions on created files by default. Must be an octal value between 0000 and 0777 or a decimal value between 0 and 511. YAML accepts both octal and decimal values, JSON requires decimal values for mode bits. Defaults to 0644. Directories within the path are not affected by this setting. This might be in conflict with other options that affect the file mode, like fsGroup, and the result can be other mode bits set.

+

items

+

Array of io.cci.otc.api.pkg.apis.versioned.cci.v2.KeyToPath objects

+

items if unspecified, each key-value pair in the Data field of

+

the referenced ConfigMap will be projected into the volume as a file whose

+

name is the key and content is the value. If specified, the listed keys

+

will be projected into the specified paths, and unlisted keys will not be

+

present. If a key is specified which is not present in the ConfigMap, the

+

volume setup will error unless it is marked optional. Paths must be relative

+

and may not contain the '..' path or start with '..'.

+

name

+

String

+

Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names

+

optional

+

Boolean

+

optional specify whether the ConfigMap or its keys must be defined

+
+
+ +
+ + + + + + + + + + + + + +
Table 46 io.cci.otc.api.pkg.apis.versioned.cci.v2.DownwardAPIVolumeSource

Parameter

+

Type

+

Description

+

defaultMode

+

Integer

+

Optional: mode bits to use on created files by default. Must be a Optional: mode bits used to set permissions on created files by default. Must be an octal value between 0000 and 0777 or a decimal value between 0 and 511. YAML accepts both octal and decimal values, JSON requires decimal values for mode bits. Defaults to 0644. Directories within the path are not affected by this setting. This might be in conflict with other options that affect the file mode, like fsGroup, and the result can be other mode bits set.

+

items

+

Array of io.cci.otc.api.pkg.apis.versioned.cci.v2.DownwardAPIVolumeFile objects

+

Items is a list of downward API volume file

+
+
+ +
+ + + + + + + + + + + + + +
Table 47 io.cci.otc.api.pkg.apis.versioned.cci.v2.EmptyDirVolumeSource

Parameter

+

Type

+

Description

+

medium

+

String

+

medium represents what type of storage medium should back this directory. The default is "" which means to use the node's default medium. Must be an empty string (default) or Memory. More info: https://kubernetes.io/docs/concepts/storage/volumes#emptydir

+

sizeLimit

+

String

+

sizeLimit is the total amount of local storage required for this EmptyDir volume. The size limit is also applicable for memory medium. The maximum usage on memory medium EmptyDir would be the minimum value between the SizeLimit specified here and the sum of memory limits of all containers in a pod. The default is nil which means that the limit is undefined. More info: http://kubernetes.io/docs/user-guide/volumes#emptydir

+
+
+ +
+ + + + + + + + + +
Table 48 io.cci.otc.api.pkg.apis.versioned.cci.v2.EphemeralVolumeSource

Parameter

+

Type

+

Description

+

volumeClaimTemplate

+

io.cci.otc.api.pkg.apis.versioned.cci.v2.PersistentVolumeClaimTemplate object

+

Will be used to create a stand-alone PVC to provision the volume. The pod in which this EphemeralVolumeSource is embedded will be the owner of the PVC, i.e. the PVC will be deleted together with the pod. The name of the PVC will be <pod name>-<volume name> where <volume name> is the name from the PodSpec.Volumes array entry. Pod validation will reject the pod if the concatenated name is not valid for a PVC (for example, too long).

+

An existing PVC with that name that is not owned by the pod will not be used for the pod to avoid using an unrelated volume by mistake. Starting the pod is then blocked until the unrelated PVC is removed. If such a pre-created PVC is meant to be used by the pod, the PVC has to updated with an owner reference to the pod once the pod exists. Normally this should not be necessary, but it may be useful when manually reconstructing a broken cluster.

+

This field is read-only and no changes will be made by Kubernetes to the PVC after it has been created.

+

Required, must not be nil.

+
+
+ +
+ + + + + + + + + + + + + +
Table 49 io.cci.otc.api.pkg.apis.versioned.cci.v2.PersistentVolumeClaimTemplate

Parameter

+

Type

+

Description

+

metadata

+

io.k8s.apimachinery.pkg.apis.meta.v1.ObjectMeta object

+

May contain labels and annotations that will be copied into the

+

PVC when creating it. No other fields are allowed and will be rejected during

+

validation.

+

spec

+

io.cci.otc.api.pkg.apis.versioned.cci.v2.PersistentVolumeClaimSpec object

+

The specification for the PersistentVolumeClaim. The entire content

+

is copied unchanged into the PVC that gets created from this template. The

+

same fields as in a PersistentVolumeClaim are also valid here.

+
+
+ +
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Table 50 io.k8s.apimachinery.pkg.apis.meta.v1.ObjectMeta

Parameter

+

Type

+

Description

+

annotations

+

Map<String,String>

+

Annotations is an unstructured key value map stored with a resource that may be set by external tools to store and retrieve arbitrary metadata. They are not queryable and should be preserved when modifying objects. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/annotations/

+

clusterName

+

String

+

The name of the cluster which the object belongs to. This is

+

used to distinguish resources with same name and namespace in different

+

clusters. This field is not set anywhere right now and apiserver is going

+

to ignore it if set in create or update request.

+

creationTimestamp

+

String

+

CreationTimestamp is a timestamp representing the server time when this object was created. It is not guaranteed to be set in happens-before order across separate operations. Clients may not set this value. It is represented in RFC3339 form and is in UTC.

+

Populated by the system. Read-only. Null for lists. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata

+

deletionGracePeriodSeconds

+

Long

+

Number of seconds allowed for this object to gracefully terminate

+

before it will be removed from the system. Only set when deletionTimestamp

+

is also set. May only be shortened. Read-only.

+

deletionTimestamp

+

String

+

DeletionTimestamp is RFC 3339 date and time at which this resource will be deleted. This field is set by the server when a graceful deletion is requested by the user, and is not directly settable by a client. The resource is expected to be deleted (no longer visible from resource lists, and not reachable by name) after the time in this field, once the finalizers list is empty. As long as the finalizers list contains items, deletion is blocked. Once the deletionTimestamp is set, this value may not be unset or be set further into the future, although it may be shortened or the resource may be deleted prior to this time. For example, a user may request that a pod is deleted in 30 seconds. The Kubelet will react by sending a graceful termination signal to the containers in the pod. After that 30 seconds, the Kubelet will send a hard termination signal (SIGKILL) to the container and after cleanup, remove the pod from the API. In the presence of network partitions, this object may still exist after this timestamp, until an administrator or automated process can determine the resource is fully terminated. If not set, graceful deletion of the object has not been requested.

+

Populated by the system when a graceful deletion is requested. Read-only. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata

+

enable

+

Boolean

+

Enable identifies whether the resource is available

+

finalizers

+

Array of strings

+

Must be empty before the object is deleted from the registry.

+

Each entry is an identifier for the responsible component that will remove

+

the entry from the list. If the deletionTimestamp of the object is non-nil,

+

entries in this list can only be removed. Finalizers may be processed and

+

removed in any order. Order is NOT enforced because it introduces significant

+

risk of stuck finalizers. finalizers is a shared field, any actor with permission

+

can reorder it. If the finalizer list is processed in order, then this can

+

lead to a situation in which the component responsible for the first finalizer

+

in the list is waiting for a signal (field value, external system, or other)

+

produced by a component responsible for a finalizer later in the list, resulting

+

in a deadlock. Without enforced ordering finalizers are free to order amongst

+

themselves and are not vulnerable to ordering changes in the list.

+

generateName

+

String

+

GenerateName is an optional prefix, used by the server, to generate a unique name ONLY IF the Name field has not been provided. If this field is used, the name returned to the client will be different than the name passed. This value will also be combined with a unique suffix. The provided value has the same validation rules as the Name field, and may be truncated by the length of the suffix required to make the value unique on the server.

+

If this field is specified and the generated name exists, the server will NOT return a 409 - instead, it will either return 201 Created or 500 with Reason ServerTimeout indicating a unique name could not be found in the time allotted, and the client should retry (optionally after the time indicated in the Retry-After header).

+

Applied only if Name is not specified. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#idempotency

+

generation

+

Long

+

A sequence number representing a specific generation of the desired

+

state. Populated by the system. Read-only.

+

labels

+

Map<String,String>

+

Map of string keys and values that can be used to organize and categorize (scope and select) objects. May match selectors of replication controllers and services. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/labels/

+

managedFields

+

Array of io.k8s.apimachinery.pkg.apis.meta.v1.ManagedFieldsEntry objects

+

ManagedFields maps workflow-id and version to the set of fields

+

that are managed by that workflow. This is mostly for internal housekeeping,

+

and users typically shouldn't need to set or understand this field. A workflow

+

can be the user's name, a controller's name, or the name of a specific apply

+

path like "ci-cd". The set of fields is always in the version that the workflow

+

used when modifying the object.

+

name

+

String

+

Name must be unique within a namespace. Is required when creating resources, although some resources may allow a client to request the generation of an appropriate name automatically. Name is primarily intended for creation idempotence and configuration definition. Cannot be updated. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names

+

namespace

+

String

+

Namespace defines the space within which each name must be unique. An empty namespace is equivalent to the "default" namespace, but "default" is the canonical representation. Not all objects are required to be scoped to a namespace - the value of this field for those objects will be empty.

+

Must be a DNS_LABEL. Cannot be updated. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/namespaces/

+

ownerReferences

+

Array of io.k8s.apimachinery.pkg.apis.meta.v1.OwnerReference objects

+

List of objects depended by this object. If ALL objects in the

+

list have been deleted, this object will be garbage collected. If this object

+

is managed by a controller, then an entry in this list will point to this

+

controller, with the controller field set to true. There cannot be more

+

than one managing controller.

+

resourceVersion

+

String

+

An opaque value that represents the internal version of this object that can be used by clients to determine when objects have changed. May be used for optimistic concurrency, change detection, and the watch operation on a resource or set of resources. Clients must treat these values as opaque and passed unmodified back to the server. They may only be valid for a particular resource or set of resources.

+

Populated by the system. Read-only. Value must be treated as opaque by clients and . More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#concurrency-control-and-consistency

+

selfLink

+

String

+

SelfLink is a URL representing this object. Populated by the system. Read-only.

+

DEPRECATED Kubernetes will stop propagating this field in 1.20 release and the field is planned to be removed in 1.21 release.

+

uid

+

String

+

UID is the unique in time and space value for this object. It is typically generated by the server on successful creation of a resource and is not allowed to change on PUT operations.

+

Populated by the system. Read-only. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#uids

+
+
+ +
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Table 51 io.k8s.apimachinery.pkg.apis.meta.v1.ManagedFieldsEntry

Parameter

+

Type

+

Description

+

apiVersion

+

String

+

APIVersion defines the version of this resource that this field

+

set applies to. The format is "group/version" just like the top-level APIVersion

+

field. It is necessary to track the version of a field set because it cannot

+

be automatically converted.

+

fieldsType

+

String

+

FieldsType is the discriminator for the different fields format and version. There is currently only one possible value: "FieldsV1"

+

fieldsV1

+

Object

+

FieldsV1 holds the first JSON version format as described in

+

the "FieldsV1" type.

+

manager

+

String

+

Manager is an identifier of the workflow managing these fields.

+

operation

+

String

+

Operation is the type of operation which lead to this ManagedFieldsEntry

+

being created. The only valid values for this field are 'Apply' and 'Update'.

+

time

+

String

+

Time is timestamp of when these fields were set. It should always

+

be empty if Operation is 'Apply'

+
+
+ +
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Table 52 io.k8s.apimachinery.pkg.apis.meta.v1.OwnerReference

Parameter

+

Type

+

Description

+

apiVersion

+

String

+

API version of the referent.

+

blockOwnerDeletion

+

Boolean

+

If true, AND if the owner has the "foregroundDeletion" finalizer,

+

then the owner cannot be deleted from the key-value store until this reference

+

is removed. Defaults to false. To set this field, a user needs "delete"

+

permission of the owner, otherwise 422 (Unprocessable Entity) will be returned.

+

controller

+

Boolean

+

If true, this reference points to the managing controller.

+

kind

+

String

+

Kind of the referent. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds

+

name

+

String

+

Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names

+

uid

+

String

+

UID of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#uids

+
+
+ +
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Table 53 io.cci.otc.api.pkg.apis.versioned.cci.v2.PersistentVolumeClaimSpec

Parameter

+

Type

+

Description

+

accessModes

+

Array of strings

+

accessModes contains the desired access modes the volume should have. More info: https://kubernetes.io/docs/concepts/storage/persistent-volumes#access-modes-1

+

dataSource

+

io.cci.otc.api.pkg.apis.versioned.cci.v2.TypedLocalObjectReference object

+

dataSource field can be used to specify either: * An existing VolumeSnapshot object (snapshot.storage.k8s.io/VolumeSnapshot) * An existing PVC (PersistentVolumeClaim) If the provisioner or an external controller can support the specified data source, it will create a new volume based on the contents of the specified data source. If the AnyVolumeDataSource feature gate is enabled, this field will always have the same contents as the DataSourceRef field.

+

dataSourceRef

+

io.cci.otc.api.pkg.apis.versioned.cci.v2.TypedLocalObjectReference object

+

dataSourceRef specifies the object from which to populate the volume with data, if a non-empty volume is desired. This may be any local object from a non-empty API group (non core object) or a PersistentVolumeClaim object. When this field is specified, volume binding will only succeed if the type of the specified object matches some installed volume populator or dynamic provisioner. This field will replace the functionality of the DataSource field and as such if both fields are non-empty, they must have the same value. For backwards compatibility, both fields (DataSource and DataSourceRef) will be set to the same value automatically if one of them is empty and the other is non-empty. There are two important differences between DataSource and DataSourceRef: * While DataSource only allows two specific types of objects, DataSourceRef

+

allows any non-core object, as well as PersistentVolumeClaim objects.

+
  • While DataSource ignores disallowed values (dropping them), DataSourceRef

    preserves all values, and generates an error if a disallowed value is

    +

    specified.

    +

    (Beta) Using this field requires the AnyVolumeDataSource feature gate to be enabled.

    +
+

resources

+

io.cci.otc.api.pkg.apis.versioned.cci.v2.ResourceRequirements object

+

resources represents the minimum resources the volume should have. If RecoverVolumeExpansionFailure feature is enabled users are allowed to specify resource requirements that are lower than previous value but must still be higher than capacity recorded in the status field of the claim. More info: https://kubernetes.io/docs/concepts/storage/persistent-volumes#resources

+

selector

+

io.k8s.apimachinery.pkg.apis.meta.v1.LabelSelector object

+

selector is a label query over volumes to consider for binding.

+

storageClassName

+

String

+

storageClassName is the name of the StorageClass required by the claim. More info: https://kubernetes.io/docs/concepts/storage/persistent-volumes#class-1

+

volumeMode

+

String

+

volumeMode defines what type of volume is required by the claim.

+

Value of Filesystem is implied when not included in claim spec.

+

volumeName

+

String

+

volumeName is the binding reference to the PersistentVolume backing

+

this claim.

+
+
+ +
+ + + + + + + + + + + + + + + + + +
Table 54 io.cci.otc.api.pkg.apis.versioned.cci.v2.TypedLocalObjectReference

Parameter

+

Type

+

Description

+

apiGroup

+

String

+

APIGroup is the group for the resource being referenced. If APIGroup

+

is not specified, the specified Kind must be in the core API group. For

+

any other third-party types, APIGroup is required.

+

kind

+

String

+

Kind is the type of resource being referenced

+

name

+

String

+

Name is the name of resource being referenced

+
+
+ +
+ + + + + + + + + + + + + +
Table 55 io.cci.otc.api.pkg.apis.versioned.cci.v2.ResourceRequirements

Parameter

+

Type

+

Description

+

limits

+

Map<String,String>

+

Limits describes the maximum amount of compute resources allowed. More info: https://kubernetes.io/docs/concepts/configuration/manage-resources-containers/

+

requests

+

Map<String,String>

+

Requests describes the minimum amount of compute resources required. If Requests is omitted for a container, it defaults to Limits if that is explicitly specified, otherwise to an implementation-defined value. More info: https://kubernetes.io/docs/concepts/configuration/manage-resources-containers/

+
+
+ +
+ + + + + + + + + +
Table 56 io.k8s.apimachinery.pkg.api.resource.Quantity

Parameter

+

Type

+

Description

+

-

+

String

+

Quantity is a fixed-point representation of a number. It provides convenient marshaling/unmarshaling in JSON and YAML, in addition to String() and AsInt64() accessors.

+

The serialization format is:

+

[/topic/body/section/table/tgroup/tbody/row/entry/p/br {""}) (br] ::= [/topic/body/section/table/tgroup/tbody/row/entry/p/br {""}) (br][/topic/body/section/table/tgroup/tbody/row/entry/p/br {""}) (br]

+

(Note that [/topic/body/section/table/tgroup/tbody/row/entry/p/br {""}) (br] may be empty, from the "" case in [/topic/body/section/table/tgroup/tbody/row/entry/p/br {""}) (br].)

+

[/topic/body/section/table/tgroup/tbody/row/entry/p/br {""}) (br] ::= 0 | 1 | ... | 9 [/topic/body/section/table/tgroup/tbody/row/entry/p/br {""}) (br] ::= [/topic/body/section/table/tgroup/tbody/row/entry/p/br {""}) (br] | [/topic/body/section/table/tgroup/tbody/row/entry/p/br {""}) (br][/topic/body/section/table/tgroup/tbody/row/entry/p/br {""}) (br] [/topic/body/section/table/tgroup/tbody/row/entry/p/br {""}) (br] ::= [/topic/body/section/table/tgroup/tbody/row/entry/p/br {""}) (br] | [/topic/body/section/table/tgroup/tbody/row/entry/p/br {""}) (br].[/topic/body/section/table/tgroup/tbody/row/entry/p/br {""}) (br] | [/topic/body/section/table/tgroup/tbody/row/entry/p/br {""}) (br]. | .[/topic/body/section/table/tgroup/tbody/row/entry/p/br {""}) (br] [/topic/body/section/table/tgroup/tbody/row/entry/p/br {""}) (br] ::= "+" | "-" [/topic/body/section/table/tgroup/tbody/row/entry/p/br {""}) (br] ::= [/topic/body/section/table/tgroup/tbody/row/entry/p/br {""}) (br] | [/topic/body/section/table/tgroup/tbody/row/entry/p/br {""}) (br][/topic/body/section/table/tgroup/tbody/row/entry/p/br {""}) (br] [/topic/body/section/table/tgroup/tbody/row/entry/p/br {""}) (br] ::= [/topic/body/section/table/tgroup/tbody/row/entry/p/br {""}) (br] | [/topic/body/section/table/tgroup/tbody/row/entry/p/br {""}) (br] | [/topic/body/section/table/tgroup/tbody/row/entry/p/br {""}) (br] [/topic/body/section/table/tgroup/tbody/row/entry/p/br {""}) (br] ::= Ki | Mi | Gi | Ti | Pi | Ei

+

(International System of units; See: http://physics.nist.gov/cuu/Units/binary.html)

+

[/topic/body/section/table/tgroup/tbody/row/entry/p/br {""}) (br] ::= m | "" | k | M | G | T | P | E

+

(Note that 1024 = 1Ki but 1000 = 1k; I didn't choose the capitalization.)

+

[/topic/body/section/table/tgroup/tbody/row/entry/p/br {""}) (br] ::= "e" [/topic/body/section/table/tgroup/tbody/row/entry/p/br {""}) (br] | "E" [/topic/body/section/table/tgroup/tbody/row/entry/p/br {""}) (br]

+

No matter which of the three exponent forms is used, no quantity may represent a number greater than 2^63-1 in magnitude, nor may it have more than 3 decimal places. Numbers larger or more precise will be capped or rounded up. (E.g.: 0.1m will rounded up to 1m.) This may be extended in the future if we require larger or smaller quantities.

+

When a Quantity is parsed from a string, it will remember the type of suffix it had, and will use the same type again when it is serialized.

+

Before serializing, Quantity will be put in "canonical form". This means that Exponent/suffix will be adjusted up or down (with a corresponding increase or decrease in Mantissa) such that:

+

a. No precision is lost

+

b. No fractional digits will be emitted

+

c. The exponent (or suffix) is as large as possible.

+

The sign will be omitted unless the number is negative.

+

Examples:

+

1.5 will be serialized as "1500m"

+

1.5Gi will be serialized as "1536Mi"

+

Note that the quantity will NEVER be internally represented by a floating point number. That is the whole point of this exercise.

+

Non-canonical values will still parse as long as they are well formed, but will be re-emitted in their canonical form. (So always use canonical form, or don't diff.)

+

This format is intended to make it difficult to use these numbers without writing some sort of special handling code in the hopes that that will cause implementors to also use a fixed point implementation.

+
+
+ +
+ + + + + + + + + + + + + +
Table 57 io.k8s.apimachinery.pkg.apis.meta.v1.LabelSelector

Parameter

+

Type

+

Description

+

matchExpressions

+

Array of io.k8s.apimachinery.pkg.apis.meta.v1.LabelSelectorRequirement objects

+

matchExpressions is a list of label selector requirements. The

+

requirements are ANDed.

+

matchLabels

+

Map<String,String>

+

matchLabels is a map of {key,value} pairs. A single {key,value}

+

in the matchLabels map is equivalent to an element of matchExpressions,

+

whose key field is "key", the operator is "In", and the values array contains

+

only "value". The requirements are ANDed.

+
+
+ +
+ + + + + + + + + + + + + + + + + +
Table 58 io.k8s.apimachinery.pkg.apis.meta.v1.LabelSelectorRequirement

Parameter

+

Type

+

Description

+

key

+

String

+

key is the label key that the selector applies to.

+

operator

+

String

+

operator represents a key's relationship to a set of values.

+

Valid operators are In, NotIn, Exists and DoesNotExist.

+

values

+

Array of strings

+

values is an array of string values. If the operator is In or

+

NotIn, the values array must be non-empty. If the operator is Exists or

+

DoesNotExist, the values array must be empty. This array is replaced during

+

a strategic merge patch.

+
+
+ +
+ + + + + + + + + + + + + + + + + +
Table 59 io.cci.otc.api.pkg.apis.versioned.cci.v2.NFSVolumeSource

Parameter

+

Type

+

Description

+

path

+

String

+

path that is exported by the NFS server. More info: https://kubernetes.io/docs/concepts/storage/volumes#nfs

+

readOnly

+

Boolean

+

readOnly here will force the NFS export to be mounted with read-only permissions. Defaults to false. More info: https://kubernetes.io/docs/concepts/storage/volumes#nfs

+

server

+

String

+

server is the hostname or IP address of the NFS server. More info: https://kubernetes.io/docs/concepts/storage/volumes#nfs

+
+
+ +
+ + + + + + + + + + + + + +
Table 60 io.cci.otc.api.pkg.apis.versioned.cci.v2.PersistentVolumeClaimVolumeSource

Parameter

+

Type

+

Description

+

claimName

+

String

+

claimName is the name of a PersistentVolumeClaim in the same namespace as the pod using this volume. More info: https://kubernetes.io/docs/concepts/storage/persistent-volumes#persistentvolumeclaims

+

readOnly

+

Boolean

+

readOnly Will force the ReadOnly setting in VolumeMounts. Default

+

false.

+
+
+ +
+ + + + + + + + + + + + + +
Table 61 io.cci.otc.api.pkg.apis.versioned.cci.v2.ProjectedVolumeSource

Parameter

+

Type

+

Description

+

defaultMode

+

Integer

+

defaultMode are the mode bits used to set permissions on created

+

files by default. Must be an octal value between 0000 and 0777 or a decimal

+

value between 0 and 511. YAML accepts both octal and decimal values, JSON

+

requires decimal values for mode bits. Directories within the path are not

+

affected by this setting. This might be in conflict with other options that

+

affect the file mode, like fsGroup, and the result can be other mode bits

+

set.

+

sources

+

Array of io.cci.otc.api.pkg.apis.versioned.cci.v2.VolumeProjection objects

+

sources is the list of volume projections

+
+
+ +
+ + + + + + + + + + + + + + + + + +
Table 62 io.cci.otc.api.pkg.apis.versioned.cci.v2.VolumeProjection

Parameter

+

Type

+

Description

+

configMap

+

io.cci.otc.api.pkg.apis.versioned.cci.v2.ConfigMapProjection object

+

configMap information about the configMap data to project

+

downwardAPI

+

io.cci.otc.api.pkg.apis.versioned.cci.v2.DownwardAPIProjection object

+

downwardAPI information about the downwardAPI data to project

+

secret

+

io.cci.otc.api.pkg.apis.versioned.cci.v2.SecretProjection object

+

secret information about the secret data to project

+
+
+ +
+ + + + + + + + + + + + + + + + + +
Table 63 io.cci.otc.api.pkg.apis.versioned.cci.v2.ConfigMapProjection

Parameter

+

Type

+

Description

+

items

+

Array of io.cci.otc.api.pkg.apis.versioned.cci.v2.KeyToPath objects

+

items if unspecified, each key-value pair in the Data field of

+

the referenced ConfigMap will be projected into the volume as a file whose

+

name is the key and content is the value. If specified, the listed keys

+

will be projected into the specified paths, and unlisted keys will not be

+

present. If a key is specified which is not present in the ConfigMap, the

+

volume setup will error unless it is marked optional. Paths must be relative

+

and may not contain the '..' path or start with '..'.

+

name

+

String

+

Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names

+

optional

+

Boolean

+

optional specify whether the ConfigMap or its keys must be defined

+
+
+ +
+ + + + + + + + + +
Table 64 io.cci.otc.api.pkg.apis.versioned.cci.v2.DownwardAPIProjection

Parameter

+

Type

+

Description

+

items

+

Array of io.cci.otc.api.pkg.apis.versioned.cci.v2.DownwardAPIVolumeFile objects

+

Items is a list of DownwardAPIVolume file

+
+
+ +
+ + + + + + + + + + + + + + + + + + + + + +
Table 65 io.cci.otc.api.pkg.apis.versioned.cci.v2.DownwardAPIVolumeFile

Parameter

+

Type

+

Description

+

fieldRef

+

io.cci.otc.api.pkg.apis.versioned.cci.v2.ObjectFieldSelector object

+

Required: Selects a field of the pod: only annotations, labels, name and namespace are supported.

+

mode

+

Integer

+

Optional: mode bits used to set permissions on this file, must be an octal value between 0000 and 0777 or a decimal value between 0 and 511. YAML accepts both octal and decimal values, JSON requires decimal values for mode bits. If not specified, the volume defaultMode will be used. This might be in conflict with other options that affect the file mode, like fsGroup, and the result can be other mode bits set.

+

path

+

String

+

Required: Path is the relative path name of the file to be created. Must not be absolute or contain the '..' path. Must be utf-8 encoded. The first item of the relative path must not start with '..'

+

resourceFieldRef

+

io.cci.otc.api.pkg.apis.versioned.cci.v2.ResourceFieldSelector object

+

Selects a resource of the container: only resources limits and requests (limits.cpu, limits.memory, requests.cpu and requests.memory) are currently supported.

+
+
+ +
+ + + + + + + + + + + + + +
Table 66 io.cci.otc.api.pkg.apis.versioned.cci.v2.ObjectFieldSelector

Parameter

+

Type

+

Description

+

apiVersion

+

String

+

Version of the schema the FieldPath is written in terms of, defaults

+

to "v1".

+

fieldPath

+

String

+

Path of the field to select in the specified API version.

+
+
+ +
+ + + + + + + + + + + + + + + + + +
Table 67 io.cci.otc.api.pkg.apis.versioned.cci.v2.ResourceFieldSelector

Parameter

+

Type

+

Description

+

containerName

+

String

+

Container name: required for volumes, optional for env vars

+

divisor

+

String

+

Specifies the output format of the exposed resources, defaults

+

to "1"

+

resource

+

String

+

Required: resource to select

+
+
+ +
+ + + + + + + + + + + + + + + + + +
Table 68 io.cci.otc.api.pkg.apis.versioned.cci.v2.SecretProjection

Parameter

+

Type

+

Description

+

items

+

Array of io.cci.otc.api.pkg.apis.versioned.cci.v2.KeyToPath objects

+

items if unspecified, each key-value pair in the Data field of

+

the referenced Secret will be projected into the volume as a file whose

+

name is the key and content is the value. If specified, the listed keys

+

will be projected into the specified paths, and unlisted keys will not be

+

present. If a key is specified which is not present in the Secret, the volume

+

setup will error unless it is marked optional. Paths must be relative and

+

may not contain the '..' path or start with '..'.

+

name

+

String

+

Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names

+

optional

+

Boolean

+

optional field specify whether the Secret or its key must be

+

defined

+
+
+ +
+ + + + + + + + + + + + + + + + + + + + + +
Table 69 io.cci.otc.api.pkg.apis.versioned.cci.v2.SecretVolumeSource

Parameter

+

Type

+

Description

+

defaultMode

+

Integer

+

defaultMode is Optional: mode bits used to set permissions on created files by default. Must be an octal value between 0000 and 0777 or a decimal value between 0 and 511. YAML accepts both octal and decimal values, JSON requires decimal values for mode bits. Defaults to 0644. Directories within the path are not affected by this setting. This might be in conflict with other options that affect the file mode, like fsGroup, and the result can be other mode bits set.

+

items

+

Array of io.cci.otc.api.pkg.apis.versioned.cci.v2.KeyToPath objects

+

items If unspecified, each key-value pair in the Data field of

+

the referenced Secret will be projected into the volume as a file whose

+

name is the key and content is the value. If specified, the listed keys

+

will be projected into the specified paths, and unlisted keys will not be

+

present. If a key is specified which is not present in the Secret, the volume

+

setup will error unless it is marked optional. Paths must be relative and

+

may not contain the '..' path or start with '..'.

+

optional

+

Boolean

+

optional field specify whether the Secret or its keys must be

+

defined

+

secretName

+

String

+

secretName is the name of the secret in the pod's namespace to use. More info: https://kubernetes.io/docs/concepts/storage/volumes#secret

+
+
+ +
+ + + + + + + + + + + + + + + + + +
Table 70 io.cci.otc.api.pkg.apis.versioned.cci.v2.KeyToPath

Parameter

+

Type

+

Description

+

key

+

String

+

key is the key to project.

+

mode

+

Integer

+

mode is Optional: mode bits used to set permissions on this file. Must be an octal value between 0000 and 0777 or a decimal value between 0 and 511. YAML accepts both octal and decimal values, JSON requires decimal values for mode bits. If not specified, the volume defaultMode will be used. This might be in conflict with other options that affect the file mode, like fsGroup, and the result can be other mode bits set.

+

path

+

String

+

path is the relative path of the file to map the key to. May

+

not be an absolute path. May not contain the path element '..'. May not

+

start with the string '..'.

+
+
+ +
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Table 71 io.cci.otc.api.pkg.apis.versioned.cci.v2.PodStatus

Parameter

+

Type

+

Description

+

conditions

+

Array of io.cci.otc.api.pkg.apis.versioned.cci.v2.PodCondition objects

+

Current service state of pod. More info: https://kubernetes.io/docs/concepts/workloads/pods/pod-lifecycle#pod-conditions

+

containerStatuses

+

Array of io.cci.otc.api.pkg.apis.versioned.cci.v2.ContainerStatus objects

+

The list has one entry per container in the manifest. More info: https://kubernetes.io/docs/concepts/workloads/pods/pod-lifecycle#pod-and-container-status

+

ephemeralContainerStatuses

+

Array of io.cci.otc.api.pkg.apis.versioned.cci.v2.ContainerStatus objects

+

Status for any ephemeral containers that have run in this pod.

+

hostIP

+

String

+

IP address of the host to which the pod is assigned. Empty if

+

not yet scheduled.

+

initContainerStatuses

+

Array of io.cci.otc.api.pkg.apis.versioned.cci.v2.ContainerStatus objects

+

The list has one entry per init container in the manifest. The most recent successful init container will have ready = true, the most recently started container will have startTime set. More info: https://kubernetes.io/docs/concepts/workloads/pods/pod-lifecycle#pod-and-container-status

+

message

+

String

+

A human readable message indicating details about why the pod

+

is in this condition.

+

nominatedNodeName

+

String

+

nominatedNodeName is set only when this pod preempts other pods

+

on the node, but it cannot be scheduled right away as preemption victims

+

receive their graceful termination periods. This field does not guarantee

+

that the pod will be scheduled on this node. Scheduler may decide to place

+

the pod elsewhere if other nodes become available sooner. Scheduler may

+

also decide to give the resources on this node to a higher priority pod

+

that is created after preemption. As a result, this field may be different

+

than PodSpec.nodeName when the pod is scheduled.

+

phase

+

String

+

The phase of a Pod is a simple, high-level summary of where the Pod is in its lifecycle. The conditions array, the reason and message fields, and the individual container status arrays contain more detail about the pod's status. There are five possible phase values:

+

Pending: The pod has been accepted by the Kubernetes system, but one or more of the container images has not been created. This includes time before being scheduled as well as time spent downloading images over the network, which could take a while. Running: The pod has been bound to a node, and all of the containers have been created. At least one container is still running, or is in the process of starting or restarting. Succeeded: All containers in the pod have terminated in success, and will not be restarted. Failed: All containers in the pod have terminated, and at least one container has terminated in failure. The container either exited with non-zero status or was terminated by the system. Unknown: For some reason the state of the pod could not be obtained, typically due to an error in communicating with the host of the pod.

+

More info: https://kubernetes.io/docs/concepts/workloads/pods/pod-lifecycle#pod-phase

+

Possible enum values:

+
  • "Failed" means that all containers in the pod have terminated, and at least one container has terminated in a failure (exited with a non-zero exit code or was stopped by the system).
  • "Pending" means the pod has been accepted by the system, but one or more of the containers has not been started. This includes time before being bound to a node, as well as time spent pulling images onto the host.
  • "Running" means the pod has been bound to a node and all of the containers have been started. At least one container is still running or is in the process of being restarted.
  • "Succeeded" means that all containers in the pod have voluntarily terminated with a container exit code of 0, and the system is not going to restart any of these containers.
  • "Unknown" means that for some reason the state of the pod could not be obtained, typically due to an error in communicating with the host of the pod. Deprecated: It isn't being set since 2015 (74da3b14b0c0f658b3bb8d2def5094686d0e9095)
+

podIP

+

String

+

IP address allocated to the pod. Routable at least within the

+

cluster. Empty if not yet allocated.

+

podIPs

+

Array of io.cci.otc.api.pkg.apis.versioned.cci.v2.PodIP objects

+

podIPs holds the IP addresses allocated to the pod. If this field

+

is specified, the 0th entry must match the podIP field. Pods may be allocated

+

at most 1 value for each of IPv4 and IPv6. This list is empty if no IPs

+

have been allocated yet.

+

qosClass

+

String

+

The Quality of Service (QOS) classification assigned to the pod based on resource requirements See PodQOSClass type for available QOS classes More info: https://git.k8s.io/community/contributors/design-proposals/node/resource-qos.md

+

Possible enum values:

+
  • "BestEffort" is the BestEffort qos class.
  • "Burstable" is the Burstable qos class.
  • "Guaranteed" is the Guaranteed qos class.
+

reason

+

String

+

A brief CamelCase message indicating details about why the pod

+

is in this state. e.g. 'Evicted'

+

startTime

+

String

+

RFC 3339 date and time at which the object was acknowledged by

+

the Kubelet. This is before the Kubelet pulled the container image(s) for

+

the pod.

+
+
+ +
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Table 72 io.cci.otc.api.pkg.apis.versioned.cci.v2.PodCondition

Parameter

+

Type

+

Description

+

lastProbeTime

+

String

+

Last time we probed the condition.

+

lastTransitionTime

+

String

+

Last time the condition transitioned from one status to another.

+

message

+

String

+

Human-readable message indicating details about last transition.

+

reason

+

String

+

Unique, one-word, CamelCase reason for the condition's last transition.

+

status

+

String

+

Status is the status of the condition. Can be True, False, Unknown. More info: https://kubernetes.io/docs/concepts/workloads/pods/pod-lifecycle#pod-conditions

+

type

+

String

+

Type is the type of the condition. More info: https://kubernetes.io/docs/concepts/workloads/pods/pod-lifecycle#pod-conditions

+
+
+ +
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Table 73 io.cci.otc.api.pkg.apis.versioned.cci.v2.ContainerStatus

Parameter

+

Type

+

Description

+

containerID

+

String

+

Container's ID in the format '[/topic/body/section/table/tgroup/tbody/row/entry/p/br {""}) (br]://<container_id>'.

+

image

+

String

+

The image the container is running. More info: https://kubernetes.io/docs/concepts/containers/images.

+

imageID

+

String

+

ImageID of the container's image.

+

lastState

+

io.cci.otc.api.pkg.apis.versioned.cci.v2.ContainerState object

+

Details about the container's last termination condition.

+

name

+

String

+

This must be a DNS_LABEL. Each container in a pod must have a

+

unique name. Cannot be updated.

+

ready

+

Boolean

+

Specifies whether the container has passed its readiness probe.

+

restartCount

+

Integer

+

The number of times the container has been restarted.

+

started

+

Boolean

+

Specifies whether the container has passed its startup probe.

+

Initialized as false, becomes true after startupProbe is considered successful.

+

Resets to false when the container is restarted, or if kubelet loses state

+

temporarily. Is always true when no startupProbe is defined.

+

state

+

io.cci.otc.api.pkg.apis.versioned.cci.v2.ContainerState object

+

Details about the container's current condition.

+
+
+ +
+ + + + + + + + + + + + + + + + + +
Table 74 io.cci.otc.api.pkg.apis.versioned.cci.v2.ContainerState

Parameter

+

Type

+

Description

+

running

+

io.cci.otc.api.pkg.apis.versioned.cci.v2.ContainerStateRunning object

+

Details about a running container

+

terminated

+

io.cci.otc.api.pkg.apis.versioned.cci.v2.ContainerStateTerminated object

+

Details about a terminated container

+

waiting

+

io.cci.otc.api.pkg.apis.versioned.cci.v2.ContainerStateWaiting object

+

Details about a waiting container

+
+
+ +
+ + + + + + + + + +
Table 75 io.cci.otc.api.pkg.apis.versioned.cci.v2.ContainerStateRunning

Parameter

+

Type

+

Description

+

startedAt

+

String

+

Time at which the container was last (re-)started

+
+
+ +
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Table 76 io.cci.otc.api.pkg.apis.versioned.cci.v2.ContainerStateTerminated

Parameter

+

Type

+

Description

+

containerID

+

String

+

Container's ID in the format '[/topic/body/section/table/tgroup/tbody/row/entry/p/br {""}) (br]://<container_id>'

+

exitCode

+

Integer

+

Exit status from the last termination of the container

+

finishedAt

+

String

+

Time at which the container last terminated

+

message

+

String

+

Message regarding the last termination of the container

+

reason

+

String

+

(brief) reason from the last termination of the container

+

signal

+

Integer

+

Signal from the last termination of the container

+

startedAt

+

String

+

Time at which previous execution of the container started

+
+
+ +
+ + + + + + + + + + + + + +
Table 77 io.cci.otc.api.pkg.apis.versioned.cci.v2.ContainerStateWaiting

Parameter

+

Type

+

Description

+

message

+

String

+

Message regarding why the container is not yet running.

+

reason

+

String

+

(brief) reason the container is not yet running.

+
+
+ +
+ + + + + + + + + +
Table 78 io.cci.otc.api.pkg.apis.versioned.cci.v2.PodIP

Parameter

+

Type

+

Description

+

ip

+

String

+

ip is an IP address (IPv4 or IPv6) assigned to the pod

+
+
+

Status code: 202

+ +
+ + + + + + + + + + + + + + + + + + + + + + + + + +
Table 79 Response body parameters

Parameter

+

Type

+

Description

+

apiVersion

+

String

+

APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#resources

+

kind

+

String

+

Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds

+

metadata

+

io.k8s.apimachinery.pkg.apis.meta.v1.ObjectMeta object

+

Standard object's metadata. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata

+

spec

+

io.cci.otc.api.pkg.apis.versioned.cci.v2.PodSpec object

+

Specification of the desired behavior of the pod. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#spec-and-status

+

status

+

io.cci.otc.api.pkg.apis.versioned.cci.v2.PodStatus object

+

Most recently observed status of the pod. This data may not be up to date. Populated by the system. Read-only. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#spec-and-status

+
+
+ +
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Table 80 io.cci.otc.api.pkg.apis.versioned.cci.v2.PodSpec

Parameter

+

Type

+

Description

+

activeDeadlineSeconds

+

Long

+

Optional duration in seconds the pod may be active on the node

+

relative to StartTime before the system will actively try to mark it failed

+

and kill associated containers. Value must be a positive integer.

+

affinity

+

io.cci.otc.api.pkg.apis.versioned.cci.v2.Affinity object

+

If specified, the pod's scheduling constraints

+

containers

+

Array of io.cci.otc.api.pkg.apis.versioned.cci.v2.Container objects

+

List of containers belonging to the pod. Containers cannot currently

+

be added or removed. There must be at least one container in a Pod. Cannot

+

be updated.

+

dnsConfig

+

io.cci.otc.api.pkg.apis.versioned.cci.v2.PodDNSConfig object

+

Specifies the DNS parameters of a pod. Parameters specified here

+

will be merged to the generated DNS configuration based on DNSPolicy.

+

dnsPolicy

+

String

+

Set DNS policy for the pod. Defaults to "ClusterFirst". Valid values are 'ClusterFirstWithHostNet', 'ClusterFirst', 'Default' or 'None'. DNS parameters given in DNSConfig will be merged with the policy selected with DNSPolicy. To have DNS options set along with hostNetwork, you have to specify DNS policy explicitly to 'ClusterFirstWithHostNet'.

+

Possible enum values:

+
  • "ClusterFirst" indicates that the pod should use cluster DNS first unless hostNetwork is true, if it is available, then fall back on the default (as determined by kubelet) DNS settings.
  • "ClusterFirstWithHostNet" indicates that the pod should use cluster DNS first, if it is available, then fall back on the default (as determined by kubelet) DNS settings.
  • "Default" indicates that the pod should use the default (as determined by kubelet) DNS settings.
  • "None" indicates that the pod should use empty DNS settings. DNS parameters such as nameservers and search paths should be defined via DNSConfig.
+

ephemeralContainers

+

Array of io.cci.otc.api.pkg.apis.versioned.cci.v2.EphemeralContainer objects

+

List of ephemeral containers run in this pod. Ephemeral containers

+

may be run in an existing pod to perform user-initiated actions such as

+

debugging. This list cannot be specified when creating a pod, and it cannot

+

be modified by updating the pod spec. In order to add an ephemeral container

+

to an existing pod, use the pod's ephemeralcontainers subresource.

+

hostAliases

+

Array of io.cci.otc.api.pkg.apis.versioned.cci.v2.HostAlias objects

+

HostAliases is an optional list of hosts and IPs that will be

+

injected into the pod's hosts file if specified. This is only valid for

+

non-hostNetwork pods.

+

hostname

+

String

+

Specifies the hostName of the Pod. If not specified, the pod's

+

hostname will be set to a system-defined value.

+

imagePullSecrets

+

Array of io.cci.otc.api.pkg.apis.versioned.cci.v2.LocalObjectReference objects

+

ImagePullSecrets is an optional list of references to secrets in the same namespace to use for pulling any of the images used by this PodSpec. If specified, these secrets will be passed to individual puller implementations for them to use. More info: https://kubernetes.io/docs/concepts/containers/images#specifying-imagepullsecrets-on-a-pod

+

initContainers

+

Array of io.cci.otc.api.pkg.apis.versioned.cci.v2.Container objects

+

List of initialization containers belonging to the pod. Init containers are executed in order prior to containers being started. If any init container fails, the pod is considered to have failed and is handled according to its restartPolicy. The name for an init container or normal container must be unique among all containers. Init containers may not have Lifecycle actions, Readiness probes, Liveness probes, or Startup probes. The resourceRequirements of an init container are taken into account during scheduling by finding the highest request/limit for each resource type, and then using the max of of that value or the sum of the normal containers. Limits are applied to init containers in a similar fashion. Init containers cannot currently be added or removed. Cannot be updated. More info: https://kubernetes.io/docs/concepts/workloads/pods/init-containers/

+

nodeName

+

String

+

NodeName is a request to schedule this pod onto a specific node.

+

If it is non-empty, the scheduler simply schedules this pod onto that node,

+

assuming that it fits resource requirements.

+

overhead

+

Map<String,String>

+

Overhead represents the resource overhead associated with running a pod for a given RuntimeClass. This field will be autopopulated at admission time by the RuntimeClass admission controller. If the RuntimeClass admission controller is enabled, overhead must not be set in Pod create requests. The RuntimeClass admission controller will reject Pod create requests which have the overhead already set. If RuntimeClass is configured and selected in the PodSpec, Overhead will be set to the value defined in the corresponding RuntimeClass, otherwise it will remain unset and treated as zero. More info: https://git.k8s.io/enhancements/keps/sig-node/688-pod-overhead/README.md

+

readinessGates

+

Array of io.cci.otc.api.pkg.apis.versioned.cci.v2.PodReadinessGate objects

+

If specified, all readiness gates will be evaluated for pod readiness. A pod is ready when all its containers are ready AND all conditions specified in the readiness gates have status equal to "True" More info: https://git.k8s.io/enhancements/keps/sig-network/580-pod-readiness-gates

+

restartPolicy

+

String

+

Restart policy for all containers within the pod. One of Always, OnFailure, Never. Default to Always. More info: https://kubernetes.io/docs/concepts/workloads/pods/pod-lifecycle/#restart-policy

+

Possible enum values:

+
  • "Always"
  • "Never"
  • "OnFailure"
+

schedulerName

+

String

+

If specified, the pod will be dispatched by specified scheduler.

+

If not specified, the pod will be dispatched by default scheduler.

+

securityContext

+

io.cci.otc.api.pkg.apis.versioned.cci.v2.PodSecurityContext object

+

SecurityContext holds pod-level security attributes and common container settings. Optional: Defaults to empty. See type description for default values of each field.

+

setHostnameAsFQDN

+

Boolean

+

If true the pod's hostname will be configured as the pod's FQDN,

+

rather than the leaf name (the default). In Linux containers, this means

+

setting the FQDN in the hostname field of the kernel (the nodename field

+

of struct utsname). In Windows containers, this means setting the registry

+

value of hostname for the registry key HKEY_LOCAL_MACHINE\SYSTEM\CurrentControlSet\Services\Tcpip\Parameters

+

to FQDN. If a pod does not have FQDN, this has no effect. Default to false.

+

shareProcessNamespace

+

Boolean

+

Share a single process namespace between all of the containers in a pod. When this is set containers will be able to view and signal processes from other containers in the same pod, and the first process in each container will not be assigned PID 1. HostPID and ShareProcessNamespace cannot both be set. Optional: Default to false.

+

terminationGracePeriodSeconds

+

Long

+

Optional duration in seconds the pod needs to terminate gracefully.

+

May be decreased in delete request. Value must be non-negative integer.

+

The value zero indicates stop immediately via the kill signal (no opportunity

+

to shut down). If this value is nil, the default grace period will be used

+

instead. The grace period is the duration in seconds after the processes

+

running in the pod are sent a termination signal and the time when the processes

+

are forcibly halted with a kill signal. Set this value longer than the expected

+

cleanup time for your process. Defaults to 30 seconds.

+

topologySpreadConstraints

+

Array of io.cci.otc.api.pkg.apis.versioned.cci.v2.TopologySpreadConstraint objects

+

TopologySpreadConstraints describes how a group of pods ought

+

to spread across topology domains. Scheduler will schedule pods in a way

+

which abides by the constraints. All topologySpreadConstraints are ANDed.

+

volumes

+

Array of io.cci.otc.api.pkg.apis.versioned.cci.v2.Volume objects

+

List of volumes that can be mounted by containers belonging to the pod. More info: https://kubernetes.io/docs/concepts/storage/volumes

+
+
+ +
+ + + + + + + + + + + + + +
Table 81 io.cci.otc.api.pkg.apis.versioned.cci.v2.Affinity

Parameter

+

Type

+

Description

+

nodeAffinity

+

io.cci.otc.api.pkg.apis.versioned.cci.v2.NodeAffinity object

+

Describes node affinity scheduling rules for the pod.

+

podAntiAffinity

+

io.cci.otc.api.pkg.apis.versioned.cci.v2.PodAntiAffinity object

+

Describes pod anti-affinity scheduling rules (e.g. avoid putting

+

this pod in the same zone, etc. as some other pod(s)).

+
+
+ +
+ + + + + + + + + +
Table 82 io.cci.otc.api.pkg.apis.versioned.cci.v2.NodeAffinity

Parameter

+

Type

+

Description

+

requiredDuringSchedulingIgnoredDuringExecution

+

io.cci.otc.api.pkg.apis.versioned.cci.v2.NodeSelector object

+

If the affinity requirements specified by this field are not

+

met at scheduling time, the pod will not be scheduled onto the node. If

+

the affinity requirements specified by this field cease to be met at some

+

point during pod execution (e.g. due to an update), the system may or may

+

not try to eventually evict the pod from its node.

+
+
+ +
+ + + + + + + + + +
Table 83 io.cci.otc.api.pkg.apis.versioned.cci.v2.NodeSelector

Parameter

+

Type

+

Description

+

nodeSelectorTerms

+

Array of io.cci.otc.api.pkg.apis.versioned.cci.v2.NodeSelectorTerm objects

+

Required. A list of node selector terms. The terms are ORed.

+
+
+ +
+ + + + + + + + + +
Table 84 io.cci.otc.api.pkg.apis.versioned.cci.v2.NodeSelectorTerm

Parameter

+

Type

+

Description

+

matchExpressions

+

Array of io.cci.otc.api.pkg.apis.versioned.cci.v2.NodeSelectorRequirement objects

+

A list of node selector requirements by node's labels.

+
+
+ +
+ + + + + + + + + + + + + + + + + +
Table 85 io.cci.otc.api.pkg.apis.versioned.cci.v2.NodeSelectorRequirement

Parameter

+

Type

+

Description

+

key

+

String

+

The label key that the selector applies to.

+

operator

+

String

+

Represents a key's relationship to a set of values. Valid operators are In, NotIn, Exists, DoesNotExist. Gt, and Lt.

+

Possible enum values:

+
  • "DoesNotExist"
  • "Exists"
  • "Gt"
  • "In"
  • "Lt"
  • "NotIn"
+

values

+

Array of strings

+

An array of string values. If the operator is In or NotIn, the

+

values array must be non-empty. If the operator is Exists or DoesNotExist,

+

the values array must be empty. If the operator is Gt or Lt, the values

+

array must have a single element, which will be interpreted as an integer.

+

This array is replaced during a strategic merge patch.

+
+
+ +
+ + + + + + + + + + + + + +
Table 86 io.cci.otc.api.pkg.apis.versioned.cci.v2.PodAntiAffinity

Parameter

+

Type

+

Description

+

preferredDuringSchedulingIgnoredDuringExecution

+

Array of io.cci.otc.api.pkg.apis.versioned.cci.v2.WeightedPodAffinityTerm objects

+

The scheduler will prefer to schedule pods to nodes that satisfy

+

the anti-affinity expressions specified by this field, but it may choose

+

a node that violates one or more of the expressions. The node that is most

+

preferred is the one with the greatest sum of weights, i.e. for each node

+

that meets all of the scheduling requirements (resource request, requiredDuringScheduling

+

anti-affinity expressions, etc.), compute a sum by iterating through the

+

elements of this field and adding "weight" to the sum if the node has pods

+

which matches the corresponding podAffinityTerm; the node(s) with the highest

+

sum are the most preferred.

+

requiredDuringSchedulingIgnoredDuringExecution

+

Array of io.cci.otc.api.pkg.apis.versioned.cci.v2.PodAffinityTerm objects

+

If the anti-affinity requirements specified by this field are

+

not met at scheduling time, the pod will not be scheduled onto the node.

+

If the anti-affinity requirements specified by this field cease to be met

+

at some point during pod execution (e.g. due to a pod label update), the

+

system may or may not try to eventually evict the pod from its node. When

+

there are multiple elements, the lists of nodes corresponding to each podAffinityTerm

+

are intersected, i.e. all terms must be satisfied.

+
+
+ +
+ + + + + + + + + + + + + +
Table 87 io.cci.otc.api.pkg.apis.versioned.cci.v2.WeightedPodAffinityTerm

Parameter

+

Type

+

Description

+

podAffinityTerm

+

io.cci.otc.api.pkg.apis.versioned.cci.v2.PodAffinityTerm object

+

Required. A pod affinity term, associated with the corresponding

+

weight.

+

weight

+

Integer

+

weight associated with matching the corresponding podAffinityTerm,

+

in the range 1-100.

+
+
+ +
+ + + + + + + + + + + + + + + + + +
Table 88 io.cci.otc.api.pkg.apis.versioned.cci.v2.PodAffinityTerm

Parameter

+

Type

+

Description

+

labelSelector

+

io.k8s.apimachinery.pkg.apis.meta.v1.LabelSelector object

+

A label query over a set of resources, in this case pods.

+

namespaces

+

Array of strings

+

namespaces specifies a static list of namespace names that the

+

term applies to. The term is applied to the union of the namespaces listed

+

in this field and the ones selected by namespaceSelector. null or empty

+

namespaces list and null namespaceSelector means "this pod's namespace".

+

topologyKey

+

String

+

This pod should be co-located (affinity) or not co-located (anti-affinity)

+

with the pods matching the labelSelector in the specified namespaces, where

+

co-located is defined as running on a node whose value of the label with

+

key topologyKey matches that of any node on which any of the selected pods

+

is running. Empty topologyKey is not allowed.

+
+
+ +
+ + + + + + + + + + + + + + + + + +
Table 89 io.cci.otc.api.pkg.apis.versioned.cci.v2.PodDNSConfig

Parameter

+

Type

+

Description

+

nameservers

+

Array of strings

+

A list of DNS name server IP addresses. This will be appended

+

to the base nameservers generated from DNSPolicy. Duplicated nameservers

+

will be removed.

+

options

+

Array of io.cci.otc.api.pkg.apis.versioned.cci.v2.PodDNSConfigOption objects

+

A list of DNS resolver options. This will be merged with the

+

base options generated from DNSPolicy. Duplicated entries will be removed.

+

Resolution options given in Options will override those that appear in the

+

base DNSPolicy.

+

searches

+

Array of strings

+

A list of DNS search domains for host-name lookup. This will

+

be appended to the base search paths generated from DNSPolicy. Duplicated

+

search paths will be removed.

+
+
+ +
+ + + + + + + + + + + + + +
Table 90 io.cci.otc.api.pkg.apis.versioned.cci.v2.PodDNSConfigOption

Parameter

+

Type

+

Description

+

name

+

String

+

Required.

+

value

+

String

+		  
+
+ +
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Table 91 io.cci.otc.api.pkg.apis.versioned.cci.v2.EphemeralContainer

Parameter

+

Type

+

Description

+

args

+

Array of strings

+

Arguments to the entrypoint. The image's CMD is used if this is not provided. Variable references $(VAR_NAME) are expanded using the container's environment. If a variable cannot be resolved, the reference in the input string will be unchanged. Double $$ are reduced to a single $, which allows for escaping the $(VAR_NAME) syntax: i.e. "$$(VAR_NAME)" will produce the string literal "$(VAR_NAME)". Escaped references will never be expanded, regardless of whether the variable exists or not. Cannot be updated. More info: https://kubernetes.io/docs/tasks/inject-data-application/define-command-argument-container/#running-a-command-in-a-shell

+

command

+

Array of strings

+

Entrypoint array. Not executed within a shell. The image's ENTRYPOINT is used if this is not provided. Variable references $(VAR_NAME) are expanded using the container's environment. If a variable cannot be resolved, the reference in the input string will be unchanged. Double $$ are reduced to a single $, which allows for escaping the $(VAR_NAME) syntax: i.e. "$$(VAR_NAME)" will produce the string literal "$(VAR_NAME)". Escaped references will never be expanded, regardless of whether the variable exists or not. Cannot be updated. More info: https://kubernetes.io/docs/tasks/inject-data-application/define-command-argument-container/#running-a-command-in-a-shell

+

env

+

Array of io.cci.otc.api.pkg.apis.versioned.cci.v2.EnvVar objects

+

List of environment variables to set in the container. Cannot

+

be updated.

+

envFrom

+

Array of io.cci.otc.api.pkg.apis.versioned.cci.v2.EnvFromSource objects

+

List of sources to populate environment variables in the container.

+

The keys defined within a source must be a C_IDENTIFIER. All invalid keys

+

will be reported as an event when the container is starting. When a key

+

exists in multiple sources, the value associated with the last source will

+

take precedence. Values defined by an Env with a duplicate key will take

+

precedence. Cannot be updated.

+

image

+

String

+

Container image name. More info: https://kubernetes.io/docs/concepts/containers/images

+

lifecycle

+

io.cci.otc.api.pkg.apis.versioned.cci.v2.Lifecycle object

+

Lifecycle is not allowed for ephemeral containers.

+

livenessProbe

+

io.cci.otc.api.pkg.apis.versioned.cci.v2.Probe object

+

Probes are not allowed for ephemeral containers.

+

name

+

String

+

Name of the ephemeral container specified as a DNS_LABEL. This

+

name must be unique among all containers, init containers and ephemeral

+

containers.

+

ports

+

Array of io.cci.otc.api.pkg.apis.versioned.cci.v2.ContainerPort objects

+

Ports are not allowed for ephemeral containers.

+

readinessProbe

+

io.cci.otc.api.pkg.apis.versioned.cci.v2.Probe object

+

Probes are not allowed for ephemeral containers.

+

resources

+

io.cci.otc.api.pkg.apis.versioned.cci.v2.ResourceRequirements object

+

Resources are not allowed for ephemeral containers. Ephemeral

+

containers use spare resources already allocated to the pod.

+

securityContext

+

io.cci.otc.api.pkg.apis.versioned.cci.v2.SecurityContext object

+

Optional: SecurityContext defines the security options the ephemeral container should be run with. If set, the fields of SecurityContext override the equivalent fields of PodSecurityContext.

+

startupProbe

+

io.cci.otc.api.pkg.apis.versioned.cci.v2.Probe object

+

Probes are not allowed for ephemeral containers.

+

stdin

+

Boolean

+

Whether this container should allocate a buffer for stdin in

+

the container runtime. If this is not set, reads from stdin in the container

+

will always result in EOF. Default is false.

+

stdinOnce

+

Boolean

+

Whether the container runtime should close the stdin channel

+

after it has been opened by a single attach. When stdin is true the stdin

+

stream will remain open across multiple attach sessions. If stdinOnce is

+

set to true, stdin is opened on container start, is empty until the first

+

client attaches to stdin, and then remains open and accepts data until the

+

client disconnects, at which time stdin is closed and remains closed until

+

the container is restarted. If this flag is false, a container processes

+

that reads from stdin will never receive an EOF. Default is false

+

targetContainerName

+

String

+

If set, the name of the container from PodSpec that this ephemeral container targets. The ephemeral container will be run in the namespaces (IPC, PID, etc) of this container. If not set then the ephemeral container uses the namespaces configured in the Pod spec.

+

The container runtime must implement support for this feature. If the runtime does not support namespace targeting then the result of setting this field is undefined.

+

terminationMessagePath

+

String

+

Optional: Path at which the file to which the container's termination message will be written is mounted into the container's filesystem. Message written is intended to be brief final status, such as an assertion failure message. Will be truncated by the node if greater than 4096 bytes. The total message length across all containers will be limited to 12kb. Defaults to /dev/termination-log. Cannot be updated.

+

terminationMessagePolicy

+

String

+

Indicate how the termination message should be populated. File will use the contents of terminationMessagePath to populate the container status message on both success and failure. FallbackToLogsOnError will use the last chunk of container log output if the termination message file is empty and the container exited with an error. The log output is limited to 2048 bytes or 80 lines, whichever is smaller. Defaults to File. Cannot be updated.

+

Possible enum values:

+
  • "FallbackToLogsOnError" will read the most recent contents of the container logs for the container status message when the container exits with an error and the terminationMessagePath has no contents.
  • "File" is the default behavior and will set the container status message to the contents of the container's terminationMessagePath when the container exits.
+

tty

+

Boolean

+

Whether this container should allocate a TTY for itself, also

+

requires 'stdin' to be true. Default is false.

+

volumeMounts

+

Array of io.cci.otc.api.pkg.apis.versioned.cci.v2.VolumeMount objects

+

Pod volumes to mount into the container's filesystem. Subpath

+

mounts are not allowed for ephemeral containers. Cannot be updated.

+

workingDir

+

String

+

Container's working directory. If not specified, the container

+

runtime's default will be used, which might be configured in the container

+

image. Cannot be updated.

+
+
+ +
+ + + + + + + + + + + + + +
Table 92 io.cci.otc.api.pkg.apis.versioned.cci.v2.HostAlias

Parameter

+

Type

+

Description

+

hostnames

+

Array of strings

+

Hostnames for the above IP address.

+

ip

+

String

+

IP address of the host file entry.

+
+
+ +
+ + + + + + + + + +
Table 93 io.cci.otc.api.pkg.apis.versioned.cci.v2.LocalObjectReference

Parameter

+

Type

+

Description

+

name

+

String

+

Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names

+
+
+ +
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Table 94 io.cci.otc.api.pkg.apis.versioned.cci.v2.Container

Parameter

+

Type

+

Description

+

args

+

Array of strings

+

Arguments to the entrypoint. The container image's CMD is used if this is not provided. Variable references $(VAR_NAME) are expanded using the container's environment. If a variable cannot be resolved, the reference in the input string will be unchanged. Double $$ are reduced to a single $, which allows for escaping the $(VAR_NAME) syntax: i.e. "$$(VAR_NAME)" will produce the string literal "$(VAR_NAME)". Escaped references will never be expanded, regardless of whether the variable exists or not. Cannot be updated. More info: https://kubernetes.io/docs/tasks/inject-data-application/define-command-argument-container/#running-a-command-in-a-shell

+

command

+

Array of strings

+

Entrypoint array. Not executed within a shell. The container image's ENTRYPOINT is used if this is not provided. Variable references $(VAR_NAME) are expanded using the container's environment. If a variable cannot be resolved, the reference in the input string will be unchanged. Double $$ are reduced to a single $, which allows for escaping the $(VAR_NAME) syntax: i.e. "$$(VAR_NAME)" will produce the string literal "$(VAR_NAME)". Escaped references will never be expanded, regardless of whether the variable exists or not. Cannot be updated. More info: https://kubernetes.io/docs/tasks/inject-data-application/define-command-argument-container/#running-a-command-in-a-shell

+

env

+

Array of io.cci.otc.api.pkg.apis.versioned.cci.v2.EnvVar objects

+

List of environment variables to set in the container. Cannot

+

be updated.

+

envFrom

+

Array of io.cci.otc.api.pkg.apis.versioned.cci.v2.EnvFromSource objects

+

List of sources to populate environment variables in the container.

+

The keys defined within a source must be a C_IDENTIFIER. All invalid keys

+

will be reported as an event when the container is starting. When a key

+

exists in multiple sources, the value associated with the last source will

+

take precedence. Values defined by an Env with a duplicate key will take

+

precedence. Cannot be updated.

+

image

+

String

+

Container image name. More info: https://kubernetes.io/docs/concepts/containers/images This field is optional to allow higher level config management to default or override container images in workload controllers like Deployments and StatefulSets.

+

lifecycle

+

io.cci.otc.api.pkg.apis.versioned.cci.v2.Lifecycle object

+

Actions that the management system should take in response to

+

container lifecycle events. Cannot be updated.

+

livenessProbe

+

io.cci.otc.api.pkg.apis.versioned.cci.v2.Probe object

+

Periodic probe of container liveness. Container will be restarted if the probe fails. Cannot be updated. More info: https://kubernetes.io/docs/concepts/workloads/pods/pod-lifecycle#container-probes

+

name

+

String

+

Name of the container specified as a DNS_LABEL. Each container

+

in a pod must have a unique name (DNS_LABEL). Cannot be updated.

+

ports

+

Array of io.cci.otc.api.pkg.apis.versioned.cci.v2.ContainerPort objects

+

List of ports to expose from the container. Not specifying a

+

port here DOES NOT prevent that port from being exposed. Any port which

+

is listening on the default "0.0.0.0" address inside a container will be

+

accessible from the network. Modifying this array with strategic merge patch

+

may corrupt the data. For more information See https://github.com/kubernetes/kubernetes/issues/108255.

+

Cannot be updated.

+

readinessProbe

+

io.cci.otc.api.pkg.apis.versioned.cci.v2.Probe object

+

Periodic probe of container service readiness. Container will be removed from service endpoints if the probe fails. Cannot be updated. More info: https://kubernetes.io/docs/concepts/workloads/pods/pod-lifecycle#container-probes

+

resources

+

io.cci.otc.api.pkg.apis.versioned.cci.v2.ResourceRequirements object

+

Compute Resources required by this container. Cannot be updated. More info: https://kubernetes.io/docs/concepts/configuration/manage-resources-containers/

+

securityContext

+

io.cci.otc.api.pkg.apis.versioned.cci.v2.SecurityContext object

+

SecurityContext defines the security options the container should be run with. If set, the fields of SecurityContext override the equivalent fields of PodSecurityContext. More info: https://kubernetes.io/docs/tasks/configure-pod-container/security-context/

+

startupProbe

+

io.cci.otc.api.pkg.apis.versioned.cci.v2.Probe object

+

StartupProbe indicates that the Pod has successfully initialized. If specified, no other probes are executed until this completes successfully. If this probe fails, the Pod will be restarted, just as if the livenessProbe failed. This can be used to provide different probe parameters at the beginning of a Pod's lifecycle, when it might take a long time to load data or warm a cache, than during steady-state operation. This cannot be updated. More info: https://kubernetes.io/docs/concepts/workloads/pods/pod-lifecycle#container-probes

+

stdin

+

Boolean

+

Whether this container should allocate a buffer for stdin in

+

the container runtime. If this is not set, reads from stdin in the container

+

will always result in EOF. Default is false.

+

stdinOnce

+

Boolean

+

Whether the container runtime should close the stdin channel

+

after it has been opened by a single attach. When stdin is true the stdin

+

stream will remain open across multiple attach sessions. If stdinOnce is

+

set to true, stdin is opened on container start, is empty until the first

+

client attaches to stdin, and then remains open and accepts data until the

+

client disconnects, at which time stdin is closed and remains closed until

+

the container is restarted. If this flag is false, a container processes

+

that reads from stdin will never receive an EOF. Default is false

+

terminationMessagePath

+

String

+

Optional: Path at which the file to which the container's termination message will be written is mounted into the container's filesystem. Message written is intended to be brief final status, such as an assertion failure message. Will be truncated by the node if greater than 4096 bytes. The total message length across all containers will be limited to 12kb. Defaults to /dev/termination-log. Cannot be updated.

+

terminationMessagePolicy

+

String

+

Indicate how the termination message should be populated. File will use the contents of terminationMessagePath to populate the container status message on both success and failure. FallbackToLogsOnError will use the last chunk of container log output if the termination message file is empty and the container exited with an error. The log output is limited to 2048 bytes or 80 lines, whichever is smaller. Defaults to File. Cannot be updated.

+

Possible enum values:

+
  • "FallbackToLogsOnError" will read the most recent contents of the container logs for the container status message when the container exits with an error and the terminationMessagePath has no contents.
  • "File" is the default behavior and will set the container status message to the contents of the container's terminationMessagePath when the container exits.
+

tty

+

Boolean

+

Whether this container should allocate a TTY for itself, also

+

requires 'stdin' to be true. Default is false.

+

volumeMounts

+

Array of io.cci.otc.api.pkg.apis.versioned.cci.v2.VolumeMount objects

+

Pod volumes to mount into the container's filesystem. Cannot

+

be updated.

+

workingDir

+

String

+

Container's working directory. If not specified, the container

+

runtime's default will be used, which might be configured in the container

+

image. Cannot be updated.

+
+
+ +
+ + + + + + + + + + + + + + + + + +
Table 95 io.cci.otc.api.pkg.apis.versioned.cci.v2.EnvVar

Parameter

+

Type

+

Description

+

name

+

String

+

Name of the environment variable. Must be a C_IDENTIFIER.

+

value

+

String

+

Variable references $(VAR_NAME) are expanded using the previously defined environment variables in the container and any service environment variables. If a variable cannot be resolved, the reference in the input string will be unchanged. Double $$ are reduced to a single $, which allows for escaping the $(VAR_NAME) syntax: i.e. "$$(VAR_NAME)" will produce the string literal "$(VAR_NAME)". Escaped references will never be expanded, regardless of whether the variable exists or not. Defaults to "".

+

valueFrom

+

io.cci.otc.api.pkg.apis.versioned.cci.v2.EnvVarSource object

+

Source for the environment variable's value. Cannot be used if

+

value is not empty.

+
+
+ +
+ + + + + + + + + + + + + + + + + + + + + +
Table 96 io.cci.otc.api.pkg.apis.versioned.cci.v2.EnvVarSource

Parameter

+

Type

+

Description

+

configMapKeyRef

+

io.cci.otc.api.pkg.apis.versioned.cci.v2.ConfigMapKeySelector object

+

Selects a key of a ConfigMap.

+

fieldRef

+

io.cci.otc.api.pkg.apis.versioned.cci.v2.ObjectFieldSelector object

+

Selects a field of the pod: supports metadata.name, metadata.namespace, metadata.labels['<KEY>'], metadata.annotations['<KEY>'], spec.nodeName, spec.serviceAccountName, status.hostIP, status.podIP, status.podIPs.

+

resourceFieldRef

+

io.cci.otc.api.pkg.apis.versioned.cci.v2.ResourceFieldSelector object

+

Selects a resource of the container: only resources limits and requests (limits.cpu, limits.memory, limits.ephemeral-storage, requests.cpu, requests.memory and requests.ephemeral-storage) are currently supported.

+

secretKeyRef

+

io.cci.otc.api.pkg.apis.versioned.cci.v2.SecretKeySelector object

+

Selects a key of a secret in the pod's namespace

+
+
+ +
+ + + + + + + + + + + + + + + + + +
Table 97 io.cci.otc.api.pkg.apis.versioned.cci.v2.ConfigMapKeySelector

Parameter

+

Type

+

Description

+

key

+

String

+

The key to select.

+

name

+

String

+

Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names

+

optional

+

Boolean

+

Specify whether the ConfigMap or its key must be defined

+
+
+ +
+ + + + + + + + + + + + + + + + + +
Table 98 io.cci.otc.api.pkg.apis.versioned.cci.v2.SecretKeySelector

Parameter

+

Type

+

Description

+

key

+

String

+

The key of the secret to select from. Must be a valid secret

+

key.

+

name

+

String

+

Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names

+

optional

+

Boolean

+

Specify whether the Secret or its key must be defined

+
+
+ +
+ + + + + + + + + + + + + + + + + +
Table 99 io.cci.otc.api.pkg.apis.versioned.cci.v2.EnvFromSource

Parameter

+

Type

+

Description

+

configMapRef

+

io.cci.otc.api.pkg.apis.versioned.cci.v2.ConfigMapEnvSource object

+

The ConfigMap to select from

+

prefix

+

String

+

An optional identifier to prepend to each key in the ConfigMap.

+

Must be a C_IDENTIFIER.

+

secretRef

+

io.cci.otc.api.pkg.apis.versioned.cci.v2.SecretEnvSource object

+

The Secret to select from

+
+
+ +
+ + + + + + + + + + + + + +
Table 100 io.cci.otc.api.pkg.apis.versioned.cci.v2.ConfigMapEnvSource

Parameter

+

Type

+

Description

+

name

+

String

+

Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names

+

optional

+

Boolean

+

Specify whether the ConfigMap must be defined

+
+
+ +
+ + + + + + + + + + + + + +
Table 101 io.cci.otc.api.pkg.apis.versioned.cci.v2.SecretEnvSource

Parameter

+

Type

+

Description

+

name

+

String

+

Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names

+

optional

+

Boolean

+

Specify whether the Secret must be defined

+
+
+ +
+ + + + + + + + + + + + + +
Table 102 io.cci.otc.api.pkg.apis.versioned.cci.v2.Lifecycle

Parameter

+

Type

+

Description

+

postStart

+

io.cci.otc.api.pkg.apis.versioned.cci.v2.LifecycleHandler object

+

PostStart is called immediately after a container is created. If the handler fails, the container is terminated and restarted according to its restart policy. Other management of the container blocks until the hook completes. More info: https://kubernetes.io/docs/concepts/containers/container-lifecycle-hooks/#container-hooks

+

preStop

+

io.cci.otc.api.pkg.apis.versioned.cci.v2.LifecycleHandler object

+

PreStop is called immediately before a container is terminated due to an API request or management event such as liveness/startup probe failure, preemption, resource contention, etc. The handler is not called if the container crashes or exits. The Pod's termination grace period countdown begins before the PreStop hook is executed. Regardless of the outcome of the handler, the container will eventually terminate within the Pod's termination grace period (unless delayed by finalizers). Other management of the container blocks until the hook completes or until the termination grace period is reached. More info: https://kubernetes.io/docs/concepts/containers/container-lifecycle-hooks/#container-hooks

+
+
+ +
+ + + + + + + + + + + + + +
Table 103 io.cci.otc.api.pkg.apis.versioned.cci.v2.LifecycleHandler

Parameter

+

Type

+

Description

+

exec

+

io.cci.otc.api.pkg.apis.versioned.cci.v2.ExecAction object

+

Exec specifies the action to take.

+

httpGet

+

io.cci.otc.api.pkg.apis.versioned.cci.v2.HTTPGetAction object

+

HTTPGet specifies the http request to perform.

+
+
+ +
+ + + + + + + + + + + + + + + + + +
Table 104 io.cci.otc.api.pkg.apis.versioned.cci.v2.ContainerPort

Parameter

+

Type

+

Description

+

containerPort

+

Integer

+

Number of port to expose on the pod's IP address. This must be

+

a valid port number, 0 < x < 65536.

+

name

+

String

+

If specified, this must be an IANA_SVC_NAME and unique within

+

the pod. Each named port in a pod must have a unique name. Name for the

+

port that can be referred to by services.

+

protocol

+

String

+

Protocol for port. Must be UDP, TCP, or SCTP. Defaults to "TCP".

+

Possible enum values:

+
  • "SCTP" is the SCTP protocol.
  • "TCP" is the TCP protocol.
  • "UDP" is the UDP protocol.
+
+
+ +
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Table 105 io.cci.otc.api.pkg.apis.versioned.cci.v2.SecurityContext

Parameter

+

Type

+

Description

+

capabilities

+

io.cci.otc.api.pkg.apis.versioned.cci.v2.Capabilities object

+

The capabilities to add/drop when running containers. Defaults

+

to the default set of capabilities granted by the container runtime. Note

+

that this field cannot be set when spec.os.name is windows.

+

procMount

+

String

+

procMount denotes the type of proc mount to use for the containers.

+

The default is DefaultProcMount which uses the container runtime defaults

+

for readonly paths and masked paths. This requires the ProcMountType feature

+

flag to be enabled. Note that this field cannot be set when spec.os.name

+

is windows.

+

readOnlyRootFilesystem

+

Boolean

+

Whether this container has a read-only root filesystem. Default

+

is false. Note that this field cannot be set when spec.os.name is windows.

+

runAsGroup

+

Long

+

The GID to run the entrypoint of the container process. Uses

+

runtime default if unset. May also be set in PodSecurityContext. If set

+

in both SecurityContext and PodSecurityContext, the value specified in SecurityContext

+

takes precedence. Note that this field cannot be set when spec.os.name is

+

windows.

+

runAsNonRoot

+

Boolean

+

Indicates that the container must run as a non-root user. If

+

true, the Kubelet will validate the image at runtime to ensure that it does

+

not run as UID 0 (root) and fail to start the container if it does. If unset

+

or false, no such validation will be performed. May also be set in PodSecurityContext. If

+

set in both SecurityContext and PodSecurityContext, the value specified

+

in SecurityContext takes precedence.

+

runAsUser

+

Long

+

The UID to run the entrypoint of the container process. Defaults

+

to user specified in image metadata if unspecified. May also be set in PodSecurityContext. If

+

set in both SecurityContext and PodSecurityContext, the value specified

+

in SecurityContext takes precedence. Note that this field cannot be set

+

when spec.os.name is windows.

+
+
+ +
+ + + + + + + + + + + + + +
Table 106 io.cci.otc.api.pkg.apis.versioned.cci.v2.Capabilities

Parameter

+

Type

+

Description

+

add

+

Array of strings

+

Added capabilities

+

drop

+

Array of strings

+

Removed capabilities

+
+
+ +
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Table 107 io.cci.otc.api.pkg.apis.versioned.cci.v2.Probe

Parameter

+

Type

+

Description

+

exec

+

io.cci.otc.api.pkg.apis.versioned.cci.v2.ExecAction object

+

Exec specifies the action to take.

+

failureThreshold

+

Integer

+

Minimum consecutive failures for the probe to be considered failed

+

after having succeeded. Defaults to 3. Minimum value is 1.

+

httpGet

+

io.cci.otc.api.pkg.apis.versioned.cci.v2.HTTPGetAction object

+

HTTPGet specifies the http request to perform.

+

initialDelaySeconds

+

Integer

+

Number of seconds after the container has started before liveness probes are initiated. More info: https://kubernetes.io/docs/concepts/workloads/pods/pod-lifecycle#container-probes

+

periodSeconds

+

Integer

+

How often (in seconds) to perform the probe. Default to 10 seconds.

+

Minimum value is 1.

+

successThreshold

+

Integer

+

Minimum consecutive successes for the probe to be considered

+

successful after having failed. Defaults to 1. Must be 1 for liveness and

+

startup. Minimum value is 1.

+

tcpSocket

+

io.cci.otc.api.pkg.apis.versioned.cci.v2.TCPSocketAction object

+

TCPSocket specifies an action involving a TCP port.

+

terminationGracePeriodSeconds

+

Long

+

Optional duration in seconds the pod needs to terminate gracefully

+

upon probe failure. The grace period is the duration in seconds after the

+

processes running in the pod are sent a termination signal and the time

+

when the processes are forcibly halted with a kill signal. Set this value

+

longer than the expected cleanup time for your process. If this value is

+

nil, the pod's terminationGracePeriodSeconds will be used. Otherwise, this

+

value overrides the value provided by the pod spec. Value must be non-negative

+

integer. The value zero indicates stop immediately via the kill signal (no

+

opportunity to shut down). This is a beta field and requires enabling ProbeTerminationGracePeriod

+

feature gate. Minimum value is 1. spec.terminationGracePeriodSeconds is

+

used if unset.

+

timeoutSeconds

+

Integer

+

Number of seconds after which the probe times out. Defaults to 1 second. Minimum value is 1. More info: https://kubernetes.io/docs/concepts/workloads/pods/pod-lifecycle#container-probes

+
+
+ +
+ + + + + + + + + +
Table 108 io.cci.otc.api.pkg.apis.versioned.cci.v2.ExecAction

Parameter

+

Type

+

Description

+

command

+

Array of strings

+

Command is the command line to execute inside the container,

+

the working directory for the command is root ('/') in the container's

+

filesystem. The command is simply exec'd, it is not run inside a shell,

+

so traditional shell instructions ('|', etc) won't work. To use a shell,

+

you need to explicitly call out to that shell. Exit status of 0 is treated

+

as live/healthy and non-zero is unhealthy.

+
+
+ +
+ + + + + + + + + + + + + + + + + + + + + + + + + +
Table 109 io.cci.otc.api.pkg.apis.versioned.cci.v2.HTTPGetAction

Parameter

+

Type

+

Description

+

host

+

String

+

Host name to connect to, defaults to the pod IP. You probably

+

want to set "Host" in httpHeaders instead.

+

httpHeaders

+

Array of io.cci.otc.api.pkg.apis.versioned.cci.v2.HTTPHeader objects

+

Custom headers to set in the request. HTTP allows repeated headers.

+

path

+

String

+

Path to access on the HTTP server.

+

port

+

String

+

Name or number of the port to access on the container. Number

+

must be in the range 1 to 65535. Name must be an IANA_SVC_NAME.

+

scheme

+

String

+

Scheme to use for connecting to the host. Defaults to HTTP.

+

Possible enum values:

+
  • "HTTP" means that the scheme used will be http://
  • "HTTPS" means that the scheme used will be https://
+
+
+ +
+ + + + + + + + + + + + + +
Table 110 io.cci.otc.api.pkg.apis.versioned.cci.v2.HTTPHeader

Parameter

+

Type

+

Description

+

name

+

String

+

The header field name

+

value

+

String

+

The header field value

+
+
+ +
+ + + + + + + + + + + + + +
Table 111 io.cci.otc.api.pkg.apis.versioned.cci.v2.TCPSocketAction

Parameter

+

Type

+

Description

+

host

+

String

+

Optional: Host name to connect to, defaults to the pod IP.

+

port

+

String

+

Number or name of the port to access on the container. Number

+

must be in the range 1 to 65535. Name must be an IANA_SVC_NAME.

+
+
+ +
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Table 112 io.cci.otc.api.pkg.apis.versioned.cci.v2.VolumeMount

Parameter

+

Type

+

Description

+

extendPathMode

+

String

+

Extend the volume path by appending the pod metadata to the path

+

according to specified pattern. which provide a way of directory isolation

+

and help prevent the writing conflict between different pods.

+

mountPath

+

String

+

Path within the container at which the volume should be mounted. Must

+

not contain ':'.

+

name

+

String

+

This must match the Name of a Volume.

+

readOnly

+

Boolean

+

Mounted read-only if true, read-write otherwise (false or unspecified).

+

Defaults to false.

+

subPath

+

String

+

Path within the volume from which the container's volume should

+

be mounted. Defaults to "" (volume's root).

+

subPathExpr

+

String

+

Expanded path within the volume from which the container's volume

+

should be mounted. Behaves similarly to SubPath but environment variable

+

references $(VAR_NAME) are expanded using the container's environment. Defaults

+

to "" (volume's root). SubPathExpr and SubPath are mutually exclusive.

+
+
+ +
+ + + + + + + + + +
Table 113 io.cci.otc.api.pkg.apis.versioned.cci.v2.PodReadinessGate

Parameter

+

Type

+

Description

+

conditionType

+

String

+

ConditionType refers to a condition in the pod's condition list

+

with matching type.

+
+
+ +
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Table 114 io.cci.otc.api.pkg.apis.versioned.cci.v2.PodSecurityContext

Parameter

+

Type

+

Description

+

fsGroup

+

Long

+

A special supplemental group that applies to all containers in a pod. Some volume types allow the Kubelet to change the ownership of that volume to be owned by the pod:

+
  1. The owning GID will be the FSGroup 2. The setgid bit is set (new files created in the volume will be owned by FSGroup) 3. The permission bits are OR'd with rw-rw----
+

If unset, the Kubelet will not modify the ownership and permissions of any volume. Note that this field cannot be set when spec.os.name is windows.

+

fsGroupChangePolicy

+

String

+

fsGroupChangePolicy defines behavior of changing ownership and permission of the volume before being exposed inside Pod. This field will only apply to volume types which support fsGroup based ownership(and permissions). It will have no effect on ephemeral volume types such as: secret, configmaps and emptydir. Valid values are "OnRootMismatch" and "Always". If not specified, "Always" is used. Note that this field cannot be set when spec.os.name is windows.

+

runAsGroup

+

Long

+

The GID to run the entrypoint of the container process. Uses

+

runtime default if unset. May also be set in SecurityContext. If set in

+

both SecurityContext and PodSecurityContext, the value specified in SecurityContext

+

takes precedence for that container. Note that this field cannot be set

+

when spec.os.name is windows.

+

runAsNonRoot

+

Boolean

+

Indicates that the container must run as a non-root user. If

+

true, the Kubelet will validate the image at runtime to ensure that it does

+

not run as UID 0 (root) and fail to start the container if it does. If unset

+

or false, no such validation will be performed. May also be set in SecurityContext. If

+

set in both SecurityContext and PodSecurityContext, the value specified

+

in SecurityContext takes precedence.

+

runAsUser

+

Long

+

The UID to run the entrypoint of the container process. Defaults

+

to user specified in image metadata if unspecified. May also be set in SecurityContext. If

+

set in both SecurityContext and PodSecurityContext, the value specified

+

in SecurityContext takes precedence for that container. Note that this field

+

cannot be set when spec.os.name is windows.

+

supplementalGroups

+

Array of longs

+

A list of groups applied to the first process run in each container,

+

in addition to the container's primary GID. If unspecified, no groups will

+

be added to any container. Note that this field cannot be set when spec.os.name

+

is windows.

+

sysctls

+

Array of io.cci.otc.api.pkg.apis.versioned.cci.v2.Sysctl objects

+

Sysctls hold a list of namespaced sysctls used for the pod. Pods

+

with unsupported sysctls (by the container runtime) might fail to launch.

+

Note that this field cannot be set when spec.os.name is windows.

+
+
+ +
+ + + + + + + + + + + + + +
Table 115 io.cci.otc.api.pkg.apis.versioned.cci.v2.Sysctl

Parameter

+

Type

+

Description

+

name

+

String

+

Name of a property to set

+

value

+

String

+

Value of a property to set

+
+
+ +
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Table 116 io.cci.otc.api.pkg.apis.versioned.cci.v2.TopologySpreadConstraint

Parameter

+

Type

+

Description

+

labelSelector

+

io.k8s.apimachinery.pkg.apis.meta.v1.LabelSelector object

+

LabelSelector is used to find matching pods. Pods that match

+

this label selector are counted to determine the number of pods in their

+

corresponding topology domain.

+

matchLabelKeys

+

Array of strings

+

MatchLabelKeys is a set of pod label keys to select the pods

+

over which spreading will be calculated. The keys are used to lookup values

+

from the incoming pod labels, those key-value labels are ANDed with labelSelector

+

to select the group of existing pods over which spreading will be calculated

+

for the incoming pod. Keys that don't exist in the incoming pod labels will

+

be ignored. A null or empty list means only match against labelSelector.

+

maxSkew

+

Integer

+

MaxSkew describes the degree to which pods may be unevenly distributed. When whenUnsatisfiable=DoNotSchedule, it is the maximum permitted difference between the number of matching pods in the target topology and the global minimum. The global minimum is the minimum number of matching pods in an eligible domain or zero if the number of eligible domains is less than MinDomains. For example, in a 3-zone cluster, MaxSkew is set to 1, and pods with the same labelSelector spread as 2/2/1: In this case, the global minimum is 1. | zone1 | zone2 | zone3 | | P P | P P | P | - if MaxSkew is 1, incoming pod can only be scheduled to zone3 to become 2/2/2; scheduling it onto zone1(zone2) would make the ActualSkew(3-1) on zone1(zone2) violate MaxSkew(1). - if MaxSkew is 2, incoming pod can be scheduled onto any zone. When whenUnsatisfiable=ScheduleAnyway, it is used to give higher precedence to topologies that satisfy it. It's a required field. Default value is 1 and 0 is not allowed.

+

minDomains

+

Integer

+

MinDomains indicates a minimum number of eligible domains. When the number of eligible domains with matching topology keys is less than minDomains, Pod Topology Spread treats "global minimum" as 0, and then the calculation of Skew is performed. And when the number of eligible domains with matching topology keys equals or greater than minDomains, this value has no effect on scheduling. As a result, when the number of eligible domains is less than minDomains, scheduler won't schedule more than maxSkew Pods to those domains. If value is nil, the constraint behaves as if MinDomains is equal to 1. Valid values are integers greater than 0. When value is not nil, WhenUnsatisfiable must be DoNotSchedule.

+

For example, in a 3-zone cluster, MaxSkew is set to 2, MinDomains is set to 5 and pods with the same labelSelector spread as 2/2/2: | zone1 | zone2 | zone3 | | P P | P P | P P | The number of domains is less than 5(MinDomains), so "global minimum" is treated as 0. In this situation, new pod with the same labelSelector cannot be scheduled, because computed skew will be 3(3 - 0) if new Pod is scheduled to any of the three zones, it will violate MaxSkew.

+

This is a beta field and requires the MinDomainsInPodTopologySpread feature gate to be enabled (enabled by default).

+

nodeAffinityPolicy

+

String

+

NodeAffinityPolicy indicates how we will treat Pod's nodeAffinity/nodeSelector when calculating pod topology spread skew. Options are: - Honor: only nodes matching nodeAffinity/nodeSelector are included in the calculations. - Ignore: nodeAffinity/nodeSelector are ignored. All nodes are included in the calculations.

+

If this value is nil, the behavior is equivalent to the Honor policy. This is a alpha-level feature enabled by the NodeInclusionPolicyInPodTopologySpread feature flag.

+

nodeTaintsPolicy

+

String

+

NodeTaintsPolicy indicates how we will treat node taints when calculating pod topology spread skew. Options are: - Honor: nodes without taints, along with tainted nodes for which the incoming pod has a toleration, are included. - Ignore: node taints are ignored. All nodes are included.

+

If this value is nil, the behavior is equivalent to the Ignore policy. This is a alpha-level feature enabled by the NodeInclusionPolicyInPodTopologySpread feature flag.

+

topologyKey

+

String

+

TopologyKey is the key of node labels. Nodes that have a label

+

with this key and identical values are considered to be in the same topology.

+

We consider each <key, value> as a "bucket", and try to put balanced number

+

of pods into each bucket. We define a domain as a particular instance of

+

a topology. Also, we define an eligible domain as a domain whose nodes meet

+

the requirements of nodeAffinityPolicy and nodeTaintsPolicy. e.g. If TopologyKey

+

is "kubernetes.io/hostname", each Node is a domain of that topology. And,

+

if TopologyKey is "topology.kubernetes.io/zone", each zone is a domain of

+

that topology. It's a required field.

+

whenUnsatisfiable

+

String

+

WhenUnsatisfiable indicates how to deal with a pod if it doesn't satisfy the spread constraint. - DoNotSchedule (default) tells the scheduler not to schedule it. - ScheduleAnyway tells the scheduler to schedule the pod in any location,

+

but giving higher precedence to topologies that would help reduce the

+

skew.

+

A constraint is considered "Unsatisfiable" for an incoming pod if and only if every possible node assignment for that pod would violate "MaxSkew" on some topology. For example, in a 3-zone cluster, MaxSkew is set to 1, and pods with the same labelSelector spread as 3/1/1: | zone1 | zone2 | zone3 | | P P P | P | P | If WhenUnsatisfiable is set to DoNotSchedule, incoming pod can only be scheduled to zone2(zone3) to become 3/2/1(3/1/2) as ActualSkew(2-1) on zone2(zone3) satisfies MaxSkew(1). In other words, the cluster can still be imbalanced, but scheduler won't make it more imbalanced. It's a required field.

+

Possible enum values:

+
  • "DoNotSchedule" instructs the scheduler not to schedule the pod when constraints are not satisfied.
  • "ScheduleAnyway" instructs the scheduler to schedule the pod even if constraints are not satisfied.
+
+
+ +
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Table 117 io.cci.otc.api.pkg.apis.versioned.cci.v2.Volume

Parameter

+

Type

+

Description

+

configMap

+

io.cci.otc.api.pkg.apis.versioned.cci.v2.ConfigMapVolumeSource object

+

configMap represents a configMap that should populate this volume

+

downwardAPI

+

io.cci.otc.api.pkg.apis.versioned.cci.v2.DownwardAPIVolumeSource object

+

downwardAPI represents downward API about the pod that should

+

populate this volume

+

emptyDir

+

io.cci.otc.api.pkg.apis.versioned.cci.v2.EmptyDirVolumeSource object

+

emptyDir represents a temporary directory that shares a pod's lifetime. More info: https://kubernetes.io/docs/concepts/storage/volumes#emptydir

+

ephemeral

+

io.cci.otc.api.pkg.apis.versioned.cci.v2.EphemeralVolumeSource object

+

ephemeral represents a volume that is handled by a cluster storage driver. The volume's lifecycle is tied to the pod that defines it - it will be created before the pod starts, and deleted when the pod is removed.

+

Use this if: a) the volume is only needed while the pod runs, b) features of normal volumes like restoring from snapshot or capacity

+

tracking are needed,

+

c) the storage driver is specified through a storage class, and d) the storage driver supports dynamic volume provisioning through

+

a PersistentVolumeClaim (see EphemeralVolumeSource for more

+

information on the connection between this volume type

+

and PersistentVolumeClaim).

+

Use PersistentVolumeClaim or one of the vendor-specific APIs for volumes that persist for longer than the lifecycle of an individual pod.

+

Use CSI for light-weight local ephemeral volumes if the CSI driver is meant to be used that way - see the documentation of the driver for more information.

+

A pod can use both types of ephemeral volumes and persistent volumes at the same time.

+

name

+

String

+

name of the volume. Must be a DNS_LABEL and unique within the pod. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names

+

nfs

+

io.cci.otc.api.pkg.apis.versioned.cci.v2.NFSVolumeSource object

+

nfs represents an NFS mount on the host that shares a pod's lifetime More info: https://kubernetes.io/docs/concepts/storage/volumes#nfs

+

persistentVolumeClaim

+

io.cci.otc.api.pkg.apis.versioned.cci.v2.PersistentVolumeClaimVolumeSource object

+

persistentVolumeClaimVolumeSource represents a reference to a PersistentVolumeClaim in the same namespace. More info: https://kubernetes.io/docs/concepts/storage/persistent-volumes#persistentvolumeclaims

+

projected

+

io.cci.otc.api.pkg.apis.versioned.cci.v2.ProjectedVolumeSource object

+

projected items for all in one resources secrets, configmaps,

+

and downward API

+

secret

+

io.cci.otc.api.pkg.apis.versioned.cci.v2.SecretVolumeSource object

+

secret represents a secret that should populate this volume. More info: https://kubernetes.io/docs/concepts/storage/volumes#secret

+
+
+ +
+ + + + + + + + + + + + + + + + + + + + + +
Table 118 io.cci.otc.api.pkg.apis.versioned.cci.v2.ConfigMapVolumeSource

Parameter

+

Type

+

Description

+

defaultMode

+

Integer

+

defaultMode is optional: mode bits used to set permissions on created files by default. Must be an octal value between 0000 and 0777 or a decimal value between 0 and 511. YAML accepts both octal and decimal values, JSON requires decimal values for mode bits. Defaults to 0644. Directories within the path are not affected by this setting. This might be in conflict with other options that affect the file mode, like fsGroup, and the result can be other mode bits set.

+

items

+

Array of io.cci.otc.api.pkg.apis.versioned.cci.v2.KeyToPath objects

+

items if unspecified, each key-value pair in the Data field of

+

the referenced ConfigMap will be projected into the volume as a file whose

+

name is the key and content is the value. If specified, the listed keys

+

will be projected into the specified paths, and unlisted keys will not be

+

present. If a key is specified which is not present in the ConfigMap, the

+

volume setup will error unless it is marked optional. Paths must be relative

+

and may not contain the '..' path or start with '..'.

+

name

+

String

+

Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names

+

optional

+

Boolean

+

optional specify whether the ConfigMap or its keys must be defined

+
+
+ +
+ + + + + + + + + + + + + +
Table 119 io.cci.otc.api.pkg.apis.versioned.cci.v2.DownwardAPIVolumeSource

Parameter

+

Type

+

Description

+

defaultMode

+

Integer

+

Optional: mode bits to use on created files by default. Must be a Optional: mode bits used to set permissions on created files by default. Must be an octal value between 0000 and 0777 or a decimal value between 0 and 511. YAML accepts both octal and decimal values, JSON requires decimal values for mode bits. Defaults to 0644. Directories within the path are not affected by this setting. This might be in conflict with other options that affect the file mode, like fsGroup, and the result can be other mode bits set.

+

items

+

Array of io.cci.otc.api.pkg.apis.versioned.cci.v2.DownwardAPIVolumeFile objects

+

Items is a list of downward API volume file

+
+
+ +
+ + + + + + + + + + + + + +
Table 120 io.cci.otc.api.pkg.apis.versioned.cci.v2.EmptyDirVolumeSource

Parameter

+

Type

+

Description

+

medium

+

String

+

medium represents what type of storage medium should back this directory. The default is "" which means to use the node's default medium. Must be an empty string (default) or Memory. More info: https://kubernetes.io/docs/concepts/storage/volumes#emptydir

+

sizeLimit

+

String

+

sizeLimit is the total amount of local storage required for this EmptyDir volume. The size limit is also applicable for memory medium. The maximum usage on memory medium EmptyDir would be the minimum value between the SizeLimit specified here and the sum of memory limits of all containers in a pod. The default is nil which means that the limit is undefined. More info: http://kubernetes.io/docs/user-guide/volumes#emptydir

+
+
+ +
+ + + + + + + + + +
Table 121 io.cci.otc.api.pkg.apis.versioned.cci.v2.EphemeralVolumeSource

Parameter

+

Type

+

Description

+

volumeClaimTemplate

+

io.cci.otc.api.pkg.apis.versioned.cci.v2.PersistentVolumeClaimTemplate object

+

Will be used to create a stand-alone PVC to provision the volume. The pod in which this EphemeralVolumeSource is embedded will be the owner of the PVC, i.e. the PVC will be deleted together with the pod. The name of the PVC will be <pod name>-<volume name> where <volume name> is the name from the PodSpec.Volumes array entry. Pod validation will reject the pod if the concatenated name is not valid for a PVC (for example, too long).

+

An existing PVC with that name that is not owned by the pod will not be used for the pod to avoid using an unrelated volume by mistake. Starting the pod is then blocked until the unrelated PVC is removed. If such a pre-created PVC is meant to be used by the pod, the PVC has to updated with an owner reference to the pod once the pod exists. Normally this should not be necessary, but it may be useful when manually reconstructing a broken cluster.

+

This field is read-only and no changes will be made by Kubernetes to the PVC after it has been created.

+

Required, must not be nil.

+
+
+ +
+ + + + + + + + + + + + + +
Table 122 io.cci.otc.api.pkg.apis.versioned.cci.v2.PersistentVolumeClaimTemplate

Parameter

+

Type

+

Description

+

metadata

+

io.k8s.apimachinery.pkg.apis.meta.v1.ObjectMeta object

+

May contain labels and annotations that will be copied into the

+

PVC when creating it. No other fields are allowed and will be rejected during

+

validation.

+

spec

+

io.cci.otc.api.pkg.apis.versioned.cci.v2.PersistentVolumeClaimSpec object

+

The specification for the PersistentVolumeClaim. The entire content

+

is copied unchanged into the PVC that gets created from this template. The

+

same fields as in a PersistentVolumeClaim are also valid here.

+
+
+ +
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Table 123 io.k8s.apimachinery.pkg.apis.meta.v1.ObjectMeta

Parameter

+

Type

+

Description

+

annotations

+

Map<String,String>

+

Annotations is an unstructured key value map stored with a resource that may be set by external tools to store and retrieve arbitrary metadata. They are not queryable and should be preserved when modifying objects. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/annotations/

+

clusterName

+

String

+

The name of the cluster which the object belongs to. This is

+

used to distinguish resources with same name and namespace in different

+

clusters. This field is not set anywhere right now and apiserver is going

+

to ignore it if set in create or update request.

+

creationTimestamp

+

String

+

CreationTimestamp is a timestamp representing the server time when this object was created. It is not guaranteed to be set in happens-before order across separate operations. Clients may not set this value. It is represented in RFC3339 form and is in UTC.

+

Populated by the system. Read-only. Null for lists. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata

+

deletionGracePeriodSeconds

+

Long

+

Number of seconds allowed for this object to gracefully terminate

+

before it will be removed from the system. Only set when deletionTimestamp

+

is also set. May only be shortened. Read-only.

+

deletionTimestamp

+

String

+

DeletionTimestamp is RFC 3339 date and time at which this resource will be deleted. This field is set by the server when a graceful deletion is requested by the user, and is not directly settable by a client. The resource is expected to be deleted (no longer visible from resource lists, and not reachable by name) after the time in this field, once the finalizers list is empty. As long as the finalizers list contains items, deletion is blocked. Once the deletionTimestamp is set, this value may not be unset or be set further into the future, although it may be shortened or the resource may be deleted prior to this time. For example, a user may request that a pod is deleted in 30 seconds. The Kubelet will react by sending a graceful termination signal to the containers in the pod. After that 30 seconds, the Kubelet will send a hard termination signal (SIGKILL) to the container and after cleanup, remove the pod from the API. In the presence of network partitions, this object may still exist after this timestamp, until an administrator or automated process can determine the resource is fully terminated. If not set, graceful deletion of the object has not been requested.

+

Populated by the system when a graceful deletion is requested. Read-only. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata

+

enable

+

Boolean

+

Enable identifies whether the resource is available

+

finalizers

+

Array of strings

+

Must be empty before the object is deleted from the registry.

+

Each entry is an identifier for the responsible component that will remove

+

the entry from the list. If the deletionTimestamp of the object is non-nil,

+

entries in this list can only be removed. Finalizers may be processed and

+

removed in any order. Order is NOT enforced because it introduces significant

+

risk of stuck finalizers. finalizers is a shared field, any actor with permission

+

can reorder it. If the finalizer list is processed in order, then this can

+

lead to a situation in which the component responsible for the first finalizer

+

in the list is waiting for a signal (field value, external system, or other)

+

produced by a component responsible for a finalizer later in the list, resulting

+

in a deadlock. Without enforced ordering finalizers are free to order amongst

+

themselves and are not vulnerable to ordering changes in the list.

+

generateName

+

String

+

GenerateName is an optional prefix, used by the server, to generate a unique name ONLY IF the Name field has not been provided. If this field is used, the name returned to the client will be different than the name passed. This value will also be combined with a unique suffix. The provided value has the same validation rules as the Name field, and may be truncated by the length of the suffix required to make the value unique on the server.

+

If this field is specified and the generated name exists, the server will NOT return a 409 - instead, it will either return 201 Created or 500 with Reason ServerTimeout indicating a unique name could not be found in the time allotted, and the client should retry (optionally after the time indicated in the Retry-After header).

+

Applied only if Name is not specified. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#idempotency

+

generation

+

Long

+

A sequence number representing a specific generation of the desired

+

state. Populated by the system. Read-only.

+

labels

+

Map<String,String>

+

Map of string keys and values that can be used to organize and categorize (scope and select) objects. May match selectors of replication controllers and services. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/labels/

+

managedFields

+

Array of io.k8s.apimachinery.pkg.apis.meta.v1.ManagedFieldsEntry objects

+

ManagedFields maps workflow-id and version to the set of fields

+

that are managed by that workflow. This is mostly for internal housekeeping,

+

and users typically shouldn't need to set or understand this field. A workflow

+

can be the user's name, a controller's name, or the name of a specific apply

+

path like "ci-cd". The set of fields is always in the version that the workflow

+

used when modifying the object.

+

name

+

String

+

Name must be unique within a namespace. Is required when creating resources, although some resources may allow a client to request the generation of an appropriate name automatically. Name is primarily intended for creation idempotence and configuration definition. Cannot be updated. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names

+

namespace

+

String

+

Namespace defines the space within which each name must be unique. An empty namespace is equivalent to the "default" namespace, but "default" is the canonical representation. Not all objects are required to be scoped to a namespace - the value of this field for those objects will be empty.

+

Must be a DNS_LABEL. Cannot be updated. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/namespaces/

+

ownerReferences

+

Array of io.k8s.apimachinery.pkg.apis.meta.v1.OwnerReference objects

+

List of objects depended by this object. If ALL objects in the

+

list have been deleted, this object will be garbage collected. If this object

+

is managed by a controller, then an entry in this list will point to this

+

controller, with the controller field set to true. There cannot be more

+

than one managing controller.

+

resourceVersion

+

String

+

An opaque value that represents the internal version of this object that can be used by clients to determine when objects have changed. May be used for optimistic concurrency, change detection, and the watch operation on a resource or set of resources. Clients must treat these values as opaque and passed unmodified back to the server. They may only be valid for a particular resource or set of resources.

+

Populated by the system. Read-only. Value must be treated as opaque by clients and . More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#concurrency-control-and-consistency

+

selfLink

+

String

+

SelfLink is a URL representing this object. Populated by the system. Read-only.

+

DEPRECATED Kubernetes will stop propagating this field in 1.20 release and the field is planned to be removed in 1.21 release.

+

uid

+

String

+

UID is the unique in time and space value for this object. It is typically generated by the server on successful creation of a resource and is not allowed to change on PUT operations.

+

Populated by the system. Read-only. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#uids

+
+
+ +
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Table 124 io.k8s.apimachinery.pkg.apis.meta.v1.ManagedFieldsEntry

Parameter

+

Type

+

Description

+

apiVersion

+

String

+

APIVersion defines the version of this resource that this field

+

set applies to. The format is "group/version" just like the top-level APIVersion

+

field. It is necessary to track the version of a field set because it cannot

+

be automatically converted.

+

fieldsType

+

String

+

FieldsType is the discriminator for the different fields format and version. There is currently only one possible value: "FieldsV1"

+

fieldsV1

+

Object

+

FieldsV1 holds the first JSON version format as described in

+

the "FieldsV1" type.

+

manager

+

String

+

Manager is an identifier of the workflow managing these fields.

+

operation

+

String

+

Operation is the type of operation which lead to this ManagedFieldsEntry

+

being created. The only valid values for this field are 'Apply' and 'Update'.

+

time

+

String

+

Time is timestamp of when these fields were set. It should always

+

be empty if Operation is 'Apply'

+
+
+ +
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Table 125 io.k8s.apimachinery.pkg.apis.meta.v1.OwnerReference

Parameter

+

Type

+

Description

+

apiVersion

+

String

+

API version of the referent.

+

blockOwnerDeletion

+

Boolean

+

If true, AND if the owner has the "foregroundDeletion" finalizer,

+

then the owner cannot be deleted from the key-value store until this reference

+

is removed. Defaults to false. To set this field, a user needs "delete"

+

permission of the owner, otherwise 422 (Unprocessable Entity) will be returned.

+

controller

+

Boolean

+

If true, this reference points to the managing controller.

+

kind

+

String

+

Kind of the referent. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds

+

name

+

String

+

Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names

+

uid

+

String

+

UID of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#uids

+
+
+ +
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Table 126 io.cci.otc.api.pkg.apis.versioned.cci.v2.PersistentVolumeClaimSpec

Parameter

+

Type

+

Description

+

accessModes

+

Array of strings

+

accessModes contains the desired access modes the volume should have. More info: https://kubernetes.io/docs/concepts/storage/persistent-volumes#access-modes-1

+

dataSource

+

io.cci.otc.api.pkg.apis.versioned.cci.v2.TypedLocalObjectReference object

+

dataSource field can be used to specify either: * An existing VolumeSnapshot object (snapshot.storage.k8s.io/VolumeSnapshot) * An existing PVC (PersistentVolumeClaim) If the provisioner or an external controller can support the specified data source, it will create a new volume based on the contents of the specified data source. If the AnyVolumeDataSource feature gate is enabled, this field will always have the same contents as the DataSourceRef field.

+

dataSourceRef

+

io.cci.otc.api.pkg.apis.versioned.cci.v2.TypedLocalObjectReference object

+

dataSourceRef specifies the object from which to populate the volume with data, if a non-empty volume is desired. This may be any local object from a non-empty API group (non core object) or a PersistentVolumeClaim object. When this field is specified, volume binding will only succeed if the type of the specified object matches some installed volume populator or dynamic provisioner. This field will replace the functionality of the DataSource field and as such if both fields are non-empty, they must have the same value. For backwards compatibility, both fields (DataSource and DataSourceRef) will be set to the same value automatically if one of them is empty and the other is non-empty. There are two important differences between DataSource and DataSourceRef: * While DataSource only allows two specific types of objects, DataSourceRef

+

allows any non-core object, as well as PersistentVolumeClaim objects.

+
  • While DataSource ignores disallowed values (dropping them), DataSourceRef

    preserves all values, and generates an error if a disallowed value is

    +

    specified.

    +

    (Beta) Using this field requires the AnyVolumeDataSource feature gate to be enabled.

    +
+

resources

+

io.cci.otc.api.pkg.apis.versioned.cci.v2.ResourceRequirements object

+

resources represents the minimum resources the volume should have. If RecoverVolumeExpansionFailure feature is enabled users are allowed to specify resource requirements that are lower than previous value but must still be higher than capacity recorded in the status field of the claim. More info: https://kubernetes.io/docs/concepts/storage/persistent-volumes#resources

+

selector

+

io.k8s.apimachinery.pkg.apis.meta.v1.LabelSelector object

+

selector is a label query over volumes to consider for binding.

+

storageClassName

+

String

+

storageClassName is the name of the StorageClass required by the claim. More info: https://kubernetes.io/docs/concepts/storage/persistent-volumes#class-1

+

volumeMode

+

String

+

volumeMode defines what type of volume is required by the claim.

+

Value of Filesystem is implied when not included in claim spec.

+

volumeName

+

String

+

volumeName is the binding reference to the PersistentVolume backing

+

this claim.

+
+
+ +
+ + + + + + + + + + + + + + + + + +
Table 127 io.cci.otc.api.pkg.apis.versioned.cci.v2.TypedLocalObjectReference

Parameter

+

Type

+

Description

+

apiGroup

+

String

+

APIGroup is the group for the resource being referenced. If APIGroup

+

is not specified, the specified Kind must be in the core API group. For

+

any other third-party types, APIGroup is required.

+

kind

+

String

+

Kind is the type of resource being referenced

+

name

+

String

+

Name is the name of resource being referenced

+
+
+ +
+ + + + + + + + + + + + + +
Table 128 io.cci.otc.api.pkg.apis.versioned.cci.v2.ResourceRequirements

Parameter

+

Type

+

Description

+

limits

+

Map<String,String>

+

Limits describes the maximum amount of compute resources allowed. More info: https://kubernetes.io/docs/concepts/configuration/manage-resources-containers/

+

requests

+

Map<String,String>

+

Requests describes the minimum amount of compute resources required. If Requests is omitted for a container, it defaults to Limits if that is explicitly specified, otherwise to an implementation-defined value. More info: https://kubernetes.io/docs/concepts/configuration/manage-resources-containers/

+
+
+ +
+ + + + + + + + + +
Table 129 io.k8s.apimachinery.pkg.api.resource.Quantity

Parameter

+

Type

+

Description

+

-

+

String

+

Quantity is a fixed-point representation of a number. It provides convenient marshaling/unmarshaling in JSON and YAML, in addition to String() and AsInt64() accessors.

+

The serialization format is:

+

[/topic/body/section/table/tgroup/tbody/row/entry/p/br {""}) (br] ::= [/topic/body/section/table/tgroup/tbody/row/entry/p/br {""}) (br][/topic/body/section/table/tgroup/tbody/row/entry/p/br {""}) (br]

+

(Note that [/topic/body/section/table/tgroup/tbody/row/entry/p/br {""}) (br] may be empty, from the "" case in [/topic/body/section/table/tgroup/tbody/row/entry/p/br {""}) (br].)

+

[/topic/body/section/table/tgroup/tbody/row/entry/p/br {""}) (br] ::= 0 | 1 | ... | 9 [/topic/body/section/table/tgroup/tbody/row/entry/p/br {""}) (br] ::= [/topic/body/section/table/tgroup/tbody/row/entry/p/br {""}) (br] | [/topic/body/section/table/tgroup/tbody/row/entry/p/br {""}) (br][/topic/body/section/table/tgroup/tbody/row/entry/p/br {""}) (br] [/topic/body/section/table/tgroup/tbody/row/entry/p/br {""}) (br] ::= [/topic/body/section/table/tgroup/tbody/row/entry/p/br {""}) (br] | [/topic/body/section/table/tgroup/tbody/row/entry/p/br {""}) (br].[/topic/body/section/table/tgroup/tbody/row/entry/p/br {""}) (br] | [/topic/body/section/table/tgroup/tbody/row/entry/p/br {""}) (br]. | .[/topic/body/section/table/tgroup/tbody/row/entry/p/br {""}) (br] [/topic/body/section/table/tgroup/tbody/row/entry/p/br {""}) (br] ::= "+" | "-" [/topic/body/section/table/tgroup/tbody/row/entry/p/br {""}) (br] ::= [/topic/body/section/table/tgroup/tbody/row/entry/p/br {""}) (br] | [/topic/body/section/table/tgroup/tbody/row/entry/p/br {""}) (br][/topic/body/section/table/tgroup/tbody/row/entry/p/br {""}) (br] [/topic/body/section/table/tgroup/tbody/row/entry/p/br {""}) (br] ::= [/topic/body/section/table/tgroup/tbody/row/entry/p/br {""}) (br] | [/topic/body/section/table/tgroup/tbody/row/entry/p/br {""}) (br] | [/topic/body/section/table/tgroup/tbody/row/entry/p/br {""}) (br] [/topic/body/section/table/tgroup/tbody/row/entry/p/br {""}) (br] ::= Ki | Mi | Gi | Ti | Pi | Ei

+

(International System of units; See: http://physics.nist.gov/cuu/Units/binary.html)

+

[/topic/body/section/table/tgroup/tbody/row/entry/p/br {""}) (br] ::= m | "" | k | M | G | T | P | E

+

(Note that 1024 = 1Ki but 1000 = 1k; I didn't choose the capitalization.)

+

[/topic/body/section/table/tgroup/tbody/row/entry/p/br {""}) (br] ::= "e" [/topic/body/section/table/tgroup/tbody/row/entry/p/br {""}) (br] | "E" [/topic/body/section/table/tgroup/tbody/row/entry/p/br {""}) (br]

+

No matter which of the three exponent forms is used, no quantity may represent a number greater than 2^63-1 in magnitude, nor may it have more than 3 decimal places. Numbers larger or more precise will be capped or rounded up. (E.g.: 0.1m will rounded up to 1m.) This may be extended in the future if we require larger or smaller quantities.

+

When a Quantity is parsed from a string, it will remember the type of suffix it had, and will use the same type again when it is serialized.

+

Before serializing, Quantity will be put in "canonical form". This means that Exponent/suffix will be adjusted up or down (with a corresponding increase or decrease in Mantissa) such that:

+

a. No precision is lost

+

b. No fractional digits will be emitted

+

c. The exponent (or suffix) is as large as possible.

+

The sign will be omitted unless the number is negative.

+

Examples:

+

1.5 will be serialized as "1500m"

+

1.5Gi will be serialized as "1536Mi"

+

Note that the quantity will NEVER be internally represented by a floating point number. That is the whole point of this exercise.

+

Non-canonical values will still parse as long as they are well formed, but will be re-emitted in their canonical form. (So always use canonical form, or don't diff.)

+

This format is intended to make it difficult to use these numbers without writing some sort of special handling code in the hopes that that will cause implementors to also use a fixed point implementation.

+
+
+ +
+ + + + + + + + + + + + + +
Table 130 io.k8s.apimachinery.pkg.apis.meta.v1.LabelSelector

Parameter

+

Type

+

Description

+

matchExpressions

+

Array of io.k8s.apimachinery.pkg.apis.meta.v1.LabelSelectorRequirement objects

+

matchExpressions is a list of label selector requirements. The

+

requirements are ANDed.

+

matchLabels

+

Map<String,String>

+

matchLabels is a map of {key,value} pairs. A single {key,value}

+

in the matchLabels map is equivalent to an element of matchExpressions,

+

whose key field is "key", the operator is "In", and the values array contains

+

only "value". The requirements are ANDed.

+
+
+ +
+ + + + + + + + + + + + + + + + + +
Table 131 io.k8s.apimachinery.pkg.apis.meta.v1.LabelSelectorRequirement

Parameter

+

Type

+

Description

+

key

+

String

+

key is the label key that the selector applies to.

+

operator

+

String

+

operator represents a key's relationship to a set of values.

+

Valid operators are In, NotIn, Exists and DoesNotExist.

+

values

+

Array of strings

+

values is an array of string values. If the operator is In or

+

NotIn, the values array must be non-empty. If the operator is Exists or

+

DoesNotExist, the values array must be empty. This array is replaced during

+

a strategic merge patch.

+
+
+ +
+ + + + + + + + + + + + + + + + + +
Table 132 io.cci.otc.api.pkg.apis.versioned.cci.v2.NFSVolumeSource

Parameter

+

Type

+

Description

+

path

+

String

+

path that is exported by the NFS server. More info: https://kubernetes.io/docs/concepts/storage/volumes#nfs

+

readOnly

+

Boolean

+

readOnly here will force the NFS export to be mounted with read-only permissions. Defaults to false. More info: https://kubernetes.io/docs/concepts/storage/volumes#nfs

+

server

+

String

+

server is the hostname or IP address of the NFS server. More info: https://kubernetes.io/docs/concepts/storage/volumes#nfs

+
+
+ +
+ + + + + + + + + + + + + +
Table 133 io.cci.otc.api.pkg.apis.versioned.cci.v2.PersistentVolumeClaimVolumeSource

Parameter

+

Type

+

Description

+

claimName

+

String

+

claimName is the name of a PersistentVolumeClaim in the same namespace as the pod using this volume. More info: https://kubernetes.io/docs/concepts/storage/persistent-volumes#persistentvolumeclaims

+

readOnly

+

Boolean

+

readOnly Will force the ReadOnly setting in VolumeMounts. Default

+

false.

+
+
+ +
+ + + + + + + + + + + + + +
Table 134 io.cci.otc.api.pkg.apis.versioned.cci.v2.ProjectedVolumeSource

Parameter

+

Type

+

Description

+

defaultMode

+

Integer

+

defaultMode are the mode bits used to set permissions on created

+

files by default. Must be an octal value between 0000 and 0777 or a decimal

+

value between 0 and 511. YAML accepts both octal and decimal values, JSON

+

requires decimal values for mode bits. Directories within the path are not

+

affected by this setting. This might be in conflict with other options that

+

affect the file mode, like fsGroup, and the result can be other mode bits

+

set.

+

sources

+

Array of io.cci.otc.api.pkg.apis.versioned.cci.v2.VolumeProjection objects

+

sources is the list of volume projections

+
+
+ +
+ + + + + + + + + + + + + + + + + +
Table 135 io.cci.otc.api.pkg.apis.versioned.cci.v2.VolumeProjection

Parameter

+

Type

+

Description

+

configMap

+

io.cci.otc.api.pkg.apis.versioned.cci.v2.ConfigMapProjection object

+

configMap information about the configMap data to project

+

downwardAPI

+

io.cci.otc.api.pkg.apis.versioned.cci.v2.DownwardAPIProjection object

+

downwardAPI information about the downwardAPI data to project

+

secret

+

io.cci.otc.api.pkg.apis.versioned.cci.v2.SecretProjection object

+

secret information about the secret data to project

+
+
+ +
+ + + + + + + + + + + + + + + + + +
Table 136 io.cci.otc.api.pkg.apis.versioned.cci.v2.ConfigMapProjection

Parameter

+

Type

+

Description

+

items

+

Array of io.cci.otc.api.pkg.apis.versioned.cci.v2.KeyToPath objects

+

items if unspecified, each key-value pair in the Data field of

+

the referenced ConfigMap will be projected into the volume as a file whose

+

name is the key and content is the value. If specified, the listed keys

+

will be projected into the specified paths, and unlisted keys will not be

+

present. If a key is specified which is not present in the ConfigMap, the

+

volume setup will error unless it is marked optional. Paths must be relative

+

and may not contain the '..' path or start with '..'.

+

name

+

String

+

Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names

+

optional

+

Boolean

+

optional specify whether the ConfigMap or its keys must be defined

+
+
+ +
+ + + + + + + + + +
Table 137 io.cci.otc.api.pkg.apis.versioned.cci.v2.DownwardAPIProjection

Parameter

+

Type

+

Description

+

items

+

Array of io.cci.otc.api.pkg.apis.versioned.cci.v2.DownwardAPIVolumeFile objects

+

Items is a list of DownwardAPIVolume file

+
+
+ +
+ + + + + + + + + + + + + + + + + + + + + +
Table 138 io.cci.otc.api.pkg.apis.versioned.cci.v2.DownwardAPIVolumeFile

Parameter

+

Type

+

Description

+

fieldRef

+

io.cci.otc.api.pkg.apis.versioned.cci.v2.ObjectFieldSelector object

+

Required: Selects a field of the pod: only annotations, labels, name and namespace are supported.

+

mode

+

Integer

+

Optional: mode bits used to set permissions on this file, must be an octal value between 0000 and 0777 or a decimal value between 0 and 511. YAML accepts both octal and decimal values, JSON requires decimal values for mode bits. If not specified, the volume defaultMode will be used. This might be in conflict with other options that affect the file mode, like fsGroup, and the result can be other mode bits set.

+

path

+

String

+

Required: Path is the relative path name of the file to be created. Must not be absolute or contain the '..' path. Must be utf-8 encoded. The first item of the relative path must not start with '..'

+

resourceFieldRef

+

io.cci.otc.api.pkg.apis.versioned.cci.v2.ResourceFieldSelector object

+

Selects a resource of the container: only resources limits and requests (limits.cpu, limits.memory, requests.cpu and requests.memory) are currently supported.

+
+
+ +
+ + + + + + + + + + + + + +
Table 139 io.cci.otc.api.pkg.apis.versioned.cci.v2.ObjectFieldSelector

Parameter

+

Type

+

Description

+

apiVersion

+

String

+

Version of the schema the FieldPath is written in terms of, defaults

+

to "v1".

+

fieldPath

+

String

+

Path of the field to select in the specified API version.

+
+
+ +
+ + + + + + + + + + + + + + + + + +
Table 140 io.cci.otc.api.pkg.apis.versioned.cci.v2.ResourceFieldSelector

Parameter

+

Type

+

Description

+

containerName

+

String

+

Container name: required for volumes, optional for env vars

+

divisor

+

String

+

Specifies the output format of the exposed resources, defaults

+

to "1"

+

resource

+

String

+

Required: resource to select

+
+
+ +
+ + + + + + + + + + + + + + + + + +
Table 141 io.cci.otc.api.pkg.apis.versioned.cci.v2.SecretProjection

Parameter

+

Type

+

Description

+

items

+

Array of io.cci.otc.api.pkg.apis.versioned.cci.v2.KeyToPath objects

+

items if unspecified, each key-value pair in the Data field of

+

the referenced Secret will be projected into the volume as a file whose

+

name is the key and content is the value. If specified, the listed keys

+

will be projected into the specified paths, and unlisted keys will not be

+

present. If a key is specified which is not present in the Secret, the volume

+

setup will error unless it is marked optional. Paths must be relative and

+

may not contain the '..' path or start with '..'.

+

name

+

String

+

Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names

+

optional

+

Boolean

+

optional field specify whether the Secret or its key must be

+

defined

+
+
+ +
+ + + + + + + + + + + + + + + + + + + + + +
Table 142 io.cci.otc.api.pkg.apis.versioned.cci.v2.SecretVolumeSource

Parameter

+

Type

+

Description

+

defaultMode

+

Integer

+

defaultMode is Optional: mode bits used to set permissions on created files by default. Must be an octal value between 0000 and 0777 or a decimal value between 0 and 511. YAML accepts both octal and decimal values, JSON requires decimal values for mode bits. Defaults to 0644. Directories within the path are not affected by this setting. This might be in conflict with other options that affect the file mode, like fsGroup, and the result can be other mode bits set.

+

items

+

Array of io.cci.otc.api.pkg.apis.versioned.cci.v2.KeyToPath objects

+

items If unspecified, each key-value pair in the Data field of

+

the referenced Secret will be projected into the volume as a file whose

+

name is the key and content is the value. If specified, the listed keys

+

will be projected into the specified paths, and unlisted keys will not be

+

present. If a key is specified which is not present in the Secret, the volume

+

setup will error unless it is marked optional. Paths must be relative and

+

may not contain the '..' path or start with '..'.

+

optional

+

Boolean

+

optional field specify whether the Secret or its keys must be

+

defined

+

secretName

+

String

+

secretName is the name of the secret in the pod's namespace to use. More info: https://kubernetes.io/docs/concepts/storage/volumes#secret

+
+
+ +
+ + + + + + + + + + + + + + + + + +
Table 143 io.cci.otc.api.pkg.apis.versioned.cci.v2.KeyToPath

Parameter

+

Type

+

Description

+

key

+

String

+

key is the key to project.

+

mode

+

Integer

+

mode is Optional: mode bits used to set permissions on this file. Must be an octal value between 0000 and 0777 or a decimal value between 0 and 511. YAML accepts both octal and decimal values, JSON requires decimal values for mode bits. If not specified, the volume defaultMode will be used. This might be in conflict with other options that affect the file mode, like fsGroup, and the result can be other mode bits set.

+

path

+

String

+

path is the relative path of the file to map the key to. May

+

not be an absolute path. May not contain the path element '..'. May not

+

start with the string '..'.

+
+
+ +
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Table 144 io.cci.otc.api.pkg.apis.versioned.cci.v2.PodStatus

Parameter

+

Type

+

Description

+

conditions

+

Array of io.cci.otc.api.pkg.apis.versioned.cci.v2.PodCondition objects

+

Current service state of pod. More info: https://kubernetes.io/docs/concepts/workloads/pods/pod-lifecycle#pod-conditions

+

containerStatuses

+

Array of io.cci.otc.api.pkg.apis.versioned.cci.v2.ContainerStatus objects

+

The list has one entry per container in the manifest. More info: https://kubernetes.io/docs/concepts/workloads/pods/pod-lifecycle#pod-and-container-status

+

ephemeralContainerStatuses

+

Array of io.cci.otc.api.pkg.apis.versioned.cci.v2.ContainerStatus objects

+

Status for any ephemeral containers that have run in this pod.

+

hostIP

+

String

+

IP address of the host to which the pod is assigned. Empty if

+

not yet scheduled.

+

initContainerStatuses

+

Array of io.cci.otc.api.pkg.apis.versioned.cci.v2.ContainerStatus objects

+

The list has one entry per init container in the manifest. The most recent successful init container will have ready = true, the most recently started container will have startTime set. More info: https://kubernetes.io/docs/concepts/workloads/pods/pod-lifecycle#pod-and-container-status

+

message

+

String

+

A human readable message indicating details about why the pod

+

is in this condition.

+

nominatedNodeName

+

String

+

nominatedNodeName is set only when this pod preempts other pods

+

on the node, but it cannot be scheduled right away as preemption victims

+

receive their graceful termination periods. This field does not guarantee

+

that the pod will be scheduled on this node. Scheduler may decide to place

+

the pod elsewhere if other nodes become available sooner. Scheduler may

+

also decide to give the resources on this node to a higher priority pod

+

that is created after preemption. As a result, this field may be different

+

than PodSpec.nodeName when the pod is scheduled.

+

phase

+

String

+

The phase of a Pod is a simple, high-level summary of where the Pod is in its lifecycle. The conditions array, the reason and message fields, and the individual container status arrays contain more detail about the pod's status. There are five possible phase values:

+

Pending: The pod has been accepted by the Kubernetes system, but one or more of the container images has not been created. This includes time before being scheduled as well as time spent downloading images over the network, which could take a while. Running: The pod has been bound to a node, and all of the containers have been created. At least one container is still running, or is in the process of starting or restarting. Succeeded: All containers in the pod have terminated in success, and will not be restarted. Failed: All containers in the pod have terminated, and at least one container has terminated in failure. The container either exited with non-zero status or was terminated by the system. Unknown: For some reason the state of the pod could not be obtained, typically due to an error in communicating with the host of the pod.

+

More info: https://kubernetes.io/docs/concepts/workloads/pods/pod-lifecycle#pod-phase

+

Possible enum values:

+
  • "Failed" means that all containers in the pod have terminated, and at least one container has terminated in a failure (exited with a non-zero exit code or was stopped by the system).
  • "Pending" means the pod has been accepted by the system, but one or more of the containers has not been started. This includes time before being bound to a node, as well as time spent pulling images onto the host.
  • "Running" means the pod has been bound to a node and all of the containers have been started. At least one container is still running or is in the process of being restarted.
  • "Succeeded" means that all containers in the pod have voluntarily terminated with a container exit code of 0, and the system is not going to restart any of these containers.
  • "Unknown" means that for some reason the state of the pod could not be obtained, typically due to an error in communicating with the host of the pod. Deprecated: It isn't being set since 2015 (74da3b14b0c0f658b3bb8d2def5094686d0e9095)
+

podIP

+

String

+

IP address allocated to the pod. Routable at least within the

+

cluster. Empty if not yet allocated.

+

podIPs

+

Array of io.cci.otc.api.pkg.apis.versioned.cci.v2.PodIP objects

+

podIPs holds the IP addresses allocated to the pod. If this field

+

is specified, the 0th entry must match the podIP field. Pods may be allocated

+

at most 1 value for each of IPv4 and IPv6. This list is empty if no IPs

+

have been allocated yet.

+

qosClass

+

String

+

The Quality of Service (QOS) classification assigned to the pod based on resource requirements See PodQOSClass type for available QOS classes More info: https://git.k8s.io/community/contributors/design-proposals/node/resource-qos.md

+

Possible enum values:

+
  • "BestEffort" is the BestEffort qos class.
  • "Burstable" is the Burstable qos class.
  • "Guaranteed" is the Guaranteed qos class.
+

reason

+

String

+

A brief CamelCase message indicating details about why the pod

+

is in this state. e.g. 'Evicted'

+

startTime

+

String

+

RFC 3339 date and time at which the object was acknowledged by

+

the Kubelet. This is before the Kubelet pulled the container image(s) for

+

the pod.

+
+
+ +
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Table 145 io.cci.otc.api.pkg.apis.versioned.cci.v2.PodCondition

Parameter

+

Type

+

Description

+

lastProbeTime

+

String

+

Last time we probed the condition.

+

lastTransitionTime

+

String

+

Last time the condition transitioned from one status to another.

+

message

+

String

+

Human-readable message indicating details about last transition.

+

reason

+

String

+

Unique, one-word, CamelCase reason for the condition's last transition.

+

status

+

String

+

Status is the status of the condition. Can be True, False, Unknown. More info: https://kubernetes.io/docs/concepts/workloads/pods/pod-lifecycle#pod-conditions

+

type

+

String

+

Type is the type of the condition. More info: https://kubernetes.io/docs/concepts/workloads/pods/pod-lifecycle#pod-conditions

+
+
+ +
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Table 146 io.cci.otc.api.pkg.apis.versioned.cci.v2.ContainerStatus

Parameter

+

Type

+

Description

+

containerID

+

String

+

Container's ID in the format '[/topic/body/section/table/tgroup/tbody/row/entry/p/br {""}) (br]://<container_id>'.

+

image

+

String

+

The image the container is running. More info: https://kubernetes.io/docs/concepts/containers/images.

+

imageID

+

String

+

ImageID of the container's image.

+

lastState

+

io.cci.otc.api.pkg.apis.versioned.cci.v2.ContainerState object

+

Details about the container's last termination condition.

+

name

+

String

+

This must be a DNS_LABEL. Each container in a pod must have a

+

unique name. Cannot be updated.

+

ready

+

Boolean

+

Specifies whether the container has passed its readiness probe.

+

restartCount

+

Integer

+

The number of times the container has been restarted.

+

started

+

Boolean

+

Specifies whether the container has passed its startup probe.

+

Initialized as false, becomes true after startupProbe is considered successful.

+

Resets to false when the container is restarted, or if kubelet loses state

+

temporarily. Is always true when no startupProbe is defined.

+

state

+

io.cci.otc.api.pkg.apis.versioned.cci.v2.ContainerState object

+

Details about the container's current condition.

+
+
+ +
+ + + + + + + + + + + + + + + + + +
Table 147 io.cci.otc.api.pkg.apis.versioned.cci.v2.ContainerState

Parameter

+

Type

+

Description

+

running

+

io.cci.otc.api.pkg.apis.versioned.cci.v2.ContainerStateRunning object

+

Details about a running container

+

terminated

+

io.cci.otc.api.pkg.apis.versioned.cci.v2.ContainerStateTerminated object

+

Details about a terminated container

+

waiting

+

io.cci.otc.api.pkg.apis.versioned.cci.v2.ContainerStateWaiting object

+

Details about a waiting container

+
+
+ +
+ + + + + + + + + +
Table 148 io.cci.otc.api.pkg.apis.versioned.cci.v2.ContainerStateRunning

Parameter

+

Type

+

Description

+

startedAt

+

String

+

Time at which the container was last (re-)started

+
+
+ +
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Table 149 io.cci.otc.api.pkg.apis.versioned.cci.v2.ContainerStateTerminated

Parameter

+

Type

+

Description

+

containerID

+

String

+

Container's ID in the format '[/topic/body/section/table/tgroup/tbody/row/entry/p/br {""}) (br]://<container_id>'

+

exitCode

+

Integer

+

Exit status from the last termination of the container

+

finishedAt

+

String

+

Time at which the container last terminated

+

message

+

String

+

Message regarding the last termination of the container

+

reason

+

String

+

(brief) reason from the last termination of the container

+

signal

+

Integer

+

Signal from the last termination of the container

+

startedAt

+

String

+

Time at which previous execution of the container started

+
+
+ +
+ + + + + + + + + + + + + +
Table 150 io.cci.otc.api.pkg.apis.versioned.cci.v2.ContainerStateWaiting

Parameter

+

Type

+

Description

+

message

+

String

+

Message regarding why the container is not yet running.

+

reason

+

String

+

(brief) reason the container is not yet running.

+
+
+ +
+ + + + + + + + + +
Table 151 io.cci.otc.api.pkg.apis.versioned.cci.v2.PodIP

Parameter

+

Type

+

Description

+

ip

+

String

+

ip is an IP address (IPv4 or IPv6) assigned to the pod

+
+
+
+

Example Requests

None

+
+

Example Responses

Status code: 200

+

OK

+
{
+  "apiVersion" : "cci/v2",
+  "kind" : "Pod",
+  "metadata" : {
+    "annotations" : {
+      "cni.yangtse.io/network-status" : "[{\"macAddress\":\"fa:16:3e:1d:75:3a\",\"ipv4Info\":{\"subnet\":\"192.168.0.0/24\",\"ipAddress\":\"192.168.0.197\",\"gateway\":\"192.168.0.1\"},\"name\":\"test-api\",\"portID\":\"b471658c-caac-4377-94f4-2eeff1192d2b\",\"ips\":[\"192.168.0.197\"],\"vlanID\":3687}]",
+      "networking.cci.io/vm-network-info" : "{\"vmID\":\"fda21659-a816-4449-abcf-193ac5a47b4a\",\"eniID\":\"ec9f8fae-ae74-445b-b8bb-b533e5342dbd\",\"maxEniNum\":2,\"maxSubEniNum\":16}",
+      "openvessel.io/monitoring-aominfo" : "08a2*************************c03:4257ecf3-7c47-43a3-86d2-d2b4d4aa3a20",
+      "resource.cci.io/pod-size-specs" : "2.00_4.0",
+      "resource.cci.io/size" : "2.00_4.0",
+      "scheduling.k8s.io/group-name" : "podgroup-ade5799e-9371-4c9f-ab77-0472e97211f8",
+      "tenant.cci.io/tenant-id" : "08a2*************************c03",
+      "topology.kubernetes.io/region" : "region1",
+      "topology.kubernetes.io/zone" : "region1c"
+    },
+    "creationTimestamp" : "2024-10-09T16:11:23Z",
+    "deletionGracePeriodSeconds" : 30,
+    "deletionTimestamp" : "2024-10-09T17:07:39Z",
+    "finalizers" : [ "billing.kubernetes.io/podbilling-finalizer" ],
+    "labels" : {
+      "scheduling.cci.io/vmid" : "fda21659-a816-4449-abcf-193ac5a47b4a",
+      "sys_enterprise_project_id" : "0",
+      "tenant.cci.io/tenant-id" : "08a2*************************c03",
+      "tenant.kubernetes.io/domain-id" : "08a*************************ee60",
+      "tenant.kubernetes.io/project-id" : "08a2*************************c03",
+      "test-label-key" : "test-label-value"
+    },
+    "name" : "test",
+    "namespace" : "test-api",
+    "resourceVersion" : "391112739",
+    "uid" : "ade5799e-9371-4c9f-ab77-0472e97211f8"
+  },
+  "spec" : {
+    "containers" : [ {
+      "env" : [ {
+        "name" : "ENV1",
+        "value" : "false"
+      }, {
+        "name" : "ENV2",
+        "value" : "xxx"
+      } ],
+      "image" : "nginx:latest",
+      "name" : "deploy-example",
+      "resources" : {
+        "limits" : {
+          "cpu" : "500m",
+          "memory" : "1Gi"
+        },
+        "requests" : {
+          "cpu" : "500m",
+          "memory" : "1Gi"
+        }
+      },
+      "terminationMessagePath" : "/dev/termination-log",
+      "terminationMessagePolicy" : "File"
+    } ],
+    "dnsPolicy" : "Default",
+    "imagePullSecrets" : [ {
+      "name" : "imagepull-secret"
+    } ],
+    "nodeName" : "compute-cell-001",
+    "restartPolicy" : "Always",
+    "schedulerName" : "volcano",
+    "securityContext" : { },
+    "terminationGracePeriodSeconds" : 30
+  },
+  "status" : {
+    "conditions" : [ {
+      "lastProbeTime" : null,
+      "lastTransitionTime" : "2024-10-09T16:11:24Z",
+      "status" : "True",
+      "type" : "Initialized"
+    }, {
+      "lastProbeTime" : null,
+      "lastTransitionTime" : "2024-10-09T16:11:28Z",
+      "status" : "True",
+      "type" : "Ready"
+    }, {
+      "lastProbeTime" : null,
+      "lastTransitionTime" : "2024-10-09T16:11:28Z",
+      "status" : "True",
+      "type" : "ContainersReady"
+    }, {
+      "lastProbeTime" : null,
+      "lastTransitionTime" : "2024-10-09T16:11:23Z",
+      "status" : "True",
+      "type" : "PodScheduled"
+    } ],
+    "containerStatuses" : [ {
+      "containerID" : "containerd://a44eef6b753babaff802d212e78afef2422959e90bd79ab5b385adb302aa3d1e",
+      "image" : "nginx:latest",
+      "imageID" : "docker.io/library/nginx@sha256:416d511ffa63777489af47f250b70d1570e428b67666567085f2bece3571ad83",
+      "lastState" : { },
+      "name" : "deploy-example",
+      "ready" : true,
+      "restartCount" : 0,
+      "started" : true,
+      "state" : {
+        "running" : {
+          "startedAt" : "2024-10-09T16:11:27Z"
+        }
+      }
+    } ],
+    "phase" : "Running",
+    "podIP" : "192.168.0.197",
+    "podIPs" : [ {
+      "ip" : "192.168.0.197"
+    } ],
+    "qosClass" : "Guaranteed",
+    "startTime" : "2024-10-09T16:11:24Z"
+  }
+}
+
+

Status Codes

+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +

Status Code

+

Description

+

200

+

OK

+

202

+

Accepted

+

400

+

BadRequest

+

401

+

Unauthorized

+

403

+

Forbidden

+

404

+

NotFound

+

405

+

MethodNotAllowed

+

406

+

NotAcceptable

+

409

+

Conflict

+

415

+

UnsupportedMediaType

+

422

+

Invalid

+

429

+

TooManyRequests

+

500

+

InternalError

+

503

+

ServiceUnavailable

+

504

+

ServerTimeout

+
+
+
+
+
+
+
Parent topic: Proprietary APIs
+
+
+ diff --git a/docs/cci/api-ref/deleteCciV2NamespacedSecret.html b/docs/cci/api-ref/deleteCciV2NamespacedSecret.html new file mode 100644 index 00000000..6f0e06f7 --- /dev/null +++ b/docs/cci/api-ref/deleteCciV2NamespacedSecret.html @@ -0,0 +1,821 @@ + + +

Deleting a Secret

+

Function

Delete a Secret.

+
+

Calling Method

For details, see Calling APIs.

+
+

URI

DELETE /apis/cci/v2/namespaces/{namespace}/secrets/{name}

+ +
+ + + + + + + + + + + + + + + + +
Table 1 Path Parameters

Parameter

+

Mandatory

+

Type

+

Description

+

name

+

Yes

+

String

+

name of the Secret

+

namespace

+

Yes

+

String

+

Object name and auth scope, such as for teams and projects.

+
+
+ +
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Table 2 Query Parameters

Parameter

+

Mandatory

+

Type

+

Description

+

dryRun

+

No

+

String

+

When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed

+

gracePeriodSeconds

+

No

+

Integer

+

The duration in seconds before the object should be deleted.

+

Value must be non-negative integer. The value zero indicates delete immediately.

+

If this value is nil, the default grace period for the specified type will

+

be used. Defaults to a per object value if not specified. zero means delete

+

immediately.

+

orphanDependents

+

No

+

Boolean

+

Deprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the "orphan" finalizer will be added to/removed from the object's finalizers list. Either this field or PropagationPolicy may be set, but not both.

+

propagationPolicy

+

No

+

String

+

Whether and how garbage collection will be performed. Either this field or OrphanDependents may be set, but not both. The default policy is decided by the existing finalizer set in the metadata.finalizers and the resource-specific default policy. Acceptable values are: 'Orphan' - orphan the dependents; 'Background' - allow the garbage collector to delete the dependents in the background; 'Foreground' - a cascading policy that deletes all dependents in the foreground.

+

pretty

+

No

+

String

+

If 'true', then the output is pretty printed.

+
+
+
+

Request Parameters

+
+ + + + + + + + + + + + + + + + +
Table 3 Request header parameters

Parameter

+

Mandatory

+

Type

+

Description

+

X-Auth-Token

+

Yes

+

String

+

User token.

+

It can be obtained through the IAM API used to obtain a user token. The value of X-Subject-Token in the response header is the user token.

+

Content-Type

+

Yes

+

String

+

The type of the message body, with a default value of "application/JSON".

+
+
+ +
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Table 4 Request body parameters

Parameter

+

Mandatory

+

Type

+

Description

+

apiVersion

+

No

+

String

+

APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#resources

+

dryRun

+

No

+

Array of strings

+

When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed

+

gracePeriodSeconds

+

No

+

Long

+

The duration in seconds before the object should be deleted.

+

Value must be non-negative integer. The value zero indicates delete immediately.

+

If this value is nil, the default grace period for the specified type will

+

be used. Defaults to a per object value if not specified. zero means delete

+

immediately.

+

kind

+

No

+

String

+

Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds

+

orphanDependents

+

No

+

Boolean

+

Deprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the "orphan" finalizer will be added to/removed from the object's finalizers list. Either this field or PropagationPolicy may be set, but not both.

+

preconditions

+

No

+

io.k8s.apimachinery.pkg.apis.meta.v1.Preconditions object

+

Must be fulfilled before a deletion is carried out. If not possible,

+

a 409 Conflict status will be returned.

+

propagationPolicy

+

No

+

String

+

Whether and how garbage collection will be performed. Either this field or OrphanDependents may be set, but not both. The default policy is decided by the existing finalizer set in the metadata.finalizers and the resource-specific default policy. Acceptable values are: 'Orphan' - orphan the dependents; 'Background' - allow the garbage collector to delete the dependents in the background; 'Foreground' - a cascading policy that deletes all dependents in the foreground.

+
+
+ +
+ + + + + + + + + + + + + + + + +
Table 5 io.k8s.apimachinery.pkg.apis.meta.v1.Preconditions

Parameter

+

Mandatory

+

Type

+

Description

+

resourceVersion

+

No

+

String

+

Specifies the target ResourceVersion

+

uid

+

No

+

String

+

Specifies the target UID.

+
+
+
+

Response Parameters

Status code: 200

+ +
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Table 6 Response body parameters

Parameter

+

Type

+

Description

+

apiVersion

+

String

+

APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#resources

+

code

+

Integer

+

Suggested HTTP return code for this status, 0 if not set.

+

details

+

io.k8s.apimachinery.pkg.apis.meta.v1.StatusDetails object

+

Extended data associated with the reason. Each reason may define

+

its own extended details. This field is optional and the data returned is

+

not guaranteed to conform to any schema except that defined by the reason

+

type.

+

kind

+

String

+

Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds

+

message

+

String

+

A human-readable description of the status of this operation.

+

metadata

+

io.k8s.apimachinery.pkg.apis.meta.v1.ListMeta object

+

Standard list metadata. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds

+

reason

+

String

+

A machine-readable description of why this operation is in the

+

"Failure" status. If this value is empty there is no information available.

+

A Reason clarifies an HTTP status code but does not override it.

+

status

+

String

+

Status of the operation. One of: "Success" or "Failure". More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#spec-and-status

+
+
+ +
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Table 7 io.k8s.apimachinery.pkg.apis.meta.v1.StatusDetails

Parameter

+

Type

+

Description

+

causes

+

Array of io.k8s.apimachinery.pkg.apis.meta.v1.StatusCause objects

+

The Causes array includes more details associated with the StatusReason

+

failure. Not all StatusReasons may provide detailed causes.

+

group

+

String

+

The group attribute of the resource associated with the status

+

StatusReason.

+

kind

+

String

+

The kind attribute of the resource associated with the status StatusReason. On some operations may differ from the requested resource Kind. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds

+

name

+

String

+

The name attribute of the resource associated with the status

+

StatusReason (when there is a single name which can be described).

+

retryAfterSeconds

+

Integer

+

If specified, the time in seconds before the operation should

+

be retried. Some errors may indicate the client must take an alternate action

+
  • for those errors this field may indicate how long to wait before taking

    the alternate action.

    +
+

uid

+

String

+

UID of the resource. (when there is a single resource which can be described). More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#uids

+
+
+ +
+ + + + + + + + + + + + + + + + + +
Table 8 io.k8s.apimachinery.pkg.apis.meta.v1.StatusCause

Parameter

+

Type

+

Description

+

field

+

String

+

The field of the resource that has caused this error, as named by its JSON serialization. May include dot and postfix notation for nested attributes. Arrays are zero-indexed. Fields may appear more than once in an array of causes due to fields having multiple errors. Optional.

+

Examples:

+

"name" - the field "name" on the current resource

+

"items[0].name" - the field "name" on the first array entry in "items"

+

message

+

String

+

A human-readable description of the cause of the error. This

+

field may be presented as-is to a reader.

+

reason

+

String

+

A machine-readable description of the cause of the error. If

+

this value is empty there is no information available.

+
+
+ +
+ + + + + + + + + + + + + + + + + + + + + +
Table 9 io.k8s.apimachinery.pkg.apis.meta.v1.ListMeta

Parameter

+

Type

+

Description

+

continue

+

String

+

continue may be set if the user set a limit on the number of

+

items returned, and indicates that the server has more data available. The

+

value is opaque and may be used to issue another request to the endpoint

+

that served this list to retrieve the next set of available objects. Continuing

+

a consistent list may not be possible if the server configuration has changed

+

or more than a few minutes have passed. The resourceVersion field returned

+

when using this continue value will be identical to the value in the first

+

response, unless you have received this token from an error message.

+

remainingItemCount

+

Long

+

remainingItemCount is the number of subsequent items in the list

+

which are not included in this list response. If the list request contained

+

label or field selectors, then the number of remaining items is unknown

+

and the field will be left unset and omitted during serialization. If the

+

list is complete (either because it is not chunking or because this is the

+

last chunk), then there are no more remaining items and this field will

+

be left unset and omitted during serialization. Servers older than v1.15

+

do not set this field. The intended use of the remainingItemCount is estimating

+

the size of a collection. Clients should not rely on the remainingItemCount

+

to be set or to be exact.

+

resourceVersion

+

String

+

String that identifies the server's internal version of this object that can be used by clients to determine when objects have changed. Value must be treated as opaque by clients and passed unmodified back to the server. Populated by the system. Read-only. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#concurrency-control-and-consistency

+

selfLink

+

String

+

selfLink is a URL representing this object. Populated by the system. Read-only.

+

DEPRECATED Kubernetes will stop propagating this field in 1.20 release and the field is planned to be removed in 1.21 release.

+
+
+

Status code: 202

+ +
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Table 10 Response body parameters

Parameter

+

Type

+

Description

+

apiVersion

+

String

+

APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#resources

+

code

+

Integer

+

Suggested HTTP return code for this status, 0 if not set.

+

details

+

io.k8s.apimachinery.pkg.apis.meta.v1.StatusDetails object

+

Extended data associated with the reason. Each reason may define

+

its own extended details. This field is optional and the data returned is

+

not guaranteed to conform to any schema except that defined by the reason

+

type.

+

kind

+

String

+

Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds

+

message

+

String

+

A human-readable description of the status of this operation.

+

metadata

+

io.k8s.apimachinery.pkg.apis.meta.v1.ListMeta object

+

Standard list metadata. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds

+

reason

+

String

+

A machine-readable description of why this operation is in the

+

"Failure" status. If this value is empty there is no information available.

+

A Reason clarifies an HTTP status code but does not override it.

+

status

+

String

+

Status of the operation. One of: "Success" or "Failure". More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#spec-and-status

+
+
+ +
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Table 11 io.k8s.apimachinery.pkg.apis.meta.v1.StatusDetails

Parameter

+

Type

+

Description

+

causes

+

Array of io.k8s.apimachinery.pkg.apis.meta.v1.StatusCause objects

+

The Causes array includes more details associated with the StatusReason

+

failure. Not all StatusReasons may provide detailed causes.

+

group

+

String

+

The group attribute of the resource associated with the status

+

StatusReason.

+

kind

+

String

+

The kind attribute of the resource associated with the status StatusReason. On some operations may differ from the requested resource Kind. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds

+

name

+

String

+

The name attribute of the resource associated with the status

+

StatusReason (when there is a single name which can be described).

+

retryAfterSeconds

+

Integer

+

If specified, the time in seconds before the operation should

+

be retried. Some errors may indicate the client must take an alternate action

+
  • for those errors this field may indicate how long to wait before taking

    the alternate action.

    +
+

uid

+

String

+

UID of the resource. (when there is a single resource which can be described). More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#uids

+
+
+ +
+ + + + + + + + + + + + + + + + + +
Table 12 io.k8s.apimachinery.pkg.apis.meta.v1.StatusCause

Parameter

+

Type

+

Description

+

field

+

String

+

The field of the resource that has caused this error, as named by its JSON serialization. May include dot and postfix notation for nested attributes. Arrays are zero-indexed. Fields may appear more than once in an array of causes due to fields having multiple errors. Optional.

+

Examples:

+

"name" - the field "name" on the current resource

+

"items[0].name" - the field "name" on the first array entry in "items"

+

message

+

String

+

A human-readable description of the cause of the error. This

+

field may be presented as-is to a reader.

+

reason

+

String

+

A machine-readable description of the cause of the error. If

+

this value is empty there is no information available.

+
+
+ +
+ + + + + + + + + + + + + + + + + + + + + +
Table 13 io.k8s.apimachinery.pkg.apis.meta.v1.ListMeta

Parameter

+

Type

+

Description

+

continue

+

String

+

continue may be set if the user set a limit on the number of

+

items returned, and indicates that the server has more data available. The

+

value is opaque and may be used to issue another request to the endpoint

+

that served this list to retrieve the next set of available objects. Continuing

+

a consistent list may not be possible if the server configuration has changed

+

or more than a few minutes have passed. The resourceVersion field returned

+

when using this continue value will be identical to the value in the first

+

response, unless you have received this token from an error message.

+

remainingItemCount

+

Long

+

remainingItemCount is the number of subsequent items in the list

+

which are not included in this list response. If the list request contained

+

label or field selectors, then the number of remaining items is unknown

+

and the field will be left unset and omitted during serialization. If the

+

list is complete (either because it is not chunking or because this is the

+

last chunk), then there are no more remaining items and this field will

+

be left unset and omitted during serialization. Servers older than v1.15

+

do not set this field. The intended use of the remainingItemCount is estimating

+

the size of a collection. Clients should not rely on the remainingItemCount

+

to be set or to be exact.

+

resourceVersion

+

String

+

String that identifies the server's internal version of this object that can be used by clients to determine when objects have changed. Value must be treated as opaque by clients and passed unmodified back to the server. Populated by the system. Read-only. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#concurrency-control-and-consistency

+

selfLink

+

String

+

selfLink is a URL representing this object. Populated by the system. Read-only.

+

DEPRECATED Kubernetes will stop propagating this field in 1.20 release and the field is planned to be removed in 1.21 release.

+
+
+
+

Example Requests

None

+
+

Example Responses

Status code: 200

+

OK

+
{
+  "apiVersion" : "v1",
+  "details" : {
+    "group" : "cci",
+    "kind" : "secrets",
+    "name" : "test-secret",
+    "uid" : "77d8dedc-b7ae-40a1-b9a6-6f37cca2c4d1"
+  },
+  "kind" : "Status",
+  "metadata" : { },
+  "status" : "Success"
+}
+
+

Status Codes

+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +

Status Code

+

Description

+

200

+

OK

+

202

+

Accepted

+

400

+

BadRequest

+

401

+

Unauthorized

+

403

+

Forbidden

+

404

+

NotFound

+

405

+

MethodNotAllowed

+

406

+

NotAcceptable

+

409

+

Conflict

+

415

+

UnsupportedMediaType

+

422

+

Invalid

+

429

+

TooManyRequests

+

500

+

InternalError

+

503

+

ServiceUnavailable

+

504

+

ServerTimeout

+
+
+
+
+
+
+
Parent topic: Proprietary APIs
+
+
+ diff --git a/docs/cci/api-ref/deleteYangtseV2NamespacedNetwork.html b/docs/cci/api-ref/deleteYangtseV2NamespacedNetwork.html new file mode 100644 index 00000000..40457c14 --- /dev/null +++ b/docs/cci/api-ref/deleteYangtseV2NamespacedNetwork.html @@ -0,0 +1,796 @@ + + +

Deleting a Network

+

Function

Delete a Network.

+
+

Calling Method

For details, see Calling APIs.

+
+

URI

DELETE /apis/yangtse/v2/namespaces/{namespace}/networks/{name}

+ +
+ + + + + + + + + + + + + + + + +
Table 1 Path Parameters

Parameter

+

Mandatory

+

Type

+

Description

+

name

+

Yes

+

String

+

Name of the Network.

+

namespace

+

Yes

+

String

+

Object name and auth scope, such as for teams and projects.

+
+
+ +
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Table 2 Query Parameters

Parameter

+

Mandatory

+

Type

+

Description

+

dryRun

+

No

+

String

+

When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed

+

gracePeriodSeconds

+

No

+

Integer

+

The duration in seconds before the object should be deleted.

+

Value must be non-negative integer. The value zero indicates delete immediately.

+

If this value is nil, the default grace period for the specified type will be used. Defaults to a per object value if not specified. zero means delete immediately.

+

orphanDependents

+

No

+

Boolean

+

Deprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the "orphan" finalizer will be added to/removed from the object's finalizers list. Either this field or PropagationPolicy may be set, but not both.

+

propagationPolicy

+

No

+

String

+

Whether and how garbage collection will be performed. Either this field or OrphanDependents may be set, but not both. The default policy is decided by the existing finalizer set in the metadata.finalizers and the resource-specific default policy. Acceptable values are: 'Orphan' - orphan the dependents; 'Background' - allow the garbage collector to delete the dependents in the background; 'Foreground' - a cascading policy that deletes all dependents in the foreground.

+

pretty

+

No

+

String

+

If 'true', then the output is pretty printed.

+
+
+
+

Request Parameters

+
+ + + + + + + + + + + + + + + + +
Table 3 Request header parameters

Parameter

+

Mandatory

+

Type

+

Description

+

X-Auth-Token

+

Yes

+

String

+

User token.

+

It can be obtained through the IAM API used to obtain a user token. The value of X-Subject-Token in the response header is the user token.

+

Content-Type

+

Yes

+

String

+

The type of the message body, with a default value of "application/JSON".

+
+
+ +
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Table 4 Request body parameters

Parameter

+

Mandatory

+

Type

+

Description

+

apiVersion

+

No

+

String

+

APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#resources

+

dryRun

+

No

+

Array of strings

+

When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed

+

gracePeriodSeconds

+

No

+

Long

+

The duration in seconds before the object should be deleted.

+

Value must be non-negative integer. The value zero indicates delete immediately.

+

If this value is nil, the default grace period for the specified type will be used. Defaults to a per object value if not specified. zero means delete immediately.

+

kind

+

No

+

String

+

Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds

+

orphanDependents

+

No

+

Boolean

+

Deprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the "orphan" finalizer will be added to/removed from the object's finalizers list. Either this field or PropagationPolicy may be set, but not both.

+

preconditions

+

No

+

io.k8s.apimachinery.pkg.apis.meta.v1.Preconditions object

+

Must be fulfilled before a deletion is carried out. If not possible, a 409 Conflict status will be returned.

+

propagationPolicy

+

No

+

String

+

Whether and how garbage collection will be performed. Either this field or OrphanDependents may be set, but not both. The default policy is decided by the existing finalizer set in the metadata.finalizers and the resource-specific default policy. Acceptable values are: 'Orphan' - orphan the dependents; 'Background' - allow the garbage collector to delete the dependents in the background; 'Foreground' - a cascading policy that deletes all dependents in the foreground.

+
+
+ +
+ + + + + + + + + + + + + + + + +
Table 5 io.k8s.apimachinery.pkg.apis.meta.v1.Preconditions

Parameter

+

Mandatory

+

Type

+

Description

+

resourceVersion

+

No

+

String

+

Specifies the target ResourceVersion.

+

uid

+

No

+

String

+

Specifies the target UID.

+
+
+
+

Response Parameters

Status code: 200

+ +
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Table 6 Response body parameters

Parameter

+

Type

+

Description

+

apiVersion

+

String

+

APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#resources

+

code

+

Integer

+

Suggested HTTP return code for this status, 0 if not set.

+

details

+

io.k8s.apimachinery.pkg.apis.meta.v1.StatusDetails object

+

Extended data associated with the reason. Each reason may define its own extended details. This field is optional and the data returned is not guaranteed to conform to any schema except that defined by the reason type.

+

+

kind

+

String

+

Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds

+

message

+

String

+

A human-readable description of the status of this operation.

+

metadata

+

io.k8s.apimachinery.pkg.apis.meta.v1.ListMeta object

+

Standard list metadata. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds

+

reason

+

String

+

A machine-readable description of why this operation is in the "Failure" status. If this value is empty there is no information available.

+

A Reason clarifies an HTTP status code but does not override it.

+

status

+

String

+

Status of the operation. One of: "Success" or "Failure". More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#spec-and-status

+
+
+ +
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Table 7 io.k8s.apimachinery.pkg.apis.meta.v1.StatusDetails

Parameter

+

Type

+

Description

+

causes

+

Array of io.k8s.apimachinery.pkg.apis.meta.v1.StatusCause objects

+

The Causes array includes more details associated with the StatusReason failure. Not all StatusReasons may provide detailed causes.

+

group

+

String

+

The group attribute of the resource associated with the status StatusReason.

+

kind

+

String

+

The kind attribute of the resource associated with the status StatusReason. On some operations may differ from the requested resource Kind. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds

+

name

+

String

+

The name attribute of the resource associated with the status StatusReason (when there is a single name which can be described).

+

retryAfterSeconds

+

Integer

+

If specified, the time in seconds before the operation should

+

be retried. Some errors may indicate the client must take an alternate action

+
  • for those errors this field may indicate how long to wait before taking

    the alternate action.

    +
+

uid

+

String

+

UID of the resource. (when there is a single resource which can be described). More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#uids

+
+
+ +
+ + + + + + + + + + + + + + + + + +
Table 8 io.k8s.apimachinery.pkg.apis.meta.v1.StatusCause

Parameter

+

Type

+

Description

+

field

+

String

+

The field of the resource that has caused this error, as named by its JSON serialization. May include dot and postfix notation for nested attributes. Arrays are zero-indexed. Fields may appear more than once in an array of causes due to fields having multiple errors. Optional.

+

Examples:

+

"name" - the field "name" on the current resource

+

"items[0].name" - the field "name" on the first array entry in "items"

+

message

+

String

+

A human-readable description of the cause of the error. This field may be presented as-is to a reader.

+

reason

+

String

+

A machine-readable description of the cause of the error. If this value is empty there is no information available.

+
+
+ +
+ + + + + + + + + + + + + + + + + + + + + +
Table 9 io.k8s.apimachinery.pkg.apis.meta.v1.ListMeta

Parameter

+

Type

+

Description

+

continue

+

String

+

continue may be set if the user set a limit on the number of items returned, and indicates that the server has more data available. The value is opaque and may be used to issue another request to the endpoint that served this list to retrieve the next set of available objects. Continuing a consistent list may not be possible if the server configuration has changed or more than a few minutes have passed. The resourceVersion field returned when using this continue value will be identical to the value in the first response, unless you have received this token from an error message.

+

remainingItemCount

+

Long

+

remainingItemCount is the number of subsequent items in the list which are not included in this list response. If the list request contained label or field selectors, then the number of remaining items is unknown and the field will be left unset and omitted during serialization. If the list is complete (either because it is not chunking or because this is the last chunk), then there are no more remaining items and this field will be left unset and omitted during serialization. Servers older than v1.15do not set this field. The intended use of the remainingItemCount is estimating the size of a collection. Clients should not rely on the remainingItemCount to be set or to be exact.

+

resourceVersion

+

String

+

String that identifies the server's internal version of this object that can be used by clients to determine when objects have changed. Value must be treated as opaque by clients and passed unmodified back to the server. Populated by the system. Read-only. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#concurrency-control-and-consistency

+

selfLink

+

String

+

selfLink is a URL representing this object. Populated by the system. Read-only.

+

DEPRECATED Kubernetes will stop propagating this field in 1.20 release and the field is planned to be removed in 1.21 release.

+
+
+

Status code: 202

+ +
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Table 10 Response body parameters

Parameter

+

Type

+

Description

+

apiVersion

+

String

+

APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#resources

+

code

+

Integer

+

Suggested HTTP return code for this status, 0 if not set.

+

details

+

io.k8s.apimachinery.pkg.apis.meta.v1.StatusDetails object

+

Extended data associated with the reason. Each reason may define its own extended details. This field is optional and the data returned is not guaranteed to conform to any schema except that defined by the reasontype.

+

kind

+

String

+

Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds

+

message

+

String

+

A human-readable description of the status of this operation.

+

metadata

+

io.k8s.apimachinery.pkg.apis.meta.v1.ListMeta object

+

Standard list metadata. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds

+

reason

+

String

+

A machine-readable description of why this operation is in the "Failure" status. If this value is empty there is no information available.

+

A Reason clarifies an HTTP status code but does not override it.

+

status

+

String

+

Status of the operation. One of: "Success" or "Failure". More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#spec-and-status

+
+
+ +
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Table 11 io.k8s.apimachinery.pkg.apis.meta.v1.StatusDetails

Parameter

+

Type

+

Description

+

causes

+

Array of io.k8s.apimachinery.pkg.apis.meta.v1.StatusCause objects

+

The Causes array includes more details associated with the StatusReason failure. Not all StatusReasons may provide detailed causes.

+

group

+

String

+

The group attribute of the resource associated with the status StatusReason.

+

kind

+

String

+

The kind attribute of the resource associated with the status StatusReason. On some operations may differ from the requested resource Kind. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds

+

name

+

String

+

The name attribute of the resource associated with the status StatusReason (when there is a single name which can be described).

+

retryAfterSeconds

+

Integer

+

If specified, the time in seconds before the operation should

+

be retried. Some errors may indicate the client must take an alternate action

+
  • for those errors this field may indicate how long to wait before taking

    the alternate action.

    +
+

uid

+

String

+

UID of the resource. (when there is a single resource which can be described). More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#uids

+
+
+ +
+ + + + + + + + + + + + + + + + + +
Table 12 io.k8s.apimachinery.pkg.apis.meta.v1.StatusCause

Parameter

+

Type

+

Description

+

field

+

String

+

The field of the resource that has caused this error, as named by its JSON serialization. May include dot and postfix notation for nested attributes. Arrays are zero-indexed. Fields may appear more than once in an array of causes due to fields having multiple errors. Optional.

+

Examples:

+

"name" - the field "name" on the current resource

+

"items[0].name" - the field "name" on the first array entry in "items"

+

message

+

String

+

A human-readable description of the cause of the error. This field may be presented as-is to a reader.

+

reason

+

String

+

A machine-readable description of the cause of the error. If this value is empty there is no information available.

+
+
+ +
+ + + + + + + + + + + + + + + + + + + + + +
Table 13 io.k8s.apimachinery.pkg.apis.meta.v1.ListMeta

Parameter

+

Type

+

Description

+

continue

+

String

+

continue may be set if the user set a limit on the number of items returned, and indicates that the server has more data available. The value is opaque and may be used to issue another request to the endpoint that served this list to retrieve the next set of available objects. Continuing a consistent list may not be possible if the server configuration has changed or more than a few minutes have passed. The resourceVersion field returned when using this continue value will be identical to the value in the first response, unless you have received this token from an error message.

+

remainingItemCount

+

Long

+

remainingItemCount is the number of subsequent items in the list which are not included in this list response. If the list request contained label or field selectors, then the number of remaining items is unknown and the field will be left unset and omitted during serialization. If the list is complete (either because it is not chunking or because this is the last chunk), then there are no more remaining items and this field will be left unset and omitted during serialization. Servers older than v1.15 do not set this field. The intended use of the remainingItemCount is estimating the size of a collection. Clients should not rely on the remainingItemCount to be set or to be exact.

+

resourceVersion

+

String

+

String that identifies the server's internal version of this object that can be used by clients to determine when objects have changed. Value must be treated as opaque by clients and passed unmodified back to the server. Populated by the system. Read-only. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#concurrency-control-and-consistency

+

selfLink

+

String

+

selfLink is a URL representing this object. Populated by the system. Read-only.

+

DEPRECATED Kubernetes will stop propagating this field in 1.20 release and the field is planned to be removed in 1.21 release.

+
+
+
+

Example Requests

None

+
+

Example Responses

Status code: 200

+

OK

+
{
+  "apiVersion" : "yangtse/v2",
+  "kind" : "Network",
+  "metadata" : {
+    "annotations" : {
+      "yangtse.io/domain-id" : "08a*************************ee60",
+      "yangtse.io/project-id" : "08a2*************************c03",
+      "yangtse.io/warm-pool-recycle-interval" : "1",
+      "yangtse.io/warm-pool-size" : "10"
+    },
+    "creationTimestamp" : "2024-10-09T17:46:14Z",
+    "deletionGracePeriodSeconds" : 0,
+    "deletionTimestamp" : "2024-10-09T17:46:52Z",
+    "finalizers" : [ "yangtse.io/network-cleanup" ],
+    "name" : "test-api",
+    "namespace" : "test-namespace",
+    "resourceVersion" : "20608419",
+    "uid" : "aa839966-6b47-4775-b8b3-c4d32a7b516c"
+  },
+  "spec" : {
+    "networkType" : "underlay_neutron",
+    "securityGroups" : [ "4120c2f9-3a1d-453e-9b64-f51b92861e26" ],
+    "subnets" : [ {
+      "subnetID" : "2eb62e19-cf1a-4741-90cc-90fb127b20ab"
+    } ]
+  },
+  "status" : {
+    "conditions" : [ {
+      "lastTransitionTime" : "2024-10-09T17:46:14Z",
+      "message" : "",
+      "reason" : "",
+      "status" : "True",
+      "type" : "NetworkSynced"
+    } ],
+    "status" : "Ready",
+    "subnetAttrs" : [ {
+      "networkID" : "377b6228-d2a7-47ab-bdb0-f7fc59802198",
+      "subnetV4ID" : "2eb62e19-cf1a-4741-90cc-90fb127b20ab"
+    } ]
+  }
+}
+
+

Status Codes

+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +

Status Code

+

Description

+

200

+

OK

+

202

+

Accepted

+

400

+

BadRequest

+

401

+

Unauthorized

+

403

+

Forbidden

+

404

+

NotFound

+

405

+

MethodNotAllowed

+

406

+

NotAcceptable

+

409

+

Conflict

+

415

+

UnsupportedMediaType

+

422

+

Invalid

+

429

+

TooManyRequests

+

500

+

InternalError

+

503

+

ServiceUnavailable

+

504

+

ServerTimeout

+
+
+
+
+
+
+
Parent topic: Proprietary APIs
+
+
+ diff --git a/docs/cci/api-ref/devg_na.html b/docs/cci/api-ref/devg_na.html new file mode 100644 index 00000000..b36810d2 --- /dev/null +++ b/docs/cci/api-ref/devg_na.html @@ -0,0 +1,18 @@ + + +

Namespace and Network

+

A namespace provides a method of allocating resources among multiple users. It applies to scenarios where multiple teams or projects exist.

+

A network is a Kubernetes resource object extended for CCI. You can associate a network with a Virtual Private Cloud (VPC) and subnet so that CCI can use network resources of the public cloud.

+

Relationship Between a Namespace and Network

A namespace corresponds to a subnet in a VPC, as shown in Figure 1. When a namespace is created, it will be associated with a VPC, and a subnet will be created under the VPC. In this namespace, resources such as pods and Services are created in the corresponding VPC and subnet, and the IP addresses in the subnet are used.

+

If you want to run resources of multiple services in the same VPC, you need to plan subnet CIDR blocks and IP addresses.

+
Figure 1 Relationship between namespaces and VPC subnets
+
+

Scenarios Where Multiple Namespaces Are Used

Because namespaces enable partial environment isolation, you can create different namespaces, such as production, test, and development namespaces based on project attributes when there are a large number of projects and persons.

+
+
+
+
+
Parent topic: Appendix
+
+
+ diff --git a/docs/cci/api-ref/en-us_image_0000001508295281.png b/docs/cci/api-ref/en-us_image_0000001508295281.png new file mode 100644 index 00000000..ec3abb85 Binary files /dev/null and b/docs/cci/api-ref/en-us_image_0000001508295281.png differ diff --git a/docs/cci/api-ref/en-us_image_0000001874007888.png b/docs/cci/api-ref/en-us_image_0000001874007888.png new file mode 100644 index 00000000..2c6b0135 Binary files /dev/null and b/docs/cci/api-ref/en-us_image_0000001874007888.png differ diff --git a/docs/cci/api-ref/en-us_image_0000001909077313.png b/docs/cci/api-ref/en-us_image_0000001909077313.png new file mode 100644 index 00000000..8f62ee3d Binary files /dev/null and b/docs/cci/api-ref/en-us_image_0000001909077313.png differ diff --git a/docs/cci/api-ref/en-us_image_0000001909236985.png b/docs/cci/api-ref/en-us_image_0000001909236985.png new file mode 100644 index 00000000..d255b44d Binary files /dev/null and b/docs/cci/api-ref/en-us_image_0000001909236985.png differ diff --git a/docs/cci/api-ref/en-us_topic_0000001991313061.html b/docs/cci/api-ref/en-us_topic_0000001991313061.html new file mode 100644 index 00000000..b43ca81a --- /dev/null +++ b/docs/cci/api-ref/en-us_topic_0000001991313061.html @@ -0,0 +1,38 @@ + + +

Change History

+
+
+ + + + + + + + + + + + + + + + +

Released On

+

What's New

+

2024-10-12

+

Modified the following:

+ +

2024-10-10

+

Modified the following:

+ +

2024-07-18

+

Modified the following:

+ +

2024-05-10

+

This issue is the first official release.

+
+
+
+ diff --git a/docs/cci/api-ref/listCciV2Namespace.html b/docs/cci/api-ref/listCciV2Namespace.html new file mode 100644 index 00000000..0a2e134b --- /dev/null +++ b/docs/cci/api-ref/listCciV2Namespace.html @@ -0,0 +1,756 @@ + + +

Listing or Watching Objects of kind Namespace

+

Function

List or watch objects of kind Namespace.

+
+

Calling Method

For details, see Calling APIs.

+
+

URI

GET /apis/cci/v2/namespaces

+ +
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Table 1 Query Parameters

Parameter

+

Mandatory

+

Type

+

Description

+

allowWatchBookmarks

+

No

+

Boolean

+

allowWatchBookmarks requests watch events with type "BOOKMARK".

+

Servers that do not implement bookmarks may ignore this flag and bookmarks are sent at the server's discretion. Clients should not assume bookmarksare returned at any specific interval, nor may they assume the server will send any BOOKMARK event during a session. If this is not a watch, this field is ignored.

+

continue

+

No

+

String

+

The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the "next key".

+

This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications.

+

fieldSelector

+

No

+

String

+

A selector to restrict the list of returned objects by their fields. Defaults to everything.

+

labelSelector

+

No

+

String

+

A selector to restrict the list of returned objects by their labels. Defaults to everything.

+

limit

+

No

+

Integer

+

limit is a maximum number of responses to return for a list call. If more items exist, the server will set the continue field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true.

+

The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned.

+

resourceVersion

+

No

+

String

+

resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details.

+

Defaults to unset.

+

resourceVersionMatch

+

No

+

String

+

resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details.

+

Defaults to unset.

+

sendInitialEvents

+

No

+

Boolean

+

sendInitialEvents when set together with Watch option, begins the watch stream with synthetic "Added" events of all resources. Followed by a synthetic "Bookmark" event containing a ResourceVersion after which the server continues streaming events. This option is meant to be used with the resourceVersion parameter with the following semantics:

+
  • sendInitialEvent and RV>0 - provides the initial events and when we reach the desired RV,

    the synthetic bookmark event. Note that the desired RV must be >= the current revision the server knows about.

    +

    If the desired RV is older than the current revision the server is aware of, the TooLargeResourceVersionError is returned.

    +

    Essentially this provides NotOlderThan semantics.

    +
  • sendInitialEvent and RV=0 - provides the initial events and the synthetic bookmark with the current RV. - sendInitialEvent and RV="" - matches data at the most recent ResourceVersion.

    The returned data is consistent, that is, served from etcd via a quorum read.

    +

    It provides the initial events, any other updates and the synthetic bookmark event with the most recent ResourceVersion.

    +
+

timeoutSeconds

+

No

+

Integer

+

Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity.

+

watch

+

No

+

Boolean

+

Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion.

+

pretty

+

No

+

String

+

If 'true', then the output is pretty printed.

+
+
+
+

Request Parameters

+
+ + + + + + + + + + + +
Table 2 Request header parameters

Parameter

+

Mandatory

+

Type

+

Description

+

X-Auth-Token

+

Yes

+

String

+

User token.

+

It can be obtained through the IAM API used to obtain a user token. The value of X-Subject-Token in the response header is the user token.

+
+
+
+

Response Parameters

Status code: 200

+ +
+ + + + + + + + + + + + + + + + + + + + + +
Table 3 Response body parameters

Parameter

+

Type

+

Description

+

apiVersion

+

String

+

APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#resources

+

items

+

Array of io.cci.otc.api.pkg.apis.versioned.cci.v2.Namespace objects

+

Items is the list of Namespace objects in the list. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/namespaces/

+

kind

+

String

+

Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds

+

metadata

+

io.k8s.apimachinery.pkg.apis.meta.v1.ListMeta object

+

Standard list metadata. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds

+
+
+ +
+ + + + + + + + + + + + + + + + + + + + + + + + + +
Table 4 io.cci.otc.api.pkg.apis.versioned.cci.v2.Namespace

Parameter

+

Type

+

Description

+

apiVersion

+

String

+

APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#resources

+

kind

+

String

+

Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds

+

metadata

+

io.k8s.apimachinery.pkg.apis.meta.v1.ObjectMeta object

+

Standard object's metadata. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata

+

spec

+

io.cci.otc.api.pkg.apis.versioned.cci.v2.NamespaceSpec object

+

Spec defines the behavior of the Namespace. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#spec-and-status

+

status

+

io.cci.otc.api.pkg.apis.versioned.cci.v2.NamespaceStatus object

+

Status describes the current status of a Namespace. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#spec-and-status

+
+
+ +
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Table 5 io.k8s.apimachinery.pkg.apis.meta.v1.ObjectMeta

Parameter

+

Type

+

Description

+

annotations

+

Map<String,String>

+

Annotations is an unstructured key value map stored with a resource that may be set by external tools to store and retrieve arbitrary metadata. They are not queryable and should be preserved when modifying objects. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/annotations/

+

clusterName

+

String

+

The name of the cluster which the object belongs to. This is used to distinguish resources with same name and namespace in different clusters. This field is not set anywhere right now and apiserver is going to ignore it if set in create or update request.

+

creationTimestamp

+

String

+

CreationTimestamp is a timestamp representing the server time when this object was created. It is not guaranteed to be set in happens-before order across separate operations. Clients may not set this value. It is represented in RFC3339 form and is in UTC.

+

Populated by the system. Read-only. Null for lists. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata

+

deletionGracePeriodSeconds

+

Long

+

Number of seconds allowed for this object to gracefully terminate before it will be removed from the system. Only set when deletionTimestamp is also set. May only be shortened. Read-only.

+

deletionTimestamp

+

String

+

DeletionTimestamp is RFC 3339 date and time at which this resource will be deleted. This field is set by the server when a graceful deletion is requested by the user, and is not directly settable by a client. The resource is expected to be deleted (no longer visible from resource lists, and not reachable by name) after the time in this field, once the finalizers list is empty. As long as the finalizers list contains items, deletion is blocked. Once the deletionTimestamp is set, this value may not be unset or be set further into the future, although it may be shortened or the resource may be deleted prior to this time. For example, a user may request that a pod is deleted in 30 seconds. The Kubelet will react by sending a graceful termination signal to the containers in the pod. After that 30 seconds, the Kubelet will send a hard termination signal (SIGKILL) to the container and after cleanup, remove the pod from the API. In the presence of network partitions, this object may still exist after this timestamp, until an administrator or automated process can determine the resource is fully terminated. If not set, graceful deletion of the object has not been requested.

+

Populated by the system when a graceful deletion is requested. Read-only. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata

+

enable

+

Boolean

+

Enable identifies whether the resource is available.

+

finalizers

+

Array of strings

+

Must be empty before the object is deleted from the registry.

+

Each entry is an identifier for the responsible component that will remove the entry from the list. If the deletionTimestamp of the object is non-nil, entries in this list can only be removed. Finalizers may be processed and removed in any order. Order is NOT enforced because it introduces significant risk of stuck finalizers. finalizers is a shared field, any actor with permissioncan reorder it. If the finalizer list is processed in order, then this can lead to a situation in which the component responsible for the first finalizer in the list is waiting for a signal (field value, external system, or other) produced by a component responsible for a finalizer later in the list, resulting in a deadlock. Without enforced ordering finalizers are free to order amongst themselves and are not vulnerable to ordering changes in the list.

+

generateName

+

String

+

GenerateName is an optional prefix, used by the server, to generate a unique name ONLY IF the Name field has not been provided. If this field is used, the name returned to the client will be different than the name passed. This value will also be combined with a unique suffix. The provided value has the same validation rules as the Name field, and may be truncated by the length of the suffix required to make the value unique on the server.

+

If this field is specified and the generated name exists, the server will NOT return a 409 - instead, it will either return 201 Created or 500 with Reason ServerTimeout indicating a unique name could not be found in the time allotted, and the client should retry (optionally after the time indicated in the Retry-After header).

+

Applied only if Name is not specified. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#idempotency

+

generation

+

Long

+

A sequence number representing a specific generation of the desired state. Populated by the system. Read-only.

+

labels

+

Map<String,String>

+

Map of string keys and values that can be used to organize and categorize (scope and select) objects. May match selectors of replication controllers and services. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/labels/

+

managedFields

+

Array of io.k8s.apimachinery.pkg.apis.meta.v1.ManagedFieldsEntry objects

+

ManagedFields maps workflow-id and version to the set of fields that are managed by that workflow. This is mostly for internal housekeeping, and users typically shouldn't need to set or understand this field. A workflow can be the user's name, a controller's name, or the name of a specific apply-path like "ci-cd". The set of fields is always in the version that the workflow used when modifying the object.

+

name

+

String

+

Name must be unique within a namespace. Is required when creating resources, although some resources may allow a client to request the generation of an appropriate name automatically. Name is primarily intended for creation idempotence and configuration definition. Cannot be updated. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names

+

namespace

+

String

+

Namespace defines the space within which each name must be unique. An empty namespace is equivalent to the "default" namespace, but "default" is the canonical representation. Not all objects are required to be scoped to a namespace - the value of this field for those objects will be empty.

+

Must be a DNS_LABEL. Cannot be updated. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/namespaces/

+

ownerReferences

+

Array of io.k8s.apimachinery.pkg.apis.meta.v1.OwnerReference objects

+

List of objects depended by this object. If ALL objects in the list have been deleted, this object will be garbage collected. If this object is managed by a controller, then an entry in this list will point to this controller, with the controller field set to true. There cannot be more than one managing controller.

+

resourceVersion

+

String

+

An opaque value that represents the internal version of this object that can be used by clients to determine when objects have changed. May be used for optimistic concurrency, change detection, and the watch operation on a resource or set of resources. Clients must treat these values as opaque and passed unmodified back to the server. They may only be valid for a particular resource or set of resources.

+

Populated by the system. Read-only. Value must be treated as opaque by clients and . More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#concurrency-control-and-consistency

+

selfLink

+

String

+

SelfLink is a URL representing this object. Populated by the system. Read-only.

+

DEPRECATED Kubernetes will stop propagating this field in 1.20 release and the field is planned to be removed in 1.21 release.

+

uid

+

String

+

UID is the unique in time and space value for this object. It is typically generated by the server on successful creation of a resource and is not allowed to change on PUT operations.

+

Populated by the system. Read-only. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#uids

+
+
+ +
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Table 6 io.k8s.apimachinery.pkg.apis.meta.v1.ManagedFieldsEntry

Parameter

+

Type

+

Description

+

apiVersion

+

String

+

APIVersion defines the version of this resource that this field set applies to. The format is "group/version" just like the top-level APIVersion field. It is necessary to track the version of a field set because it cannot be automatically converted.

+

fieldsType

+

String

+

FieldsType is the discriminator for the different fields format and version. There is currently only one possible value: "FieldsV1"

+

fieldsV1

+

Object

+

FieldsV1 holds the first JSON version format as described in the "FieldsV1" type.

+

manager

+

String

+

Manager is an identifier of the workflow managing these fields.

+

operation

+

String

+

Operation is the type of operation which lead to this ManagedFieldsEntry being created. The only valid values for this field are 'Apply' and 'Update'.

+

time

+

String

+

Time is timestamp of when these fields were set. It should always be empty if Operation is 'Apply'

+
+
+ +
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Table 7 io.k8s.apimachinery.pkg.apis.meta.v1.OwnerReference

Parameter

+

Type

+

Description

+

apiVersion

+

String

+

API version of the referent.

+

blockOwnerDeletion

+

Boolean

+

If true, AND if the owner has the "foregroundDeletion" finalizer, then the owner cannot be deleted from the key-value store until this reference is removed. Defaults to false. To set this field, a user needs "delete" permission of the owner, otherwise 422 (Unprocessable Entity) will be returned.

+

controller

+

Boolean

+

If true, this reference points to the managing controller.

+

kind

+

String

+

Kind of the referent. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds

+

name

+

String

+

Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names

+

uid

+

String

+

UID of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#uids

+
+
+ +
+ + + + + + + + + +
Table 8 io.cci.otc.api.pkg.apis.versioned.cci.v2.NamespaceSpec

Parameter

+

Type

+

Description

+

finalizers

+

Array of strings

+

Finalizers is an opaque list of values that must be empty to permanently remove object from storage. More info: https://kubernetes.io/docs/tasks/administer-cluster/namespaces/

+
+
+ +
+ + + + + + + + + + + + + +
Table 9 io.cci.otc.api.pkg.apis.versioned.cci.v2.NamespaceStatus

Parameter

+

Type

+

Description

+

conditions

+

Array of io.cci.otc.api.pkg.apis.versioned.cci.v2.NamespaceCondition objects

+

Represents the latest available observations of a namespace's

+

current state.

+

phase

+

String

+

Phase is the current lifecycle phase of the namespace. More info: https://kubernetes.io/docs/tasks/administer-cluster/namespaces/

+

Possible enum values:

+
  • "Active" means the namespace is available for use in the system
  • "Terminating" means the namespace is undergoing graceful termination
+
+
+ +
+ + + + + + + + + + + + + + + + + + + + + + + + + +
Table 10 io.cci.otc.api.pkg.apis.versioned.cci.v2.NamespaceCondition

Parameter

+

Type

+

Description

+

lastTransitionTime

+

String

+

Time is a wrapper around time. Time which supports correct marshaling to YAML and JSON. Wrappers are provided for many of the factory methods that the time package offers.

+

message

+

String

+		  

reason

+

String

+		  

status

+

String

+

Status of the condition, one of True, False, Unknown.

+

type

+

String

+

Type of namespace controller condition.

+
+
+ +
+ + + + + + + + + + + + + + + + + + + + + +
Table 11 io.k8s.apimachinery.pkg.apis.meta.v1.ListMeta

Parameter

+

Type

+

Description

+

continue

+

String

+

continue may be set if the user set a limit on the number of items returned, and indicates that the server has more data available. The value is opaque and may be used to issue another request to the endpoint that served this list to retrieve the next set of available objects. Continuing a consistent list may not be possible if the server configuration has changed or more than a few minutes have passed. The resourceVersion field returned when using this continue value will be identical to the value in the first response, unless you have received this token from an error message.

+

remainingItemCount

+

Long

+

remainingItemCount is the number of subsequent items in the list which are not included in this list response. If the list request contained label or field selectors, then the number of remaining items is unknown and the field will be left unset and omitted during serialization. If the list is complete (either because it is not chunking or because this is the last chunk), then there are no more remaining items and this field will be left unset and omitted during serialization. Servers older than v1.15 do not set this field. The intended use of the remainingItemCount is estimating the size of a collection. Clients should not rely on the remainingItemCount to be set or to be exact.

+

resourceVersion

+

String

+

String that identifies the server's internal version of this object that can be used by clients to determine when objects have changed. Value must be treated as opaque by clients and passed unmodified back to the server. Populated by the system. Read-only. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#concurrency-control-and-consistency

+

selfLink

+

String

+

selfLink is a URL representing this object. Populated by the system. Read-only.

+

DEPRECATED Kubernetes will stop propagating this field in 1.20 release and the field is planned to be removed in 1.21 release.

+
+
+
+

Example Requests

None

+
+

Example Responses

Status code: 200

+

OK

+ +
+

Status Codes

+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +

Status Code

+

Description

+

200

+

OK

+

400

+

BadRequest

+

401

+

Unauthorized

+

403

+

Forbidden

+

404

+

NotFound

+

405

+

MethodNotAllowed

+

406

+

NotAcceptable

+

409

+

Conflict

+

415

+

UnsupportedMediaType

+

422

+

Invalid

+

429

+

TooManyRequests

+

500

+

InternalError

+

503

+

ServiceUnavailable

+

504

+

ServerTimeout

+
+
+
+
+
+
+
Parent topic: Proprietary APIs
+
+
+ diff --git a/docs/cci/api-ref/listCciV2NamespacedConfigMap.html b/docs/cci/api-ref/listCciV2NamespacedConfigMap.html new file mode 100644 index 00000000..10f715a8 --- /dev/null +++ b/docs/cci/api-ref/listCciV2NamespacedConfigMap.html @@ -0,0 +1,715 @@ + + +

Listing or Watching Objects of kind ConfigMap

+

Function

List or watch objects of kind ConfigMap.

+
+

Calling Method

For details, see Calling APIs.

+
+

URI

GET /apis/cci/v2/namespaces/{namespace}/configmaps

+ +
+ + + + + + + + + + + +
Table 1 Path Parameters

Parameter

+

Mandatory

+

Type

+

Description

+

namespace

+

Yes

+

String

+

Object name and auth scope, such as for teams and projects

+
+
+ +
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Table 2 Query Parameters

Parameter

+

Mandatory

+

Type

+

Description

+

allowWatchBookmarks

+

No

+

Boolean

+

allowWatchBookmarks requests watch events with type "BOOKMARK".

+

Servers that do not implement bookmarks may ignore this flag and bookmarks are sent at the server's discretion. Clients should not assume bookmarks are returned at any specific interval, nor may they assume the server will send any BOOKMARK event during a session. If this is not a watch, this field is ignored.

+

continue

+

No

+

String

+

The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the "next key".

+

This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications.

+

fieldSelector

+

No

+

String

+

A selector to restrict the list of returned objects by their fields. Defaults to everything.

+

labelSelector

+

No

+

String

+

A selector to restrict the list of returned objects by their labels. Defaults to everything.

+

limit

+

No

+

Integer

+

limit is a maximum number of responses to return for a list call. If more items exist, the server will set the continue field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true.

+

The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned.

+

resourceVersion

+

No

+

String

+

resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details.

+

Defaults to unset.

+

resourceVersionMatch

+

No

+

String

+

resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details.

+

Defaults to unset.

+

sendInitialEvents

+

No

+

Boolean

+

sendInitialEvents when set together with Watch option, begins the watch stream with synthetic "Added" events of all resources. Followed by a synthetic "Bookmark" event containing a ResourceVersion after which the server continues streaming events. This option is meant to be used with the resourceVersion parameter with the following semantics:

+
  • sendInitialEvent and RV>0 - provides the initial events and when we reach the desired RV,

    the synthetic bookmark event. Note that the desired RV must be >= the current revision the server knows about.

    +

    If the desired RV is older than the current revision the server is aware of, the TooLargeResourceVersionError is returned.

    +

    Essentially this provides NotOlderThan semantics.

    +
  • sendInitialEvent and RV=0 - provides the initial events and the synthetic bookmark with the current RV. - sendInitialEvent and RV="" - matches data at the most recent ResourceVersion.

    The returned data is consistent, that is, served from etcd via a quorum read.

    +

    It provides the initial events, any other updates and the synthetic bookmark event with the most recent ResourceVersion.

    +
+

timeoutSeconds

+

No

+

Integer

+

Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity.

+

watch

+

No

+

Boolean

+

Watch for changes to the described resources and return themas a stream of add, update, and remove notifications. Specify resourceVersion.

+

pretty

+

No

+

String

+

If 'true', then the output is pretty printed.

+
+
+
+

Request Parameters

+
+ + + + + + + + + + + +
Table 3 Request header parameters

Parameter

+

Mandatory

+

Type

+

Description

+

X-Auth-Token

+

Yes

+

String

+

User token.

+

It can be obtained through the IAM API used to obtain a user token. The value of X-Subject-Token in the response header is the user token.

+
+
+
+

Response Parameters

Status code: 200

+ +
+ + + + + + + + + + + + + + + + + + + + + +
Table 4 Response body parameters

Parameter

+

Type

+

Description

+

apiVersion

+

String

+

APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#resources

+

items

+

Array of io.cci.otc.api.pkg.apis.versioned.cci.v2.ConfigMap objects

+

Items is the list of ConfigMaps.

+

kind

+

String

+

Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds

+

metadata

+

io.k8s.apimachinery.pkg.apis.meta.v1.ListMeta object

+

More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata

+
+
+ +
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Table 5 io.cci.otc.api.pkg.apis.versioned.cci.v2.ConfigMap

Parameter

+

Type

+

Description

+

apiVersion

+

String

+

APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#resources

+

binaryData

+

Map<String,String>

+

BinaryData contains the binary data. Each key must consist of alphanumeric characters, '-', '_' or '.'. BinaryData can contain byte sequences that are not in the UTF-8 range. The keys stored in BinaryData must not overlap with the ones in the Data field, this is enforced during validation process. Using this field will require 1.10+ apiserver and kubelet.

+

data

+

Map<String,String>

+

Data contains the configuration data. Each key must consist of

+

alphanumeric characters, '-', '_' or '.'. Values with non-UTF-8 byte sequences must use the BinaryData field. The keys stored in Data must not overlap with the keys in the BinaryData field, this is enforced during validation process.

+

immutable

+

Boolean

+

Immutable, if set to true, ensures that data stored in the ConfigMap cannot be updated (only object metadata can be modified). If not set to true, the field can be modified at any time. Defaulted to nil.

+

kind

+

String

+

Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds

+

metadata

+

io.k8s.apimachinery.pkg.apis.meta.v1.ObjectMeta object

+

Standard object's metadata. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata

+
+
+ +
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Table 6 io.k8s.apimachinery.pkg.apis.meta.v1.ObjectMeta

Parameter

+

Type

+

Description

+

annotations

+

Map<String,String>

+

Annotations is an unstructured key value map stored with a resource that may be set by external tools to store and retrieve arbitrary metadata. They are not queryable and should be preserved when modifying objects. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/annotations/

+

clusterName

+

String

+

The name of the cluster which the object belongs to. This is used to distinguish resources with same name and namespace in different clusters. This field is not set anywhere right now and apiserver is going to ignore it if set in create or update request.

+

creationTimestamp

+

String

+

CreationTimestamp is a timestamp representing the server time when this object was created. It is not guaranteed to be set in happens-before order across separate operations. Clients may not set this value. It is represented in RFC3339 form and is in UTC.

+

Populated by the system. Read-only. Null for lists. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata

+

deletionGracePeriodSeconds

+

Long

+

Number of seconds allowed for this object to gracefully terminate before it will be removed from the system. Only set when deletionTimestamp is also set. May only be shortened. Read-only.

+

deletionTimestamp

+

String

+

DeletionTimestamp is RFC 3339 date and time at which this resource will be deleted. This field is set by the server when a graceful deletion is requested by the user, and is not directly settable by a client. The resource is expected to be deleted (no longer visible from resource lists, and not reachable by name) after the time in this field, once the finalizers list is empty. As long as the finalizers list contains items, deletion is blocked. Once the deletionTimestamp is set, this value may not be unset or be set further into the future, although it may be shortened or the resource may be deleted prior to this time. For example, a user may request that a pod is deleted in 30 seconds. The Kubelet will react by sending a graceful termination signal to the containers in the pod. After that 30 seconds, the Kubelet will send a hard termination signal (SIGKILL) to the container and after cleanup, remove the pod from the API. In the presence of network partitions, this object may still exist after this timestamp, until an administrator or automated process can determine the resource is fully terminated. If not set, graceful deletion of the object has not been requested.

+

Populated by the system when a graceful deletion is requested. Read-only. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata

+

enable

+

Boolean

+

Enable identifies whether the resource is available

+

finalizers

+

Array of strings

+

Must be empty before the object is deleted from the registry.

+

Each entry is an identifier for the responsible component that will remove the entry from the list. If the deletionTimestamp of the object is non-nil, entries in this list can only be removed. Finalizers may be processed and removed in any order. Order is NOT enforced because it introduces significant risk of stuck finalizers. finalizers is a shared field, any actor with permission can reorder it. If the finalizer list is processed in order, then this can lead to a situation in which the component responsible for the first finalizer in the list is waiting for a signal (field value, external system, or other) produced by a component responsible for a finalizer later in the list, resulting in a deadlock. Without enforced ordering finalizers are free to order amongst themselves and are not vulnerable to ordering changes in the list.

+

generateName

+

String

+

GenerateName is an optional prefix, used by the server, to generate a unique name ONLY IF the Name field has not been provided. If this field is used, the name returned to the client will be different than the name passed. This value will also be combined with a unique suffix. The provided value has the same validation rules as the Name field, and may be truncated by the length of the suffix required to make the value unique on the server.

+

If this field is specified and the generated name exists, the server will NOT return a 409 - instead, it will either return 201 Created or 500 with Reason ServerTimeout indicating a unique name could not be found in the time allotted, and the client should retry (optionally after the time indicated in the Retry-After header).

+

Applied only if Name is not specified. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#idempotency

+

generation

+

Long

+

A sequence number representing a specific generation of the desired state. Populated by the system. Read-only.

+

labels

+

Map<String,String>

+

Map of string keys and values that can be used to organize and categorize (scope and select) objects. May match selectors of replication controllers and services. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/labels/

+

managedFields

+

Array of io.k8s.apimachinery.pkg.apis.meta.v1.ManagedFieldsEntry objects

+

ManagedFields maps workflow-id and version to the set of fields that are managed by that workflow. This is mostly for internal housekeeping, and users typically shouldn't need to set or understand this field. A workflow can be the user's name, a controller's name, or the name of a specific apply-path like "ci-cd". The set of fields is always in the version that the workflow used when modifying the object.

+

name

+

String

+

Name must be unique within a namespace. Is required when creating resources, although some resources may allow a client to request the generation of an appropriate name automatically. Name is primarily intended for creation idempotence and configuration definition. Cannot be updated. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names

+

namespace

+

String

+

Namespace defines the space within which each name must be unique. An empty namespace is equivalent to the "default" namespace, but "default" is the canonical representation. Not all objects are required to be scoped to a namespace - the value of this field for those objects will be empty.

+

Must be a DNS_LABEL. Cannot be updated. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/namespaces/

+

ownerReferences

+

Array of io.k8s.apimachinery.pkg.apis.meta.v1.OwnerReference objects

+

List of objects depended by this object. If ALL objects in the list have been deleted, this object will be garbage collected. If this object is managed by a controller, then an entry in this list will point to this controller, with the controller field set to true. There cannot be more than one managing controller.

+

resourceVersion

+

String

+

An opaque value that represents the internal version of this object that can be used by clients to determine when objects have changed. May be used for optimistic concurrency, change detection, and the watch operation on a resource or set of resources. Clients must treat these values as opaque and passed unmodified back to the server. They may only be valid for a particular resource or set of resources.

+

Populated by the system. Read-only. Value must be treated as opaque by clients and . More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#concurrency-control-and-consistency

+

selfLink

+

String

+

SelfLink is a URL representing this object. Populated by the system. Read-only.

+

DEPRECATED Kubernetes will stop propagating this field in 1.20 release and the field is planned to be removed in 1.21 release.

+

uid

+

String

+

UID is the unique in time and space value for this object. It is typically generated by the server on successful creation of a resource and is not allowed to change on PUT operations.

+

Populated by the system. Read-only. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#uids

+
+
+ +
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Table 7 io.k8s.apimachinery.pkg.apis.meta.v1.ManagedFieldsEntry

Parameter

+

Type

+

Description

+

apiVersion

+

String

+

APIVersion defines the version of this resource that this field set applies to. The format is "group/version" just like the top-level APIVersion field. It is necessary to track the version of a field set because it cannot be automatically converted.

+

fieldsType

+

String

+

FieldsType is the discriminator for the different fields format and version. There is currently only one possible value: "FieldsV1"

+

fieldsV1

+

Object

+

FieldsV1 holds the first JSON version format as described in the "FieldsV1" type.

+

manager

+

String

+

Manager is an identifier of the workflow managing these fields.

+

operation

+

String

+

Operation is the type of operation which lead to this ManagedFieldsEntry being created. The only valid values for this field are 'Apply' and 'Update'.

+

time

+

String

+

Time is timestamp of when these fields were set. It should always

+

be empty if Operation is 'Apply'

+
+
+ +
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Table 8 io.k8s.apimachinery.pkg.apis.meta.v1.OwnerReference

Parameter

+

Type

+

Description

+

apiVersion

+

String

+

API version of the referent.

+

blockOwnerDeletion

+

Boolean

+

If true, AND if the owner has the "foregroundDeletion" finalizer, then the owner cannot be deleted from the key-value store until this reference is removed. Defaults to false. To set this field, a user needs "delete"permission of the owner, otherwise 422 (Unprocessable Entity) will be returned.

+

controller

+

Boolean

+

If true, this reference points to the managing controller.

+

kind

+

String

+

Kind of the referent. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds

+

name

+

String

+

Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names

+

uid

+

String

+

UID of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#uids

+
+
+ +
+ + + + + + + + + + + + + + + + + + + + + +
Table 9 io.k8s.apimachinery.pkg.apis.meta.v1.ListMeta

Parameter

+

Type

+

Description

+

continue

+

String

+

continue may be set if the user set a limit on the number of items returned, and indicates that the server has more data available. The value is opaque and may be used to issue another request to the endpoint that served this list to retrieve the next set of available objects. Continuing a consistent list may not be possible if the server configuration has changed or more than a few minutes have passed. The resourceVersion field returned when using this continue value will be identical to the value in the first response, unless you have received this token from an error message.

+

remainingItemCount

+

Long

+

remainingItemCount is the number of subsequent items in the list which are not included in this list response. If the list request contained label or field selectors, then the number of remaining items is unknown and the field will be left unset and omitted during serialization. If the list is complete (either because it is not chunking or because this is the last chunk), then there are no more remaining items and this field will be left unset and omitted during serialization. Servers older than v1.15 do not set this field. The intended use of the remainingItemCount is estimating the size of a collection. Clients should not rely on the remainingItemCountto be set or to be exact.

+

resourceVersion

+

String

+

String that identifies the server's internal version of this object that can be used by clients to determine when objects have changed. Value must be treated as opaque by clients and passed unmodified back to the server. Populated by the system. Read-only. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#concurrency-control-and-consistency

+

selfLink

+

String

+

selfLink is a URL representing this object. Populated by the system. Read-only.

+

DEPRECATED Kubernetes will stop propagating this field in 1.20 release and the field is planned to be removed in 1.21 release.

+
+
+
+

Example Requests

None

+
+

Example Responses

Status code: 200

+

OK

+
{
+  "apiVersion" : "v1",
+  "items" : [ {
+    "apiVersion" : "cci/v2",
+    "data" : {
+      "ca.crt" : "-----BEGIN CERTIFICATE-----\n...\n-----END CERTIFICATE-----"
+    },
+    "kind" : "ConfigMap",
+    "metadata" : {
+      "annotations" : {
+        "kubernetes.io/description" : "Contains a CA bundle that can be used\rto verify the kube-apiserver when using internal endpoints such\ras the internal service IP or kubernetes.default.svc. No other\rusage is guaranteed across distributions of Kubernetes clusters.",
+        "tenant.cci.io/tenant-id" : "08a2*************************c03"
+      },
+      "creationTimestamp" : "2024-08-15T12:05:58Z",
+      "labels" : {
+        "sys_enterprise_project_id" : "0",
+        "tenant.cci.io/tenant-id" : "08a2*************************c03",
+        "tenant.kubernetes.io/domain-id" : "08a*************************ee60",
+        "tenant.kubernetes.io/project-id" : "08a2*************************c03"
+      },
+      "name" : "kube-root-ca.crt",
+      "namespace" : "wbtest4",
+      "resourceVersion" : "363213016",
+      "uid" : "ebfa11af-0a1b-47c1-b106-0730017a9ca8"
+    }
+  }, {
+    "apiVersion" : "cci/v2",
+    "data" : {
+      "rootKey" : "xxx",
+      "sharedKey" : "xxx"
+    },
+    "kind" : "ConfigMap",
+    "metadata" : {
+      "annotations" : {
+        "tenant.cci.io/tenant-id" : "08a2*************************c03"
+      },
+      "creationTimestamp" : "2024-08-21T06:43:42Z",
+      "labels" : {
+        "sys_enterprise_project_id" : "0",
+        "tenant.cci.io/tenant-id" : "08a2*************************c03",
+        "tenant.kubernetes.io/domain-id" : "08a*************************ee60",
+        "tenant.kubernetes.io/project-id" : "08a2*************************c03"
+      },
+      "name" : "system-preset-aeskey",
+      "namespace" : "wbtest4",
+      "resourceVersion" : "368412328",
+      "uid" : "65ff7e35-b12f-4f28-81ed-a8df1905952c"
+    }
+  } ],
+  "kind" : "List",
+  "metadata" : {
+    "resourceVersion" : ""
+  }
+}
+
+

Status Codes

+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +

Status Code

+

Description

+

200

+

OK

+

400

+

BadRequest

+

401

+

Unauthorized

+

403

+

Forbidden

+

404

+

NotFound

+

405

+

MethodNotAllowed

+

406

+

NotAcceptable

+

409

+

Conflict

+

415

+

UnsupportedMediaType

+

422

+

Invalid

+

429

+

TooManyRequests

+

500

+

InternalError

+

503

+

ServiceUnavailable

+

504

+

ServerTimeout

+
+
+
+
+
+
+
Parent topic: Proprietary APIs
+
+
+ diff --git a/docs/cci/api-ref/listCciV2NamespacedPod.html b/docs/cci/api-ref/listCciV2NamespacedPod.html new file mode 100644 index 00000000..e52dcf66 --- /dev/null +++ b/docs/cci/api-ref/listCciV2NamespacedPod.html @@ -0,0 +1,3976 @@ + + +

Listing or Watching Objects of kind Pod

+

Function

List or watch objects of kind Pod.

+
+

Calling Method

For details, see Calling APIs.

+
+

URI

GET /apis/cci/v2/namespaces/{namespace}/pods

+ +
+ + + + + + + + + + + +
Table 1 Path Parameters

Parameter

+

Mandatory

+

Type

+

Description

+

namespace

+

Yes

+

String

+

Object name and auth scope, such as for teams and projects

+
+
+ +
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Table 2 Query Parameters

Parameter

+

Mandatory

+

Type

+

Description

+

allowWatchBookmarks

+

No

+

Boolean

+

allowWatchBookmarks requests watch events with type "BOOKMARK".

+

Servers that do not implement bookmarks may ignore this flag and bookmarks

+

are sent at the server's discretion. Clients should not assume bookmarks

+

are returned at any specific interval, nor may they assume the server will

+

send any BOOKMARK event during a session. If this is not a watch, this field

+

is ignored.

+

continue

+

No

+

String

+

The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the "next key".

+

This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications.

+

fieldSelector

+

No

+

String

+

A selector to restrict the list of returned objects by their

+

fields. Defaults to everything.

+

labelSelector

+

No

+

String

+

A selector to restrict the list of returned objects by their

+

labels. Defaults to everything.

+

limit

+

No

+

Integer

+

limit is a maximum number of responses to return for a list call. If more items exist, the server will set the continue field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true.

+

The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned.

+

resourceVersion

+

No

+

String

+

resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details.

+

Defaults to unset

+

resourceVersionMatch

+

No

+

String

+

resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details.

+

Defaults to unset

+

sendInitialEvents

+

No

+

Boolean

+

sendInitialEvents when set together with Watch option, begins the watch stream with synthetic "Added" events of all resources. Followed by a synthetic "Bookmark" event containing a ResourceVersion after which the server continues streaming events. This option is meant to be used with the resourceVersion parameter with the following semantics:

+
  • sendInitialEvent and RV>0 - provides the initial events and when we reach the desired RV,

    the synthetic bookmark event. Note that the desired RV must be >= the current revision the server knows about.

    +

    If the desired RV is older than the current revision the server is aware of, the TooLargeResourceVersionError is returned.

    +

    Essentially this provides NotOlderThan semantics.

    +
  • sendInitialEvent and RV=0 - provides the initial events and the synthetic bookmark with the current RV. - sendInitialEvent and RV="" - matches data at the most recent ResourceVersion.

    The returned data is consistent, that is, served from etcd via a quorum read.

    +

    It provides the initial events, any other updates and the synthetic bookmark

    +

    event with the most recent ResourceVersion.

    +
+

timeoutSeconds

+

No

+

Integer

+

Timeout for the list/watch call. This limits the duration of

+

the call, regardless of any activity or inactivity.

+

watch

+

No

+

Boolean

+

Watch for changes to the described resources and return them

+

as a stream of add, update, and remove notifications. Specify resourceVersion.

+

pretty

+

No

+

String

+

If 'true', then the output is pretty printed.

+
+
+
+

Request Parameters

+
+ + + + + + + + + + + +
Table 3 Request header parameters

Parameter

+

Mandatory

+

Type

+

Description

+

X-Auth-Token

+

Yes

+

String

+

user Token.

+

It can be obtained through the IAM API used to obtain a user token. The value of X-Subject-Token in the response header is the user token.

+
+
+
+

Response Parameters

Status code: 200

+ +
+ + + + + + + + + + + + + + + + + + + + + +
Table 4 Response body parameters

Parameter

+

Type

+

Description

+

apiVersion

+

String

+

APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#resources

+

items

+

Array of io.cci.otc.api.pkg.apis.versioned.cci.v2.Pod objects

+

List of pods. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md

+

kind

+

String

+

Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds

+

metadata

+

io.k8s.apimachinery.pkg.apis.meta.v1.ListMeta object

+

Standard list metadata. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds

+
+
+ +
+ + + + + + + + + + + + + + + + + + + + + + + + + +
Table 5 io.cci.otc.api.pkg.apis.versioned.cci.v2.Pod

Parameter

+

Type

+

Description

+

apiVersion

+

String

+

APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#resources

+

kind

+

String

+

Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds

+

metadata

+

io.k8s.apimachinery.pkg.apis.meta.v1.ObjectMeta object

+

Standard object's metadata. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata

+

spec

+

io.cci.otc.api.pkg.apis.versioned.cci.v2.PodSpec object

+

Specification of the desired behavior of the pod. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#spec-and-status

+

status

+

io.cci.otc.api.pkg.apis.versioned.cci.v2.PodStatus object

+

Most recently observed status of the pod. This data may not be up to date. Populated by the system. Read-only. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#spec-and-status

+
+
+ +
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Table 6 io.cci.otc.api.pkg.apis.versioned.cci.v2.PodSpec

Parameter

+

Type

+

Description

+

activeDeadlineSeconds

+

Long

+

Optional duration in seconds the pod may be active on the node

+

relative to StartTime before the system will actively try to mark it failed

+

and kill associated containers. Value must be a positive integer.

+

affinity

+

io.cci.otc.api.pkg.apis.versioned.cci.v2.Affinity object

+

If specified, the pod's scheduling constraints

+

containers

+

Array of io.cci.otc.api.pkg.apis.versioned.cci.v2.Container objects

+

List of containers belonging to the pod. Containers cannot currently

+

be added or removed. There must be at least one container in a Pod. Cannot

+

be updated.

+

dnsConfig

+

io.cci.otc.api.pkg.apis.versioned.cci.v2.PodDNSConfig object

+

Specifies the DNS parameters of a pod. Parameters specified here

+

will be merged to the generated DNS configuration based on DNSPolicy.

+

dnsPolicy

+

String

+

Set DNS policy for the pod. Defaults to "ClusterFirst". Valid values are 'ClusterFirstWithHostNet', 'ClusterFirst', 'Default' or 'None'. DNS parameters given in DNSConfig will be merged with the policy selected with DNSPolicy. To have DNS options set along with hostNetwork, you have to specify DNS policy explicitly to 'ClusterFirstWithHostNet'.

+

Possible enum values:

+
  • "ClusterFirst" indicates that the pod should use cluster DNS first unless hostNetwork is true, if it is available, then fall back on the default (as determined by kubelet) DNS settings.
  • "ClusterFirstWithHostNet" indicates that the pod should use cluster DNS first, if it is available, then fall back on the default (as determined by kubelet) DNS settings.
  • "Default" indicates that the pod should use the default (as determined by kubelet) DNS settings.
  • "None" indicates that the pod should use empty DNS settings. DNS parameters such as nameservers and search paths should be defined via DNSConfig.
+

ephemeralContainers

+

Array of io.cci.otc.api.pkg.apis.versioned.cci.v2.EphemeralContainer objects

+

List of ephemeral containers run in this pod. Ephemeral containers

+

may be run in an existing pod to perform user-initiated actions such as

+

debugging. This list cannot be specified when creating a pod, and it cannot

+

be modified by updating the pod spec. In order to add an ephemeral container

+

to an existing pod, use the pod's ephemeralcontainers subresource.

+

hostAliases

+

Array of io.cci.otc.api.pkg.apis.versioned.cci.v2.HostAlias objects

+

HostAliases is an optional list of hosts and IPs that will be

+

injected into the pod's hosts file if specified. This is only valid for

+

non-hostNetwork pods.

+

hostname

+

String

+

Specifies the hostname of the Pod If not specified, the pod's

+

hostname will be set to a system-defined value.

+

imagePullSecrets

+

Array of io.cci.otc.api.pkg.apis.versioned.cci.v2.LocalObjectReference objects

+

ImagePullSecrets is an optional list of references to secrets in the same namespace to use for pulling any of the images used by this PodSpec. If specified, these secrets will be passed to individual puller implementations for them to use. More info: https://kubernetes.io/docs/concepts/containers/images#specifying-imagepullsecrets-on-a-pod

+

initContainers

+

Array of io.cci.otc.api.pkg.apis.versioned.cci.v2.Container objects

+

List of initialization containers belonging to the pod. Init containers are executed in order prior to containers being started. If any init container fails, the pod is considered to have failed and is handled according to its restartPolicy. The name for an init container or normal container must be unique among all containers. Init containers may not have Lifecycle actions, Readiness probes, Liveness probes, or Startup probes. The resourceRequirements of an init container are taken into account during scheduling by finding the highest request/limit for each resource type, and then using the max of of that value or the sum of the normal containers. Limits are applied to init containers in a similar fashion. Init containers cannot currently be added or removed. Cannot be updated. More info: https://kubernetes.io/docs/concepts/workloads/pods/init-containers/

+

nodeName

+

String

+

NodeName is a request to schedule this pod onto a specific node.

+

If it is non-empty, the scheduler simply schedules this pod onto that node,

+

assuming that it fits resource requirements.

+

overhead

+

Map<String,String>

+

Overhead represents the resource overhead associated with running a pod for a given RuntimeClass. This field will be autopopulated at admission time by the RuntimeClass admission controller. If the RuntimeClass admission controller is enabled, overhead must not be set in Pod create requests. The RuntimeClass admission controller will reject Pod create requests which have the overhead already set. If RuntimeClass is configured and selected in the PodSpec, Overhead will be set to the value defined in the corresponding RuntimeClass, otherwise it will remain unset and treated as zero. More info: https://git.k8s.io/enhancements/keps/sig-node/688-pod-overhead/README.md

+

readinessGates

+

Array of io.cci.otc.api.pkg.apis.versioned.cci.v2.PodReadinessGate objects

+

If specified, all readiness gates will be evaluated for pod readiness. A pod is ready when all its containers are ready AND all conditions specified in the readiness gates have status equal to "True" More info: https://git.k8s.io/enhancements/keps/sig-network/580-pod-readiness-gates

+

restartPolicy

+

String

+

Restart policy for all containers within the pod. One of Always, OnFailure, Never. Default to Always. More info: https://kubernetes.io/docs/concepts/workloads/pods/pod-lifecycle/#restart-policy

+

Possible enum values:

+
  • "Always"
  • "Never"
  • "OnFailure"
+

schedulerName

+

String

+

If specified, the pod will be dispatched by specified scheduler.

+

If not specified, the pod will be dispatched by default scheduler.

+

securityContext

+

io.cci.otc.api.pkg.apis.versioned.cci.v2.PodSecurityContext object

+

SecurityContext holds pod-level security attributes and common container settings. Optional: Defaults to empty. See type description for default values of each field.

+

setHostnameAsFQDN

+

Boolean

+

If true the pod's hostname will be configured as the pod's FQDN,

+

rather than the leaf name (the default). In Linux containers, this means

+

setting the FQDN in the hostname field of the kernel (the nodename field

+

of struct utsname). In Windows containers, this means setting the registry

+

value of hostname for the registry key HKEY_LOCAL_MACHINE\SYSTEM\CurrentControlSet\Services\Tcpip\Parameters

+

to FQDN. If a pod does not have FQDN, this has no effect. Default to false.

+

shareProcessNamespace

+

Boolean

+

Share a single process namespace between all of the containers in a pod. When this is set containers will be able to view and signal processes from other containers in the same pod, and the first process in each container will not be assigned PID 1. HostPID and ShareProcessNamespace cannot both be set. Optional: Default to false.

+

terminationGracePeriodSeconds

+

Long

+

Optional duration in seconds the pod needs to terminate gracefully.

+

May be decreased in delete request. Value must be non-negative integer.

+

The value zero indicates stop immediately via the kill signal (no opportunity

+

to shut down). If this value is nil, the default grace period will be used

+

instead. The grace period is the duration in seconds after the processes

+

running in the pod are sent a termination signal and the time when the processes

+

are forcibly halted with a kill signal. Set this value longer than the expected

+

cleanup time for your process. Defaults to 30 seconds.

+

topologySpreadConstraints

+

Array of io.cci.otc.api.pkg.apis.versioned.cci.v2.TopologySpreadConstraint objects

+

TopologySpreadConstraints describes how a group of pods ought

+

to spread across topology domains. Scheduler will schedule pods in a way

+

which abides by the constraints. All topologySpreadConstraints are ANDed.

+

volumes

+

Array of io.cci.otc.api.pkg.apis.versioned.cci.v2.Volume objects

+

List of volumes that can be mounted by containers belonging to the pod. More info: https://kubernetes.io/docs/concepts/storage/volumes

+
+
+ +
+ + + + + + + + + + + + + +
Table 7 io.cci.otc.api.pkg.apis.versioned.cci.v2.Affinity

Parameter

+

Type

+

Description

+

nodeAffinity

+

io.cci.otc.api.pkg.apis.versioned.cci.v2.NodeAffinity object

+

Describes node affinity scheduling rules for the pod.

+

podAntiAffinity

+

io.cci.otc.api.pkg.apis.versioned.cci.v2.PodAntiAffinity object

+

Describes pod anti-affinity scheduling rules (e.g. avoid putting

+

this pod in the same zone, etc. as some other pod(s)).

+
+
+ +
+ + + + + + + + + +
Table 8 io.cci.otc.api.pkg.apis.versioned.cci.v2.NodeAffinity

Parameter

+

Type

+

Description

+

requiredDuringSchedulingIgnoredDuringExecution

+

io.cci.otc.api.pkg.apis.versioned.cci.v2.NodeSelector object

+

If the affinity requirements specified by this field are not

+

met at scheduling time, the pod will not be scheduled onto the node. If

+

the affinity requirements specified by this field cease to be met at some

+

point during pod execution (e.g. due to an update), the system may or may

+

not try to eventually evict the pod from its node.

+
+
+ +
+ + + + + + + + + +
Table 9 io.cci.otc.api.pkg.apis.versioned.cci.v2.NodeSelector

Parameter

+

Type

+

Description

+

nodeSelectorTerms

+

Array of io.cci.otc.api.pkg.apis.versioned.cci.v2.NodeSelectorTerm objects

+

Required. A list of node selector terms. The terms are ORed.

+
+
+ +
+ + + + + + + + + +
Table 10 io.cci.otc.api.pkg.apis.versioned.cci.v2.NodeSelectorTerm

Parameter

+

Type

+

Description

+

matchExpressions

+

Array of io.cci.otc.api.pkg.apis.versioned.cci.v2.NodeSelectorRequirement objects

+

A list of node selector requirements by node's labels.

+
+
+ +
+ + + + + + + + + + + + + + + + + +
Table 11 io.cci.otc.api.pkg.apis.versioned.cci.v2.NodeSelectorRequirement

Parameter

+

Type

+

Description

+

key

+

String

+

The label key that the selector applies to.

+

operator

+

String

+

Represents a key's relationship to a set of values. Valid operators are In, NotIn, Exists, DoesNotExist. Gt, and Lt.

+

Possible enum values:

+
  • "DoesNotExist"
  • "Exists"
  • "Gt"
  • "In"
  • "Lt"
  • "NotIn"
+

values

+

Array of strings

+

An array of string values. If the operator is In or NotIn, the

+

values array must be non-empty. If the operator is Exists or DoesNotExist,

+

the values array must be empty. If the operator is Gt or Lt, the values

+

array must have a single element, which will be interpreted as an integer.

+

This array is replaced during a strategic merge patch.

+
+
+ +
+ + + + + + + + + + + + + +
Table 12 io.cci.otc.api.pkg.apis.versioned.cci.v2.PodAntiAffinity

Parameter

+

Type

+

Description

+

preferredDuringSchedulingIgnoredDuringExecution

+

Array of io.cci.otc.api.pkg.apis.versioned.cci.v2.WeightedPodAffinityTerm objects

+

The scheduler will prefer to schedule pods to nodes that satisfy

+

the anti-affinity expressions specified by this field, but it may choose

+

a node that violates one or more of the expressions. The node that is most

+

preferred is the one with the greatest sum of weights, i.e. for each node

+

that meets all of the scheduling requirements (resource request, requiredDuringScheduling

+

anti-affinity expressions, etc.), compute a sum by iterating through the

+

elements of this field and adding "weight" to the sum if the node has pods

+

which matches the corresponding podAffinityTerm; the node(s) with the highest

+

sum are the most preferred.

+

requiredDuringSchedulingIgnoredDuringExecution

+

Array of io.cci.otc.api.pkg.apis.versioned.cci.v2.PodAffinityTerm objects

+

If the anti-affinity requirements specified by this field are

+

not met at scheduling time, the pod will not be scheduled onto the node.

+

If the anti-affinity requirements specified by this field cease to be met

+

at some point during pod execution (e.g. due to a pod label update), the

+

system may or may not try to eventually evict the pod from its node. When

+

there are multiple elements, the lists of nodes corresponding to each podAffinityTerm

+

are intersected, i.e. all terms must be satisfied.

+
+
+ +
+ + + + + + + + + + + + + +
Table 13 io.cci.otc.api.pkg.apis.versioned.cci.v2.WeightedPodAffinityTerm

Parameter

+

Type

+

Description

+

podAffinityTerm

+

io.cci.otc.api.pkg.apis.versioned.cci.v2.PodAffinityTerm object

+

Required. A pod affinity term, associated with the corresponding

+

weight.

+

weight

+

Integer

+

weight associated with matching the corresponding podAffinityTerm,

+

in the range 1-100.

+
+
+ +
+ + + + + + + + + + + + + + + + + +
Table 14 io.cci.otc.api.pkg.apis.versioned.cci.v2.PodAffinityTerm

Parameter

+

Type

+

Description

+

labelSelector

+

io.k8s.apimachinery.pkg.apis.meta.v1.LabelSelector object

+

A label query over a set of resources, in this case pods.

+

namespaces

+

Array of strings

+

namespaces specifies a static list of namespace names that the

+

term applies to. The term is applied to the union of the namespaces listed

+

in this field and the ones selected by namespaceSelector. null or empty

+

namespaces list and null namespaceSelector means "this pod's namespace".

+

topologyKey

+

String

+

This pod should be co-located (affinity) or not co-located (anti-affinity)

+

with the pods matching the labelSelector in the specified namespaces, where

+

co-located is defined as running on a node whose value of the label with

+

key topologyKey matches that of any node on which any of the selected pods

+

is running. Empty topologyKey is not allowed.

+
+
+ +
+ + + + + + + + + + + + + + + + + +
Table 15 io.cci.otc.api.pkg.apis.versioned.cci.v2.PodDNSConfig

Parameter

+

Type

+

Description

+

nameservers

+

Array of strings

+

A list of DNS name server IP addresses. This will be appended

+

to the base nameservers generated from DNSPolicy. Duplicated nameservers

+

will be removed.

+

options

+

Array of io.cci.otc.api.pkg.apis.versioned.cci.v2.PodDNSConfigOption objects

+

A list of DNS resolver options. This will be merged with the

+

base options generated from DNSPolicy. Duplicated entries will be removed.

+

Resolution options given in Options will override those that appear in the

+

base DNSPolicy.

+

searches

+

Array of strings

+

A list of DNS search domains for host-name lookup. This will

+

be appended to the base search paths generated from DNSPolicy. Duplicated

+

search paths will be removed.

+
+
+ +
+ + + + + + + + + + + + + +
Table 16 io.cci.otc.api.pkg.apis.versioned.cci.v2.PodDNSConfigOption

Parameter

+

Type

+

Description

+

name

+

String

+

Required.

+

value

+

String

+		  
+
+ +
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Table 17 io.cci.otc.api.pkg.apis.versioned.cci.v2.EphemeralContainer

Parameter

+

Type

+

Description

+

args

+

Array of strings

+

Arguments to the entrypoint. The image's CMD is used if this is not provided. Variable references $(VAR_NAME) are expanded using the container's environment. If a variable cannot be resolved, the reference in the input string will be unchanged. Double $$ are reduced to a single $, which allows for escaping the $(VAR_NAME) syntax: i.e. "$$(VAR_NAME)" will produce the string literal "$(VAR_NAME)". Escaped references will never be expanded, regardless of whether the variable exists or not. Cannot be updated. More info: https://kubernetes.io/docs/tasks/inject-data-application/define-command-argument-container/#running-a-command-in-a-shell

+

command

+

Array of strings

+

Entrypoint array. Not executed within a shell. The image's ENTRYPOINT is used if this is not provided. Variable references $(VAR_NAME) are expanded using the container's environment. If a variable cannot be resolved, the reference in the input string will be unchanged. Double $$ are reduced to a single $, which allows for escaping the $(VAR_NAME) syntax: i.e. "$$(VAR_NAME)" will produce the string literal "$(VAR_NAME)". Escaped references will never be expanded, regardless of whether the variable exists or not. Cannot be updated. More info: https://kubernetes.io/docs/tasks/inject-data-application/define-command-argument-container/#running-a-command-in-a-shell

+

env

+

Array of io.cci.otc.api.pkg.apis.versioned.cci.v2.EnvVar objects

+

List of environment variables to set in the container. Cannot

+

be updated.

+

envFrom

+

Array of io.cci.otc.api.pkg.apis.versioned.cci.v2.EnvFromSource objects

+

List of sources to populate environment variables in the container.

+

The keys defined within a source must be a C_IDENTIFIER. All invalid keys

+

will be reported as an event when the container is starting. When a key

+

exists in multiple sources, the value associated with the last source will

+

take precedence. Values defined by an Env with a duplicate key will take

+

precedence. Cannot be updated.

+

image

+

String

+

Container image name. More info: https://kubernetes.io/docs/concepts/containers/images

+

lifecycle

+

io.cci.otc.api.pkg.apis.versioned.cci.v2.Lifecycle object

+

Lifecycle is not allowed for ephemeral containers.

+

livenessProbe

+

io.cci.otc.api.pkg.apis.versioned.cci.v2.Probe object

+

Probes are not allowed for ephemeral containers.

+

name

+

String

+

Name of the ephemeral container specified as a DNS_LABEL. This

+

name must be unique among all containers, init containers and ephemeral

+

containers.

+

ports

+

Array of io.cci.otc.api.pkg.apis.versioned.cci.v2.ContainerPort objects

+

Ports are not allowed for ephemeral containers.

+

readinessProbe

+

io.cci.otc.api.pkg.apis.versioned.cci.v2.Probe object

+

Probes are not allowed for ephemeral containers.

+

resources

+

io.cci.otc.api.pkg.apis.versioned.cci.v2.ResourceRequirements object

+

Resources are not allowed for ephemeral containers. Ephemeral

+

containers use spare resources already allocated to the pod.

+

securityContext

+

io.cci.otc.api.pkg.apis.versioned.cci.v2.SecurityContext object

+

Optional: SecurityContext defines the security options the ephemeral container should be run with. If set, the fields of SecurityContext override the equivalent fields of PodSecurityContext.

+

startupProbe

+

io.cci.otc.api.pkg.apis.versioned.cci.v2.Probe object

+

Probes are not allowed for ephemeral containers.

+

stdin

+

Boolean

+

Whether this container should allocate a buffer for stdin in

+

the container runtime. If this is not set, reads from stdin in the container

+

will always result in EOF. Default is false.

+

stdinOnce

+

Boolean

+

Whether the container runtime should close the stdin channel

+

after it has been opened by a single attach. When stdin is true the stdin

+

stream will remain open across multiple attach sessions. If stdinOnce is

+

set to true, stdin is opened on container start, is empty until the first

+

client attaches to stdin, and then remains open and accepts data until the

+

client disconnects, at which time stdin is closed and remains closed until

+

the container is restarted. If this flag is false, a container processes

+

that reads from stdin will never receive an EOF. Default is false

+

targetContainerName

+

String

+

If set, the name of the container from PodSpec that this ephemeral container targets. The ephemeral container will be run in the namespaces (IPC, PID, etc) of this container. If not set then the ephemeral container uses the namespaces configured in the Pod spec.

+

The container runtime must implement support for this feature. If the runtime does not support namespace targeting then the result of setting this field is undefined.

+

terminationMessagePath

+

String

+

Optional: Path at which the file to which the container's termination message will be written is mounted into the container's filesystem. Message written is intended to be brief final status, such as an assertion failure message. Will be truncated by the node if greater than 4096 bytes. The total message length across all containers will be limited to 12kb. Defaults to /dev/termination-log. Cannot be updated.

+

terminationMessagePolicy

+

String

+

Indicate how the termination message should be populated. File will use the contents of terminationMessagePath to populate the container status message on both success and failure. FallbackToLogsOnError will use the last chunk of container log output if the termination message file is empty and the container exited with an error. The log output is limited to 2048 bytes or 80 lines, whichever is smaller. Defaults to File. Cannot be updated.

+

Possible enum values:

+
  • "FallbackToLogsOnError" will read the most recent contents of the container logs for the container status message when the container exits with an error and the terminationMessagePath has no contents.
  • "File" is the default behavior and will set the container status message to the contents of the container's terminationMessagePath when the container exits.
+

tty

+

Boolean

+

Whether this container should allocate a TTY for itself, also

+

requires 'stdin' to be true. Default is false.

+

volumeMounts

+

Array of io.cci.otc.api.pkg.apis.versioned.cci.v2.VolumeMount objects

+

Pod volumes to mount into the container's filesystem. Subpath

+

mounts are not allowed for ephemeral containers. Cannot be updated.

+

workingDir

+

String

+

Container's working directory. If not specified, the container

+

runtime's default will be used, which might be configured in the container

+

image. Cannot be updated.

+
+
+ +
+ + + + + + + + + + + + + +
Table 18 io.cci.otc.api.pkg.apis.versioned.cci.v2.HostAlias

Parameter

+

Type

+

Description

+

hostnames

+

Array of strings

+

Hostnames for the above IP address.

+

ip

+

String

+

IP address of the host file entry.

+
+
+ +
+ + + + + + + + + +
Table 19 io.cci.otc.api.pkg.apis.versioned.cci.v2.LocalObjectReference

Parameter

+

Type

+

Description

+

name

+

String

+

Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names

+
+
+ +
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Table 20 io.cci.otc.api.pkg.apis.versioned.cci.v2.Container

Parameter

+

Type

+

Description

+

args

+

Array of strings

+

Arguments to the entrypoint. The container image's CMD is used if this is not provided. Variable references $(VAR_NAME) are expanded using the container's environment. If a variable cannot be resolved, the reference in the input string will be unchanged. Double $$ are reduced to a single $, which allows for escaping the $(VAR_NAME) syntax: i.e. "$$(VAR_NAME)" will produce the string literal "$(VAR_NAME)". Escaped references will never be expanded, regardless of whether the variable exists or not. Cannot be updated. More info: https://kubernetes.io/docs/tasks/inject-data-application/define-command-argument-container/#running-a-command-in-a-shell

+

command

+

Array of strings

+

Entrypoint array. Not executed within a shell. The container image's ENTRYPOINT is used if this is not provided. Variable references $(VAR_NAME) are expanded using the container's environment. If a variable cannot be resolved, the reference in the input string will be unchanged. Double $$ are reduced to a single $, which allows for escaping the $(VAR_NAME) syntax: i.e. "$$(VAR_NAME)" will produce the string literal "$(VAR_NAME)". Escaped references will never be expanded, regardless of whether the variable exists or not. Cannot be updated. More info: https://kubernetes.io/docs/tasks/inject-data-application/define-command-argument-container/#running-a-command-in-a-shell

+

env

+

Array of io.cci.otc.api.pkg.apis.versioned.cci.v2.EnvVar objects

+

List of environment variables to set in the container. Cannot

+

be updated.

+

envFrom

+

Array of io.cci.otc.api.pkg.apis.versioned.cci.v2.EnvFromSource objects

+

List of sources to populate environment variables in the container.

+

The keys defined within a source must be a C_IDENTIFIER. All invalid keys

+

will be reported as an event when the container is starting. When a key

+

exists in multiple sources, the value associated with the last source will

+

take precedence. Values defined by an Env with a duplicate key will take

+

precedence. Cannot be updated.

+

image

+

String

+

Container image name. More info: https://kubernetes.io/docs/concepts/containers/images This field is optional to allow higher level config management to default or override container images in workload controllers like Deployments and StatefulSets.

+

lifecycle

+

io.cci.otc.api.pkg.apis.versioned.cci.v2.Lifecycle object

+

Actions that the management system should take in response to

+

container lifecycle events. Cannot be updated.

+

livenessProbe

+

io.cci.otc.api.pkg.apis.versioned.cci.v2.Probe object

+

Periodic probe of container liveness. Container will be restarted if the probe fails. Cannot be updated. More info: https://kubernetes.io/docs/concepts/workloads/pods/pod-lifecycle#container-probes

+

name

+

String

+

Name of the container specified as a DNS_LABEL. Each container

+

in a pod must have a unique name (DNS_LABEL). Cannot be updated.

+

ports

+

Array of io.cci.otc.api.pkg.apis.versioned.cci.v2.ContainerPort objects

+

List of ports to expose from the container. Not specifying a

+

port here DOES NOT prevent that port from being exposed. Any port which

+

is listening on the default "0.0.0.0" address inside a container will be

+

accessible from the network. Modifying this array with strategic merge patch

+

may corrupt the data. For more information See https://github.com/kubernetes/kubernetes/issues/108255.

+

Cannot be updated.

+

readinessProbe

+

io.cci.otc.api.pkg.apis.versioned.cci.v2.Probe object

+

Periodic probe of container service readiness. Container will be removed from service endpoints if the probe fails. Cannot be updated. More info: https://kubernetes.io/docs/concepts/workloads/pods/pod-lifecycle#container-probes

+

resources

+

io.cci.otc.api.pkg.apis.versioned.cci.v2.ResourceRequirements object

+

Compute Resources required by this container. Cannot be updated. More info: https://kubernetes.io/docs/concepts/configuration/manage-resources-containers/

+

securityContext

+

io.cci.otc.api.pkg.apis.versioned.cci.v2.SecurityContext object

+

SecurityContext defines the security options the container should be run with. If set, the fields of SecurityContext override the equivalent fields of PodSecurityContext. More info: https://kubernetes.io/docs/tasks/configure-pod-container/security-context/

+

startupProbe

+

io.cci.otc.api.pkg.apis.versioned.cci.v2.Probe object

+

StartupProbe indicates that the Pod has successfully initialized. If specified, no other probes are executed until this completes successfully. If this probe fails, the Pod will be restarted, just as if the livenessProbe failed. This can be used to provide different probe parameters at the beginning of a Pod's lifecycle, when it might take a long time to load data or warm a cache, than during steady-state operation. This cannot be updated. More info: https://kubernetes.io/docs/concepts/workloads/pods/pod-lifecycle#container-probes

+

stdin

+

Boolean

+

Whether this container should allocate a buffer for stdin in

+

the container runtime. If this is not set, reads from stdin in the container

+

will always result in EOF. Default is false.

+

stdinOnce

+

Boolean

+

Whether the container runtime should close the stdin channel

+

after it has been opened by a single attach. When stdin is true the stdin

+

stream will remain open across multiple attach sessions. If stdinOnce is

+

set to true, stdin is opened on container start, is empty until the first

+

client attaches to stdin, and then remains open and accepts data until the

+

client disconnects, at which time stdin is closed and remains closed until

+

the container is restarted. If this flag is false, a container processes

+

that reads from stdin will never receive an EOF. Default is false

+

terminationMessagePath

+

String

+

Optional: Path at which the file to which the container's termination message will be written is mounted into the container's filesystem. Message written is intended to be brief final status, such as an assertion failure message. Will be truncated by the node if greater than 4096 bytes. The total message length across all containers will be limited to 12kb. Defaults to /dev/termination-log. Cannot be updated.

+

terminationMessagePolicy

+

String

+

Indicate how the termination message should be populated. File will use the contents of terminationMessagePath to populate the container status message on both success and failure. FallbackToLogsOnError will use the last chunk of container log output if the termination message file is empty and the container exited with an error. The log output is limited to 2048 bytes or 80 lines, whichever is smaller. Defaults to File. Cannot be updated.

+

Possible enum values:

+
  • "FallbackToLogsOnError" will read the most recent contents of the container logs for the container status message when the container exits with an error and the terminationMessagePath has no contents.
  • "File" is the default behavior and will set the container status message to the contents of the container's terminationMessagePath when the container exits.
+

tty

+

Boolean

+

Whether this container should allocate a TTY for itself, also

+

requires 'stdin' to be true. Default is false.

+

volumeMounts

+

Array of io.cci.otc.api.pkg.apis.versioned.cci.v2.VolumeMount objects

+

Pod volumes to mount into the container's filesystem. Cannot

+

be updated.

+

workingDir

+

String

+

Container's working directory. If not specified, the container

+

runtime's default will be used, which might be configured in the container

+

image. Cannot be updated.

+
+
+ +
+ + + + + + + + + + + + + + + + + +
Table 21 io.cci.otc.api.pkg.apis.versioned.cci.v2.EnvVar

Parameter

+

Type

+

Description

+

name

+

String

+

Name of the environment variable. Must be a C_IDENTIFIER.

+

value

+

String

+

Variable references $(VAR_NAME) are expanded using the previously defined environment variables in the container and any service environment variables. If a variable cannot be resolved, the reference in the input string will be unchanged. Double $$ are reduced to a single $, which allows for escaping the $(VAR_NAME) syntax: i.e. "$$(VAR_NAME)" will produce the string literal "$(VAR_NAME)". Escaped references will never be expanded, regardless of whether the variable exists or not. Defaults to "".

+

valueFrom

+

io.cci.otc.api.pkg.apis.versioned.cci.v2.EnvVarSource object

+

Source for the environment variable's value. Cannot be used if

+

value is not empty.

+
+
+ +
+ + + + + + + + + + + + + + + + + + + + + +
Table 22 io.cci.otc.api.pkg.apis.versioned.cci.v2.EnvVarSource

Parameter

+

Type

+

Description

+

configMapKeyRef

+

io.cci.otc.api.pkg.apis.versioned.cci.v2.ConfigMapKeySelector object

+

Selects a key of a ConfigMap.

+

fieldRef

+

io.cci.otc.api.pkg.apis.versioned.cci.v2.ObjectFieldSelector object

+

Selects a field of the pod: supports metadata.name, metadata.namespace, metadata.labels['<KEY>'], metadata.annotations['<KEY>'], spec.nodeName, spec.serviceAccountName, status.hostIP, status.podIP, status.podIPs.

+

resourceFieldRef

+

io.cci.otc.api.pkg.apis.versioned.cci.v2.ResourceFieldSelector object

+

Selects a resource of the container: only resources limits and requests (limits.cpu, limits.memory, limits.ephemeral-storage, requests.cpu, requests.memory and requests.ephemeral-storage) are currently supported.

+

secretKeyRef

+

io.cci.otc.api.pkg.apis.versioned.cci.v2.SecretKeySelector object

+

Selects a key of a secret in the pod's namespace

+
+
+ +
+ + + + + + + + + + + + + + + + + +
Table 23 io.cci.otc.api.pkg.apis.versioned.cci.v2.ConfigMapKeySelector

Parameter

+

Type

+

Description

+

key

+

String

+

The key to select.

+

name

+

String

+

Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names

+

optional

+

Boolean

+

Specify whether the ConfigMap or its key must be defined

+
+
+ +
+ + + + + + + + + + + + + + + + + +
Table 24 io.cci.otc.api.pkg.apis.versioned.cci.v2.SecretKeySelector

Parameter

+

Type

+

Description

+

key

+

String

+

The key of the secret to select from. Must be a valid secret

+

key.

+

name

+

String

+

Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names

+

optional

+

Boolean

+

Specify whether the Secret or its key must be defined

+
+
+ +
+ + + + + + + + + + + + + + + + + +
Table 25 io.cci.otc.api.pkg.apis.versioned.cci.v2.EnvFromSource

Parameter

+

Type

+

Description

+

configMapRef

+

io.cci.otc.api.pkg.apis.versioned.cci.v2.ConfigMapEnvSource object

+

The ConfigMap to select from

+

prefix

+

String

+

An optional identifier to prepend to each key in the ConfigMap.

+

Must be a C_IDENTIFIER.

+

secretRef

+

io.cci.otc.api.pkg.apis.versioned.cci.v2.SecretEnvSource object

+

The Secret to select from

+
+
+ +
+ + + + + + + + + + + + + +
Table 26 io.cci.otc.api.pkg.apis.versioned.cci.v2.ConfigMapEnvSource

Parameter

+

Type

+

Description

+

name

+

String

+

Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names

+

optional

+

Boolean

+

Specify whether the ConfigMap must be defined

+
+
+ +
+ + + + + + + + + + + + + +
Table 27 io.cci.otc.api.pkg.apis.versioned.cci.v2.SecretEnvSource

Parameter

+

Type

+

Description

+

name

+

String

+

Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names

+

optional

+

Boolean

+

Specify whether the Secret must be defined

+
+
+ +
+ + + + + + + + + + + + + +
Table 28 io.cci.otc.api.pkg.apis.versioned.cci.v2.Lifecycle

Parameter

+

Type

+

Description

+

postStart

+

io.cci.otc.api.pkg.apis.versioned.cci.v2.LifecycleHandler object

+

PostStart is called immediately after a container is created. If the handler fails, the container is terminated and restarted according to its restart policy. Other management of the container blocks until the hook completes. More info: https://kubernetes.io/docs/concepts/containers/container-lifecycle-hooks/#container-hooks

+

preStop

+

io.cci.otc.api.pkg.apis.versioned.cci.v2.LifecycleHandler object

+

PreStop is called immediately before a container is terminated due to an API request or management event such as liveness/startup probe failure, preemption, resource contention, etc. The handler is not called if the container crashes or exits. The Pod's termination grace period countdown begins before the PreStop hook is executed. Regardless of the outcome of the handler, the container will eventually terminate within the Pod's termination grace period (unless delayed by finalizers). Other management of the container blocks until the hook completes or until the termination grace period is reached. More info: https://kubernetes.io/docs/concepts/containers/container-lifecycle-hooks/#container-hooks

+
+
+ +
+ + + + + + + + + + + + + +
Table 29 io.cci.otc.api.pkg.apis.versioned.cci.v2.LifecycleHandler

Parameter

+

Type

+

Description

+

exec

+

io.cci.otc.api.pkg.apis.versioned.cci.v2.ExecAction object

+

Exec specifies the action to take.

+

httpGet

+

io.cci.otc.api.pkg.apis.versioned.cci.v2.HTTPGetAction object

+

HTTPGet specifies the http request to perform.

+
+
+ +
+ + + + + + + + + + + + + + + + + +
Table 30 io.cci.otc.api.pkg.apis.versioned.cci.v2.ContainerPort

Parameter

+

Type

+

Description

+

containerPort

+

Integer

+

Number of port to expose on the pod's IP address. This must be

+

a valid port number, 0 < x < 65536.

+

name

+

String

+

If specified, this must be an IANA_SVC_NAME and unique within

+

the pod. Each named port in a pod must have a unique name. Name for the

+

port that can be referred to by services.

+

protocol

+

String

+

Protocol for port. Must be UDP, TCP, or SCTP. Defaults to "TCP".

+

Possible enum values:

+
  • "SCTP" is the SCTP protocol.
  • "TCP" is the TCP protocol.
  • "UDP" is the UDP protocol.
+
+
+ +
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Table 31 io.cci.otc.api.pkg.apis.versioned.cci.v2.SecurityContext

Parameter

+

Type

+

Description

+

capabilities

+

io.cci.otc.api.pkg.apis.versioned.cci.v2.Capabilities object

+

The capabilities to add/drop when running containers. Defaults

+

to the default set of capabilities granted by the container runtime. Note

+

that this field cannot be set when spec.os.name is windows.

+

procMount

+

String

+

procMount denotes the type of proc mount to use for the containers.

+

The default is DefaultProcMount which uses the container runtime defaults

+

for readonly paths and masked paths. This requires the ProcMountType feature

+

flag to be enabled. Note that this field cannot be set when spec.os.name

+

is windows.

+

readOnlyRootFilesystem

+

Boolean

+

Whether this container has a read-only root filesystem. Default

+

is false. Note that this field cannot be set when spec.os.name is windows.

+

runAsGroup

+

Long

+

The GID to run the entrypoint of the container process. Uses

+

runtime default if unset. May also be set in PodSecurityContext. If set

+

in both SecurityContext and PodSecurityContext, the value specified in SecurityContext

+

takes precedence. Note that this field cannot be set when spec.os.name is

+

windows.

+

runAsNonRoot

+

Boolean

+

Indicates that the container must run as a non-root user. If

+

true, the Kubelet will validate the image at runtime to ensure that it does

+

not run as UID 0 (root) and fail to start the container if it does. If unset

+

or false, no such validation will be performed. May also be set in PodSecurityContext. If

+

set in both SecurityContext and PodSecurityContext, the value specified

+

in SecurityContext takes precedence.

+

runAsUser

+

Long

+

The UID to run the entrypoint of the container process. Defaults

+

to user specified in image metadata if unspecified. May also be set in PodSecurityContext. If

+

set in both SecurityContext and PodSecurityContext, the value specified

+

in SecurityContext takes precedence. Note that this field cannot be set

+

when spec.os.name is windows.

+
+
+ +
+ + + + + + + + + + + + + +
Table 32 io.cci.otc.api.pkg.apis.versioned.cci.v2.Capabilities

Parameter

+

Type

+

Description

+

add

+

Array of strings

+

Added capabilities

+

drop

+

Array of strings

+

Removed capabilities

+
+
+ +
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Table 33 io.cci.otc.api.pkg.apis.versioned.cci.v2.Probe

Parameter

+

Type

+

Description

+

exec

+

io.cci.otc.api.pkg.apis.versioned.cci.v2.ExecAction object

+

Exec specifies the action to take.

+

failureThreshold

+

Integer

+

Minimum consecutive failures for the probe to be considered failed

+

after having succeeded. Defaults to 3. Minimum value is 1.

+

httpGet

+

io.cci.otc.api.pkg.apis.versioned.cci.v2.HTTPGetAction object

+

HTTPGet specifies the http request to perform.

+

initialDelaySeconds

+

Integer

+

Number of seconds after the container has started before liveness probes are initiated. More info: https://kubernetes.io/docs/concepts/workloads/pods/pod-lifecycle#container-probes

+

periodSeconds

+

Integer

+

How often (in seconds) to perform the probe. Default to 10 seconds.

+

Minimum value is 1.

+

successThreshold

+

Integer

+

Minimum consecutive successes for the probe to be considered

+

successful after having failed. Defaults to 1. Must be 1 for liveness and

+

startup. Minimum value is 1.

+

tcpSocket

+

io.cci.otc.api.pkg.apis.versioned.cci.v2.TCPSocketAction object

+

TCPSocket specifies an action involving a TCP port.

+

terminationGracePeriodSeconds

+

Long

+

Optional duration in seconds the pod needs to terminate gracefully

+

upon probe failure. The grace period is the duration in seconds after the

+

processes running in the pod are sent a termination signal and the time

+

when the processes are forcibly halted with a kill signal. Set this value

+

longer than the expected cleanup time for your process. If this value is

+

nil, the pod's terminationGracePeriodSeconds will be used. Otherwise, this

+

value overrides the value provided by the pod spec. Value must be non-negative

+

integer. The value zero indicates stop immediately via the kill signal (no

+

opportunity to shut down). This is a beta field and requires enabling ProbeTerminationGracePeriod

+

feature gate. Minimum value is 1. spec.terminationGracePeriodSeconds is

+

used if unset.

+

timeoutSeconds

+

Integer

+

Number of seconds after which the probe times out. Defaults to 1 second. Minimum value is 1. More info: https://kubernetes.io/docs/concepts/workloads/pods/pod-lifecycle#container-probes

+
+
+ +
+ + + + + + + + + +
Table 34 io.cci.otc.api.pkg.apis.versioned.cci.v2.ExecAction

Parameter

+

Type

+

Description

+

command

+

Array of strings

+

Command is the command line to execute inside the container,

+

the working directory for the command is root ('/') in the container's

+

filesystem. The command is simply exec'd, it is not run inside a shell,

+

so traditional shell instructions ('|', etc) won't work. To use a shell,

+

you need to explicitly call out to that shell. Exit status of 0 is treated

+

as live/healthy and non-zero is unhealthy.

+
+
+ +
+ + + + + + + + + + + + + + + + + + + + + + + + + +
Table 35 io.cci.otc.api.pkg.apis.versioned.cci.v2.HTTPGetAction

Parameter

+

Type

+

Description

+

host

+

String

+

Host name to connect to, defaults to the pod IP. You probably

+

want to set "Host" in httpHeaders instead.

+

httpHeaders

+

Array of io.cci.otc.api.pkg.apis.versioned.cci.v2.HTTPHeader objects

+

Custom headers to set in the request. HTTP allows repeated headers.

+

path

+

String

+

Path to access on the HTTP server.

+

port

+

String

+

Name or number of the port to access on the container. Number

+

must be in the range 1 to 65535. Name must be an IANA_SVC_NAME.

+

scheme

+

String

+

Scheme to use for connecting to the host. Defaults to HTTP.

+

Possible enum values:

+
  • "HTTP" means that the scheme used will be http://
  • "HTTPS" means that the scheme used will be https://
+
+
+ +
+ + + + + + + + + + + + + +
Table 36 io.cci.otc.api.pkg.apis.versioned.cci.v2.HTTPHeader

Parameter

+

Type

+

Description

+

name

+

String

+

The header field name

+

value

+

String

+

The header field value

+
+
+ +
+ + + + + + + + + + + + + +
Table 37 io.cci.otc.api.pkg.apis.versioned.cci.v2.TCPSocketAction

Parameter

+

Type

+

Description

+

host

+

String

+

Optional: Host name to connect to, defaults to the pod IP.

+

port

+

String

+

Number or name of the port to access on the container. Number

+

must be in the range 1 to 65535. Name must be an IANA_SVC_NAME.

+
+
+ +
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Table 38 io.cci.otc.api.pkg.apis.versioned.cci.v2.VolumeMount

Parameter

+

Type

+

Description

+

extendPathMode

+

String

+

Extend the volume path by appending the pod metadata to the path

+

according to specified pattern. which provide a way of directory isolation

+

and help prevent the writing conflict between different pods.

+

mountPath

+

String

+

Path within the container at which the volume should be mounted. Must

+

not contain ':'.

+

name

+

String

+

This must match the Name of a Volume.

+

readOnly

+

Boolean

+

Mounted read-only if true, read-write otherwise (false or unspecified).

+

Defaults to false.

+

subPath

+

String

+

Path within the volume from which the container's volume should

+

be mounted. Defaults to "" (volume's root).

+

subPathExpr

+

String

+

Expanded path within the volume from which the container's volume

+

should be mounted. Behaves similarly to SubPath but environment variable

+

references $(VAR_NAME) are expanded using the container's environment. Defaults

+

to "" (volume's root). SubPathExpr and SubPath are mutually exclusive.

+
+
+ +
+ + + + + + + + + +
Table 39 io.cci.otc.api.pkg.apis.versioned.cci.v2.PodReadinessGate

Parameter

+

Type

+

Description

+

conditionType

+

String

+

ConditionType refers to a condition in the pod's condition list

+

with matching type.

+
+
+ +
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Table 40 io.cci.otc.api.pkg.apis.versioned.cci.v2.PodSecurityContext

Parameter

+

Type

+

Description

+

fsGroup

+

Long

+

A special supplemental group that applies to all containers in a pod. Some volume types allow the Kubelet to change the ownership of that volume to be owned by the pod:

+
  1. The owning GID will be the FSGroup 2. The setgid bit is set (new files created in the volume will be owned by FSGroup) 3. The permission bits are OR'd with rw-rw----
+

If unset, the Kubelet will not modify the ownership and permissions of any volume. Note that this field cannot be set when spec.os.name is windows.

+

fsGroupChangePolicy

+

String

+

fsGroupChangePolicy defines behavior of changing ownership and permission of the volume before being exposed inside Pod. This field will only apply to volume types which support fsGroup based ownership(and permissions). It will have no effect on ephemeral volume types such as: secret, configmaps and emptydir. Valid values are "OnRootMismatch" and "Always". If not specified, "Always" is used. Note that this field cannot be set when spec.os.name is windows.

+

runAsGroup

+

Long

+

The GID to run the entrypoint of the container process. Uses

+

runtime default if unset. May also be set in SecurityContext. If set in

+

both SecurityContext and PodSecurityContext, the value specified in SecurityContext

+

takes precedence for that container. Note that this field cannot be set

+

when spec.os.name is windows.

+

runAsNonRoot

+

Boolean

+

Indicates that the container must run as a non-root user. If

+

true, the Kubelet will validate the image at runtime to ensure that it does

+

not run as UID 0 (root) and fail to start the container if it does. If unset

+

or false, no such validation will be performed. May also be set in SecurityContext. If

+

set in both SecurityContext and PodSecurityContext, the value specified

+

in SecurityContext takes precedence.

+

runAsUser

+

Long

+

The UID to run the entrypoint of the container process. Defaults

+

to user specified in image metadata if unspecified. May also be set in SecurityContext. If

+

set in both SecurityContext and PodSecurityContext, the value specified

+

in SecurityContext takes precedence for that container. Note that this field

+

cannot be set when spec.os.name is windows.

+

supplementalGroups

+

Array of longs

+

A list of groups applied to the first process run in each container,

+

in addition to the container's primary GID. If unspecified, no groups will

+

be added to any container. Note that this field cannot be set when spec.os.name

+

is windows.

+

sysctls

+

Array of io.cci.otc.api.pkg.apis.versioned.cci.v2.Sysctl objects

+

Sysctls hold a list of namespaced sysctls used for the pod. Pods

+

with unsupported sysctls (by the container runtime) might fail to launch.

+

Note that this field cannot be set when spec.os.name is windows.

+
+
+ +
+ + + + + + + + + + + + + +
Table 41 io.cci.otc.api.pkg.apis.versioned.cci.v2.Sysctl

Parameter

+

Type

+

Description

+

name

+

String

+

Name of a property to set

+

value

+

String

+

Value of a property to set

+
+
+ +
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Table 42 io.cci.otc.api.pkg.apis.versioned.cci.v2.TopologySpreadConstraint

Parameter

+

Type

+

Description

+

labelSelector

+

io.k8s.apimachinery.pkg.apis.meta.v1.LabelSelector object

+

LabelSelector is used to find matching pods. Pods that match

+

this label selector are counted to determine the number of pods in their

+

corresponding topology domain.

+

matchLabelKeys

+

Array of strings

+

MatchLabelKeys is a set of pod label keys to select the pods

+

over which spreading will be calculated. The keys are used to lookup values

+

from the incoming pod labels, those key-value labels are ANDed with labelSelector

+

to select the group of existing pods over which spreading will be calculated

+

for the incoming pod. Keys that don't exist in the incoming pod labels will

+

be ignored. A null or empty list means only match against labelSelector.

+

maxSkew

+

Integer

+

MaxSkew describes the degree to which pods may be unevenly distributed. When whenUnsatisfiable=DoNotSchedule, it is the maximum permitted difference between the number of matching pods in the target topology and the global minimum. The global minimum is the minimum number of matching pods in an eligible domain or zero if the number of eligible domains is less than MinDomains. For example, in a 3-zone cluster, MaxSkew is set to 1, and pods with the same labelSelector spread as 2/2/1: In this case, the global minimum is 1. | zone1 | zone2 | zone3 | | P P | P P | P | - if MaxSkew is 1, incoming pod can only be scheduled to zone3 to become 2/2/2; scheduling it onto zone1(zone2) would make the ActualSkew(3-1) on zone1(zone2) violate MaxSkew(1). - if MaxSkew is 2, incoming pod can be scheduled onto any zone. When whenUnsatisfiable=ScheduleAnyway, it is used to give higher precedence to topologies that satisfy it. It's a required field. Default value is 1 and 0 is not allowed.

+

minDomains

+

Integer

+

MinDomains indicates a minimum number of eligible domains. When the number of eligible domains with matching topology keys is less than minDomains, Pod Topology Spread treats "global minimum" as 0, and then the calculation of Skew is performed. And when the number of eligible domains with matching topology keys equals or greater than minDomains, this value has no effect on scheduling. As a result, when the number of eligible domains is less than minDomains, scheduler won't schedule more than maxSkew Pods to those domains. If value is nil, the constraint behaves as if MinDomains is equal to 1. Valid values are integers greater than 0. When value is not nil, WhenUnsatisfiable must be DoNotSchedule.

+

For example, in a 3-zone cluster, MaxSkew is set to 2, MinDomains is set to 5 and pods with the same labelSelector spread as 2/2/2: | zone1 | zone2 | zone3 | | P P | P P | P P | The number of domains is less than 5(MinDomains), so "global minimum" is treated as 0. In this situation, new pod with the same labelSelector cannot be scheduled, because computed skew will be 3(3 - 0) if new Pod is scheduled to any of the three zones, it will violate MaxSkew.

+

This is a beta field and requires the MinDomainsInPodTopologySpread feature gate to be enabled (enabled by default).

+

nodeAffinityPolicy

+

String

+

NodeAffinityPolicy indicates how we will treat Pod's nodeAffinity/nodeSelector when calculating pod topology spread skew. Options are: - Honor: only nodes matching nodeAffinity/nodeSelector are included in the calculations. - Ignore: nodeAffinity/nodeSelector are ignored. All nodes are included in the calculations.

+

If this value is nil, the behavior is equivalent to the Honor policy. This is a alpha-level feature enabled by the NodeInclusionPolicyInPodTopologySpread feature flag.

+

nodeTaintsPolicy

+

String

+

NodeTaintsPolicy indicates how we will treat node taints when calculating pod topology spread skew. Options are: - Honor: nodes without taints, along with tainted nodes for which the incoming pod has a toleration, are included. - Ignore: node taints are ignored. All nodes are included.

+

If this value is nil, the behavior is equivalent to the Ignore policy. This is a alpha-level feature enabled by the NodeInclusionPolicyInPodTopologySpread feature flag.

+

topologyKey

+

String

+

TopologyKey is the key of node labels. Nodes that have a label

+

with this key and identical values are considered to be in the same topology.

+

We consider each <key, value> as a "bucket", and try to put balanced number

+

of pods into each bucket. We define a domain as a particular instance of

+

a topology. Also, we define an eligible domain as a domain whose nodes meet

+

the requirements of nodeAffinityPolicy and nodeTaintsPolicy. e.g. If TopologyKey

+

is "kubernetes.io/hostname", each Node is a domain of that topology. And,

+

if TopologyKey is "topology.kubernetes.io/zone", each zone is a domain of

+

that topology. It's a required field.

+

whenUnsatisfiable

+

String

+

WhenUnsatisfiable indicates how to deal with a pod if it doesn't satisfy the spread constraint. - DoNotSchedule (default) tells the scheduler not to schedule it. - ScheduleAnyway tells the scheduler to schedule the pod in any location,

+

but giving higher precedence to topologies that would help reduce the

+

skew.

+

A constraint is considered "Unsatisfiable" for an incoming pod if and only if every possible node assignment for that pod would violate "MaxSkew" on some topology. For example, in a 3-zone cluster, MaxSkew is set to 1, and pods with the same labelSelector spread as 3/1/1: | zone1 | zone2 | zone3 | | P P P | P | P | If WhenUnsatisfiable is set to DoNotSchedule, incoming pod can only be scheduled to zone2(zone3) to become 3/2/1(3/1/2) as ActualSkew(2-1) on zone2(zone3) satisfies MaxSkew(1). In other words, the cluster can still be imbalanced, but scheduler won't make it more imbalanced. It's a required field.

+

Possible enum values:

+
  • "DoNotSchedule" instructs the scheduler not to schedule the pod when constraints are not satisfied.
  • "ScheduleAnyway" instructs the scheduler to schedule the pod even if constraints are not satisfied.
+
+
+ +
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Table 43 io.cci.otc.api.pkg.apis.versioned.cci.v2.Volume

Parameter

+

Type

+

Description

+

configMap

+

io.cci.otc.api.pkg.apis.versioned.cci.v2.ConfigMapVolumeSource object

+

configMap represents a configMap that should populate this volume

+

downwardAPI

+

io.cci.otc.api.pkg.apis.versioned.cci.v2.DownwardAPIVolumeSource object

+

downwardAPI represents downward API about the pod that should

+

populate this volume

+

emptyDir

+

io.cci.otc.api.pkg.apis.versioned.cci.v2.EmptyDirVolumeSource object

+

emptyDir represents a temporary directory that shares a pod's lifetime. More info: https://kubernetes.io/docs/concepts/storage/volumes#emptydir

+

ephemeral

+

io.cci.otc.api.pkg.apis.versioned.cci.v2.EphemeralVolumeSource object

+

ephemeral represents a volume that is handled by a cluster storage driver. The volume's lifecycle is tied to the pod that defines it - it will be created before the pod starts, and deleted when the pod is removed.

+

Use this if: a) the volume is only needed while the pod runs, b) features of normal volumes like restoring from snapshot or capacity

+

tracking are needed,

+

c) the storage driver is specified through a storage class, and d) the storage driver supports dynamic volume provisioning through

+

a PersistentVolumeClaim (see EphemeralVolumeSource for more

+

information on the connection between this volume type

+

and PersistentVolumeClaim).

+

Use PersistentVolumeClaim or one of the vendor-specific APIs for volumes that persist for longer than the lifecycle of an individual pod.

+

Use CSI for light-weight local ephemeral volumes if the CSI driver is meant to be used that way - see the documentation of the driver for more information.

+

A pod can use both types of ephemeral volumes and persistent volumes at the same time.

+

name

+

String

+

name of the volume. Must be a DNS_LABEL and unique within the pod. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names

+

nfs

+

io.cci.otc.api.pkg.apis.versioned.cci.v2.NFSVolumeSource object

+

nfs represents an NFS mount on the host that shares a pod's lifetime More info: https://kubernetes.io/docs/concepts/storage/volumes#nfs

+

persistentVolumeClaim

+

io.cci.otc.api.pkg.apis.versioned.cci.v2.PersistentVolumeClaimVolumeSource object

+

persistentVolumeClaimVolumeSource represents a reference to a PersistentVolumeClaim in the same namespace. More info: https://kubernetes.io/docs/concepts/storage/persistent-volumes#persistentvolumeclaims

+

projected

+

io.cci.otc.api.pkg.apis.versioned.cci.v2.ProjectedVolumeSource object

+

projected items for all in one resources secrets, configmaps,

+

and downward API

+

secret

+

io.cci.otc.api.pkg.apis.versioned.cci.v2.SecretVolumeSource object

+

secret represents a secret that should populate this volume. More info: https://kubernetes.io/docs/concepts/storage/volumes#secret

+
+
+ +
+ + + + + + + + + + + + + + + + + + + + + +
Table 44 io.cci.otc.api.pkg.apis.versioned.cci.v2.ConfigMapVolumeSource

Parameter

+

Type

+

Description

+

defaultMode

+

Integer

+

defaultMode is optional: mode bits used to set permissions on created files by default. Must be an octal value between 0000 and 0777 or a decimal value between 0 and 511. YAML accepts both octal and decimal values, JSON requires decimal values for mode bits. Defaults to 0644. Directories within the path are not affected by this setting. This might be in conflict with other options that affect the file mode, like fsGroup, and the result can be other mode bits set.

+

items

+

Array of io.cci.otc.api.pkg.apis.versioned.cci.v2.KeyToPath objects

+

items if unspecified, each key-value pair in the Data field of

+

the referenced ConfigMap will be projected into the volume as a file whose

+

name is the key and content is the value. If specified, the listed keys

+

will be projected into the specified paths, and unlisted keys will not be

+

present. If a key is specified which is not present in the ConfigMap, the

+

volume setup will error unless it is marked optional. Paths must be relative

+

and may not contain the '..' path or start with '..'.

+

name

+

String

+

Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names

+

optional

+

Boolean

+

optional specify whether the ConfigMap or its keys must be defined

+
+
+ +
+ + + + + + + + + + + + + +
Table 45 io.cci.otc.api.pkg.apis.versioned.cci.v2.DownwardAPIVolumeSource

Parameter

+

Type

+

Description

+

defaultMode

+

Integer

+

Optional: mode bits to use on created files by default. Must be a Optional: mode bits used to set permissions on created files by default. Must be an octal value between 0000 and 0777 or a decimal value between 0 and 511. YAML accepts both octal and decimal values, JSON requires decimal values for mode bits. Defaults to 0644. Directories within the path are not affected by this setting. This might be in conflict with other options that affect the file mode, like fsGroup, and the result can be other mode bits set.

+

items

+

Array of io.cci.otc.api.pkg.apis.versioned.cci.v2.DownwardAPIVolumeFile objects

+

Items is a list of downward API volume file

+
+
+ +
+ + + + + + + + + + + + + +
Table 46 io.cci.otc.api.pkg.apis.versioned.cci.v2.EmptyDirVolumeSource

Parameter

+

Type

+

Description

+

medium

+

String

+

medium represents what type of storage medium should back this directory. The default is "" which means to use the node's default medium. Must be an empty string (default) or Memory. More info: https://kubernetes.io/docs/concepts/storage/volumes#emptydir

+

sizeLimit

+

String

+

sizeLimit is the total amount of local storage required for this EmptyDir volume. The size limit is also applicable for memory medium. The maximum usage on memory medium EmptyDir would be the minimum value between the SizeLimit specified here and the sum of memory limits of all containers in a pod. The default is nil which means that the limit is undefined. More info: http://kubernetes.io/docs/user-guide/volumes#emptydir

+
+
+ +
+ + + + + + + + + +
Table 47 io.cci.otc.api.pkg.apis.versioned.cci.v2.EphemeralVolumeSource

Parameter

+

Type

+

Description

+

volumeClaimTemplate

+

io.cci.otc.api.pkg.apis.versioned.cci.v2.PersistentVolumeClaimTemplate object

+

Will be used to create a stand-alone PVC to provision the volume. The pod in which this EphemeralVolumeSource is embedded will be the owner of the PVC, i.e. the PVC will be deleted together with the pod. The name of the PVC will be <pod name>-<volume name> where <volume name> is the name from the PodSpec.Volumes array entry. Pod validation will reject the pod if the concatenated name is not valid for a PVC (for example, too long).

+

An existing PVC with that name that is not owned by the pod will not be used for the pod to avoid using an unrelated volume by mistake. Starting the pod is then blocked until the unrelated PVC is removed. If such a pre-created PVC is meant to be used by the pod, the PVC has to updated with an owner reference to the pod once the pod exists. Normally this should not be necessary, but it may be useful when manually reconstructing a broken cluster.

+

This field is read-only and no changes will be made by Kubernetes to the PVC after it has been created.

+

Required, must not be nil.

+
+
+ +
+ + + + + + + + + + + + + +
Table 48 io.cci.otc.api.pkg.apis.versioned.cci.v2.PersistentVolumeClaimTemplate

Parameter

+

Type

+

Description

+

metadata

+

io.k8s.apimachinery.pkg.apis.meta.v1.ObjectMeta object

+

May contain labels and annotations that will be copied into the

+

PVC when creating it. No other fields are allowed and will be rejected during

+

validation.

+

spec

+

io.cci.otc.api.pkg.apis.versioned.cci.v2.PersistentVolumeClaimSpec object

+

The specification for the PersistentVolumeClaim. The entire content

+

is copied unchanged into the PVC that gets created from this template. The

+

same fields as in a PersistentVolumeClaim are also valid here.

+
+
+ +
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Table 49 io.k8s.apimachinery.pkg.apis.meta.v1.ObjectMeta

Parameter

+

Type

+

Description

+

annotations

+

Map<String,String>

+

Annotations is an unstructured key value map stored with a resource that may be set by external tools to store and retrieve arbitrary metadata. They are not queryable and should be preserved when modifying objects. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/annotations/

+

clusterName

+

String

+

The name of the cluster which the object belongs to. This is

+

used to distinguish resources with same name and namespace in different

+

clusters. This field is not set anywhere right now and apiserver is going

+

to ignore it if set in create or update request.

+

creationTimestamp

+

String

+

CreationTimestamp is a timestamp representing the server time when this object was created. It is not guaranteed to be set in happens-before order across separate operations. Clients may not set this value. It is represented in RFC3339 form and is in UTC.

+

Populated by the system. Read-only. Null for lists. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata

+

deletionGracePeriodSeconds

+

Long

+

Number of seconds allowed for this object to gracefully terminate

+

before it will be removed from the system. Only set when deletionTimestamp

+

is also set. May only be shortened. Read-only.

+

deletionTimestamp

+

String

+

DeletionTimestamp is RFC 3339 date and time at which this resource will be deleted. This field is set by the server when a graceful deletion is requested by the user, and is not directly settable by a client. The resource is expected to be deleted (no longer visible from resource lists, and not reachable by name) after the time in this field, once the finalizers list is empty. As long as the finalizers list contains items, deletion is blocked. Once the deletionTimestamp is set, this value may not be unset or be set further into the future, although it may be shortened or the resource may be deleted prior to this time. For example, a user may request that a pod is deleted in 30 seconds. The Kubelet will react by sending a graceful termination signal to the containers in the pod. After that 30 seconds, the Kubelet will send a hard termination signal (SIGKILL) to the container and after cleanup, remove the pod from the API. In the presence of network partitions, this object may still exist after this timestamp, until an administrator or automated process can determine the resource is fully terminated. If not set, graceful deletion of the object has not been requested.

+

Populated by the system when a graceful deletion is requested. Read-only. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata

+

enable

+

Boolean

+

Enable identify whether the resource is available

+

finalizers

+

Array of strings

+

Must be empty before the object is deleted from the registry.

+

Each entry is an identifier for the responsible component that will remove

+

the entry from the list. If the deletionTimestamp of the object is non-nil,

+

entries in this list can only be removed. Finalizers may be processed and

+

removed in any order. Order is NOT enforced because it introduces significant

+

risk of stuck finalizers. finalizers is a shared field, any actor with permission

+

can reorder it. If the finalizer list is processed in order, then this can

+

lead to a situation in which the component responsible for the first finalizer

+

in the list is waiting for a signal (field value, external system, or other)

+

produced by a component responsible for a finalizer later in the list, resulting

+

in a deadlock. Without enforced ordering finalizers are free to order amongst

+

themselves and are not vulnerable to ordering changes in the list.

+

generateName

+

String

+

GenerateName is an optional prefix, used by the server, to generate a unique name ONLY IF the Name field has not been provided. If this field is used, the name returned to the client will be different than the name passed. This value will also be combined with a unique suffix. The provided value has the same validation rules as the Name field, and may be truncated by the length of the suffix required to make the value unique on the server.

+

If this field is specified and the generated name exists, the server will NOT return a 409 - instead, it will either return 201 Created or 500 with Reason ServerTimeout indicating a unique name could not be found in the time allotted, and the client should retry (optionally after the time indicated in the Retry-After header).

+

Applied only if Name is not specified. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#idempotency

+

generation

+

Long

+

A sequence number representing a specific generation of the desired

+

state. Populated by the system. Read-only.

+

labels

+

Map<String,String>

+

Map of string keys and values that can be used to organize and categorize (scope and select) objects. May match selectors of replication controllers and services. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/labels/

+

managedFields

+

Array of io.k8s.apimachinery.pkg.apis.meta.v1.ManagedFieldsEntry objects

+

ManagedFields maps workflow-id and version to the set of fields

+

that are managed by that workflow. This is mostly for internal housekeeping,

+

and users typically shouldn't need to set or understand this field. A workflow

+

can be the user's name, a controller's name, or the name of a specific apply

+

path like "ci-cd". The set of fields is always in the version that the workflow

+

used when modifying the object.

+

name

+

String

+

Name must be unique within a namespace. Is required when creating resources, although some resources may allow a client to request the generation of an appropriate name automatically. Name is primarily intended for creation idempotence and configuration definition. Cannot be updated. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names

+

namespace

+

String

+

Namespace defines the space within which each name must be unique. An empty namespace is equivalent to the "default" namespace, but "default" is the canonical representation. Not all objects are required to be scoped to a namespace - the value of this field for those objects will be empty.

+

Must be a DNS_LABEL. Cannot be updated. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/namespaces/

+

ownerReferences

+

Array of io.k8s.apimachinery.pkg.apis.meta.v1.OwnerReference objects

+

List of objects depended by this object. If ALL objects in the

+

list have been deleted, this object will be garbage collected. If this object

+

is managed by a controller, then an entry in this list will point to this

+

controller, with the controller field set to true. There cannot be more

+

than one managing controller.

+

resourceVersion

+

String

+

An opaque value that represents the internal version of this object that can be used by clients to determine when objects have changed. May be used for optimistic concurrency, change detection, and the watch operation on a resource or set of resources. Clients must treat these values as opaque and passed unmodified back to the server. They may only be valid for a particular resource or set of resources.

+

Populated by the system. Read-only. Value must be treated as opaque by clients and . More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#concurrency-control-and-consistency

+

selfLink

+

String

+

SelfLink is a URL representing this object. Populated by the system. Read-only.

+

DEPRECATED Kubernetes will stop propagating this field in 1.20 release and the field is planned to be removed in 1.21 release.

+

uid

+

String

+

UID is the unique in time and space value for this object. It is typically generated by the server on successful creation of a resource and is not allowed to change on PUT operations.

+

Populated by the system. Read-only. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#uids

+
+
+ +
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Table 50 io.k8s.apimachinery.pkg.apis.meta.v1.ManagedFieldsEntry

Parameter

+

Type

+

Description

+

apiVersion

+

String

+

APIVersion defines the version of this resource that this field

+

set applies to. The format is "group/version" just like the top-level APIVersion

+

field. It is necessary to track the version of a field set because it cannot

+

be automatically converted.

+

fieldsType

+

String

+

FieldsType is the discriminator for the different fields format and version. There is currently only one possible value: "FieldsV1"

+

fieldsV1

+

Object

+

FieldsV1 holds the first JSON version format as described in

+

the "FieldsV1" type.

+

manager

+

String

+

Manager is an identifier of the workflow managing these fields.

+

operation

+

String

+

Operation is the type of operation which lead to this ManagedFieldsEntry

+

being created. The only valid values for this field are 'Apply' and 'Update'.

+

time

+

String

+

Time is timestamp of when these fields were set. It should always

+

be empty if Operation is 'Apply'

+
+
+ +
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Table 51 io.k8s.apimachinery.pkg.apis.meta.v1.OwnerReference

Parameter

+

Type

+

Description

+

apiVersion

+

String

+

API version of the referent.

+

blockOwnerDeletion

+

Boolean

+

If true, AND if the owner has the "foregroundDeletion" finalizer,

+

then the owner cannot be deleted from the key-value store until this reference

+

is removed. Defaults to false. To set this field, a user needs "delete"

+

permission of the owner, otherwise 422 (Unprocessable Entity) will be returned.

+

controller

+

Boolean

+

If true, this reference points to the managing controller.

+

kind

+

String

+

Kind of the referent. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds

+

name

+

String

+

Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names

+

uid

+

String

+

UID of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#uids

+
+
+ +
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Table 52 io.cci.otc.api.pkg.apis.versioned.cci.v2.PersistentVolumeClaimSpec

Parameter

+

Type

+

Description

+

accessModes

+

Array of strings

+

accessModes contains the desired access modes the volume should have. More info: https://kubernetes.io/docs/concepts/storage/persistent-volumes#access-modes-1

+

dataSource

+

io.cci.otc.api.pkg.apis.versioned.cci.v2.TypedLocalObjectReference object

+

dataSource field can be used to specify either: * An existing VolumeSnapshot object (snapshot.storage.k8s.io/VolumeSnapshot) * An existing PVC (PersistentVolumeClaim) If the provisioner or an external controller can support the specified data source, it will create a new volume based on the contents of the specified data source. If the AnyVolumeDataSource feature gate is enabled, this field will always have the same contents as the DataSourceRef field.

+

dataSourceRef

+

io.cci.otc.api.pkg.apis.versioned.cci.v2.TypedLocalObjectReference object

+

dataSourceRef specifies the object from which to populate the volume with data, if a non-empty volume is desired. This may be any local object from a non-empty API group (non core object) or a PersistentVolumeClaim object. When this field is specified, volume binding will only succeed if the type of the specified object matches some installed volume populator or dynamic provisioner. This field will replace the functionality of the DataSource field and as such if both fields are non-empty, they must have the same value. For backwards compatibility, both fields (DataSource and DataSourceRef) will be set to the same value automatically if one of them is empty and the other is non-empty. There are two important differences between DataSource and DataSourceRef: * While DataSource only allows two specific types of objects, DataSourceRef

+

allows any non-core object, as well as PersistentVolumeClaim objects.

+
  • While DataSource ignores disallowed values (dropping them), DataSourceRef

    preserves all values, and generates an error if a disallowed value is

    +

    specified.

    +

    (Beta) Using this field requires the AnyVolumeDataSource feature gate to be enabled.

    +
+

resources

+

io.cci.otc.api.pkg.apis.versioned.cci.v2.ResourceRequirements object

+

resources represents the minimum resources the volume should have. If RecoverVolumeExpansionFailure feature is enabled users are allowed to specify resource requirements that are lower than previous value but must still be higher than capacity recorded in the status field of the claim. More info: https://kubernetes.io/docs/concepts/storage/persistent-volumes#resources

+

selector

+

io.k8s.apimachinery.pkg.apis.meta.v1.LabelSelector object

+

selector is a label query over volumes to consider for binding.

+

storageClassName

+

String

+

storageClassName is the name of the StorageClass required by the claim. More info: https://kubernetes.io/docs/concepts/storage/persistent-volumes#class-1

+

volumeMode

+

String

+

volumeMode defines what type of volume is required by the claim.

+

Value of Filesystem is implied when not included in claim spec.

+

volumeName

+

String

+

volumeName is the binding reference to the PersistentVolume backing

+

this claim.

+
+
+ +
+ + + + + + + + + + + + + + + + + +
Table 53 io.cci.otc.api.pkg.apis.versioned.cci.v2.TypedLocalObjectReference

Parameter

+

Type

+

Description

+

apiGroup

+

String

+

APIGroup is the group for the resource being referenced. If APIGroup

+

is not specified, the specified Kind must be in the core API group. For

+

any other third-party types, APIGroup is required.

+

kind

+

String

+

Kind is the type of resource being referenced

+

name

+

String

+

Name is the name of resource being referenced

+
+
+ +
+ + + + + + + + + + + + + +
Table 54 io.cci.otc.api.pkg.apis.versioned.cci.v2.ResourceRequirements

Parameter

+

Type

+

Description

+

limits

+

Map<String,String>

+

Limits describes the maximum amount of compute resources allowed. More info: https://kubernetes.io/docs/concepts/configuration/manage-resources-containers/

+

requests

+

Map<String,String>

+

Requests describes the minimum amount of compute resources required. If Requests is omitted for a container, it defaults to Limits if that is explicitly specified, otherwise to an implementation-defined value. More info: https://kubernetes.io/docs/concepts/configuration/manage-resources-containers/

+
+
+ +
+ + + + + + + + + +
Table 55 io.k8s.apimachinery.pkg.api.resource.Quantity

Parameter

+

Type

+

Description

+

-

+

String

+

Quantity is a fixed-point representation of a number. It provides convenient marshaling/unmarshaling in JSON and YAML, in addition to String() and AsInt64() accessors.

+

The serialization format is:

+

[/topic/body/section/table/tgroup/tbody/row/entry/p/br + {""}) (br] ::= [/topic/body/section/table/tgroup/tbody/row/entry/p/br + {""}) (br][/topic/body/section/table/tgroup/tbody/row/entry/p/br + {""}) (br]

+

(Note that [/topic/body/section/table/tgroup/tbody/row/entry/p/br + {""}) (br] may be empty, from the "" case in [/topic/body/section/table/tgroup/tbody/row/entry/p/br + {""}) (br].)

+

[/topic/body/section/table/tgroup/tbody/row/entry/p/br + {""}) (br] ::= 0 | 1 | ... | 9 [/topic/body/section/table/tgroup/tbody/row/entry/p/br + {""}) (br] ::= [/topic/body/section/table/tgroup/tbody/row/entry/p/br + {""}) (br] | [/topic/body/section/table/tgroup/tbody/row/entry/p/br + {""}) (br][/topic/body/section/table/tgroup/tbody/row/entry/p/br + {""}) (br] [/topic/body/section/table/tgroup/tbody/row/entry/p/br + {""}) (br] ::= [/topic/body/section/table/tgroup/tbody/row/entry/p/br + {""}) (br] | [/topic/body/section/table/tgroup/tbody/row/entry/p/br + {""}) (br].[/topic/body/section/table/tgroup/tbody/row/entry/p/br + {""}) (br] | [/topic/body/section/table/tgroup/tbody/row/entry/p/br + {""}) (br]. | .[/topic/body/section/table/tgroup/tbody/row/entry/p/br + {""}) (br] [/topic/body/section/table/tgroup/tbody/row/entry/p/br + {""}) (br] ::= "+" | "-" [/topic/body/section/table/tgroup/tbody/row/entry/p/br + {""}) (br] ::= [/topic/body/section/table/tgroup/tbody/row/entry/p/br + {""}) (br] | [/topic/body/section/table/tgroup/tbody/row/entry/p/br + {""}) (br][/topic/body/section/table/tgroup/tbody/row/entry/p/br + {""}) (br] [/topic/body/section/table/tgroup/tbody/row/entry/p/br + {""}) (br] ::= [/topic/body/section/table/tgroup/tbody/row/entry/p/br + {""}) (br] | [/topic/body/section/table/tgroup/tbody/row/entry/p/br + {""}) (br] | [/topic/body/section/table/tgroup/tbody/row/entry/p/br + {""}) (br] [/topic/body/section/table/tgroup/tbody/row/entry/p/br + {""}) (br] ::= Ki | Mi | Gi | Ti | Pi | Ei

+

(International System of units; See: http://physics.nist.gov/cuu/Units/binary.html)

+

[/topic/body/section/table/tgroup/tbody/row/entry/p/br + {""}) (br] ::= m | "" | k | M | G | T | P | E

+

(Note that 1024 = 1Ki but 1000 = 1k; I didn't choose the capitalization.)

+

[/topic/body/section/table/tgroup/tbody/row/entry/p/br + {""}) (br] ::= "e" [/topic/body/section/table/tgroup/tbody/row/entry/p/br + {""}) (br] | "E" [/topic/body/section/table/tgroup/tbody/row/entry/p/br + {""}) (br]

+

No matter which of the three exponent forms is used, no quantity may represent a number greater than 2^63-1 in magnitude, nor may it have more than 3 decimal places. Numbers larger or more precise will be capped or rounded up. (E.g.: 0.1m will rounded up to 1m.) This may be extended in the future if we require larger or smaller quantities.

+

When a Quantity is parsed from a string, it will remember the type of suffix it had, and will use the same type again when it is serialized.

+

Before serializing, Quantity will be put in "canonical form". This means that Exponent/suffix will be adjusted up or down (with a corresponding increase or decrease in Mantissa) such that:

+

a. No precision is lost

+

b. No fractional digits will be emitted

+

c. The exponent (or suffix) is as large as possible.

+

The sign will be omitted unless the number is negative.

+

Examples:

+

1.5 will be serialized as "1500m"

+

1.5Gi will be serialized as "1536Mi"

+

Note that the quantity will NEVER be internally represented by a floating point number. That is the whole point of this exercise.

+

Non-canonical values will still parse as long as they are well formed, but will be re-emitted in their canonical form. (So always use canonical form, or don't diff.)

+

This format is intended to make it difficult to use these numbers without writing some sort of special handling code in the hopes that that will cause implementors to also use a fixed point implementation.

+
+
+ +
+ + + + + + + + + + + + + +
Table 56 io.k8s.apimachinery.pkg.apis.meta.v1.LabelSelector

Parameter

+

Type

+

Description

+

matchExpressions

+

Array of io.k8s.apimachinery.pkg.apis.meta.v1.LabelSelectorRequirement objects

+

matchExpressions is a list of label selector requirements. The

+

requirements are ANDed.

+

matchLabels

+

Map<String,String>

+

matchLabels is a map of {key,value} pairs. A single {key,value}

+

in the matchLabels map is equivalent to an element of matchExpressions,

+

whose key field is "key", the operator is "In", and the values array contains

+

only "value". The requirements are ANDed.

+
+
+ +
+ + + + + + + + + + + + + + + + + +
Table 57 io.k8s.apimachinery.pkg.apis.meta.v1.LabelSelectorRequirement

Parameter

+

Type

+

Description

+

key

+

String

+

key is the label key that the selector applies to.

+

operator

+

String

+

operator represents a key's relationship to a set of values.

+

Valid operators are In, NotIn, Exists and DoesNotExist.

+

values

+

Array of strings

+

values is an array of string values. If the operator is In or

+

NotIn, the values array must be non-empty. If the operator is Exists or

+

DoesNotExist, the values array must be empty. This array is replaced during

+

a strategic merge patch.

+
+
+ +
+ + + + + + + + + + + + + + + + + +
Table 58 io.cci.otc.api.pkg.apis.versioned.cci.v2.NFSVolumeSource

Parameter

+

Type

+

Description

+

path

+

String

+

path that is exported by the NFS server. More info: https://kubernetes.io/docs/concepts/storage/volumes#nfs

+

readOnly

+

Boolean

+

readOnly here will force the NFS export to be mounted with read-only permissions. Defaults to false. More info: https://kubernetes.io/docs/concepts/storage/volumes#nfs

+

server

+

String

+

server is the hostname or IP address of the NFS server. More info: https://kubernetes.io/docs/concepts/storage/volumes#nfs

+
+
+ +
+ + + + + + + + + + + + + +
Table 59 io.cci.otc.api.pkg.apis.versioned.cci.v2.PersistentVolumeClaimVolumeSource

Parameter

+

Type

+

Description

+

claimName

+

String

+

claimName is the name of a PersistentVolumeClaim in the same namespace as the pod using this volume. More info: https://kubernetes.io/docs/concepts/storage/persistent-volumes#persistentvolumeclaims

+

readOnly

+

Boolean

+

readOnly Will force the ReadOnly setting in VolumeMounts. Default

+

false.

+
+
+ +
+ + + + + + + + + + + + + +
Table 60 io.cci.otc.api.pkg.apis.versioned.cci.v2.ProjectedVolumeSource

Parameter

+

Type

+

Description

+

defaultMode

+

Integer

+

defaultMode are the mode bits used to set permissions on created

+

files by default. Must be an octal value between 0000 and 0777 or a decimal

+

value between 0 and 511. YAML accepts both octal and decimal values, JSON

+

requires decimal values for mode bits. Directories within the path are not

+

affected by this setting. This might be in conflict with other options that

+

affect the file mode, like fsGroup, and the result can be other mode bits

+

set.

+

sources

+

Array of io.cci.otc.api.pkg.apis.versioned.cci.v2.VolumeProjection objects

+

sources is the list of volume projections

+
+
+ +
+ + + + + + + + + + + + + + + + + +
Table 61 io.cci.otc.api.pkg.apis.versioned.cci.v2.VolumeProjection

Parameter

+

Type

+

Description

+

configMap

+

io.cci.otc.api.pkg.apis.versioned.cci.v2.ConfigMapProjection object

+

configMap information about the configMap data to project

+

downwardAPI

+

io.cci.otc.api.pkg.apis.versioned.cci.v2.DownwardAPIProjection object

+

downwardAPI information about the downwardAPI data to project

+

secret

+

io.cci.otc.api.pkg.apis.versioned.cci.v2.SecretProjection object

+

secret information about the secret data to project

+
+
+ +
+ + + + + + + + + + + + + + + + + +
Table 62 io.cci.otc.api.pkg.apis.versioned.cci.v2.ConfigMapProjection

Parameter

+

Type

+

Description

+

items

+

Array of io.cci.otc.api.pkg.apis.versioned.cci.v2.KeyToPath objects

+

items if unspecified, each key-value pair in the Data field of

+

the referenced ConfigMap will be projected into the volume as a file whose

+

name is the key and content is the value. If specified, the listed keys

+

will be projected into the specified paths, and unlisted keys will not be

+

present. If a key is specified which is not present in the ConfigMap, the

+

volume setup will error unless it is marked optional. Paths must be relative

+

and may not contain the '..' path or start with '..'.

+

name

+

String

+

Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names

+

optional

+

Boolean

+

optional specify whether the ConfigMap or its keys must be defined

+
+
+ +
+ + + + + + + + + +
Table 63 io.cci.otc.api.pkg.apis.versioned.cci.v2.DownwardAPIProjection

Parameter

+

Type

+

Description

+

items

+

Array of io.cci.otc.api.pkg.apis.versioned.cci.v2.DownwardAPIVolumeFile objects

+

Items is a list of DownwardAPIVolume file

+
+
+ +
+ + + + + + + + + + + + + + + + + + + + + +
Table 64 io.cci.otc.api.pkg.apis.versioned.cci.v2.DownwardAPIVolumeFile

Parameter

+

Type

+

Description

+

fieldRef

+

io.cci.otc.api.pkg.apis.versioned.cci.v2.ObjectFieldSelector object

+

Required: Selects a field of the pod: only annotations, labels, name and namespace are supported.

+

mode

+

Integer

+

Optional: mode bits used to set permissions on this file, must be an octal value between 0000 and 0777 or a decimal value between 0 and 511. YAML accepts both octal and decimal values, JSON requires decimal values for mode bits. If not specified, the volume defaultMode will be used. This might be in conflict with other options that affect the file mode, like fsGroup, and the result can be other mode bits set.

+

path

+

String

+

Required: Path is the relative path name of the file to be created. Must not be absolute or contain the '..' path. Must be utf-8 encoded. The first item of the relative path must not start with '..'

+

resourceFieldRef

+

io.cci.otc.api.pkg.apis.versioned.cci.v2.ResourceFieldSelector object

+

Selects a resource of the container: only resources limits and requests (limits.cpu, limits.memory, requests.cpu and requests.memory) are currently supported.

+
+
+ +
+ + + + + + + + + + + + + +
Table 65 io.cci.otc.api.pkg.apis.versioned.cci.v2.ObjectFieldSelector

Parameter

+

Type

+

Description

+

apiVersion

+

String

+

Version of the schema the FieldPath is written in terms of, defaults

+

to "v1".

+

fieldPath

+

String

+

Path of the field to select in the specified API version.

+
+
+ +
+ + + + + + + + + + + + + + + + + +
Table 66 io.cci.otc.api.pkg.apis.versioned.cci.v2.ResourceFieldSelector

Parameter

+

Type

+

Description

+

containerName

+

String

+

Container name: required for volumes, optional for env vars

+

divisor

+

String

+

Specifies the output format of the exposed resources, defaults

+

to "1"

+

resource

+

String

+

Required: resource to select

+
+
+ +
+ + + + + + + + + + + + + + + + + +
Table 67 io.cci.otc.api.pkg.apis.versioned.cci.v2.SecretProjection

Parameter

+

Type

+

Description

+

items

+

Array of io.cci.otc.api.pkg.apis.versioned.cci.v2.KeyToPath objects

+

items if unspecified, each key-value pair in the Data field of

+

the referenced Secret will be projected into the volume as a file whose

+

name is the key and content is the value. If specified, the listed keys

+

will be projected into the specified paths, and unlisted keys will not be

+

present. If a key is specified which is not present in the Secret, the volume

+

setup will error unless it is marked optional. Paths must be relative and

+

may not contain the '..' path or start with '..'.

+

name

+

String

+

Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names

+

optional

+

Boolean

+

optional field specify whether the Secret or its key must be

+

defined

+
+
+ +
+ + + + + + + + + + + + + + + + + + + + + +
Table 68 io.cci.otc.api.pkg.apis.versioned.cci.v2.SecretVolumeSource

Parameter

+

Type

+

Description

+

defaultMode

+

Integer

+

defaultMode is Optional: mode bits used to set permissions on created files by default. Must be an octal value between 0000 and 0777 or a decimal value between 0 and 511. YAML accepts both octal and decimal values, JSON requires decimal values for mode bits. Defaults to 0644. Directories within the path are not affected by this setting. This might be in conflict with other options that affect the file mode, like fsGroup, and the result can be other mode bits set.

+

items

+

Array of io.cci.otc.api.pkg.apis.versioned.cci.v2.KeyToPath objects

+

items If unspecified, each key-value pair in the Data field of

+

the referenced Secret will be projected into the volume as a file whose

+

name is the key and content is the value. If specified, the listed keys

+

will be projected into the specified paths, and unlisted keys will not be

+

present. If a key is specified which is not present in the Secret, the volume

+

setup will error unless it is marked optional. Paths must be relative and

+

may not contain the '..' path or start with '..'.

+

optional

+

Boolean

+

optional field specify whether the Secret or its keys must be

+

defined

+

secretName

+

String

+

secretName is the name of the secret in the pod's namespace to use. More info: https://kubernetes.io/docs/concepts/storage/volumes#secret

+
+
+ +
+ + + + + + + + + + + + + + + + + +
Table 69 io.cci.otc.api.pkg.apis.versioned.cci.v2.KeyToPath

Parameter

+

Type

+

Description

+

key

+

String

+

key is the key to project.

+

mode

+

Integer

+

mode is Optional: mode bits used to set permissions on this file. Must be an octal value between 0000 and 0777 or a decimal value between 0 and 511. YAML accepts both octal and decimal values, JSON requires decimal values for mode bits. If not specified, the volume defaultMode will be used. This might be in conflict with other options that affect the file mode, like fsGroup, and the result can be other mode bits set.

+

path

+

String

+

path is the relative path of the file to map the key to. May

+

not be an absolute path. May not contain the path element '..'. May not

+

start with the string '..'.

+
+
+ +
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Table 70 io.cci.otc.api.pkg.apis.versioned.cci.v2.PodStatus

Parameter

+

Type

+

Description

+

conditions

+

Array of io.cci.otc.api.pkg.apis.versioned.cci.v2.PodCondition objects

+

Current service state of pod. More info: https://kubernetes.io/docs/concepts/workloads/pods/pod-lifecycle#pod-conditions

+

containerStatuses

+

Array of io.cci.otc.api.pkg.apis.versioned.cci.v2.ContainerStatus objects

+

The list has one entry per container in the manifest. More info: https://kubernetes.io/docs/concepts/workloads/pods/pod-lifecycle#pod-and-container-status

+

ephemeralContainerStatuses

+

Array of io.cci.otc.api.pkg.apis.versioned.cci.v2.ContainerStatus objects

+

Status for any ephemeral containers that have run in this pod.

+

hostIP

+

String

+

IP address of the host to which the pod is assigned. Empty if

+

not yet scheduled.

+

initContainerStatuses

+

Array of io.cci.otc.api.pkg.apis.versioned.cci.v2.ContainerStatus objects

+

The list has one entry per init container in the manifest. The most recent successful init container will have ready = true, the most recently started container will have startTime set. More info: https://kubernetes.io/docs/concepts/workloads/pods/pod-lifecycle#pod-and-container-status

+

message

+

String

+

A human readable message indicating details about why the pod

+

is in this condition.

+

nominatedNodeName

+

String

+

nominatedNodeName is set only when this pod preempts other pods

+

on the node, but it cannot be scheduled right away as preemption victims

+

receive their graceful termination periods. This field does not guarantee

+

that the pod will be scheduled on this node. Scheduler may decide to place

+

the pod elsewhere if other nodes become available sooner. Scheduler may

+

also decide to give the resources on this node to a higher priority pod

+

that is created after preemption. As a result, this field may be different

+

than PodSpec.nodeName when the pod is scheduled.

+

phase

+

String

+

The phase of a Pod is a simple, high-level summary of where the Pod is in its lifecycle. The conditions array, the reason and message fields, and the individual container status arrays contain more detail about the pod's status. There are five possible phase values:

+

Pending: The pod has been accepted by the Kubernetes system, but one or more of the container images has not been created. This includes time before being scheduled as well as time spent downloading images over the network, which could take a while. Running: The pod has been bound to a node, and all of the containers have been created. At least one container is still running, or is in the process of starting or restarting. Succeeded: All containers in the pod have terminated in success, and will not be restarted. Failed: All containers in the pod have terminated, and at least one container has terminated in failure. The container either exited with non-zero status or was terminated by the system. Unknown: For some reason the state of the pod could not be obtained, typically due to an error in communicating with the host of the pod.

+

More info: https://kubernetes.io/docs/concepts/workloads/pods/pod-lifecycle#pod-phase

+

Possible enum values:

+
  • "Failed" means that all containers in the pod have terminated, and at least one container has terminated in a failure (exited with a non-zero exit code or was stopped by the system).
  • "Pending" means the pod has been accepted by the system, but one or more of the containers has not been started. This includes time before being bound to a node, as well as time spent pulling images onto the host.
  • "Running" means the pod has been bound to a node and all of the containers have been started. At least one container is still running or is in the process of being restarted.
  • "Succeeded" means that all containers in the pod have voluntarily terminated with a container exit code of 0, and the system is not going to restart any of these containers.
  • "Unknown" means that for some reason the state of the pod could not be obtained, typically due to an error in communicating with the host of the pod. Deprecated: It isn't being set since 2015 (74da3b14b0c0f658b3bb8d2def5094686d0e9095)
+

podIP

+

String

+

IP address allocated to the pod. Routable at least within the

+

cluster. Empty if not yet allocated.

+

podIPs

+

Array of io.cci.otc.api.pkg.apis.versioned.cci.v2.PodIP objects

+

podIPs holds the IP addresses allocated to the pod. If this field

+

is specified, the 0th entry must match the podIP field. Pods may be allocated

+

at most 1 value for each of IPv4 and IPv6. This list is empty if no IPs

+

have been allocated yet.

+

qosClass

+

String

+

The Quality of Service (QOS) classification assigned to the pod based on resource requirements See PodQOSClass type for available QOS classes More info: https://git.k8s.io/community/contributors/design-proposals/node/resource-qos.md

+

Possible enum values:

+
  • "BestEffort" is the BestEffort qos class.
  • "Burstable" is the Burstable qos class.
  • "Guaranteed" is the Guaranteed qos class.
+

reason

+

String

+

A brief CamelCase message indicating details about why the pod

+

is in this state. e.g. 'Evicted'

+

startTime

+

String

+

RFC 3339 date and time at which the object was acknowledged by

+

the Kubelet. This is before the Kubelet pulled the container image(s) for

+

the pod.

+
+
+ +
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Table 71 io.cci.otc.api.pkg.apis.versioned.cci.v2.PodCondition

Parameter

+

Type

+

Description

+

lastProbeTime

+

String

+

Last time we probed the condition.

+

lastTransitionTime

+

String

+

Last time the condition transitioned from one status to another.

+

message

+

String

+

Human-readable message indicating details about last transition.

+

reason

+

String

+

Unique, one-word, CamelCase reason for the condition's last transition.

+

status

+

String

+

Status is the status of the condition. Can be True, False, Unknown. More info: https://kubernetes.io/docs/concepts/workloads/pods/pod-lifecycle#pod-conditions

+

type

+

String

+

Type is the type of the condition. More info: https://kubernetes.io/docs/concepts/workloads/pods/pod-lifecycle#pod-conditions

+
+
+ +
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Table 72 io.cci.otc.api.pkg.apis.versioned.cci.v2.ContainerStatus

Parameter

+

Type

+

Description

+

containerID

+

String

+

Container's ID in the format '[/topic/body/section/table/tgroup/tbody/row/entry/p/br + {""}) (br]://<container_id>'.

+

image

+

String

+

The image the container is running. More info: https://kubernetes.io/docs/concepts/containers/images.

+

imageID

+

String

+

ImageID of the container's image.

+

lastState

+

io.cci.otc.api.pkg.apis.versioned.cci.v2.ContainerState object

+

Details about the container's last termination condition.

+

name

+

String

+

This must be a DNS_LABEL. Each container in a pod must have a

+

unique name. Cannot be updated.

+

ready

+

Boolean

+

Specifies whether the container has passed its readiness probe.

+

restartCount

+

Integer

+

The number of times the container has been restarted.

+

started

+

Boolean

+

Specifies whether the container has passed its startup probe.

+

Initialized as false, becomes true after startupProbe is considered successful.

+

Resets to false when the container is restarted, or if kubelet loses state

+

temporarily. Is always true when no startupProbe is defined.

+

state

+

io.cci.otc.api.pkg.apis.versioned.cci.v2.ContainerState object

+

Details about the container's current condition.

+
+
+ +
+ + + + + + + + + + + + + + + + + +
Table 73 io.cci.otc.api.pkg.apis.versioned.cci.v2.ContainerState

Parameter

+

Type

+

Description

+

running

+

io.cci.otc.api.pkg.apis.versioned.cci.v2.ContainerStateRunning object

+

Details about a running container

+

terminated

+

io.cci.otc.api.pkg.apis.versioned.cci.v2.ContainerStateTerminated object

+

Details about a terminated container

+

waiting

+

io.cci.otc.api.pkg.apis.versioned.cci.v2.ContainerStateWaiting object

+

Details about a waiting container

+
+
+ +
+ + + + + + + + + +
Table 74 io.cci.otc.api.pkg.apis.versioned.cci.v2.ContainerStateRunning

Parameter

+

Type

+

Description

+

startedAt

+

String

+

Time at which the container was last (re-)started

+
+
+ +
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Table 75 io.cci.otc.api.pkg.apis.versioned.cci.v2.ContainerStateTerminated

Parameter

+

Type

+

Description

+

containerID

+

String

+

Container's ID in the format '[/topic/body/section/table/tgroup/tbody/row/entry/p/br + {""}) (br]://<container_id>'

+

exitCode

+

Integer

+

Exit status from the last termination of the container

+

finishedAt

+

String

+

Time at which the container last terminated

+

message

+

String

+

Message regarding the last termination of the container

+

reason

+

String

+

(brief) reason from the last termination of the container

+

signal

+

Integer

+

Signal from the last termination of the container

+

startedAt

+

String

+

Time at which previous execution of the container started

+
+
+ +
+ + + + + + + + + + + + + +
Table 76 io.cci.otc.api.pkg.apis.versioned.cci.v2.ContainerStateWaiting

Parameter

+

Type

+

Description

+

message

+

String

+

Message regarding why the container is not yet running.

+

reason

+

String

+

(brief) reason the container is not yet running.

+
+
+ +
+ + + + + + + + + +
Table 77 io.cci.otc.api.pkg.apis.versioned.cci.v2.PodIP

Parameter

+

Type

+

Description

+

ip

+

String

+

ip is an IP address (IPv4 or IPv6) assigned to the pod

+
+
+ +
+ + + + + + + + + + + + + + + + + + + + + +
Table 78 io.k8s.apimachinery.pkg.apis.meta.v1.ListMeta

Parameter

+

Type

+

Description

+

continue

+

String

+

continue may be set if the user set a limit on the number of

+

items returned, and indicates that the server has more data available. The

+

value is opaque and may be used to issue another request to the endpoint

+

that served this list to retrieve the next set of available objects. Continuing

+

a consistent list may not be possible if the server configuration has changed

+

or more than a few minutes have passed. The resourceVersion field returned

+

when using this continue value will be identical to the value in the first

+

response, unless you have received this token from an error message.

+

remainingItemCount

+

Long

+

remainingItemCount is the number of subsequent items in the list

+

which are not included in this list response. If the list request contained

+

label or field selectors, then the number of remaining items is unknown

+

and the field will be left unset and omitted during serialization. If the

+

list is complete (either because it is not chunking or because this is the

+

last chunk), then there are no more remaining items and this field will

+

be left unset and omitted during serialization. Servers older than v1.15

+

do not set this field. The intended use of the remainingItemCount is estimating

+

the size of a collection. Clients should not rely on the remainingItemCount

+

to be set or to be exact.

+

resourceVersion

+

String

+

String that identifies the server's internal version of this object that can be used by clients to determine when objects have changed. Value must be treated as opaque by clients and passed unmodified back to the server. Populated by the system. Read-only. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#concurrency-control-and-consistency

+

selfLink

+

String

+

selfLink is a URL representing this object. Populated by the system. Read-only.

+

DEPRECATED Kubernetes will stop propagating this field in 1.20 release and the field is planned to be removed in 1.21 release.

+
+
+
+

Example Requests

None

+
+

Example Responses

Status code: 200

+

OK

+
{
+  "apiVersion" : "v1",
+  "items" : [ {
+    "apiVersion" : "cci/v2",
+    "kind" : "Pod",
+    "metadata" : {
+      "annotations" : {
+        "cni.yangtse.io/network-status" : "[{\"macAddress\":\"fa:16:3e:1d:75:3a\",\"ipv4Info\":{\"subnet\":\"192.168.0.0/24\",\"ipAddress\":\"192.168.0.197\",\"gateway\":\"192.168.0.1\"},\"name\":\"test-api\",\"portID\":\"b471658c-caac-4377-94f4-2eeff1192d2b\",\"ips\":[\"192.168.0.197\"],\"vlanID\":3687}]",
+        "networking.cci.io/vm-network-info" : "{\"vmID\":\"fda21659-a816-4449-abcf-193ac5a47b4a\",\"eniID\":\"ec9f8fae-ae74-445b-b8bb-b533e5342dbd\",\"maxEniNum\":2,\"maxSubEniNum\":16}",
+        "openvessel.io/monitoring-aominfo" : "08a2*************************c03:4257ecf3-7c47-43a3-86d2-d2b4d4aa3a20",
+        "resource.cci.io/pod-size-specs" : "2.00_4.0",
+        "resource.cci.io/size" : "2.00_4.0",
+        "scheduling.k8s.io/group-name" : "podgroup-ade5799e-9371-4c9f-ab77-0472e97211f8",
+        "tenant.cci.io/tenant-id" : "08a2*************************c03",
+        "topology.kubernetes.io/region" : "region1",
+        "topology.kubernetes.io/zone" : "region1c"
+      },
+      "creationTimestamp" : "2024-10-09T16:11:23Z",
+      "finalizers" : [ "billing.kubernetes.io/podbilling-finalizer" ],
+      "labels" : {
+        "scheduling.cci.io/vmid" : "fda21659-a816-4449-abcf-193ac5a47b4a",
+        "sys_enterprise_project_id" : "0",
+        "tenant.cci.io/tenant-id" : "08a2*************************c03",
+        "tenant.kubernetes.io/domain-id" : "08a*************************ee60",
+        "tenant.kubernetes.io/project-id" : "08a2*************************c03"
+      },
+      "name" : "test",
+      "namespace" : "test-api",
+      "resourceVersion" : "391095556",
+      "uid" : "ade5799e-9371-4c9f-ab77-0472e97211f8"
+    },
+    "spec" : {
+      "containers" : [ {
+        "env" : [ {
+          "name" : "ENV1",
+          "value" : "false"
+        }, {
+          "name" : "ENV2",
+          "value" : "xxx"
+        } ],
+        "image" : "nginx:latest",
+        "name" : "deploy-example",
+        "resources" : {
+          "limits" : {
+            "cpu" : "500m",
+            "memory" : "1Gi"
+          },
+          "requests" : {
+            "cpu" : "500m",
+            "memory" : "1Gi"
+          }
+        },
+        "terminationMessagePath" : "/dev/termination-log",
+        "terminationMessagePolicy" : "File"
+      } ],
+      "dnsPolicy" : "Default",
+      "imagePullSecrets" : [ {
+        "name" : "imagepull-secret"
+      } ],
+      "nodeName" : "compute-cell-001",
+      "restartPolicy" : "Always",
+      "schedulerName" : "volcano",
+      "securityContext" : { },
+      "terminationGracePeriodSeconds" : 30
+    },
+    "status" : {
+      "conditions" : [ {
+        "lastProbeTime" : null,
+        "lastTransitionTime" : "2024-10-09T16:11:24Z",
+        "status" : "True",
+        "type" : "Initialized"
+      }, {
+        "lastProbeTime" : null,
+        "lastTransitionTime" : "2024-10-09T16:11:28Z",
+        "status" : "True",
+        "type" : "Ready"
+      }, {
+        "lastProbeTime" : null,
+        "lastTransitionTime" : "2024-10-09T16:11:28Z",
+        "status" : "True",
+        "type" : "ContainersReady"
+      }, {
+        "lastProbeTime" : null,
+        "lastTransitionTime" : "2024-10-09T16:11:23Z",
+        "status" : "True",
+        "type" : "PodScheduled"
+      } ],
+      "containerStatuses" : [ {
+        "containerID" : "containerd://a44eef6b753babaff802d212e78afef2422959e90bd79ab5b385adb302aa3d1e",
+        "image" : "nginx:latest",
+        "imageID" : "docker.io/library/nginx@sha256:416d511ffa63777489af47f250b70d1570e428b67666567085f2bece3571ad83",
+        "lastState" : { },
+        "name" : "deploy-example",
+        "ready" : true,
+        "restartCount" : 0,
+        "started" : true,
+        "state" : {
+          "running" : {
+            "startedAt" : "2024-10-09T16:11:27Z"
+          }
+        }
+      } ],
+      "phase" : "Running",
+      "podIP" : "192.168.0.197",
+      "podIPs" : [ {
+        "ip" : "192.168.0.197"
+      } ],
+      "qosClass" : "Guaranteed",
+      "startTime" : "2024-10-09T16:11:24Z"
+    }
+  } ],
+  "kind" : "List",
+  "metadata" : {
+    "resourceVersion" : ""
+  }
+}
+
+

Status Codes

+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +

Status Code

+

Description

+

200

+

OK

+

400

+

BadRequest

+

401

+

Unauthorized

+

403

+

Forbidden

+

404

+

NotFound

+

405

+

MethodNotAllowed

+

406

+

NotAcceptable

+

409

+

Conflict

+

415

+

UnsupportedMediaType

+

422

+

Invalid

+

429

+

TooManyRequests

+

500

+

InternalError

+

503

+

ServiceUnavailable

+

504

+

ServerTimeout

+
+
+
+
+
+
+
Parent topic: Proprietary APIs
+
+
+ diff --git a/docs/cci/api-ref/listCciV2NamespacedSecret.html b/docs/cci/api-ref/listCciV2NamespacedSecret.html new file mode 100644 index 00000000..9fe2aac9 --- /dev/null +++ b/docs/cci/api-ref/listCciV2NamespacedSecret.html @@ -0,0 +1,765 @@ + + +

Listing or Watching Objects of kind Secret

+

Function

List or watch objects of kind Secret.

+
+

Calling Method

For details, see Calling APIs.

+
+

URI

GET /apis/cci/v2/namespaces/{namespace}/secrets

+ +
+ + + + + + + + + + + +
Table 1 Path Parameters

Parameter

+

Mandatory

+

Type

+

Description

+

namespace

+

Yes

+

String

+

Object name and auth scope, such as for teams and projects.

+
+
+ +
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Table 2 Query Parameters

Parameter

+

Mandatory

+

Type

+

Description

+

allowWatchBookmarks

+

No

+

Boolean

+

allowWatchBookmarks requests watch events with type "BOOKMARK".

+

Servers that do not implement bookmarks may ignore this flag and bookmarks

+

are sent at the server's discretion. Clients should not assume bookmarks

+

are returned at any specific interval, nor may they assume the server will

+

send any BOOKMARK event during a session. If this is not a watch, this field

+

is ignored.

+

continue

+

No

+

String

+

The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the "next key".

+

This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications.

+

fieldSelector

+

No

+

String

+

A selector to restrict the list of returned objects by their

+

fields. Defaults to everything.

+

labelSelector

+

No

+

String

+

A selector to restrict the list of returned objects by their

+

labels. Defaults to everything.

+

limit

+

No

+

Integer

+

limit is a maximum number of responses to return for a list call. If more items exist, the server will set the continue field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true.

+

The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned.

+

resourceVersion

+

No

+

String

+

resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details.

+

Defaults to unset

+

resourceVersionMatch

+

No

+

String

+

resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details.

+

Defaults to unset

+

sendInitialEvents

+

No

+

Boolean

+

sendInitialEvents when set together with Watch option, begins the watch stream with synthetic "Added" events of all resources. Followed by a synthetic "Bookmark" event containing a ResourceVersion after which the server continues streaming events. This option is meant to be used with the resourceVersion parameter with the following semantics:

+
  • sendInitialEvent and RV>0 - provides the initial events and when we reach the desired RV,

    the synthetic bookmark event. Note that the desired RV must be >= the current revision the server knows about.

    +

    If the desired RV is older than the current revision the server is aware of, the TooLargeResourceVersionError is returned.

    +

    Essentially this provides NotOlderThan semantics.

    +
  • sendInitialEvent and RV=0 - provides the initial events and the synthetic bookmark with the current RV. - sendInitialEvent and RV="" - matches data at the most recent ResourceVersion.

    The returned data is consistent, that is, served from etcd via a quorum read.

    +

    It provides the initial events, any other updates and the synthetic bookmark

    +

    event with the most recent ResourceVersion.

    +
+

timeoutSeconds

+

No

+

Integer

+

Timeout for the list/watch call. This limits the duration of

+

the call, regardless of any activity or inactivity.

+

watch

+

No

+

Boolean

+

Watch for changes to the described resources and return them

+

as a stream of add, update, and remove notifications. Specify resourceVersion.

+

pretty

+

No

+

String

+

If 'true', then the output is pretty printed.

+
+
+
+

Request Parameters

+
+ + + + + + + + + + + +
Table 3 Request header parameters

Parameter

+

Mandatory

+

Type

+

Description

+

X-Auth-Token

+

Yes

+

String

+

User token.

+

It can be obtained through the IAM API used to obtain a user token. The value of X-Subject-Token in the response header is the user token.

+
+
+
+

Response Parameters

Status code: 200

+ +
+ + + + + + + + + + + + + + + + + + + + + +
Table 4 Response body parameters

Parameter

+

Type

+

Description

+

apiVersion

+

String

+

APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#resources

+

items

+

Array of io.cci.otc.api.pkg.apis.versioned.cci.v2.Secret objects

+

Items is a list of secret objects. More info: https://kubernetes.io/docs/concepts/configuration/secret

+

kind

+

String

+

Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds

+

metadata

+

io.k8s.apimachinery.pkg.apis.meta.v1.ListMeta object

+

Standard list metadata. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds

+
+
+ +
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Table 5 io.cci.otc.api.pkg.apis.versioned.cci.v2.Secret

Parameter

+

Type

+

Description

+

apiVersion

+

String

+

APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#resources

+

data

+

Map<String,String>

+

Data contains the secret data. Each key must consist of alphanumeric

+

characters, '-', '_' or '.'. The serialized form of the secret data is a

+

base64 encoded string, representing the arbitrary (possibly non-string)

+

data value here. Described in https://tools.ietf.org/html/rfc4648#section-4

+

immutable

+

Boolean

+

Immutable, if set to true, ensures that data stored in the Secret

+

cannot be updated (only object metadata can be modified). If not set to

+

true, the field can be modified at any time. Defaulted to nil.

+

kind

+

String

+

Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds

+

metadata

+

io.k8s.apimachinery.pkg.apis.meta.v1.ObjectMeta object

+

Standard object's metadata. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata

+

stringData

+

Map<String,String>

+

stringData allows specifying non-binary secret data in string

+

form. It is provided as a write-only input field for convenience. All keys

+

and values are merged into the data field on write, overwriting any existing

+

values. The stringData field is never output when reading from the API.

+

type

+

String

+

Used to facilitate programmatic handling of secret data. More info: https://kubernetes.io/docs/concepts/configuration/secret/#secret-types

+
+
+ +
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Table 6 io.k8s.apimachinery.pkg.apis.meta.v1.ObjectMeta

Parameter

+

Type

+

Description

+

annotations

+

Map<String,String>

+

Annotations is an unstructured key value map stored with a resource that may be set by external tools to store and retrieve arbitrary metadata. They are not queryable and should be preserved when modifying objects. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/annotations/

+

clusterName

+

String

+

The name of the cluster which the object belongs to. This is

+

used to distinguish resources with same name and namespace in different

+

clusters. This field is not set anywhere right now and apiserver is going

+

to ignore it if set in create or update request.

+

creationTimestamp

+

String

+

CreationTimestamp is a timestamp representing the server time when this object was created. It is not guaranteed to be set in happens-before order across separate operations. Clients may not set this value. It is represented in RFC3339 form and is in UTC.

+

Populated by the system. Read-only. Null for lists. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata

+

deletionGracePeriodSeconds

+

Long

+

Number of seconds allowed for this object to gracefully terminate

+

before it will be removed from the system. Only set when deletionTimestamp

+

is also set. May only be shortened. Read-only.

+

deletionTimestamp

+

String

+

DeletionTimestamp is RFC 3339 date and time at which this resource will be deleted. This field is set by the server when a graceful deletion is requested by the user, and is not directly settable by a client. The resource is expected to be deleted (no longer visible from resource lists, and not reachable by name) after the time in this field, once the finalizers list is empty. As long as the finalizers list contains items, deletion is blocked. Once the deletionTimestamp is set, this value may not be unset or be set further into the future, although it may be shortened or the resource may be deleted prior to this time. For example, a user may request that a pod is deleted in 30 seconds. The Kubelet will react by sending a graceful termination signal to the containers in the pod. After that 30 seconds, the Kubelet will send a hard termination signal (SIGKILL) to the container and after cleanup, remove the pod from the API. In the presence of network partitions, this object may still exist after this timestamp, until an administrator or automated process can determine the resource is fully terminated. If not set, graceful deletion of the object has not been requested.

+

Populated by the system when a graceful deletion is requested. Read-only. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata

+

enable

+

Boolean

+

Enable identifies whether the resource is available

+

finalizers

+

Array of strings

+

Must be empty before the object is deleted from the registry.

+

Each entry is an identifier for the responsible component that will remove

+

the entry from the list. If the deletionTimestamp of the object is non-nil,

+

entries in this list can only be removed. Finalizers may be processed and

+

removed in any order. Order is NOT enforced because it introduces significant

+

risk of stuck finalizers. finalizers is a shared field, any actor with permission

+

can reorder it. If the finalizer list is processed in order, then this can

+

lead to a situation in which the component responsible for the first finalizer

+

in the list is waiting for a signal (field value, external system, or other)

+

produced by a component responsible for a finalizer later in the list, resulting

+

in a deadlock. Without enforced ordering finalizers are free to order amongst

+

themselves and are not vulnerable to ordering changes in the list.

+

generateName

+

String

+

GenerateName is an optional prefix, used by the server, to generate a unique name ONLY IF the Name field has not been provided. If this field is used, the name returned to the client will be different than the name passed. This value will also be combined with a unique suffix. The provided value has the same validation rules as the Name field, and may be truncated by the length of the suffix required to make the value unique on the server.

+

If this field is specified and the generated name exists, the server will NOT return a 409 - instead, it will either return 201 Created or 500 with Reason ServerTimeout indicating a unique name could not be found in the time allotted, and the client should retry (optionally after the time indicated in the Retry-After header).

+

Applied only if Name is not specified. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#idempotency

+

generation

+

Long

+

A sequence number representing a specific generation of the desired

+

state. Populated by the system. Read-only.

+

labels

+

Map<String,String>

+

Map of string keys and values that can be used to organize and categorize (scope and select) objects. May match selectors of replication controllers and services. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/labels/

+

managedFields

+

Array of io.k8s.apimachinery.pkg.apis.meta.v1.ManagedFieldsEntry objects

+

ManagedFields maps workflow-id and version to the set of fields

+

that are managed by that workflow. This is mostly for internal housekeeping,

+

and users typically shouldn't need to set or understand this field. A workflow

+

can be the user's name, a controller's name, or the name of a specific apply

+

path like "ci-cd". The set of fields is always in the version that the workflow

+

used when modifying the object.

+

name

+

String

+

Name must be unique within a namespace. Is required when creating resources, although some resources may allow a client to request the generation of an appropriate name automatically. Name is primarily intended for creation idempotence and configuration definition. Cannot be updated. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names

+

namespace

+

String

+

Namespace defines the space within which each name must be unique. An empty namespace is equivalent to the "default" namespace, but "default" is the canonical representation. Not all objects are required to be scoped to a namespace - the value of this field for those objects will be empty.

+

Must be a DNS_LABEL. Cannot be updated. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/namespaces/

+

ownerReferences

+

Array of io.k8s.apimachinery.pkg.apis.meta.v1.OwnerReference objects

+

List of objects depended by this object. If ALL objects in the

+

list have been deleted, this object will be garbage collected. If this object

+

is managed by a controller, then an entry in this list will point to this

+

controller, with the controller field set to true. There cannot be more

+

than one managing controller.

+

resourceVersion

+

String

+

An opaque value that represents the internal version of this object that can be used by clients to determine when objects have changed. May be used for optimistic concurrency, change detection, and the watch operation on a resource or set of resources. Clients must treat these values as opaque and passed unmodified back to the server. They may only be valid for a particular resource or set of resources.

+

Populated by the system. Read-only. Value must be treated as opaque by clients and . More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#concurrency-control-and-consistency

+

selfLink

+

String

+

SelfLink is a URL representing this object. Populated by the system. Read-only.

+

DEPRECATED Kubernetes will stop propagating this field in 1.20 release and the field is planned to be removed in 1.21 release.

+

uid

+

String

+

UID is the unique in time and space value for this object. It is typically generated by the server on successful creation of a resource and is not allowed to change on PUT operations.

+

Populated by the system. Read-only. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#uids

+
+
+ +
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Table 7 io.k8s.apimachinery.pkg.apis.meta.v1.ManagedFieldsEntry

Parameter

+

Type

+

Description

+

apiVersion

+

String

+

APIVersion defines the version of this resource that this field

+

set applies to. The format is "group/version" just like the top-level APIVersion

+

field. It is necessary to track the version of a field set because it cannot

+

be automatically converted.

+

fieldsType

+

String

+

FieldsType is the discriminator for the different fields format and version. There is currently only one possible value: "FieldsV1"

+

fieldsV1

+

Object

+

FieldsV1 holds the first JSON version format as described in

+

the "FieldsV1" type.

+

manager

+

String

+

Manager is an identifier of the workflow managing these fields.

+

operation

+

String

+

Operation is the type of operation which lead to this ManagedFieldsEntry

+

being created. The only valid values for this field are 'Apply' and 'Update'.

+

time

+

String

+

Time is timestamp of when these fields were set. It should always

+

be empty if Operation is 'Apply'

+
+
+ +
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Table 8 io.k8s.apimachinery.pkg.apis.meta.v1.OwnerReference

Parameter

+

Type

+

Description

+

apiVersion

+

String

+

API version of the referent.

+

blockOwnerDeletion

+

Boolean

+

If true, AND if the owner has the "foregroundDeletion" finalizer,

+

then the owner cannot be deleted from the key-value store until this reference

+

is removed. Defaults to false. To set this field, a user needs "delete"

+

permission of the owner, otherwise 422 (Unprocessable Entity) will be returned.

+

controller

+

Boolean

+

If true, this reference points to the managing controller.

+

kind

+

String

+

Kind of the referent. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds

+

name

+

String

+

Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names

+

uid

+

String

+

UID of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#uids

+
+
+ +
+ + + + + + + + + + + + + + + + + + + + + +
Table 9 io.k8s.apimachinery.pkg.apis.meta.v1.ListMeta

Parameter

+

Type

+

Description

+

continue

+

String

+

continue may be set if the user set a limit on the number of

+

items returned, and indicates that the server has more data available. The

+

value is opaque and may be used to issue another request to the endpoint

+

that served this list to retrieve the next set of available objects. Continuing

+

a consistent list may not be possible if the server configuration has changed

+

or more than a few minutes have passed. The resourceVersion field returned

+

when using this continue value will be identical to the value in the first

+

response, unless you have received this token from an error message.

+

remainingItemCount

+

Long

+

remainingItemCount is the number of subsequent items in the list

+

which are not included in this list response. If the list request contained

+

label or field selectors, then the number of remaining items is unknown

+

and the field will be left unset and omitted during serialization. If the

+

list is complete (either because it is not chunking or because this is the

+

last chunk), then there are no more remaining items and this field will

+

be left unset and omitted during serialization. Servers older than v1.15

+

do not set this field. The intended use of the remainingItemCount is estimating

+

the size of a collection. Clients should not rely on the remainingItemCount

+

to be set or to be exact.

+

resourceVersion

+

String

+

String that identifies the server's internal version of this object that can be used by clients to determine when objects have changed. Value must be treated as opaque by clients and passed unmodified back to the server. Populated by the system. Read-only. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#concurrency-control-and-consistency

+

selfLink

+

String

+

selfLink is a URL representing this object. Populated by the system. Read-only.

+

DEPRECATED Kubernetes will stop propagating this field in 1.20 release and the field is planned to be removed in 1.21 release.

+
+
+
+

Example Requests

None

+
+

Example Responses

Status code: 200

+

OK

+
{
+  "apiVersion" : "v1",
+  "items" : [ {
+    "apiVersion" : "cci/v2",
+    "data" : {
+      "key" : "eHh4Cg=="
+    },
+    "kind" : "Secret",
+    "metadata" : {
+      "annotations" : {
+        "secret.cci.io/namespace-uid" : "8fd96f2d-ecfa-4e4f-8f5f-4070766d333c",
+        "tenant.cci.io/tenant-id" : "08a2*************************c03"
+      },
+      "creationTimestamp" : "2024-10-09T17:13:08Z",
+      "labels" : {
+        "sys_enterprise_project_id" : "0",
+        "tenant.cci.io/tenant-id" : "08a2*************************c03",
+        "tenant.kubernetes.io/domain-id" : "08a*************************ee60",
+        "tenant.kubernetes.io/project-id" : "08a2*************************c03"
+      },
+      "name" : "test-secret",
+      "namespace" : "test-api",
+      "resourceVersion" : "391114527",
+      "uid" : "77d8dedc-b7ae-40a1-b9a6-6f37cca2c4d1"
+    },
+    "type" : "Opaque"
+  } ],
+  "kind" : "List",
+  "metadata" : {
+    "resourceVersion" : ""
+  }
+}
+
+

Status Codes

+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +

Status Code

+

Description

+

200

+

OK

+

400

+

BadRequest

+

401

+

Unauthorized

+

403

+

Forbidden

+

404

+

NotFound

+

405

+

MethodNotAllowed

+

406

+

NotAcceptable

+

409

+

Conflict

+

415

+

UnsupportedMediaType

+

422

+

Invalid

+

429

+

TooManyRequests

+

500

+

InternalError

+

503

+

ServiceUnavailable

+

504

+

ServerTimeout

+
+
+
+
+
+
+
Parent topic: Proprietary APIs
+
+
+ diff --git a/docs/cci/api-ref/listYangtseV2NamespacedNetwork.html b/docs/cci/api-ref/listYangtseV2NamespacedNetwork.html new file mode 100644 index 00000000..2fe2b952 --- /dev/null +++ b/docs/cci/api-ref/listYangtseV2NamespacedNetwork.html @@ -0,0 +1,880 @@ + + +

Listing or Watching Objects of kind Network

+

Function

List or watch objects of kind Network.

+
+

Calling Method

For details, see Calling APIs.

+
+

URI

GET /apis/yangtse/v2/namespaces/{namespace}/networks

+ +
+ + + + + + + + + + + +
Table 1 Path Parameters

Parameter

+

Mandatory

+

Type

+

Description

+

namespace

+

Yes

+

String

+

Object name and auth scope, such as for teams and projects.

+
+
+ +
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Table 2 Query Parameters

Parameter

+

Mandatory

+

Type

+

Description

+

allowWatchBookmarks

+

No

+

Boolean

+

allowWatchBookmarks requests watch events with type "BOOKMARK".

+

Servers that do not implement bookmarks may ignore this flag and bookmarks are sent at the server's discretion. Clients should not assume bookmarks are returned at any specific interval, nor may they assume the server will send any BOOKMARK event during a session. If this is not a watch, this field is ignored.

+

continue

+

No

+

String

+

The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the "next key".

+

This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications.

+

fieldSelector

+

No

+

String

+

A selector to restrict the list of returned objects by their fields. Defaults to everything.

+

labelSelector

+

No

+

String

+

A selector to restrict the list of returned objects by their labels. Defaults to everything.

+

limit

+

No

+

Integer

+

limit is a maximum number of responses to return for a list call. If more items exist, the server will set the continue field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true.

+

The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned.

+

resourceVersion

+

No

+

String

+

resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details.

+

Defaults to unset.

+

resourceVersionMatch

+

No

+

String

+

resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details.

+

Defaults to unset.

+

sendInitialEvents

+

No

+

Boolean

+

sendInitialEvents when set together with Watch option, begins the watch stream with synthetic "Added" events of all resources. Followed by a synthetic "Bookmark" event containing a ResourceVersion after which the server continues streaming events. This option is meant to be used with the resourceVersion parameter with the following semantics:

+
  • sendInitialEvent and RV>0 - provides the initial events and when we reach the desired RV,

    the synthetic bookmark event. Note that the desired RV must be >= the current revision the server knows about.

    +

    If the desired RV is older than the current revision the server is aware of, the TooLargeResourceVersionError is returned.

    +

    Essentially this provides NotOlderThan semantics.

    +
  • sendInitialEvent and RV=0 - provides the initial events and the synthetic bookmark with the current RV. - sendInitialEvent and RV="" - matches data at the most recent ResourceVersion.

    The returned data is consistent, that is, served from etcd via a quorum read.

    +

    It provides the initial events, any other updates and the synthetic bookmark event with the most recent ResourceVersion.

    +
+

timeoutSeconds

+

No

+

Integer

+

Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity.

+

watch

+

No

+

Boolean

+

Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion.

+

pretty

+

No

+

String

+

If 'true', then the output is pretty printed.

+
+
+
+

Request Parameters

+
+ + + + + + + + + + + +
Table 3 Request header parameters

Parameter

+

Mandatory

+

Type

+

Description

+

X-Auth-Token

+

Yes

+

String

+

User token.

+

It can be obtained through the IAM API used to obtain a user token. The value of X-Subject-Token in the response header is the user token.

+
+
+
+

Response Parameters

Status code: 200

+ +
+ + + + + + + + + + + + + + + + + + + + + +
Table 4 Response body parameters

Parameter

+

Type

+

Description

+

apiVersion

+

String

+

APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#resources

+

items

+

Array of com.otc.paas-core.yangtse.pkg.apis.yangtse.v2.Network objects

+

Network is a logical network defined in yangtse.

+

kind

+

String

+

Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds

+

metadata

+

io.k8s.apimachinery.pkg.apis.meta.v1.ListMeta object

+

ListMeta describes metadata that synthetic resources must have, including lists and various status objects. A resource may have only one of {ObjectMeta, ListMeta}.

+
+
+ +
+ + + + + + + + + + + + + + + + + + + + + + + + + +
Table 5 com.otc.paas-core.yangtse.pkg.apis.yangtse.v2.Network

Parameter

+

Type

+

Description

+

apiVersion

+

String

+

APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#resources

+

kind

+

String

+

Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds

+

metadata

+

io.k8s.apimachinery.pkg.apis.meta.v1.ObjectMeta object

+

ObjectMeta is metadata that all persisted resources must have, which includes all objects users must create.

+

spec

+

com.otc.paas-core.yangtse.pkg.apis.yangtse.v2.NetworkSpec object

+

Specification of the desired behavior of network.

+

status

+

com.otc.paas-core.yangtse.pkg.apis.yangtse.v2.NetworkStatus object

+

Most recently observed status of the network.

+
+
+ +
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Table 6 io.k8s.apimachinery.pkg.apis.meta.v1.ObjectMeta

Parameter

+

Type

+

Description

+

annotations

+

Map<String,String>

+

Annotations is an unstructured key value map stored with a resource that may be set by external tools to store and retrieve arbitrary metadata. They are not queryable and should be preserved when modifying objects. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/annotations/

+

clusterName

+

String

+

The name of the cluster which the object belongs to. This is used to distinguish resources with same name and namespace in different clusters. This field is not set anywhere right now and apiserver is going to ignore it if set in create or update request.

+

creationTimestamp

+

String

+

CreationTimestamp is a timestamp representing the server time when this object was created. It is not guaranteed to be set in happens-before order across separate operations. Clients may not set this value. It is represented in RFC3339 form and is in UTC.

+

Populated by the system. Read-only. Null for lists. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata

+

deletionGracePeriodSeconds

+

Long

+

Number of seconds allowed for this object to gracefully terminate before it will be removed from the system. Only set when deletionTimestamp is also set. May only be shortened. Read-only.

+

deletionTimestamp

+

String

+

DeletionTimestamp is RFC 3339 date and time at which this resource will be deleted. This field is set by the server when a graceful deletion is requested by the user, and is not directly settable by a client. The resource is expected to be deleted (no longer visible from resource lists, and not reachable by name) after the time in this field, once the finalizers list is empty. As long as the finalizers list contains items, deletion is blocked. Once the deletionTimestamp is set, this value may not be unset or be set further into the future, although it may be shortened or the resource may be deleted prior to this time. For example, a user may request that a pod is deleted in 30 seconds. The Kubelet will react by sending a graceful termination signal to the containers in the pod. After that 30 seconds, the Kubelet will send a hard termination signal (SIGKILL) to the container and after cleanup, remove the pod from the API. In the presence of network partitions, this object may still exist after this timestamp, until an administrator or automated process can determine the resource is fully terminated. If not set, graceful deletion of the object has not been requested.

+

Populated by the system when a graceful deletion is requested. Read-only. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata

+

enable

+

Boolean

+

Enable identifies whether the resource is available.

+

finalizers

+

Array of strings

+

Must be empty before the object is deleted from the registry.

+

Each entry is an identifier for the responsible component that will remove the entry from the list. If the deletionTimestamp of the object is non-nil, entries in this list can only be removed. Finalizers may be processed and removed in any order. Order is NOT enforced because it introduces significant risk of stuck finalizers. finalizers is a shared field, any actor with permission can reorder it. If the finalizer list is processed in order, then this can lead to a situation in which the component responsible for the first finalizer in the list is waiting for a signal (field value, external system, or other) produced by a component responsible for a finalizer later in the list, resulting in a deadlock. Without enforced ordering finalizers are free to order amongst themselves and are not vulnerable to ordering changes in the list.

+

generateName

+

String

+

GenerateName is an optional prefix, used by the server, to generate a unique name ONLY IF the Name field has not been provided. If this field is used, the name returned to the client will be different than the name passed. This value will also be combined with a unique suffix. The provided value has the same validation rules as the Name field, and may be truncated by the length of the suffix required to make the value unique on the server.

+

If this field is specified and the generated name exists, the server will NOT return a 409 - instead, it will either return 201 Created or 500 with Reason ServerTimeout indicating a unique name could not be found in the time allotted, and the client should retry (optionally after the time indicated in the Retry-After header).

+

Applied only if Name is not specified. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#idempotency

+

generation

+

Long

+

A sequence number representing a specific generation of the desired state. Populated by the system. Read-only.

+

labels

+

Map<String,String>

+

Map of string keys and values that can be used to organize and categorize (scope and select) objects. May match selectors of replication controllers and services. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/labels/

+

managedFields

+

Array of io.k8s.apimachinery.pkg.apis.meta.v1.ManagedFieldsEntry objects

+

ManagedFields maps workflow-id and version to the set of fields that are managed by that workflow. This is mostly for internal housekeeping, and users typically shouldn't need to set or understand this field. A workflow can be the user's name, a controller's name, or the name of a specific apply path like "ci-cd". The set of fields is always in the version that the workflow used when modifying the object.

+

name

+

String

+

Name must be unique within a namespace. Is required when creating resources, although some resources may allow a client to request the generation of an appropriate name automatically. Name is primarily intended for creation idempotence and configuration definition. Cannot be updated. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names

+

namespace

+

String

+

Namespace defines the space within which each name must be unique. An empty namespace is equivalent to the "default" namespace, but "default" is the canonical representation. Not all objects are required to be scoped to a namespace - the value of this field for those objects will be empty.

+

Must be a DNS_LABEL. Cannot be updated. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/namespaces/

+

ownerReferences

+

Array of io.k8s.apimachinery.pkg.apis.meta.v1.OwnerReference objects

+

List of objects depended by this object. If ALL objects in the list have been deleted, this object will be garbage collected. If this object is managed by a controller, then an entry in this list will point to this controller, with the controller field set to true. There cannot be more than one managing controller.

+

resourceVersion

+

String

+

An opaque value that represents the internal version of this object that can be used by clients to determine when objects have changed. May be used for optimistic concurrency, change detection, and the watch operation on a resource or set of resources. Clients must treat these values as opaque and passed unmodified back to the server. They may only be valid for a particular resource or set of resources.

+

Populated by the system. Read-only. Value must be treated as opaque by clients and . More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#concurrency-control-and-consistency

+

selfLink

+

String

+

SelfLink is a URL representing this object. Populated by the system. Read-only.

+

DEPRECATED Kubernetes will stop propagating this field in 1.20 release and the field is planned to be removed in 1.21 release.

+

uid

+

String

+

UID is the unique in time and space value for this object. It is typically generated by the server on successful creation of a resource and is not allowed to change on PUT operations.

+

Populated by the system. Read-only. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#uids

+
+
+ +
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Table 7 io.k8s.apimachinery.pkg.apis.meta.v1.ManagedFieldsEntry

Parameter

+

Type

+

Description

+

apiVersion

+

String

+

APIVersion defines the version of this resource that this field set applies to. The format is "group/version" just like the top-level APIVersion field. It is necessary to track the version of a field set because it cannot be automatically converted.

+

fieldsType

+

String

+

FieldsType is the discriminator for the different fields format and version. There is currently only one possible value: "FieldsV1"

+

fieldsV1

+

Object

+

FieldsV1 holds the first JSON version format as described in the "FieldsV1" type.

+

manager

+

String

+

Manager is an identifier of the workflow managing these fields.

+

operation

+

String

+

Operation is the type of operation which lead to this ManagedFieldsEntry being created. The only valid values for this field are 'Apply' and 'Update'.

+

time

+

String

+

Time is timestamp of when these fields were set. It should always be empty if Operation is 'Apply'

+
+
+ +
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Table 8 io.k8s.apimachinery.pkg.apis.meta.v1.OwnerReference

Parameter

+

Type

+

Description

+

apiVersion

+

String

+

API version of the referent.

+

blockOwnerDeletion

+

Boolean

+

If true, AND if the owner has the "foregroundDeletion" finalizer, then the owner cannot be deleted from the key-value store until this reference is removed. Defaults to false. To set this field, a user needs "delete" permission of the owner, otherwise 422 (Unprocessable Entity) will be returned.

+

controller

+

Boolean

+

If true, this reference points to the managing controller.

+

kind

+

String

+

Kind of the referent. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds

+

name

+

String

+

Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names

+

uid

+

String

+

UID of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#uids

+
+
+ +
+ + + + + + + + + + + + + + + + + + + + + +
Table 9 com.otc.paas-core.yangtse.pkg.apis.yangtse.v2.NetworkSpec

Parameter

+

Type

+

Description

+

ipFamilies

+

Array of strings

+

IPFamilies of Network, can be "IPv4" or "IPv6".

+

networkType

+

String

+

Type of network, only support "underlay-neutron".

+

securityGroups

+

Array of strings

+

SecurityGroups of the network. NOTE: 1. nil means not enable security group; 2. [""] means enable security group but deny all; 3. ["xxx,yyy"] means enable security group and allow with security group ids;

+

subnets

+

Array of com.otc.paas-core.yangtse.pkg.apis.yangtse.v2.SubnetConf objects

+

Describes the subnets of the network.

+
+
+ +
+ + + + + + + + + +
Table 10 com.otc.paas-core.yangtse.pkg.apis.yangtse.v2.SubnetConf

Parameter

+

Type

+

Description

+

subnetID

+

String

+

SubnetID subnetV4ID of the subnet.

+
+
+ +
+ + + + + + + + + + + + + + + + + +
Table 11 com.otc.paas-core.yangtse.pkg.apis.yangtse.v2.NetworkStatus

Parameter

+

Type

+

Description

+

conditions

+

Array of io.k8s.apimachinery.pkg.apis.meta.v1.Condition objects

+

Conditions describe the current conditions of the Network.

+

status

+

String

+

Status of network, can be "Ready" or "Failed" or "IPInsufficient".

+

subnetAttrs

+

Array of com.otc.paas-core.yangtse.pkg.apis.yangtse.v2.SubnetAttr objects

+

SubnetAttrs describe the current subnet information of the Network.

+
+
+ +
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Table 12 io.k8s.apimachinery.pkg.apis.meta.v1.Condition

Parameter

+

Type

+

Description

+

lastTransitionTime

+

String

+

lastTransitionTime is the last time the condition transitioned from one status to another. This should be when the underlying condition changed. If that is not known, then using the time when the API field changed is acceptable.

+

message

+

String

+

message is a human readable message indicating details about the transition. This may be an empty string.

+

observedGeneration

+

Long

+

observedGeneration represents the .metadata.generation that the condition was set based upon. For instance, if .metadata.generation is currently 12, but the .status.conditions[x].observedGeneration is 9, the condition is out of date with respect to the current state of the instance.

+

reason

+

String

+

reason contains a programmatic identifier indicating the reason for the condition's last transition. Producers of specific condition types may define expected values and meanings for this field, and whether the values are considered a guaranteed API. The value should be a CamelCase string. This field may not be empty.

+

status

+

String

+

status of the condition, one of True, False, Unknown.

+

type

+

String

+

type of condition in CamelCase or in foo.example.com/CamelCase.

+
+
+ +
+ + + + + + + + + + + + + + + + + +
Table 13 com.otc.paas-core.yangtse.pkg.apis.yangtse.v2.SubnetAttr

Parameter

+

Type

+

Description

+

networkID

+

String

+		  

subnetV4ID

+

String

+		  

subnetV6ID

+

String

+		  
+
+ +
+ + + + + + + + + + + + + + + + + + + + + +
Table 14 io.k8s.apimachinery.pkg.apis.meta.v1.ListMeta

Parameter

+

Type

+

Description

+

continue

+

String

+

continue may be set if the user set a limit on the number of items returned, and indicates that the server has more data available. The value is opaque and may be used to issue another request to the endpoint that served this list to retrieve the next set of available objects. Continuing a consistent list may not be possible if the server configuration has changed or more than a few minutes have passed. The resourceVersion field returned when using this continue value will be identical to the value in the first response, unless you have received this token from an error message.

+

remainingItemCount

+

Long

+

remainingItemCount is the number of subsequent items in the list which are not included in this list response. If the list request contained label or field selectors, then the number of remaining items is unknown and the field will be left unset and omitted during serialization. If the list is complete (either because it is not chunking or because this is the last chunk), then there are no more remaining items and this field will be left unset and omitted during serialization. Servers older than v1.15 do not set this field. The intended use of the remainingItemCount is estimating the size of a collection. Clients should not rely on the remainingItemCount to be set or to be exact.

+

resourceVersion

+

String

+

String that identifies the server's internal version of this object that can be used by clients to determine when objects have changed. Value must be treated as opaque by clients and passed unmodified back to the server. Populated by the system. Read-only. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#concurrency-control-and-consistency

+

selfLink

+

String

+

selfLink is a URL representing this object. Populated by the system. Read-only.

+

DEPRECATED Kubernetes will stop propagating this field in 1.20 release and the field is planned to be removed in 1.21 release.

+
+
+
+

Example Requests

None

+
+

Example Responses

Status code: 200

+

OK

+
{
+  "apiVersion" : "v1",
+  "items" : [ {
+    "apiVersion" : "yangtse/v2",
+    "kind" : "Network",
+    "metadata" : {
+      "annotations" : {
+        "yangtse.io/domain-id" : "08a*************************ee60",
+        "yangtse.io/project-id" : "08a2*************************c03",
+        "yangtse.io/warm-pool-recycle-interval" : "1",
+        "yangtse.io/warm-pool-size" : "10"
+      },
+      "creationTimestamp" : "2024-03-25T09:27:52Z",
+      "finalizers" : [ "yangtse.io/network-cleanup" ],
+      "name" : "test-api",
+      "namespace" : "test-api",
+      "resourceVersion" : "17365331",
+      "uid" : "70c20697-a233-4405-b512-ebec1d3c58d0"
+    },
+    "spec" : {
+      "networkType" : "underlay_neutron",
+      "securityGroups" : [ "4120c2f9-3a1d-453e-9b64-f51b92861e26" ],
+      "subnets" : [ {
+        "subnetID" : "2eb62e19-cf1a-4741-90cc-90fb127b20ab"
+      } ]
+    },
+    "status" : {
+      "conditions" : [ {
+        "lastTransitionTime" : "2024-03-25T09:27:53Z",
+        "message" : "",
+        "reason" : "",
+        "status" : "True",
+        "type" : "NetworkSynced"
+      }, {
+        "lastTransitionTime" : "2024-08-12T15:40:03Z",
+        "message" : "",
+        "reason" : "",
+        "status" : "True",
+        "type" : "NetworkExternalDependenciesSynced"
+      } ],
+      "status" : "Ready",
+      "subnetAttrs" : [ {
+        "networkID" : "377b6228-d2a7-47ab-bdb0-f7fc59802198",
+        "subnetV4ID" : "2eb62e19-cf1a-4741-90cc-90fb127b20ab"
+      } ]
+    }
+  } ],
+  "kind" : "List",
+  "metadata" : {
+    "resourceVersion" : ""
+  }
+}
+
+

Status Codes

+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +

Status Code

+

Description

+

200

+

OK

+

400

+

BadRequest

+

401

+

Unauthorized

+

403

+

Forbidden

+

404

+

NotFound

+

405

+

MethodNotAllowed

+

406

+

NotAcceptable

+

409

+

Conflict

+

415

+

UnsupportedMediaType

+

422

+

Invalid

+

429

+

TooManyRequests

+

500

+

InternalError

+

503

+

ServiceUnavailable

+

504

+

ServerTimeout

+
+
+
+
+
+
+
Parent topic: Proprietary APIs
+
+
+ diff --git a/docs/cci/api-ref/patchCciV2NamespacedPod.html b/docs/cci/api-ref/patchCciV2NamespacedPod.html new file mode 100644 index 00000000..88f360c6 --- /dev/null +++ b/docs/cci/api-ref/patchCciV2NamespacedPod.html @@ -0,0 +1,7269 @@ + + +

Partially Updating the Specified Pod

+

Function

Partially update the specified Pod.

+

The following fields can be updated:

+ +
+

Calling Method

For details, see Calling APIs.

+
+

URI

PATCH /apis/cci/v2/namespaces/{namespace}/pods/{name}

+ +
+ + + + + + + + + + + + + + + + +
Table 1 Path Parameters

Parameter

+

Mandatory

+

Type

+

Description

+

name

+

Yes

+

String

+

Name of the Pod.

+

namespace

+

Yes

+

String

+

Object name and auth scope, such as for teams and projects.

+
+
+ +
+ + + + + + + + + + + + + + + + + + + + + + + + + + +
Table 2 Query Parameters

Parameter

+

Mandatory

+

Type

+

Description

+

dryRun

+

No

+

String

+

When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed

+

fieldManager

+

No

+

String

+

fieldManager is a name associated with the actor or entity that

+

is making these changes. The value must be less than or 128 characters long,

+

and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint.

+

This field is required for apply requests (application/apply-patch) but

+

optional for non-apply patch types (JsonPatch, MergePatch, StrategicMergePatch).

+

force

+

No

+

Boolean

+

Force is going to "force" Apply requests. It means user will

+

re-acquire conflicting fields owned by other people. Force flag must be

+

unset for non-apply patch requests.

+

pretty

+

No

+

String

+

If 'true', then the output is pretty printed.

+
+
+
+

Request Parameters

+
+ + + + + + + + + + + + + + + + +
Table 3 Request header parameters

Parameter

+

Mandatory

+

Type

+

Description

+

X-Auth-Token

+

Yes

+

String

+

User token.

+

It can be obtained through the IAM API used to obtain a user token. The value of X-Subject-Token in the response header is the user token.

+

Content-Type

+

Yes

+

String

+

Currently, three types of patch request methods are supported. For details, see "Update API Objects in Place Using kubectl patch" (https://kubernetes.io/docs/tasks/manage-kubernetes-objects/update-api-object-kubectl-patch/).

+
  1. Json Patch, Content-Type: application/json-patch+json As defined in RFC6902, Json Patch contains a series of operations on a JSON object. After receiving the object, the server applies the represented operations to the JSON object.
  2. Merge Patch, Content-Type: application/merge-patch+json According to RFC 7386, Merge Patch contains some description of a JSON object. The JSON object is submitted to the server end and merges with the current object of the server end, which means to replace the list field of the current resource object to form a new object.
  3. Strategic Merge Patch, Content-Type: application/strategic-merge-patch+json Strategic Merge Patch is used to add legal metadata to API objects and uses new metadata to determine which lists should be merged and which ones should not. The current metadata is used as the structure labels.
+
+
+ +
+ + + + + + + + + + + +
Table 4 Request body parameters

Parameter

+

Mandatory

+

Type

+

Description

+

-

+

Yes

+

Object

+

Patch is provided to give a concrete name and type to the Kubernetes

+

PATCH request body.

+
+
+
+

Response Parameters

Status code: 200

+ +
+ + + + + + + + + + + + + + + + + + + + + + + + + +
Table 5 Response body parameters

Parameter

+

Type

+

Description

+

apiVersion

+

String

+

APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#resources

+

kind

+

String

+

Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds

+

metadata

+

io.k8s.apimachinery.pkg.apis.meta.v1.ObjectMeta object

+

Standard object's metadata. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata

+

spec

+

io.cci.otc.api.pkg.apis.versioned.cci.v2.PodSpec object

+

Specification of the desired behavior of the pod. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#spec-and-status

+

status

+

io.cci.otc.api.pkg.apis.versioned.cci.v2.PodStatus object

+

Most recently observed status of the pod. This data may not be up to date. Populated by the system. Read-only. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#spec-and-status

+
+
+ +
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Table 6 io.cci.otc.api.pkg.apis.versioned.cci.v2.PodSpec

Parameter

+

Type

+

Description

+

activeDeadlineSeconds

+

Long

+

Optional duration in seconds the pod may be active on the node

+

relative to StartTime before the system will actively try to mark it failed

+

and kill associated containers. Value must be a positive integer.

+

affinity

+

io.cci.otc.api.pkg.apis.versioned.cci.v2.Affinity object

+

If specified, the pod's scheduling constraints

+

containers

+

Array of io.cci.otc.api.pkg.apis.versioned.cci.v2.Container objects

+

List of containers belonging to the pod. Containers cannot currently

+

be added or removed. There must be at least one container in a Pod. Cannot

+

be updated.

+

dnsConfig

+

io.cci.otc.api.pkg.apis.versioned.cci.v2.PodDNSConfig object

+

Specifies the DNS parameters of a pod. Parameters specified here

+

will be merged to the generated DNS configuration based on DNSPolicy.

+

dnsPolicy

+

String

+

Set DNS policy for the pod. Defaults to "ClusterFirst". Valid values are 'ClusterFirstWithHostNet', 'ClusterFirst', 'Default' or 'None'. DNS parameters given in DNSConfig will be merged with the policy selected with DNSPolicy. To have DNS options set along with hostNetwork, you have to specify DNS policy explicitly to 'ClusterFirstWithHostNet'.

+

Possible enum values:

+
  • "ClusterFirst" indicates that the pod should use cluster DNS first unless hostNetwork is true, if it is available, then fall back on the default (as determined by kubelet) DNS settings.
  • "ClusterFirstWithHostNet" indicates that the pod should use cluster DNS first, if it is available, then fall back on the default (as determined by kubelet) DNS settings.
  • "Default" indicates that the pod should use the default (as determined by kubelet) DNS settings.
  • "None" indicates that the pod should use empty DNS settings. DNS parameters such as nameservers and search paths should be defined via DNSConfig.
+

ephemeralContainers

+

Array of io.cci.otc.api.pkg.apis.versioned.cci.v2.EphemeralContainer objects

+

List of ephemeral containers run in this pod. Ephemeral containers

+

may be run in an existing pod to perform user-initiated actions such as

+

debugging. This list cannot be specified when creating a pod, and it cannot

+

be modified by updating the pod spec. In order to add an ephemeral container

+

to an existing pod, use the pod's ephemeralcontainers subresource.

+

hostAliases

+

Array of io.cci.otc.api.pkg.apis.versioned.cci.v2.HostAlias objects

+

HostAliases is an optional list of hosts and IPs that will be

+

injected into the pod's hosts file if specified. This is only valid for

+

non-hostNetwork pods.

+

hostname

+

String

+

Specifies the hostName of the Pod. If not specified, the pod's

+

hostname will be set to a system-defined value.

+

imagePullSecrets

+

Array of io.cci.otc.api.pkg.apis.versioned.cci.v2.LocalObjectReference objects

+

ImagePullSecrets is an optional list of references to secrets in the same namespace to use for pulling any of the images used by this PodSpec. If specified, these secrets will be passed to individual puller implementations for them to use. More info: https://kubernetes.io/docs/concepts/containers/images#specifying-imagepullsecrets-on-a-pod

+

initContainers

+

Array of io.cci.otc.api.pkg.apis.versioned.cci.v2.Container objects

+

List of initialization containers belonging to the pod. Init containers are executed in order prior to containers being started. If any init container fails, the pod is considered to have failed and is handled according to its restartPolicy. The name for an init container or normal container must be unique among all containers. Init containers may not have Lifecycle actions, Readiness probes, Liveness probes, or Startup probes. The resourceRequirements of an init container are taken into account during scheduling by finding the highest request/limit for each resource type, and then using the max of of that value or the sum of the normal containers. Limits are applied to init containers in a similar fashion. Init containers cannot currently be added or removed. Cannot be updated. More info: https://kubernetes.io/docs/concepts/workloads/pods/init-containers/

+

nodeName

+

String

+

NodeName is a request to schedule this pod onto a specific node.

+

If it is non-empty, the scheduler simply schedules this pod onto that node,

+

assuming that it fits resource requirements.

+

overhead

+

Map<String,String>

+

Overhead represents the resource overhead associated with running a pod for a given RuntimeClass. This field will be autopopulated at admission time by the RuntimeClass admission controller. If the RuntimeClass admission controller is enabled, overhead must not be set in Pod create requests. The RuntimeClass admission controller will reject Pod create requests which have the overhead already set. If RuntimeClass is configured and selected in the PodSpec, Overhead will be set to the value defined in the corresponding RuntimeClass, otherwise it will remain unset and treated as zero. More info: https://git.k8s.io/enhancements/keps/sig-node/688-pod-overhead/README.md

+

readinessGates

+

Array of io.cci.otc.api.pkg.apis.versioned.cci.v2.PodReadinessGate objects

+

If specified, all readiness gates will be evaluated for pod readiness. A pod is ready when all its containers are ready AND all conditions specified in the readiness gates have status equal to "True" More info: https://git.k8s.io/enhancements/keps/sig-network/580-pod-readiness-gates

+

restartPolicy

+

String

+

Restart policy for all containers within the pod. One of Always, OnFailure, Never. Default to Always. More info: https://kubernetes.io/docs/concepts/workloads/pods/pod-lifecycle/#restart-policy

+

Possible enum values:

+
  • "Always"
  • "Never"
  • "OnFailure"
+

schedulerName

+

String

+

If specified, the pod will be dispatched by specified scheduler.

+

If not specified, the pod will be dispatched by default scheduler.

+

securityContext

+

io.cci.otc.api.pkg.apis.versioned.cci.v2.PodSecurityContext object

+

SecurityContext holds pod-level security attributes and common container settings. Optional: Defaults to empty. See type description for default values of each field.

+

setHostnameAsFQDN

+

Boolean

+

If true the pod's hostname will be configured as the pod's FQDN,

+

rather than the leaf name (the default). In Linux containers, this means

+

setting the FQDN in the hostname field of the kernel (the nodename field

+

of struct utsname). In Windows containers, this means setting the registry

+

value of hostname for the registry key HKEY_LOCAL_MACHINE\SYSTEM\CurrentControlSet\Services\Tcpip\Parameters

+

to FQDN. If a pod does not have FQDN, this has no effect. Default to false.

+

shareProcessNamespace

+

Boolean

+

Share a single process namespace between all of the containers in a pod. When this is set containers will be able to view and signal processes from other containers in the same pod, and the first process in each container will not be assigned PID 1. HostPID and ShareProcessNamespace cannot both be set. Optional: Default to false.

+

terminationGracePeriodSeconds

+

Long

+

Optional duration in seconds the pod needs to terminate gracefully.

+

May be decreased in delete request. Value must be non-negative integer.

+

The value zero indicates stop immediately via the kill signal (no opportunity

+

to shut down). If this value is nil, the default grace period will be used

+

instead. The grace period is the duration in seconds after the processes

+

running in the pod are sent a termination signal and the time when the processes

+

are forcibly halted with a kill signal. Set this value longer than the expected

+

cleanup time for your process. Defaults to 30 seconds.

+

topologySpreadConstraints

+

Array of io.cci.otc.api.pkg.apis.versioned.cci.v2.TopologySpreadConstraint objects

+

TopologySpreadConstraints describes how a group of pods ought

+

to spread across topology domains. Scheduler will schedule pods in a way

+

which abides by the constraints. All topologySpreadConstraints are ANDed.

+

volumes

+

Array of io.cci.otc.api.pkg.apis.versioned.cci.v2.Volume objects

+

List of volumes that can be mounted by containers belonging to the pod. More info: https://kubernetes.io/docs/concepts/storage/volumes

+
+
+ +
+ + + + + + + + + + + + + +
Table 7 io.cci.otc.api.pkg.apis.versioned.cci.v2.Affinity

Parameter

+

Type

+

Description

+

nodeAffinity

+

io.cci.otc.api.pkg.apis.versioned.cci.v2.NodeAffinity object

+

Describes node affinity scheduling rules for the pod.

+

podAntiAffinity

+

io.cci.otc.api.pkg.apis.versioned.cci.v2.PodAntiAffinity object

+

Describes pod anti-affinity scheduling rules (e.g. avoid putting

+

this pod in the same zone, etc. as some other pod(s)).

+
+
+ +
+ + + + + + + + + +
Table 8 io.cci.otc.api.pkg.apis.versioned.cci.v2.NodeAffinity

Parameter

+

Type

+

Description

+

requiredDuringSchedulingIgnoredDuringExecution

+

io.cci.otc.api.pkg.apis.versioned.cci.v2.NodeSelector object

+

If the affinity requirements specified by this field are not

+

met at scheduling time, the pod will not be scheduled onto the node. If

+

the affinity requirements specified by this field cease to be met at some

+

point during pod execution (e.g. due to an update), the system may or may

+

not try to eventually evict the pod from its node.

+
+
+ +
+ + + + + + + + + +
Table 9 io.cci.otc.api.pkg.apis.versioned.cci.v2.NodeSelector

Parameter

+

Type

+

Description

+

nodeSelectorTerms

+

Array of io.cci.otc.api.pkg.apis.versioned.cci.v2.NodeSelectorTerm objects

+

Required. A list of node selector terms. The terms are ORed.

+
+
+ +
+ + + + + + + + + +
Table 10 io.cci.otc.api.pkg.apis.versioned.cci.v2.NodeSelectorTerm

Parameter

+

Type

+

Description

+

matchExpressions

+

Array of io.cci.otc.api.pkg.apis.versioned.cci.v2.NodeSelectorRequirement objects

+

A list of node selector requirements by node's labels.

+
+
+ +
+ + + + + + + + + + + + + + + + + +
Table 11 io.cci.otc.api.pkg.apis.versioned.cci.v2.NodeSelectorRequirement

Parameter

+

Type

+

Description

+

key

+

String

+

The label key that the selector applies to.

+

operator

+

String

+

Represents a key's relationship to a set of values. Valid operators are In, NotIn, Exists, DoesNotExist. Gt, and Lt.

+

Possible enum values:

+
  • "DoesNotExist"
  • "Exists"
  • "Gt"
  • "In"
  • "Lt"
  • "NotIn"
+

values

+

Array of strings

+

An array of string values. If the operator is In or NotIn, the

+

values array must be non-empty. If the operator is Exists or DoesNotExist,

+

the values array must be empty. If the operator is Gt or Lt, the values

+

array must have a single element, which will be interpreted as an integer.

+

This array is replaced during a strategic merge patch.

+
+
+ +
+ + + + + + + + + + + + + +
Table 12 io.cci.otc.api.pkg.apis.versioned.cci.v2.PodAntiAffinity

Parameter

+

Type

+

Description

+

preferredDuringSchedulingIgnoredDuringExecution

+

Array of io.cci.otc.api.pkg.apis.versioned.cci.v2.WeightedPodAffinityTerm objects

+

The scheduler will prefer to schedule pods to nodes that satisfy

+

the anti-affinity expressions specified by this field, but it may choose

+

a node that violates one or more of the expressions. The node that is most

+

preferred is the one with the greatest sum of weights, i.e. for each node

+

that meets all of the scheduling requirements (resource request, requiredDuringScheduling

+

anti-affinity expressions, etc.), compute a sum by iterating through the

+

elements of this field and adding "weight" to the sum if the node has pods

+

which matches the corresponding podAffinityTerm; the node(s) with the highest

+

sum are the most preferred.

+

requiredDuringSchedulingIgnoredDuringExecution

+

Array of io.cci.otc.api.pkg.apis.versioned.cci.v2.PodAffinityTerm objects

+

If the anti-affinity requirements specified by this field are

+

not met at scheduling time, the pod will not be scheduled onto the node.

+

If the anti-affinity requirements specified by this field cease to be met

+

at some point during pod execution (e.g. due to a pod label update), the

+

system may or may not try to eventually evict the pod from its node. When

+

there are multiple elements, the lists of nodes corresponding to each podAffinityTerm

+

are intersected, i.e. all terms must be satisfied.

+
+
+ +
+ + + + + + + + + + + + + +
Table 13 io.cci.otc.api.pkg.apis.versioned.cci.v2.WeightedPodAffinityTerm

Parameter

+

Type

+

Description

+

podAffinityTerm

+

io.cci.otc.api.pkg.apis.versioned.cci.v2.PodAffinityTerm object

+

Required. A pod affinity term, associated with the corresponding

+

weight.

+

weight

+

Integer

+

weight associated with matching the corresponding podAffinityTerm,

+

in the range 1-100.

+
+
+ +
+ + + + + + + + + + + + + + + + + +
Table 14 io.cci.otc.api.pkg.apis.versioned.cci.v2.PodAffinityTerm

Parameter

+

Type

+

Description

+

labelSelector

+

io.k8s.apimachinery.pkg.apis.meta.v1.LabelSelector object

+

A label query over a set of resources, in this case pods.

+

namespaces

+

Array of strings

+

namespaces specifies a static list of namespace names that the

+

term applies to. The term is applied to the union of the namespaces listed

+

in this field and the ones selected by namespaceSelector. null or empty

+

namespaces list and null namespaceSelector means "this pod's namespace".

+

topologyKey

+

String

+

This pod should be co-located (affinity) or not co-located (anti-affinity)

+

with the pods matching the labelSelector in the specified namespaces, where

+

co-located is defined as running on a node whose value of the label with

+

key topologyKey matches that of any node on which any of the selected pods

+

is running. Empty topologyKey is not allowed.

+
+
+ +
+ + + + + + + + + + + + + + + + + +
Table 15 io.cci.otc.api.pkg.apis.versioned.cci.v2.PodDNSConfig

Parameter

+

Type

+

Description

+

nameservers

+

Array of strings

+

A list of DNS name server IP addresses. This will be appended

+

to the base nameservers generated from DNSPolicy. Duplicated nameservers

+

will be removed.

+

options

+

Array of io.cci.otc.api.pkg.apis.versioned.cci.v2.PodDNSConfigOption objects

+

A list of DNS resolver options. This will be merged with the

+

base options generated from DNSPolicy. Duplicated entries will be removed.

+

Resolution options given in Options will override those that appear in the

+

base DNSPolicy.

+

searches

+

Array of strings

+

A list of DNS search domains for host-name lookup. This will

+

be appended to the base search paths generated from DNSPolicy. Duplicated

+

search paths will be removed.

+
+
+ +
+ + + + + + + + + + + + + +
Table 16 io.cci.otc.api.pkg.apis.versioned.cci.v2.PodDNSConfigOption

Parameter

+

Type

+

Description

+

name

+

String

+

Required.

+

value

+

String

+		  
+
+ +
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Table 17 io.cci.otc.api.pkg.apis.versioned.cci.v2.EphemeralContainer

Parameter

+

Type

+

Description

+

args

+

Array of strings

+

Arguments to the entrypoint. The image's CMD is used if this is not provided. Variable references $(VAR_NAME) are expanded using the container's environment. If a variable cannot be resolved, the reference in the input string will be unchanged. Double $$ are reduced to a single $, which allows for escaping the $(VAR_NAME) syntax: i.e. "$$(VAR_NAME)" will produce the string literal "$(VAR_NAME)". Escaped references will never be expanded, regardless of whether the variable exists or not. Cannot be updated. More info: https://kubernetes.io/docs/tasks/inject-data-application/define-command-argument-container/#running-a-command-in-a-shell

+

command

+

Array of strings

+

Entrypoint array. Not executed within a shell. The image's ENTRYPOINT is used if this is not provided. Variable references $(VAR_NAME) are expanded using the container's environment. If a variable cannot be resolved, the reference in the input string will be unchanged. Double $$ are reduced to a single $, which allows for escaping the $(VAR_NAME) syntax: i.e. "$$(VAR_NAME)" will produce the string literal "$(VAR_NAME)". Escaped references will never be expanded, regardless of whether the variable exists or not. Cannot be updated. More info: https://kubernetes.io/docs/tasks/inject-data-application/define-command-argument-container/#running-a-command-in-a-shell

+

env

+

Array of io.cci.otc.api.pkg.apis.versioned.cci.v2.EnvVar objects

+

List of environment variables to set in the container. Cannot

+

be updated.

+

envFrom

+

Array of io.cci.otc.api.pkg.apis.versioned.cci.v2.EnvFromSource objects

+

List of sources to populate environment variables in the container.

+

The keys defined within a source must be a C_IDENTIFIER. All invalid keys

+

will be reported as an event when the container is starting. When a key

+

exists in multiple sources, the value associated with the last source will

+

take precedence. Values defined by an Env with a duplicate key will take

+

precedence. Cannot be updated.

+

image

+

String

+

Container image name. More info: https://kubernetes.io/docs/concepts/containers/images

+

lifecycle

+

io.cci.otc.api.pkg.apis.versioned.cci.v2.Lifecycle object

+

Lifecycle is not allowed for ephemeral containers.

+

livenessProbe

+

io.cci.otc.api.pkg.apis.versioned.cci.v2.Probe object

+

Probes are not allowed for ephemeral containers.

+

name

+

String

+

Name of the ephemeral container specified as a DNS_LABEL. This

+

name must be unique among all containers, init containers and ephemeral

+

containers.

+

ports

+

Array of io.cci.otc.api.pkg.apis.versioned.cci.v2.ContainerPort objects

+

Ports are not allowed for ephemeral containers.

+

readinessProbe

+

io.cci.otc.api.pkg.apis.versioned.cci.v2.Probe object

+

Probes are not allowed for ephemeral containers.

+

resources

+

io.cci.otc.api.pkg.apis.versioned.cci.v2.ResourceRequirements object

+

Resources are not allowed for ephemeral containers. Ephemeral

+

containers use spare resources already allocated to the pod.

+

securityContext

+

io.cci.otc.api.pkg.apis.versioned.cci.v2.SecurityContext object

+

Optional: SecurityContext defines the security options the ephemeral container should be run with. If set, the fields of SecurityContext override the equivalent fields of PodSecurityContext.

+

startupProbe

+

io.cci.otc.api.pkg.apis.versioned.cci.v2.Probe object

+

Probes are not allowed for ephemeral containers.

+

stdin

+

Boolean

+

Whether this container should allocate a buffer for stdin in

+

the container runtime. If this is not set, reads from stdin in the container

+

will always result in EOF. Default is false.

+

stdinOnce

+

Boolean

+

Whether the container runtime should close the stdin channel

+

after it has been opened by a single attach. When stdin is true the stdin

+

stream will remain open across multiple attach sessions. If stdinOnce is

+

set to true, stdin is opened on container start, is empty until the first

+

client attaches to stdin, and then remains open and accepts data until the

+

client disconnects, at which time stdin is closed and remains closed until

+

the container is restarted. If this flag is false, a container processes

+

that reads from stdin will never receive an EOF. Default is false

+

targetContainerName

+

String

+

If set, the name of the container from PodSpec that this ephemeral container targets. The ephemeral container will be run in the namespaces (IPC, PID, etc) of this container. If not set then the ephemeral container uses the namespaces configured in the Pod spec.

+

The container runtime must implement support for this feature. If the runtime does not support namespace targeting then the result of setting this field is undefined.

+

terminationMessagePath

+

String

+

Optional: Path at which the file to which the container's termination message will be written is mounted into the container's filesystem. Message written is intended to be brief final status, such as an assertion failure message. Will be truncated by the node if greater than 4096 bytes. The total message length across all containers will be limited to 12kb. Defaults to /dev/termination-log. Cannot be updated.

+

terminationMessagePolicy

+

String

+

Indicate how the termination message should be populated. File will use the contents of terminationMessagePath to populate the container status message on both success and failure. FallbackToLogsOnError will use the last chunk of container log output if the termination message file is empty and the container exited with an error. The log output is limited to 2048 bytes or 80 lines, whichever is smaller. Defaults to File. Cannot be updated.

+

Possible enum values:

+
  • "FallbackToLogsOnError" will read the most recent contents of the container logs for the container status message when the container exits with an error and the terminationMessagePath has no contents.
  • "File" is the default behavior and will set the container status message to the contents of the container's terminationMessagePath when the container exits.
+

tty

+

Boolean

+

Whether this container should allocate a TTY for itself, also

+

requires 'stdin' to be true. Default is false.

+

volumeMounts

+

Array of io.cci.otc.api.pkg.apis.versioned.cci.v2.VolumeMount objects

+

Pod volumes to mount into the container's filesystem. Subpath

+

mounts are not allowed for ephemeral containers. Cannot be updated.

+

workingDir

+

String

+

Container's working directory. If not specified, the container

+

runtime's default will be used, which might be configured in the container

+

image. Cannot be updated.

+
+
+ +
+ + + + + + + + + + + + + +
Table 18 io.cci.otc.api.pkg.apis.versioned.cci.v2.HostAlias

Parameter

+

Type

+

Description

+

hostnames

+

Array of strings

+

Hostnames for the above IP address.

+

ip

+

String

+

IP address of the host file entry.

+
+
+ +
+ + + + + + + + + +
Table 19 io.cci.otc.api.pkg.apis.versioned.cci.v2.LocalObjectReference

Parameter

+

Type

+

Description

+

name

+

String

+

Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names

+
+
+ +
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Table 20 io.cci.otc.api.pkg.apis.versioned.cci.v2.Container

Parameter

+

Type

+

Description

+

args

+

Array of strings

+

Arguments to the entrypoint. The container image's CMD is used if this is not provided. Variable references $(VAR_NAME) are expanded using the container's environment. If a variable cannot be resolved, the reference in the input string will be unchanged. Double $$ are reduced to a single $, which allows for escaping the $(VAR_NAME) syntax: i.e. "$$(VAR_NAME)" will produce the string literal "$(VAR_NAME)". Escaped references will never be expanded, regardless of whether the variable exists or not. Cannot be updated. More info: https://kubernetes.io/docs/tasks/inject-data-application/define-command-argument-container/#running-a-command-in-a-shell

+

command

+

Array of strings

+

Entrypoint array. Not executed within a shell. The container image's ENTRYPOINT is used if this is not provided. Variable references $(VAR_NAME) are expanded using the container's environment. If a variable cannot be resolved, the reference in the input string will be unchanged. Double $$ are reduced to a single $, which allows for escaping the $(VAR_NAME) syntax: i.e. "$$(VAR_NAME)" will produce the string literal "$(VAR_NAME)". Escaped references will never be expanded, regardless of whether the variable exists or not. Cannot be updated. More info: https://kubernetes.io/docs/tasks/inject-data-application/define-command-argument-container/#running-a-command-in-a-shell

+

env

+

Array of io.cci.otc.api.pkg.apis.versioned.cci.v2.EnvVar objects

+

List of environment variables to set in the container. Cannot

+

be updated.

+

envFrom

+

Array of io.cci.otc.api.pkg.apis.versioned.cci.v2.EnvFromSource objects

+

List of sources to populate environment variables in the container.

+

The keys defined within a source must be a C_IDENTIFIER. All invalid keys

+

will be reported as an event when the container is starting. When a key

+

exists in multiple sources, the value associated with the last source will

+

take precedence. Values defined by an Env with a duplicate key will take

+

precedence. Cannot be updated.

+

image

+

String

+

Container image name. More info: https://kubernetes.io/docs/concepts/containers/images This field is optional to allow higher level config management to default or override container images in workload controllers like Deployments and StatefulSets.

+

lifecycle

+

io.cci.otc.api.pkg.apis.versioned.cci.v2.Lifecycle object

+

Actions that the management system should take in response to

+

container lifecycle events. Cannot be updated.

+

livenessProbe

+

io.cci.otc.api.pkg.apis.versioned.cci.v2.Probe object

+

Periodic probe of container liveness. Container will be restarted if the probe fails. Cannot be updated. More info: https://kubernetes.io/docs/concepts/workloads/pods/pod-lifecycle#container-probes

+

name

+

String

+

Name of the container specified as a DNS_LABEL. Each container

+

in a pod must have a unique name (DNS_LABEL). Cannot be updated.

+

ports

+

Array of io.cci.otc.api.pkg.apis.versioned.cci.v2.ContainerPort objects

+

List of ports to expose from the container. Not specifying a

+

port here DOES NOT prevent that port from being exposed. Any port which

+

is listening on the default "0.0.0.0" address inside a container will be

+

accessible from the network. Modifying this array with strategic merge patch

+

may corrupt the data. For more information See https://github.com/kubernetes/kubernetes/issues/108255.

+

Cannot be updated.

+

readinessProbe

+

io.cci.otc.api.pkg.apis.versioned.cci.v2.Probe object

+

Periodic probe of container service readiness. Container will be removed from service endpoints if the probe fails. Cannot be updated. More info: https://kubernetes.io/docs/concepts/workloads/pods/pod-lifecycle#container-probes

+

resources

+

io.cci.otc.api.pkg.apis.versioned.cci.v2.ResourceRequirements object

+

Compute Resources required by this container. Cannot be updated. More info: https://kubernetes.io/docs/concepts/configuration/manage-resources-containers/

+

securityContext

+

io.cci.otc.api.pkg.apis.versioned.cci.v2.SecurityContext object

+

SecurityContext defines the security options the container should be run with. If set, the fields of SecurityContext override the equivalent fields of PodSecurityContext. More info: https://kubernetes.io/docs/tasks/configure-pod-container/security-context/

+

startupProbe

+

io.cci.otc.api.pkg.apis.versioned.cci.v2.Probe object

+

StartupProbe indicates that the Pod has successfully initialized. If specified, no other probes are executed until this completes successfully. If this probe fails, the Pod will be restarted, just as if the livenessProbe failed. This can be used to provide different probe parameters at the beginning of a Pod's lifecycle, when it might take a long time to load data or warm a cache, than during steady-state operation. This cannot be updated. More info: https://kubernetes.io/docs/concepts/workloads/pods/pod-lifecycle#container-probes

+

stdin

+

Boolean

+

Whether this container should allocate a buffer for stdin in

+

the container runtime. If this is not set, reads from stdin in the container

+

will always result in EOF. Default is false.

+

stdinOnce

+

Boolean

+

Whether the container runtime should close the stdin channel

+

after it has been opened by a single attach. When stdin is true the stdin

+

stream will remain open across multiple attach sessions. If stdinOnce is

+

set to true, stdin is opened on container start, is empty until the first

+

client attaches to stdin, and then remains open and accepts data until the

+

client disconnects, at which time stdin is closed and remains closed until

+

the container is restarted. If this flag is false, a container processes

+

that reads from stdin will never receive an EOF. Default is false

+

terminationMessagePath

+

String

+

Optional: Path at which the file to which the container's termination message will be written is mounted into the container's filesystem. Message written is intended to be brief final status, such as an assertion failure message. Will be truncated by the node if greater than 4096 bytes. The total message length across all containers will be limited to 12kb. Defaults to /dev/termination-log. Cannot be updated.

+

terminationMessagePolicy

+

String

+

Indicate how the termination message should be populated. File will use the contents of terminationMessagePath to populate the container status message on both success and failure. FallbackToLogsOnError will use the last chunk of container log output if the termination message file is empty and the container exited with an error. The log output is limited to 2048 bytes or 80 lines, whichever is smaller. Defaults to File. Cannot be updated.

+

Possible enum values:

+
  • "FallbackToLogsOnError" will read the most recent contents of the container logs for the container status message when the container exits with an error and the terminationMessagePath has no contents.
  • "File" is the default behavior and will set the container status message to the contents of the container's terminationMessagePath when the container exits.
+

tty

+

Boolean

+

Whether this container should allocate a TTY for itself, also

+

requires 'stdin' to be true. Default is false.

+

volumeMounts

+

Array of io.cci.otc.api.pkg.apis.versioned.cci.v2.VolumeMount objects

+

Pod volumes to mount into the container's filesystem. Cannot

+

be updated.

+

workingDir

+

String

+

Container's working directory. If not specified, the container

+

runtime's default will be used, which might be configured in the container

+

image. Cannot be updated.

+
+
+ +
+ + + + + + + + + + + + + + + + + +
Table 21 io.cci.otc.api.pkg.apis.versioned.cci.v2.EnvVar

Parameter

+

Type

+

Description

+

name

+

String

+

Name of the environment variable. Must be a C_IDENTIFIER.

+

value

+

String

+

Variable references $(VAR_NAME) are expanded using the previously defined environment variables in the container and any service environment variables. If a variable cannot be resolved, the reference in the input string will be unchanged. Double $$ are reduced to a single $, which allows for escaping the $(VAR_NAME) syntax: i.e. "$$(VAR_NAME)" will produce the string literal "$(VAR_NAME)". Escaped references will never be expanded, regardless of whether the variable exists or not. Defaults to "".

+

valueFrom

+

io.cci.otc.api.pkg.apis.versioned.cci.v2.EnvVarSource object

+

Source for the environment variable's value. Cannot be used if

+

value is not empty.

+
+
+ +
+ + + + + + + + + + + + + + + + + + + + + +
Table 22 io.cci.otc.api.pkg.apis.versioned.cci.v2.EnvVarSource

Parameter

+

Type

+

Description

+

configMapKeyRef

+

io.cci.otc.api.pkg.apis.versioned.cci.v2.ConfigMapKeySelector object

+

Selects a key of a ConfigMap.

+

fieldRef

+

io.cci.otc.api.pkg.apis.versioned.cci.v2.ObjectFieldSelector object

+

Selects a field of the pod: supports metadata.name, metadata.namespace, metadata.labels['<KEY>'], metadata.annotations['<KEY>'], spec.nodeName, spec.serviceAccountName, status.hostIP, status.podIP, status.podIPs.

+

resourceFieldRef

+

io.cci.otc.api.pkg.apis.versioned.cci.v2.ResourceFieldSelector object

+

Selects a resource of the container: only resources limits and requests (limits.cpu, limits.memory, limits.ephemeral-storage, requests.cpu, requests.memory and requests.ephemeral-storage) are currently supported.

+

secretKeyRef

+

io.cci.otc.api.pkg.apis.versioned.cci.v2.SecretKeySelector object

+

Selects a key of a secret in the pod's namespace

+
+
+ +
+ + + + + + + + + + + + + + + + + +
Table 23 io.cci.otc.api.pkg.apis.versioned.cci.v2.ConfigMapKeySelector

Parameter

+

Type

+

Description

+

key

+

String

+

The key to select.

+

name

+

String

+

Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names

+

optional

+

Boolean

+

Specify whether the ConfigMap or its key must be defined

+
+
+ +
+ + + + + + + + + + + + + + + + + +
Table 24 io.cci.otc.api.pkg.apis.versioned.cci.v2.SecretKeySelector

Parameter

+

Type

+

Description

+

key

+

String

+

The key of the secret to select from. Must be a valid secret

+

key.

+

name

+

String

+

Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names

+

optional

+

Boolean

+

Specify whether the Secret or its key must be defined

+
+
+ +
+ + + + + + + + + + + + + + + + + +
Table 25 io.cci.otc.api.pkg.apis.versioned.cci.v2.EnvFromSource

Parameter

+

Type

+

Description

+

configMapRef

+

io.cci.otc.api.pkg.apis.versioned.cci.v2.ConfigMapEnvSource object

+

The ConfigMap to select from

+

prefix

+

String

+

An optional identifier to prepend to each key in the ConfigMap.

+

Must be a C_IDENTIFIER.

+

secretRef

+

io.cci.otc.api.pkg.apis.versioned.cci.v2.SecretEnvSource object

+

The Secret to select from

+
+
+ +
+ + + + + + + + + + + + + +
Table 26 io.cci.otc.api.pkg.apis.versioned.cci.v2.ConfigMapEnvSource

Parameter

+

Type

+

Description

+

name

+

String

+

Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names

+

optional

+

Boolean

+

Specify whether the ConfigMap must be defined

+
+
+ +
+ + + + + + + + + + + + + +
Table 27 io.cci.otc.api.pkg.apis.versioned.cci.v2.SecretEnvSource

Parameter

+

Type

+

Description

+

name

+

String

+

Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names

+

optional

+

Boolean

+

Specify whether the Secret must be defined

+
+
+ +
+ + + + + + + + + + + + + +
Table 28 io.cci.otc.api.pkg.apis.versioned.cci.v2.Lifecycle

Parameter

+

Type

+

Description

+

postStart

+

io.cci.otc.api.pkg.apis.versioned.cci.v2.LifecycleHandler object

+

PostStart is called immediately after a container is created. If the handler fails, the container is terminated and restarted according to its restart policy. Other management of the container blocks until the hook completes. More info: https://kubernetes.io/docs/concepts/containers/container-lifecycle-hooks/#container-hooks

+

preStop

+

io.cci.otc.api.pkg.apis.versioned.cci.v2.LifecycleHandler object

+

PreStop is called immediately before a container is terminated due to an API request or management event such as liveness/startup probe failure, preemption, resource contention, etc. The handler is not called if the container crashes or exits. The Pod's termination grace period countdown begins before the PreStop hook is executed. Regardless of the outcome of the handler, the container will eventually terminate within the Pod's termination grace period (unless delayed by finalizers). Other management of the container blocks until the hook completes or until the termination grace period is reached. More info: https://kubernetes.io/docs/concepts/containers/container-lifecycle-hooks/#container-hooks

+
+
+ +
+ + + + + + + + + + + + + +
Table 29 io.cci.otc.api.pkg.apis.versioned.cci.v2.LifecycleHandler

Parameter

+

Type

+

Description

+

exec

+

io.cci.otc.api.pkg.apis.versioned.cci.v2.ExecAction object

+

Exec specifies the action to take.

+

httpGet

+

io.cci.otc.api.pkg.apis.versioned.cci.v2.HTTPGetAction object

+

HTTPGet specifies the http request to perform.

+
+
+ +
+ + + + + + + + + + + + + + + + + +
Table 30 io.cci.otc.api.pkg.apis.versioned.cci.v2.ContainerPort

Parameter

+

Type

+

Description

+

containerPort

+

Integer

+

Number of port to expose on the pod's IP address. This must be

+

a valid port number, 0 < x < 65536.

+

name

+

String

+

If specified, this must be an IANA_SVC_NAME and unique within

+

the pod. Each named port in a pod must have a unique name. Name for the

+

port that can be referred to by services.

+

protocol

+

String

+

Protocol for port. Must be UDP, TCP, or SCTP. Defaults to "TCP".

+

Possible enum values:

+
  • "SCTP" is the SCTP protocol.
  • "TCP" is the TCP protocol.
  • "UDP" is the UDP protocol.
+
+
+ +
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Table 31 io.cci.otc.api.pkg.apis.versioned.cci.v2.SecurityContext

Parameter

+

Type

+

Description

+

capabilities

+

io.cci.otc.api.pkg.apis.versioned.cci.v2.Capabilities object

+

The capabilities to add/drop when running containers. Defaults

+

to the default set of capabilities granted by the container runtime. Note

+

that this field cannot be set when spec.os.name is windows.

+

procMount

+

String

+

procMount denotes the type of proc mount to use for the containers.

+

The default is DefaultProcMount which uses the container runtime defaults

+

for readonly paths and masked paths. This requires the ProcMountType feature

+

flag to be enabled. Note that this field cannot be set when spec.os.name

+

is windows.

+

readOnlyRootFilesystem

+

Boolean

+

Whether this container has a read-only root filesystem. Default

+

is false. Note that this field cannot be set when spec.os.name is windows.

+

runAsGroup

+

Long

+

The GID to run the entrypoint of the container process. Uses

+

runtime default if unset. May also be set in PodSecurityContext. If set

+

in both SecurityContext and PodSecurityContext, the value specified in SecurityContext

+

takes precedence. Note that this field cannot be set when spec.os.name is

+

windows.

+

runAsNonRoot

+

Boolean

+

Indicates that the container must run as a non-root user. If

+

true, the Kubelet will validate the image at runtime to ensure that it does

+

not run as UID 0 (root) and fail to start the container if it does. If unset

+

or false, no such validation will be performed. May also be set in PodSecurityContext. If

+

set in both SecurityContext and PodSecurityContext, the value specified

+

in SecurityContext takes precedence.

+

runAsUser

+

Long

+

The UID to run the entrypoint of the container process. Defaults

+

to user specified in image metadata if unspecified. May also be set in PodSecurityContext. If

+

set in both SecurityContext and PodSecurityContext, the value specified

+

in SecurityContext takes precedence. Note that this field cannot be set

+

when spec.os.name is windows.

+
+
+ +
+ + + + + + + + + + + + + +
Table 32 io.cci.otc.api.pkg.apis.versioned.cci.v2.Capabilities

Parameter

+

Type

+

Description

+

add

+

Array of strings

+

Added capabilities

+

drop

+

Array of strings

+

Removed capabilities

+
+
+ +
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Table 33 io.cci.otc.api.pkg.apis.versioned.cci.v2.Probe

Parameter

+

Type

+

Description

+

exec

+

io.cci.otc.api.pkg.apis.versioned.cci.v2.ExecAction object

+

Exec specifies the action to take.

+

failureThreshold

+

Integer

+

Minimum consecutive failures for the probe to be considered failed

+

after having succeeded. Defaults to 3. Minimum value is 1.

+

httpGet

+

io.cci.otc.api.pkg.apis.versioned.cci.v2.HTTPGetAction object

+

HTTPGet specifies the http request to perform.

+

initialDelaySeconds

+

Integer

+

Number of seconds after the container has started before liveness probes are initiated. More info: https://kubernetes.io/docs/concepts/workloads/pods/pod-lifecycle#container-probes

+

periodSeconds

+

Integer

+

How often (in seconds) to perform the probe. Default to 10 seconds.

+

Minimum value is 1.

+

successThreshold

+

Integer

+

Minimum consecutive successes for the probe to be considered

+

successful after having failed. Defaults to 1. Must be 1 for liveness and

+

startup. Minimum value is 1.

+

tcpSocket

+

io.cci.otc.api.pkg.apis.versioned.cci.v2.TCPSocketAction object

+

TCPSocket specifies an action involving a TCP port.

+

terminationGracePeriodSeconds

+

Long

+

Optional duration in seconds the pod needs to terminate gracefully

+

upon probe failure. The grace period is the duration in seconds after the

+

processes running in the pod are sent a termination signal and the time

+

when the processes are forcibly halted with a kill signal. Set this value

+

longer than the expected cleanup time for your process. If this value is

+

nil, the pod's terminationGracePeriodSeconds will be used. Otherwise, this

+

value overrides the value provided by the pod spec. Value must be non-negative

+

integer. The value zero indicates stop immediately via the kill signal (no

+

opportunity to shut down). This is a beta field and requires enabling ProbeTerminationGracePeriod

+

feature gate. Minimum value is 1. spec.terminationGracePeriodSeconds is

+

used if unset.

+

timeoutSeconds

+

Integer

+

Number of seconds after which the probe times out. Defaults to 1 second. Minimum value is 1. More info: https://kubernetes.io/docs/concepts/workloads/pods/pod-lifecycle#container-probes

+
+
+ +
+ + + + + + + + + +
Table 34 io.cci.otc.api.pkg.apis.versioned.cci.v2.ExecAction

Parameter

+

Type

+

Description

+

command

+

Array of strings

+

Command is the command line to execute inside the container,

+

the working directory for the command is root ('/') in the container's

+

filesystem. The command is simply exec'd, it is not run inside a shell,

+

so traditional shell instructions ('|', etc) won't work. To use a shell,

+

you need to explicitly call out to that shell. Exit status of 0 is treated

+

as live/healthy and non-zero is unhealthy.

+
+
+ +
+ + + + + + + + + + + + + + + + + + + + + + + + + +
Table 35 io.cci.otc.api.pkg.apis.versioned.cci.v2.HTTPGetAction

Parameter

+

Type

+

Description

+

host

+

String

+

Host name to connect to, defaults to the pod IP. You probably

+

want to set "Host" in httpHeaders instead.

+

httpHeaders

+

Array of io.cci.otc.api.pkg.apis.versioned.cci.v2.HTTPHeader objects

+

Custom headers to set in the request. HTTP allows repeated headers.

+

path

+

String

+

Path to access on the HTTP server.

+

port

+

String

+

Name or number of the port to access on the container. Number

+

must be in the range 1 to 65535. Name must be an IANA_SVC_NAME.

+

scheme

+

String

+

Scheme to use for connecting to the host. Defaults to HTTP.

+

Possible enum values:

+
  • "HTTP" means that the scheme used will be http://
  • "HTTPS" means that the scheme used will be https://
+
+
+ +
+ + + + + + + + + + + + + +
Table 36 io.cci.otc.api.pkg.apis.versioned.cci.v2.HTTPHeader

Parameter

+

Type

+

Description

+

name

+

String

+

The header field name

+

value

+

String

+

The header field value

+
+
+ +
+ + + + + + + + + + + + + +
Table 37 io.cci.otc.api.pkg.apis.versioned.cci.v2.TCPSocketAction

Parameter

+

Type

+

Description

+

host

+

String

+

Optional: Host name to connect to, defaults to the pod IP.

+

port

+

String

+

Number or name of the port to access on the container. Number

+

must be in the range 1 to 65535. Name must be an IANA_SVC_NAME.

+
+
+ +
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Table 38 io.cci.otc.api.pkg.apis.versioned.cci.v2.VolumeMount

Parameter

+

Type

+

Description

+

extendPathMode

+

String

+

Extend the volume path by appending the pod metadata to the path

+

according to specified pattern. which provide a way of directory isolation

+

and help prevent the writing conflict between different pods.

+

mountPath

+

String

+

Path within the container at which the volume should be mounted. Must

+

not contain ':'.

+

name

+

String

+

This must match the Name of a Volume.

+

readOnly

+

Boolean

+

Mounted read-only if true, read-write otherwise (false or unspecified).

+

Defaults to false.

+

subPath

+

String

+

Path within the volume from which the container's volume should

+

be mounted. Defaults to "" (volume's root).

+

subPathExpr

+

String

+

Expanded path within the volume from which the container's volume

+

should be mounted. Behaves similarly to SubPath but environment variable

+

references $(VAR_NAME) are expanded using the container's environment. Defaults

+

to "" (volume's root). SubPathExpr and SubPath are mutually exclusive.

+
+
+ +
+ + + + + + + + + +
Table 39 io.cci.otc.api.pkg.apis.versioned.cci.v2.PodReadinessGate

Parameter

+

Type

+

Description

+

conditionType

+

String

+

ConditionType refers to a condition in the pod's condition list

+

with matching type.

+
+
+ +
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Table 40 io.cci.otc.api.pkg.apis.versioned.cci.v2.PodSecurityContext

Parameter

+

Type

+

Description

+

fsGroup

+

Long

+

A special supplemental group that applies to all containers in a pod. Some volume types allow the Kubelet to change the ownership of that volume to be owned by the pod:

+
  1. The owning GID will be the FSGroup 2. The setgid bit is set (new files created in the volume will be owned by FSGroup) 3. The permission bits are OR'd with rw-rw----
+

If unset, the Kubelet will not modify the ownership and permissions of any volume. Note that this field cannot be set when spec.os.name is windows.

+

fsGroupChangePolicy

+

String

+

fsGroupChangePolicy defines behavior of changing ownership and permission of the volume before being exposed inside Pod. This field will only apply to volume types which support fsGroup based ownership(and permissions). It will have no effect on ephemeral volume types such as: secret, configmaps and emptydir. Valid values are "OnRootMismatch" and "Always". If not specified, "Always" is used. Note that this field cannot be set when spec.os.name is windows.

+

runAsGroup

+

Long

+

The GID to run the entrypoint of the container process. Uses

+

runtime default if unset. May also be set in SecurityContext. If set in

+

both SecurityContext and PodSecurityContext, the value specified in SecurityContext

+

takes precedence for that container. Note that this field cannot be set

+

when spec.os.name is windows.

+

runAsNonRoot

+

Boolean

+

Indicates that the container must run as a non-root user. If

+

true, the Kubelet will validate the image at runtime to ensure that it does

+

not run as UID 0 (root) and fail to start the container if it does. If unset

+

or false, no such validation will be performed. May also be set in SecurityContext. If

+

set in both SecurityContext and PodSecurityContext, the value specified

+

in SecurityContext takes precedence.

+

runAsUser

+

Long

+

The UID to run the entrypoint of the container process. Defaults

+

to user specified in image metadata if unspecified. May also be set in SecurityContext. If

+

set in both SecurityContext and PodSecurityContext, the value specified

+

in SecurityContext takes precedence for that container. Note that this field

+

cannot be set when spec.os.name is windows.

+

supplementalGroups

+

Array of longs

+

A list of groups applied to the first process run in each container,

+

in addition to the container's primary GID. If unspecified, no groups will

+

be added to any container. Note that this field cannot be set when spec.os.name

+

is windows.

+

sysctls

+

Array of io.cci.otc.api.pkg.apis.versioned.cci.v2.Sysctl objects

+

Sysctls hold a list of namespaced sysctls used for the pod. Pods

+

with unsupported sysctls (by the container runtime) might fail to launch.

+

Note that this field cannot be set when spec.os.name is windows.

+
+
+ +
+ + + + + + + + + + + + + +
Table 41 io.cci.otc.api.pkg.apis.versioned.cci.v2.Sysctl

Parameter

+

Type

+

Description

+

name

+

String

+

Name of a property to set

+

value

+

String

+

Value of a property to set

+
+
+ +
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Table 42 io.cci.otc.api.pkg.apis.versioned.cci.v2.TopologySpreadConstraint

Parameter

+

Type

+

Description

+

labelSelector

+

io.k8s.apimachinery.pkg.apis.meta.v1.LabelSelector object

+

LabelSelector is used to find matching pods. Pods that match

+

this label selector are counted to determine the number of pods in their

+

corresponding topology domain.

+

matchLabelKeys

+

Array of strings

+

MatchLabelKeys is a set of pod label keys to select the pods

+

over which spreading will be calculated. The keys are used to lookup values

+

from the incoming pod labels, those key-value labels are ANDed with labelSelector

+

to select the group of existing pods over which spreading will be calculated

+

for the incoming pod. Keys that don't exist in the incoming pod labels will

+

be ignored. A null or empty list means only match against labelSelector.

+

maxSkew

+

Integer

+

MaxSkew describes the degree to which pods may be unevenly distributed. When whenUnsatisfiable=DoNotSchedule, it is the maximum permitted difference between the number of matching pods in the target topology and the global minimum. The global minimum is the minimum number of matching pods in an eligible domain or zero if the number of eligible domains is less than MinDomains. For example, in a 3-zone cluster, MaxSkew is set to 1, and pods with the same labelSelector spread as 2/2/1: In this case, the global minimum is 1. | zone1 | zone2 | zone3 | | P P | P P | P | - if MaxSkew is 1, incoming pod can only be scheduled to zone3 to become 2/2/2; scheduling it onto zone1(zone2) would make the ActualSkew(3-1) on zone1(zone2) violate MaxSkew(1). - if MaxSkew is 2, incoming pod can be scheduled onto any zone. When whenUnsatisfiable=ScheduleAnyway, it is used to give higher precedence to topologies that satisfy it. It's a required field. Default value is 1 and 0 is not allowed.

+

minDomains

+

Integer

+

MinDomains indicates a minimum number of eligible domains. When the number of eligible domains with matching topology keys is less than minDomains, Pod Topology Spread treats "global minimum" as 0, and then the calculation of Skew is performed. And when the number of eligible domains with matching topology keys equals or greater than minDomains, this value has no effect on scheduling. As a result, when the number of eligible domains is less than minDomains, scheduler won't schedule more than maxSkew Pods to those domains. If value is nil, the constraint behaves as if MinDomains is equal to 1. Valid values are integers greater than 0. When value is not nil, WhenUnsatisfiable must be DoNotSchedule.

+

For example, in a 3-zone cluster, MaxSkew is set to 2, MinDomains is set to 5 and pods with the same labelSelector spread as 2/2/2: | zone1 | zone2 | zone3 | | P P | P P | P P | The number of domains is less than 5(MinDomains), so "global minimum" is treated as 0. In this situation, new pod with the same labelSelector cannot be scheduled, because computed skew will be 3(3 - 0) if new Pod is scheduled to any of the three zones, it will violate MaxSkew.

+

This is a beta field and requires the MinDomainsInPodTopologySpread feature gate to be enabled (enabled by default).

+

nodeAffinityPolicy

+

String

+

NodeAffinityPolicy indicates how we will treat Pod's nodeAffinity/nodeSelector when calculating pod topology spread skew. Options are: - Honor: only nodes matching nodeAffinity/nodeSelector are included in the calculations. - Ignore: nodeAffinity/nodeSelector are ignored. All nodes are included in the calculations.

+

If this value is nil, the behavior is equivalent to the Honor policy. This is a alpha-level feature enabled by the NodeInclusionPolicyInPodTopologySpread feature flag.

+

nodeTaintsPolicy

+

String

+

NodeTaintsPolicy indicates how we will treat node taints when calculating pod topology spread skew. Options are: - Honor: nodes without taints, along with tainted nodes for which the incoming pod has a toleration, are included. - Ignore: node taints are ignored. All nodes are included.

+

If this value is nil, the behavior is equivalent to the Ignore policy. This is a alpha-level feature enabled by the NodeInclusionPolicyInPodTopologySpread feature flag.

+

topologyKey

+

String

+

TopologyKey is the key of node labels. Nodes that have a label

+

with this key and identical values are considered to be in the same topology.

+

We consider each <key, value> as a "bucket", and try to put balanced number

+

of pods into each bucket. We define a domain as a particular instance of

+

a topology. Also, we define an eligible domain as a domain whose nodes meet

+

the requirements of nodeAffinityPolicy and nodeTaintsPolicy. e.g. If TopologyKey

+

is "kubernetes.io/hostname", each Node is a domain of that topology. And,

+

if TopologyKey is "topology.kubernetes.io/zone", each zone is a domain of

+

that topology. It's a required field.

+

whenUnsatisfiable

+

String

+

WhenUnsatisfiable indicates how to deal with a pod if it doesn't satisfy the spread constraint. - DoNotSchedule (default) tells the scheduler not to schedule it. - ScheduleAnyway tells the scheduler to schedule the pod in any location,

+

but giving higher precedence to topologies that would help reduce the

+

skew.

+

A constraint is considered "Unsatisfiable" for an incoming pod if and only if every possible node assignment for that pod would violate "MaxSkew" on some topology. For example, in a 3-zone cluster, MaxSkew is set to 1, and pods with the same labelSelector spread as 3/1/1: | zone1 | zone2 | zone3 | | P P P | P | P | If WhenUnsatisfiable is set to DoNotSchedule, incoming pod can only be scheduled to zone2(zone3) to become 3/2/1(3/1/2) as ActualSkew(2-1) on zone2(zone3) satisfies MaxSkew(1). In other words, the cluster can still be imbalanced, but scheduler won't make it more imbalanced. It's a required field.

+

Possible enum values:

+
  • "DoNotSchedule" instructs the scheduler not to schedule the pod when constraints are not satisfied.
  • "ScheduleAnyway" instructs the scheduler to schedule the pod even if constraints are not satisfied.
+
+
+ +
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Table 43 io.cci.otc.api.pkg.apis.versioned.cci.v2.Volume

Parameter

+

Type

+

Description

+

configMap

+

io.cci.otc.api.pkg.apis.versioned.cci.v2.ConfigMapVolumeSource object

+

configMap represents a configMap that should populate this volume

+

downwardAPI

+

io.cci.otc.api.pkg.apis.versioned.cci.v2.DownwardAPIVolumeSource object

+

downwardAPI represents downward API about the pod that should

+

populate this volume

+

emptyDir

+

io.cci.otc.api.pkg.apis.versioned.cci.v2.EmptyDirVolumeSource object

+

emptyDir represents a temporary directory that shares a pod's lifetime. More info: https://kubernetes.io/docs/concepts/storage/volumes#emptydir

+

ephemeral

+

io.cci.otc.api.pkg.apis.versioned.cci.v2.EphemeralVolumeSource object

+

ephemeral represents a volume that is handled by a cluster storage driver. The volume's lifecycle is tied to the pod that defines it - it will be created before the pod starts, and deleted when the pod is removed.

+

Use this if: a) the volume is only needed while the pod runs, b) features of normal volumes like restoring from snapshot or capacity

+

tracking are needed,

+

c) the storage driver is specified through a storage class, and d) the storage driver supports dynamic volume provisioning through

+

a PersistentVolumeClaim (see EphemeralVolumeSource for more

+

information on the connection between this volume type

+

and PersistentVolumeClaim).

+

Use PersistentVolumeClaim or one of the vendor-specific APIs for volumes that persist for longer than the lifecycle of an individual pod.

+

Use CSI for light-weight local ephemeral volumes if the CSI driver is meant to be used that way - see the documentation of the driver for more information.

+

A pod can use both types of ephemeral volumes and persistent volumes at the same time.

+

name

+

String

+

name of the volume. Must be a DNS_LABEL and unique within the pod. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names

+

nfs

+

io.cci.otc.api.pkg.apis.versioned.cci.v2.NFSVolumeSource object

+

nfs represents an NFS mount on the host that shares a pod's lifetime More info: https://kubernetes.io/docs/concepts/storage/volumes#nfs

+

persistentVolumeClaim

+

io.cci.otc.api.pkg.apis.versioned.cci.v2.PersistentVolumeClaimVolumeSource object

+

persistentVolumeClaimVolumeSource represents a reference to a PersistentVolumeClaim in the same namespace. More info: https://kubernetes.io/docs/concepts/storage/persistent-volumes#persistentvolumeclaims

+

projected

+

io.cci.otc.api.pkg.apis.versioned.cci.v2.ProjectedVolumeSource object

+

projected items for all in one resources secrets, configmaps,

+

and downward API

+

secret

+

io.cci.otc.api.pkg.apis.versioned.cci.v2.SecretVolumeSource object

+

secret represents a secret that should populate this volume. More info: https://kubernetes.io/docs/concepts/storage/volumes#secret

+
+
+ +
+ + + + + + + + + + + + + + + + + + + + + +
Table 44 io.cci.otc.api.pkg.apis.versioned.cci.v2.ConfigMapVolumeSource

Parameter

+

Type

+

Description

+

defaultMode

+

Integer

+

defaultMode is optional: mode bits used to set permissions on created files by default. Must be an octal value between 0000 and 0777 or a decimal value between 0 and 511. YAML accepts both octal and decimal values, JSON requires decimal values for mode bits. Defaults to 0644. Directories within the path are not affected by this setting. This might be in conflict with other options that affect the file mode, like fsGroup, and the result can be other mode bits set.

+

items

+

Array of io.cci.otc.api.pkg.apis.versioned.cci.v2.KeyToPath objects

+

items if unspecified, each key-value pair in the Data field of

+

the referenced ConfigMap will be projected into the volume as a file whose

+

name is the key and content is the value. If specified, the listed keys

+

will be projected into the specified paths, and unlisted keys will not be

+

present. If a key is specified which is not present in the ConfigMap, the

+

volume setup will error unless it is marked optional. Paths must be relative

+

and may not contain the '..' path or start with '..'.

+

name

+

String

+

Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names

+

optional

+

Boolean

+

optional specify whether the ConfigMap or its keys must be defined

+
+
+ +
+ + + + + + + + + + + + + +
Table 45 io.cci.otc.api.pkg.apis.versioned.cci.v2.DownwardAPIVolumeSource

Parameter

+

Type

+

Description

+

defaultMode

+

Integer

+

Optional: mode bits to use on created files by default. Must be a Optional: mode bits used to set permissions on created files by default. Must be an octal value between 0000 and 0777 or a decimal value between 0 and 511. YAML accepts both octal and decimal values, JSON requires decimal values for mode bits. Defaults to 0644. Directories within the path are not affected by this setting. This might be in conflict with other options that affect the file mode, like fsGroup, and the result can be other mode bits set.

+

items

+

Array of io.cci.otc.api.pkg.apis.versioned.cci.v2.DownwardAPIVolumeFile objects

+

Items is a list of downward API volume file

+
+
+ +
+ + + + + + + + + + + + + +
Table 46 io.cci.otc.api.pkg.apis.versioned.cci.v2.EmptyDirVolumeSource

Parameter

+

Type

+

Description

+

medium

+

String

+

medium represents what type of storage medium should back this directory. The default is "" which means to use the node's default medium. Must be an empty string (default) or Memory. More info: https://kubernetes.io/docs/concepts/storage/volumes#emptydir

+

sizeLimit

+

String

+

sizeLimit is the total amount of local storage required for this EmptyDir volume. The size limit is also applicable for memory medium. The maximum usage on memory medium EmptyDir would be the minimum value between the SizeLimit specified here and the sum of memory limits of all containers in a pod. The default is nil which means that the limit is undefined. More info: http://kubernetes.io/docs/user-guide/volumes#emptydir

+
+
+ +
+ + + + + + + + + +
Table 47 io.cci.otc.api.pkg.apis.versioned.cci.v2.EphemeralVolumeSource

Parameter

+

Type

+

Description

+

volumeClaimTemplate

+

io.cci.otc.api.pkg.apis.versioned.cci.v2.PersistentVolumeClaimTemplate object

+

Will be used to create a stand-alone PVC to provision the volume. The pod in which this EphemeralVolumeSource is embedded will be the owner of the PVC, i.e. the PVC will be deleted together with the pod. The name of the PVC will be <pod name>-<volume name> where <volume name> is the name from the PodSpec.Volumes array entry. Pod validation will reject the pod if the concatenated name is not valid for a PVC (for example, too long).

+

An existing PVC with that name that is not owned by the pod will not be used for the pod to avoid using an unrelated volume by mistake. Starting the pod is then blocked until the unrelated PVC is removed. If such a pre-created PVC is meant to be used by the pod, the PVC has to updated with an owner reference to the pod once the pod exists. Normally this should not be necessary, but it may be useful when manually reconstructing a broken cluster.

+

This field is read-only and no changes will be made by Kubernetes to the PVC after it has been created.

+

Required, must not be nil.

+
+
+ +
+ + + + + + + + + + + + + +
Table 48 io.cci.otc.api.pkg.apis.versioned.cci.v2.PersistentVolumeClaimTemplate

Parameter

+

Type

+

Description

+

metadata

+

io.k8s.apimachinery.pkg.apis.meta.v1.ObjectMeta object

+

May contain labels and annotations that will be copied into the

+

PVC when creating it. No other fields are allowed and will be rejected during

+

validation.

+

spec

+

io.cci.otc.api.pkg.apis.versioned.cci.v2.PersistentVolumeClaimSpec object

+

The specification for the PersistentVolumeClaim. The entire content

+

is copied unchanged into the PVC that gets created from this template. The

+

same fields as in a PersistentVolumeClaim are also valid here.

+
+
+ +
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Table 49 io.k8s.apimachinery.pkg.apis.meta.v1.ObjectMeta

Parameter

+

Type

+

Description

+

annotations

+

Map<String,String>

+

Annotations is an unstructured key value map stored with a resource that may be set by external tools to store and retrieve arbitrary metadata. They are not queryable and should be preserved when modifying objects. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/annotations/

+

clusterName

+

String

+

The name of the cluster which the object belongs to. This is

+

used to distinguish resources with same name and namespace in different

+

clusters. This field is not set anywhere right now and apiserver is going

+

to ignore it if set in create or update request.

+

creationTimestamp

+

String

+

CreationTimestamp is a timestamp representing the server time when this object was created. It is not guaranteed to be set in happens-before order across separate operations. Clients may not set this value. It is represented in RFC3339 form and is in UTC.

+

Populated by the system. Read-only. Null for lists. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata

+

deletionGracePeriodSeconds

+

Long

+

Number of seconds allowed for this object to gracefully terminate

+

before it will be removed from the system. Only set when deletionTimestamp

+

is also set. May only be shortened. Read-only.

+

deletionTimestamp

+

String

+

DeletionTimestamp is RFC 3339 date and time at which this resource will be deleted. This field is set by the server when a graceful deletion is requested by the user, and is not directly settable by a client. The resource is expected to be deleted (no longer visible from resource lists, and not reachable by name) after the time in this field, once the finalizers list is empty. As long as the finalizers list contains items, deletion is blocked. Once the deletionTimestamp is set, this value may not be unset or be set further into the future, although it may be shortened or the resource may be deleted prior to this time. For example, a user may request that a pod is deleted in 30 seconds. The Kubelet will react by sending a graceful termination signal to the containers in the pod. After that 30 seconds, the Kubelet will send a hard termination signal (SIGKILL) to the container and after cleanup, remove the pod from the API. In the presence of network partitions, this object may still exist after this timestamp, until an administrator or automated process can determine the resource is fully terminated. If not set, graceful deletion of the object has not been requested.

+

Populated by the system when a graceful deletion is requested. Read-only. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata

+

enable

+

Boolean

+

Enable identifies whether the resource is available

+

finalizers

+

Array of strings

+

Must be empty before the object is deleted from the registry.

+

Each entry is an identifier for the responsible component that will remove

+

the entry from the list. If the deletionTimestamp of the object is non-nil,

+

entries in this list can only be removed. Finalizers may be processed and

+

removed in any order. Order is NOT enforced because it introduces significant

+

risk of stuck finalizers. finalizers is a shared field, any actor with permission

+

can reorder it. If the finalizer list is processed in order, then this can

+

lead to a situation in which the component responsible for the first finalizer

+

in the list is waiting for a signal (field value, external system, or other)

+

produced by a component responsible for a finalizer later in the list, resulting

+

in a deadlock. Without enforced ordering finalizers are free to order amongst

+

themselves and are not vulnerable to ordering changes in the list.

+

generateName

+

String

+

GenerateName is an optional prefix, used by the server, to generate a unique name ONLY IF the Name field has not been provided. If this field is used, the name returned to the client will be different than the name passed. This value will also be combined with a unique suffix. The provided value has the same validation rules as the Name field, and may be truncated by the length of the suffix required to make the value unique on the server.

+

If this field is specified and the generated name exists, the server will NOT return a 409 - instead, it will either return 201 Created or 500 with Reason ServerTimeout indicating a unique name could not be found in the time allotted, and the client should retry (optionally after the time indicated in the Retry-After header).

+

Applied only if Name is not specified. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#idempotency

+

generation

+

Long

+

A sequence number representing a specific generation of the desired

+

state. Populated by the system. Read-only.

+

labels

+

Map<String,String>

+

Map of string keys and values that can be used to organize and categorize (scope and select) objects. May match selectors of replication controllers and services. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/labels/

+

managedFields

+

Array of io.k8s.apimachinery.pkg.apis.meta.v1.ManagedFieldsEntry objects

+

ManagedFields maps workflow-id and version to the set of fields

+

that are managed by that workflow. This is mostly for internal housekeeping,

+

and users typically shouldn't need to set or understand this field. A workflow

+

can be the user's name, a controller's name, or the name of a specific apply

+

path like "ci-cd". The set of fields is always in the version that the workflow

+

used when modifying the object.

+

name

+

String

+

Name must be unique within a namespace. Is required when creating resources, although some resources may allow a client to request the generation of an appropriate name automatically. Name is primarily intended for creation idempotence and configuration definition. Cannot be updated. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names

+

namespace

+

String

+

Namespace defines the space within which each name must be unique. An empty namespace is equivalent to the "default" namespace, but "default" is the canonical representation. Not all objects are required to be scoped to a namespace - the value of this field for those objects will be empty.

+

Must be a DNS_LABEL. Cannot be updated. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/namespaces/

+

ownerReferences

+

Array of io.k8s.apimachinery.pkg.apis.meta.v1.OwnerReference objects

+

List of objects depended by this object. If ALL objects in the

+

list have been deleted, this object will be garbage collected. If this object

+

is managed by a controller, then an entry in this list will point to this

+

controller, with the controller field set to true. There cannot be more

+

than one managing controller.

+

resourceVersion

+

String

+

An opaque value that represents the internal version of this object that can be used by clients to determine when objects have changed. May be used for optimistic concurrency, change detection, and the watch operation on a resource or set of resources. Clients must treat these values as opaque and passed unmodified back to the server. They may only be valid for a particular resource or set of resources.

+

Populated by the system. Read-only. Value must be treated as opaque by clients and . More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#concurrency-control-and-consistency

+

selfLink

+

String

+

SelfLink is a URL representing this object. Populated by the system. Read-only.

+

DEPRECATED Kubernetes will stop propagating this field in 1.20 release and the field is planned to be removed in 1.21 release.

+

uid

+

String

+

UID is the unique in time and space value for this object. It is typically generated by the server on successful creation of a resource and is not allowed to change on PUT operations.

+

Populated by the system. Read-only. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#uids

+
+
+ +
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Table 50 io.k8s.apimachinery.pkg.apis.meta.v1.ManagedFieldsEntry

Parameter

+

Type

+

Description

+

apiVersion

+

String

+

APIVersion defines the version of this resource that this field

+

set applies to. The format is "group/version" just like the top-level APIVersion

+

field. It is necessary to track the version of a field set because it cannot

+

be automatically converted.

+

fieldsType

+

String

+

FieldsType is the discriminator for the different fields format and version. There is currently only one possible value: "FieldsV1"

+

fieldsV1

+

Object

+

FieldsV1 holds the first JSON version format as described in

+

the "FieldsV1" type.

+

manager

+

String

+

Manager is an identifier of the workflow managing these fields.

+

operation

+

String

+

Operation is the type of operation which lead to this ManagedFieldsEntry

+

being created. The only valid values for this field are 'Apply' and 'Update'.

+

time

+

String

+

Time is timestamp of when these fields were set. It should always

+

be empty if Operation is 'Apply'

+
+
+ +
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Table 51 io.k8s.apimachinery.pkg.apis.meta.v1.OwnerReference

Parameter

+

Type

+

Description

+

apiVersion

+

String

+

API version of the referent.

+

blockOwnerDeletion

+

Boolean

+

If true, AND if the owner has the "foregroundDeletion" finalizer,

+

then the owner cannot be deleted from the key-value store until this reference

+

is removed. Defaults to false. To set this field, a user needs "delete"

+

permission of the owner, otherwise 422 (Unprocessable Entity) will be returned.

+

controller

+

Boolean

+

If true, this reference points to the managing controller.

+

kind

+

String

+

Kind of the referent. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds

+

name

+

String

+

Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names

+

uid

+

String

+

UID of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#uids

+
+
+ +
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Table 52 io.cci.otc.api.pkg.apis.versioned.cci.v2.PersistentVolumeClaimSpec

Parameter

+

Type

+

Description

+

accessModes

+

Array of strings

+

accessModes contains the desired access modes the volume should have. More info: https://kubernetes.io/docs/concepts/storage/persistent-volumes#access-modes-1

+

dataSource

+

io.cci.otc.api.pkg.apis.versioned.cci.v2.TypedLocalObjectReference object

+

dataSource field can be used to specify either: * An existing VolumeSnapshot object (snapshot.storage.k8s.io/VolumeSnapshot) * An existing PVC (PersistentVolumeClaim) If the provisioner or an external controller can support the specified data source, it will create a new volume based on the contents of the specified data source. If the AnyVolumeDataSource feature gate is enabled, this field will always have the same contents as the DataSourceRef field.

+

dataSourceRef

+

io.cci.otc.api.pkg.apis.versioned.cci.v2.TypedLocalObjectReference object

+

dataSourceRef specifies the object from which to populate the volume with data, if a non-empty volume is desired. This may be any local object from a non-empty API group (non core object) or a PersistentVolumeClaim object. When this field is specified, volume binding will only succeed if the type of the specified object matches some installed volume populator or dynamic provisioner. This field will replace the functionality of the DataSource field and as such if both fields are non-empty, they must have the same value. For backwards compatibility, both fields (DataSource and DataSourceRef) will be set to the same value automatically if one of them is empty and the other is non-empty. There are two important differences between DataSource and DataSourceRef: * While DataSource only allows two specific types of objects, DataSourceRef

+

allows any non-core object, as well as PersistentVolumeClaim objects.

+
  • While DataSource ignores disallowed values (dropping them), DataSourceRef

    preserves all values, and generates an error if a disallowed value is

    +

    specified.

    +

    (Beta) Using this field requires the AnyVolumeDataSource feature gate to be enabled.

    +
+

resources

+

io.cci.otc.api.pkg.apis.versioned.cci.v2.ResourceRequirements object

+

resources represents the minimum resources the volume should have. If RecoverVolumeExpansionFailure feature is enabled users are allowed to specify resource requirements that are lower than previous value but must still be higher than capacity recorded in the status field of the claim. More info: https://kubernetes.io/docs/concepts/storage/persistent-volumes#resources

+

selector

+

io.k8s.apimachinery.pkg.apis.meta.v1.LabelSelector object

+

selector is a label query over volumes to consider for binding.

+

storageClassName

+

String

+

storageClassName is the name of the StorageClass required by the claim. More info: https://kubernetes.io/docs/concepts/storage/persistent-volumes#class-1

+

volumeMode

+

String

+

volumeMode defines what type of volume is required by the claim.

+

Value of Filesystem is implied when not included in claim spec.

+

volumeName

+

String

+

volumeName is the binding reference to the PersistentVolume backing

+

this claim.

+
+
+ +
+ + + + + + + + + + + + + + + + + +
Table 53 io.cci.otc.api.pkg.apis.versioned.cci.v2.TypedLocalObjectReference

Parameter

+

Type

+

Description

+

apiGroup

+

String

+

APIGroup is the group for the resource being referenced. If APIGroup

+

is not specified, the specified Kind must be in the core API group. For

+

any other third-party types, APIGroup is required.

+

kind

+

String

+

Kind is the type of resource being referenced

+

name

+

String

+

Name is the name of resource being referenced

+
+
+ +
+ + + + + + + + + + + + + +
Table 54 io.cci.otc.api.pkg.apis.versioned.cci.v2.ResourceRequirements

Parameter

+

Type

+

Description

+

limits

+

Map<String,String>

+

Limits describes the maximum amount of compute resources allowed. More info: https://kubernetes.io/docs/concepts/configuration/manage-resources-containers/

+

requests

+

Map<String,String>

+

Requests describes the minimum amount of compute resources required. If Requests is omitted for a container, it defaults to Limits if that is explicitly specified, otherwise to an implementation-defined value. More info: https://kubernetes.io/docs/concepts/configuration/manage-resources-containers/

+
+
+ +
+ + + + + + + + + +
Table 55 io.k8s.apimachinery.pkg.api.resource.Quantity

Parameter

+

Type

+

Description

+

-

+

String

+

Quantity is a fixed-point representation of a number. It provides convenient marshaling/unmarshaling in JSON and YAML, in addition to String() and AsInt64() accessors.

+

The serialization format is:

+

[/topic/body/section/table/tgroup/tbody/row/entry/p/br {""}) (br] ::= [/topic/body/section/table/tgroup/tbody/row/entry/p/br {""}) (br][/topic/body/section/table/tgroup/tbody/row/entry/p/br {""}) (br]

+

(Note that [/topic/body/section/table/tgroup/tbody/row/entry/p/br {""}) (br] may be empty, from the "" case in [/topic/body/section/table/tgroup/tbody/row/entry/p/br {""}) (br].)

+

[/topic/body/section/table/tgroup/tbody/row/entry/p/br {""}) (br] ::= 0 | 1 | ... | 9 [/topic/body/section/table/tgroup/tbody/row/entry/p/br {""}) (br] ::= [/topic/body/section/table/tgroup/tbody/row/entry/p/br {""}) (br] | [/topic/body/section/table/tgroup/tbody/row/entry/p/br {""}) (br][/topic/body/section/table/tgroup/tbody/row/entry/p/br {""}) (br] [/topic/body/section/table/tgroup/tbody/row/entry/p/br {""}) (br] ::= [/topic/body/section/table/tgroup/tbody/row/entry/p/br {""}) (br] | [/topic/body/section/table/tgroup/tbody/row/entry/p/br {""}) (br].[/topic/body/section/table/tgroup/tbody/row/entry/p/br {""}) (br] | [/topic/body/section/table/tgroup/tbody/row/entry/p/br {""}) (br]. | .[/topic/body/section/table/tgroup/tbody/row/entry/p/br {""}) (br] [/topic/body/section/table/tgroup/tbody/row/entry/p/br {""}) (br] ::= "+" | "-" [/topic/body/section/table/tgroup/tbody/row/entry/p/br {""}) (br] ::= [/topic/body/section/table/tgroup/tbody/row/entry/p/br {""}) (br] | [/topic/body/section/table/tgroup/tbody/row/entry/p/br {""}) (br][/topic/body/section/table/tgroup/tbody/row/entry/p/br {""}) (br] [/topic/body/section/table/tgroup/tbody/row/entry/p/br {""}) (br] ::= [/topic/body/section/table/tgroup/tbody/row/entry/p/br {""}) (br] | [/topic/body/section/table/tgroup/tbody/row/entry/p/br {""}) (br] | [/topic/body/section/table/tgroup/tbody/row/entry/p/br {""}) (br] [/topic/body/section/table/tgroup/tbody/row/entry/p/br {""}) (br] ::= Ki | Mi | Gi | Ti | Pi | Ei

+

(International System of units; See: http://physics.nist.gov/cuu/Units/binary.html)

+

[/topic/body/section/table/tgroup/tbody/row/entry/p/br {""}) (br] ::= m | "" | k | M | G | T | P | E

+

(Note that 1024 = 1Ki but 1000 = 1k; I didn't choose the capitalization.)

+

[/topic/body/section/table/tgroup/tbody/row/entry/p/br {""}) (br] ::= "e" [/topic/body/section/table/tgroup/tbody/row/entry/p/br {""}) (br] | "E" [/topic/body/section/table/tgroup/tbody/row/entry/p/br {""}) (br]

+

No matter which of the three exponent forms is used, no quantity may represent a number greater than 2^63-1 in magnitude, nor may it have more than 3 decimal places. Numbers larger or more precise will be capped or rounded up. (E.g.: 0.1m will rounded up to 1m.) This may be extended in the future if we require larger or smaller quantities.

+

When a Quantity is parsed from a string, it will remember the type of suffix it had, and will use the same type again when it is serialized.

+

Before serializing, Quantity will be put in "canonical form". This means that Exponent/suffix will be adjusted up or down (with a corresponding increase or decrease in Mantissa) such that:

+

a. No precision is lost

+

b. No fractional digits will be emitted

+

c. The exponent (or suffix) is as large as possible.

+

The sign will be omitted unless the number is negative.

+

Examples:

+

1.5 will be serialized as "1500m"

+

1.5Gi will be serialized as "1536Mi"

+

Note that the quantity will NEVER be internally represented by a floating point number. That is the whole point of this exercise.

+

Non-canonical values will still parse as long as they are well formed, but will be re-emitted in their canonical form. (So always use canonical form, or don't diff.)

+

This format is intended to make it difficult to use these numbers without writing some sort of special handling code in the hopes that that will cause implementors to also use a fixed point implementation.

+
+
+ +
+ + + + + + + + + + + + + +
Table 56 io.k8s.apimachinery.pkg.apis.meta.v1.LabelSelector

Parameter

+

Type

+

Description

+

matchExpressions

+

Array of io.k8s.apimachinery.pkg.apis.meta.v1.LabelSelectorRequirement objects

+

matchExpressions is a list of label selector requirements. The

+

requirements are ANDed.

+

matchLabels

+

Map<String,String>

+

matchLabels is a map of {key,value} pairs. A single {key,value}

+

in the matchLabels map is equivalent to an element of matchExpressions,

+

whose key field is "key", the operator is "In", and the values array contains

+

only "value". The requirements are ANDed.

+
+
+ +
+ + + + + + + + + + + + + + + + + +
Table 57 io.k8s.apimachinery.pkg.apis.meta.v1.LabelSelectorRequirement

Parameter

+

Type

+

Description

+

key

+

String

+

key is the label key that the selector applies to.

+

operator

+

String

+

operator represents a key's relationship to a set of values.

+

Valid operators are In, NotIn, Exists and DoesNotExist.

+

values

+

Array of strings

+

values is an array of string values. If the operator is In or

+

NotIn, the values array must be non-empty. If the operator is Exists or

+

DoesNotExist, the values array must be empty. This array is replaced during

+

a strategic merge patch.

+
+
+ +
+ + + + + + + + + + + + + + + + + +
Table 58 io.cci.otc.api.pkg.apis.versioned.cci.v2.NFSVolumeSource

Parameter

+

Type

+

Description

+

path

+

String

+

path that is exported by the NFS server. More info: https://kubernetes.io/docs/concepts/storage/volumes#nfs

+

readOnly

+

Boolean

+

readOnly here will force the NFS export to be mounted with read-only permissions. Defaults to false. More info: https://kubernetes.io/docs/concepts/storage/volumes#nfs

+

server

+

String

+

server is the hostname or IP address of the NFS server. More info: https://kubernetes.io/docs/concepts/storage/volumes#nfs

+
+
+ +
+ + + + + + + + + + + + + +
Table 59 io.cci.otc.api.pkg.apis.versioned.cci.v2.PersistentVolumeClaimVolumeSource

Parameter

+

Type

+

Description

+

claimName

+

String

+

claimName is the name of a PersistentVolumeClaim in the same namespace as the pod using this volume. More info: https://kubernetes.io/docs/concepts/storage/persistent-volumes#persistentvolumeclaims

+

readOnly

+

Boolean

+

readOnly Will force the ReadOnly setting in VolumeMounts. Default

+

false.

+
+
+ +
+ + + + + + + + + + + + + +
Table 60 io.cci.otc.api.pkg.apis.versioned.cci.v2.ProjectedVolumeSource

Parameter

+

Type

+

Description

+

defaultMode

+

Integer

+

defaultMode are the mode bits used to set permissions on created

+

files by default. Must be an octal value between 0000 and 0777 or a decimal

+

value between 0 and 511. YAML accepts both octal and decimal values, JSON

+

requires decimal values for mode bits. Directories within the path are not

+

affected by this setting. This might be in conflict with other options that

+

affect the file mode, like fsGroup, and the result can be other mode bits

+

set.

+

sources

+

Array of io.cci.otc.api.pkg.apis.versioned.cci.v2.VolumeProjection objects

+

sources is the list of volume projections

+
+
+ +
+ + + + + + + + + + + + + + + + + +
Table 61 io.cci.otc.api.pkg.apis.versioned.cci.v2.VolumeProjection

Parameter

+

Type

+

Description

+

configMap

+

io.cci.otc.api.pkg.apis.versioned.cci.v2.ConfigMapProjection object

+

configMap information about the configMap data to project

+

downwardAPI

+

io.cci.otc.api.pkg.apis.versioned.cci.v2.DownwardAPIProjection object

+

downwardAPI information about the downwardAPI data to project

+

secret

+

io.cci.otc.api.pkg.apis.versioned.cci.v2.SecretProjection object

+

secret information about the secret data to project

+
+
+ +
+ + + + + + + + + + + + + + + + + +
Table 62 io.cci.otc.api.pkg.apis.versioned.cci.v2.ConfigMapProjection

Parameter

+

Type

+

Description

+

items

+

Array of io.cci.otc.api.pkg.apis.versioned.cci.v2.KeyToPath objects

+

items if unspecified, each key-value pair in the Data field of

+

the referenced ConfigMap will be projected into the volume as a file whose

+

name is the key and content is the value. If specified, the listed keys

+

will be projected into the specified paths, and unlisted keys will not be

+

present. If a key is specified which is not present in the ConfigMap, the

+

volume setup will error unless it is marked optional. Paths must be relative

+

and may not contain the '..' path or start with '..'.

+

name

+

String

+

Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names

+

optional

+

Boolean

+

optional specify whether the ConfigMap or its keys must be defined

+
+
+ +
+ + + + + + + + + +
Table 63 io.cci.otc.api.pkg.apis.versioned.cci.v2.DownwardAPIProjection

Parameter

+

Type

+

Description

+

items

+

Array of io.cci.otc.api.pkg.apis.versioned.cci.v2.DownwardAPIVolumeFile objects

+

Items is a list of DownwardAPIVolume file

+
+
+ +
+ + + + + + + + + + + + + + + + + + + + + +
Table 64 io.cci.otc.api.pkg.apis.versioned.cci.v2.DownwardAPIVolumeFile

Parameter

+

Type

+

Description

+

fieldRef

+

io.cci.otc.api.pkg.apis.versioned.cci.v2.ObjectFieldSelector object

+

Required: Selects a field of the pod: only annotations, labels, name and namespace are supported.

+

mode

+

Integer

+

Optional: mode bits used to set permissions on this file, must be an octal value between 0000 and 0777 or a decimal value between 0 and 511. YAML accepts both octal and decimal values, JSON requires decimal values for mode bits. If not specified, the volume defaultMode will be used. This might be in conflict with other options that affect the file mode, like fsGroup, and the result can be other mode bits set.

+

path

+

String

+

Required: Path is the relative path name of the file to be created. Must not be absolute or contain the '..' path. Must be utf-8 encoded. The first item of the relative path must not start with '..'

+

resourceFieldRef

+

io.cci.otc.api.pkg.apis.versioned.cci.v2.ResourceFieldSelector object

+

Selects a resource of the container: only resources limits and requests (limits.cpu, limits.memory, requests.cpu and requests.memory) are currently supported.

+
+
+ +
+ + + + + + + + + + + + + +
Table 65 io.cci.otc.api.pkg.apis.versioned.cci.v2.ObjectFieldSelector

Parameter

+

Type

+

Description

+

apiVersion

+

String

+

Version of the schema the FieldPath is written in terms of, defaults

+

to "v1".

+

fieldPath

+

String

+

Path of the field to select in the specified API version.

+
+
+ +
+ + + + + + + + + + + + + + + + + +
Table 66 io.cci.otc.api.pkg.apis.versioned.cci.v2.ResourceFieldSelector

Parameter

+

Type

+

Description

+

containerName

+

String

+

Container name: required for volumes, optional for env vars

+

divisor

+

String

+

Specifies the output format of the exposed resources, defaults

+

to "1"

+

resource

+

String

+

Required: resource to select

+
+
+ +
+ + + + + + + + + + + + + + + + + +
Table 67 io.cci.otc.api.pkg.apis.versioned.cci.v2.SecretProjection

Parameter

+

Type

+

Description

+

items

+

Array of io.cci.otc.api.pkg.apis.versioned.cci.v2.KeyToPath objects

+

items if unspecified, each key-value pair in the Data field of

+

the referenced Secret will be projected into the volume as a file whose

+

name is the key and content is the value. If specified, the listed keys

+

will be projected into the specified paths, and unlisted keys will not be

+

present. If a key is specified which is not present in the Secret, the volume

+

setup will error unless it is marked optional. Paths must be relative and

+

may not contain the '..' path or start with '..'.

+

name

+

String

+

Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names

+

optional

+

Boolean

+

optional field specify whether the Secret or its key must be

+

defined

+
+
+ +
+ + + + + + + + + + + + + + + + + + + + + +
Table 68 io.cci.otc.api.pkg.apis.versioned.cci.v2.SecretVolumeSource

Parameter

+

Type

+

Description

+

defaultMode

+

Integer

+

defaultMode is Optional: mode bits used to set permissions on created files by default. Must be an octal value between 0000 and 0777 or a decimal value between 0 and 511. YAML accepts both octal and decimal values, JSON requires decimal values for mode bits. Defaults to 0644. Directories within the path are not affected by this setting. This might be in conflict with other options that affect the file mode, like fsGroup, and the result can be other mode bits set.

+

items

+

Array of io.cci.otc.api.pkg.apis.versioned.cci.v2.KeyToPath objects

+

items If unspecified, each key-value pair in the Data field of

+

the referenced Secret will be projected into the volume as a file whose

+

name is the key and content is the value. If specified, the listed keys

+

will be projected into the specified paths, and unlisted keys will not be

+

present. If a key is specified which is not present in the Secret, the volume

+

setup will error unless it is marked optional. Paths must be relative and

+

may not contain the '..' path or start with '..'.

+

optional

+

Boolean

+

optional field specify whether the Secret or its keys must be

+

defined

+

secretName

+

String

+

secretName is the name of the secret in the pod's namespace to use. More info: https://kubernetes.io/docs/concepts/storage/volumes#secret

+
+
+ +
+ + + + + + + + + + + + + + + + + +
Table 69 io.cci.otc.api.pkg.apis.versioned.cci.v2.KeyToPath

Parameter

+

Type

+

Description

+

key

+

String

+

key is the key to project.

+

mode

+

Integer

+

mode is Optional: mode bits used to set permissions on this file. Must be an octal value between 0000 and 0777 or a decimal value between 0 and 511. YAML accepts both octal and decimal values, JSON requires decimal values for mode bits. If not specified, the volume defaultMode will be used. This might be in conflict with other options that affect the file mode, like fsGroup, and the result can be other mode bits set.

+

path

+

String

+

path is the relative path of the file to map the key to. May

+

not be an absolute path. May not contain the path element '..'. May not

+

start with the string '..'.

+
+
+ +
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Table 70 io.cci.otc.api.pkg.apis.versioned.cci.v2.PodStatus

Parameter

+

Type

+

Description

+

conditions

+

Array of io.cci.otc.api.pkg.apis.versioned.cci.v2.PodCondition objects

+

Current service state of pod. More info: https://kubernetes.io/docs/concepts/workloads/pods/pod-lifecycle#pod-conditions

+

containerStatuses

+

Array of io.cci.otc.api.pkg.apis.versioned.cci.v2.ContainerStatus objects

+

The list has one entry per container in the manifest. More info: https://kubernetes.io/docs/concepts/workloads/pods/pod-lifecycle#pod-and-container-status

+

ephemeralContainerStatuses

+

Array of io.cci.otc.api.pkg.apis.versioned.cci.v2.ContainerStatus objects

+

Status for any ephemeral containers that have run in this pod.

+

hostIP

+

String

+

IP address of the host to which the pod is assigned. Empty if

+

not yet scheduled.

+

initContainerStatuses

+

Array of io.cci.otc.api.pkg.apis.versioned.cci.v2.ContainerStatus objects

+

The list has one entry per init container in the manifest. The most recent successful init container will have ready = true, the most recently started container will have startTime set. More info: https://kubernetes.io/docs/concepts/workloads/pods/pod-lifecycle#pod-and-container-status

+

message

+

String

+

A human readable message indicating details about why the pod

+

is in this condition.

+

nominatedNodeName

+

String

+

nominatedNodeName is set only when this pod preempts other pods

+

on the node, but it cannot be scheduled right away as preemption victims

+

receive their graceful termination periods. This field does not guarantee

+

that the pod will be scheduled on this node. Scheduler may decide to place

+

the pod elsewhere if other nodes become available sooner. Scheduler may

+

also decide to give the resources on this node to a higher priority pod

+

that is created after preemption. As a result, this field may be different

+

than PodSpec.nodeName when the pod is scheduled.

+

phase

+

String

+

The phase of a Pod is a simple, high-level summary of where the Pod is in its lifecycle. The conditions array, the reason and message fields, and the individual container status arrays contain more detail about the pod's status. There are five possible phase values:

+

Pending: The pod has been accepted by the Kubernetes system, but one or more of the container images has not been created. This includes time before being scheduled as well as time spent downloading images over the network, which could take a while. Running: The pod has been bound to a node, and all of the containers have been created. At least one container is still running, or is in the process of starting or restarting. Succeeded: All containers in the pod have terminated in success, and will not be restarted. Failed: All containers in the pod have terminated, and at least one container has terminated in failure. The container either exited with non-zero status or was terminated by the system. Unknown: For some reason the state of the pod could not be obtained, typically due to an error in communicating with the host of the pod.

+

More info: https://kubernetes.io/docs/concepts/workloads/pods/pod-lifecycle#pod-phase

+

Possible enum values:

+
  • "Failed" means that all containers in the pod have terminated, and at least one container has terminated in a failure (exited with a non-zero exit code or was stopped by the system).
  • "Pending" means the pod has been accepted by the system, but one or more of the containers has not been started. This includes time before being bound to a node, as well as time spent pulling images onto the host.
  • "Running" means the pod has been bound to a node and all of the containers have been started. At least one container is still running or is in the process of being restarted.
  • "Succeeded" means that all containers in the pod have voluntarily terminated with a container exit code of 0, and the system is not going to restart any of these containers.
  • "Unknown" means that for some reason the state of the pod could not be obtained, typically due to an error in communicating with the host of the pod. Deprecated: It isn't being set since 2015 (74da3b14b0c0f658b3bb8d2def5094686d0e9095)
+

podIP

+

String

+

IP address allocated to the pod. Routable at least within the

+

cluster. Empty if not yet allocated.

+

podIPs

+

Array of io.cci.otc.api.pkg.apis.versioned.cci.v2.PodIP objects

+

podIPs holds the IP addresses allocated to the pod. If this field

+

is specified, the 0th entry must match the podIP field. Pods may be allocated

+

at most 1 value for each of IPv4 and IPv6. This list is empty if no IPs

+

have been allocated yet.

+

qosClass

+

String

+

The Quality of Service (QOS) classification assigned to the pod based on resource requirements See PodQOSClass type for available QOS classes More info: https://git.k8s.io/community/contributors/design-proposals/node/resource-qos.md

+

Possible enum values:

+
  • "BestEffort" is the BestEffort qos class.
  • "Burstable" is the Burstable qos class.
  • "Guaranteed" is the Guaranteed qos class.
+

reason

+

String

+

A brief CamelCase message indicating details about why the pod

+

is in this state. e.g. 'Evicted'

+

startTime

+

String

+

RFC 3339 date and time at which the object was acknowledged by

+

the Kubelet. This is before the Kubelet pulled the container image(s) for

+

the pod.

+
+
+ +
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Table 71 io.cci.otc.api.pkg.apis.versioned.cci.v2.PodCondition

Parameter

+

Type

+

Description

+

lastProbeTime

+

String

+

Last time we probed the condition.

+

lastTransitionTime

+

String

+

Last time the condition transitioned from one status to another.

+

message

+

String

+

Human-readable message indicating details about last transition.

+

reason

+

String

+

Unique, one-word, CamelCase reason for the condition's last transition.

+

status

+

String

+

Status is the status of the condition. Can be True, False, Unknown. More info: https://kubernetes.io/docs/concepts/workloads/pods/pod-lifecycle#pod-conditions

+

type

+

String

+

Type is the type of the condition. More info: https://kubernetes.io/docs/concepts/workloads/pods/pod-lifecycle#pod-conditions

+
+
+ +
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Table 72 io.cci.otc.api.pkg.apis.versioned.cci.v2.ContainerStatus

Parameter

+

Type

+

Description

+

containerID

+

String

+

Container's ID in the format '[/topic/body/section/table/tgroup/tbody/row/entry/p/br {""}) (br]://<container_id>'.

+

image

+

String

+

The image the container is running. More info: https://kubernetes.io/docs/concepts/containers/images.

+

imageID

+

String

+

ImageID of the container's image.

+

lastState

+

io.cci.otc.api.pkg.apis.versioned.cci.v2.ContainerState object

+

Details about the container's last termination condition.

+

name

+

String

+

This must be a DNS_LABEL. Each container in a pod must have a

+

unique name. Cannot be updated.

+

ready

+

Boolean

+

Specifies whether the container has passed its readiness probe.

+

restartCount

+

Integer

+

The number of times the container has been restarted.

+

started

+

Boolean

+

Specifies whether the container has passed its startup probe.

+

Initialized as false, becomes true after startupProbe is considered successful.

+

Resets to false when the container is restarted, or if kubelet loses state

+

temporarily. Is always true when no startupProbe is defined.

+

state

+

io.cci.otc.api.pkg.apis.versioned.cci.v2.ContainerState object

+

Details about the container's current condition.

+
+
+ +
+ + + + + + + + + + + + + + + + + +
Table 73 io.cci.otc.api.pkg.apis.versioned.cci.v2.ContainerState

Parameter

+

Type

+

Description

+

running

+

io.cci.otc.api.pkg.apis.versioned.cci.v2.ContainerStateRunning object

+

Details about a running container

+

terminated

+

io.cci.otc.api.pkg.apis.versioned.cci.v2.ContainerStateTerminated object

+

Details about a terminated container

+

waiting

+

io.cci.otc.api.pkg.apis.versioned.cci.v2.ContainerStateWaiting object

+

Details about a waiting container

+
+
+ +
+ + + + + + + + + +
Table 74 io.cci.otc.api.pkg.apis.versioned.cci.v2.ContainerStateRunning

Parameter

+

Type

+

Description

+

startedAt

+

String

+

Time at which the container was last (re-)started

+
+
+ +
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Table 75 io.cci.otc.api.pkg.apis.versioned.cci.v2.ContainerStateTerminated

Parameter

+

Type

+

Description

+

containerID

+

String

+

Container's ID in the format '[/topic/body/section/table/tgroup/tbody/row/entry/p/br {""}) (br]://<container_id>'

+

exitCode

+

Integer

+

Exit status from the last termination of the container

+

finishedAt

+

String

+

Time at which the container last terminated

+

message

+

String

+

Message regarding the last termination of the container

+

reason

+

String

+

(brief) reason from the last termination of the container

+

signal

+

Integer

+

Signal from the last termination of the container

+

startedAt

+

String

+

Time at which previous execution of the container started

+
+
+ +
+ + + + + + + + + + + + + +
Table 76 io.cci.otc.api.pkg.apis.versioned.cci.v2.ContainerStateWaiting

Parameter

+

Type

+

Description

+

message

+

String

+

Message regarding why the container is not yet running.

+

reason

+

String

+

(brief) reason the container is not yet running.

+
+
+ +
+ + + + + + + + + +
Table 77 io.cci.otc.api.pkg.apis.versioned.cci.v2.PodIP

Parameter

+

Type

+

Description

+

ip

+

String

+

ip is an IP address (IPv4 or IPv6) assigned to the pod

+
+
+

Status code: 201

+ +
+ + + + + + + + + + + + + + + + + + + + + + + + + +
Table 78 Response body parameters

Parameter

+

Type

+

Description

+

apiVersion

+

String

+

APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#resources

+

kind

+

String

+

Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds

+

metadata

+

io.k8s.apimachinery.pkg.apis.meta.v1.ObjectMeta object

+

Standard object's metadata. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata

+

spec

+

io.cci.otc.api.pkg.apis.versioned.cci.v2.PodSpec object

+

Specification of the desired behavior of the pod. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#spec-and-status

+

status

+

io.cci.otc.api.pkg.apis.versioned.cci.v2.PodStatus object

+

Most recently observed status of the pod. This data may not be up to date. Populated by the system. Read-only. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#spec-and-status

+
+
+ +
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Table 79 io.cci.otc.api.pkg.apis.versioned.cci.v2.PodSpec

Parameter

+

Type

+

Description

+

activeDeadlineSeconds

+

Long

+

Optional duration in seconds the pod may be active on the node

+

relative to StartTime before the system will actively try to mark it failed

+

and kill associated containers. Value must be a positive integer.

+

affinity

+

io.cci.otc.api.pkg.apis.versioned.cci.v2.Affinity object

+

If specified, the pod's scheduling constraints

+

containers

+

Array of io.cci.otc.api.pkg.apis.versioned.cci.v2.Container objects

+

List of containers belonging to the pod. Containers cannot currently

+

be added or removed. There must be at least one container in a Pod. Cannot

+

be updated.

+

dnsConfig

+

io.cci.otc.api.pkg.apis.versioned.cci.v2.PodDNSConfig object

+

Specifies the DNS parameters of a pod. Parameters specified here

+

will be merged to the generated DNS configuration based on DNSPolicy.

+

dnsPolicy

+

String

+

Set DNS policy for the pod. Defaults to "ClusterFirst". Valid values are 'ClusterFirstWithHostNet', 'ClusterFirst', 'Default' or 'None'. DNS parameters given in DNSConfig will be merged with the policy selected with DNSPolicy. To have DNS options set along with hostNetwork, you have to specify DNS policy explicitly to 'ClusterFirstWithHostNet'.

+

Possible enum values:

+
  • "ClusterFirst" indicates that the pod should use cluster DNS first unless hostNetwork is true, if it is available, then fall back on the default (as determined by kubelet) DNS settings.
  • "ClusterFirstWithHostNet" indicates that the pod should use cluster DNS first, if it is available, then fall back on the default (as determined by kubelet) DNS settings.
  • "Default" indicates that the pod should use the default (as determined by kubelet) DNS settings.
  • "None" indicates that the pod should use empty DNS settings. DNS parameters such as nameservers and search paths should be defined via DNSConfig.
+

ephemeralContainers

+

Array of io.cci.otc.api.pkg.apis.versioned.cci.v2.EphemeralContainer objects

+

List of ephemeral containers run in this pod. Ephemeral containers

+

may be run in an existing pod to perform user-initiated actions such as

+

debugging. This list cannot be specified when creating a pod, and it cannot

+

be modified by updating the pod spec. In order to add an ephemeral container

+

to an existing pod, use the pod's ephemeralcontainers subresource.

+

hostAliases

+

Array of io.cci.otc.api.pkg.apis.versioned.cci.v2.HostAlias objects

+

HostAliases is an optional list of hosts and IPs that will be

+

injected into the pod's hosts file if specified. This is only valid for

+

non-hostNetwork pods.

+

hostname

+

String

+

Specifies the hostName of the Pod. If not specified, the pod's

+

hostname will be set to a system-defined value.

+

imagePullSecrets

+

Array of io.cci.otc.api.pkg.apis.versioned.cci.v2.LocalObjectReference objects

+

ImagePullSecrets is an optional list of references to secrets in the same namespace to use for pulling any of the images used by this PodSpec. If specified, these secrets will be passed to individual puller implementations for them to use. More info: https://kubernetes.io/docs/concepts/containers/images#specifying-imagepullsecrets-on-a-pod

+

initContainers

+

Array of io.cci.otc.api.pkg.apis.versioned.cci.v2.Container objects

+

List of initialization containers belonging to the pod. Init containers are executed in order prior to containers being started. If any init container fails, the pod is considered to have failed and is handled according to its restartPolicy. The name for an init container or normal container must be unique among all containers. Init containers may not have Lifecycle actions, Readiness probes, Liveness probes, or Startup probes. The resourceRequirements of an init container are taken into account during scheduling by finding the highest request/limit for each resource type, and then using the max of of that value or the sum of the normal containers. Limits are applied to init containers in a similar fashion. Init containers cannot currently be added or removed. Cannot be updated. More info: https://kubernetes.io/docs/concepts/workloads/pods/init-containers/

+

nodeName

+

String

+

NodeName is a request to schedule this pod onto a specific node.

+

If it is non-empty, the scheduler simply schedules this pod onto that node,

+

assuming that it fits resource requirements.

+

overhead

+

Map<String,String>

+

Overhead represents the resource overhead associated with running a pod for a given RuntimeClass. This field will be autopopulated at admission time by the RuntimeClass admission controller. If the RuntimeClass admission controller is enabled, overhead must not be set in Pod create requests. The RuntimeClass admission controller will reject Pod create requests which have the overhead already set. If RuntimeClass is configured and selected in the PodSpec, Overhead will be set to the value defined in the corresponding RuntimeClass, otherwise it will remain unset and treated as zero. More info: https://git.k8s.io/enhancements/keps/sig-node/688-pod-overhead/README.md

+

readinessGates

+

Array of io.cci.otc.api.pkg.apis.versioned.cci.v2.PodReadinessGate objects

+

If specified, all readiness gates will be evaluated for pod readiness. A pod is ready when all its containers are ready AND all conditions specified in the readiness gates have status equal to "True" More info: https://git.k8s.io/enhancements/keps/sig-network/580-pod-readiness-gates

+

restartPolicy

+

String

+

Restart policy for all containers within the pod. One of Always, OnFailure, Never. Default to Always. More info: https://kubernetes.io/docs/concepts/workloads/pods/pod-lifecycle/#restart-policy

+

Possible enum values:

+
  • "Always"
  • "Never"
  • "OnFailure"
+

schedulerName

+

String

+

If specified, the pod will be dispatched by specified scheduler.

+

If not specified, the pod will be dispatched by default scheduler.

+

securityContext

+

io.cci.otc.api.pkg.apis.versioned.cci.v2.PodSecurityContext object

+

SecurityContext holds pod-level security attributes and common container settings. Optional: Defaults to empty. See type description for default values of each field.

+

setHostnameAsFQDN

+

Boolean

+

If true the pod's hostname will be configured as the pod's FQDN,

+

rather than the leaf name (the default). In Linux containers, this means

+

setting the FQDN in the hostname field of the kernel (the nodename field

+

of struct utsname). In Windows containers, this means setting the registry

+

value of hostname for the registry key HKEY_LOCAL_MACHINE\SYSTEM\CurrentControlSet\Services\Tcpip\Parameters

+

to FQDN. If a pod does not have FQDN, this has no effect. Default to false.

+

shareProcessNamespace

+

Boolean

+

Share a single process namespace between all of the containers in a pod. When this is set containers will be able to view and signal processes from other containers in the same pod, and the first process in each container will not be assigned PID 1. HostPID and ShareProcessNamespace cannot both be set. Optional: Default to false.

+

terminationGracePeriodSeconds

+

Long

+

Optional duration in seconds the pod needs to terminate gracefully.

+

May be decreased in delete request. Value must be non-negative integer.

+

The value zero indicates stop immediately via the kill signal (no opportunity

+

to shut down). If this value is nil, the default grace period will be used

+

instead. The grace period is the duration in seconds after the processes

+

running in the pod are sent a termination signal and the time when the processes

+

are forcibly halted with a kill signal. Set this value longer than the expected

+

cleanup time for your process. Defaults to 30 seconds.

+

topologySpreadConstraints

+

Array of io.cci.otc.api.pkg.apis.versioned.cci.v2.TopologySpreadConstraint objects

+

TopologySpreadConstraints describes how a group of pods ought

+

to spread across topology domains. Scheduler will schedule pods in a way

+

which abides by the constraints. All topologySpreadConstraints are ANDed.

+

volumes

+

Array of io.cci.otc.api.pkg.apis.versioned.cci.v2.Volume objects

+

List of volumes that can be mounted by containers belonging to the pod. More info: https://kubernetes.io/docs/concepts/storage/volumes

+
+
+ +
+ + + + + + + + + + + + + +
Table 80 io.cci.otc.api.pkg.apis.versioned.cci.v2.Affinity

Parameter

+

Type

+

Description

+

nodeAffinity

+

io.cci.otc.api.pkg.apis.versioned.cci.v2.NodeAffinity object

+

Describes node affinity scheduling rules for the pod.

+

podAntiAffinity

+

io.cci.otc.api.pkg.apis.versioned.cci.v2.PodAntiAffinity object

+

Describes pod anti-affinity scheduling rules (e.g. avoid putting

+

this pod in the same zone, etc. as some other pod(s)).

+
+
+ +
+ + + + + + + + + +
Table 81 io.cci.otc.api.pkg.apis.versioned.cci.v2.NodeAffinity

Parameter

+

Type

+

Description

+

requiredDuringSchedulingIgnoredDuringExecution

+

io.cci.otc.api.pkg.apis.versioned.cci.v2.NodeSelector object

+

If the affinity requirements specified by this field are not

+

met at scheduling time, the pod will not be scheduled onto the node. If

+

the affinity requirements specified by this field cease to be met at some

+

point during pod execution (e.g. due to an update), the system may or may

+

not try to eventually evict the pod from its node.

+
+
+ +
+ + + + + + + + + +
Table 82 io.cci.otc.api.pkg.apis.versioned.cci.v2.NodeSelector

Parameter

+

Type

+

Description

+

nodeSelectorTerms

+

Array of io.cci.otc.api.pkg.apis.versioned.cci.v2.NodeSelectorTerm objects

+

Required. A list of node selector terms. The terms are ORed.

+
+
+ +
+ + + + + + + + + +
Table 83 io.cci.otc.api.pkg.apis.versioned.cci.v2.NodeSelectorTerm

Parameter

+

Type

+

Description

+

matchExpressions

+

Array of io.cci.otc.api.pkg.apis.versioned.cci.v2.NodeSelectorRequirement objects

+

A list of node selector requirements by node's labels.

+
+
+ +
+ + + + + + + + + + + + + + + + + +
Table 84 io.cci.otc.api.pkg.apis.versioned.cci.v2.NodeSelectorRequirement

Parameter

+

Type

+

Description

+

key

+

String

+

The label key that the selector applies to.

+

operator

+

String

+

Represents a key's relationship to a set of values. Valid operators are In, NotIn, Exists, DoesNotExist. Gt, and Lt.

+

Possible enum values:

+
  • "DoesNotExist"
  • "Exists"
  • "Gt"
  • "In"
  • "Lt"
  • "NotIn"
+

values

+

Array of strings

+

An array of string values. If the operator is In or NotIn, the

+

values array must be non-empty. If the operator is Exists or DoesNotExist,

+

the values array must be empty. If the operator is Gt or Lt, the values

+

array must have a single element, which will be interpreted as an integer.

+

This array is replaced during a strategic merge patch.

+
+
+ +
+ + + + + + + + + + + + + +
Table 85 io.cci.otc.api.pkg.apis.versioned.cci.v2.PodAntiAffinity

Parameter

+

Type

+

Description

+

preferredDuringSchedulingIgnoredDuringExecution

+

Array of io.cci.otc.api.pkg.apis.versioned.cci.v2.WeightedPodAffinityTerm objects

+

The scheduler will prefer to schedule pods to nodes that satisfy

+

the anti-affinity expressions specified by this field, but it may choose

+

a node that violates one or more of the expressions. The node that is most

+

preferred is the one with the greatest sum of weights, i.e. for each node

+

that meets all of the scheduling requirements (resource request, requiredDuringScheduling

+

anti-affinity expressions, etc.), compute a sum by iterating through the

+

elements of this field and adding "weight" to the sum if the node has pods

+

which matches the corresponding podAffinityTerm; the node(s) with the highest

+

sum are the most preferred.

+

requiredDuringSchedulingIgnoredDuringExecution

+

Array of io.cci.otc.api.pkg.apis.versioned.cci.v2.PodAffinityTerm objects

+

If the anti-affinity requirements specified by this field are

+

not met at scheduling time, the pod will not be scheduled onto the node.

+

If the anti-affinity requirements specified by this field cease to be met

+

at some point during pod execution (e.g. due to a pod label update), the

+

system may or may not try to eventually evict the pod from its node. When

+

there are multiple elements, the lists of nodes corresponding to each podAffinityTerm

+

are intersected, i.e. all terms must be satisfied.

+
+
+ +
+ + + + + + + + + + + + + +
Table 86 io.cci.otc.api.pkg.apis.versioned.cci.v2.WeightedPodAffinityTerm

Parameter

+

Type

+

Description

+

podAffinityTerm

+

io.cci.otc.api.pkg.apis.versioned.cci.v2.PodAffinityTerm object

+

Required. A pod affinity term, associated with the corresponding

+

weight.

+

weight

+

Integer

+

weight associated with matching the corresponding podAffinityTerm,

+

in the range 1-100.

+
+
+ +
+ + + + + + + + + + + + + + + + + +
Table 87 io.cci.otc.api.pkg.apis.versioned.cci.v2.PodAffinityTerm

Parameter

+

Type

+

Description

+

labelSelector

+

io.k8s.apimachinery.pkg.apis.meta.v1.LabelSelector object

+

A label query over a set of resources, in this case pods.

+

namespaces

+

Array of strings

+

namespaces specifies a static list of namespace names that the

+

term applies to. The term is applied to the union of the namespaces listed

+

in this field and the ones selected by namespaceSelector. null or empty

+

namespaces list and null namespaceSelector means "this pod's namespace".

+

topologyKey

+

String

+

This pod should be co-located (affinity) or not co-located (anti-affinity)

+

with the pods matching the labelSelector in the specified namespaces, where

+

co-located is defined as running on a node whose value of the label with

+

key topologyKey matches that of any node on which any of the selected pods

+

is running. Empty topologyKey is not allowed.

+
+
+ +
+ + + + + + + + + + + + + + + + + +
Table 88 io.cci.otc.api.pkg.apis.versioned.cci.v2.PodDNSConfig

Parameter

+

Type

+

Description

+

nameservers

+

Array of strings

+

A list of DNS name server IP addresses. This will be appended

+

to the base nameservers generated from DNSPolicy. Duplicated nameservers

+

will be removed.

+

options

+

Array of io.cci.otc.api.pkg.apis.versioned.cci.v2.PodDNSConfigOption objects

+

A list of DNS resolver options. This will be merged with the

+

base options generated from DNSPolicy. Duplicated entries will be removed.

+

Resolution options given in Options will override those that appear in the

+

base DNSPolicy.

+

searches

+

Array of strings

+

A list of DNS search domains for host-name lookup. This will

+

be appended to the base search paths generated from DNSPolicy. Duplicated

+

search paths will be removed.

+
+
+ +
+ + + + + + + + + + + + + +
Table 89 io.cci.otc.api.pkg.apis.versioned.cci.v2.PodDNSConfigOption

Parameter

+

Type

+

Description

+

name

+

String

+

Required.

+

value

+

String

+		  
+
+ +
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Table 90 io.cci.otc.api.pkg.apis.versioned.cci.v2.EphemeralContainer

Parameter

+

Type

+

Description

+

args

+

Array of strings

+

Arguments to the entrypoint. The image's CMD is used if this is not provided. Variable references $(VAR_NAME) are expanded using the container's environment. If a variable cannot be resolved, the reference in the input string will be unchanged. Double $$ are reduced to a single $, which allows for escaping the $(VAR_NAME) syntax: i.e. "$$(VAR_NAME)" will produce the string literal "$(VAR_NAME)". Escaped references will never be expanded, regardless of whether the variable exists or not. Cannot be updated. More info: https://kubernetes.io/docs/tasks/inject-data-application/define-command-argument-container/#running-a-command-in-a-shell

+

command

+

Array of strings

+

Entrypoint array. Not executed within a shell. The image's ENTRYPOINT is used if this is not provided. Variable references $(VAR_NAME) are expanded using the container's environment. If a variable cannot be resolved, the reference in the input string will be unchanged. Double $$ are reduced to a single $, which allows for escaping the $(VAR_NAME) syntax: i.e. "$$(VAR_NAME)" will produce the string literal "$(VAR_NAME)". Escaped references will never be expanded, regardless of whether the variable exists or not. Cannot be updated. More info: https://kubernetes.io/docs/tasks/inject-data-application/define-command-argument-container/#running-a-command-in-a-shell

+

env

+

Array of io.cci.otc.api.pkg.apis.versioned.cci.v2.EnvVar objects

+

List of environment variables to set in the container. Cannot

+

be updated.

+

envFrom

+

Array of io.cci.otc.api.pkg.apis.versioned.cci.v2.EnvFromSource objects

+

List of sources to populate environment variables in the container.

+

The keys defined within a source must be a C_IDENTIFIER. All invalid keys

+

will be reported as an event when the container is starting. When a key

+

exists in multiple sources, the value associated with the last source will

+

take precedence. Values defined by an Env with a duplicate key will take

+

precedence. Cannot be updated.

+

image

+

String

+

Container image name. More info: https://kubernetes.io/docs/concepts/containers/images

+

lifecycle

+

io.cci.otc.api.pkg.apis.versioned.cci.v2.Lifecycle object

+

Lifecycle is not allowed for ephemeral containers.

+

livenessProbe

+

io.cci.otc.api.pkg.apis.versioned.cci.v2.Probe object

+

Probes are not allowed for ephemeral containers.

+

name

+

String

+

Name of the ephemeral container specified as a DNS_LABEL. This

+

name must be unique among all containers, init containers and ephemeral

+

containers.

+

ports

+

Array of io.cci.otc.api.pkg.apis.versioned.cci.v2.ContainerPort objects

+

Ports are not allowed for ephemeral containers.

+

readinessProbe

+

io.cci.otc.api.pkg.apis.versioned.cci.v2.Probe object

+

Probes are not allowed for ephemeral containers.

+

resources

+

io.cci.otc.api.pkg.apis.versioned.cci.v2.ResourceRequirements object

+

Resources are not allowed for ephemeral containers. Ephemeral

+

containers use spare resources already allocated to the pod.

+

securityContext

+

io.cci.otc.api.pkg.apis.versioned.cci.v2.SecurityContext object

+

Optional: SecurityContext defines the security options the ephemeral container should be run with. If set, the fields of SecurityContext override the equivalent fields of PodSecurityContext.

+

startupProbe

+

io.cci.otc.api.pkg.apis.versioned.cci.v2.Probe object

+

Probes are not allowed for ephemeral containers.

+

stdin

+

Boolean

+

Whether this container should allocate a buffer for stdin in

+

the container runtime. If this is not set, reads from stdin in the container

+

will always result in EOF. Default is false.

+

stdinOnce

+

Boolean

+

Whether the container runtime should close the stdin channel

+

after it has been opened by a single attach. When stdin is true the stdin

+

stream will remain open across multiple attach sessions. If stdinOnce is

+

set to true, stdin is opened on container start, is empty until the first

+

client attaches to stdin, and then remains open and accepts data until the

+

client disconnects, at which time stdin is closed and remains closed until

+

the container is restarted. If this flag is false, a container processes

+

that reads from stdin will never receive an EOF. Default is false

+

targetContainerName

+

String

+

If set, the name of the container from PodSpec that this ephemeral container targets. The ephemeral container will be run in the namespaces (IPC, PID, etc) of this container. If not set then the ephemeral container uses the namespaces configured in the Pod spec.

+

The container runtime must implement support for this feature. If the runtime does not support namespace targeting then the result of setting this field is undefined.

+

terminationMessagePath

+

String

+

Optional: Path at which the file to which the container's termination message will be written is mounted into the container's filesystem. Message written is intended to be brief final status, such as an assertion failure message. Will be truncated by the node if greater than 4096 bytes. The total message length across all containers will be limited to 12kb. Defaults to /dev/termination-log. Cannot be updated.

+

terminationMessagePolicy

+

String

+

Indicate how the termination message should be populated. File will use the contents of terminationMessagePath to populate the container status message on both success and failure. FallbackToLogsOnError will use the last chunk of container log output if the termination message file is empty and the container exited with an error. The log output is limited to 2048 bytes or 80 lines, whichever is smaller. Defaults to File. Cannot be updated.

+

Possible enum values:

+
  • "FallbackToLogsOnError" will read the most recent contents of the container logs for the container status message when the container exits with an error and the terminationMessagePath has no contents.
  • "File" is the default behavior and will set the container status message to the contents of the container's terminationMessagePath when the container exits.
+

tty

+

Boolean

+

Whether this container should allocate a TTY for itself, also

+

requires 'stdin' to be true. Default is false.

+

volumeMounts

+

Array of io.cci.otc.api.pkg.apis.versioned.cci.v2.VolumeMount objects

+

Pod volumes to mount into the container's filesystem. Subpath

+

mounts are not allowed for ephemeral containers. Cannot be updated.

+

workingDir

+

String

+

Container's working directory. If not specified, the container

+

runtime's default will be used, which might be configured in the container

+

image. Cannot be updated.

+
+
+ +
+ + + + + + + + + + + + + +
Table 91 io.cci.otc.api.pkg.apis.versioned.cci.v2.HostAlias

Parameter

+

Type

+

Description

+

hostnames

+

Array of strings

+

Hostnames for the above IP address.

+

ip

+

String

+

IP address of the host file entry.

+
+
+ +
+ + + + + + + + + +
Table 92 io.cci.otc.api.pkg.apis.versioned.cci.v2.LocalObjectReference

Parameter

+

Type

+

Description

+

name

+

String

+

Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names

+
+
+ +
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Table 93 io.cci.otc.api.pkg.apis.versioned.cci.v2.Container

Parameter

+

Type

+

Description

+

args

+

Array of strings

+

Arguments to the entrypoint. The container image's CMD is used if this is not provided. Variable references $(VAR_NAME) are expanded using the container's environment. If a variable cannot be resolved, the reference in the input string will be unchanged. Double $$ are reduced to a single $, which allows for escaping the $(VAR_NAME) syntax: i.e. "$$(VAR_NAME)" will produce the string literal "$(VAR_NAME)". Escaped references will never be expanded, regardless of whether the variable exists or not. Cannot be updated. More info: https://kubernetes.io/docs/tasks/inject-data-application/define-command-argument-container/#running-a-command-in-a-shell

+

command

+

Array of strings

+

Entrypoint array. Not executed within a shell. The container image's ENTRYPOINT is used if this is not provided. Variable references $(VAR_NAME) are expanded using the container's environment. If a variable cannot be resolved, the reference in the input string will be unchanged. Double $$ are reduced to a single $, which allows for escaping the $(VAR_NAME) syntax: i.e. "$$(VAR_NAME)" will produce the string literal "$(VAR_NAME)". Escaped references will never be expanded, regardless of whether the variable exists or not. Cannot be updated. More info: https://kubernetes.io/docs/tasks/inject-data-application/define-command-argument-container/#running-a-command-in-a-shell

+

env

+

Array of io.cci.otc.api.pkg.apis.versioned.cci.v2.EnvVar objects

+

List of environment variables to set in the container. Cannot

+

be updated.

+

envFrom

+

Array of io.cci.otc.api.pkg.apis.versioned.cci.v2.EnvFromSource objects

+

List of sources to populate environment variables in the container.

+

The keys defined within a source must be a C_IDENTIFIER. All invalid keys

+

will be reported as an event when the container is starting. When a key

+

exists in multiple sources, the value associated with the last source will

+

take precedence. Values defined by an Env with a duplicate key will take

+

precedence. Cannot be updated.

+

image

+

String

+

Container image name. More info: https://kubernetes.io/docs/concepts/containers/images This field is optional to allow higher level config management to default or override container images in workload controllers like Deployments and StatefulSets.

+

lifecycle

+

io.cci.otc.api.pkg.apis.versioned.cci.v2.Lifecycle object

+

Actions that the management system should take in response to

+

container lifecycle events. Cannot be updated.

+

livenessProbe

+

io.cci.otc.api.pkg.apis.versioned.cci.v2.Probe object

+

Periodic probe of container liveness. Container will be restarted if the probe fails. Cannot be updated. More info: https://kubernetes.io/docs/concepts/workloads/pods/pod-lifecycle#container-probes

+

name

+

String

+

Name of the container specified as a DNS_LABEL. Each container

+

in a pod must have a unique name (DNS_LABEL). Cannot be updated.

+

ports

+

Array of io.cci.otc.api.pkg.apis.versioned.cci.v2.ContainerPort objects

+

List of ports to expose from the container. Not specifying a

+

port here DOES NOT prevent that port from being exposed. Any port which

+

is listening on the default "0.0.0.0" address inside a container will be

+

accessible from the network. Modifying this array with strategic merge patch

+

may corrupt the data. For more information See https://github.com/kubernetes/kubernetes/issues/108255.

+

Cannot be updated.

+

readinessProbe

+

io.cci.otc.api.pkg.apis.versioned.cci.v2.Probe object

+

Periodic probe of container service readiness. Container will be removed from service endpoints if the probe fails. Cannot be updated. More info: https://kubernetes.io/docs/concepts/workloads/pods/pod-lifecycle#container-probes

+

resources

+

io.cci.otc.api.pkg.apis.versioned.cci.v2.ResourceRequirements object

+

Compute Resources required by this container. Cannot be updated. More info: https://kubernetes.io/docs/concepts/configuration/manage-resources-containers/

+

securityContext

+

io.cci.otc.api.pkg.apis.versioned.cci.v2.SecurityContext object

+

SecurityContext defines the security options the container should be run with. If set, the fields of SecurityContext override the equivalent fields of PodSecurityContext. More info: https://kubernetes.io/docs/tasks/configure-pod-container/security-context/

+

startupProbe

+

io.cci.otc.api.pkg.apis.versioned.cci.v2.Probe object

+

StartupProbe indicates that the Pod has successfully initialized. If specified, no other probes are executed until this completes successfully. If this probe fails, the Pod will be restarted, just as if the livenessProbe failed. This can be used to provide different probe parameters at the beginning of a Pod's lifecycle, when it might take a long time to load data or warm a cache, than during steady-state operation. This cannot be updated. More info: https://kubernetes.io/docs/concepts/workloads/pods/pod-lifecycle#container-probes

+

stdin

+

Boolean

+

Whether this container should allocate a buffer for stdin in

+

the container runtime. If this is not set, reads from stdin in the container

+

will always result in EOF. Default is false.

+

stdinOnce

+

Boolean

+

Whether the container runtime should close the stdin channel

+

after it has been opened by a single attach. When stdin is true the stdin

+

stream will remain open across multiple attach sessions. If stdinOnce is

+

set to true, stdin is opened on container start, is empty until the first

+

client attaches to stdin, and then remains open and accepts data until the

+

client disconnects, at which time stdin is closed and remains closed until

+

the container is restarted. If this flag is false, a container processes

+

that reads from stdin will never receive an EOF. Default is false

+

terminationMessagePath

+

String

+

Optional: Path at which the file to which the container's termination message will be written is mounted into the container's filesystem. Message written is intended to be brief final status, such as an assertion failure message. Will be truncated by the node if greater than 4096 bytes. The total message length across all containers will be limited to 12kb. Defaults to /dev/termination-log. Cannot be updated.

+

terminationMessagePolicy

+

String

+

Indicate how the termination message should be populated. File will use the contents of terminationMessagePath to populate the container status message on both success and failure. FallbackToLogsOnError will use the last chunk of container log output if the termination message file is empty and the container exited with an error. The log output is limited to 2048 bytes or 80 lines, whichever is smaller. Defaults to File. Cannot be updated.

+

Possible enum values:

+
  • "FallbackToLogsOnError" will read the most recent contents of the container logs for the container status message when the container exits with an error and the terminationMessagePath has no contents.
  • "File" is the default behavior and will set the container status message to the contents of the container's terminationMessagePath when the container exits.
+

tty

+

Boolean

+

Whether this container should allocate a TTY for itself, also

+

requires 'stdin' to be true. Default is false.

+

volumeMounts

+

Array of io.cci.otc.api.pkg.apis.versioned.cci.v2.VolumeMount objects

+

Pod volumes to mount into the container's filesystem. Cannot

+

be updated.

+

workingDir

+

String

+

Container's working directory. If not specified, the container

+

runtime's default will be used, which might be configured in the container

+

image. Cannot be updated.

+
+
+ +
+ + + + + + + + + + + + + + + + + +
Table 94 io.cci.otc.api.pkg.apis.versioned.cci.v2.EnvVar

Parameter

+

Type

+

Description

+

name

+

String

+

Name of the environment variable. Must be a C_IDENTIFIER.

+

value

+

String

+

Variable references $(VAR_NAME) are expanded using the previously defined environment variables in the container and any service environment variables. If a variable cannot be resolved, the reference in the input string will be unchanged. Double $$ are reduced to a single $, which allows for escaping the $(VAR_NAME) syntax: i.e. "$$(VAR_NAME)" will produce the string literal "$(VAR_NAME)". Escaped references will never be expanded, regardless of whether the variable exists or not. Defaults to "".

+

valueFrom

+

io.cci.otc.api.pkg.apis.versioned.cci.v2.EnvVarSource object

+

Source for the environment variable's value. Cannot be used if

+

value is not empty.

+
+
+ +
+ + + + + + + + + + + + + + + + + + + + + +
Table 95 io.cci.otc.api.pkg.apis.versioned.cci.v2.EnvVarSource

Parameter

+

Type

+

Description

+

configMapKeyRef

+

io.cci.otc.api.pkg.apis.versioned.cci.v2.ConfigMapKeySelector object

+

Selects a key of a ConfigMap.

+

fieldRef

+

io.cci.otc.api.pkg.apis.versioned.cci.v2.ObjectFieldSelector object

+

Selects a field of the pod: supports metadata.name, metadata.namespace, metadata.labels['<KEY>'], metadata.annotations['<KEY>'], spec.nodeName, spec.serviceAccountName, status.hostIP, status.podIP, status.podIPs.

+

resourceFieldRef

+

io.cci.otc.api.pkg.apis.versioned.cci.v2.ResourceFieldSelector object

+

Selects a resource of the container: only resources limits and requests (limits.cpu, limits.memory, limits.ephemeral-storage, requests.cpu, requests.memory and requests.ephemeral-storage) are currently supported.

+

secretKeyRef

+

io.cci.otc.api.pkg.apis.versioned.cci.v2.SecretKeySelector object

+

Selects a key of a secret in the pod's namespace

+
+
+ +
+ + + + + + + + + + + + + + + + + +
Table 96 io.cci.otc.api.pkg.apis.versioned.cci.v2.ConfigMapKeySelector

Parameter

+

Type

+

Description

+

key

+

String

+

The key to select.

+

name

+

String

+

Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names

+

optional

+

Boolean

+

Specify whether the ConfigMap or its key must be defined

+
+
+ +
+ + + + + + + + + + + + + + + + + +
Table 97 io.cci.otc.api.pkg.apis.versioned.cci.v2.SecretKeySelector

Parameter

+

Type

+

Description

+

key

+

String

+

The key of the secret to select from. Must be a valid secret

+

key.

+

name

+

String

+

Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names

+

optional

+

Boolean

+

Specify whether the Secret or its key must be defined

+
+
+ +
+ + + + + + + + + + + + + + + + + +
Table 98 io.cci.otc.api.pkg.apis.versioned.cci.v2.EnvFromSource

Parameter

+

Type

+

Description

+

configMapRef

+

io.cci.otc.api.pkg.apis.versioned.cci.v2.ConfigMapEnvSource object

+

The ConfigMap to select from

+

prefix

+

String

+

An optional identifier to prepend to each key in the ConfigMap.

+

Must be a C_IDENTIFIER.

+

secretRef

+

io.cci.otc.api.pkg.apis.versioned.cci.v2.SecretEnvSource object

+

The Secret to select from

+
+
+ +
+ + + + + + + + + + + + + +
Table 99 io.cci.otc.api.pkg.apis.versioned.cci.v2.ConfigMapEnvSource

Parameter

+

Type

+

Description

+

name

+

String

+

Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names

+

optional

+

Boolean

+

Specify whether the ConfigMap must be defined

+
+
+ +
+ + + + + + + + + + + + + +
Table 100 io.cci.otc.api.pkg.apis.versioned.cci.v2.SecretEnvSource

Parameter

+

Type

+

Description

+

name

+

String

+

Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names

+

optional

+

Boolean

+

Specify whether the Secret must be defined

+
+
+ +
+ + + + + + + + + + + + + +
Table 101 io.cci.otc.api.pkg.apis.versioned.cci.v2.Lifecycle

Parameter

+

Type

+

Description

+

postStart

+

io.cci.otc.api.pkg.apis.versioned.cci.v2.LifecycleHandler object

+

PostStart is called immediately after a container is created. If the handler fails, the container is terminated and restarted according to its restart policy. Other management of the container blocks until the hook completes. More info: https://kubernetes.io/docs/concepts/containers/container-lifecycle-hooks/#container-hooks

+

preStop

+

io.cci.otc.api.pkg.apis.versioned.cci.v2.LifecycleHandler object

+

PreStop is called immediately before a container is terminated due to an API request or management event such as liveness/startup probe failure, preemption, resource contention, etc. The handler is not called if the container crashes or exits. The Pod's termination grace period countdown begins before the PreStop hook is executed. Regardless of the outcome of the handler, the container will eventually terminate within the Pod's termination grace period (unless delayed by finalizers). Other management of the container blocks until the hook completes or until the termination grace period is reached. More info: https://kubernetes.io/docs/concepts/containers/container-lifecycle-hooks/#container-hooks

+
+
+ +
+ + + + + + + + + + + + + +
Table 102 io.cci.otc.api.pkg.apis.versioned.cci.v2.LifecycleHandler

Parameter

+

Type

+

Description

+

exec

+

io.cci.otc.api.pkg.apis.versioned.cci.v2.ExecAction object

+

Exec specifies the action to take.

+

httpGet

+

io.cci.otc.api.pkg.apis.versioned.cci.v2.HTTPGetAction object

+

HTTPGet specifies the http request to perform.

+
+
+ +
+ + + + + + + + + + + + + + + + + +
Table 103 io.cci.otc.api.pkg.apis.versioned.cci.v2.ContainerPort

Parameter

+

Type

+

Description

+

containerPort

+

Integer

+

Number of port to expose on the pod's IP address. This must be

+

a valid port number, 0 < x < 65536.

+

name

+

String

+

If specified, this must be an IANA_SVC_NAME and unique within

+

the pod. Each named port in a pod must have a unique name. Name for the

+

port that can be referred to by services.

+

protocol

+

String

+

Protocol for port. Must be UDP, TCP, or SCTP. Defaults to "TCP".

+

Possible enum values:

+
  • "SCTP" is the SCTP protocol.
  • "TCP" is the TCP protocol.
  • "UDP" is the UDP protocol.
+
+
+ +
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Table 104 io.cci.otc.api.pkg.apis.versioned.cci.v2.SecurityContext

Parameter

+

Type

+

Description

+

capabilities

+

io.cci.otc.api.pkg.apis.versioned.cci.v2.Capabilities object

+

The capabilities to add/drop when running containers. Defaults

+

to the default set of capabilities granted by the container runtime. Note

+

that this field cannot be set when spec.os.name is windows.

+

procMount

+

String

+

procMount denotes the type of proc mount to use for the containers.

+

The default is DefaultProcMount which uses the container runtime defaults

+

for readonly paths and masked paths. This requires the ProcMountType feature

+

flag to be enabled. Note that this field cannot be set when spec.os.name

+

is windows.

+

readOnlyRootFilesystem

+

Boolean

+

Whether this container has a read-only root filesystem. Default

+

is false. Note that this field cannot be set when spec.os.name is windows.

+

runAsGroup

+

Long

+

The GID to run the entrypoint of the container process. Uses

+

runtime default if unset. May also be set in PodSecurityContext. If set

+

in both SecurityContext and PodSecurityContext, the value specified in SecurityContext

+

takes precedence. Note that this field cannot be set when spec.os.name is

+

windows.

+

runAsNonRoot

+

Boolean

+

Indicates that the container must run as a non-root user. If

+

true, the Kubelet will validate the image at runtime to ensure that it does

+

not run as UID 0 (root) and fail to start the container if it does. If unset

+

or false, no such validation will be performed. May also be set in PodSecurityContext. If

+

set in both SecurityContext and PodSecurityContext, the value specified

+

in SecurityContext takes precedence.

+

runAsUser

+

Long

+

The UID to run the entrypoint of the container process. Defaults

+

to user specified in image metadata if unspecified. May also be set in PodSecurityContext. If

+

set in both SecurityContext and PodSecurityContext, the value specified

+

in SecurityContext takes precedence. Note that this field cannot be set

+

when spec.os.name is windows.

+
+
+ +
+ + + + + + + + + + + + + +
Table 105 io.cci.otc.api.pkg.apis.versioned.cci.v2.Capabilities

Parameter

+

Type

+

Description

+

add

+

Array of strings

+

Added capabilities

+

drop

+

Array of strings

+

Removed capabilities

+
+
+ +
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Table 106 io.cci.otc.api.pkg.apis.versioned.cci.v2.Probe

Parameter

+

Type

+

Description

+

exec

+

io.cci.otc.api.pkg.apis.versioned.cci.v2.ExecAction object

+

Exec specifies the action to take.

+

failureThreshold

+

Integer

+

Minimum consecutive failures for the probe to be considered failed

+

after having succeeded. Defaults to 3. Minimum value is 1.

+

httpGet

+

io.cci.otc.api.pkg.apis.versioned.cci.v2.HTTPGetAction object

+

HTTPGet specifies the http request to perform.

+

initialDelaySeconds

+

Integer

+

Number of seconds after the container has started before liveness probes are initiated. More info: https://kubernetes.io/docs/concepts/workloads/pods/pod-lifecycle#container-probes

+

periodSeconds

+

Integer

+

How often (in seconds) to perform the probe. Default to 10 seconds.

+

Minimum value is 1.

+

successThreshold

+

Integer

+

Minimum consecutive successes for the probe to be considered

+

successful after having failed. Defaults to 1. Must be 1 for liveness and

+

startup. Minimum value is 1.

+

tcpSocket

+

io.cci.otc.api.pkg.apis.versioned.cci.v2.TCPSocketAction object

+

TCPSocket specifies an action involving a TCP port.

+

terminationGracePeriodSeconds

+

Long

+

Optional duration in seconds the pod needs to terminate gracefully

+

upon probe failure. The grace period is the duration in seconds after the

+

processes running in the pod are sent a termination signal and the time

+

when the processes are forcibly halted with a kill signal. Set this value

+

longer than the expected cleanup time for your process. If this value is

+

nil, the pod's terminationGracePeriodSeconds will be used. Otherwise, this

+

value overrides the value provided by the pod spec. Value must be non-negative

+

integer. The value zero indicates stop immediately via the kill signal (no

+

opportunity to shut down). This is a beta field and requires enabling ProbeTerminationGracePeriod

+

feature gate. Minimum value is 1. spec.terminationGracePeriodSeconds is

+

used if unset.

+

timeoutSeconds

+

Integer

+

Number of seconds after which the probe times out. Defaults to 1 second. Minimum value is 1. More info: https://kubernetes.io/docs/concepts/workloads/pods/pod-lifecycle#container-probes

+
+
+ +
+ + + + + + + + + +
Table 107 io.cci.otc.api.pkg.apis.versioned.cci.v2.ExecAction

Parameter

+

Type

+

Description

+

command

+

Array of strings

+

Command is the command line to execute inside the container,

+

the working directory for the command is root ('/') in the container's

+

filesystem. The command is simply exec'd, it is not run inside a shell,

+

so traditional shell instructions ('|', etc) won't work. To use a shell,

+

you need to explicitly call out to that shell. Exit status of 0 is treated

+

as live/healthy and non-zero is unhealthy.

+
+
+ +
+ + + + + + + + + + + + + + + + + + + + + + + + + +
Table 108 io.cci.otc.api.pkg.apis.versioned.cci.v2.HTTPGetAction

Parameter

+

Type

+

Description

+

host

+

String

+

Host name to connect to, defaults to the pod IP. You probably

+

want to set "Host" in httpHeaders instead.

+

httpHeaders

+

Array of io.cci.otc.api.pkg.apis.versioned.cci.v2.HTTPHeader objects

+

Custom headers to set in the request. HTTP allows repeated headers.

+

path

+

String

+

Path to access on the HTTP server.

+

port

+

String

+

Name or number of the port to access on the container. Number

+

must be in the range 1 to 65535. Name must be an IANA_SVC_NAME.

+

scheme

+

String

+

Scheme to use for connecting to the host. Defaults to HTTP.

+

Possible enum values:

+
  • "HTTP" means that the scheme used will be http://
  • "HTTPS" means that the scheme used will be https://
+
+
+ +
+ + + + + + + + + + + + + +
Table 109 io.cci.otc.api.pkg.apis.versioned.cci.v2.HTTPHeader

Parameter

+

Type

+

Description

+

name

+

String

+

The header field name

+

value

+

String

+

The header field value

+
+
+ +
+ + + + + + + + + + + + + +
Table 110 io.cci.otc.api.pkg.apis.versioned.cci.v2.TCPSocketAction

Parameter

+

Type

+

Description

+

host

+

String

+

Optional: Host name to connect to, defaults to the pod IP.

+

port

+

String

+

Number or name of the port to access on the container. Number

+

must be in the range 1 to 65535. Name must be an IANA_SVC_NAME.

+
+
+ +
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Table 111 io.cci.otc.api.pkg.apis.versioned.cci.v2.VolumeMount

Parameter

+

Type

+

Description

+

extendPathMode

+

String

+

Extend the volume path by appending the pod metadata to the path

+

according to specified pattern. which provide a way of directory isolation

+

and help prevent the writing conflict between different pods.

+

mountPath

+

String

+

Path within the container at which the volume should be mounted. Must

+

not contain ':'.

+

name

+

String

+

This must match the Name of a Volume.

+

readOnly

+

Boolean

+

Mounted read-only if true, read-write otherwise (false or unspecified).

+

Defaults to false.

+

subPath

+

String

+

Path within the volume from which the container's volume should

+

be mounted. Defaults to "" (volume's root).

+

subPathExpr

+

String

+

Expanded path within the volume from which the container's volume

+

should be mounted. Behaves similarly to SubPath but environment variable

+

references $(VAR_NAME) are expanded using the container's environment. Defaults

+

to "" (volume's root). SubPathExpr and SubPath are mutually exclusive.

+
+
+ +
+ + + + + + + + + +
Table 112 io.cci.otc.api.pkg.apis.versioned.cci.v2.PodReadinessGate

Parameter

+

Type

+

Description

+

conditionType

+

String

+

ConditionType refers to a condition in the pod's condition list

+

with matching type.

+
+
+ +
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Table 113 io.cci.otc.api.pkg.apis.versioned.cci.v2.PodSecurityContext

Parameter

+

Type

+

Description

+

fsGroup

+

Long

+

A special supplemental group that applies to all containers in a pod. Some volume types allow the Kubelet to change the ownership of that volume to be owned by the pod:

+
  1. The owning GID will be the FSGroup 2. The setgid bit is set (new files created in the volume will be owned by FSGroup) 3. The permission bits are OR'd with rw-rw----
+

If unset, the Kubelet will not modify the ownership and permissions of any volume. Note that this field cannot be set when spec.os.name is windows.

+

fsGroupChangePolicy

+

String

+

fsGroupChangePolicy defines behavior of changing ownership and permission of the volume before being exposed inside Pod. This field will only apply to volume types which support fsGroup based ownership(and permissions). It will have no effect on ephemeral volume types such as: secret, configmaps and emptydir. Valid values are "OnRootMismatch" and "Always". If not specified, "Always" is used. Note that this field cannot be set when spec.os.name is windows.

+

runAsGroup

+

Long

+

The GID to run the entrypoint of the container process. Uses

+

runtime default if unset. May also be set in SecurityContext. If set in

+

both SecurityContext and PodSecurityContext, the value specified in SecurityContext

+

takes precedence for that container. Note that this field cannot be set

+

when spec.os.name is windows.

+

runAsNonRoot

+

Boolean

+

Indicates that the container must run as a non-root user. If

+

true, the Kubelet will validate the image at runtime to ensure that it does

+

not run as UID 0 (root) and fail to start the container if it does. If unset

+

or false, no such validation will be performed. May also be set in SecurityContext. If

+

set in both SecurityContext and PodSecurityContext, the value specified

+

in SecurityContext takes precedence.

+

runAsUser

+

Long

+

The UID to run the entrypoint of the container process. Defaults

+

to user specified in image metadata if unspecified. May also be set in SecurityContext. If

+

set in both SecurityContext and PodSecurityContext, the value specified

+

in SecurityContext takes precedence for that container. Note that this field

+

cannot be set when spec.os.name is windows.

+

supplementalGroups

+

Array of longs

+

A list of groups applied to the first process run in each container,

+

in addition to the container's primary GID. If unspecified, no groups will

+

be added to any container. Note that this field cannot be set when spec.os.name

+

is windows.

+

sysctls

+

Array of io.cci.otc.api.pkg.apis.versioned.cci.v2.Sysctl objects

+

Sysctls hold a list of namespaced sysctls used for the pod. Pods

+

with unsupported sysctls (by the container runtime) might fail to launch.

+

Note that this field cannot be set when spec.os.name is windows.

+
+
+ +
+ + + + + + + + + + + + + +
Table 114 io.cci.otc.api.pkg.apis.versioned.cci.v2.Sysctl

Parameter

+

Type

+

Description

+

name

+

String

+

Name of a property to set

+

value

+

String

+

Value of a property to set

+
+
+ +
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Table 115 io.cci.otc.api.pkg.apis.versioned.cci.v2.TopologySpreadConstraint

Parameter

+

Type

+

Description

+

labelSelector

+

io.k8s.apimachinery.pkg.apis.meta.v1.LabelSelector object

+

LabelSelector is used to find matching pods. Pods that match

+

this label selector are counted to determine the number of pods in their

+

corresponding topology domain.

+

matchLabelKeys

+

Array of strings

+

MatchLabelKeys is a set of pod label keys to select the pods

+

over which spreading will be calculated. The keys are used to lookup values

+

from the incoming pod labels, those key-value labels are ANDed with labelSelector

+

to select the group of existing pods over which spreading will be calculated

+

for the incoming pod. Keys that don't exist in the incoming pod labels will

+

be ignored. A null or empty list means only match against labelSelector.

+

maxSkew

+

Integer

+

MaxSkew describes the degree to which pods may be unevenly distributed. When whenUnsatisfiable=DoNotSchedule, it is the maximum permitted difference between the number of matching pods in the target topology and the global minimum. The global minimum is the minimum number of matching pods in an eligible domain or zero if the number of eligible domains is less than MinDomains. For example, in a 3-zone cluster, MaxSkew is set to 1, and pods with the same labelSelector spread as 2/2/1: In this case, the global minimum is 1. | zone1 | zone2 | zone3 | | P P | P P | P | - if MaxSkew is 1, incoming pod can only be scheduled to zone3 to become 2/2/2; scheduling it onto zone1(zone2) would make the ActualSkew(3-1) on zone1(zone2) violate MaxSkew(1). - if MaxSkew is 2, incoming pod can be scheduled onto any zone. When whenUnsatisfiable=ScheduleAnyway, it is used to give higher precedence to topologies that satisfy it. It's a required field. Default value is 1 and 0 is not allowed.

+

minDomains

+

Integer

+

MinDomains indicates a minimum number of eligible domains. When the number of eligible domains with matching topology keys is less than minDomains, Pod Topology Spread treats "global minimum" as 0, and then the calculation of Skew is performed. And when the number of eligible domains with matching topology keys equals or greater than minDomains, this value has no effect on scheduling. As a result, when the number of eligible domains is less than minDomains, scheduler won't schedule more than maxSkew Pods to those domains. If value is nil, the constraint behaves as if MinDomains is equal to 1. Valid values are integers greater than 0. When value is not nil, WhenUnsatisfiable must be DoNotSchedule.

+

For example, in a 3-zone cluster, MaxSkew is set to 2, MinDomains is set to 5 and pods with the same labelSelector spread as 2/2/2: | zone1 | zone2 | zone3 | | P P | P P | P P | The number of domains is less than 5(MinDomains), so "global minimum" is treated as 0. In this situation, new pod with the same labelSelector cannot be scheduled, because computed skew will be 3(3 - 0) if new Pod is scheduled to any of the three zones, it will violate MaxSkew.

+

This is a beta field and requires the MinDomainsInPodTopologySpread feature gate to be enabled (enabled by default).

+

nodeAffinityPolicy

+

String

+

NodeAffinityPolicy indicates how we will treat Pod's nodeAffinity/nodeSelector when calculating pod topology spread skew. Options are: - Honor: only nodes matching nodeAffinity/nodeSelector are included in the calculations. - Ignore: nodeAffinity/nodeSelector are ignored. All nodes are included in the calculations.

+

If this value is nil, the behavior is equivalent to the Honor policy. This is a alpha-level feature enabled by the NodeInclusionPolicyInPodTopologySpread feature flag.

+

nodeTaintsPolicy

+

String

+

NodeTaintsPolicy indicates how we will treat node taints when calculating pod topology spread skew. Options are: - Honor: nodes without taints, along with tainted nodes for which the incoming pod has a toleration, are included. - Ignore: node taints are ignored. All nodes are included.

+

If this value is nil, the behavior is equivalent to the Ignore policy. This is a alpha-level feature enabled by the NodeInclusionPolicyInPodTopologySpread feature flag.

+

topologyKey

+

String

+

TopologyKey is the key of node labels. Nodes that have a label

+

with this key and identical values are considered to be in the same topology.

+

We consider each <key, value> as a "bucket", and try to put balanced number

+

of pods into each bucket. We define a domain as a particular instance of

+

a topology. Also, we define an eligible domain as a domain whose nodes meet

+

the requirements of nodeAffinityPolicy and nodeTaintsPolicy. e.g. If TopologyKey

+

is "kubernetes.io/hostname", each Node is a domain of that topology. And,

+

if TopologyKey is "topology.kubernetes.io/zone", each zone is a domain of

+

that topology. It's a required field.

+

whenUnsatisfiable

+

String

+

WhenUnsatisfiable indicates how to deal with a pod if it doesn't satisfy the spread constraint. - DoNotSchedule (default) tells the scheduler not to schedule it. - ScheduleAnyway tells the scheduler to schedule the pod in any location,

+

but giving higher precedence to topologies that would help reduce the

+

skew.

+

A constraint is considered "Unsatisfiable" for an incoming pod if and only if every possible node assignment for that pod would violate "MaxSkew" on some topology. For example, in a 3-zone cluster, MaxSkew is set to 1, and pods with the same labelSelector spread as 3/1/1: | zone1 | zone2 | zone3 | | P P P | P | P | If WhenUnsatisfiable is set to DoNotSchedule, incoming pod can only be scheduled to zone2(zone3) to become 3/2/1(3/1/2) as ActualSkew(2-1) on zone2(zone3) satisfies MaxSkew(1). In other words, the cluster can still be imbalanced, but scheduler won't make it more imbalanced. It's a required field.

+

Possible enum values:

+
  • "DoNotSchedule" instructs the scheduler not to schedule the pod when constraints are not satisfied.
  • "ScheduleAnyway" instructs the scheduler to schedule the pod even if constraints are not satisfied.
+
+
+ +
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Table 116 io.cci.otc.api.pkg.apis.versioned.cci.v2.Volume

Parameter

+

Type

+

Description

+

configMap

+

io.cci.otc.api.pkg.apis.versioned.cci.v2.ConfigMapVolumeSource object

+

configMap represents a configMap that should populate this volume

+

downwardAPI

+

io.cci.otc.api.pkg.apis.versioned.cci.v2.DownwardAPIVolumeSource object

+

downwardAPI represents downward API about the pod that should

+

populate this volume

+

emptyDir

+

io.cci.otc.api.pkg.apis.versioned.cci.v2.EmptyDirVolumeSource object

+

emptyDir represents a temporary directory that shares a pod's lifetime. More info: https://kubernetes.io/docs/concepts/storage/volumes#emptydir

+

ephemeral

+

io.cci.otc.api.pkg.apis.versioned.cci.v2.EphemeralVolumeSource object

+

ephemeral represents a volume that is handled by a cluster storage driver. The volume's lifecycle is tied to the pod that defines it - it will be created before the pod starts, and deleted when the pod is removed.

+

Use this if: a) the volume is only needed while the pod runs, b) features of normal volumes like restoring from snapshot or capacity

+

tracking are needed,

+

c) the storage driver is specified through a storage class, and d) the storage driver supports dynamic volume provisioning through

+

a PersistentVolumeClaim (see EphemeralVolumeSource for more

+

information on the connection between this volume type

+

and PersistentVolumeClaim).

+

Use PersistentVolumeClaim or one of the vendor-specific APIs for volumes that persist for longer than the lifecycle of an individual pod.

+

Use CSI for light-weight local ephemeral volumes if the CSI driver is meant to be used that way - see the documentation of the driver for more information.

+

A pod can use both types of ephemeral volumes and persistent volumes at the same time.

+

name

+

String

+

name of the volume. Must be a DNS_LABEL and unique within the pod. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names

+

nfs

+

io.cci.otc.api.pkg.apis.versioned.cci.v2.NFSVolumeSource object

+

nfs represents an NFS mount on the host that shares a pod's lifetime More info: https://kubernetes.io/docs/concepts/storage/volumes#nfs

+

persistentVolumeClaim

+

io.cci.otc.api.pkg.apis.versioned.cci.v2.PersistentVolumeClaimVolumeSource object

+

persistentVolumeClaimVolumeSource represents a reference to a PersistentVolumeClaim in the same namespace. More info: https://kubernetes.io/docs/concepts/storage/persistent-volumes#persistentvolumeclaims

+

projected

+

io.cci.otc.api.pkg.apis.versioned.cci.v2.ProjectedVolumeSource object

+

projected items for all in one resources secrets, configmaps,

+

and downward API

+

secret

+

io.cci.otc.api.pkg.apis.versioned.cci.v2.SecretVolumeSource object

+

secret represents a secret that should populate this volume. More info: https://kubernetes.io/docs/concepts/storage/volumes#secret

+
+
+ +
+ + + + + + + + + + + + + + + + + + + + + +
Table 117 io.cci.otc.api.pkg.apis.versioned.cci.v2.ConfigMapVolumeSource

Parameter

+

Type

+

Description

+

defaultMode

+

Integer

+

defaultMode is optional: mode bits used to set permissions on created files by default. Must be an octal value between 0000 and 0777 or a decimal value between 0 and 511. YAML accepts both octal and decimal values, JSON requires decimal values for mode bits. Defaults to 0644. Directories within the path are not affected by this setting. This might be in conflict with other options that affect the file mode, like fsGroup, and the result can be other mode bits set.

+

items

+

Array of io.cci.otc.api.pkg.apis.versioned.cci.v2.KeyToPath objects

+

items if unspecified, each key-value pair in the Data field of

+

the referenced ConfigMap will be projected into the volume as a file whose

+

name is the key and content is the value. If specified, the listed keys

+

will be projected into the specified paths, and unlisted keys will not be

+

present. If a key is specified which is not present in the ConfigMap, the

+

volume setup will error unless it is marked optional. Paths must be relative

+

and may not contain the '..' path or start with '..'.

+

name

+

String

+

Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names

+

optional

+

Boolean

+

optional specify whether the ConfigMap or its keys must be defined

+
+
+ +
+ + + + + + + + + + + + + +
Table 118 io.cci.otc.api.pkg.apis.versioned.cci.v2.DownwardAPIVolumeSource

Parameter

+

Type

+

Description

+

defaultMode

+

Integer

+

Optional: mode bits to use on created files by default. Must be a Optional: mode bits used to set permissions on created files by default. Must be an octal value between 0000 and 0777 or a decimal value between 0 and 511. YAML accepts both octal and decimal values, JSON requires decimal values for mode bits. Defaults to 0644. Directories within the path are not affected by this setting. This might be in conflict with other options that affect the file mode, like fsGroup, and the result can be other mode bits set.

+

items

+

Array of io.cci.otc.api.pkg.apis.versioned.cci.v2.DownwardAPIVolumeFile objects

+

Items is a list of downward API volume file

+
+
+ +
+ + + + + + + + + + + + + +
Table 119 io.cci.otc.api.pkg.apis.versioned.cci.v2.EmptyDirVolumeSource

Parameter

+

Type

+

Description

+

medium

+

String

+

medium represents what type of storage medium should back this directory. The default is "" which means to use the node's default medium. Must be an empty string (default) or Memory. More info: https://kubernetes.io/docs/concepts/storage/volumes#emptydir

+

sizeLimit

+

String

+

sizeLimit is the total amount of local storage required for this EmptyDir volume. The size limit is also applicable for memory medium. The maximum usage on memory medium EmptyDir would be the minimum value between the SizeLimit specified here and the sum of memory limits of all containers in a pod. The default is nil which means that the limit is undefined. More info: http://kubernetes.io/docs/user-guide/volumes#emptydir

+
+
+ +
+ + + + + + + + + +
Table 120 io.cci.otc.api.pkg.apis.versioned.cci.v2.EphemeralVolumeSource

Parameter

+

Type

+

Description

+

volumeClaimTemplate

+

io.cci.otc.api.pkg.apis.versioned.cci.v2.PersistentVolumeClaimTemplate object

+

Will be used to create a stand-alone PVC to provision the volume. The pod in which this EphemeralVolumeSource is embedded will be the owner of the PVC, i.e. the PVC will be deleted together with the pod. The name of the PVC will be <pod name>-<volume name> where <volume name> is the name from the PodSpec.Volumes array entry. Pod validation will reject the pod if the concatenated name is not valid for a PVC (for example, too long).

+

An existing PVC with that name that is not owned by the pod will not be used for the pod to avoid using an unrelated volume by mistake. Starting the pod is then blocked until the unrelated PVC is removed. If such a pre-created PVC is meant to be used by the pod, the PVC has to updated with an owner reference to the pod once the pod exists. Normally this should not be necessary, but it may be useful when manually reconstructing a broken cluster.

+

This field is read-only and no changes will be made by Kubernetes to the PVC after it has been created.

+

Required, must not be nil.

+
+
+ +
+ + + + + + + + + + + + + +
Table 121 io.cci.otc.api.pkg.apis.versioned.cci.v2.PersistentVolumeClaimTemplate

Parameter

+

Type

+

Description

+

metadata

+

io.k8s.apimachinery.pkg.apis.meta.v1.ObjectMeta object

+

May contain labels and annotations that will be copied into the

+

PVC when creating it. No other fields are allowed and will be rejected during

+

validation.

+

spec

+

io.cci.otc.api.pkg.apis.versioned.cci.v2.PersistentVolumeClaimSpec object

+

The specification for the PersistentVolumeClaim. The entire content

+

is copied unchanged into the PVC that gets created from this template. The

+

same fields as in a PersistentVolumeClaim are also valid here.

+
+
+ +
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Table 122 io.k8s.apimachinery.pkg.apis.meta.v1.ObjectMeta

Parameter

+

Type

+

Description

+

annotations

+

Map<String,String>

+

Annotations is an unstructured key value map stored with a resource that may be set by external tools to store and retrieve arbitrary metadata. They are not queryable and should be preserved when modifying objects. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/annotations/

+

clusterName

+

String

+

The name of the cluster which the object belongs to. This is

+

used to distinguish resources with same name and namespace in different

+

clusters. This field is not set anywhere right now and apiserver is going

+

to ignore it if set in create or update request.

+

creationTimestamp

+

String

+

CreationTimestamp is a timestamp representing the server time when this object was created. It is not guaranteed to be set in happens-before order across separate operations. Clients may not set this value. It is represented in RFC3339 form and is in UTC.

+

Populated by the system. Read-only. Null for lists. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata

+

deletionGracePeriodSeconds

+

Long

+

Number of seconds allowed for this object to gracefully terminate

+

before it will be removed from the system. Only set when deletionTimestamp

+

is also set. May only be shortened. Read-only.

+

deletionTimestamp

+

String

+

DeletionTimestamp is RFC 3339 date and time at which this resource will be deleted. This field is set by the server when a graceful deletion is requested by the user, and is not directly settable by a client. The resource is expected to be deleted (no longer visible from resource lists, and not reachable by name) after the time in this field, once the finalizers list is empty. As long as the finalizers list contains items, deletion is blocked. Once the deletionTimestamp is set, this value may not be unset or be set further into the future, although it may be shortened or the resource may be deleted prior to this time. For example, a user may request that a pod is deleted in 30 seconds. The Kubelet will react by sending a graceful termination signal to the containers in the pod. After that 30 seconds, the Kubelet will send a hard termination signal (SIGKILL) to the container and after cleanup, remove the pod from the API. In the presence of network partitions, this object may still exist after this timestamp, until an administrator or automated process can determine the resource is fully terminated. If not set, graceful deletion of the object has not been requested.

+

Populated by the system when a graceful deletion is requested. Read-only. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata

+

enable

+

Boolean

+

Enable identifies whether the resource is available

+

finalizers

+

Array of strings

+

Must be empty before the object is deleted from the registry.

+

Each entry is an identifier for the responsible component that will remove

+

the entry from the list. If the deletionTimestamp of the object is non-nil,

+

entries in this list can only be removed. Finalizers may be processed and

+

removed in any order. Order is NOT enforced because it introduces significant

+

risk of stuck finalizers. finalizers is a shared field, any actor with permission

+

can reorder it. If the finalizer list is processed in order, then this can

+

lead to a situation in which the component responsible for the first finalizer

+

in the list is waiting for a signal (field value, external system, or other)

+

produced by a component responsible for a finalizer later in the list, resulting

+

in a deadlock. Without enforced ordering finalizers are free to order amongst

+

themselves and are not vulnerable to ordering changes in the list.

+

generateName

+

String

+

GenerateName is an optional prefix, used by the server, to generate a unique name ONLY IF the Name field has not been provided. If this field is used, the name returned to the client will be different than the name passed. This value will also be combined with a unique suffix. The provided value has the same validation rules as the Name field, and may be truncated by the length of the suffix required to make the value unique on the server.

+

If this field is specified and the generated name exists, the server will NOT return a 409 - instead, it will either return 201 Created or 500 with Reason ServerTimeout indicating a unique name could not be found in the time allotted, and the client should retry (optionally after the time indicated in the Retry-After header).

+

Applied only if Name is not specified. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#idempotency

+

generation

+

Long

+

A sequence number representing a specific generation of the desired

+

state. Populated by the system. Read-only.

+

labels

+

Map<String,String>

+

Map of string keys and values that can be used to organize and categorize (scope and select) objects. May match selectors of replication controllers and services. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/labels/

+

managedFields

+

Array of io.k8s.apimachinery.pkg.apis.meta.v1.ManagedFieldsEntry objects

+

ManagedFields maps workflow-id and version to the set of fields

+

that are managed by that workflow. This is mostly for internal housekeeping,

+

and users typically shouldn't need to set or understand this field. A workflow

+

can be the user's name, a controller's name, or the name of a specific apply

+

path like "ci-cd". The set of fields is always in the version that the workflow

+

used when modifying the object.

+

name

+

String

+

Name must be unique within a namespace. Is required when creating resources, although some resources may allow a client to request the generation of an appropriate name automatically. Name is primarily intended for creation idempotence and configuration definition. Cannot be updated. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names

+

namespace

+

String

+

Namespace defines the space within which each name must be unique. An empty namespace is equivalent to the "default" namespace, but "default" is the canonical representation. Not all objects are required to be scoped to a namespace - the value of this field for those objects will be empty.

+

Must be a DNS_LABEL. Cannot be updated. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/namespaces/

+

ownerReferences

+

Array of io.k8s.apimachinery.pkg.apis.meta.v1.OwnerReference objects

+

List of objects depended by this object. If ALL objects in the

+

list have been deleted, this object will be garbage collected. If this object

+

is managed by a controller, then an entry in this list will point to this

+

controller, with the controller field set to true. There cannot be more

+

than one managing controller.

+

resourceVersion

+

String

+

An opaque value that represents the internal version of this object that can be used by clients to determine when objects have changed. May be used for optimistic concurrency, change detection, and the watch operation on a resource or set of resources. Clients must treat these values as opaque and passed unmodified back to the server. They may only be valid for a particular resource or set of resources.

+

Populated by the system. Read-only. Value must be treated as opaque by clients and . More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#concurrency-control-and-consistency

+

selfLink

+

String

+

SelfLink is a URL representing this object. Populated by the system. Read-only.

+

DEPRECATED Kubernetes will stop propagating this field in 1.20 release and the field is planned to be removed in 1.21 release.

+

uid

+

String

+

UID is the unique in time and space value for this object. It is typically generated by the server on successful creation of a resource and is not allowed to change on PUT operations.

+

Populated by the system. Read-only. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#uids

+
+
+ +
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Table 123 io.k8s.apimachinery.pkg.apis.meta.v1.ManagedFieldsEntry

Parameter

+

Type

+

Description

+

apiVersion

+

String

+

APIVersion defines the version of this resource that this field

+

set applies to. The format is "group/version" just like the top-level APIVersion

+

field. It is necessary to track the version of a field set because it cannot

+

be automatically converted.

+

fieldsType

+

String

+

FieldsType is the discriminator for the different fields format and version. There is currently only one possible value: "FieldsV1"

+

fieldsV1

+

Object

+

FieldsV1 holds the first JSON version format as described in

+

the "FieldsV1" type.

+

manager

+

String

+

Manager is an identifier of the workflow managing these fields.

+

operation

+

String

+

Operation is the type of operation which lead to this ManagedFieldsEntry

+

being created. The only valid values for this field are 'Apply' and 'Update'.

+

time

+

String

+

Time is timestamp of when these fields were set. It should always

+

be empty if Operation is 'Apply'

+
+
+ +
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Table 124 io.k8s.apimachinery.pkg.apis.meta.v1.OwnerReference

Parameter

+

Type

+

Description

+

apiVersion

+

String

+

API version of the referent.

+

blockOwnerDeletion

+

Boolean

+

If true, AND if the owner has the "foregroundDeletion" finalizer,

+

then the owner cannot be deleted from the key-value store until this reference

+

is removed. Defaults to false. To set this field, a user needs "delete"

+

permission of the owner, otherwise 422 (Unprocessable Entity) will be returned.

+

controller

+

Boolean

+

If true, this reference points to the managing controller.

+

kind

+

String

+

Kind of the referent. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds

+

name

+

String

+

Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names

+

uid

+

String

+

UID of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#uids

+
+
+ +
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Table 125 io.cci.otc.api.pkg.apis.versioned.cci.v2.PersistentVolumeClaimSpec

Parameter

+

Type

+

Description

+

accessModes

+

Array of strings

+

accessModes contains the desired access modes the volume should have. More info: https://kubernetes.io/docs/concepts/storage/persistent-volumes#access-modes-1

+

dataSource

+

io.cci.otc.api.pkg.apis.versioned.cci.v2.TypedLocalObjectReference object

+

dataSource field can be used to specify either: * An existing VolumeSnapshot object (snapshot.storage.k8s.io/VolumeSnapshot) * An existing PVC (PersistentVolumeClaim) If the provisioner or an external controller can support the specified data source, it will create a new volume based on the contents of the specified data source. If the AnyVolumeDataSource feature gate is enabled, this field will always have the same contents as the DataSourceRef field.

+

dataSourceRef

+

io.cci.otc.api.pkg.apis.versioned.cci.v2.TypedLocalObjectReference object

+

dataSourceRef specifies the object from which to populate the volume with data, if a non-empty volume is desired. This may be any local object from a non-empty API group (non core object) or a PersistentVolumeClaim object. When this field is specified, volume binding will only succeed if the type of the specified object matches some installed volume populator or dynamic provisioner. This field will replace the functionality of the DataSource field and as such if both fields are non-empty, they must have the same value. For backwards compatibility, both fields (DataSource and DataSourceRef) will be set to the same value automatically if one of them is empty and the other is non-empty. There are two important differences between DataSource and DataSourceRef: * While DataSource only allows two specific types of objects, DataSourceRef

+

allows any non-core object, as well as PersistentVolumeClaim objects.

+
  • While DataSource ignores disallowed values (dropping them), DataSourceRef

    preserves all values, and generates an error if a disallowed value is

    +

    specified.

    +

    (Beta) Using this field requires the AnyVolumeDataSource feature gate to be enabled.

    +
+

resources

+

io.cci.otc.api.pkg.apis.versioned.cci.v2.ResourceRequirements object

+

resources represents the minimum resources the volume should have. If RecoverVolumeExpansionFailure feature is enabled users are allowed to specify resource requirements that are lower than previous value but must still be higher than capacity recorded in the status field of the claim. More info: https://kubernetes.io/docs/concepts/storage/persistent-volumes#resources

+

selector

+

io.k8s.apimachinery.pkg.apis.meta.v1.LabelSelector object

+

selector is a label query over volumes to consider for binding.

+

storageClassName

+

String

+

storageClassName is the name of the StorageClass required by the claim. More info: https://kubernetes.io/docs/concepts/storage/persistent-volumes#class-1

+

volumeMode

+

String

+

volumeMode defines what type of volume is required by the claim.

+

Value of Filesystem is implied when not included in claim spec.

+

volumeName

+

String

+

volumeName is the binding reference to the PersistentVolume backing

+

this claim.

+
+
+ +
+ + + + + + + + + + + + + + + + + +
Table 126 io.cci.otc.api.pkg.apis.versioned.cci.v2.TypedLocalObjectReference

Parameter

+

Type

+

Description

+

apiGroup

+

String

+

APIGroup is the group for the resource being referenced. If APIGroup

+

is not specified, the specified Kind must be in the core API group. For

+

any other third-party types, APIGroup is required.

+

kind

+

String

+

Kind is the type of resource being referenced

+

name

+

String

+

Name is the name of resource being referenced

+
+
+ +
+ + + + + + + + + + + + + +
Table 127 io.cci.otc.api.pkg.apis.versioned.cci.v2.ResourceRequirements

Parameter

+

Type

+

Description

+

limits

+

Map<String,String>

+

Limits describes the maximum amount of compute resources allowed. More info: https://kubernetes.io/docs/concepts/configuration/manage-resources-containers/

+

requests

+

Map<String,String>

+

Requests describes the minimum amount of compute resources required. If Requests is omitted for a container, it defaults to Limits if that is explicitly specified, otherwise to an implementation-defined value. More info: https://kubernetes.io/docs/concepts/configuration/manage-resources-containers/

+
+
+ +
+ + + + + + + + + +
Table 128 io.k8s.apimachinery.pkg.api.resource.Quantity

Parameter

+

Type

+

Description

+

-

+

String

+

Quantity is a fixed-point representation of a number. It provides convenient marshaling/unmarshaling in JSON and YAML, in addition to String() and AsInt64() accessors.

+

The serialization format is:

+

[/topic/body/section/table/tgroup/tbody/row/entry/p/br {""}) (br] ::= [/topic/body/section/table/tgroup/tbody/row/entry/p/br {""}) (br][/topic/body/section/table/tgroup/tbody/row/entry/p/br {""}) (br]

+

(Note that [/topic/body/section/table/tgroup/tbody/row/entry/p/br {""}) (br] may be empty, from the "" case in [/topic/body/section/table/tgroup/tbody/row/entry/p/br {""}) (br].)

+

[/topic/body/section/table/tgroup/tbody/row/entry/p/br {""}) (br] ::= 0 | 1 | ... | 9 [/topic/body/section/table/tgroup/tbody/row/entry/p/br {""}) (br] ::= [/topic/body/section/table/tgroup/tbody/row/entry/p/br {""}) (br] | [/topic/body/section/table/tgroup/tbody/row/entry/p/br {""}) (br][/topic/body/section/table/tgroup/tbody/row/entry/p/br {""}) (br] [/topic/body/section/table/tgroup/tbody/row/entry/p/br {""}) (br] ::= [/topic/body/section/table/tgroup/tbody/row/entry/p/br {""}) (br] | [/topic/body/section/table/tgroup/tbody/row/entry/p/br {""}) (br].[/topic/body/section/table/tgroup/tbody/row/entry/p/br {""}) (br] | [/topic/body/section/table/tgroup/tbody/row/entry/p/br {""}) (br]. | .[/topic/body/section/table/tgroup/tbody/row/entry/p/br {""}) (br] [/topic/body/section/table/tgroup/tbody/row/entry/p/br {""}) (br] ::= "+" | "-" [/topic/body/section/table/tgroup/tbody/row/entry/p/br {""}) (br] ::= [/topic/body/section/table/tgroup/tbody/row/entry/p/br {""}) (br] | [/topic/body/section/table/tgroup/tbody/row/entry/p/br {""}) (br][/topic/body/section/table/tgroup/tbody/row/entry/p/br {""}) (br] [/topic/body/section/table/tgroup/tbody/row/entry/p/br {""}) (br] ::= [/topic/body/section/table/tgroup/tbody/row/entry/p/br {""}) (br] | [/topic/body/section/table/tgroup/tbody/row/entry/p/br {""}) (br] | [/topic/body/section/table/tgroup/tbody/row/entry/p/br {""}) (br] [/topic/body/section/table/tgroup/tbody/row/entry/p/br {""}) (br] ::= Ki | Mi | Gi | Ti | Pi | Ei

+

(International System of units; See: http://physics.nist.gov/cuu/Units/binary.html)

+

[/topic/body/section/table/tgroup/tbody/row/entry/p/br {""}) (br] ::= m | "" | k | M | G | T | P | E

+

(Note that 1024 = 1Ki but 1000 = 1k; I didn't choose the capitalization.)

+

[/topic/body/section/table/tgroup/tbody/row/entry/p/br {""}) (br] ::= "e" [/topic/body/section/table/tgroup/tbody/row/entry/p/br {""}) (br] | "E" [/topic/body/section/table/tgroup/tbody/row/entry/p/br {""}) (br]

+

No matter which of the three exponent forms is used, no quantity may represent a number greater than 2^63-1 in magnitude, nor may it have more than 3 decimal places. Numbers larger or more precise will be capped or rounded up. (E.g.: 0.1m will rounded up to 1m.) This may be extended in the future if we require larger or smaller quantities.

+

When a Quantity is parsed from a string, it will remember the type of suffix it had, and will use the same type again when it is serialized.

+

Before serializing, Quantity will be put in "canonical form". This means that Exponent/suffix will be adjusted up or down (with a corresponding increase or decrease in Mantissa) such that:

+

a. No precision is lost

+

b. No fractional digits will be emitted

+

c. The exponent (or suffix) is as large as possible.

+

The sign will be omitted unless the number is negative.

+

Examples:

+

1.5 will be serialized as "1500m"

+

1.5Gi will be serialized as "1536Mi"

+

Note that the quantity will NEVER be internally represented by a floating point number. That is the whole point of this exercise.

+

Non-canonical values will still parse as long as they are well formed, but will be re-emitted in their canonical form. (So always use canonical form, or don't diff.)

+

This format is intended to make it difficult to use these numbers without writing some sort of special handling code in the hopes that that will cause implementors to also use a fixed point implementation.

+
+
+ +
+ + + + + + + + + + + + + +
Table 129 io.k8s.apimachinery.pkg.apis.meta.v1.LabelSelector

Parameter

+

Type

+

Description

+

matchExpressions

+

Array of io.k8s.apimachinery.pkg.apis.meta.v1.LabelSelectorRequirement objects

+

matchExpressions is a list of label selector requirements. The

+

requirements are ANDed.

+

matchLabels

+

Map<String,String>

+

matchLabels is a map of {key,value} pairs. A single {key,value}

+

in the matchLabels map is equivalent to an element of matchExpressions,

+

whose key field is "key", the operator is "In", and the values array contains

+

only "value". The requirements are ANDed.

+
+
+ +
+ + + + + + + + + + + + + + + + + +
Table 130 io.k8s.apimachinery.pkg.apis.meta.v1.LabelSelectorRequirement

Parameter

+

Type

+

Description

+

key

+

String

+

key is the label key that the selector applies to.

+

operator

+

String

+

operator represents a key's relationship to a set of values.

+

Valid operators are In, NotIn, Exists and DoesNotExist.

+

values

+

Array of strings

+

values is an array of string values. If the operator is In or

+

NotIn, the values array must be non-empty. If the operator is Exists or

+

DoesNotExist, the values array must be empty. This array is replaced during

+

a strategic merge patch.

+
+
+ +
+ + + + + + + + + + + + + + + + + +
Table 131 io.cci.otc.api.pkg.apis.versioned.cci.v2.NFSVolumeSource

Parameter

+

Type

+

Description

+

path

+

String

+

path that is exported by the NFS server. More info: https://kubernetes.io/docs/concepts/storage/volumes#nfs

+

readOnly

+

Boolean

+

readOnly here will force the NFS export to be mounted with read-only permissions. Defaults to false. More info: https://kubernetes.io/docs/concepts/storage/volumes#nfs

+

server

+

String

+

server is the hostname or IP address of the NFS server. More info: https://kubernetes.io/docs/concepts/storage/volumes#nfs

+
+
+ +
+ + + + + + + + + + + + + +
Table 132 io.cci.otc.api.pkg.apis.versioned.cci.v2.PersistentVolumeClaimVolumeSource

Parameter

+

Type

+

Description

+

claimName

+

String

+

claimName is the name of a PersistentVolumeClaim in the same namespace as the pod using this volume. More info: https://kubernetes.io/docs/concepts/storage/persistent-volumes#persistentvolumeclaims

+

readOnly

+

Boolean

+

readOnly Will force the ReadOnly setting in VolumeMounts. Default

+

false.

+
+
+ +
+ + + + + + + + + + + + + +
Table 133 io.cci.otc.api.pkg.apis.versioned.cci.v2.ProjectedVolumeSource

Parameter

+

Type

+

Description

+

defaultMode

+

Integer

+

defaultMode are the mode bits used to set permissions on created

+

files by default. Must be an octal value between 0000 and 0777 or a decimal

+

value between 0 and 511. YAML accepts both octal and decimal values, JSON

+

requires decimal values for mode bits. Directories within the path are not

+

affected by this setting. This might be in conflict with other options that

+

affect the file mode, like fsGroup, and the result can be other mode bits

+

set.

+

sources

+

Array of io.cci.otc.api.pkg.apis.versioned.cci.v2.VolumeProjection objects

+

sources is the list of volume projections

+
+
+ +
+ + + + + + + + + + + + + + + + + +
Table 134 io.cci.otc.api.pkg.apis.versioned.cci.v2.VolumeProjection

Parameter

+

Type

+

Description

+

configMap

+

io.cci.otc.api.pkg.apis.versioned.cci.v2.ConfigMapProjection object

+

configMap information about the configMap data to project

+

downwardAPI

+

io.cci.otc.api.pkg.apis.versioned.cci.v2.DownwardAPIProjection object

+

downwardAPI information about the downwardAPI data to project

+

secret

+

io.cci.otc.api.pkg.apis.versioned.cci.v2.SecretProjection object

+

secret information about the secret data to project

+
+
+ +
+ + + + + + + + + + + + + + + + + +
Table 135 io.cci.otc.api.pkg.apis.versioned.cci.v2.ConfigMapProjection

Parameter

+

Type

+

Description

+

items

+

Array of io.cci.otc.api.pkg.apis.versioned.cci.v2.KeyToPath objects

+

items if unspecified, each key-value pair in the Data field of

+

the referenced ConfigMap will be projected into the volume as a file whose

+

name is the key and content is the value. If specified, the listed keys

+

will be projected into the specified paths, and unlisted keys will not be

+

present. If a key is specified which is not present in the ConfigMap, the

+

volume setup will error unless it is marked optional. Paths must be relative

+

and may not contain the '..' path or start with '..'.

+

name

+

String

+

Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names

+

optional

+

Boolean

+

optional specify whether the ConfigMap or its keys must be defined

+
+
+ +
+ + + + + + + + + +
Table 136 io.cci.otc.api.pkg.apis.versioned.cci.v2.DownwardAPIProjection

Parameter

+

Type

+

Description

+

items

+

Array of io.cci.otc.api.pkg.apis.versioned.cci.v2.DownwardAPIVolumeFile objects

+

Items is a list of DownwardAPIVolume file

+
+
+ +
+ + + + + + + + + + + + + + + + + + + + + +
Table 137 io.cci.otc.api.pkg.apis.versioned.cci.v2.DownwardAPIVolumeFile

Parameter

+

Type

+

Description

+

fieldRef

+

io.cci.otc.api.pkg.apis.versioned.cci.v2.ObjectFieldSelector object

+

Required: Selects a field of the pod: only annotations, labels, name and namespace are supported.

+

mode

+

Integer

+

Optional: mode bits used to set permissions on this file, must be an octal value between 0000 and 0777 or a decimal value between 0 and 511. YAML accepts both octal and decimal values, JSON requires decimal values for mode bits. If not specified, the volume defaultMode will be used. This might be in conflict with other options that affect the file mode, like fsGroup, and the result can be other mode bits set.

+

path

+

String

+

Required: Path is the relative path name of the file to be created. Must not be absolute or contain the '..' path. Must be utf-8 encoded. The first item of the relative path must not start with '..'

+

resourceFieldRef

+

io.cci.otc.api.pkg.apis.versioned.cci.v2.ResourceFieldSelector object

+

Selects a resource of the container: only resources limits and requests (limits.cpu, limits.memory, requests.cpu and requests.memory) are currently supported.

+
+
+ +
+ + + + + + + + + + + + + +
Table 138 io.cci.otc.api.pkg.apis.versioned.cci.v2.ObjectFieldSelector

Parameter

+

Type

+

Description

+

apiVersion

+

String

+

Version of the schema the FieldPath is written in terms of, defaults

+

to "v1".

+

fieldPath

+

String

+

Path of the field to select in the specified API version.

+
+
+ +
+ + + + + + + + + + + + + + + + + +
Table 139 io.cci.otc.api.pkg.apis.versioned.cci.v2.ResourceFieldSelector

Parameter

+

Type

+

Description

+

containerName

+

String

+

Container name: required for volumes, optional for env vars

+

divisor

+

String

+

Specifies the output format of the exposed resources, defaults

+

to "1"

+

resource

+

String

+

Required: resource to select

+
+
+ +
+ + + + + + + + + + + + + + + + + +
Table 140 io.cci.otc.api.pkg.apis.versioned.cci.v2.SecretProjection

Parameter

+

Type

+

Description

+

items

+

Array of io.cci.otc.api.pkg.apis.versioned.cci.v2.KeyToPath objects

+

items if unspecified, each key-value pair in the Data field of

+

the referenced Secret will be projected into the volume as a file whose

+

name is the key and content is the value. If specified, the listed keys

+

will be projected into the specified paths, and unlisted keys will not be

+

present. If a key is specified which is not present in the Secret, the volume

+

setup will error unless it is marked optional. Paths must be relative and

+

may not contain the '..' path or start with '..'.

+

name

+

String

+

Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names

+

optional

+

Boolean

+

optional field specify whether the Secret or its key must be

+

defined

+
+
+ +
+ + + + + + + + + + + + + + + + + + + + + +
Table 141 io.cci.otc.api.pkg.apis.versioned.cci.v2.SecretVolumeSource

Parameter

+

Type

+

Description

+

defaultMode

+

Integer

+

defaultMode is Optional: mode bits used to set permissions on created files by default. Must be an octal value between 0000 and 0777 or a decimal value between 0 and 511. YAML accepts both octal and decimal values, JSON requires decimal values for mode bits. Defaults to 0644. Directories within the path are not affected by this setting. This might be in conflict with other options that affect the file mode, like fsGroup, and the result can be other mode bits set.

+

items

+

Array of io.cci.otc.api.pkg.apis.versioned.cci.v2.KeyToPath objects

+

items If unspecified, each key-value pair in the Data field of

+

the referenced Secret will be projected into the volume as a file whose

+

name is the key and content is the value. If specified, the listed keys

+

will be projected into the specified paths, and unlisted keys will not be

+

present. If a key is specified which is not present in the Secret, the volume

+

setup will error unless it is marked optional. Paths must be relative and

+

may not contain the '..' path or start with '..'.

+

optional

+

Boolean

+

optional field specify whether the Secret or its keys must be

+

defined

+

secretName

+

String

+

secretName is the name of the secret in the pod's namespace to use. More info: https://kubernetes.io/docs/concepts/storage/volumes#secret

+
+
+ +
+ + + + + + + + + + + + + + + + + +
Table 142 io.cci.otc.api.pkg.apis.versioned.cci.v2.KeyToPath

Parameter

+

Type

+

Description

+

key

+

String

+

key is the key to project.

+

mode

+

Integer

+

mode is Optional: mode bits used to set permissions on this file. Must be an octal value between 0000 and 0777 or a decimal value between 0 and 511. YAML accepts both octal and decimal values, JSON requires decimal values for mode bits. If not specified, the volume defaultMode will be used. This might be in conflict with other options that affect the file mode, like fsGroup, and the result can be other mode bits set.

+

path

+

String

+

path is the relative path of the file to map the key to. May

+

not be an absolute path. May not contain the path element '..'. May not

+

start with the string '..'.

+
+
+ +
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Table 143 io.cci.otc.api.pkg.apis.versioned.cci.v2.PodStatus

Parameter

+

Type

+

Description

+

conditions

+

Array of io.cci.otc.api.pkg.apis.versioned.cci.v2.PodCondition objects

+

Current service state of pod. More info: https://kubernetes.io/docs/concepts/workloads/pods/pod-lifecycle#pod-conditions

+

containerStatuses

+

Array of io.cci.otc.api.pkg.apis.versioned.cci.v2.ContainerStatus objects

+

The list has one entry per container in the manifest. More info: https://kubernetes.io/docs/concepts/workloads/pods/pod-lifecycle#pod-and-container-status

+

ephemeralContainerStatuses

+

Array of io.cci.otc.api.pkg.apis.versioned.cci.v2.ContainerStatus objects

+

Status for any ephemeral containers that have run in this pod.

+

hostIP

+

String

+

IP address of the host to which the pod is assigned. Empty if

+

not yet scheduled.

+

initContainerStatuses

+

Array of io.cci.otc.api.pkg.apis.versioned.cci.v2.ContainerStatus objects

+

The list has one entry per init container in the manifest. The most recent successful init container will have ready = true, the most recently started container will have startTime set. More info: https://kubernetes.io/docs/concepts/workloads/pods/pod-lifecycle#pod-and-container-status

+

message

+

String

+

A human readable message indicating details about why the pod

+

is in this condition.

+

nominatedNodeName

+

String

+

nominatedNodeName is set only when this pod preempts other pods

+

on the node, but it cannot be scheduled right away as preemption victims

+

receive their graceful termination periods. This field does not guarantee

+

that the pod will be scheduled on this node. Scheduler may decide to place

+

the pod elsewhere if other nodes become available sooner. Scheduler may

+

also decide to give the resources on this node to a higher priority pod

+

that is created after preemption. As a result, this field may be different

+

than PodSpec.nodeName when the pod is scheduled.

+

phase

+

String

+

The phase of a Pod is a simple, high-level summary of where the Pod is in its lifecycle. The conditions array, the reason and message fields, and the individual container status arrays contain more detail about the pod's status. There are five possible phase values:

+

Pending: The pod has been accepted by the Kubernetes system, but one or more of the container images has not been created. This includes time before being scheduled as well as time spent downloading images over the network, which could take a while. Running: The pod has been bound to a node, and all of the containers have been created. At least one container is still running, or is in the process of starting or restarting. Succeeded: All containers in the pod have terminated in success, and will not be restarted. Failed: All containers in the pod have terminated, and at least one container has terminated in failure. The container either exited with non-zero status or was terminated by the system. Unknown: For some reason the state of the pod could not be obtained, typically due to an error in communicating with the host of the pod.

+

More info: https://kubernetes.io/docs/concepts/workloads/pods/pod-lifecycle#pod-phase

+

Possible enum values:

+
  • "Failed" means that all containers in the pod have terminated, and at least one container has terminated in a failure (exited with a non-zero exit code or was stopped by the system).
  • "Pending" means the pod has been accepted by the system, but one or more of the containers has not been started. This includes time before being bound to a node, as well as time spent pulling images onto the host.
  • "Running" means the pod has been bound to a node and all of the containers have been started. At least one container is still running or is in the process of being restarted.
  • "Succeeded" means that all containers in the pod have voluntarily terminated with a container exit code of 0, and the system is not going to restart any of these containers.
  • "Unknown" means that for some reason the state of the pod could not be obtained, typically due to an error in communicating with the host of the pod. Deprecated: It isn't being set since 2015 (74da3b14b0c0f658b3bb8d2def5094686d0e9095)
+

podIP

+

String

+

IP address allocated to the pod. Routable at least within the

+

cluster. Empty if not yet allocated.

+

podIPs

+

Array of io.cci.otc.api.pkg.apis.versioned.cci.v2.PodIP objects

+

podIPs holds the IP addresses allocated to the pod. If this field

+

is specified, the 0th entry must match the podIP field. Pods may be allocated

+

at most 1 value for each of IPv4 and IPv6. This list is empty if no IPs

+

have been allocated yet.

+

qosClass

+

String

+

The Quality of Service (QOS) classification assigned to the pod based on resource requirements See PodQOSClass type for available QOS classes More info: https://git.k8s.io/community/contributors/design-proposals/node/resource-qos.md

+

Possible enum values:

+
  • "BestEffort" is the BestEffort qos class.
  • "Burstable" is the Burstable qos class.
  • "Guaranteed" is the Guaranteed qos class.
+

reason

+

String

+

A brief CamelCase message indicating details about why the pod

+

is in this state. e.g. 'Evicted'

+

startTime

+

String

+

RFC 3339 date and time at which the object was acknowledged by

+

the Kubelet. This is before the Kubelet pulled the container image(s) for

+

the pod.

+
+
+ +
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Table 144 io.cci.otc.api.pkg.apis.versioned.cci.v2.PodCondition

Parameter

+

Type

+

Description

+

lastProbeTime

+

String

+

Last time we probed the condition.

+

lastTransitionTime

+

String

+

Last time the condition transitioned from one status to another.

+

message

+

String

+

Human-readable message indicating details about last transition.

+

reason

+

String

+

Unique, one-word, CamelCase reason for the condition's last transition.

+

status

+

String

+

Status is the status of the condition. Can be True, False, Unknown. More info: https://kubernetes.io/docs/concepts/workloads/pods/pod-lifecycle#pod-conditions

+

type

+

String

+

Type is the type of the condition. More info: https://kubernetes.io/docs/concepts/workloads/pods/pod-lifecycle#pod-conditions

+
+
+ +
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Table 145 io.cci.otc.api.pkg.apis.versioned.cci.v2.ContainerStatus

Parameter

+

Type

+

Description

+

containerID

+

String

+

Container's ID in the format '[/topic/body/section/table/tgroup/tbody/row/entry/p/br {""}) (br]://<container_id>'.

+

image

+

String

+

The image the container is running. More info: https://kubernetes.io/docs/concepts/containers/images.

+

imageID

+

String

+

ImageID of the container's image.

+

lastState

+

io.cci.otc.api.pkg.apis.versioned.cci.v2.ContainerState object

+

Details about the container's last termination condition.

+

name

+

String

+

This must be a DNS_LABEL. Each container in a pod must have a

+

unique name. Cannot be updated.

+

ready

+

Boolean

+

Specifies whether the container has passed its readiness probe.

+

restartCount

+

Integer

+

The number of times the container has been restarted.

+

started

+

Boolean

+

Specifies whether the container has passed its startup probe.

+

Initialized as false, becomes true after startupProbe is considered successful.

+

Resets to false when the container is restarted, or if kubelet loses state

+

temporarily. Is always true when no startupProbe is defined.

+

state

+

io.cci.otc.api.pkg.apis.versioned.cci.v2.ContainerState object

+

Details about the container's current condition.

+
+
+ +
+ + + + + + + + + + + + + + + + + +
Table 146 io.cci.otc.api.pkg.apis.versioned.cci.v2.ContainerState

Parameter

+

Type

+

Description

+

running

+

io.cci.otc.api.pkg.apis.versioned.cci.v2.ContainerStateRunning object

+

Details about a running container

+

terminated

+

io.cci.otc.api.pkg.apis.versioned.cci.v2.ContainerStateTerminated object

+

Details about a terminated container

+

waiting

+

io.cci.otc.api.pkg.apis.versioned.cci.v2.ContainerStateWaiting object

+

Details about a waiting container

+
+
+ +
+ + + + + + + + + +
Table 147 io.cci.otc.api.pkg.apis.versioned.cci.v2.ContainerStateRunning

Parameter

+

Type

+

Description

+

startedAt

+

String

+

Time at which the container was last (re-)started

+
+
+ +
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Table 148 io.cci.otc.api.pkg.apis.versioned.cci.v2.ContainerStateTerminated

Parameter

+

Type

+

Description

+

containerID

+

String

+

Container's ID in the format '[/topic/body/section/table/tgroup/tbody/row/entry/p/br {""}) (br]://<container_id>'

+

exitCode

+

Integer

+

Exit status from the last termination of the container

+

finishedAt

+

String

+

Time at which the container last terminated

+

message

+

String

+

Message regarding the last termination of the container

+

reason

+

String

+

(brief) reason from the last termination of the container

+

signal

+

Integer

+

Signal from the last termination of the container

+

startedAt

+

String

+

Time at which previous execution of the container started

+
+
+ +
+ + + + + + + + + + + + + +
Table 149 io.cci.otc.api.pkg.apis.versioned.cci.v2.ContainerStateWaiting

Parameter

+

Type

+

Description

+

message

+

String

+

Message regarding why the container is not yet running.

+

reason

+

String

+

(brief) reason the container is not yet running.

+
+
+ +
+ + + + + + + + + +
Table 150 io.cci.otc.api.pkg.apis.versioned.cci.v2.PodIP

Parameter

+

Type

+

Description

+

ip

+

String

+

ip is an IP address (IPv4 or IPv6) assigned to the pod

+
+
+
+

Example Requests

Merge Patch, Content-Type: application/merge-patch+json

+
{
+  "metadata" : {
+    "labels" : {
+      "test-label-key" : "test-label-value"
+    }
+  }
+}
+
+

Example Responses

Status code: 200

+

OK

+
{
+  "apiVersion" : "cci/v2",
+  "kind" : "Pod",
+  "metadata" : {
+    "annotations" : {
+      "cni.yangtse.io/network-status" : "[{\"macAddress\":\"fa:16:3e:1d:75:3a\",\"ipv4Info\":{\"subnet\":\"192.168.0.0/24\",\"ipAddress\":\"192.168.0.197\",\"gateway\":\"192.168.0.1\"},\"name\":\"test-api\",\"portID\":\"b471658c-caac-4377-94f4-2eeff1192d2b\",\"ips\":[\"192.168.0.197\"],\"vlanID\":3687}]",
+      "networking.cci.io/vm-network-info" : "{\"vmID\":\"fda21659-a816-4449-abcf-193ac5a47b4a\",\"eniID\":\"ec9f8fae-ae74-445b-b8bb-b533e5342dbd\",\"maxEniNum\":2,\"maxSubEniNum\":16}",
+      "openvessel.io/monitoring-aominfo" : "08a2*************************c03:4257ecf3-7c47-43a3-86d2-d2b4d4aa3a20",
+      "resource.cci.io/pod-size-specs" : "2.00_4.0",
+      "resource.cci.io/size" : "2.00_4.0",
+      "scheduling.k8s.io/group-name" : "podgroup-ade5799e-9371-4c9f-ab77-0472e97211f8",
+      "tenant.cci.io/tenant-id" : "08a2*************************c03",
+      "topology.kubernetes.io/region" : "region1",
+      "topology.kubernetes.io/zone" : "region1c"
+    },
+    "creationTimestamp" : "2024-10-09T16:11:23Z",
+    "finalizers" : [ "billing.kubernetes.io/podbilling-finalizer" ],
+    "labels" : {
+      "scheduling.cci.io/vmid" : "fda21659-a816-4449-abcf-193ac5a47b4a",
+      "sys_enterprise_project_id" : "0",
+      "tenant.cci.io/tenant-id" : "08a2*************************c03",
+      "tenant.kubernetes.io/domain-id" : "08a*************************ee60",
+      "tenant.kubernetes.io/project-id" : "08a2*************************c03",
+      "test-label-key" : "test-label-value"
+    },
+    "name" : "test",
+    "namespace" : "test-api",
+    "resourceVersion" : "391110951",
+    "uid" : "ade5799e-9371-4c9f-ab77-0472e97211f8"
+  },
+  "spec" : {
+    "containers" : [ {
+      "env" : [ {
+        "name" : "ENV1",
+        "value" : "false"
+      }, {
+        "name" : "ENV2",
+        "value" : "xxx"
+      } ],
+      "image" : "nginx:latest",
+      "name" : "deploy-example",
+      "resources" : {
+        "limits" : {
+          "cpu" : "500m",
+          "memory" : "1Gi"
+        },
+        "requests" : {
+          "cpu" : "500m",
+          "memory" : "1Gi"
+        }
+      },
+      "terminationMessagePath" : "/dev/termination-log",
+      "terminationMessagePolicy" : "File"
+    } ],
+    "dnsPolicy" : "Default",
+    "imagePullSecrets" : [ {
+      "name" : "imagepull-secret"
+    } ],
+    "nodeName" : "compute-cell-001",
+    "restartPolicy" : "Always",
+    "schedulerName" : "volcano",
+    "securityContext" : { },
+    "terminationGracePeriodSeconds" : 30
+  },
+  "status" : {
+    "conditions" : [ {
+      "lastProbeTime" : null,
+      "lastTransitionTime" : "2024-10-09T16:11:24Z",
+      "status" : "True",
+      "type" : "Initialized"
+    }, {
+      "lastProbeTime" : null,
+      "lastTransitionTime" : "2024-10-09T16:11:28Z",
+      "status" : "True",
+      "type" : "Ready"
+    }, {
+      "lastProbeTime" : null,
+      "lastTransitionTime" : "2024-10-09T16:11:28Z",
+      "status" : "True",
+      "type" : "ContainersReady"
+    }, {
+      "lastProbeTime" : null,
+      "lastTransitionTime" : "2024-10-09T16:11:23Z",
+      "status" : "True",
+      "type" : "PodScheduled"
+    } ],
+    "containerStatuses" : [ {
+      "containerID" : "containerd://a44eef6b753babaff802d212e78afef2422959e90bd79ab5b385adb302aa3d1e",
+      "image" : "nginx:latest",
+      "imageID" : "docker.io/library/nginx@sha256:416d511ffa63777489af47f250b70d1570e428b67666567085f2bece3571ad83",
+      "lastState" : { },
+      "name" : "deploy-example",
+      "ready" : true,
+      "restartCount" : 0,
+      "started" : true,
+      "state" : {
+        "running" : {
+          "startedAt" : "2024-10-09T16:11:27Z"
+        }
+      }
+    } ],
+    "phase" : "Running",
+    "podIP" : "192.168.0.197",
+    "podIPs" : [ {
+      "ip" : "192.168.0.197"
+    } ],
+    "qosClass" : "Guaranteed",
+    "startTime" : "2024-10-09T16:11:24Z"
+  }
+}
+
+

Status Codes

+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +

Status Code

+

Description

+

200

+

OK

+

201

+

Created

+

400

+

BadRequest

+

401

+

Unauthorized

+

403

+

Forbidden

+

404

+

NotFound

+

405

+

MethodNotAllowed

+

406

+

NotAcceptable

+

409

+

Conflict

+

415

+

UnsupportedMediaType

+

422

+

Invalid

+

429

+

TooManyRequests

+

500

+

InternalError

+

503

+

ServiceUnavailable

+

504

+

ServerTimeout

+
+
+
+
+
+
+
Parent topic: Proprietary APIs
+
+
+ diff --git a/docs/cci/api-ref/pro_ys.html b/docs/cci/api-ref/pro_ys.html new file mode 100644 index 00000000..607d16ba --- /dev/null +++ b/docs/cci/api-ref/pro_ys.html @@ -0,0 +1,27 @@ + + +

Notes and Constraints

+

Regions

CCI is available in regions listed in Table 1.

+ +
+ + + + + + + +
Table 1 Supported regions

Region Name

+

Region

+

EU-Magdeburg/Biere

+

eu-de

+
+
+
+
+
+
+
Parent topic: Appendix
+
+
+ diff --git a/docs/cci/api-ref/public_sys-resources/caution_3.0-en-us.png b/docs/cci/api-ref/public_sys-resources/caution_3.0-en-us.png new file mode 100644 index 00000000..60f60762 Binary files /dev/null and b/docs/cci/api-ref/public_sys-resources/caution_3.0-en-us.png differ diff --git a/docs/cci/api-ref/public_sys-resources/danger_3.0-en-us.png b/docs/cci/api-ref/public_sys-resources/danger_3.0-en-us.png new file mode 100644 index 00000000..47a9c723 Binary files /dev/null and b/docs/cci/api-ref/public_sys-resources/danger_3.0-en-us.png differ diff --git a/docs/cci/api-ref/public_sys-resources/delta.gif b/docs/cci/api-ref/public_sys-resources/delta.gif new file mode 100644 index 00000000..0d1b1f67 Binary files /dev/null and b/docs/cci/api-ref/public_sys-resources/delta.gif differ diff --git a/docs/cci/api-ref/public_sys-resources/deltaend.gif b/docs/cci/api-ref/public_sys-resources/deltaend.gif new file mode 100644 index 00000000..cc7da0fc Binary files /dev/null and b/docs/cci/api-ref/public_sys-resources/deltaend.gif differ diff --git a/docs/cci/api-ref/public_sys-resources/icon-arrowdn.gif b/docs/cci/api-ref/public_sys-resources/icon-arrowdn.gif new file mode 100644 index 00000000..37942803 Binary files /dev/null and b/docs/cci/api-ref/public_sys-resources/icon-arrowdn.gif differ diff --git a/docs/cci/api-ref/public_sys-resources/icon-arrowrt.gif b/docs/cci/api-ref/public_sys-resources/icon-arrowrt.gif new file mode 100644 index 00000000..6aaaa11c Binary files /dev/null and b/docs/cci/api-ref/public_sys-resources/icon-arrowrt.gif differ diff --git a/docs/cci/api-ref/public_sys-resources/icon-caution.gif b/docs/cci/api-ref/public_sys-resources/icon-caution.gif new file mode 100644 index 00000000..079c79b2 Binary files /dev/null and b/docs/cci/api-ref/public_sys-resources/icon-caution.gif differ diff --git a/docs/cci/api-ref/public_sys-resources/icon-danger.gif b/docs/cci/api-ref/public_sys-resources/icon-danger.gif new file mode 100644 index 00000000..079c79b2 Binary files /dev/null and b/docs/cci/api-ref/public_sys-resources/icon-danger.gif differ diff --git a/docs/cci/api-ref/public_sys-resources/icon-huawei.gif b/docs/cci/api-ref/public_sys-resources/icon-huawei.gif new file mode 100644 index 00000000..a31d60f8 Binary files /dev/null and b/docs/cci/api-ref/public_sys-resources/icon-huawei.gif differ diff --git a/docs/cci/api-ref/public_sys-resources/icon-note.gif b/docs/cci/api-ref/public_sys-resources/icon-note.gif new file mode 100644 index 00000000..31be2b03 Binary files /dev/null and b/docs/cci/api-ref/public_sys-resources/icon-note.gif differ diff --git a/docs/cci/api-ref/public_sys-resources/icon-notice.gif b/docs/cci/api-ref/public_sys-resources/icon-notice.gif new file mode 100644 index 00000000..40907065 Binary files /dev/null and b/docs/cci/api-ref/public_sys-resources/icon-notice.gif differ diff --git a/docs/cci/api-ref/public_sys-resources/icon-tip.gif b/docs/cci/api-ref/public_sys-resources/icon-tip.gif new file mode 100644 index 00000000..c47bae05 Binary files /dev/null and b/docs/cci/api-ref/public_sys-resources/icon-tip.gif differ diff --git a/docs/cci/api-ref/public_sys-resources/icon-warning.gif b/docs/cci/api-ref/public_sys-resources/icon-warning.gif new file mode 100644 index 00000000..079c79b2 Binary files /dev/null and b/docs/cci/api-ref/public_sys-resources/icon-warning.gif differ diff --git a/docs/cci/api-ref/public_sys-resources/note_3.0-en-us.png b/docs/cci/api-ref/public_sys-resources/note_3.0-en-us.png new file mode 100644 index 00000000..57a0e1f5 Binary files /dev/null and b/docs/cci/api-ref/public_sys-resources/note_3.0-en-us.png differ diff --git a/docs/cci/api-ref/public_sys-resources/notice_3.0-en-us.png b/docs/cci/api-ref/public_sys-resources/notice_3.0-en-us.png new file mode 100644 index 00000000..fa4b6499 Binary files /dev/null and b/docs/cci/api-ref/public_sys-resources/notice_3.0-en-us.png differ diff --git a/docs/cci/api-ref/public_sys-resources/warning_3.0-en-us.png b/docs/cci/api-ref/public_sys-resources/warning_3.0-en-us.png new file mode 100644 index 00000000..def5c356 Binary files /dev/null and b/docs/cci/api-ref/public_sys-resources/warning_3.0-en-us.png differ diff --git a/docs/cci/api-ref/readCciV2Namespace.html b/docs/cci/api-ref/readCciV2Namespace.html new file mode 100644 index 00000000..d3e958a1 --- /dev/null +++ b/docs/cci/api-ref/readCciV2Namespace.html @@ -0,0 +1,622 @@ + + +

Reading the Specified Namespace

+

Function

Read the specified Namespace.

+
+

Calling Method

For details, see Calling APIs.

+
+

URI

GET /apis/cci/v2/namespaces/{name}

+ +
+ + + + + + + + + + + +
Table 1 Path Parameters

Parameter

+

Mandatory

+

Type

+

Description

+

name

+

Yes

+

String

+

Name of the Namespace

+
+
+ +
+ + + + + + + + + + + +
Table 2 Query Parameters

Parameter

+

Mandatory

+

Type

+

Description

+

pretty

+

No

+

String

+

If 'true', then the output is pretty printed.

+
+
+
+

Request Parameters

+
+ + + + + + + + + + + +
Table 3 Request header parameters

Parameter

+

Mandatory

+

Type

+

Description

+

X-Auth-Token

+

Yes

+

String

+

User token.

+

It can be obtained through the IAM API used to obtain a user token. The value of X-Subject-Token in the response header is the user token.

+
+
+
+

Response Parameters

Status code: 200

+ +
+ + + + + + + + + + + + + + + + + + + + + + + + + +
Table 4 Response body parameters

Parameter

+

Type

+

Description

+

apiVersion

+

String

+

APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#resources

+

kind

+

String

+

Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds

+

metadata

+

io.k8s.apimachinery.pkg.apis.meta.v1.ObjectMeta object

+

Standard object's metadata. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata

+

spec

+

io.cci.otc.api.pkg.apis.versioned.cci.v2.NamespaceSpec object

+

Spec defines the behavior of the Namespace. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#spec-and-status

+

status

+

io.cci.otc.api.pkg.apis.versioned.cci.v2.NamespaceStatus object

+

Status describes the current status of a Namespace. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#spec-and-status

+
+
+ +
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Table 5 io.k8s.apimachinery.pkg.apis.meta.v1.ObjectMeta

Parameter

+

Type

+

Description

+

annotations

+

Map<String,String>

+

Annotations is an unstructured key value map stored with a resource that may be set by external tools to store and retrieve arbitrary metadata. They are not queryable and should be preserved when modifying objects. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/annotations/

+

clusterName

+

String

+

The name of the cluster which the object belongs to. This is used to distinguish resources with same name and namespace in different clusters. This field is not set anywhere right now and apiserver is going to ignore it if set in create or update request.

+

creationTimestamp

+

String

+

CreationTimestamp is a timestamp representing the server time when this object was created. It is not guaranteed to be set in happens-before order across separate operations. Clients may not set this value. It is represented in RFC3339 form and is in UTC.

+

Populated by the system. Read-only. Null for lists. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata

+

deletionGracePeriodSeconds

+

Long

+

Number of seconds allowed for this object to gracefully terminate before it will be removed from the system. Only set when deletionTimestamp is also set. May only be shortened. Read-only.

+

deletionTimestamp

+

String

+

DeletionTimestamp is RFC 3339 date and time at which this resource will be deleted. This field is set by the server when a graceful deletion is requested by the user, and is not directly settable by a client. The resource is expected to be deleted (no longer visible from resource lists, and not reachable by name) after the time in this field, once the finalizers list is empty. As long as the finalizers list contains items, deletion is blocked. Once the deletionTimestamp is set, this value may not be unset or be set further into the future, although it may be shortened or the resource may be deleted prior to this time. For example, a user may request that a pod is deleted in 30 seconds. The Kubelet will react by sending a graceful termination signal to the containers in the pod. After that 30 seconds, the Kubelet will send a hard termination signal (SIGKILL) to the container and after cleanup, remove the pod from the API. In the presence of network partitions, this object may still exist after this timestamp, until an administrator or automated process can determine the resource is fully terminated. If not set, graceful deletion of the object has not been requested.

+

Populated by the system when a graceful deletion is requested. Read-only. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata

+

enable

+

Boolean

+

Enable identifies whether the resource is available

+

finalizers

+

Array of strings

+

Must be empty before the object is deleted from the registry.

+

Each entry is an identifier for the responsible component that will remove

+

the entry from the list. If the deletionTimestamp of the object is non-nil,

+

entries in this list can only be removed. Finalizers may be processed and

+

removed in any order. Order is NOT enforced because it introduces significant

+

risk of stuck finalizers. finalizers is a shared field, any actor with permission

+

can reorder it. If the finalizer list is processed in order, then this can

+

lead to a situation in which the component responsible for the first finalizer

+

in the list is waiting for a signal (field value, external system, or other)

+

produced by a component responsible for a finalizer later in the list, resulting

+

in a deadlock. Without enforced ordering finalizers are free to order amongst

+

themselves and are not vulnerable to ordering changes in the list.

+

generateName

+

String

+

GenerateName is an optional prefix, used by the server, to generate a unique name ONLY IF the Name field has not been provided. If this field is used, the name returned to the client will be different than the name passed. This value will also be combined with a unique suffix. The provided value has the same validation rules as the Name field, and may be truncated by the length of the suffix required to make the value unique on the server.

+

If this field is specified and the generated name exists, the server will NOT return a 409 - instead, it will either return 201 Created or 500 with Reason ServerTimeout indicating a unique name could not be found in the time allotted, and the client should retry (optionally after the time indicated in the Retry-After header).

+

Applied only if Name is not specified. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#idempotency

+

generation

+

Long

+

A sequence number representing a specific generation of the desired

+

state. Populated by the system. Read-only.

+

labels

+

Map<String,String>

+

Map of string keys and values that can be used to organize and categorize (scope and select) objects. May match selectors of replication controllers and services. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/labels/

+

managedFields

+

Array of io.k8s.apimachinery.pkg.apis.meta.v1.ManagedFieldsEntry objects

+

ManagedFields maps workflow-id and version to the set of fields

+

that are managed by that workflow. This is mostly for internal housekeeping,

+

and users typically shouldn't need to set or understand this field. A workflow

+

can be the user's name, a controller's name, or the name of a specific apply

+

path like "ci-cd". The set of fields is always in the version that the workflow

+

used when modifying the object.

+

name

+

String

+

Name must be unique within a namespace. Is required when creating resources, although some resources may allow a client to request the generation of an appropriate name automatically. Name is primarily intended for creation idempotence and configuration definition. Cannot be updated. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names

+

namespace

+

String

+

Namespace defines the space within which each name must be unique. An empty namespace is equivalent to the "default" namespace, but "default" is the canonical representation. Not all objects are required to be scoped to a namespace - the value of this field for those objects will be empty.

+

Must be a DNS_LABEL. Cannot be updated. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/namespaces/

+

ownerReferences

+

Array of io.k8s.apimachinery.pkg.apis.meta.v1.OwnerReference objects

+

List of objects depended by this object. If ALL objects in the

+

list have been deleted, this object will be garbage collected. If this object

+

is managed by a controller, then an entry in this list will point to this

+

controller, with the controller field set to true. There cannot be more

+

than one managing controller.

+

resourceVersion

+

String

+

An opaque value that represents the internal version of this object that can be used by clients to determine when objects have changed. May be used for optimistic concurrency, change detection, and the watch operation on a resource or set of resources. Clients must treat these values as opaque and passed unmodified back to the server. They may only be valid for a particular resource or set of resources.

+

Populated by the system. Read-only. Value must be treated as opaque by clients and . More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#concurrency-control-and-consistency

+

selfLink

+

String

+

SelfLink is a URL representing this object. Populated by the system. Read-only.

+

DEPRECATED Kubernetes will stop propagating this field in 1.20 release and the field is planned to be removed in 1.21 release.

+

uid

+

String

+

UID is the unique in time and space value for this object. It is typically generated by the server on successful creation of a resource and is not allowed to change on PUT operations.

+

Populated by the system. Read-only. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#uids

+
+
+ +
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Table 6 io.k8s.apimachinery.pkg.apis.meta.v1.ManagedFieldsEntry

Parameter

+

Type

+

Description

+

apiVersion

+

String

+

APIVersion defines the version of this resource that this field

+

set applies to. The format is "group/version" just like the top-level APIVersion

+

field. It is necessary to track the version of a field set because it cannot

+

be automatically converted.

+

fieldsType

+

String

+

FieldsType is the discriminator for the different fields format and version. There is currently only one possible value: "FieldsV1"

+

fieldsV1

+

Object

+

FieldsV1 holds the first JSON version format as described in

+

the "FieldsV1" type.

+

manager

+

String

+

Manager is an identifier of the workflow managing these fields.

+

operation

+

String

+

Operation is the type of operation which lead to this ManagedFieldsEntry

+

being created. The only valid values for this field are 'Apply' and 'Update'.

+

time

+

String

+

Time is timestamp of when these fields were set. It should always

+

be empty if Operation is 'Apply'

+
+
+ +
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Table 7 io.k8s.apimachinery.pkg.apis.meta.v1.OwnerReference

Parameter

+

Type

+

Description

+

apiVersion

+

String

+

API version of the referent.

+

blockOwnerDeletion

+

Boolean

+

If true, AND if the owner has the "foregroundDeletion" finalizer,

+

then the owner cannot be deleted from the key-value store until this reference

+

is removed. Defaults to false. To set this field, a user needs "delete"

+

permission of the owner, otherwise 422 (Unprocessable Entity) will be returned.

+

controller

+

Boolean

+

If true, this reference points to the managing controller.

+

kind

+

String

+

Kind of the referent. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds

+

name

+

String

+

Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names

+

uid

+

String

+

UID of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#uids

+
+
+ +
+ + + + + + + + + +
Table 8 io.cci.otc.api.pkg.apis.versioned.cci.v2.NamespaceSpec

Parameter

+

Type

+

Description

+

finalizers

+

Array of strings

+

Finalizers is an opaque list of values that must be empty to permanently remove object from storage. More info: https://kubernetes.io/docs/tasks/administer-cluster/namespaces/

+
+
+ +
+ + + + + + + + + + + + + +
Table 9 io.cci.otc.api.pkg.apis.versioned.cci.v2.NamespaceStatus

Parameter

+

Type

+

Description

+

conditions

+

Array of io.cci.otc.api.pkg.apis.versioned.cci.v2.NamespaceCondition objects

+

Represents the latest available observations of a namespace's

+

current state.

+

phase

+

String

+

Phase is the current lifecycle phase of the namespace. More info: https://kubernetes.io/docs/tasks/administer-cluster/namespaces/

+

Possible enum values:

+
  • "Active" means the namespace is available for use in the system
  • "Terminating" means the namespace is undergoing graceful termination
+
+
+ +
+ + + + + + + + + + + + + + + + + + + + + + + + + +
Table 10 io.cci.otc.api.pkg.apis.versioned.cci.v2.NamespaceCondition

Parameter

+

Type

+

Description

+

lastTransitionTime

+

String

+

Time is a wrapper around time.Time which supports correct marshaling

+

to YAML and JSON. Wrappers are provided for many of the factory methods that

+

the time package offers.

+

message

+

String

+		  

reason

+

String

+		  

status

+

String

+

Status of the condition, one of True, False, Unknown.

+

type

+

String

+

Type of namespace controller condition.

+
+
+
+

Example Requests

None

+
+

Example Responses

Status code: 200

+

OK

+
{
+  "apiVersion" : "cci/v2",
+  "kind" : "Namespace",
+  "metadata" : {
+    "annotations" : {
+      "tag.cci.io/tms-tags" : "",
+      "tenant.cci.io/tenant-id" : "08a2*************************c03",
+      "tenant.kubernetes.io/domain-id" : "08a*************************ee60",
+      "tenant.kubernetes.io/domain-name" : "fake-user",
+      "tenant.kubernetes.io/project-id" : "08a2*************************c03",
+      "tenant.kubernetes.io/project-name" : "region1",
+      "volcano.sh/queue-name" : "v5-queue"
+    },
+    "creationTimestamp" : "2024-10-09T11:45:26Z",
+    "labels" : {
+      "kubernetes.io/metadata.name" : "test"
+    },
+    "name" : "test",
+    "resourceVersion" : "391014484",
+    "uid" : "7ea9e4d0-2cf4-44cc-8938-f332d90bc665"
+  },
+  "spec" : {
+    "finalizers" : [ "kubernetes" ]
+  },
+  "status" : {
+    "phase" : "Active"
+  }
+}
+
+

Status Codes

+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +

Status Code

+

Description

+

200

+

OK

+

400

+

BadRequest

+

401

+

Unauthorized

+

403

+

Forbidden

+

404

+

NotFound

+

405

+

MethodNotAllowed

+

406

+

NotAcceptable

+

409

+

Conflict

+

415

+

UnsupportedMediaType

+

422

+

Invalid

+

429

+

TooManyRequests

+

500

+

InternalError

+

503

+

ServiceUnavailable

+

504

+

ServerTimeout

+
+
+
+
+
+
+
Parent topic: Proprietary APIs
+
+
+ diff --git a/docs/cci/api-ref/readCciV2NamespacedConfigMap.html b/docs/cci/api-ref/readCciV2NamespacedConfigMap.html new file mode 100644 index 00000000..54730018 --- /dev/null +++ b/docs/cci/api-ref/readCciV2NamespacedConfigMap.html @@ -0,0 +1,512 @@ + + +

Reading the Specified ConfigMap

+

Function

Read the specified ConfigMap.

+
+

Calling Method

For details, see Calling APIs.

+
+

URI

GET /apis/cci/v2/namespaces/{namespace}/configmaps/{name}

+ +
+ + + + + + + + + + + + + + + + +
Table 1 Path Parameters

Parameter

+

Mandatory

+

Type

+

Description

+

name

+

Yes

+

String

+

Name of the ConfigMap.

+

namespace

+

Yes

+

String

+

Object name and auth scope, such as for teams and projects.

+
+
+ +
+ + + + + + + + + + + +
Table 2 Query Parameters

Parameter

+

Mandatory

+

Type

+

Description

+

pretty

+

No

+

String

+

If 'true', then the output is pretty printed.

+
+
+
+

Request Parameters

+
+ + + + + + + + + + + +
Table 3 Request header parameters

Parameter

+

Mandatory

+

Type

+

Description

+

X-Auth-Token

+

Yes

+

String

+

User token.

+

It can be obtained through the IAM API used to obtain a user token. The value of X-Subject-Token in the response header is the user token.

+
+
+
+

Response Parameters

Status code: 200

+ +
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Table 4 Response body parameters

Parameter

+

Type

+

Description

+

apiVersion

+

String

+

APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#resources

+

binaryData

+

Map<String,String>

+

BinaryData contains the binary data. Each key must consist of alphanumeric characters, '-', '_' or '.'. BinaryData can contain byte sequences that are not in the UTF-8 range. The keys stored in BinaryData must not overlap with the ones in the Data field, this is enforced during validation process. Using this field will require 1.10+ apiserver and kubelet.

+

data

+

Map<String,String>

+

Data contains the configuration data. Each key must consist of alphanumeric characters, '-', '_' or '.'. Values with non-UTF-8 byte sequences ust use the BinaryData field. The keys stored in Data must not overlap ith the keys in the BinaryData field, this is enforced during validation process.

+

immutable

+

Boolean

+

Immutable, if set to true, ensures that data stored in the ConfigMap cannot be updated (only object metadata can be modified). If not set to true, the field can be modified at any time. Defaulted to nil.

+

kind

+

String

+

Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds

+

metadata

+

io.k8s.apimachinery.pkg.apis.meta.v1.ObjectMeta object

+

Standard object's metadata. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata

+
+
+ +
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Table 5 io.k8s.apimachinery.pkg.apis.meta.v1.ObjectMeta

Parameter

+

Type

+

Description

+

annotations

+

Map<String,String>

+

Annotations is an unstructured key value map stored with a resource that may be set by external tools to store and retrieve arbitrary metadata. They are not queryable and should be preserved when modifying objects. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/annotations/

+

clusterName

+

String

+

The name of the cluster which the object belongs to. This is used to distinguish resources with same name and namespace in different clusters. This field is not set anywhere right now and apiserver is going to ignore it if set in create or update request.

+

creationTimestamp

+

String

+

CreationTimestamp is a timestamp representing the server time when this object was created. It is not guaranteed to be set in happens-before order across separate operations. Clients may not set this value. It is represented in RFC3339 form and is in UTC.

+

Populated by the system. Read-only. Null for lists. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata

+

deletionGracePeriodSeconds

+

Long

+

Number of seconds allowed for this object to gracefully terminate before it will be removed from the system. Only set when deletionTimestamp is also set. May only be shortened. Read-only.

+

deletionTimestamp

+

String

+

DeletionTimestamp is RFC 3339 date and time at which this resource will be deleted. This field is set by the server when a graceful deletion is requested by the user, and is not directly settable by a client. The resource is expected to be deleted (no longer visible from resource lists, and not reachable by name) after the time in this field, once the finalizers list is empty. As long as the finalizers list contains items, deletion is blocked. Once the deletionTimestamp is set, this value may not be unset or be set further into the future, although it may be shortened or the resource may be deleted prior to this time. For example, a user may request that a pod is deleted in 30 seconds. The Kubelet will react by sending a graceful termination signal to the containers in the pod. After that 30 seconds, the Kubelet will send a hard termination signal (SIGKILL) to the container and after cleanup, remove the pod from the API. In the presence of network partitions, this object may still exist after this timestamp, until an administrator or automated process can determine the resource is fully terminated. If not set, graceful deletion of the object has not been requested.

+

Populated by the system when a graceful deletion is requested. Read-only. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata

+

enable

+

Boolean

+

Enable identifies whether the resource is available

+

finalizers

+

Array of strings

+

Must be empty before the object is deleted from the registry.

+

Each entry is an identifier for the responsible component that will remove the entry from the list. If the deletionTimestamp of the object is non-nil, entries in this list can only be removed. Finalizers may be processed and removed in any order. Order is NOT enforced because it introduces significant risk of stuck finalizers. finalizers is a shared field, any actor with permission can reorder it. If the finalizer list is processed in order, then this can lead to a situation in which the component responsible for the first finalizer in the list is waiting for a signal (field value, external system, or other) produced by a component responsible for a finalizer later in the list, resulting in a deadlock. Without enforced ordering finalizers are free to order amongst themselves and are not vulnerable to ordering changes in the list.

+

generateName

+

String

+

GenerateName is an optional prefix, used by the server, to generate a unique name ONLY IF the Name field has not been provided. If this field is used, the name returned to the client will be different than the name passed. This value will also be combined with a unique suffix. The provided value has the same validation rules as the Name field, and may be truncated by the length of the suffix required to make the value unique on the server.

+

If this field is specified and the generated name exists, the server will NOT return a 409 - instead, it will either return 201 Created or 500 with Reason ServerTimeout indicating a unique name could not be found in the time allotted, and the client should retry (optionally after the time indicated in the Retry-After header).

+

Applied only if Name is not specified. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#idempotency

+

generation

+

Long

+

A sequence number representing a specific generation of the desired state. Populated by the system. Read-only.

+

labels

+

Map<String,String>

+

Map of string keys and values that can be used to organize and categorize (scope and select) objects. May match selectors of replication controllers and services. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/labels/

+

managedFields

+

Array of io.k8s.apimachinery.pkg.apis.meta.v1.ManagedFieldsEntry objects

+

ManagedFields maps workflow-id and version to the set of fields that are managed by that workflow. This is mostly for internal housekeeping, and users typically shouldn't need to set or understand this field. A workflow can be the user's name, a controller's name, or the name of a specific apply path like "ci-cd". The set of fields is always in the version that the workflow used when modifying the object.

+

name

+

String

+

Name must be unique within a namespace. Is required when creating resources, although some resources may allow a client to request the generation of an appropriate name automatically. Name is primarily intended for creation idempotence and configuration definition. Cannot be updated. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names

+

namespace

+

String

+

Namespace defines the space within which each name must be unique. An empty namespace is equivalent to the "default" namespace, but "default" is the canonical representation. Not all objects are required to be scoped to a namespace - the value of this field for those objects will be empty.

+

Must be a DNS_LABEL. Cannot be updated. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/namespaces/

+

ownerReferences

+

Array of io.k8s.apimachinery.pkg.apis.meta.v1.OwnerReference objects

+

List of objects depended by this object. If ALL objects in the list have been deleted, this object will be garbage collected. If this objec is managed by a controller, then an entry in this list will point to this controller, with the controller field set to true. There cannot be more than one managing controller.

+

+

resourceVersion

+

String

+

An opaque value that represents the internal version of this object that can be used by clients to determine when objects have changed. May be used for optimistic concurrency, change detection, and the watch operation on a resource or set of resources. Clients must treat these values as opaque and passed unmodified back to the server. They may only be valid for a particular resource or set of resources.

+

Populated by the system. Read-only. Value must be treated as opaque by clients and . More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#concurrency-control-and-consistency

+

selfLink

+

String

+

SelfLink is a URL representing this object. Populated by the system. Read-only.

+

DEPRECATED Kubernetes will stop propagating this field in 1.20 release and the field is planned to be removed in 1.21 release.

+

uid

+

String

+

UID is the unique in time and space value for this object. It is typically generated by the server on successful creation of a resource and is not allowed to change on PUT operations.

+

Populated by the system. Read-only. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#uids

+
+
+ +
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Table 6 io.k8s.apimachinery.pkg.apis.meta.v1.ManagedFieldsEntry

Parameter

+

Type

+

Description

+

apiVersion

+

String

+

APIVersion defines the version of this resource that this field set applies to. The format is "group/version" just like the top-level APIVersion field. It is necessary to track the version of a field set because it cannot be automatically converted.

+

fieldsType

+

String

+

FieldsType is the discriminator for the different fields format and version. There is currently only one possible value: "FieldsV1"

+

fieldsV1

+

Object

+

FieldsV1 holds the first JSON version format as described in the "FieldsV1" type.

+

manager

+

String

+

Manager is an identifier of the workflow managing these fields.

+

operation

+

String

+

Operation is the type of operation which lead to this ManagedFieldsEntry being created. The only valid values for this field are 'Apply' and 'Update'.

+

time

+

String

+

Time is timestamp of when these fields were set. It should always be empty if Operation is 'Apply'.

+
+
+ +
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Table 7 io.k8s.apimachinery.pkg.apis.meta.v1.OwnerReference

Parameter

+

Type

+

Description

+

apiVersion

+

String

+

API version of the referent.

+

blockOwnerDeletion

+

Boolean

+

If true, AND if the owner has the "foregroundDeletion" finalizer, then the owner cannot be deleted from the key-value store until this reference is removed. Defaults to false. To set this field, a user needs "delete" permission of the owner, otherwise 422 (Unprocessable Entity) will be returned.

+

controller

+

Boolean

+

If true, this reference points to the managing controller.

+

kind

+

String

+

Kind of the referent. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds

+

name

+

String

+

Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names

+

uid

+

String

+

UID of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#uids

+
+
+
+

Example Requests

None

+
+

Example Responses

Status code: 200

+

OK

+
{
+  "apiVersion" : "cci/v2",
+  "data" : {
+    "key1" : "value1",
+    "key2" : "value2"
+  },
+  "kind" : "ConfigMap",
+  "metadata" : {
+    "annotations" : {
+      "tenant.cci.io/tenant-id" : "08a2*************************c03"
+    },
+    "creationTimestamp" : "2024-10-09T12:05:03Z",
+    "labels" : {
+      "sys_enterprise_project_id" : "0",
+      "tenant.cci.io/tenant-id" : "08a2*************************c03",
+      "tenant.kubernetes.io/domain-id" : "08a*************************ee60",
+      "tenant.kubernetes.io/project-id" : "08a2*************************c03",
+      "usage" : "just-for-test"
+    },
+    "name" : "test-cm",
+    "namespace" : "wbtest4",
+    "resourceVersion" : "391020615",
+    "uid" : "7c6f7981-78bb-42ff-b659-b8b4cbcbab5e"
+  }
+}
+
+

Status Codes

+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +

Status Code

+

Description

+

200

+

OK

+

400

+

BadRequest

+

401

+

Unauthorized

+

403

+

Forbidden

+

404

+

NotFound

+

405

+

MethodNotAllowed

+

406

+

NotAcceptable

+

409

+

Conflict

+

415

+

UnsupportedMediaType

+

422

+

Invalid

+

429

+

TooManyRequests

+

500

+

InternalError

+

503

+

ServiceUnavailable

+

504

+

ServerTimeout

+
+
+
+
+
+
+
Parent topic: Proprietary APIs
+
+
+ diff --git a/docs/cci/api-ref/readCciV2NamespacedPod.html b/docs/cci/api-ref/readCciV2NamespacedPod.html new file mode 100644 index 00000000..2d3c5bf3 --- /dev/null +++ b/docs/cci/api-ref/readCciV2NamespacedPod.html @@ -0,0 +1,3739 @@ + + +

Reading the Specified Pod

+

Function

Read the specified Pod.

+
+

Calling Method

For details, see Calling APIs.

+
+

URI

GET /apis/cci/v2/namespaces/{namespace}/pods/{name}

+ +
+ + + + + + + + + + + + + + + + +
Table 1 Path Parameters

Parameter

+

Mandatory

+

Type

+

Description

+

name

+

Yes

+

String

+

Name of the Pod.

+

namespace

+

Yes

+

String

+

Object name and auth scope, such as for teams and projects.

+
+
+ +
+ + + + + + + + + + + +
Table 2 Query Parameters

Parameter

+

Mandatory

+

Type

+

Description

+

pretty

+

No

+

String

+

If 'true', then the output is pretty printed.

+
+
+
+

Request Parameters

+
+ + + + + + + + + + + +
Table 3 Request header parameters

Parameter

+

Mandatory

+

Type

+

Description

+

X-Auth-Token

+

Yes

+

String

+

User token.

+

It can be obtained through the IAM API used to obtain a user token. The value of X-Subject-Token in the response header is the user token.

+
+
+
+

Response Parameters

Status code: 200

+ +
+ + + + + + + + + + + + + + + + + + + + + + + + + +
Table 4 Response body parameters

Parameter

+

Type

+

Description

+

apiVersion

+

String

+

APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#resources

+

kind

+

String

+

Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds

+

metadata

+

io.k8s.apimachinery.pkg.apis.meta.v1.ObjectMeta object

+

Standard object's metadata. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata

+

spec

+

io.cci.otc.api.pkg.apis.versioned.cci.v2.PodSpec object

+

Specification of the desired behavior of the pod. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#spec-and-status

+

status

+

io.cci.otc.api.pkg.apis.versioned.cci.v2.PodStatus object

+

Most recently observed status of the pod. This data may not be up to date. Populated by the system. Read-only. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#spec-and-status

+
+
+ +
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Table 5 io.cci.otc.api.pkg.apis.versioned.cci.v2.PodSpec

Parameter

+

Type

+

Description

+

activeDeadlineSeconds

+

Long

+

Optional duration in seconds the pod may be active on the node

+

relative to StartTime before the system will actively try to mark it failed

+

and kill associated containers. Value must be a positive integer.

+

affinity

+

io.cci.otc.api.pkg.apis.versioned.cci.v2.Affinity object

+

If specified, the pod's scheduling constraints

+

containers

+

Array of io.cci.otc.api.pkg.apis.versioned.cci.v2.Container objects

+

List of containers belonging to the pod. Containers cannot currently

+

be added or removed. There must be at least one container in a Pod. Cannot

+

be updated.

+

dnsConfig

+

io.cci.otc.api.pkg.apis.versioned.cci.v2.PodDNSConfig object

+

Specifies the DNS parameters of a pod. Parameters specified here

+

will be merged to the generated DNS configuration based on DNSPolicy.

+

dnsPolicy

+

String

+

Set DNS policy for the pod. Defaults to "ClusterFirst". Valid values are 'ClusterFirstWithHostNet', 'ClusterFirst', 'Default' or 'None'. DNS parameters given in DNSConfig will be merged with the policy selected with DNSPolicy. To have DNS options set along with hostNetwork, you have to specify DNS policy explicitly to 'ClusterFirstWithHostNet'.

+

Possible enum values:

+
  • "ClusterFirst" indicates that the pod should use cluster DNS first unless hostNetwork is true, if it is available, then fall back on the default (as determined by kubelet) DNS settings.
  • "ClusterFirstWithHostNet" indicates that the pod should use cluster DNS first, if it is available, then fall back on the default (as determined by kubelet) DNS settings.
  • "Default" indicates that the pod should use the default (as determined by kubelet) DNS settings.
  • "None" indicates that the pod should use empty DNS settings. DNS parameters such as nameservers and search paths should be defined via DNSConfig.
+

ephemeralContainers

+

Array of io.cci.otc.api.pkg.apis.versioned.cci.v2.EphemeralContainer objects

+

List of ephemeral containers run in this pod. Ephemeral containers

+

may be run in an existing pod to perform user-initiated actions such as

+

debugging. This list cannot be specified when creating a pod, and it cannot

+

be modified by updating the pod spec. In order to add an ephemeral container

+

to an existing pod, use the pod's ephemeralcontainers subresource.

+

hostAliases

+

Array of io.cci.otc.api.pkg.apis.versioned.cci.v2.HostAlias objects

+

HostAliases is an optional list of hosts and IPs that will be

+

injected into the pod's hosts file if specified. This is only valid for

+

non-hostNetwork pods.

+

hostname

+

String

+

Specifies the hostName of the Pod. If not specified, the pod's

+

hostname will be set to a system-defined value.

+

imagePullSecrets

+

Array of io.cci.otc.api.pkg.apis.versioned.cci.v2.LocalObjectReference objects

+

ImagePullSecrets is an optional list of references to secrets in the same namespace to use for pulling any of the images used by this PodSpec. If specified, these secrets will be passed to individual puller implementations for them to use. More info: https://kubernetes.io/docs/concepts/containers/images#specifying-imagepullsecrets-on-a-pod

+

initContainers

+

Array of io.cci.otc.api.pkg.apis.versioned.cci.v2.Container objects

+

List of initialization containers belonging to the pod. Init containers are executed in order prior to containers being started. If any init container fails, the pod is considered to have failed and is handled according to its restartPolicy. The name for an init container or normal container must be unique among all containers. Init containers may not have Lifecycle actions, Readiness probes, Liveness probes, or Startup probes. The resourceRequirements of an init container are taken into account during scheduling by finding the highest request/limit for each resource type, and then using the max of of that value or the sum of the normal containers. Limits are applied to init containers in a similar fashion. Init containers cannot currently be added or removed. Cannot be updated. More info: https://kubernetes.io/docs/concepts/workloads/pods/init-containers/

+

nodeName

+

String

+

NodeName is a request to schedule this pod onto a specific node.

+

If it is non-empty, the scheduler simply schedules this pod onto that node,

+

assuming that it fits resource requirements.

+

overhead

+

Map<String,String>

+

Overhead represents the resource overhead associated with running a pod for a given RuntimeClass. This field will be autopopulated at admission time by the RuntimeClass admission controller. If the RuntimeClass admission controller is enabled, overhead must not be set in Pod create requests. The RuntimeClass admission controller will reject Pod create requests which have the overhead already set. If RuntimeClass is configured and selected in the PodSpec, Overhead will be set to the value defined in the corresponding RuntimeClass, otherwise it will remain unset and treated as zero. More info: https://git.k8s.io/enhancements/keps/sig-node/688-pod-overhead/README.md

+

readinessGates

+

Array of io.cci.otc.api.pkg.apis.versioned.cci.v2.PodReadinessGate objects

+

If specified, all readiness gates will be evaluated for pod readiness. A pod is ready when all its containers are ready AND all conditions specified in the readiness gates have status equal to "True" More info: https://git.k8s.io/enhancements/keps/sig-network/580-pod-readiness-gates

+

restartPolicy

+

String

+

Restart policy for all containers within the pod. One of Always, OnFailure, Never. Default to Always. More info: https://kubernetes.io/docs/concepts/workloads/pods/pod-lifecycle/#restart-policy

+

Possible enum values:

+
  • "Always"
  • "Never"
  • "OnFailure"
+

schedulerName

+

String

+

If specified, the pod will be dispatched by specified scheduler.

+

If not specified, the pod will be dispatched by default scheduler.

+

securityContext

+

io.cci.otc.api.pkg.apis.versioned.cci.v2.PodSecurityContext object

+

SecurityContext holds pod-level security attributes and common container settings. Optional: Defaults to empty. See type description for default values of each field.

+

setHostnameAsFQDN

+

Boolean

+

If true the pod's hostname will be configured as the pod's FQDN,

+

rather than the leaf name (the default). In Linux containers, this means

+

setting the FQDN in the hostname field of the kernel (the nodename field

+

of struct utsname). In Windows containers, this means setting the registry

+

value of hostname for the registry key HKEY_LOCAL_MACHINE\SYSTEM\CurrentControlSet\Services\Tcpip\Parameters

+

to FQDN. If a pod does not have FQDN, this has no effect. Default to false.

+

shareProcessNamespace

+

Boolean

+

Share a single process namespace between all of the containers in a pod. When this is set containers will be able to view and signal processes from other containers in the same pod, and the first process in each container will not be assigned PID 1. HostPID and ShareProcessNamespace cannot both be set. Optional: Default to false.

+

terminationGracePeriodSeconds

+

Long

+

Optional duration in seconds the pod needs to terminate gracefully.

+

May be decreased in delete request. Value must be non-negative integer.

+

The value zero indicates stop immediately via the kill signal (no opportunity

+

to shut down). If this value is nil, the default grace period will be used

+

instead. The grace period is the duration in seconds after the processes

+

running in the pod are sent a termination signal and the time when the processes

+

are forcibly halted with a kill signal. Set this value longer than the expected

+

cleanup time for your process. Defaults to 30 seconds.

+

topologySpreadConstraints

+

Array of io.cci.otc.api.pkg.apis.versioned.cci.v2.TopologySpreadConstraint objects

+

TopologySpreadConstraints describes how a group of pods ought

+

to spread across topology domains. Scheduler will schedule pods in a way

+

which abides by the constraints. All topologySpreadConstraints are ANDed.

+

volumes

+

Array of io.cci.otc.api.pkg.apis.versioned.cci.v2.Volume objects

+

List of volumes that can be mounted by containers belonging to the pod. More info: https://kubernetes.io/docs/concepts/storage/volumes

+
+
+ +
+ + + + + + + + + + + + + +
Table 6 io.cci.otc.api.pkg.apis.versioned.cci.v2.Affinity

Parameter

+

Type

+

Description

+

nodeAffinity

+

io.cci.otc.api.pkg.apis.versioned.cci.v2.NodeAffinity object

+

Describes node affinity scheduling rules for the pod.

+

podAntiAffinity

+

io.cci.otc.api.pkg.apis.versioned.cci.v2.PodAntiAffinity object

+

Describes pod anti-affinity scheduling rules (e.g. avoid putting

+

this pod in the same zone, etc. as some other pod(s)).

+
+
+ +
+ + + + + + + + + +
Table 7 io.cci.otc.api.pkg.apis.versioned.cci.v2.NodeAffinity

Parameter

+

Type

+

Description

+

requiredDuringSchedulingIgnoredDuringExecution

+

io.cci.otc.api.pkg.apis.versioned.cci.v2.NodeSelector object

+

If the affinity requirements specified by this field are not

+

met at scheduling time, the pod will not be scheduled onto the node. If

+

the affinity requirements specified by this field cease to be met at some

+

point during pod execution (e.g. due to an update), the system may or may

+

not try to eventually evict the pod from its node.

+
+
+ +
+ + + + + + + + + +
Table 8 io.cci.otc.api.pkg.apis.versioned.cci.v2.NodeSelector

Parameter

+

Type

+

Description

+

nodeSelectorTerms

+

Array of io.cci.otc.api.pkg.apis.versioned.cci.v2.NodeSelectorTerm objects

+

Required. A list of node selector terms. The terms are ORed.

+
+
+ +
+ + + + + + + + + +
Table 9 io.cci.otc.api.pkg.apis.versioned.cci.v2.NodeSelectorTerm

Parameter

+

Type

+

Description

+

matchExpressions

+

Array of io.cci.otc.api.pkg.apis.versioned.cci.v2.NodeSelectorRequirement objects

+

A list of node selector requirements by node's labels.

+
+
+ +
+ + + + + + + + + + + + + + + + + +
Table 10 io.cci.otc.api.pkg.apis.versioned.cci.v2.NodeSelectorRequirement

Parameter

+

Type

+

Description

+

key

+

String

+

The label key that the selector applies to.

+

operator

+

String

+

Represents a key's relationship to a set of values. Valid operators are In, NotIn, Exists, DoesNotExist. Gt, and Lt.

+

Possible enum values:

+
  • "DoesNotExist"
  • "Exists"
  • "Gt"
  • "In"
  • "Lt"
  • "NotIn"
+

values

+

Array of strings

+

An array of string values. If the operator is In or NotIn, the

+

values array must be non-empty. If the operator is Exists or DoesNotExist,

+

the values array must be empty. If the operator is Gt or Lt, the values

+

array must have a single element, which will be interpreted as an integer.

+

This array is replaced during a strategic merge patch.

+
+
+ +
+ + + + + + + + + + + + + +
Table 11 io.cci.otc.api.pkg.apis.versioned.cci.v2.PodAntiAffinity

Parameter

+

Type

+

Description

+

preferredDuringSchedulingIgnoredDuringExecution

+

Array of io.cci.otc.api.pkg.apis.versioned.cci.v2.WeightedPodAffinityTerm objects

+

The scheduler will prefer to schedule pods to nodes that satisfy

+

the anti-affinity expressions specified by this field, but it may choose

+

a node that violates one or more of the expressions. The node that is most

+

preferred is the one with the greatest sum of weights, i.e. for each node

+

that meets all of the scheduling requirements (resource request, requiredDuringScheduling

+

anti-affinity expressions, etc.), compute a sum by iterating through the

+

elements of this field and adding "weight" to the sum if the node has pods

+

which matches the corresponding podAffinityTerm; the node(s) with the highest

+

sum are the most preferred.

+

requiredDuringSchedulingIgnoredDuringExecution

+

Array of io.cci.otc.api.pkg.apis.versioned.cci.v2.PodAffinityTerm objects

+

If the anti-affinity requirements specified by this field are

+

not met at scheduling time, the pod will not be scheduled onto the node.

+

If the anti-affinity requirements specified by this field cease to be met

+

at some point during pod execution (e.g. due to a pod label update), the

+

system may or may not try to eventually evict the pod from its node. When

+

there are multiple elements, the lists of nodes corresponding to each podAffinityTerm

+

are intersected, i.e. all terms must be satisfied.

+
+
+ +
+ + + + + + + + + + + + + +
Table 12 io.cci.otc.api.pkg.apis.versioned.cci.v2.WeightedPodAffinityTerm

Parameter

+

Type

+

Description

+

podAffinityTerm

+

io.cci.otc.api.pkg.apis.versioned.cci.v2.PodAffinityTerm object

+

Required. A pod affinity term, associated with the corresponding

+

weight.

+

weight

+

Integer

+

weight associated with matching the corresponding podAffinityTerm,

+

in the range 1-100.

+
+
+ +
+ + + + + + + + + + + + + + + + + +
Table 13 io.cci.otc.api.pkg.apis.versioned.cci.v2.PodAffinityTerm

Parameter

+

Type

+

Description

+

labelSelector

+

io.k8s.apimachinery.pkg.apis.meta.v1.LabelSelector object

+

A label query over a set of resources, in this case pods.

+

namespaces

+

Array of strings

+

namespaces specifies a static list of namespace names that the

+

term applies to. The term is applied to the union of the namespaces listed

+

in this field and the ones selected by namespaceSelector. null or empty

+

namespaces list and null namespaceSelector means "this pod's namespace".

+

topologyKey

+

String

+

This pod should be co-located (affinity) or not co-located (anti-affinity)

+

with the pods matching the labelSelector in the specified namespaces, where

+

co-located is defined as running on a node whose value of the label with

+

key topologyKey matches that of any node on which any of the selected pods

+

is running. Empty topologyKey is not allowed.

+
+
+ +
+ + + + + + + + + + + + + + + + + +
Table 14 io.cci.otc.api.pkg.apis.versioned.cci.v2.PodDNSConfig

Parameter

+

Type

+

Description

+

nameservers

+

Array of strings

+

A list of DNS name server IP addresses. This will be appended

+

to the base nameservers generated from DNSPolicy. Duplicated nameservers

+

will be removed.

+

options

+

Array of io.cci.otc.api.pkg.apis.versioned.cci.v2.PodDNSConfigOption objects

+

A list of DNS resolver options. This will be merged with the

+

base options generated from DNSPolicy. Duplicated entries will be removed.

+

Resolution options given in Options will override those that appear in the

+

base DNSPolicy.

+

searches

+

Array of strings

+

A list of DNS search domains for host-name lookup. This will

+

be appended to the base search paths generated from DNSPolicy. Duplicated

+

search paths will be removed.

+
+
+ +
+ + + + + + + + + + + + + +
Table 15 io.cci.otc.api.pkg.apis.versioned.cci.v2.PodDNSConfigOption

Parameter

+

Type

+

Description

+

name

+

String

+

Required.

+

value

+

String

+		  
+
+ +
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Table 16 io.cci.otc.api.pkg.apis.versioned.cci.v2.EphemeralContainer

Parameter

+

Type

+

Description

+

args

+

Array of strings

+

Arguments to the entrypoint. The image's CMD is used if this is not provided. Variable references $(VAR_NAME) are expanded using the container's environment. If a variable cannot be resolved, the reference in the input string will be unchanged. Double $$ are reduced to a single $, which allows for escaping the $(VAR_NAME) syntax: i.e. "$$(VAR_NAME)" will produce the string literal "$(VAR_NAME)". Escaped references will never be expanded, regardless of whether the variable exists or not. Cannot be updated. More info: https://kubernetes.io/docs/tasks/inject-data-application/define-command-argument-container/#running-a-command-in-a-shell

+

command

+

Array of strings

+

Entrypoint array. Not executed within a shell. The image's ENTRYPOINT is used if this is not provided. Variable references $(VAR_NAME) are expanded using the container's environment. If a variable cannot be resolved, the reference in the input string will be unchanged. Double $$ are reduced to a single $, which allows for escaping the $(VAR_NAME) syntax: i.e. "$$(VAR_NAME)" will produce the string literal "$(VAR_NAME)". Escaped references will never be expanded, regardless of whether the variable exists or not. Cannot be updated. More info: https://kubernetes.io/docs/tasks/inject-data-application/define-command-argument-container/#running-a-command-in-a-shell

+

env

+

Array of io.cci.otc.api.pkg.apis.versioned.cci.v2.EnvVar objects

+

List of environment variables to set in the container. Cannot

+

be updated.

+

envFrom

+

Array of io.cci.otc.api.pkg.apis.versioned.cci.v2.EnvFromSource objects

+

List of sources to populate environment variables in the container.

+

The keys defined within a source must be a C_IDENTIFIER. All invalid keys

+

will be reported as an event when the container is starting. When a key

+

exists in multiple sources, the value associated with the last source will

+

take precedence. Values defined by an Env with a duplicate key will take

+

precedence. Cannot be updated.

+

image

+

String

+

Container image name. More info: https://kubernetes.io/docs/concepts/containers/images

+

lifecycle

+

io.cci.otc.api.pkg.apis.versioned.cci.v2.Lifecycle object

+

Lifecycle is not allowed for ephemeral containers.

+

livenessProbe

+

io.cci.otc.api.pkg.apis.versioned.cci.v2.Probe object

+

Probes are not allowed for ephemeral containers.

+

name

+

String

+

Name of the ephemeral container specified as a DNS_LABEL. This

+

name must be unique among all containers, init containers and ephemeral

+

containers.

+

ports

+

Array of io.cci.otc.api.pkg.apis.versioned.cci.v2.ContainerPort objects

+

Ports are not allowed for ephemeral containers.

+

readinessProbe

+

io.cci.otc.api.pkg.apis.versioned.cci.v2.Probe object

+

Probes are not allowed for ephemeral containers.

+

resources

+

io.cci.otc.api.pkg.apis.versioned.cci.v2.ResourceRequirements object

+

Resources are not allowed for ephemeral containers. Ephemeral

+

containers use spare resources already allocated to the pod.

+

securityContext

+

io.cci.otc.api.pkg.apis.versioned.cci.v2.SecurityContext object

+

Optional: SecurityContext defines the security options the ephemeral container should be run with. If set, the fields of SecurityContext override the equivalent fields of PodSecurityContext.

+

startupProbe

+

io.cci.otc.api.pkg.apis.versioned.cci.v2.Probe object

+

Probes are not allowed for ephemeral containers.

+

stdin

+

Boolean

+

Whether this container should allocate a buffer for stdin in

+

the container runtime. If this is not set, reads from stdin in the container

+

will always result in EOF. Default is false.

+

stdinOnce

+

Boolean

+

Whether the container runtime should close the stdin channel

+

after it has been opened by a single attach. When stdin is true the stdin

+

stream will remain open across multiple attach sessions. If stdinOnce is

+

set to true, stdin is opened on container start, is empty until the first

+

client attaches to stdin, and then remains open and accepts data until the

+

client disconnects, at which time stdin is closed and remains closed until

+

the container is restarted. If this flag is false, a container processes

+

that reads from stdin will never receive an EOF. Default is false

+

targetContainerName

+

String

+

If set, the name of the container from PodSpec that this ephemeral container targets. The ephemeral container will be run in the namespaces (IPC, PID, etc) of this container. If not set then the ephemeral container uses the namespaces configured in the Pod spec.

+

The container runtime must implement support for this feature. If the runtime does not support namespace targeting then the result of setting this field is undefined.

+

terminationMessagePath

+

String

+

Optional: Path at which the file to which the container's termination message will be written is mounted into the container's filesystem. Message written is intended to be brief final status, such as an assertion failure message. Will be truncated by the node if greater than 4096 bytes. The total message length across all containers will be limited to 12kb. Defaults to /dev/termination-log. Cannot be updated.

+

terminationMessagePolicy

+

String

+

Indicate how the termination message should be populated. File will use the contents of terminationMessagePath to populate the container status message on both success and failure. FallbackToLogsOnError will use the last chunk of container log output if the termination message file is empty and the container exited with an error. The log output is limited to 2048 bytes or 80 lines, whichever is smaller. Defaults to File. Cannot be updated.

+

Possible enum values:

+
  • "FallbackToLogsOnError" will read the most recent contents of the container logs for the container status message when the container exits with an error and the terminationMessagePath has no contents.
  • "File" is the default behavior and will set the container status message to the contents of the container's terminationMessagePath when the container exits.
+

tty

+

Boolean

+

Whether this container should allocate a TTY for itself, also

+

requires 'stdin' to be true. Default is false.

+

volumeMounts

+

Array of io.cci.otc.api.pkg.apis.versioned.cci.v2.VolumeMount objects

+

Pod volumes to mount into the container's filesystem. Subpath

+

mounts are not allowed for ephemeral containers. Cannot be updated.

+

workingDir

+

String

+

Container's working directory. If not specified, the container

+

runtime's default will be used, which might be configured in the container

+

image. Cannot be updated.

+
+
+ +
+ + + + + + + + + + + + + +
Table 17 io.cci.otc.api.pkg.apis.versioned.cci.v2.HostAlias

Parameter

+

Type

+

Description

+

hostnames

+

Array of strings

+

Hostnames for the above IP address.

+

ip

+

String

+

IP address of the host file entry.

+
+
+ +
+ + + + + + + + + +
Table 18 io.cci.otc.api.pkg.apis.versioned.cci.v2.LocalObjectReference

Parameter

+

Type

+

Description

+

name

+

String

+

Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names

+
+
+ +
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Table 19 io.cci.otc.api.pkg.apis.versioned.cci.v2.Container

Parameter

+

Type

+

Description

+

args

+

Array of strings

+

Arguments to the entrypoint. The container image's CMD is used if this is not provided. Variable references $(VAR_NAME) are expanded using the container's environment. If a variable cannot be resolved, the reference in the input string will be unchanged. Double $$ are reduced to a single $, which allows for escaping the $(VAR_NAME) syntax: i.e. "$$(VAR_NAME)" will produce the string literal "$(VAR_NAME)". Escaped references will never be expanded, regardless of whether the variable exists or not. Cannot be updated. More info: https://kubernetes.io/docs/tasks/inject-data-application/define-command-argument-container/#running-a-command-in-a-shell

+

command

+

Array of strings

+

Entrypoint array. Not executed within a shell. The container image's ENTRYPOINT is used if this is not provided. Variable references $(VAR_NAME) are expanded using the container's environment. If a variable cannot be resolved, the reference in the input string will be unchanged. Double $$ are reduced to a single $, which allows for escaping the $(VAR_NAME) syntax: i.e. "$$(VAR_NAME)" will produce the string literal "$(VAR_NAME)". Escaped references will never be expanded, regardless of whether the variable exists or not. Cannot be updated. More info: https://kubernetes.io/docs/tasks/inject-data-application/define-command-argument-container/#running-a-command-in-a-shell

+

env

+

Array of io.cci.otc.api.pkg.apis.versioned.cci.v2.EnvVar objects

+

List of environment variables to set in the container. Cannot

+

be updated.

+

envFrom

+

Array of io.cci.otc.api.pkg.apis.versioned.cci.v2.EnvFromSource objects

+

List of sources to populate environment variables in the container.

+

The keys defined within a source must be a C_IDENTIFIER. All invalid keys

+

will be reported as an event when the container is starting. When a key

+

exists in multiple sources, the value associated with the last source will

+

take precedence. Values defined by an Env with a duplicate key will take

+

precedence. Cannot be updated.

+

image

+

String

+

Container image name. More info: https://kubernetes.io/docs/concepts/containers/images This field is optional to allow higher level config management to default or override container images in workload controllers like Deployments and StatefulSets.

+

lifecycle

+

io.cci.otc.api.pkg.apis.versioned.cci.v2.Lifecycle object

+

Actions that the management system should take in response to

+

container lifecycle events. Cannot be updated.

+

livenessProbe

+

io.cci.otc.api.pkg.apis.versioned.cci.v2.Probe object

+

Periodic probe of container liveness. Container will be restarted if the probe fails. Cannot be updated. More info: https://kubernetes.io/docs/concepts/workloads/pods/pod-lifecycle#container-probes

+

name

+

String

+

Name of the container specified as a DNS_LABEL. Each container

+

in a pod must have a unique name (DNS_LABEL). Cannot be updated.

+

ports

+

Array of io.cci.otc.api.pkg.apis.versioned.cci.v2.ContainerPort objects

+

List of ports to expose from the container. Not specifying a

+

port here DOES NOT prevent that port from being exposed. Any port which

+

is listening on the default "0.0.0.0" address inside a container will be

+

accessible from the network. Modifying this array with strategic merge patch

+

may corrupt the data. For more information See https://github.com/kubernetes/kubernetes/issues/108255.

+

Cannot be updated.

+

readinessProbe

+

io.cci.otc.api.pkg.apis.versioned.cci.v2.Probe object

+

Periodic probe of container service readiness. Container will be removed from service endpoints if the probe fails. Cannot be updated. More info: https://kubernetes.io/docs/concepts/workloads/pods/pod-lifecycle#container-probes

+

resources

+

io.cci.otc.api.pkg.apis.versioned.cci.v2.ResourceRequirements object

+

Compute Resources required by this container. Cannot be updated. More info: https://kubernetes.io/docs/concepts/configuration/manage-resources-containers/

+

securityContext

+

io.cci.otc.api.pkg.apis.versioned.cci.v2.SecurityContext object

+

SecurityContext defines the security options the container should be run with. If set, the fields of SecurityContext override the equivalent fields of PodSecurityContext. More info: https://kubernetes.io/docs/tasks/configure-pod-container/security-context/

+

startupProbe

+

io.cci.otc.api.pkg.apis.versioned.cci.v2.Probe object

+

StartupProbe indicates that the Pod has successfully initialized. If specified, no other probes are executed until this completes successfully. If this probe fails, the Pod will be restarted, just as if the livenessProbe failed. This can be used to provide different probe parameters at the beginning of a Pod's lifecycle, when it might take a long time to load data or warm a cache, than during steady-state operation. This cannot be updated. More info: https://kubernetes.io/docs/concepts/workloads/pods/pod-lifecycle#container-probes

+

stdin

+

Boolean

+

Whether this container should allocate a buffer for stdin in

+

the container runtime. If this is not set, reads from stdin in the container

+

will always result in EOF. Default is false.

+

stdinOnce

+

Boolean

+

Whether the container runtime should close the stdin channel

+

after it has been opened by a single attach. When stdin is true the stdin

+

stream will remain open across multiple attach sessions. If stdinOnce is

+

set to true, stdin is opened on container start, is empty until the first

+

client attaches to stdin, and then remains open and accepts data until the

+

client disconnects, at which time stdin is closed and remains closed until

+

the container is restarted. If this flag is false, a container processes

+

that reads from stdin will never receive an EOF. Default is false

+

terminationMessagePath

+

String

+

Optional: Path at which the file to which the container's termination message will be written is mounted into the container's filesystem. Message written is intended to be brief final status, such as an assertion failure message. Will be truncated by the node if greater than 4096 bytes. The total message length across all containers will be limited to 12kb. Defaults to /dev/termination-log. Cannot be updated.

+

terminationMessagePolicy

+

String

+

Indicate how the termination message should be populated. File will use the contents of terminationMessagePath to populate the container status message on both success and failure. FallbackToLogsOnError will use the last chunk of container log output if the termination message file is empty and the container exited with an error. The log output is limited to 2048 bytes or 80 lines, whichever is smaller. Defaults to File. Cannot be updated.

+

Possible enum values:

+
  • "FallbackToLogsOnError" will read the most recent contents of the container logs for the container status message when the container exits with an error and the terminationMessagePath has no contents.
  • "File" is the default behavior and will set the container status message to the contents of the container's terminationMessagePath when the container exits.
+

tty

+

Boolean

+

Whether this container should allocate a TTY for itself, also

+

requires 'stdin' to be true. Default is false.

+

volumeMounts

+

Array of io.cci.otc.api.pkg.apis.versioned.cci.v2.VolumeMount objects

+

Pod volumes to mount into the container's filesystem. Cannot

+

be updated.

+

workingDir

+

String

+

Container's working directory. If not specified, the container

+

runtime's default will be used, which might be configured in the container

+

image. Cannot be updated.

+
+
+ +
+ + + + + + + + + + + + + + + + + +
Table 20 io.cci.otc.api.pkg.apis.versioned.cci.v2.EnvVar

Parameter

+

Type

+

Description

+

name

+

String

+

Name of the environment variable. Must be a C_IDENTIFIER.

+

value

+

String

+

Variable references $(VAR_NAME) are expanded using the previously defined environment variables in the container and any service environment variables. If a variable cannot be resolved, the reference in the input string will be unchanged. Double $$ are reduced to a single $, which allows for escaping the $(VAR_NAME) syntax: i.e. "$$(VAR_NAME)" will produce the string literal "$(VAR_NAME)". Escaped references will never be expanded, regardless of whether the variable exists or not. Defaults to "".

+

valueFrom

+

io.cci.otc.api.pkg.apis.versioned.cci.v2.EnvVarSource object

+

Source for the environment variable's value. Cannot be used if

+

value is not empty.

+
+
+ +
+ + + + + + + + + + + + + + + + + + + + + +
Table 21 io.cci.otc.api.pkg.apis.versioned.cci.v2.EnvVarSource

Parameter

+

Type

+

Description

+

configMapKeyRef

+

io.cci.otc.api.pkg.apis.versioned.cci.v2.ConfigMapKeySelector object

+

Selects a key of a ConfigMap.

+

fieldRef

+

io.cci.otc.api.pkg.apis.versioned.cci.v2.ObjectFieldSelector object

+

Selects a field of the pod: supports metadata.name, metadata.namespace, metadata.labels['<KEY>'], metadata.annotations['<KEY>'], spec.nodeName, spec.serviceAccountName, status.hostIP, status.podIP, status.podIPs.

+

resourceFieldRef

+

io.cci.otc.api.pkg.apis.versioned.cci.v2.ResourceFieldSelector object

+

Selects a resource of the container: only resources limits and requests (limits.cpu, limits.memory, limits.ephemeral-storage, requests.cpu, requests.memory and requests.ephemeral-storage) are currently supported.

+

secretKeyRef

+

io.cci.otc.api.pkg.apis.versioned.cci.v2.SecretKeySelector object

+

Selects a key of a secret in the pod's namespace

+
+
+ +
+ + + + + + + + + + + + + + + + + +
Table 22 io.cci.otc.api.pkg.apis.versioned.cci.v2.ConfigMapKeySelector

Parameter

+

Type

+

Description

+

key

+

String

+

The key to select.

+

name

+

String

+

Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names

+

optional

+

Boolean

+

Specify whether the ConfigMap or its key must be defined

+
+
+ +
+ + + + + + + + + + + + + + + + + +
Table 23 io.cci.otc.api.pkg.apis.versioned.cci.v2.SecretKeySelector

Parameter

+

Type

+

Description

+

key

+

String

+

The key of the secret to select from. Must be a valid secret

+

key.

+

name

+

String

+

Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names

+

optional

+

Boolean

+

Specify whether the Secret or its key must be defined

+
+
+ +
+ + + + + + + + + + + + + + + + + +
Table 24 io.cci.otc.api.pkg.apis.versioned.cci.v2.EnvFromSource

Parameter

+

Type

+

Description

+

configMapRef

+

io.cci.otc.api.pkg.apis.versioned.cci.v2.ConfigMapEnvSource object

+

The ConfigMap to select from

+

prefix

+

String

+

An optional identifier to prepend to each key in the ConfigMap.

+

Must be a C_IDENTIFIER.

+

secretRef

+

io.cci.otc.api.pkg.apis.versioned.cci.v2.SecretEnvSource object

+

The Secret to select from

+
+
+ +
+ + + + + + + + + + + + + +
Table 25 io.cci.otc.api.pkg.apis.versioned.cci.v2.ConfigMapEnvSource

Parameter

+

Type

+

Description

+

name

+

String

+

Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names

+

optional

+

Boolean

+

Specify whether the ConfigMap must be defined

+
+
+ +
+ + + + + + + + + + + + + +
Table 26 io.cci.otc.api.pkg.apis.versioned.cci.v2.SecretEnvSource

Parameter

+

Type

+

Description

+

name

+

String

+

Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names

+

optional

+

Boolean

+

Specify whether the Secret must be defined

+
+
+ +
+ + + + + + + + + + + + + +
Table 27 io.cci.otc.api.pkg.apis.versioned.cci.v2.Lifecycle

Parameter

+

Type

+

Description

+

postStart

+

io.cci.otc.api.pkg.apis.versioned.cci.v2.LifecycleHandler object

+

PostStart is called immediately after a container is created. If the handler fails, the container is terminated and restarted according to its restart policy. Other management of the container blocks until the hook completes. More info: https://kubernetes.io/docs/concepts/containers/container-lifecycle-hooks/#container-hooks

+

preStop

+

io.cci.otc.api.pkg.apis.versioned.cci.v2.LifecycleHandler object

+

PreStop is called immediately before a container is terminated due to an API request or management event such as liveness/startup probe failure, preemption, resource contention, etc. The handler is not called if the container crashes or exits. The Pod's termination grace period countdown begins before the PreStop hook is executed. Regardless of the outcome of the handler, the container will eventually terminate within the Pod's termination grace period (unless delayed by finalizers). Other management of the container blocks until the hook completes or until the termination grace period is reached. More info: https://kubernetes.io/docs/concepts/containers/container-lifecycle-hooks/#container-hooks

+
+
+ +
+ + + + + + + + + + + + + +
Table 28 io.cci.otc.api.pkg.apis.versioned.cci.v2.LifecycleHandler

Parameter

+

Type

+

Description

+

exec

+

io.cci.otc.api.pkg.apis.versioned.cci.v2.ExecAction object

+

Exec specifies the action to take.

+

httpGet

+

io.cci.otc.api.pkg.apis.versioned.cci.v2.HTTPGetAction object

+

HTTPGet specifies the http request to perform.

+
+
+ +
+ + + + + + + + + + + + + + + + + +
Table 29 io.cci.otc.api.pkg.apis.versioned.cci.v2.ContainerPort

Parameter

+

Type

+

Description

+

containerPort

+

Integer

+

Number of port to expose on the pod's IP address. This must be

+

a valid port number, 0 < x < 65536.

+

name

+

String

+

If specified, this must be an IANA_SVC_NAME and unique within

+

the pod. Each named port in a pod must have a unique name. Name for the

+

port that can be referred to by services.

+

protocol

+

String

+

Protocol for port. Must be UDP, TCP, or SCTP. Defaults to "TCP".

+

Possible enum values:

+
  • "SCTP" is the SCTP protocol.
  • "TCP" is the TCP protocol.
  • "UDP" is the UDP protocol.
+
+
+ +
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Table 30 io.cci.otc.api.pkg.apis.versioned.cci.v2.SecurityContext

Parameter

+

Type

+

Description

+

capabilities

+

io.cci.otc.api.pkg.apis.versioned.cci.v2.Capabilities object

+

The capabilities to add/drop when running containers. Defaults

+

to the default set of capabilities granted by the container runtime. Note

+

that this field cannot be set when spec.os.name is windows.

+

procMount

+

String

+

procMount denotes the type of proc mount to use for the containers.

+

The default is DefaultProcMount which uses the container runtime defaults

+

for readonly paths and masked paths. This requires the ProcMountType feature

+

flag to be enabled. Note that this field cannot be set when spec.os.name

+

is windows.

+

readOnlyRootFilesystem

+

Boolean

+

Whether this container has a read-only root filesystem. Default

+

is false. Note that this field cannot be set when spec.os.name is windows.

+

runAsGroup

+

Long

+

The GID to run the entrypoint of the container process. Uses

+

runtime default if unset. May also be set in PodSecurityContext. If set

+

in both SecurityContext and PodSecurityContext, the value specified in SecurityContext

+

takes precedence. Note that this field cannot be set when spec.os.name is

+

windows.

+

runAsNonRoot

+

Boolean

+

Indicates that the container must run as a non-root user. If

+

true, the Kubelet will validate the image at runtime to ensure that it does

+

not run as UID 0 (root) and fail to start the container if it does. If unset

+

or false, no such validation will be performed. May also be set in PodSecurityContext. If

+

set in both SecurityContext and PodSecurityContext, the value specified

+

in SecurityContext takes precedence.

+

runAsUser

+

Long

+

The UID to run the entrypoint of the container process. Defaults

+

to user specified in image metadata if unspecified. May also be set in PodSecurityContext. If

+

set in both SecurityContext and PodSecurityContext, the value specified

+

in SecurityContext takes precedence. Note that this field cannot be set

+

when spec.os.name is windows.

+
+
+ +
+ + + + + + + + + + + + + +
Table 31 io.cci.otc.api.pkg.apis.versioned.cci.v2.Capabilities

Parameter

+

Type

+

Description

+

add

+

Array of strings

+

Added capabilities

+

drop

+

Array of strings

+

Removed capabilities

+
+
+ +
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Table 32 io.cci.otc.api.pkg.apis.versioned.cci.v2.Probe

Parameter

+

Type

+

Description

+

exec

+

io.cci.otc.api.pkg.apis.versioned.cci.v2.ExecAction object

+

Exec specifies the action to take.

+

failureThreshold

+

Integer

+

Minimum consecutive failures for the probe to be considered failed

+

after having succeeded. Defaults to 3. Minimum value is 1.

+

httpGet

+

io.cci.otc.api.pkg.apis.versioned.cci.v2.HTTPGetAction object

+

HTTPGet specifies the http request to perform.

+

initialDelaySeconds

+

Integer

+

Number of seconds after the container has started before liveness probes are initiated. More info: https://kubernetes.io/docs/concepts/workloads/pods/pod-lifecycle#container-probes

+

periodSeconds

+

Integer

+

How often (in seconds) to perform the probe. Default to 10 seconds.

+

Minimum value is 1.

+

successThreshold

+

Integer

+

Minimum consecutive successes for the probe to be considered

+

successful after having failed. Defaults to 1. Must be 1 for liveness and

+

startup. Minimum value is 1.

+

tcpSocket

+

io.cci.otc.api.pkg.apis.versioned.cci.v2.TCPSocketAction object

+

TCPSocket specifies an action involving a TCP port.

+

terminationGracePeriodSeconds

+

Long

+

Optional duration in seconds the pod needs to terminate gracefully

+

upon probe failure. The grace period is the duration in seconds after the

+

processes running in the pod are sent a termination signal and the time

+

when the processes are forcibly halted with a kill signal. Set this value

+

longer than the expected cleanup time for your process. If this value is

+

nil, the pod's terminationGracePeriodSeconds will be used. Otherwise, this

+

value overrides the value provided by the pod spec. Value must be non-negative

+

integer. The value zero indicates stop immediately via the kill signal (no

+

opportunity to shut down). This is a beta field and requires enabling ProbeTerminationGracePeriod

+

feature gate. Minimum value is 1. spec.terminationGracePeriodSeconds is

+

used if unset.

+

timeoutSeconds

+

Integer

+

Number of seconds after which the probe times out. Defaults to 1 second. Minimum value is 1. More info: https://kubernetes.io/docs/concepts/workloads/pods/pod-lifecycle#container-probes

+
+
+ +
+ + + + + + + + + +
Table 33 io.cci.otc.api.pkg.apis.versioned.cci.v2.ExecAction

Parameter

+

Type

+

Description

+

command

+

Array of strings

+

Command is the command line to execute inside the container,

+

the working directory for the command is root ('/') in the container's

+

filesystem. The command is simply exec'd, it is not run inside a shell,

+

so traditional shell instructions ('|', etc) won't work. To use a shell,

+

you need to explicitly call out to that shell. Exit status of 0 is treated

+

as live/healthy and non-zero is unhealthy.

+
+
+ +
+ + + + + + + + + + + + + + + + + + + + + + + + + +
Table 34 io.cci.otc.api.pkg.apis.versioned.cci.v2.HTTPGetAction

Parameter

+

Type

+

Description

+

host

+

String

+

Host name to connect to, defaults to the pod IP. You probably

+

want to set "Host" in httpHeaders instead.

+

httpHeaders

+

Array of io.cci.otc.api.pkg.apis.versioned.cci.v2.HTTPHeader objects

+

Custom headers to set in the request. HTTP allows repeated headers.

+

path

+

String

+

Path to access on the HTTP server.

+

port

+

String

+

Name or number of the port to access on the container. Number

+

must be in the range 1 to 65535. Name must be an IANA_SVC_NAME.

+

scheme

+

String

+

Scheme to use for connecting to the host. Defaults to HTTP.

+

Possible enum values:

+
  • "HTTP" means that the scheme used will be http://
  • "HTTPS" means that the scheme used will be https://
+
+
+ +
+ + + + + + + + + + + + + +
Table 35 io.cci.otc.api.pkg.apis.versioned.cci.v2.HTTPHeader

Parameter

+

Type

+

Description

+

name

+

String

+

The header field name

+

value

+

String

+

The header field value

+
+
+ +
+ + + + + + + + + + + + + +
Table 36 io.cci.otc.api.pkg.apis.versioned.cci.v2.TCPSocketAction

Parameter

+

Type

+

Description

+

host

+

String

+

Optional: Host name to connect to, defaults to the pod IP.

+

port

+

String

+

Number or name of the port to access on the container. Number

+

must be in the range 1 to 65535. Name must be an IANA_SVC_NAME.

+
+
+ +
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Table 37 io.cci.otc.api.pkg.apis.versioned.cci.v2.VolumeMount

Parameter

+

Type

+

Description

+

extendPathMode

+

String

+

Extend the volume path by appending the pod metadata to the path

+

according to specified pattern. which provide a way of directory isolation

+

and help prevent the writing conflict between different pods.

+

mountPath

+

String

+

Path within the container at which the volume should be mounted. Must

+

not contain ':'.

+

name

+

String

+

This must match the Name of a Volume.

+

readOnly

+

Boolean

+

Mounted read-only if true, read-write otherwise (false or unspecified).

+

Defaults to false.

+

subPath

+

String

+

Path within the volume from which the container's volume should

+

be mounted. Defaults to "" (volume's root).

+

subPathExpr

+

String

+

Expanded path within the volume from which the container's volume

+

should be mounted. Behaves similarly to SubPath but environment variable

+

references $(VAR_NAME) are expanded using the container's environment. Defaults

+

to "" (volume's root). SubPathExpr and SubPath are mutually exclusive.

+
+
+ +
+ + + + + + + + + +
Table 38 io.cci.otc.api.pkg.apis.versioned.cci.v2.PodReadinessGate

Parameter

+

Type

+

Description

+

conditionType

+

String

+

ConditionType refers to a condition in the pod's condition list

+

with matching type.

+
+
+ +
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Table 39 io.cci.otc.api.pkg.apis.versioned.cci.v2.PodSecurityContext

Parameter

+

Type

+

Description

+

fsGroup

+

Long

+

A special supplemental group that applies to all containers in a pod. Some volume types allow the Kubelet to change the ownership of that volume to be owned by the pod:

+
  1. The owning GID will be the FSGroup 2. The setgid bit is set (new files created in the volume will be owned by FSGroup) 3. The permission bits are OR'd with rw-rw----
+

If unset, the Kubelet will not modify the ownership and permissions of any volume. Note that this field cannot be set when spec.os.name is windows.

+

fsGroupChangePolicy

+

String

+

fsGroupChangePolicy defines behavior of changing ownership and permission of the volume before being exposed inside Pod. This field will only apply to volume types which support fsGroup based ownership(and permissions). It will have no effect on ephemeral volume types such as: secret, configmaps and emptydir. Valid values are "OnRootMismatch" and "Always". If not specified, "Always" is used. Note that this field cannot be set when spec.os.name is windows.

+

runAsGroup

+

Long

+

The GID to run the entrypoint of the container process. Uses

+

runtime default if unset. May also be set in SecurityContext. If set in

+

both SecurityContext and PodSecurityContext, the value specified in SecurityContext

+

takes precedence for that container. Note that this field cannot be set

+

when spec.os.name is windows.

+

runAsNonRoot

+

Boolean

+

Indicates that the container must run as a non-root user. If

+

true, the Kubelet will validate the image at runtime to ensure that it does

+

not run as UID 0 (root) and fail to start the container if it does. If unset

+

or false, no such validation will be performed. May also be set in SecurityContext. If

+

set in both SecurityContext and PodSecurityContext, the value specified

+

in SecurityContext takes precedence.

+

runAsUser

+

Long

+

The UID to run the entrypoint of the container process. Defaults

+

to user specified in image metadata if unspecified. May also be set in SecurityContext. If

+

set in both SecurityContext and PodSecurityContext, the value specified

+

in SecurityContext takes precedence for that container. Note that this field

+

cannot be set when spec.os.name is windows.

+

supplementalGroups

+

Array of longs

+

A list of groups applied to the first process run in each container,

+

in addition to the container's primary GID. If unspecified, no groups will

+

be added to any container. Note that this field cannot be set when spec.os.name

+

is windows.

+

sysctls

+

Array of io.cci.otc.api.pkg.apis.versioned.cci.v2.Sysctl objects

+

Sysctls hold a list of namespaced sysctls used for the pod. Pods

+

with unsupported sysctls (by the container runtime) might fail to launch.

+

Note that this field cannot be set when spec.os.name is windows.

+
+
+ +
+ + + + + + + + + + + + + +
Table 40 io.cci.otc.api.pkg.apis.versioned.cci.v2.Sysctl

Parameter

+

Type

+

Description

+

name

+

String

+

Name of a property to set

+

value

+

String

+

Value of a property to set

+
+
+ +
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Table 41 io.cci.otc.api.pkg.apis.versioned.cci.v2.TopologySpreadConstraint

Parameter

+

Type

+

Description

+

labelSelector

+

io.k8s.apimachinery.pkg.apis.meta.v1.LabelSelector object

+

LabelSelector is used to find matching pods. Pods that match

+

this label selector are counted to determine the number of pods in their

+

corresponding topology domain.

+

matchLabelKeys

+

Array of strings

+

MatchLabelKeys is a set of pod label keys to select the pods

+

over which spreading will be calculated. The keys are used to lookup values

+

from the incoming pod labels, those key-value labels are ANDed with labelSelector

+

to select the group of existing pods over which spreading will be calculated

+

for the incoming pod. Keys that don't exist in the incoming pod labels will

+

be ignored. A null or empty list means only match against labelSelector.

+

maxSkew

+

Integer

+

MaxSkew describes the degree to which pods may be unevenly distributed. When whenUnsatisfiable=DoNotSchedule, it is the maximum permitted difference between the number of matching pods in the target topology and the global minimum. The global minimum is the minimum number of matching pods in an eligible domain or zero if the number of eligible domains is less than MinDomains. For example, in a 3-zone cluster, MaxSkew is set to 1, and pods with the same labelSelector spread as 2/2/1: In this case, the global minimum is 1. | zone1 | zone2 | zone3 | | P P | P P | P | - if MaxSkew is 1, incoming pod can only be scheduled to zone3 to become 2/2/2; scheduling it onto zone1(zone2) would make the ActualSkew(3-1) on zone1(zone2) violate MaxSkew(1). - if MaxSkew is 2, incoming pod can be scheduled onto any zone. When whenUnsatisfiable=ScheduleAnyway, it is used to give higher precedence to topologies that satisfy it. It's a required field. Default value is 1 and 0 is not allowed.

+

minDomains

+

Integer

+

MinDomains indicates a minimum number of eligible domains. When the number of eligible domains with matching topology keys is less than minDomains, Pod Topology Spread treats "global minimum" as 0, and then the calculation of Skew is performed. And when the number of eligible domains with matching topology keys equals or greater than minDomains, this value has no effect on scheduling. As a result, when the number of eligible domains is less than minDomains, scheduler won't schedule more than maxSkew Pods to those domains. If value is nil, the constraint behaves as if MinDomains is equal to 1. Valid values are integers greater than 0. When value is not nil, WhenUnsatisfiable must be DoNotSchedule.

+

For example, in a 3-zone cluster, MaxSkew is set to 2, MinDomains is set to 5 and pods with the same labelSelector spread as 2/2/2: | zone1 | zone2 | zone3 | | P P | P P | P P | The number of domains is less than 5(MinDomains), so "global minimum" is treated as 0. In this situation, new pod with the same labelSelector cannot be scheduled, because computed skew will be 3(3 - 0) if new Pod is scheduled to any of the three zones, it will violate MaxSkew.

+

This is a beta field and requires the MinDomainsInPodTopologySpread feature gate to be enabled (enabled by default).

+

nodeAffinityPolicy

+

String

+

NodeAffinityPolicy indicates how we will treat Pod's nodeAffinity/nodeSelector when calculating pod topology spread skew. Options are: - Honor: only nodes matching nodeAffinity/nodeSelector are included in the calculations. - Ignore: nodeAffinity/nodeSelector are ignored. All nodes are included in the calculations.

+

If this value is nil, the behavior is equivalent to the Honor policy. This is a alpha-level feature enabled by the NodeInclusionPolicyInPodTopologySpread feature flag.

+

nodeTaintsPolicy

+

String

+

NodeTaintsPolicy indicates how we will treat node taints when calculating pod topology spread skew. Options are: - Honor: nodes without taints, along with tainted nodes for which the incoming pod has a toleration, are included. - Ignore: node taints are ignored. All nodes are included.

+

If this value is nil, the behavior is equivalent to the Ignore policy. This is a alpha-level feature enabled by the NodeInclusionPolicyInPodTopologySpread feature flag.

+

topologyKey

+

String

+

TopologyKey is the key of node labels. Nodes that have a label

+

with this key and identical values are considered to be in the same topology.

+

We consider each <key, value> as a "bucket", and try to put balanced number

+

of pods into each bucket. We define a domain as a particular instance of

+

a topology. Also, we define an eligible domain as a domain whose nodes meet

+

the requirements of nodeAffinityPolicy and nodeTaintsPolicy. e.g. If TopologyKey

+

is "kubernetes.io/hostname", each Node is a domain of that topology. And,

+

if TopologyKey is "topology.kubernetes.io/zone", each zone is a domain of

+

that topology. It's a required field.

+

whenUnsatisfiable

+

String

+

WhenUnsatisfiable indicates how to deal with a pod if it doesn't satisfy the spread constraint. - DoNotSchedule (default) tells the scheduler not to schedule it. - ScheduleAnyway tells the scheduler to schedule the pod in any location,

+

but giving higher precedence to topologies that would help reduce the

+

skew.

+

A constraint is considered "Unsatisfiable" for an incoming pod if and only if every possible node assignment for that pod would violate "MaxSkew" on some topology. For example, in a 3-zone cluster, MaxSkew is set to 1, and pods with the same labelSelector spread as 3/1/1: | zone1 | zone2 | zone3 | | P P P | P | P | If WhenUnsatisfiable is set to DoNotSchedule, incoming pod can only be scheduled to zone2(zone3) to become 3/2/1(3/1/2) as ActualSkew(2-1) on zone2(zone3) satisfies MaxSkew(1). In other words, the cluster can still be imbalanced, but scheduler won't make it more imbalanced. It's a required field.

+

Possible enum values:

+
  • "DoNotSchedule" instructs the scheduler not to schedule the pod when constraints are not satisfied.
  • "ScheduleAnyway" instructs the scheduler to schedule the pod even if constraints are not satisfied.
+
+
+ +
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Table 42 io.cci.otc.api.pkg.apis.versioned.cci.v2.Volume

Parameter

+

Type

+

Description

+

configMap

+

io.cci.otc.api.pkg.apis.versioned.cci.v2.ConfigMapVolumeSource object

+

configMap represents a configMap that should populate this volume

+

downwardAPI

+

io.cci.otc.api.pkg.apis.versioned.cci.v2.DownwardAPIVolumeSource object

+

downwardAPI represents downward API about the pod that should

+

populate this volume

+

emptyDir

+

io.cci.otc.api.pkg.apis.versioned.cci.v2.EmptyDirVolumeSource object

+

emptyDir represents a temporary directory that shares a pod's lifetime. More info: https://kubernetes.io/docs/concepts/storage/volumes#emptydir

+

ephemeral

+

io.cci.otc.api.pkg.apis.versioned.cci.v2.EphemeralVolumeSource object

+

ephemeral represents a volume that is handled by a cluster storage driver. The volume's lifecycle is tied to the pod that defines it - it will be created before the pod starts, and deleted when the pod is removed.

+

Use this if: a) the volume is only needed while the pod runs, b) features of normal volumes like restoring from snapshot or capacity

+

tracking are needed,

+

c) the storage driver is specified through a storage class, and d) the storage driver supports dynamic volume provisioning through

+

a PersistentVolumeClaim (see EphemeralVolumeSource for more

+

information on the connection between this volume type

+

and PersistentVolumeClaim).

+

Use PersistentVolumeClaim or one of the vendor-specific APIs for volumes that persist for longer than the lifecycle of an individual pod.

+

Use CSI for light-weight local ephemeral volumes if the CSI driver is meant to be used that way - see the documentation of the driver for more information.

+

A pod can use both types of ephemeral volumes and persistent volumes at the same time.

+

name

+

String

+

name of the volume. Must be a DNS_LABEL and unique within the pod. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names

+

nfs

+

io.cci.otc.api.pkg.apis.versioned.cci.v2.NFSVolumeSource object

+

nfs represents an NFS mount on the host that shares a pod's lifetime More info: https://kubernetes.io/docs/concepts/storage/volumes#nfs

+

persistentVolumeClaim

+

io.cci.otc.api.pkg.apis.versioned.cci.v2.PersistentVolumeClaimVolumeSource object

+

persistentVolumeClaimVolumeSource represents a reference to a PersistentVolumeClaim in the same namespace. More info: https://kubernetes.io/docs/concepts/storage/persistent-volumes#persistentvolumeclaims

+

projected

+

io.cci.otc.api.pkg.apis.versioned.cci.v2.ProjectedVolumeSource object

+

projected items for all in one resources secrets, configmaps,

+

and downward API

+

secret

+

io.cci.otc.api.pkg.apis.versioned.cci.v2.SecretVolumeSource object

+

secret represents a secret that should populate this volume. More info: https://kubernetes.io/docs/concepts/storage/volumes#secret

+
+
+ +
+ + + + + + + + + + + + + + + + + + + + + +
Table 43 io.cci.otc.api.pkg.apis.versioned.cci.v2.ConfigMapVolumeSource

Parameter

+

Type

+

Description

+

defaultMode

+

Integer

+

defaultMode is optional: mode bits used to set permissions on created files by default. Must be an octal value between 0000 and 0777 or a decimal value between 0 and 511. YAML accepts both octal and decimal values, JSON requires decimal values for mode bits. Defaults to 0644. Directories within the path are not affected by this setting. This might be in conflict with other options that affect the file mode, like fsGroup, and the result can be other mode bits set.

+

items

+

Array of io.cci.otc.api.pkg.apis.versioned.cci.v2.KeyToPath objects

+

items if unspecified, each key-value pair in the Data field of

+

the referenced ConfigMap will be projected into the volume as a file whose

+

name is the key and content is the value. If specified, the listed keys

+

will be projected into the specified paths, and unlisted keys will not be

+

present. If a key is specified which is not present in the ConfigMap, the

+

volume setup will error unless it is marked optional. Paths must be relative

+

and may not contain the '..' path or start with '..'.

+

name

+

String

+

Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names

+

optional

+

Boolean

+

optional specify whether the ConfigMap or its keys must be defined

+
+
+ +
+ + + + + + + + + + + + + +
Table 44 io.cci.otc.api.pkg.apis.versioned.cci.v2.DownwardAPIVolumeSource

Parameter

+

Type

+

Description

+

defaultMode

+

Integer

+

Optional: mode bits to use on created files by default. Must be a Optional: mode bits used to set permissions on created files by default. Must be an octal value between 0000 and 0777 or a decimal value between 0 and 511. YAML accepts both octal and decimal values, JSON requires decimal values for mode bits. Defaults to 0644. Directories within the path are not affected by this setting. This might be in conflict with other options that affect the file mode, like fsGroup, and the result can be other mode bits set.

+

items

+

Array of io.cci.otc.api.pkg.apis.versioned.cci.v2.DownwardAPIVolumeFile objects

+

Items is a list of downward API volume file

+
+
+ +
+ + + + + + + + + + + + + +
Table 45 io.cci.otc.api.pkg.apis.versioned.cci.v2.EmptyDirVolumeSource

Parameter

+

Type

+

Description

+

medium

+

String

+

medium represents what type of storage medium should back this directory. The default is "" which means to use the node's default medium. Must be an empty string (default) or Memory. More info: https://kubernetes.io/docs/concepts/storage/volumes#emptydir

+

sizeLimit

+

String

+

sizeLimit is the total amount of local storage required for this EmptyDir volume. The size limit is also applicable for memory medium. The maximum usage on memory medium EmptyDir would be the minimum value between the SizeLimit specified here and the sum of memory limits of all containers in a pod. The default is nil which means that the limit is undefined. More info: http://kubernetes.io/docs/user-guide/volumes#emptydir

+
+
+ +
+ + + + + + + + + +
Table 46 io.cci.otc.api.pkg.apis.versioned.cci.v2.EphemeralVolumeSource

Parameter

+

Type

+

Description

+

volumeClaimTemplate

+

io.cci.otc.api.pkg.apis.versioned.cci.v2.PersistentVolumeClaimTemplate object

+

Will be used to create a stand-alone PVC to provision the volume. The pod in which this EphemeralVolumeSource is embedded will be the owner of the PVC, i.e. the PVC will be deleted together with the pod. The name of the PVC will be <pod name>-<volume name> where <volume name> is the name from the PodSpec.Volumes array entry. Pod validation will reject the pod if the concatenated name is not valid for a PVC (for example, too long).

+

An existing PVC with that name that is not owned by the pod will not be used for the pod to avoid using an unrelated volume by mistake. Starting the pod is then blocked until the unrelated PVC is removed. If such a pre-created PVC is meant to be used by the pod, the PVC has to updated with an owner reference to the pod once the pod exists. Normally this should not be necessary, but it may be useful when manually reconstructing a broken cluster.

+

This field is read-only and no changes will be made by Kubernetes to the PVC after it has been created.

+

Required, must not be nil.

+
+
+ +
+ + + + + + + + + + + + + +
Table 47 io.cci.otc.api.pkg.apis.versioned.cci.v2.PersistentVolumeClaimTemplate

Parameter

+

Type

+

Description

+

metadata

+

io.k8s.apimachinery.pkg.apis.meta.v1.ObjectMeta object

+

May contain labels and annotations that will be copied into the

+

PVC when creating it. No other fields are allowed and will be rejected during

+

validation.

+

spec

+

io.cci.otc.api.pkg.apis.versioned.cci.v2.PersistentVolumeClaimSpec object

+

The specification for the PersistentVolumeClaim. The entire content

+

is copied unchanged into the PVC that gets created from this template. The

+

same fields as in a PersistentVolumeClaim are also valid here.

+
+
+ +
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Table 48 io.k8s.apimachinery.pkg.apis.meta.v1.ObjectMeta

Parameter

+

Type

+

Description

+

annotations

+

Map<String,String>

+

Annotations is an unstructured key value map stored with a resource that may be set by external tools to store and retrieve arbitrary metadata. They are not queryable and should be preserved when modifying objects. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/annotations/

+

clusterName

+

String

+

The name of the cluster which the object belongs to. This is

+

used to distinguish resources with same name and namespace in different

+

clusters. This field is not set anywhere right now and apiserver is going

+

to ignore it if set in create or update request.

+

creationTimestamp

+

String

+

CreationTimestamp is a timestamp representing the server time when this object was created. It is not guaranteed to be set in happens-before order across separate operations. Clients may not set this value. It is represented in RFC3339 form and is in UTC.

+

Populated by the system. Read-only. Null for lists. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata

+

deletionGracePeriodSeconds

+

Long

+

Number of seconds allowed for this object to gracefully terminate

+

before it will be removed from the system. Only set when deletionTimestamp

+

is also set. May only be shortened. Read-only.

+

deletionTimestamp

+

String

+

DeletionTimestamp is RFC 3339 date and time at which this resource will be deleted. This field is set by the server when a graceful deletion is requested by the user, and is not directly settable by a client. The resource is expected to be deleted (no longer visible from resource lists, and not reachable by name) after the time in this field, once the finalizers list is empty. As long as the finalizers list contains items, deletion is blocked. Once the deletionTimestamp is set, this value may not be unset or be set further into the future, although it may be shortened or the resource may be deleted prior to this time. For example, a user may request that a pod is deleted in 30 seconds. The Kubelet will react by sending a graceful termination signal to the containers in the pod. After that 30 seconds, the Kubelet will send a hard termination signal (SIGKILL) to the container and after cleanup, remove the pod from the API. In the presence of network partitions, this object may still exist after this timestamp, until an administrator or automated process can determine the resource is fully terminated. If not set, graceful deletion of the object has not been requested.

+

Populated by the system when a graceful deletion is requested. Read-only. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata

+

enable

+

Boolean

+

Enable identifies whether the resource is available

+

finalizers

+

Array of strings

+

Must be empty before the object is deleted from the registry.

+

Each entry is an identifier for the responsible component that will remove

+

the entry from the list. If the deletionTimestamp of the object is non-nil,

+

entries in this list can only be removed. Finalizers may be processed and

+

removed in any order. Order is NOT enforced because it introduces significant

+

risk of stuck finalizers. finalizers is a shared field, any actor with permission

+

can reorder it. If the finalizer list is processed in order, then this can

+

lead to a situation in which the component responsible for the first finalizer

+

in the list is waiting for a signal (field value, external system, or other)

+

produced by a component responsible for a finalizer later in the list, resulting

+

in a deadlock. Without enforced ordering finalizers are free to order amongst

+

themselves and are not vulnerable to ordering changes in the list.

+

generateName

+

String

+

GenerateName is an optional prefix, used by the server, to generate a unique name ONLY IF the Name field has not been provided. If this field is used, the name returned to the client will be different than the name passed. This value will also be combined with a unique suffix. The provided value has the same validation rules as the Name field, and may be truncated by the length of the suffix required to make the value unique on the server.

+

If this field is specified and the generated name exists, the server will NOT return a 409 - instead, it will either return 201 Created or 500 with Reason ServerTimeout indicating a unique name could not be found in the time allotted, and the client should retry (optionally after the time indicated in the Retry-After header).

+

Applied only if Name is not specified. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#idempotency

+

generation

+

Long

+

A sequence number representing a specific generation of the desired

+

state. Populated by the system. Read-only.

+

labels

+

Map<String,String>

+

Map of string keys and values that can be used to organize and categorize (scope and select) objects. May match selectors of replication controllers and services. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/labels/

+

managedFields

+

Array of io.k8s.apimachinery.pkg.apis.meta.v1.ManagedFieldsEntry objects

+

ManagedFields maps workflow-id and version to the set of fields

+

that are managed by that workflow. This is mostly for internal housekeeping,

+

and users typically shouldn't need to set or understand this field. A workflow

+

can be the user's name, a controller's name, or the name of a specific apply

+

path like "ci-cd". The set of fields is always in the version that the workflow

+

used when modifying the object.

+

name

+

String

+

Name must be unique within a namespace. Is required when creating resources, although some resources may allow a client to request the generation of an appropriate name automatically. Name is primarily intended for creation idempotence and configuration definition. Cannot be updated. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names

+

namespace

+

String

+

Namespace defines the space within which each name must be unique. An empty namespace is equivalent to the "default" namespace, but "default" is the canonical representation. Not all objects are required to be scoped to a namespace - the value of this field for those objects will be empty.

+

Must be a DNS_LABEL. Cannot be updated. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/namespaces/

+

ownerReferences

+

Array of io.k8s.apimachinery.pkg.apis.meta.v1.OwnerReference objects

+

List of objects depended by this object. If ALL objects in the

+

list have been deleted, this object will be garbage collected. If this object

+

is managed by a controller, then an entry in this list will point to this

+

controller, with the controller field set to true. There cannot be more

+

than one managing controller.

+

resourceVersion

+

String

+

An opaque value that represents the internal version of this object that can be used by clients to determine when objects have changed. May be used for optimistic concurrency, change detection, and the watch operation on a resource or set of resources. Clients must treat these values as opaque and passed unmodified back to the server. They may only be valid for a particular resource or set of resources.

+

Populated by the system. Read-only. Value must be treated as opaque by clients and . More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#concurrency-control-and-consistency

+

selfLink

+

String

+

SelfLink is a URL representing this object. Populated by the system. Read-only.

+

DEPRECATED Kubernetes will stop propagating this field in 1.20 release and the field is planned to be removed in 1.21 release.

+

uid

+

String

+

UID is the unique in time and space value for this object. It is typically generated by the server on successful creation of a resource and is not allowed to change on PUT operations.

+

Populated by the system. Read-only. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#uids

+
+
+ +
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Table 49 io.k8s.apimachinery.pkg.apis.meta.v1.ManagedFieldsEntry

Parameter

+

Type

+

Description

+

apiVersion

+

String

+

APIVersion defines the version of this resource that this field

+

set applies to. The format is "group/version" just like the top-level APIVersion

+

field. It is necessary to track the version of a field set because it cannot

+

be automatically converted.

+

fieldsType

+

String

+

FieldsType is the discriminator for the different fields format and version. There is currently only one possible value: "FieldsV1"

+

fieldsV1

+

Object

+

FieldsV1 holds the first JSON version format as described in

+

the "FieldsV1" type.

+

manager

+

String

+

Manager is an identifier of the workflow managing these fields.

+

operation

+

String

+

Operation is the type of operation which lead to this ManagedFieldsEntry

+

being created. The only valid values for this field are 'Apply' and 'Update'.

+

time

+

String

+

Time is timestamp of when these fields were set. It should always

+

be empty if Operation is 'Apply'

+
+
+ +
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Table 50 io.k8s.apimachinery.pkg.apis.meta.v1.OwnerReference

Parameter

+

Type

+

Description

+

apiVersion

+

String

+

API version of the referent.

+

blockOwnerDeletion

+

Boolean

+

If true, AND if the owner has the "foregroundDeletion" finalizer,

+

then the owner cannot be deleted from the key-value store until this reference

+

is removed. Defaults to false. To set this field, a user needs "delete"

+

permission of the owner, otherwise 422 (Unprocessable Entity) will be returned.

+

controller

+

Boolean

+

If true, this reference points to the managing controller.

+

kind

+

String

+

Kind of the referent. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds

+

name

+

String

+

Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names

+

uid

+

String

+

UID of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#uids

+
+
+ +
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Table 51 io.cci.otc.api.pkg.apis.versioned.cci.v2.PersistentVolumeClaimSpec

Parameter

+

Type

+

Description

+

accessModes

+

Array of strings

+

accessModes contains the desired access modes the volume should have. More info: https://kubernetes.io/docs/concepts/storage/persistent-volumes#access-modes-1

+

dataSource

+

io.cci.otc.api.pkg.apis.versioned.cci.v2.TypedLocalObjectReference object

+

dataSource field can be used to specify either: * An existing VolumeSnapshot object (snapshot.storage.k8s.io/VolumeSnapshot) * An existing PVC (PersistentVolumeClaim) If the provisioner or an external controller can support the specified data source, it will create a new volume based on the contents of the specified data source. If the AnyVolumeDataSource feature gate is enabled, this field will always have the same contents as the DataSourceRef field.

+

dataSourceRef

+

io.cci.otc.api.pkg.apis.versioned.cci.v2.TypedLocalObjectReference object

+

dataSourceRef specifies the object from which to populate the volume with data, if a non-empty volume is desired. This may be any local object from a non-empty API group (non core object) or a PersistentVolumeClaim object. When this field is specified, volume binding will only succeed if the type of the specified object matches some installed volume populator or dynamic provisioner. This field will replace the functionality of the DataSource field and as such if both fields are non-empty, they must have the same value. For backwards compatibility, both fields (DataSource and DataSourceRef) will be set to the same value automatically if one of them is empty and the other is non-empty. There are two important differences between DataSource and DataSourceRef: * While DataSource only allows two specific types of objects, DataSourceRef

+

allows any non-core object, as well as PersistentVolumeClaim objects.

+
  • While DataSource ignores disallowed values (dropping them), DataSourceRef

    preserves all values, and generates an error if a disallowed value is

    +

    specified.

    +

    (Beta) Using this field requires the AnyVolumeDataSource feature gate to be enabled.

    +
+

resources

+

io.cci.otc.api.pkg.apis.versioned.cci.v2.ResourceRequirements object

+

resources represents the minimum resources the volume should have. If RecoverVolumeExpansionFailure feature is enabled users are allowed to specify resource requirements that are lower than previous value but must still be higher than capacity recorded in the status field of the claim. More info: https://kubernetes.io/docs/concepts/storage/persistent-volumes#resources

+

selector

+

io.k8s.apimachinery.pkg.apis.meta.v1.LabelSelector object

+

selector is a label query over volumes to consider for binding.

+

storageClassName

+

String

+

storageClassName is the name of the StorageClass required by the claim. More info: https://kubernetes.io/docs/concepts/storage/persistent-volumes#class-1

+

volumeMode

+

String

+

volumeMode defines what type of volume is required by the claim.

+

Value of Filesystem is implied when not included in claim spec.

+

volumeName

+

String

+

volumeName is the binding reference to the PersistentVolume backing

+

this claim.

+
+
+ +
+ + + + + + + + + + + + + + + + + +
Table 52 io.cci.otc.api.pkg.apis.versioned.cci.v2.TypedLocalObjectReference

Parameter

+

Type

+

Description

+

apiGroup

+

String

+

APIGroup is the group for the resource being referenced. If APIGroup

+

is not specified, the specified Kind must be in the core API group. For

+

any other third-party types, APIGroup is required.

+

kind

+

String

+

Kind is the type of resource being referenced

+

name

+

String

+

Name is the name of resource being referenced

+
+
+ +
+ + + + + + + + + + + + + +
Table 53 io.cci.otc.api.pkg.apis.versioned.cci.v2.ResourceRequirements

Parameter

+

Type

+

Description

+

limits

+

Map<String,String>

+

Limits describes the maximum amount of compute resources allowed. More info: https://kubernetes.io/docs/concepts/configuration/manage-resources-containers/

+

requests

+

Map<String,String>

+

Requests describes the minimum amount of compute resources required. If Requests is omitted for a container, it defaults to Limits if that is explicitly specified, otherwise to an implementation-defined value. More info: https://kubernetes.io/docs/concepts/configuration/manage-resources-containers/

+
+
+ +
+ + + + + + + + + +
Table 54 io.k8s.apimachinery.pkg.api.resource.Quantity

Parameter

+

Type

+

Description

+

-

+

String

+

Quantity is a fixed-point representation of a number. It provides convenient marshaling/unmarshaling in JSON and YAML, in addition to String() and AsInt64() accessors.

+

The serialization format is:

+

[/topic/body/section/table/tgroup/tbody/row/entry/p/br {""}) (br] ::= [/topic/body/section/table/tgroup/tbody/row/entry/p/br {""}) (br][/topic/body/section/table/tgroup/tbody/row/entry/p/br {""}) (br]

+

(Note that [/topic/body/section/table/tgroup/tbody/row/entry/p/br {""}) (br] may be empty, from the "" case in [/topic/body/section/table/tgroup/tbody/row/entry/p/br {""}) (br].)

+

[/topic/body/section/table/tgroup/tbody/row/entry/p/br {""}) (br] ::= 0 | 1 | ... | 9 [/topic/body/section/table/tgroup/tbody/row/entry/p/br {""}) (br] ::= [/topic/body/section/table/tgroup/tbody/row/entry/p/br {""}) (br] | [/topic/body/section/table/tgroup/tbody/row/entry/p/br {""}) (br][/topic/body/section/table/tgroup/tbody/row/entry/p/br {""}) (br] [/topic/body/section/table/tgroup/tbody/row/entry/p/br {""}) (br] ::= [/topic/body/section/table/tgroup/tbody/row/entry/p/br {""}) (br] | [/topic/body/section/table/tgroup/tbody/row/entry/p/br {""}) (br].[/topic/body/section/table/tgroup/tbody/row/entry/p/br {""}) (br] | [/topic/body/section/table/tgroup/tbody/row/entry/p/br {""}) (br]. | .[/topic/body/section/table/tgroup/tbody/row/entry/p/br {""}) (br] [/topic/body/section/table/tgroup/tbody/row/entry/p/br {""}) (br] ::= "+" | "-" [/topic/body/section/table/tgroup/tbody/row/entry/p/br {""}) (br] ::= [/topic/body/section/table/tgroup/tbody/row/entry/p/br {""}) (br] | [/topic/body/section/table/tgroup/tbody/row/entry/p/br {""}) (br][/topic/body/section/table/tgroup/tbody/row/entry/p/br {""}) (br] [/topic/body/section/table/tgroup/tbody/row/entry/p/br {""}) (br] ::= [/topic/body/section/table/tgroup/tbody/row/entry/p/br {""}) (br] | [/topic/body/section/table/tgroup/tbody/row/entry/p/br {""}) (br] | [/topic/body/section/table/tgroup/tbody/row/entry/p/br {""}) (br] [/topic/body/section/table/tgroup/tbody/row/entry/p/br {""}) (br] ::= Ki | Mi | Gi | Ti | Pi | Ei

+

(International System of units; See: http://physics.nist.gov/cuu/Units/binary.html)

+

[/topic/body/section/table/tgroup/tbody/row/entry/p/br {""}) (br] ::= m | "" | k | M | G | T | P | E

+

(Note that 1024 = 1Ki but 1000 = 1k; I didn't choose the capitalization.)

+

[/topic/body/section/table/tgroup/tbody/row/entry/p/br {""}) (br] ::= "e" [/topic/body/section/table/tgroup/tbody/row/entry/p/br {""}) (br] | "E" [/topic/body/section/table/tgroup/tbody/row/entry/p/br {""}) (br]

+

No matter which of the three exponent forms is used, no quantity may represent a number greater than 2^63-1 in magnitude, nor may it have more than 3 decimal places. Numbers larger or more precise will be capped or rounded up. (E.g.: 0.1m will rounded up to 1m.) This may be extended in the future if we require larger or smaller quantities.

+

When a Quantity is parsed from a string, it will remember the type of suffix it had, and will use the same type again when it is serialized.

+

Before serializing, Quantity will be put in "canonical form". This means that Exponent/suffix will be adjusted up or down (with a corresponding increase or decrease in Mantissa) such that:

+

a. No precision is lost

+

b. No fractional digits will be emitted

+

c. The exponent (or suffix) is as large as possible.

+

The sign will be omitted unless the number is negative.

+

Examples:

+

1.5 will be serialized as "1500m"

+

1.5Gi will be serialized as "1536Mi"

+

Note that the quantity will NEVER be internally represented by a floating point number. That is the whole point of this exercise.

+

Non-canonical values will still parse as long as they are well formed, but will be re-emitted in their canonical form. (So always use canonical form, or don't diff.)

+

This format is intended to make it difficult to use these numbers without writing some sort of special handling code in the hopes that that will cause implementors to also use a fixed point implementation.

+
+
+ +
+ + + + + + + + + + + + + +
Table 55 io.k8s.apimachinery.pkg.apis.meta.v1.LabelSelector

Parameter

+

Type

+

Description

+

matchExpressions

+

Array of io.k8s.apimachinery.pkg.apis.meta.v1.LabelSelectorRequirement objects

+

matchExpressions is a list of label selector requirements. The

+

requirements are ANDed.

+

matchLabels

+

Map<String,String>

+

matchLabels is a map of {key,value} pairs. A single {key,value}

+

in the matchLabels map is equivalent to an element of matchExpressions,

+

whose key field is "key", the operator is "In", and the values array contains

+

only "value". The requirements are ANDed.

+
+
+ +
+ + + + + + + + + + + + + + + + + +
Table 56 io.k8s.apimachinery.pkg.apis.meta.v1.LabelSelectorRequirement

Parameter

+

Type

+

Description

+

key

+

String

+

key is the label key that the selector applies to.

+

operator

+

String

+

operator represents a key's relationship to a set of values.

+

Valid operators are In, NotIn, Exists and DoesNotExist.

+

values

+

Array of strings

+

values is an array of string values. If the operator is In or

+

NotIn, the values array must be non-empty. If the operator is Exists or

+

DoesNotExist, the values array must be empty. This array is replaced during

+

a strategic merge patch.

+
+
+ +
+ + + + + + + + + + + + + + + + + +
Table 57 io.cci.otc.api.pkg.apis.versioned.cci.v2.NFSVolumeSource

Parameter

+

Type

+

Description

+

path

+

String

+

path that is exported by the NFS server. More info: https://kubernetes.io/docs/concepts/storage/volumes#nfs

+

readOnly

+

Boolean

+

readOnly here will force the NFS export to be mounted with read-only permissions. Defaults to false. More info: https://kubernetes.io/docs/concepts/storage/volumes#nfs

+

server

+

String

+

server is the hostname or IP address of the NFS server. More info: https://kubernetes.io/docs/concepts/storage/volumes#nfs

+
+
+ +
+ + + + + + + + + + + + + +
Table 58 io.cci.otc.api.pkg.apis.versioned.cci.v2.PersistentVolumeClaimVolumeSource

Parameter

+

Type

+

Description

+

claimName

+

String

+

claimName is the name of a PersistentVolumeClaim in the same namespace as the pod using this volume. More info: https://kubernetes.io/docs/concepts/storage/persistent-volumes#persistentvolumeclaims

+

readOnly

+

Boolean

+

readOnly Will force the ReadOnly setting in VolumeMounts. Default

+

false.

+
+
+ +
+ + + + + + + + + + + + + +
Table 59 io.cci.otc.api.pkg.apis.versioned.cci.v2.ProjectedVolumeSource

Parameter

+

Type

+

Description

+

defaultMode

+

Integer

+

defaultMode are the mode bits used to set permissions on created

+

files by default. Must be an octal value between 0000 and 0777 or a decimal

+

value between 0 and 511. YAML accepts both octal and decimal values, JSON

+

requires decimal values for mode bits. Directories within the path are not

+

affected by this setting. This might be in conflict with other options that

+

affect the file mode, like fsGroup, and the result can be other mode bits

+

set.

+

sources

+

Array of io.cci.otc.api.pkg.apis.versioned.cci.v2.VolumeProjection objects

+

sources is the list of volume projections

+
+
+ +
+ + + + + + + + + + + + + + + + + +
Table 60 io.cci.otc.api.pkg.apis.versioned.cci.v2.VolumeProjection

Parameter

+

Type

+

Description

+

configMap

+

io.cci.otc.api.pkg.apis.versioned.cci.v2.ConfigMapProjection object

+

configMap information about the configMap data to project

+

downwardAPI

+

io.cci.otc.api.pkg.apis.versioned.cci.v2.DownwardAPIProjection object

+

downwardAPI information about the downwardAPI data to project

+

secret

+

io.cci.otc.api.pkg.apis.versioned.cci.v2.SecretProjection object

+

secret information about the secret data to project

+
+
+ +
+ + + + + + + + + + + + + + + + + +
Table 61 io.cci.otc.api.pkg.apis.versioned.cci.v2.ConfigMapProjection

Parameter

+

Type

+

Description

+

items

+

Array of io.cci.otc.api.pkg.apis.versioned.cci.v2.KeyToPath objects

+

items if unspecified, each key-value pair in the Data field of

+

the referenced ConfigMap will be projected into the volume as a file whose

+

name is the key and content is the value. If specified, the listed keys

+

will be projected into the specified paths, and unlisted keys will not be

+

present. If a key is specified which is not present in the ConfigMap, the

+

volume setup will error unless it is marked optional. Paths must be relative

+

and may not contain the '..' path or start with '..'.

+

name

+

String

+

Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names

+

optional

+

Boolean

+

optional specify whether the ConfigMap or its keys must be defined

+
+
+ +
+ + + + + + + + + +
Table 62 io.cci.otc.api.pkg.apis.versioned.cci.v2.DownwardAPIProjection

Parameter

+

Type

+

Description

+

items

+

Array of io.cci.otc.api.pkg.apis.versioned.cci.v2.DownwardAPIVolumeFile objects

+

Items is a list of DownwardAPIVolume file

+
+
+ +
+ + + + + + + + + + + + + + + + + + + + + +
Table 63 io.cci.otc.api.pkg.apis.versioned.cci.v2.DownwardAPIVolumeFile

Parameter

+

Type

+

Description

+

fieldRef

+

io.cci.otc.api.pkg.apis.versioned.cci.v2.ObjectFieldSelector object

+

Required: Selects a field of the pod: only annotations, labels, name and namespace are supported.

+

mode

+

Integer

+

Optional: mode bits used to set permissions on this file, must be an octal value between 0000 and 0777 or a decimal value between 0 and 511. YAML accepts both octal and decimal values, JSON requires decimal values for mode bits. If not specified, the volume defaultMode will be used. This might be in conflict with other options that affect the file mode, like fsGroup, and the result can be other mode bits set.

+

path

+

String

+

Required: Path is the relative path name of the file to be created. Must not be absolute or contain the '..' path. Must be utf-8 encoded. The first item of the relative path must not start with '..'

+

resourceFieldRef

+

io.cci.otc.api.pkg.apis.versioned.cci.v2.ResourceFieldSelector object

+

Selects a resource of the container: only resources limits and requests (limits.cpu, limits.memory, requests.cpu and requests.memory) are currently supported.

+
+
+ +
+ + + + + + + + + + + + + +
Table 64 io.cci.otc.api.pkg.apis.versioned.cci.v2.ObjectFieldSelector

Parameter

+

Type

+

Description

+

apiVersion

+

String

+

Version of the schema the FieldPath is written in terms of, defaults

+

to "v1".

+

fieldPath

+

String

+

Path of the field to select in the specified API version.

+
+
+ +
+ + + + + + + + + + + + + + + + + +
Table 65 io.cci.otc.api.pkg.apis.versioned.cci.v2.ResourceFieldSelector

Parameter

+

Type

+

Description

+

containerName

+

String

+

Container name: required for volumes, optional for env vars

+

divisor

+

String

+

Specifies the output format of the exposed resources, defaults

+

to "1"

+

resource

+

String

+

Required: resource to select

+
+
+ +
+ + + + + + + + + + + + + + + + + +
Table 66 io.cci.otc.api.pkg.apis.versioned.cci.v2.SecretProjection

Parameter

+

Type

+

Description

+

items

+

Array of io.cci.otc.api.pkg.apis.versioned.cci.v2.KeyToPath objects

+

items if unspecified, each key-value pair in the Data field of

+

the referenced Secret will be projected into the volume as a file whose

+

name is the key and content is the value. If specified, the listed keys

+

will be projected into the specified paths, and unlisted keys will not be

+

present. If a key is specified which is not present in the Secret, the volume

+

setup will error unless it is marked optional. Paths must be relative and

+

may not contain the '..' path or start with '..'.

+

name

+

String

+

Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names

+

optional

+

Boolean

+

optional field specify whether the Secret or its key must be

+

defined

+
+
+ +
+ + + + + + + + + + + + + + + + + + + + + +
Table 67 io.cci.otc.api.pkg.apis.versioned.cci.v2.SecretVolumeSource

Parameter

+

Type

+

Description

+

defaultMode

+

Integer

+

defaultMode is Optional: mode bits used to set permissions on created files by default. Must be an octal value between 0000 and 0777 or a decimal value between 0 and 511. YAML accepts both octal and decimal values, JSON requires decimal values for mode bits. Defaults to 0644. Directories within the path are not affected by this setting. This might be in conflict with other options that affect the file mode, like fsGroup, and the result can be other mode bits set.

+

items

+

Array of io.cci.otc.api.pkg.apis.versioned.cci.v2.KeyToPath objects

+

items If unspecified, each key-value pair in the Data field of

+

the referenced Secret will be projected into the volume as a file whose

+

name is the key and content is the value. If specified, the listed keys

+

will be projected into the specified paths, and unlisted keys will not be

+

present. If a key is specified which is not present in the Secret, the volume

+

setup will error unless it is marked optional. Paths must be relative and

+

may not contain the '..' path or start with '..'.

+

optional

+

Boolean

+

optional field specify whether the Secret or its keys must be

+

defined

+

secretName

+

String

+

secretName is the name of the secret in the pod's namespace to use. More info: https://kubernetes.io/docs/concepts/storage/volumes#secret

+
+
+ +
+ + + + + + + + + + + + + + + + + +
Table 68 io.cci.otc.api.pkg.apis.versioned.cci.v2.KeyToPath

Parameter

+

Type

+

Description

+

key

+

String

+

key is the key to project.

+

mode

+

Integer

+

mode is Optional: mode bits used to set permissions on this file. Must be an octal value between 0000 and 0777 or a decimal value between 0 and 511. YAML accepts both octal and decimal values, JSON requires decimal values for mode bits. If not specified, the volume defaultMode will be used. This might be in conflict with other options that affect the file mode, like fsGroup, and the result can be other mode bits set.

+

path

+

String

+

path is the relative path of the file to map the key to. May

+

not be an absolute path. May not contain the path element '..'. May not

+

start with the string '..'.

+
+
+ +
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Table 69 io.cci.otc.api.pkg.apis.versioned.cci.v2.PodStatus

Parameter

+

Type

+

Description

+

conditions

+

Array of io.cci.otc.api.pkg.apis.versioned.cci.v2.PodCondition objects

+

Current service state of pod. More info: https://kubernetes.io/docs/concepts/workloads/pods/pod-lifecycle#pod-conditions

+

containerStatuses

+

Array of io.cci.otc.api.pkg.apis.versioned.cci.v2.ContainerStatus objects

+

The list has one entry per container in the manifest. More info: https://kubernetes.io/docs/concepts/workloads/pods/pod-lifecycle#pod-and-container-status

+

ephemeralContainerStatuses

+

Array of io.cci.otc.api.pkg.apis.versioned.cci.v2.ContainerStatus objects

+

Status for any ephemeral containers that have run in this pod.

+

hostIP

+

String

+

IP address of the host to which the pod is assigned. Empty if

+

not yet scheduled.

+

initContainerStatuses

+

Array of io.cci.otc.api.pkg.apis.versioned.cci.v2.ContainerStatus objects

+

The list has one entry per init container in the manifest. The most recent successful init container will have ready = true, the most recently started container will have startTime set. More info: https://kubernetes.io/docs/concepts/workloads/pods/pod-lifecycle#pod-and-container-status

+

message

+

String

+

A human readable message indicating details about why the pod

+

is in this condition.

+

nominatedNodeName

+

String

+

nominatedNodeName is set only when this pod preempts other pods

+

on the node, but it cannot be scheduled right away as preemption victims

+

receive their graceful termination periods. This field does not guarantee

+

that the pod will be scheduled on this node. Scheduler may decide to place

+

the pod elsewhere if other nodes become available sooner. Scheduler may

+

also decide to give the resources on this node to a higher priority pod

+

that is created after preemption. As a result, this field may be different

+

than PodSpec.nodeName when the pod is scheduled.

+

phase

+

String

+

The phase of a Pod is a simple, high-level summary of where the Pod is in its lifecycle. The conditions array, the reason and message fields, and the individual container status arrays contain more detail about the pod's status. There are five possible phase values:

+

Pending: The pod has been accepted by the Kubernetes system, but one or more of the container images has not been created. This includes time before being scheduled as well as time spent downloading images over the network, which could take a while. Running: The pod has been bound to a node, and all of the containers have been created. At least one container is still running, or is in the process of starting or restarting. Succeeded: All containers in the pod have terminated in success, and will not be restarted. Failed: All containers in the pod have terminated, and at least one container has terminated in failure. The container either exited with non-zero status or was terminated by the system. Unknown: For some reason the state of the pod could not be obtained, typically due to an error in communicating with the host of the pod.

+

More info: https://kubernetes.io/docs/concepts/workloads/pods/pod-lifecycle#pod-phase

+

Possible enum values:

+
  • "Failed" means that all containers in the pod have terminated, and at least one container has terminated in a failure (exited with a non-zero exit code or was stopped by the system).
  • "Pending" means the pod has been accepted by the system, but one or more of the containers has not been started. This includes time before being bound to a node, as well as time spent pulling images onto the host.
  • "Running" means the pod has been bound to a node and all of the containers have been started. At least one container is still running or is in the process of being restarted.
  • "Succeeded" means that all containers in the pod have voluntarily terminated with a container exit code of 0, and the system is not going to restart any of these containers.
  • "Unknown" means that for some reason the state of the pod could not be obtained, typically due to an error in communicating with the host of the pod. Deprecated: It isn't being set since 2015 (74da3b14b0c0f658b3bb8d2def5094686d0e9095)
+

podIP

+

String

+

IP address allocated to the pod. Routable at least within the

+

cluster. Empty if not yet allocated.

+

podIPs

+

Array of io.cci.otc.api.pkg.apis.versioned.cci.v2.PodIP objects

+

podIPs holds the IP addresses allocated to the pod. If this field

+

is specified, the 0th entry must match the podIP field. Pods may be allocated

+

at most 1 value for each of IPv4 and IPv6. This list is empty if no IPs

+

have been allocated yet.

+

qosClass

+

String

+

The Quality of Service (QOS) classification assigned to the pod based on resource requirements See PodQOSClass type for available QOS classes More info: https://git.k8s.io/community/contributors/design-proposals/node/resource-qos.md

+

Possible enum values:

+
  • "BestEffort" is the BestEffort qos class.
  • "Burstable" is the Burstable qos class.
  • "Guaranteed" is the Guaranteed qos class.
+

reason

+

String

+

A brief CamelCase message indicating details about why the pod

+

is in this state. e.g. 'Evicted'

+

startTime

+

String

+

RFC 3339 date and time at which the object was acknowledged by

+

the Kubelet. This is before the Kubelet pulled the container image(s) for

+

the pod.

+
+
+ +
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Table 70 io.cci.otc.api.pkg.apis.versioned.cci.v2.PodCondition

Parameter

+

Type

+

Description

+

lastProbeTime

+

String

+

Last time we probed the condition.

+

lastTransitionTime

+

String

+

Last time the condition transitioned from one status to another.

+

message

+

String

+

Human-readable message indicating details about last transition.

+

reason

+

String

+

Unique, one-word, CamelCase reason for the condition's last transition.

+

status

+

String

+

Status is the status of the condition. Can be True, False, Unknown. More info: https://kubernetes.io/docs/concepts/workloads/pods/pod-lifecycle#pod-conditions

+

type

+

String

+

Type is the type of the condition. More info: https://kubernetes.io/docs/concepts/workloads/pods/pod-lifecycle#pod-conditions

+
+
+ +
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Table 71 io.cci.otc.api.pkg.apis.versioned.cci.v2.ContainerStatus

Parameter

+

Type

+

Description

+

containerID

+

String

+

Container's ID in the format '[/topic/body/section/table/tgroup/tbody/row/entry/p/br {""}) (br]://<container_id>'.

+

image

+

String

+

The image the container is running. More info: https://kubernetes.io/docs/concepts/containers/images.

+

imageID

+

String

+

ImageID of the container's image.

+

lastState

+

io.cci.otc.api.pkg.apis.versioned.cci.v2.ContainerState object

+

Details about the container's last termination condition.

+

name

+

String

+

This must be a DNS_LABEL. Each container in a pod must have a

+

unique name. Cannot be updated.

+

ready

+

Boolean

+

Specifies whether the container has passed its readiness probe.

+

restartCount

+

Integer

+

The number of times the container has been restarted.

+

started

+

Boolean

+

Specifies whether the container has passed its startup probe.

+

Initialized as false, becomes true after startupProbe is considered successful.

+

Resets to false when the container is restarted, or if kubelet loses state

+

temporarily. Is always true when no startupProbe is defined.

+

state

+

io.cci.otc.api.pkg.apis.versioned.cci.v2.ContainerState object

+

Details about the container's current condition.

+
+
+ +
+ + + + + + + + + + + + + + + + + +
Table 72 io.cci.otc.api.pkg.apis.versioned.cci.v2.ContainerState

Parameter

+

Type

+

Description

+

running

+

io.cci.otc.api.pkg.apis.versioned.cci.v2.ContainerStateRunning object

+

Details about a running container

+

terminated

+

io.cci.otc.api.pkg.apis.versioned.cci.v2.ContainerStateTerminated object

+

Details about a terminated container

+

waiting

+

io.cci.otc.api.pkg.apis.versioned.cci.v2.ContainerStateWaiting object

+

Details about a waiting container

+
+
+ +
+ + + + + + + + + +
Table 73 io.cci.otc.api.pkg.apis.versioned.cci.v2.ContainerStateRunning

Parameter

+

Type

+

Description

+

startedAt

+

String

+

Time at which the container was last (re-)started

+
+
+ +
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Table 74 io.cci.otc.api.pkg.apis.versioned.cci.v2.ContainerStateTerminated

Parameter

+

Type

+

Description

+

containerID

+

String

+

Container's ID in the format '[/topic/body/section/table/tgroup/tbody/row/entry/p/br {""}) (br]://<container_id>'

+

exitCode

+

Integer

+

Exit status from the last termination of the container

+

finishedAt

+

String

+

Time at which the container last terminated

+

message

+

String

+

Message regarding the last termination of the container

+

reason

+

String

+

(brief) reason from the last termination of the container

+

signal

+

Integer

+

Signal from the last termination of the container

+

startedAt

+

String

+

Time at which previous execution of the container started

+
+
+ +
+ + + + + + + + + + + + + +
Table 75 io.cci.otc.api.pkg.apis.versioned.cci.v2.ContainerStateWaiting

Parameter

+

Type

+

Description

+

message

+

String

+

Message regarding why the container is not yet running.

+

reason

+

String

+

(brief) reason the container is not yet running.

+
+
+ +
+ + + + + + + + + +
Table 76 io.cci.otc.api.pkg.apis.versioned.cci.v2.PodIP

Parameter

+

Type

+

Description

+

ip

+

String

+

ip is an IP address (IPv4 or IPv6) assigned to the pod

+
+
+
+

Example Requests

None

+
+

Example Responses

Status code: 200

+

OK

+
{
+  "apiVersion" : "cci/v2",
+  "kind" : "Pod",
+  "metadata" : {
+    "annotations" : {
+      "cni.yangtse.io/network-status" : "[{\"macAddress\":\"fa:16:3e:1d:75:3a\",\"ipv4Info\":{\"subnet\":\"192.168.0.0/24\",\"ipAddress\":\"192.168.0.197\",\"gateway\":\"192.168.0.1\"},\"name\":\"test-api\",\"portID\":\"b471658c-caac-4377-94f4-2eeff1192d2b\",\"ips\":[\"192.168.0.197\"],\"vlanID\":3687}]",
+      "networking.cci.io/vm-network-info" : "{\"vmID\":\"fda21659-a816-4449-abcf-193ac5a47b4a\",\"eniID\":\"ec9f8fae-ae74-445b-b8bb-b533e5342dbd\",\"maxEniNum\":2,\"maxSubEniNum\":16}",
+      "openvessel.io/monitoring-aominfo" : "08a2*************************c03:4257ecf3-7c47-43a3-86d2-d2b4d4aa3a20",
+      "resource.cci.io/pod-size-specs" : "2.00_4.0",
+      "resource.cci.io/size" : "2.00_4.0",
+      "scheduling.k8s.io/group-name" : "podgroup-ade5799e-9371-4c9f-ab77-0472e97211f8",
+      "tenant.cci.io/tenant-id" : "08a2*************************c03",
+      "topology.kubernetes.io/region" : "region1",
+      "topology.kubernetes.io/zone" : "region1c"
+    },
+    "creationTimestamp" : "2024-10-09T16:11:23Z",
+    "finalizers" : [ "billing.kubernetes.io/podbilling-finalizer" ],
+    "labels" : {
+      "scheduling.cci.io/vmid" : "fda21659-a816-4449-abcf-193ac5a47b4a",
+      "sys_enterprise_project_id" : "0",
+      "tenant.cci.io/tenant-id" : "08a2*************************c03",
+      "tenant.kubernetes.io/domain-id" : "08a*************************ee60",
+      "tenant.kubernetes.io/project-id" : "08a2*************************c03"
+    },
+    "name" : "test",
+    "namespace" : "test-api",
+    "resourceVersion" : "391095556",
+    "uid" : "ade5799e-9371-4c9f-ab77-0472e97211f8"
+  },
+  "spec" : {
+    "containers" : [ {
+      "env" : [ {
+        "name" : "ENV1",
+        "value" : "false"
+      }, {
+        "name" : "ENV2",
+        "value" : "xxx"
+      } ],
+      "image" : "nginx:latest",
+      "name" : "deploy-example",
+      "resources" : {
+        "limits" : {
+          "cpu" : "500m",
+          "memory" : "1Gi"
+        },
+        "requests" : {
+          "cpu" : "500m",
+          "memory" : "1Gi"
+        }
+      },
+      "terminationMessagePath" : "/dev/termination-log",
+      "terminationMessagePolicy" : "File"
+    } ],
+    "dnsPolicy" : "Default",
+    "imagePullSecrets" : [ {
+      "name" : "imagepull-secret"
+    } ],
+    "nodeName" : "compute-cell-001",
+    "restartPolicy" : "Always",
+    "schedulerName" : "volcano",
+    "securityContext" : { },
+    "terminationGracePeriodSeconds" : 30
+  },
+  "status" : {
+    "conditions" : [ {
+      "lastProbeTime" : null,
+      "lastTransitionTime" : "2024-10-09T16:11:24Z",
+      "status" : "True",
+      "type" : "Initialized"
+    }, {
+      "lastProbeTime" : null,
+      "lastTransitionTime" : "2024-10-09T16:11:28Z",
+      "status" : "True",
+      "type" : "Ready"
+    }, {
+      "lastProbeTime" : null,
+      "lastTransitionTime" : "2024-10-09T16:11:28Z",
+      "status" : "True",
+      "type" : "ContainersReady"
+    }, {
+      "lastProbeTime" : null,
+      "lastTransitionTime" : "2024-10-09T16:11:23Z",
+      "status" : "True",
+      "type" : "PodScheduled"
+    } ],
+    "containerStatuses" : [ {
+      "containerID" : "containerd://a44eef6b753babaff802d212e78afef2422959e90bd79ab5b385adb302aa3d1e",
+      "image" : "nginx:latest",
+      "imageID" : "docker.io/library/nginx@sha256:416d511ffa63777489af47f250b70d1570e428b67666567085f2bece3571ad83",
+      "lastState" : { },
+      "name" : "deploy-example",
+      "ready" : true,
+      "restartCount" : 0,
+      "started" : true,
+      "state" : {
+        "running" : {
+          "startedAt" : "2024-10-09T16:11:27Z"
+        }
+      }
+    } ],
+    "phase" : "Running",
+    "podIP" : "192.168.0.197",
+    "podIPs" : [ {
+      "ip" : "192.168.0.197"
+    } ],
+    "qosClass" : "Guaranteed",
+    "startTime" : "2024-10-09T16:11:24Z"
+  }
+}
+
+

Status Codes

+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +

Status Code

+

Description

+

200

+

OK

+

400

+

BadRequest

+

401

+

Unauthorized

+

403

+

Forbidden

+

404

+

NotFound

+

405

+

MethodNotAllowed

+

406

+

NotAcceptable

+

409

+

Conflict

+

415

+

UnsupportedMediaType

+

422

+

Invalid

+

429

+

TooManyRequests

+

500

+

InternalError

+

503

+

ServiceUnavailable

+

504

+

ServerTimeout

+
+
+
+
+
+
+
Parent topic: Proprietary APIs
+
+
+ diff --git a/docs/cci/api-ref/readCciV2NamespacedPodLog.html b/docs/cci/api-ref/readCciV2NamespacedPodLog.html new file mode 100644 index 00000000..f67300ab --- /dev/null +++ b/docs/cci/api-ref/readCciV2NamespacedPodLog.html @@ -0,0 +1,265 @@ + + +

Reading Logs of the Specified Pod

+

Function

Read logs of the specified Pod.

+
+

Calling Method

For details, see Calling APIs.

+
+

URI

GET /apis/cci/v2/namespaces/{namespace}/pods/{name}/log

+ +
+ + + + + + + + + + + + + + + + +
Table 1 Path Parameters

Parameter

+

Mandatory

+

Type

+

Description

+

name

+

Yes

+

String

+

Name of the Pod.

+

namespace

+

Yes

+

String

+

Object name and auth scope, such as for teams and projects.

+
+
+ +
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Table 2 Query Parameters

Parameter

+

Mandatory

+

Type

+

Description

+

container

+

No

+

String

+		  

follow

+

No

+

Boolean

+		  

insecureSkipTLSVerifyBackend

+

No

+

Boolean

+		  

limitBytes

+

No

+

Integer

+		  

pretty

+

No

+

String

+

If 'true', then the output is pretty printed.

+

previous

+

No

+

Boolean

+		  

sinceSeconds

+

No

+

Integer

+		  

tailLines

+

No

+

Integer

+		  

timestamps

+

No

+

Boolean

+		  
+
+
+

Request Parameters

+
+ + + + + + + + + + + +
Table 3 Request header parameters

Parameter

+

Mandatory

+

Type

+

Description

+

X-Auth-Token

+

Yes

+

String

+

User token.

+

It can be obtained through the IAM API used to obtain a user token. The value of X-Subject-Token in the response header is the user token.

+
+
+
+

Response Parameters

Status code: 200

+ +
+ + + + + + + + + +
Table 4 Response body parameters

Parameter

+

Type

+

Description

+

-

+

String

+		  
+
+
+

Example Requests

None

+
+

Example Responses

None

+
+

Status Codes

+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +

Status Code

+

Description

+

200

+

OK

+

400

+

BadRequest

+

401

+

Unauthorized

+

403

+

Forbidden

+

404

+

NotFound

+

405

+

MethodNotAllowed

+

406

+

NotAcceptable

+

409

+

Conflict

+

415

+

UnsupportedMediaType

+

422

+

Invalid

+

429

+

TooManyRequests

+

500

+

InternalError

+

503

+

ServiceUnavailable

+

504

+

ServerTimeout

+
+
+
+
+
+
+
Parent topic: Proprietary APIs
+
+
+ diff --git a/docs/cci/api-ref/readCciV2NamespacedSecret.html b/docs/cci/api-ref/readCciV2NamespacedSecret.html new file mode 100644 index 00000000..807624d5 --- /dev/null +++ b/docs/cci/api-ref/readCciV2NamespacedSecret.html @@ -0,0 +1,560 @@ + + +

Reading the Specified Secret

+

Function

Read the specified Secret.

+
+

Calling Method

For details, see Calling APIs.

+
+

URI

GET /apis/cci/v2/namespaces/{namespace}/secrets/{name}

+ +
+ + + + + + + + + + + + + + + + +
Table 1 Path Parameters

Parameter

+

Mandatory

+

Type

+

Description

+

name

+

Yes

+

String

+

name of the Secret

+

namespace

+

Yes

+

String

+

Object name and auth scope, such as for teams and projects.

+
+
+ +
+ + + + + + + + + + + +
Table 2 Query Parameters

Parameter

+

Mandatory

+

Type

+

Description

+

pretty

+

No

+

String

+

If 'true', then the output is pretty printed.

+
+
+
+

Request Parameters

+
+ + + + + + + + + + + +
Table 3 Request header parameters

Parameter

+

Mandatory

+

Type

+

Description

+

X-Auth-Token

+

Yes

+

String

+

User token.

+

It can be obtained through the IAM API used to obtain a user token. The value of X-Subject-Token in the response header is the user token.

+
+
+
+

Response Parameters

Status code: 200

+ +
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Table 4 Response body parameters

Parameter

+

Type

+

Description

+

apiVersion

+

String

+

APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#resources

+

data

+

Map<String,String>

+

Data contains the secret data. Each key must consist of alphanumeric

+

characters, '-', '_' or '.'. The serialized form of the secret data is a

+

base64 encoded string, representing the arbitrary (possibly non-string)

+

data value here. Described in https://tools.ietf.org/html/rfc4648#section-4

+

immutable

+

Boolean

+

Immutable, if set to true, ensures that data stored in the Secret

+

cannot be updated (only object metadata can be modified). If not set to

+

true, the field can be modified at any time. Defaulted to nil.

+

kind

+

String

+

Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds

+

metadata

+

io.k8s.apimachinery.pkg.apis.meta.v1.ObjectMeta object

+

Standard object's metadata. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata

+

stringData

+

Map<String,String>

+

stringData allows specifying non-binary secret data in string

+

form. It is provided as a write-only input field for convenience. All keys

+

and values are merged into the data field on write, overwriting any existing

+

values. The stringData field is never output when reading from the API.

+

type

+

String

+

Used to facilitate programmatic handling of secret data. More info: https://kubernetes.io/docs/concepts/configuration/secret/#secret-types

+
+
+ +
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Table 5 io.k8s.apimachinery.pkg.apis.meta.v1.ObjectMeta

Parameter

+

Type

+

Description

+

annotations

+

Map<String,String>

+

Annotations is an unstructured key value map stored with a resource that may be set by external tools to store and retrieve arbitrary metadata. They are not queryable and should be preserved when modifying objects. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/annotations/

+

clusterName

+

String

+

The name of the cluster which the object belongs to. This is

+

used to distinguish resources with same name and namespace in different

+

clusters. This field is not set anywhere right now and apiserver is going

+

to ignore it if set in create or update request.

+

creationTimestamp

+

String

+

CreationTimestamp is a timestamp representing the server time when this object was created. It is not guaranteed to be set in happens-before order across separate operations. Clients may not set this value. It is represented in RFC3339 form and is in UTC.

+

Populated by the system. Read-only. Null for lists. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata

+

deletionGracePeriodSeconds

+

Long

+

Number of seconds allowed for this object to gracefully terminate

+

before it will be removed from the system. Only set when deletionTimestamp

+

is also set. May only be shortened. Read-only.

+

deletionTimestamp

+

String

+

DeletionTimestamp is RFC 3339 date and time at which this resource will be deleted. This field is set by the server when a graceful deletion is requested by the user, and is not directly settable by a client. The resource is expected to be deleted (no longer visible from resource lists, and not reachable by name) after the time in this field, once the finalizers list is empty. As long as the finalizers list contains items, deletion is blocked. Once the deletionTimestamp is set, this value may not be unset or be set further into the future, although it may be shortened or the resource may be deleted prior to this time. For example, a user may request that a pod is deleted in 30 seconds. The Kubelet will react by sending a graceful termination signal to the containers in the pod. After that 30 seconds, the Kubelet will send a hard termination signal (SIGKILL) to the container and after cleanup, remove the pod from the API. In the presence of network partitions, this object may still exist after this timestamp, until an administrator or automated process can determine the resource is fully terminated. If not set, graceful deletion of the object has not been requested.

+

Populated by the system when a graceful deletion is requested. Read-only. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata

+

enable

+

Boolean

+

Enable identifies whether the resource is available

+

finalizers

+

Array of strings

+

Must be empty before the object is deleted from the registry.

+

Each entry is an identifier for the responsible component that will remove

+

the entry from the list. If the deletionTimestamp of the object is non-nil,

+

entries in this list can only be removed. Finalizers may be processed and

+

removed in any order. Order is NOT enforced because it introduces significant

+

risk of stuck finalizers. finalizers is a shared field, any actor with permission

+

can reorder it. If the finalizer list is processed in order, then this can

+

lead to a situation in which the component responsible for the first finalizer

+

in the list is waiting for a signal (field value, external system, or other)

+

produced by a component responsible for a finalizer later in the list, resulting

+

in a deadlock. Without enforced ordering finalizers are free to order amongst

+

themselves and are not vulnerable to ordering changes in the list.

+

generateName

+

String

+

GenerateName is an optional prefix, used by the server, to generate a unique name ONLY IF the Name field has not been provided. If this field is used, the name returned to the client will be different than the name passed. This value will also be combined with a unique suffix. The provided value has the same validation rules as the Name field, and may be truncated by the length of the suffix required to make the value unique on the server.

+

If this field is specified and the generated name exists, the server will NOT return a 409 - instead, it will either return 201 Created or 500 with Reason ServerTimeout indicating a unique name could not be found in the time allotted, and the client should retry (optionally after the time indicated in the Retry-After header).

+

Applied only if Name is not specified. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#idempotency

+

generation

+

Long

+

A sequence number representing a specific generation of the desired

+

state. Populated by the system. Read-only.

+

labels

+

Map<String,String>

+

Map of string keys and values that can be used to organize and categorize (scope and select) objects. May match selectors of replication controllers and services. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/labels/

+

managedFields

+

Array of io.k8s.apimachinery.pkg.apis.meta.v1.ManagedFieldsEntry objects

+

ManagedFields maps workflow-id and version to the set of fields

+

that are managed by that workflow. This is mostly for internal housekeeping,

+

and users typically shouldn't need to set or understand this field. A workflow

+

can be the user's name, a controller's name, or the name of a specific apply

+

path like "ci-cd". The set of fields is always in the version that the workflow

+

used when modifying the object.

+

name

+

String

+

Name must be unique within a namespace. Is required when creating resources, although some resources may allow a client to request the generation of an appropriate name automatically. Name is primarily intended for creation idempotence and configuration definition. Cannot be updated. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names

+

namespace

+

String

+

Namespace defines the space within which each name must be unique. An empty namespace is equivalent to the "default" namespace, but "default" is the canonical representation. Not all objects are required to be scoped to a namespace - the value of this field for those objects will be empty.

+

Must be a DNS_LABEL. Cannot be updated. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/namespaces/

+

ownerReferences

+

Array of io.k8s.apimachinery.pkg.apis.meta.v1.OwnerReference objects

+

List of objects depended by this object. If ALL objects in the

+

list have been deleted, this object will be garbage collected. If this object

+

is managed by a controller, then an entry in this list will point to this

+

controller, with the controller field set to true. There cannot be more

+

than one managing controller.

+

resourceVersion

+

String

+

An opaque value that represents the internal version of this object that can be used by clients to determine when objects have changed. May be used for optimistic concurrency, change detection, and the watch operation on a resource or set of resources. Clients must treat these values as opaque and passed unmodified back to the server. They may only be valid for a particular resource or set of resources.

+

Populated by the system. Read-only. Value must be treated as opaque by clients and . More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#concurrency-control-and-consistency

+

selfLink

+

String

+

SelfLink is a URL representing this object. Populated by the system. Read-only.

+

DEPRECATED Kubernetes will stop propagating this field in 1.20 release and the field is planned to be removed in 1.21 release.

+

uid

+

String

+

UID is the unique in time and space value for this object. It is typically generated by the server on successful creation of a resource and is not allowed to change on PUT operations.

+

Populated by the system. Read-only. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#uids

+
+
+ +
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Table 6 io.k8s.apimachinery.pkg.apis.meta.v1.ManagedFieldsEntry

Parameter

+

Type

+

Description

+

apiVersion

+

String

+

APIVersion defines the version of this resource that this field

+

set applies to. The format is "group/version" just like the top-level APIVersion

+

field. It is necessary to track the version of a field set because it cannot

+

be automatically converted.

+

fieldsType

+

String

+

FieldsType is the discriminator for the different fields format and version. There is currently only one possible value: "FieldsV1"

+

fieldsV1

+

Object

+

FieldsV1 holds the first JSON version format as described in

+

the "FieldsV1" type.

+

manager

+

String

+

Manager is an identifier of the workflow managing these fields.

+

operation

+

String

+

Operation is the type of operation which lead to this ManagedFieldsEntry

+

being created. The only valid values for this field are 'Apply' and 'Update'.

+

time

+

String

+

Time is timestamp of when these fields were set. It should always

+

be empty if Operation is 'Apply'

+
+
+ +
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Table 7 io.k8s.apimachinery.pkg.apis.meta.v1.OwnerReference

Parameter

+

Type

+

Description

+

apiVersion

+

String

+

API version of the referent.

+

blockOwnerDeletion

+

Boolean

+

If true, AND if the owner has the "foregroundDeletion" finalizer,

+

then the owner cannot be deleted from the key-value store until this reference

+

is removed. Defaults to false. To set this field, a user needs "delete"

+

permission of the owner, otherwise 422 (Unprocessable Entity) will be returned.

+

controller

+

Boolean

+

If true, this reference points to the managing controller.

+

kind

+

String

+

Kind of the referent. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds

+

name

+

String

+

Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names

+

uid

+

String

+

UID of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#uids

+
+
+
+

Example Requests

None

+
+

Example Responses

Status code: 200

+

OK

+
{
+  "apiVersion" : "cci/v2",
+  "data" : {
+    "key" : "eHh4Cg=="
+  },
+  "kind" : "Secret",
+  "metadata" : {
+    "annotations" : {
+      "secret.cci.io/namespace-uid" : "8fd96f2d-ecfa-4e4f-8f5f-4070766d333c",
+      "tenant.cci.io/tenant-id" : "08a2*************************c03"
+    },
+    "creationTimestamp" : "2024-10-09T17:13:08Z",
+    "labels" : {
+      "sys_enterprise_project_id" : "0",
+      "tenant.cci.io/tenant-id" : "08a2*************************c03",
+      "tenant.kubernetes.io/domain-id" : "08a*************************ee60",
+      "tenant.kubernetes.io/project-id" : "08a2*************************c03"
+    },
+    "name" : "test-secret",
+    "namespace" : "test-api",
+    "resourceVersion" : "391114527",
+    "uid" : "77d8dedc-b7ae-40a1-b9a6-6f37cca2c4d1"
+  },
+  "type" : "Opaque"
+}
+
+

Status Codes

+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +

Status Code

+

Description

+

200

+

OK

+

400

+

BadRequest

+

401

+

Unauthorized

+

403

+

Forbidden

+

404

+

NotFound

+

405

+

MethodNotAllowed

+

406

+

NotAcceptable

+

409

+

Conflict

+

415

+

UnsupportedMediaType

+

422

+

Invalid

+

429

+

TooManyRequests

+

500

+

InternalError

+

503

+

ServiceUnavailable

+

504

+

ServerTimeout

+
+
+
+
+
+
+
Parent topic: Proprietary APIs
+
+
+ diff --git a/docs/cci/api-ref/readYangtseV2NamespacedNetwork.html b/docs/cci/api-ref/readYangtseV2NamespacedNetwork.html new file mode 100644 index 00000000..8811abf7 --- /dev/null +++ b/docs/cci/api-ref/readYangtseV2NamespacedNetwork.html @@ -0,0 +1,701 @@ + + +

Reading the Specified Network

+

Function

Read the specified Network.

+
+

Calling Method

For details, see Calling APIs.

+
+

URI

GET /apis/yangtse/v2/namespaces/{namespace}/networks/{name}

+ +
+ + + + + + + + + + + + + + + + +
Table 1 Path Parameters

Parameter

+

Mandatory

+

Type

+

Description

+

name

+

Yes

+

String

+

Name of the Network.

+

namespace

+

Yes

+

String

+

Object name and auth scope, such as for teams and projects..

+
+
+ +
+ + + + + + + + + + + +
Table 2 Query Parameters

Parameter

+

Mandatory

+

Type

+

Description

+

pretty

+

No

+

String

+

If 'true', then the output is pretty printed.

+
+
+
+

Request Parameters

+
+ + + + + + + + + + + +
Table 3 Request header parameters

Parameter

+

Mandatory

+

Type

+

Description

+

X-Auth-Token

+

Yes

+

String

+

User token.

+

It can be obtained through the IAM API used to obtain a user token. The value of X-Subject-Token in the response header is the user token.

+
+
+
+

Response Parameters

Status code: 200

+ +
+ + + + + + + + + + + + + + + + + + + + + + + + + +
Table 4 Response body parameters

Parameter

+

Type

+

Description

+

apiVersion

+

String

+

APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#resources

+

kind

+

String

+

Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds

+

metadata

+

io.k8s.apimachinery.pkg.apis.meta.v1.ObjectMeta object

+

ObjectMeta is metadata that all persisted resources must have, which includes all objects users must create.

+

spec

+

com.otc.paas-core.yangtse.pkg.apis.yangtse.v2.NetworkSpec object

+

Specification of the desired behavior of network.

+

status

+

com.otc.paas-core.yangtse.pkg.apis.yangtse.v2.NetworkStatus object

+

Most recently observed status of the network.

+
+
+ +
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Table 5 io.k8s.apimachinery.pkg.apis.meta.v1.ObjectMeta

Parameter

+

Type

+

Description

+

annotations

+

Map<String,String>

+

Annotations is an unstructured key value map stored with a resource that may be set by external tools to store and retrieve arbitrary metadata. They are not queryable and should be preserved when modifying objects. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/annotations/

+

clusterName

+

String

+

The name of the cluster which the object belongs to. This is used to distinguish resources with same name and namespace in different clusters. This field is not set anywhere right now and apiserver is going to ignore it if set in create or update request.

+

creationTimestamp

+

String

+

CreationTimestamp is a timestamp representing the server time when this object was created. It is not guaranteed to be set in happens-before order across separate operations. Clients may not set this value. It is represented in RFC3339 form and is in UTC.

+

Populated by the system. Read-only. Null for lists. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata

+

deletionGracePeriodSeconds

+

Long

+

Number of seconds allowed for this object to gracefully terminate before it will be removed from the system. Only set when deletionTimestamp is also set. May only be shortened. Read-only.

+

deletionTimestamp

+

String

+

DeletionTimestamp is RFC 3339 date and time at which this resource will be deleted. This field is set by the server when a graceful deletion is requested by the user, and is not directly settable by a client. The resource is expected to be deleted (no longer visible from resource lists, and not reachable by name) after the time in this field, once the finalizers list is empty. As long as the finalizers list contains items, deletion is blocked. Once the deletionTimestamp is set, this value may not be unset or be set further into the future, although it may be shortened or the resource may be deleted prior to this time. For example, a user may request that a pod is deleted in 30 seconds. The Kubelet will react by sending a graceful termination signal to the containers in the pod. After that 30 seconds, the Kubelet will send a hard termination signal (SIGKILL) to the container and after cleanup, remove the pod from the API. In the presence of network partitions, this object may still exist after this timestamp, until an administrator or automated process can determine the resource is fully terminated. If not set, graceful deletion of the object has not been requested.

+

Populated by the system when a graceful deletion is requested. Read-only. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata

+

enable

+

Boolean

+

Enable identifies whether the resource is available

+

finalizers

+

Array of strings

+

Must be empty before the object is deleted from the registry.

+

Each entry is an identifier for the responsible component that will remove the entry from the list. If the deletionTimestamp of the object is non-nil, entries in this list can only be removed. Finalizers may be processed and removed in any order. Order is NOT enforced because it introduces significant risk of stuck finalizers. finalizers is a shared field, any actor with permission can reorder it. If the finalizer list is processed in order, then this can lead to a situation in which the component responsible for the first finalizer in the list is waiting for a signal (field value, external system, or other) produced by a component responsible for a finalizer later in the list, resulting in a deadlock. Without enforced ordering finalizers are free to order amongst themselves and are not vulnerable to ordering changes in the list.

+

generateName

+

String

+

GenerateName is an optional prefix, used by the server, to generate a unique name ONLY IF the Name field has not been provided. If this field is used, the name returned to the client will be different than the name passed. This value will also be combined with a unique suffix. The provided value has the same validation rules as the Name field, and may be truncated by the length of the suffix required to make the value unique on the server.

+

If this field is specified and the generated name exists, the server will NOT return a 409 - instead, it will either return 201 Created or 500 with Reason ServerTimeout indicating a unique name could not be found in the time allotted, and the client should retry (optionally after the time indicated in the Retry-After header).

+

Applied only if Name is not specified. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#idempotency

+

generation

+

Long

+

A sequence number representing a specific generation of the desired state. Populated by the system. Read-only.

+

labels

+

Map<String,String>

+

Map of string keys and values that can be used to organize and categorize (scope and select) objects. May match selectors of replication controllers and services. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/labels/

+

managedFields

+

Array of io.k8s.apimachinery.pkg.apis.meta.v1.ManagedFieldsEntry objects

+

ManagedFields maps workflow-id and version to the set of fields that are managed by that workflow. This is mostly for internal housekeeping,and users typically shouldn't need to set or understand this field. A workflow can be the user's name, a controller's name, or the name of a specific apply-path like "ci-cd". The set of fields is always in the version that the workflow used when modifying the object.

+

name

+

String

+

Name must be unique within a namespace. Is required when creating resources, although some resources may allow a client to request the generation of an appropriate name automatically. Name is primarily intended for creation idempotence and configuration definition. Cannot be updated. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names

+

namespace

+

String

+

Namespace defines the space within which each name must be unique. An empty namespace is equivalent to the "default" namespace, but "default" is the canonical representation. Not all objects are required to be scoped to a namespace - the value of this field for those objects will be empty.

+

Must be a DNS_LABEL. Cannot be updated. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/namespaces/

+

ownerReferences

+

Array of io.k8s.apimachinery.pkg.apis.meta.v1.OwnerReference objects

+

List of objects depended by this object. If ALL objects in the list have been deleted, this object will be garbage collected. If this object is managed by a controller, then an entry in this list will point to this controller, with the controller field set to true. There cannot be more than one managing controller.

+

resourceVersion

+

String

+

An opaque value that represents the internal version of this object that can be used by clients to determine when objects have changed. May be used for optimistic concurrency, change detection, and the watch operation on a resource or set of resources. Clients must treat these values as opaque and passed unmodified back to the server. They may only be valid for a particular resource or set of resources.

+

Populated by the system. Read-only. Value must be treated as opaque by clients and . More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#concurrency-control-and-consistency

+

selfLink

+

String

+

SelfLink is a URL representing this object. Populated by the system. Read-only.

+

DEPRECATED Kubernetes will stop propagating this field in 1.20 release and the field is planned to be removed in 1.21 release.

+

uid

+

String

+

UID is the unique in time and space value for this object. It is typically generated by the server on successful creation of a resource and is not allowed to change on PUT operations.

+

Populated by the system. Read-only. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#uids

+
+
+ +
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Table 6 io.k8s.apimachinery.pkg.apis.meta.v1.ManagedFieldsEntry

Parameter

+

Type

+

Description

+

apiVersion

+

String

+

APIVersion defines the version of this resource that this field set applies to. The format is "group/version" just like the top-level APIVersion field. It is necessary to track the version of a field set because it cannot be automatically converted.

+

fieldsType

+

String

+

FieldsType is the discriminator for the different fields format and version. There is currently only one possible value: "FieldsV1"

+

fieldsV1

+

Object

+

FieldsV1 holds the first JSON version format as described in the "FieldsV1" type.

+

manager

+

String

+

Manager is an identifier of the workflow managing these fields.

+

operation

+

String

+

Operation is the type of operation which lead to this ManagedFieldsEntry being created. The only valid values for this field are 'Apply' and 'Update'.

+

time

+

String

+

Time is timestamp of when these fields were set. It should always be empty if Operation is 'Apply'

+
+
+ +
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Table 7 io.k8s.apimachinery.pkg.apis.meta.v1.OwnerReference

Parameter

+

Type

+

Description

+

apiVersion

+

String

+

API version of the referent.

+

blockOwnerDeletion

+

Boolean

+

If true, AND if the owner has the "foregroundDeletion" finalizer, then the owner cannot be deleted from the key-value store until this reference is removed. Defaults to false. To set this field, a user needs "delete" permission of the owner, otherwise 422 (Unprocessable Entity) will be returned.

+

controller

+

Boolean

+

If true, this reference points to the managing controller.

+

kind

+

String

+

Kind of the referent. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds

+

name

+

String

+

Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names

+

uid

+

String

+

UID of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#uids

+
+
+ +
+ + + + + + + + + + + + + + + + + + + + + +
Table 8 com.otc.paas-core.yangtse.pkg.apis.yangtse.v2.NetworkSpec

Parameter

+

Type

+

Description

+

ipFamilies

+

Array of strings

+

IPFamilies of Network, can be "IPv4" or "IPv6"

+

networkType

+

String

+

Type of network, only support "underlay-neutron"

+

securityGroups

+

Array of strings

+

SecurityGroups of the network. NOTE: 1. nil means not enable security group; 2. [""] means enable security group but deny all; 3. ["xxx,yyy"] means enable security group and allow with security group ids;

+

subnets

+

Array of com.otc.paas-core.yangtse.pkg.apis.yangtse.v2.SubnetConf objects

+

Describes the subnets of the network

+
+
+ +
+ + + + + + + + + +
Table 9 com.otc.paas-core.yangtse.pkg.apis.yangtse.v2.SubnetConf

Parameter

+

Type

+

Description

+

subnetID

+

String

+

SubnetID subnetV4ID of the subnet

+
+
+ +
+ + + + + + + + + + + + + + + + + +
Table 10 com.otc.paas-core.yangtse.pkg.apis.yangtse.v2.NetworkStatus

Parameter

+

Type

+

Description

+

conditions

+

Array of io.k8s.apimachinery.pkg.apis.meta.v1.Condition objects

+

Conditions describe the current conditions of the Network.

+

status

+

String

+

Status of network, can be "Ready" or "Failed" or "IPInsufficient"

+

subnetAttrs

+

Array of com.otc.paas-core.yangtse.pkg.apis.yangtse.v2.SubnetAttr objects

+

SubnetAttrs describe the current subnet information of the Network.

+
+
+ +
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Table 11 io.k8s.apimachinery.pkg.apis.meta.v1.Condition

Parameter

+

Type

+

Description

+

lastTransitionTime

+

String

+

lastTransitionTime is the last time the condition transitioned from one status to another. This should be when the underlying condition changed. If that is not known, then using the time when the API field changed

+

is acceptable.

+

message

+

String

+

message is a human readable message indicating details about the transition. This may be an empty string.

+

observedGeneration

+

Long

+

observedGeneration represents the .metadata.generation that the condition was set based upon. For instance, if .metadata.generation is currently 12, but the .status.conditions[x].observedGeneration is 9, the condition is out of date with respect to the current state of the instance.

+

reason

+

String

+

reason contains a programmatic identifier indicating the reason for the condition's last transition. Producers of specific condition types may define expected values and meanings for this field, and whether the values are considered a guaranteed API. The value should be a CamelCasestring. This field may not be empty.

+

status

+

String

+

status of the condition, one of True, False, Unknown.

+

type

+

String

+

type of condition in CamelCase or in foo.example.com/CamelCase.

+
+
+ +
+ + + + + + + + + + + + + + + + + +
Table 12 com.otc.paas-core.yangtse.pkg.apis.yangtse.v2.SubnetAttr

Parameter

+

Type

+

Description

+

networkID

+

String

+		  

subnetV4ID

+

String

+		  

subnetV6ID

+

String

+		  
+
+
+

Example Requests

None

+
+

Example Responses

Status code: 200

+

OK

+
{
+  "apiVersion" : "yangtse/v2",
+  "kind" : "Network",
+  "metadata" : {
+    "annotations" : {
+      "yangtse.io/domain-id" : "08a*************************ee60",
+      "yangtse.io/project-id" : "08a2*************************c03",
+      "yangtse.io/warm-pool-recycle-interval" : "1",
+      "yangtse.io/warm-pool-size" : "10"
+    },
+    "creationTimestamp" : "2024-03-25T09:27:52Z",
+    "finalizers" : [ "yangtse.io/network-cleanup" ],
+    "name" : "test-api",
+    "namespace" : "test-api",
+    "resourceVersion" : "17365331",
+    "uid" : "70c20697-a233-4405-b512-ebec1d3c58d0"
+  },
+  "spec" : {
+    "networkType" : "underlay_neutron",
+    "securityGroups" : [ "4120c2f9-3a1d-453e-9b64-f51b92861e26" ],
+    "subnets" : [ {
+      "subnetID" : "2eb62e19-cf1a-4741-90cc-90fb127b20ab"
+    } ]
+  },
+  "status" : {
+    "conditions" : [ {
+      "lastTransitionTime" : "2024-03-25T09:27:53Z",
+      "message" : "",
+      "reason" : "",
+      "status" : "True",
+      "type" : "NetworkSynced"
+    }, {
+      "lastTransitionTime" : "2024-08-12T15:40:03Z",
+      "message" : "",
+      "reason" : "",
+      "status" : "True",
+      "type" : "NetworkExternalDependenciesSynced"
+    } ],
+    "status" : "Ready",
+    "subnetAttrs" : [ {
+      "networkID" : "377b6228-d2a7-47ab-bdb0-f7fc59802198",
+      "subnetV4ID" : "2eb62e19-cf1a-4741-90cc-90fb127b20ab"
+    } ]
+  }
+}
+
+

Status Codes

+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +

Status Code

+

Description

+

200

+

OK

+

400

+

BadRequest

+

401

+

Unauthorized

+

403

+

Forbidden

+

404

+

NotFound

+

405

+

MethodNotAllowed

+

406

+

NotAcceptable

+

409

+

Conflict

+

415

+

UnsupportedMediaType

+

422

+

Invalid

+

429

+

TooManyRequests

+

500

+

InternalError

+

503

+

ServiceUnavailable

+

504

+

ServerTimeout

+
+
+
+
+
+
+
Parent topic: Proprietary APIs
+
+
+ diff --git a/docs/cci/api-ref/replaceCciV2NamespacedConfigMap.html b/docs/cci/api-ref/replaceCciV2NamespacedConfigMap.html new file mode 100644 index 00000000..12b1d375 --- /dev/null +++ b/docs/cci/api-ref/replaceCciV2NamespacedConfigMap.html @@ -0,0 +1,1252 @@ + + +

Replacing the Specified ConfigMap

+

Function

Replace the specified ConfigMap.

+

The following fields can be updated:

+ +
+

Calling Method

For details, see Calling APIs.

+
+

URI

PUT /apis/cci/v2/namespaces/{namespace}/configmaps/{name}

+ +
+ + + + + + + + + + + + + + + + +
Table 1 Path Parameters

Parameter

+

Mandatory

+

Type

+

Description

+

name

+

Yes

+

String

+

Name of the ConfigMap.

+

namespace

+

Yes

+

String

+

Object name and auth scope, such as for teams and projects.

+
+
+ +
+ + + + + + + + + + + + + + + + + + + + + +
Table 2 Query Parameters

Parameter

+

Mandatory

+

Type

+

Description

+

dryRun

+

No

+

String

+

When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed.

+

fieldManager

+

No

+

String

+

fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint.

+

pretty

+

No

+

String

+

If 'true', then the output is pretty printed.

+
+
+
+

Request Parameters

+
+ + + + + + + + + + + + + + + + +
Table 3 Request header parameters

Parameter

+

Mandatory

+

Type

+

Description

+

X-Auth-Token

+

Yes

+

String

+

User token.

+

It can be obtained through the IAM API used to obtain a user token. The value of X-Subject-Token in the response header is the user token.

+

Content-Type

+

Yes

+

String

+

The type of the message body, with a default value of "application/JSON".

+
+
+ +
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Table 4 Request body parameters

Parameter

+

Mandatory

+

Type

+

Description

+

apiVersion

+

No

+

String

+

APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#resources

+

binaryData

+

No

+

Map<String,String>

+

BinaryData contains the binary data. Each key must consist of alphanumeric characters, '-', '_' or '.'. BinaryData can contain byte sequences that are not in the UTF-8 range. The keys stored in BinaryData must not overlap with the ones in the Data field, this is enforced during validation process. Using this field will require 1.10+ apiserver and kubelet.

+

data

+

No

+

Map<String,String>

+

Data contains the configuration data. Each key must consist of alphanumeric characters, '-', '_' or '.'. Values with non-UTF-8 byte sequences must use the BinaryData field. The keys stored in Data must not overlap with the keys in the BinaryData field, this is enforced during validation process.

+

immutable

+

No

+

Boolean

+

Immutable, if set to true, ensures that data stored in the ConfigMap cannot be updated (only object metadata can be modified). If not set to true, the field can be modified at any time. Defaulted to nil.

+

kind

+

No

+

String

+

Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds

+

metadata

+

No

+

io.k8s.apimachinery.pkg.apis.meta.v1.ObjectMeta object

+

Standard object's metadata. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata

+
+
+ +
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Table 5 io.k8s.apimachinery.pkg.apis.meta.v1.ObjectMeta

Parameter

+

Mandatory

+

Type

+

Description

+

annotations

+

No

+

Map<String,String>

+

Annotations is an unstructured key value map stored with a resource that may be set by external tools to store and retrieve arbitrary metadata. They are not queryable and should be preserved when modifying objects. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/annotations/

+

clusterName

+

No

+

String

+

The name of the cluster which the object belongs to. This is used to distinguish resources with same name and namespace in different clusters. This field is not set anywhere right now and apiserver is going to ignore it if set in create or update request.

+

creationTimestamp

+

No

+

String

+

CreationTimestamp is a timestamp representing the server time when this object was created. It is not guaranteed to be set in happens-before order across separate operations. Clients may not set this value. It is represented in RFC3339 form and is in UTC.

+

Populated by the system. Read-only. Null for lists. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata

+

deletionGracePeriodSeconds

+

No

+

Long

+

Number of seconds allowed for this object to gracefully terminate before it will be removed from the system. Only set when deletionTimestamp is also set. May only be shortened. Read-only.

+

deletionTimestamp

+

No

+

String

+

DeletionTimestamp is RFC 3339 date and time at which this resource will be deleted. This field is set by the server when a graceful deletion is requested by the user, and is not directly settable by a client. The resource is expected to be deleted (no longer visible from resource lists, and not reachable by name) after the time in this field, once the finalizers list is empty. As long as the finalizers list contains items, deletion is blocked. Once the deletionTimestamp is set, this value may not be unset or be set further into the future, although it may be shortened or the resource may be deleted prior to this time. For example, a user may request that a pod is deleted in 30 seconds. The Kubelet will react by sending a graceful termination signal to the containers in the pod. After that 30 seconds, the Kubelet will send a hard termination signal (SIGKILL) to the container and after cleanup, remove the pod from the API. In the presence of network partitions, this object may still exist after this timestamp, until an administrator or automated process can determine the resource is fully terminated. If not set, graceful deletion of the object has not been requested.

+

Populated by the system when a graceful deletion is requested. Read-only. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata

+

enable

+

No

+

Boolean

+

Enable identifies whether the resource is available.

+

finalizers

+

No

+

Array of strings

+

Must be empty before the object is deleted from the registry.

+

Each entry is an identifier for the responsible component that will remove the entry from the list. If the deletionTimestamp of the object is non-nil, entries in this list can only be removed. Finalizers may be processed and removed in any order. Order is NOT enforced because it introduces significant risk of stuck finalizers. finalizers is a shared field, any actor with permission can reorder it. If the finalizer list is processed in order, then this can lead to a situation in which the component responsible for the first finalizer in the list is waiting for a signal (field value, external system, or other) produced by a component responsible for a finalizer later in the list, resulting in a deadlock. Without enforced ordering finalizers are free to order amongst themselves and are not vulnerable to ordering changes in the list.

+

generateName

+

No

+

String

+

GenerateName is an optional prefix, used by the server, to generate a unique name ONLY IF the Name field has not been provided. If this field is used, the name returned to the client will be different than the name passed. This value will also be combined with a unique suffix. The provided value has the same validation rules as the Name field, and may be truncated by the length of the suffix required to make the value unique on the server.

+

If this field is specified and the generated name exists, the server will NOT return a 409 - instead, it will either return 201 Created or 500 with Reason ServerTimeout indicating a unique name could not be found in the time allotted, and the client should retry (optionally after the time indicated in the Retry-After header).

+

Applied only if Name is not specified. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#idempotency

+

generation

+

No

+

Long

+

A sequence number representing a specific generation of the desired state. Populated by the system. Read-only.

+

labels

+

No

+

Map<String,String>

+

Map of string keys and values that can be used to organize and categorize (scope and select) objects. May match selectors of replication controllers and services. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/labels/

+

managedFields

+

No

+

Array of io.k8s.apimachinery.pkg.apis.meta.v1.ManagedFieldsEntry objects

+

ManagedFields maps workflow-id and version to the set of fields that are managed by that workflow. This is mostly for internal housekeeping, and users typically shouldn't need to set or understand this field. A workflow can be the user's name, a controller's name, or the name of a specific apply path like "ci-cd". The set of fields is always in the version that the workflow used when modifying the object.

+

name

+

No

+

String

+

Name must be unique within a namespace. Is required when creating resources, although some resources may allow a client to request the generation of an appropriate name automatically. Name is primarily intended for creation idempotence and configuration definition. Cannot be updated. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names

+

namespace

+

No

+

String

+

Namespace defines the space within which each name must be unique. An empty namespace is equivalent to the "default" namespace, but "default" is the canonical representation. Not all objects are required to be scoped to a namespace - the value of this field for those objects will be empty.

+

Must be a DNS_LABEL. Cannot be updated. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/namespaces/

+

ownerReferences

+

No

+

Array of io.k8s.apimachinery.pkg.apis.meta.v1.OwnerReference objects

+

List of objects depended by this object. If ALL objects in the list have been deleted, this object will be garbage collected. If this object is managed by a controller, then an entry in this list will point to this controller, with the controller field set to true. There cannot be more than one managing controller.

+

resourceVersion

+

No

+

String

+

An opaque value that represents the internal version of this object that can be used by clients to determine when objects have changed. May be used for optimistic concurrency, change detection, and the watch operation on a resource or set of resources. Clients must treat these values as opaque and passed unmodified back to the server. They may only be valid for a particular resource or set of resources.

+

Populated by the system. Read-only. Value must be treated as opaque by clients and . More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#concurrency-control-and-consistency

+

selfLink

+

No

+

String

+

SelfLink is a URL representing this object. Populated by the system. Read-only.

+

DEPRECATED Kubernetes will stop propagating this field in 1.20 release and the field is planned to be removed in 1.21 release.

+

uid

+

No

+

String

+

UID is the unique in time and space value for this object. It is typically generated by the server on successful creation of a resource and is not allowed to change on PUT operations.

+

Populated by the system. Read-only. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#uids

+
+
+ +
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Table 6 io.k8s.apimachinery.pkg.apis.meta.v1.ManagedFieldsEntry

Parameter

+

Mandatory

+

Type

+

Description

+

apiVersion

+

No

+

String

+

APIVersion defines the version of this resource that this field set applies to. The format is "group/version" just like the top-level APIVersion field. It is necessary to track the version of a field set because it cannot be automatically converted.

+

fieldsType

+

No

+

String

+

FieldsType is the discriminator for the different fields format and version. There is currently only one possible value: "FieldsV1"

+

fieldsV1

+

No

+

Object

+

FieldsV1 holds the first JSON version format as described in the "FieldsV1" type.

+

manager

+

No

+

String

+

Manager is an identifier of the workflow managing these fields.

+

operation

+

No

+

String

+

Operation is the type of operation which lead to this ManagedFieldsEntry being created. The only valid values for this field are 'Apply' and 'Update'.

+

time

+

No

+

String

+

Time is timestamp of when these fields were set. It should always be empty if Operation is 'Apply'.

+
+
+ +
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Table 7 io.k8s.apimachinery.pkg.apis.meta.v1.OwnerReference

Parameter

+

Mandatory

+

Type

+

Description

+

apiVersion

+

Yes

+

String

+

API version of the referent.

+

blockOwnerDeletion

+

No

+

Boolean

+

If true, AND if the owner has the "foregroundDeletion" finalizer, then the owner cannot be deleted from the key-value store until this reference is removed. Defaults to false. To set this field, a user needs "delete" permission of the owner, otherwise 422 (Unprocessable Entity) will be returned.

+

controller

+

No

+

Boolean

+

If true, this reference points to the managing controller.

+

kind

+

Yes

+

String

+

Kind of the referent. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds

+

name

+

Yes

+

String

+

Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names

+

uid

+

Yes

+

String

+

UID of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#uids

+
+
+
+

Response Parameters

Status code: 200

+ +
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Table 8 Response body parameters

Parameter

+

Type

+

Description

+

apiVersion

+

String

+

APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#resources

+

binaryData

+

Map<String,String>

+

BinaryData contains the binary data. Each key must consist of alphanumeric characters, '-', '_' or '.'. BinaryData can contain byte sequences that are not in the UTF-8 range. The keys stored in BinaryData must not overlap with the ones in the Data field, this is enforced during validation process. Using this field will require 1.10+ apiserver and kubelet.

+

data

+

Map<String,String>

+

Data contains the configuration data. Each key must consist of alphanumeric characters, '-', '_' or '.'. Values with non-UTF-8 byte sequences must use the BinaryData field. The keys stored in Data must not overlap with the keys in the BinaryData field, this is enforced during validation process.

+

immutable

+

Boolean

+

Immutable, if set to true, ensures that data stored in the ConfigMap cannot be updated (only object metadata can be modified). If not set to true, the field can be modified at any time. Defaulted to nil.

+

kind

+

String

+

Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds

+

metadata

+

io.k8s.apimachinery.pkg.apis.meta.v1.ObjectMeta object

+

Standard object's metadata. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata

+
+
+ +
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Table 9 io.k8s.apimachinery.pkg.apis.meta.v1.ObjectMeta

Parameter

+

Type

+

Description

+

annotations

+

Map<String,String>

+

Annotations is an unstructured key value map stored with a resource that may be set by external tools to store and retrieve arbitrary metadata. They are not queryable and should be preserved when modifying objects. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/annotations/

+

clusterName

+

String

+

The name of the cluster which the object belongs to. This is used to distinguish resources with same name and namespace in different clusters. This field is not set anywhere right now and apiserver is going to ignore it if set in create or update request.

+

creationTimestamp

+

String

+

CreationTimestamp is a timestamp representing the server time when this object was created. It is not guaranteed to be set in happens-before order across separate operations. Clients may not set this value. It is represented in RFC3339 form and is in UTC.

+

Populated by the system. Read-only. Null for lists. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata

+

deletionGracePeriodSeconds

+

Long

+

Number of seconds allowed for this object to gracefully terminate before it will be removed from the system. Only set when deletionTimestamp is also set. May only be shortened. Read-only.

+

deletionTimestamp

+

String

+

DeletionTimestamp is RFC 3339 date and time at which this resource will be deleted. This field is set by the server when a graceful deletion is requested by the user, and is not directly settable by a client. The resource is expected to be deleted (no longer visible from resource lists, and not reachable by name) after the time in this field, once the finalizers list is empty. As long as the finalizers list contains items, deletion is blocked. Once the deletionTimestamp is set, this value may not be unset or be set further into the future, although it may be shortened or the resource may be deleted prior to this time. For example, a user may request that a pod is deleted in 30 seconds. The Kubelet will react by sending a graceful termination signal to the containers in the pod. After that 30 seconds, the Kubelet will send a hard termination signal (SIGKILL) to the container and after cleanup, remove the pod from the API. In the presence of network partitions, this object may still exist after this timestamp, until an administrator or automated process can determine the resource is fully terminated. If not set, graceful deletion of the object has not been requested.

+

Populated by the system when a graceful deletion is requested. Read-only. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata

+

enable

+

Boolean

+

Enable identifies whether the resource is available.

+

finalizers

+

Array of strings

+

Must be empty before the object is deleted from the registry.

+

Each entry is an identifier for the responsible component that will remove the entry from the list. If the deletionTimestamp of the object is non-nil, entries in this list can only be removed. Finalizers may be processed and removed in any order. Order is NOT enforced because it introduces significant risk of stuck finalizers. finalizers is a shared field, any actor with permission can reorder it. If the finalizer list is processed in order, then this can lead to a situation in which the component responsible for the first finalizer in the list is waiting for a signal (field value, external system, or other) produced by a component responsible for a finalizer later in the list, resulting in a deadlock. Without enforced ordering finalizers are free to order amongst themselves and are not vulnerable to ordering changes in the list.

+

generateName

+

String

+

GenerateName is an optional prefix, used by the server, to generate a unique name ONLY IF the Name field has not been provided. If this field is used, the name returned to the client will be different than the name passed. This value will also be combined with a unique suffix. The provided value has the same validation rules as the Name field, and may be truncated by the length of the suffix required to make the value unique on the server.

+

If this field is specified and the generated name exists, the server will NOT return a 409 - instead, it will either return 201 Created or 500 with Reason ServerTimeout indicating a unique name could not be found in the time allotted, and the client should retry (optionally after the time indicated in the Retry-After header).

+

Applied only if Name is not specified. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#idempotency

+

generation

+

Long

+

A sequence number representing a specific generation of the desired state. Populated by the system. Read-only.

+

labels

+

Map<String,String>

+

Map of string keys and values that can be used to organize and categorize (scope and select) objects. May match selectors of replication controllers and services. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/labels/

+

managedFields

+

Array of io.k8s.apimachinery.pkg.apis.meta.v1.ManagedFieldsEntry objects

+

ManagedFields maps workflow-id and version to the set of fields that are managed by that workflow. This is mostly for internal housekeeping, and users typically shouldn't need to set or understand this field. A workflow can be the user's name, a controller's name, or the name of a specific apply path like "ci-cd". The set of fields is always in the version that the workflow used when modifying the object.

+

name

+

String

+

Name must be unique within a namespace. Is required when creating resources, although some resources may allow a client to request the generation of an appropriate name automatically. Name is primarily intended for creation idempotence and configuration definition. Cannot be updated. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names

+

namespace

+

String

+

Namespace defines the space within which each name must be unique. An empty namespace is equivalent to the "default" namespace, but "default" is the canonical representation. Not all objects are required to be scoped to a namespace - the value of this field for those objects will be empty.

+

Must be a DNS_LABEL. Cannot be updated. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/namespaces/

+

ownerReferences

+

Array of io.k8s.apimachinery.pkg.apis.meta.v1.OwnerReference objects

+

List of objects depended by this object. If ALL objects in the list have been deleted, this object will be garbage collected. If this object is managed by a controller, then an entry in this list will point to this controller, with the controller field set to true. There cannot be more than one managing controller.

+

resourceVersion

+

String

+

An opaque value that represents the internal version of this object that can be used by clients to determine when objects have changed. May be used for optimistic concurrency, change detection, and the watch operation on a resource or set of resources. Clients must treat these values as opaque and passed unmodified back to the server. They may only be valid for a particular resource or set of resources.

+

Populated by the system. Read-only. Value must be treated as opaque by clients and . More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#concurrency-control-and-consistency

+

selfLink

+

String

+

SelfLink is a URL representing this object. Populated by the system. Read-only.

+

DEPRECATED Kubernetes will stop propagating this field in 1.20 release and the field is planned to be removed in 1.21 release.

+

uid

+

String

+

UID is the unique in time and space value for this object. It is typically generated by the server on successful creation of a resource and is not allowed to change on PUT operations.

+

Populated by the system. Read-only. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#uids

+
+
+ +
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Table 10 io.k8s.apimachinery.pkg.apis.meta.v1.ManagedFieldsEntry

Parameter

+

Type

+

Description

+

apiVersion

+

String

+

APIVersion defines the version of this resource that this field set applies to. The format is "group/version" just like the top-level APIVersion field. It is necessary to track the version of a field set because it cannot be automatically converted.

+

fieldsType

+

String

+

FieldsType is the discriminator for the different fields format and version. There is currently only one possible value: "FieldsV1"

+

fieldsV1

+

Object

+

FieldsV1 holds the first JSON version format as described in the "FieldsV1" type.

+

manager

+

String

+

Manager is an identifier of the workflow managing these fields.

+

operation

+

String

+

Operation is the type of operation which lead to this ManagedFieldsEntry being created. The only valid values for this field are 'Apply' and 'Update'.

+

time

+

String

+

Time is timestamp of when these fields were set. It should always be empty if Operation is 'Apply'

+
+
+ +
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Table 11 io.k8s.apimachinery.pkg.apis.meta.v1.OwnerReference

Parameter

+

Type

+

Description

+

apiVersion

+

String

+

API version of the referent.

+

blockOwnerDeletion

+

Boolean

+

If true, AND if the owner has the "foregroundDeletion" finalizer, then the owner cannot be deleted from the key-value store until this reference is removed. Defaults to false. To set this field, a user needs "delete" permission of the owner, otherwise 422 (Unprocessable Entity) will be returned.

+

controller

+

Boolean

+

If true, this reference points to the managing controller.

+

kind

+

String

+

Kind of the referent. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds

+

name

+

String

+

Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names

+

uid

+

String

+

UID of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#uids

+
+
+

Status code: 201

+ +
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Table 12 Response body parameters

Parameter

+

Type

+

Description

+

apiVersion

+

String

+

APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#resources

+

binaryData

+

Map<String,String>

+

BinaryData contains the binary data. Each key must consist of alphanumeric characters, '-', '_' or '.'. BinaryData can contain byte sequences that are not in the UTF-8 range. The keys stored in BinaryData must not overlap with the ones in the Data field, this is enforced during validation process. Using this field will require 1.10+ apiserver and kubelet.

+

data

+

Map<String,String>

+

Data contains the configuration data. Each key must consist of alphanumeric characters, '-', '_' or '.'. Values with non-UTF-8 byte sequences must use the BinaryData field. The keys stored in Data must not overlap with the keys in the BinaryData field, this is enforced during validation process.

+

immutable

+

Boolean

+

Immutable, if set to true, ensures that data stored in the ConfigMap cannot be updated (only object metadata can be modified). If not set to true, the field can be modified at any time. Defaulted to nil.

+

kind

+

String

+

Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds

+

metadata

+

io.k8s.apimachinery.pkg.apis.meta.v1.ObjectMeta object

+

Standard object's metadata. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata

+
+
+ +
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Table 13 io.k8s.apimachinery.pkg.apis.meta.v1.ObjectMeta

Parameter

+

Type

+

Description

+

annotations

+

Map<String,String>

+

Annotations is an unstructured key value map stored with a resource that may be set by external tools to store and retrieve arbitrary metadata. They are not queryable and should be preserved when modifying objects. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/annotations/

+

clusterName

+

String

+

The name of the cluster which the object belongs to. This is used to distinguish resources with same name and namespace in different clusters. This field is not set anywhere right now and apiserver is going to ignore it if set in create or update request.

+

creationTimestamp

+

String

+

CreationTimestamp is a timestamp representing the server time when this object was created. It is not guaranteed to be set in happens-before order across separate operations. Clients may not set this value. It is represented in RFC3339 form and is in UTC.

+

Populated by the system. Read-only. Null for lists. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata

+

deletionGracePeriodSeconds

+

Long

+

Number of seconds allowed for this object to gracefully terminate before it will be removed from the system. Only set when deletionTimestamp is also set. May only be shortened. Read-only.

+

deletionTimestamp

+

String

+

DeletionTimestamp is RFC 3339 date and time at which this resource will be deleted. This field is set by the server when a graceful deletion is requested by the user, and is not directly settable by a client. The resource is expected to be deleted (no longer visible from resource lists, and not reachable by name) after the time in this field, once the finalizers list is empty. As long as the finalizers list contains items, deletion is blocked. Once the deletionTimestamp is set, this value may not be unset or be set further into the future, although it may be shortened or the resource may be deleted prior to this time. For example, a user may request that a pod is deleted in 30 seconds. The Kubelet will react by sending a graceful termination signal to the containers in the pod. After that 30 seconds, the Kubelet will send a hard termination signal (SIGKILL) to the container and after cleanup, remove the pod from the API. In the presence of network partitions, this object may still exist after this timestamp, until an administrator or automated process can determine the resource is fully terminated. If not set, graceful deletion of the object has not been requested.

+

Populated by the system when a graceful deletion is requested. Read-only. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata

+

enable

+

Boolean

+

Enable identifies whether the resource is available

+

finalizers

+

Array of strings

+

Must be empty before the object is deleted from the registry.

+

Each entry is an identifier for the responsible component that will remove the entry from the list. If the deletionTimestamp of the object is non-nil, entries in this list can only be removed. Finalizers may be processed and removed in any order. Order is NOT enforced because it introduces significant risk of stuck finalizers. finalizers is a shared field, any actor with permission can reorder it. If the finalizer list is processed in order, then this can lead to a situation in which the component responsible for the first finalizer in the list is waiting for a signal (field value, external system, or other) produced by a component responsible for a finalizer later in the list, resulting in a deadlock. Without enforced ordering finalizers are free to order amongst themselves and are not vulnerable to ordering changes in the list.

+

generateName

+

String

+

GenerateName is an optional prefix, used by the server, to generate a unique name ONLY IF the Name field has not been provided. If this field is used, the name returned to the client will be different than the name passed. This value will also be combined with a unique suffix. The provided value has the same validation rules as the Name field, and may be truncated by the length of the suffix required to make the value unique on the server.

+

If this field is specified and the generated name exists, the server will NOT return a 409 - instead, it will either return 201 Created or 500 with Reason ServerTimeout indicating a unique name could not be found in the time allotted, and the client should retry (optionally after the time indicated in the Retry-After header).

+

Applied only if Name is not specified. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#idempotency

+

generation

+

Long

+

A sequence number representing a specific generation of the desired state. Populated by the system. Read-only.

+

labels

+

Map<String,String>

+

Map of string keys and values that can be used to organize and categorize (scope and select) objects. May match selectors of replication controllers and services. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/labels/

+

managedFields

+

Array of io.k8s.apimachinery.pkg.apis.meta.v1.ManagedFieldsEntry objects

+

ManagedFields maps workflow-id and version to the set of fields that are managed by that workflow. This is mostly for internal housekeeping, and users typically shouldn't need to set or understand this field. A workflow can be the user's name, a controller's name, or the name of a specific apply path like "ci-cd". The set of fields is always in the version that the workflow used when modifying the object.

+

name

+

String

+

Name must be unique within a namespace. Is required when creating resources, although some resources may allow a client to request the generation of an appropriate name automatically. Name is primarily intended for creation idempotence and configuration definition. Cannot be updated. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names

+

namespace

+

String

+

Namespace defines the space within which each name must be unique. An empty namespace is equivalent to the "default" namespace, but "default" is the canonical representation. Not all objects are required to be scoped to a namespace - the value of this field for those objects will be empty.

+

Must be a DNS_LABEL. Cannot be updated. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/namespaces/

+

ownerReferences

+

Array of io.k8s.apimachinery.pkg.apis.meta.v1.OwnerReference objects

+

List of objects depended by this object. If ALL objects in the list have been deleted, this object will be garbage collected. If this object is managed by a controller, then an entry in this list will point to this controller, with the controller field set to true. There cannot be more than one managing controller.

+

resourceVersion

+

String

+

An opaque value that represents the internal version of this object that can be used by clients to determine when objects have changed. May be used for optimistic concurrency, change detection, and the watch operation on a resource or set of resources. Clients must treat these values as opaque and passed unmodified back to the server. They may only be valid for a particular resource or set of resources.

+

Populated by the system. Read-only. Value must be treated as opaque by clients and . More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#concurrency-control-and-consistency

+

selfLink

+

String

+

SelfLink is a URL representing this object. Populated by the system. Read-only.

+

DEPRECATED Kubernetes will stop propagating this field in 1.20 release and the field is planned to be removed in 1.21 release.

+

uid

+

String

+

UID is the unique in time and space value for this object. It is typically generated by the server on successful creation of a resource and is not allowed to change on PUT operations.

+

Populated by the system. Read-only. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#uids

+
+
+ +
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Table 14 io.k8s.apimachinery.pkg.apis.meta.v1.ManagedFieldsEntry

Parameter

+

Type

+

Description

+

apiVersion

+

String

+

APIVersion defines the version of this resource that this field set applies to. The format is "group/version" just like the top-level APIVersion field. It is necessary to track the version of a field set because it cannot be automatically converted.

+

fieldsType

+

String

+

FieldsType is the discriminator for the different fields format and version. There is currently only one possible value: "FieldsV1"

+

fieldsV1

+

Object

+

FieldsV1 holds the first JSON version format as described in the "FieldsV1" type.

+

manager

+

String

+

Manager is an identifier of the workflow managing these fields.

+

operation

+

String

+

Operation is the type of operation which lead to this ManagedFieldsEntry being created. The only valid values for this field are 'Apply' and 'Update'.

+

time

+

String

+

Time is timestamp of when these fields were set. It should always be empty if Operation is 'Apply'.

+
+
+ +
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Table 15 io.k8s.apimachinery.pkg.apis.meta.v1.OwnerReference

Parameter

+

Type

+

Description

+

apiVersion

+

String

+

API version of the referent.

+

blockOwnerDeletion

+

Boolean

+

If true, AND if the owner has the "foregroundDeletion" finalizer, then the owner cannot be deleted from the key-value store until this reference is removed. Defaults to false. To set this field, a user needs "delete" permission of the owner, otherwise 422 (Unprocessable Entity) will be returned.

+

controller

+

Boolean

+

If true, this reference points to the managing controller.

+

kind

+

String

+

Kind of the referent. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds

+

name

+

String

+

Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names

+

uid

+

String

+

UID of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#uids

+
+
+
+

Example Requests

{
+  "apiVersion" : "cci/v2",
+  "data" : {
+    "key1" : "value1",
+    "key2" : "value2"
+  },
+  "kind" : "ConfigMap",
+  "metadata" : {
+    "annotations" : {
+      "tenant.cci.io/tenant-id" : "08a2*************************c03"
+    },
+    "creationTimestamp" : "2024-10-09T12:05:03Z",
+    "labels" : {
+      "sys_enterprise_project_id" : "0",
+      "tenant.cci.io/tenant-id" : "08a2*************************c03",
+      "tenant.kubernetes.io/domain-id" : "08a*************************ee60",
+      "tenant.kubernetes.io/project-id" : "08a2*************************c03",
+      "usage" : "just-for-test"
+    },
+    "name" : "test-cm",
+    "namespace" : "wbtest4",
+    "resourceVersion" : "391020615",
+    "uid" : "7c6f7981-78bb-42ff-b659-b8b4cbcbab5e"
+  }
+}
+
+

Example Responses

Status code: 200

+

OK

+
{
+  "apiVersion" : "cci/v2",
+  "data" : {
+    "key1" : "value1",
+    "key2" : "value2"
+  },
+  "kind" : "ConfigMap",
+  "metadata" : {
+    "annotations" : {
+      "tenant.cci.io/tenant-id" : "08a2*************************c03"
+    },
+    "creationTimestamp" : "2024-10-09T12:05:03Z",
+    "labels" : {
+      "sys_enterprise_project_id" : "0",
+      "tenant.cci.io/tenant-id" : "08a2*************************c03",
+      "tenant.kubernetes.io/domain-id" : "08a*************************ee60",
+      "tenant.kubernetes.io/project-id" : "08a2*************************c03",
+      "usage" : "just-for-test"
+    },
+    "name" : "test-cm",
+    "namespace" : "wbtest4",
+    "resourceVersion" : "391020615",
+    "uid" : "7c6f7981-78bb-42ff-b659-b8b4cbcbab5e"
+  }
+}
+
+

Status Codes

+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +

Status Code

+

Description

+

200

+

OK

+

201

+

Created

+

400

+

BadRequest

+

401

+

Unauthorized

+

403

+

Forbidden

+

404

+

NotFound

+

405

+

MethodNotAllowed

+

406

+

NotAcceptable

+

409

+

Conflict

+

415

+

UnsupportedMediaType

+

422

+

Invalid

+

429

+

TooManyRequests

+

500

+

InternalError

+

503

+

ServiceUnavailable

+

504

+

ServerTimeout

+
+
+
+
+
+
+
Parent topic: Proprietary APIs
+
+
+ diff --git a/docs/cci/api-ref/replaceCciV2NamespacedPod.html b/docs/cci/api-ref/replaceCciV2NamespacedPod.html new file mode 100644 index 00000000..4124226b --- /dev/null +++ b/docs/cci/api-ref/replaceCciV2NamespacedPod.html @@ -0,0 +1,11545 @@ + + +

Replacing the Specified Pod

+

Function

Replace the specified Pod.

+

The following fields can be updated:

+ +
+

Calling Method

For details, see Calling APIs.

+
+

URI

PUT /apis/cci/v2/namespaces/{namespace}/pods/{name}

+ +
+ + + + + + + + + + + + + + + + +
Table 1 Path Parameters

Parameter

+

Mandatory

+

Type

+

Description

+

name

+

Yes

+

String

+

Name of the Pod.

+

namespace

+

Yes

+

String

+

Object name and auth scope, such as for teams and projects.

+
+
+ +
+ + + + + + + + + + + + + + + + + + + + + +
Table 2 Query Parameters

Parameter

+

Mandatory

+

Type

+

Description

+

dryRun

+

No

+

String

+

When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed

+

fieldManager

+

No

+

String

+

fieldManager is a name associated with the actor or entity that

+

is making these changes. The value must be less than or 128 characters long,

+

and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint.

+

pretty

+

No

+

String

+

If 'true', then the output is pretty printed.

+
+
+
+

Request Parameters

+
+ + + + + + + + + + + + + + + + +
Table 3 Request header parameters

Parameter

+

Mandatory

+

Type

+

Description

+

X-Auth-Token

+

Yes

+

String

+

User token.

+

It can be obtained through the IAM API used to obtain a user token. The value of X-Subject-Token in the response header is the user token.

+

Content-Type

+

Yes

+

String

+

The type of the message body, with a default value of "application/JSON".

+
+
+ +
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Table 4 Request body parameters

Parameter

+

Mandatory

+

Type

+

Description

+

apiVersion

+

No

+

String

+

APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#resources

+

kind

+

No

+

String

+

Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds

+

metadata

+

No

+

io.k8s.apimachinery.pkg.apis.meta.v1.ObjectMeta object

+

Standard object's metadata. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata

+

spec

+

No

+

io.cci.otc.api.pkg.apis.versioned.cci.v2.PodSpec object

+

Specification of the desired behavior of the pod. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#spec-and-status

+

status

+

No

+

io.cci.otc.api.pkg.apis.versioned.cci.v2.PodStatus object

+

Most recently observed status of the pod. This data may not be up to date. Populated by the system. Read-only. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#spec-and-status

+
+
+ +
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Table 5 io.cci.otc.api.pkg.apis.versioned.cci.v2.PodSpec

Parameter

+

Mandatory

+

Type

+

Description

+

activeDeadlineSeconds

+

No

+

Long

+

Optional duration in seconds the pod may be active on the node

+

relative to StartTime before the system will actively try to mark it failed

+

and kill associated containers. Value must be a positive integer.

+

affinity

+

No

+

io.cci.otc.api.pkg.apis.versioned.cci.v2.Affinity object

+

If specified, the pod's scheduling constraints

+

containers

+

Yes

+

Array of io.cci.otc.api.pkg.apis.versioned.cci.v2.Container objects

+

List of containers belonging to the pod. Containers cannot currently

+

be added or removed. There must be at least one container in a Pod. Cannot

+

be updated.

+

dnsConfig

+

No

+

io.cci.otc.api.pkg.apis.versioned.cci.v2.PodDNSConfig object

+

Specifies the DNS parameters of a pod. Parameters specified here

+

will be merged to the generated DNS configuration based on DNSPolicy.

+

dnsPolicy

+

No

+

String

+

Set DNS policy for the pod. Defaults to "ClusterFirst". Valid values are 'ClusterFirstWithHostNet', 'ClusterFirst', 'Default' or 'None'. DNS parameters given in DNSConfig will be merged with the policy selected with DNSPolicy. To have DNS options set along with hostNetwork, you have to specify DNS policy explicitly to 'ClusterFirstWithHostNet'.

+

Possible enum values:

+
  • "ClusterFirst" indicates that the pod should use cluster DNS first unless hostNetwork is true, if it is available, then fall back on the default (as determined by kubelet) DNS settings.
  • "ClusterFirstWithHostNet" indicates that the pod should use cluster DNS first, if it is available, then fall back on the default (as determined by kubelet) DNS settings.
  • "Default" indicates that the pod should use the default (as determined by kubelet) DNS settings.
  • "None" indicates that the pod should use empty DNS settings. DNS parameters such as nameservers and search paths should be defined via DNSConfig.
+

ephemeralContainers

+

No

+

Array of io.cci.otc.api.pkg.apis.versioned.cci.v2.EphemeralContainer objects

+

List of ephemeral containers run in this pod. Ephemeral containers

+

may be run in an existing pod to perform user-initiated actions such as

+

debugging. This list cannot be specified when creating a pod, and it cannot

+

be modified by updating the pod spec. In order to add an ephemeral container

+

to an existing pod, use the pod's ephemeralcontainers subresource.

+

hostAliases

+

No

+

Array of io.cci.otc.api.pkg.apis.versioned.cci.v2.HostAlias objects

+

HostAliases is an optional list of hosts and IPs that will be

+

injected into the pod's hosts file if specified. This is only valid for

+

non-hostNetwork pods.

+

hostname

+

No

+

String

+

Specifies the hostName of the Pod. If not specified, the pod's

+

hostname will be set to a system-defined value.

+

imagePullSecrets

+

No

+

Array of io.cci.otc.api.pkg.apis.versioned.cci.v2.LocalObjectReference objects

+

ImagePullSecrets is an optional list of references to secrets in the same namespace to use for pulling any of the images used by this PodSpec. If specified, these secrets will be passed to individual puller implementations for them to use. More info: https://kubernetes.io/docs/concepts/containers/images#specifying-imagepullsecrets-on-a-pod

+

initContainers

+

No

+

Array of io.cci.otc.api.pkg.apis.versioned.cci.v2.Container objects

+

List of initialization containers belonging to the pod. Init containers are executed in order prior to containers being started. If any init container fails, the pod is considered to have failed and is handled according to its restartPolicy. The name for an init container or normal container must be unique among all containers. Init containers may not have Lifecycle actions, Readiness probes, Liveness probes, or Startup probes. The resourceRequirements of an init container are taken into account during scheduling by finding the highest request/limit for each resource type, and then using the max of of that value or the sum of the normal containers. Limits are applied to init containers in a similar fashion. Init containers cannot currently be added or removed. Cannot be updated. More info: https://kubernetes.io/docs/concepts/workloads/pods/init-containers/

+

nodeName

+

No

+

String

+

NodeName is a request to schedule this pod onto a specific node.

+

If it is non-empty, the scheduler simply schedules this pod onto that node,

+

assuming that it fits resource requirements.

+

overhead

+

No

+

Map<String,String>

+

Overhead represents the resource overhead associated with running a pod for a given RuntimeClass. This field will be autopopulated at admission time by the RuntimeClass admission controller. If the RuntimeClass admission controller is enabled, overhead must not be set in Pod create requests. The RuntimeClass admission controller will reject Pod create requests which have the overhead already set. If RuntimeClass is configured and selected in the PodSpec, Overhead will be set to the value defined in the corresponding RuntimeClass, otherwise it will remain unset and treated as zero. More info: https://git.k8s.io/enhancements/keps/sig-node/688-pod-overhead/README.md

+

readinessGates

+

No

+

Array of io.cci.otc.api.pkg.apis.versioned.cci.v2.PodReadinessGate objects

+

If specified, all readiness gates will be evaluated for pod readiness. A pod is ready when all its containers are ready AND all conditions specified in the readiness gates have status equal to "True" More info: https://git.k8s.io/enhancements/keps/sig-network/580-pod-readiness-gates

+

restartPolicy

+

No

+

String

+

Restart policy for all containers within the pod. One of Always, OnFailure, Never. Default to Always. More info: https://kubernetes.io/docs/concepts/workloads/pods/pod-lifecycle/#restart-policy

+

Possible enum values:

+
  • "Always"
  • "Never"
  • "OnFailure"
+

schedulerName

+

No

+

String

+

If specified, the pod will be dispatched by specified scheduler.

+

If not specified, the pod will be dispatched by default scheduler.

+

securityContext

+

No

+

io.cci.otc.api.pkg.apis.versioned.cci.v2.PodSecurityContext object

+

SecurityContext holds pod-level security attributes and common container settings. Optional: Defaults to empty. See type description for default values of each field.

+

setHostnameAsFQDN

+

No

+

Boolean

+

If true the pod's hostname will be configured as the pod's FQDN,

+

rather than the leaf name (the default). In Linux containers, this means

+

setting the FQDN in the hostname field of the kernel (the nodename field

+

of struct utsname). In Windows containers, this means setting the registry

+

value of hostname for the registry key HKEY_LOCAL_MACHINE\SYSTEM\CurrentControlSet\Services\Tcpip\Parameters

+

to FQDN. If a pod does not have FQDN, this has no effect. Default to false.

+

shareProcessNamespace

+

No

+

Boolean

+

Share a single process namespace between all of the containers in a pod. When this is set containers will be able to view and signal processes from other containers in the same pod, and the first process in each container will not be assigned PID 1. HostPID and ShareProcessNamespace cannot both be set. Optional: Default to false.

+

terminationGracePeriodSeconds

+

No

+

Long

+

Optional duration in seconds the pod needs to terminate gracefully.

+

May be decreased in delete request. Value must be non-negative integer.

+

The value zero indicates stop immediately via the kill signal (no opportunity

+

to shut down). If this value is nil, the default grace period will be used

+

instead. The grace period is the duration in seconds after the processes

+

running in the pod are sent a termination signal and the time when the processes

+

are forcibly halted with a kill signal. Set this value longer than the expected

+

cleanup time for your process. Defaults to 30 seconds.

+

topologySpreadConstraints

+

No

+

Array of io.cci.otc.api.pkg.apis.versioned.cci.v2.TopologySpreadConstraint objects

+

TopologySpreadConstraints describes how a group of pods ought

+

to spread across topology domains. Scheduler will schedule pods in a way

+

which abides by the constraints. All topologySpreadConstraints are ANDed.

+

volumes

+

No

+

Array of io.cci.otc.api.pkg.apis.versioned.cci.v2.Volume objects

+

List of volumes that can be mounted by containers belonging to the pod. More info: https://kubernetes.io/docs/concepts/storage/volumes

+
+
+ +
+ + + + + + + + + + + + + + + + +
Table 6 io.cci.otc.api.pkg.apis.versioned.cci.v2.Affinity

Parameter

+

Mandatory

+

Type

+

Description

+

nodeAffinity

+

No

+

io.cci.otc.api.pkg.apis.versioned.cci.v2.NodeAffinity object

+

Describes node affinity scheduling rules for the pod.

+

podAntiAffinity

+

No

+

io.cci.otc.api.pkg.apis.versioned.cci.v2.PodAntiAffinity object

+

Describes pod anti-affinity scheduling rules (e.g. avoid putting

+

this pod in the same zone, etc. as some other pod(s)).

+
+
+ +
+ + + + + + + + + + + +
Table 7 io.cci.otc.api.pkg.apis.versioned.cci.v2.NodeAffinity

Parameter

+

Mandatory

+

Type

+

Description

+

requiredDuringSchedulingIgnoredDuringExecution

+

No

+

io.cci.otc.api.pkg.apis.versioned.cci.v2.NodeSelector object

+

If the affinity requirements specified by this field are not

+

met at scheduling time, the pod will not be scheduled onto the node. If

+

the affinity requirements specified by this field cease to be met at some

+

point during pod execution (e.g. due to an update), the system may or may

+

not try to eventually evict the pod from its node.

+
+
+ +
+ + + + + + + + + + + +
Table 8 io.cci.otc.api.pkg.apis.versioned.cci.v2.NodeSelector

Parameter

+

Mandatory

+

Type

+

Description

+

nodeSelectorTerms

+

Yes

+

Array of io.cci.otc.api.pkg.apis.versioned.cci.v2.NodeSelectorTerm objects

+

Required. A list of node selector terms. The terms are ORed.

+
+
+ +
+ + + + + + + + + + + +
Table 9 io.cci.otc.api.pkg.apis.versioned.cci.v2.NodeSelectorTerm

Parameter

+

Mandatory

+

Type

+

Description

+

matchExpressions

+

No

+

Array of io.cci.otc.api.pkg.apis.versioned.cci.v2.NodeSelectorRequirement objects

+

A list of node selector requirements by node's labels.

+
+
+ +
+ + + + + + + + + + + + + + + + + + + + + +
Table 10 io.cci.otc.api.pkg.apis.versioned.cci.v2.NodeSelectorRequirement

Parameter

+

Mandatory

+

Type

+

Description

+

key

+

Yes

+

String

+

The label key that the selector applies to.

+

operator

+

Yes

+

String

+

Represents a key's relationship to a set of values. Valid operators are In, NotIn, Exists, DoesNotExist. Gt, and Lt.

+

Possible enum values:

+
  • "DoesNotExist"
  • "Exists"
  • "Gt"
  • "In"
  • "Lt"
  • "NotIn"
+

values

+

No

+

Array of strings

+

An array of string values. If the operator is In or NotIn, the

+

values array must be non-empty. If the operator is Exists or DoesNotExist,

+

the values array must be empty. If the operator is Gt or Lt, the values

+

array must have a single element, which will be interpreted as an integer.

+

This array is replaced during a strategic merge patch.

+
+
+ +
+ + + + + + + + + + + + + + + + +
Table 11 io.cci.otc.api.pkg.apis.versioned.cci.v2.PodAntiAffinity

Parameter

+

Mandatory

+

Type

+

Description

+

preferredDuringSchedulingIgnoredDuringExecution

+

No

+

Array of io.cci.otc.api.pkg.apis.versioned.cci.v2.WeightedPodAffinityTerm objects

+

The scheduler will prefer to schedule pods to nodes that satisfy

+

the anti-affinity expressions specified by this field, but it may choose

+

a node that violates one or more of the expressions. The node that is most

+

preferred is the one with the greatest sum of weights, i.e. for each node

+

that meets all of the scheduling requirements (resource request, requiredDuringScheduling

+

anti-affinity expressions, etc.), compute a sum by iterating through the

+

elements of this field and adding "weight" to the sum if the node has pods

+

which matches the corresponding podAffinityTerm; the node(s) with the highest

+

sum are the most preferred.

+

requiredDuringSchedulingIgnoredDuringExecution

+

No

+

Array of io.cci.otc.api.pkg.apis.versioned.cci.v2.PodAffinityTerm objects

+

If the anti-affinity requirements specified by this field are

+

not met at scheduling time, the pod will not be scheduled onto the node.

+

If the anti-affinity requirements specified by this field cease to be met

+

at some point during pod execution (e.g. due to a pod label update), the

+

system may or may not try to eventually evict the pod from its node. When

+

there are multiple elements, the lists of nodes corresponding to each podAffinityTerm

+

are intersected, i.e. all terms must be satisfied.

+
+
+ +
+ + + + + + + + + + + + + + + + +
Table 12 io.cci.otc.api.pkg.apis.versioned.cci.v2.WeightedPodAffinityTerm

Parameter

+

Mandatory

+

Type

+

Description

+

podAffinityTerm

+

Yes

+

io.cci.otc.api.pkg.apis.versioned.cci.v2.PodAffinityTerm object

+

Required. A pod affinity term, associated with the corresponding

+

weight.

+

weight

+

Yes

+

Integer

+

weight associated with matching the corresponding podAffinityTerm,

+

in the range 1-100.

+
+
+ +
+ + + + + + + + + + + + + + + + + + + + + +
Table 13 io.cci.otc.api.pkg.apis.versioned.cci.v2.PodAffinityTerm

Parameter

+

Mandatory

+

Type

+

Description

+

labelSelector

+

No

+

io.k8s.apimachinery.pkg.apis.meta.v1.LabelSelector object

+

A label query over a set of resources, in this case pods.

+

namespaces

+

No

+

Array of strings

+

namespaces specifies a static list of namespace names that the

+

term applies to. The term is applied to the union of the namespaces listed

+

in this field and the ones selected by namespaceSelector. null or empty

+

namespaces list and null namespaceSelector means "this pod's namespace".

+

topologyKey

+

Yes

+

String

+

This pod should be co-located (affinity) or not co-located (anti-affinity)

+

with the pods matching the labelSelector in the specified namespaces, where

+

co-located is defined as running on a node whose value of the label with

+

key topologyKey matches that of any node on which any of the selected pods

+

is running. Empty topologyKey is not allowed.

+
+
+ +
+ + + + + + + + + + + + + + + + + + + + + +
Table 14 io.cci.otc.api.pkg.apis.versioned.cci.v2.PodDNSConfig

Parameter

+

Mandatory

+

Type

+

Description

+

nameservers

+

No

+

Array of strings

+

A list of DNS name server IP addresses. This will be appended

+

to the base nameservers generated from DNSPolicy. Duplicated nameservers

+

will be removed.

+

options

+

No

+

Array of io.cci.otc.api.pkg.apis.versioned.cci.v2.PodDNSConfigOption objects

+

A list of DNS resolver options. This will be merged with the

+

base options generated from DNSPolicy. Duplicated entries will be removed.

+

Resolution options given in Options will override those that appear in the

+

base DNSPolicy.

+

searches

+

No

+

Array of strings

+

A list of DNS search domains for host-name lookup. This will

+

be appended to the base search paths generated from DNSPolicy. Duplicated

+

search paths will be removed.

+
+
+ +
+ + + + + + + + + + + + + + + + +
Table 15 io.cci.otc.api.pkg.apis.versioned.cci.v2.PodDNSConfigOption

Parameter

+

Mandatory

+

Type

+

Description

+

name

+

No

+

String

+

Required.

+

value

+

No

+

String

+		  
+
+ +
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Table 16 io.cci.otc.api.pkg.apis.versioned.cci.v2.EphemeralContainer

Parameter

+

Mandatory

+

Type

+

Description

+

args

+

No

+

Array of strings

+

Arguments to the entrypoint. The image's CMD is used if this is not provided. Variable references $(VAR_NAME) are expanded using the container's environment. If a variable cannot be resolved, the reference in the input string will be unchanged. Double $$ are reduced to a single $, which allows for escaping the $(VAR_NAME) syntax: i.e. "$$(VAR_NAME)" will produce the string literal "$(VAR_NAME)". Escaped references will never be expanded, regardless of whether the variable exists or not. Cannot be updated. More info: https://kubernetes.io/docs/tasks/inject-data-application/define-command-argument-container/#running-a-command-in-a-shell

+

command

+

No

+

Array of strings

+

Entrypoint array. Not executed within a shell. The image's ENTRYPOINT is used if this is not provided. Variable references $(VAR_NAME) are expanded using the container's environment. If a variable cannot be resolved, the reference in the input string will be unchanged. Double $$ are reduced to a single $, which allows for escaping the $(VAR_NAME) syntax: i.e. "$$(VAR_NAME)" will produce the string literal "$(VAR_NAME)". Escaped references will never be expanded, regardless of whether the variable exists or not. Cannot be updated. More info: https://kubernetes.io/docs/tasks/inject-data-application/define-command-argument-container/#running-a-command-in-a-shell

+

env

+

No

+

Array of io.cci.otc.api.pkg.apis.versioned.cci.v2.EnvVar objects

+

List of environment variables to set in the container. Cannot

+

be updated.

+

envFrom

+

No

+

Array of io.cci.otc.api.pkg.apis.versioned.cci.v2.EnvFromSource objects

+

List of sources to populate environment variables in the container.

+

The keys defined within a source must be a C_IDENTIFIER. All invalid keys

+

will be reported as an event when the container is starting. When a key

+

exists in multiple sources, the value associated with the last source will

+

take precedence. Values defined by an Env with a duplicate key will take

+

precedence. Cannot be updated.

+

image

+

No

+

String

+

Container image name. More info: https://kubernetes.io/docs/concepts/containers/images

+

lifecycle

+

No

+

io.cci.otc.api.pkg.apis.versioned.cci.v2.Lifecycle object

+

Lifecycle is not allowed for ephemeral containers.

+

livenessProbe

+

No

+

io.cci.otc.api.pkg.apis.versioned.cci.v2.Probe object

+

Probes are not allowed for ephemeral containers.

+

name

+

Yes

+

String

+

Name of the ephemeral container specified as a DNS_LABEL. This

+

name must be unique among all containers, init containers and ephemeral

+

containers.

+

ports

+

No

+

Array of io.cci.otc.api.pkg.apis.versioned.cci.v2.ContainerPort objects

+

Ports are not allowed for ephemeral containers.

+

readinessProbe

+

No

+

io.cci.otc.api.pkg.apis.versioned.cci.v2.Probe object

+

Probes are not allowed for ephemeral containers.

+

resources

+

No

+

io.cci.otc.api.pkg.apis.versioned.cci.v2.ResourceRequirements object

+

Resources are not allowed for ephemeral containers. Ephemeral

+

containers use spare resources already allocated to the pod.

+

securityContext

+

No

+

io.cci.otc.api.pkg.apis.versioned.cci.v2.SecurityContext object

+

Optional: SecurityContext defines the security options the ephemeral container should be run with. If set, the fields of SecurityContext override the equivalent fields of PodSecurityContext.

+

startupProbe

+

No

+

io.cci.otc.api.pkg.apis.versioned.cci.v2.Probe object

+

Probes are not allowed for ephemeral containers.

+

stdin

+

No

+

Boolean

+

Whether this container should allocate a buffer for stdin in

+

the container runtime. If this is not set, reads from stdin in the container

+

will always result in EOF. Default is false.

+

stdinOnce

+

No

+

Boolean

+

Whether the container runtime should close the stdin channel

+

after it has been opened by a single attach. When stdin is true the stdin

+

stream will remain open across multiple attach sessions. If stdinOnce is

+

set to true, stdin is opened on container start, is empty until the first

+

client attaches to stdin, and then remains open and accepts data until the

+

client disconnects, at which time stdin is closed and remains closed until

+

the container is restarted. If this flag is false, a container processes

+

that reads from stdin will never receive an EOF. Default is false

+

targetContainerName

+

No

+

String

+

If set, the name of the container from PodSpec that this ephemeral container targets. The ephemeral container will be run in the namespaces (IPC, PID, etc) of this container. If not set then the ephemeral container uses the namespaces configured in the Pod spec.

+

The container runtime must implement support for this feature. If the runtime does not support namespace targeting then the result of setting this field is undefined.

+

terminationMessagePath

+

No

+

String

+

Optional: Path at which the file to which the container's termination message will be written is mounted into the container's filesystem. Message written is intended to be brief final status, such as an assertion failure message. Will be truncated by the node if greater than 4096 bytes. The total message length across all containers will be limited to 12kb. Defaults to /dev/termination-log. Cannot be updated.

+

terminationMessagePolicy

+

No

+

String

+

Indicate how the termination message should be populated. File will use the contents of terminationMessagePath to populate the container status message on both success and failure. FallbackToLogsOnError will use the last chunk of container log output if the termination message file is empty and the container exited with an error. The log output is limited to 2048 bytes or 80 lines, whichever is smaller. Defaults to File. Cannot be updated.

+

Possible enum values:

+
  • "FallbackToLogsOnError" will read the most recent contents of the container logs for the container status message when the container exits with an error and the terminationMessagePath has no contents.
  • "File" is the default behavior and will set the container status message to the contents of the container's terminationMessagePath when the container exits.
+

tty

+

No

+

Boolean

+

Whether this container should allocate a TTY for itself, also

+

requires 'stdin' to be true. Default is false.

+

volumeMounts

+

No

+

Array of io.cci.otc.api.pkg.apis.versioned.cci.v2.VolumeMount objects

+

Pod volumes to mount into the container's filesystem. Subpath

+

mounts are not allowed for ephemeral containers. Cannot be updated.

+

workingDir

+

No

+

String

+

Container's working directory. If not specified, the container

+

runtime's default will be used, which might be configured in the container

+

image. Cannot be updated.

+
+
+ +
+ + + + + + + + + + + + + + + + +
Table 17 io.cci.otc.api.pkg.apis.versioned.cci.v2.HostAlias

Parameter

+

Mandatory

+

Type

+

Description

+

hostnames

+

No

+

Array of strings

+

Hostnames for the above IP address.

+

ip

+

No

+

String

+

IP address of the host file entry.

+
+
+ +
+ + + + + + + + + + + +
Table 18 io.cci.otc.api.pkg.apis.versioned.cci.v2.LocalObjectReference

Parameter

+

Mandatory

+

Type

+

Description

+

name

+

No

+

String

+

Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names

+
+
+ +
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Table 19 io.cci.otc.api.pkg.apis.versioned.cci.v2.Container

Parameter

+

Mandatory

+

Type

+

Description

+

args

+

No

+

Array of strings

+

Arguments to the entrypoint. The container image's CMD is used if this is not provided. Variable references $(VAR_NAME) are expanded using the container's environment. If a variable cannot be resolved, the reference in the input string will be unchanged. Double $$ are reduced to a single $, which allows for escaping the $(VAR_NAME) syntax: i.e. "$$(VAR_NAME)" will produce the string literal "$(VAR_NAME)". Escaped references will never be expanded, regardless of whether the variable exists or not. Cannot be updated. More info: https://kubernetes.io/docs/tasks/inject-data-application/define-command-argument-container/#running-a-command-in-a-shell

+

command

+

No

+

Array of strings

+

Entrypoint array. Not executed within a shell. The container image's ENTRYPOINT is used if this is not provided. Variable references $(VAR_NAME) are expanded using the container's environment. If a variable cannot be resolved, the reference in the input string will be unchanged. Double $$ are reduced to a single $, which allows for escaping the $(VAR_NAME) syntax: i.e. "$$(VAR_NAME)" will produce the string literal "$(VAR_NAME)". Escaped references will never be expanded, regardless of whether the variable exists or not. Cannot be updated. More info: https://kubernetes.io/docs/tasks/inject-data-application/define-command-argument-container/#running-a-command-in-a-shell

+

env

+

No

+

Array of io.cci.otc.api.pkg.apis.versioned.cci.v2.EnvVar objects

+

List of environment variables to set in the container. Cannot

+

be updated.

+

envFrom

+

No

+

Array of io.cci.otc.api.pkg.apis.versioned.cci.v2.EnvFromSource objects

+

List of sources to populate environment variables in the container.

+

The keys defined within a source must be a C_IDENTIFIER. All invalid keys

+

will be reported as an event when the container is starting. When a key

+

exists in multiple sources, the value associated with the last source will

+

take precedence. Values defined by an Env with a duplicate key will take

+

precedence. Cannot be updated.

+

image

+

No

+

String

+

Container image name. More info: https://kubernetes.io/docs/concepts/containers/images This field is optional to allow higher level config management to default or override container images in workload controllers like Deployments and StatefulSets.

+

lifecycle

+

No

+

io.cci.otc.api.pkg.apis.versioned.cci.v2.Lifecycle object

+

Actions that the management system should take in response to

+

container lifecycle events. Cannot be updated.

+

livenessProbe

+

No

+

io.cci.otc.api.pkg.apis.versioned.cci.v2.Probe object

+

Periodic probe of container liveness. Container will be restarted if the probe fails. Cannot be updated. More info: https://kubernetes.io/docs/concepts/workloads/pods/pod-lifecycle#container-probes

+

name

+

Yes

+

String

+

Name of the container specified as a DNS_LABEL. Each container

+

in a pod must have a unique name (DNS_LABEL). Cannot be updated.

+

ports

+

No

+

Array of io.cci.otc.api.pkg.apis.versioned.cci.v2.ContainerPort objects

+

List of ports to expose from the container. Not specifying a

+

port here DOES NOT prevent that port from being exposed. Any port which

+

is listening on the default "0.0.0.0" address inside a container will be

+

accessible from the network. Modifying this array with strategic merge patch

+

may corrupt the data. For more information See https://github.com/kubernetes/kubernetes/issues/108255.

+

Cannot be updated.

+

readinessProbe

+

No

+

io.cci.otc.api.pkg.apis.versioned.cci.v2.Probe object

+

Periodic probe of container service readiness. Container will be removed from service endpoints if the probe fails. Cannot be updated. More info: https://kubernetes.io/docs/concepts/workloads/pods/pod-lifecycle#container-probes

+

resources

+

No

+

io.cci.otc.api.pkg.apis.versioned.cci.v2.ResourceRequirements object

+

Compute Resources required by this container. Cannot be updated. More info: https://kubernetes.io/docs/concepts/configuration/manage-resources-containers/

+

securityContext

+

No

+

io.cci.otc.api.pkg.apis.versioned.cci.v2.SecurityContext object

+

SecurityContext defines the security options the container should be run with. If set, the fields of SecurityContext override the equivalent fields of PodSecurityContext. More info: https://kubernetes.io/docs/tasks/configure-pod-container/security-context/

+

startupProbe

+

No

+

io.cci.otc.api.pkg.apis.versioned.cci.v2.Probe object

+

StartupProbe indicates that the Pod has successfully initialized. If specified, no other probes are executed until this completes successfully. If this probe fails, the Pod will be restarted, just as if the livenessProbe failed. This can be used to provide different probe parameters at the beginning of a Pod's lifecycle, when it might take a long time to load data or warm a cache, than during steady-state operation. This cannot be updated. More info: https://kubernetes.io/docs/concepts/workloads/pods/pod-lifecycle#container-probes

+

stdin

+

No

+

Boolean

+

Whether this container should allocate a buffer for stdin in

+

the container runtime. If this is not set, reads from stdin in the container

+

will always result in EOF. Default is false.

+

stdinOnce

+

No

+

Boolean

+

Whether the container runtime should close the stdin channel

+

after it has been opened by a single attach. When stdin is true the stdin

+

stream will remain open across multiple attach sessions. If stdinOnce is

+

set to true, stdin is opened on container start, is empty until the first

+

client attaches to stdin, and then remains open and accepts data until the

+

client disconnects, at which time stdin is closed and remains closed until

+

the container is restarted. If this flag is false, a container processes

+

that reads from stdin will never receive an EOF. Default is false

+

terminationMessagePath

+

No

+

String

+

Optional: Path at which the file to which the container's termination message will be written is mounted into the container's filesystem. Message written is intended to be brief final status, such as an assertion failure message. Will be truncated by the node if greater than 4096 bytes. The total message length across all containers will be limited to 12kb. Defaults to /dev/termination-log. Cannot be updated.

+

terminationMessagePolicy

+

No

+

String

+

Indicate how the termination message should be populated. File will use the contents of terminationMessagePath to populate the container status message on both success and failure. FallbackToLogsOnError will use the last chunk of container log output if the termination message file is empty and the container exited with an error. The log output is limited to 2048 bytes or 80 lines, whichever is smaller. Defaults to File. Cannot be updated.

+

Possible enum values:

+
  • "FallbackToLogsOnError" will read the most recent contents of the container logs for the container status message when the container exits with an error and the terminationMessagePath has no contents.
  • "File" is the default behavior and will set the container status message to the contents of the container's terminationMessagePath when the container exits.
+

tty

+

No

+

Boolean

+

Whether this container should allocate a TTY for itself, also

+

requires 'stdin' to be true. Default is false.

+

volumeMounts

+

No

+

Array of io.cci.otc.api.pkg.apis.versioned.cci.v2.VolumeMount objects

+

Pod volumes to mount into the container's filesystem. Cannot

+

be updated.

+

workingDir

+

No

+

String

+

Container's working directory. If not specified, the container

+

runtime's default will be used, which might be configured in the container

+

image. Cannot be updated.

+
+
+ +
+ + + + + + + + + + + + + + + + + + + + + +
Table 20 io.cci.otc.api.pkg.apis.versioned.cci.v2.EnvVar

Parameter

+

Mandatory

+

Type

+

Description

+

name

+

Yes

+

String

+

Name of the environment variable. Must be a C_IDENTIFIER.

+

value

+

No

+

String

+

Variable references $(VAR_NAME) are expanded using the previously defined environment variables in the container and any service environment variables. If a variable cannot be resolved, the reference in the input string will be unchanged. Double $$ are reduced to a single $, which allows for escaping the $(VAR_NAME) syntax: i.e. "$$(VAR_NAME)" will produce the string literal "$(VAR_NAME)". Escaped references will never be expanded, regardless of whether the variable exists or not. Defaults to "".

+

valueFrom

+

No

+

io.cci.otc.api.pkg.apis.versioned.cci.v2.EnvVarSource object

+

Source for the environment variable's value. Cannot be used if

+

value is not empty.

+
+
+ +
+ + + + + + + + + + + + + + + + + + + + + + + + + + +
Table 21 io.cci.otc.api.pkg.apis.versioned.cci.v2.EnvVarSource

Parameter

+

Mandatory

+

Type

+

Description

+

configMapKeyRef

+

No

+

io.cci.otc.api.pkg.apis.versioned.cci.v2.ConfigMapKeySelector object

+

Selects a key of a ConfigMap.

+

fieldRef

+

No

+

io.cci.otc.api.pkg.apis.versioned.cci.v2.ObjectFieldSelector object

+

Selects a field of the pod: supports metadata.name, metadata.namespace, metadata.labels['<KEY>'], metadata.annotations['<KEY>'], spec.nodeName, spec.serviceAccountName, status.hostIP, status.podIP, status.podIPs.

+

resourceFieldRef

+

No

+

io.cci.otc.api.pkg.apis.versioned.cci.v2.ResourceFieldSelector object

+

Selects a resource of the container: only resources limits and requests (limits.cpu, limits.memory, limits.ephemeral-storage, requests.cpu, requests.memory and requests.ephemeral-storage) are currently supported.

+

secretKeyRef

+

No

+

io.cci.otc.api.pkg.apis.versioned.cci.v2.SecretKeySelector object

+

Selects a key of a secret in the pod's namespace

+
+
+ +
+ + + + + + + + + + + + + + + + + + + + + +
Table 22 io.cci.otc.api.pkg.apis.versioned.cci.v2.ConfigMapKeySelector

Parameter

+

Mandatory

+

Type

+

Description

+

key

+

Yes

+

String

+

The key to select.

+

name

+

No

+

String

+

Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names

+

optional

+

No

+

Boolean

+

Specify whether the ConfigMap or its key must be defined

+
+
+ +
+ + + + + + + + + + + + + + + + + + + + + +
Table 23 io.cci.otc.api.pkg.apis.versioned.cci.v2.SecretKeySelector

Parameter

+

Mandatory

+

Type

+

Description

+

key

+

Yes

+

String

+

The key of the secret to select from. Must be a valid secret

+

key.

+

name

+

No

+

String

+

Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names

+

optional

+

No

+

Boolean

+

Specify whether the Secret or its key must be defined

+
+
+ +
+ + + + + + + + + + + + + + + + + + + + + +
Table 24 io.cci.otc.api.pkg.apis.versioned.cci.v2.EnvFromSource

Parameter

+

Mandatory

+

Type

+

Description

+

configMapRef

+

No

+

io.cci.otc.api.pkg.apis.versioned.cci.v2.ConfigMapEnvSource object

+

The ConfigMap to select from

+

prefix

+

No

+

String

+

An optional identifier to prepend to each key in the ConfigMap.

+

Must be a C_IDENTIFIER.

+

secretRef

+

No

+

io.cci.otc.api.pkg.apis.versioned.cci.v2.SecretEnvSource object

+

The Secret to select from

+
+
+ +
+ + + + + + + + + + + + + + + + +
Table 25 io.cci.otc.api.pkg.apis.versioned.cci.v2.ConfigMapEnvSource

Parameter

+

Mandatory

+

Type

+

Description

+

name

+

No

+

String

+

Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names

+

optional

+

No

+

Boolean

+

Specify whether the ConfigMap must be defined

+
+
+ +
+ + + + + + + + + + + + + + + + +
Table 26 io.cci.otc.api.pkg.apis.versioned.cci.v2.SecretEnvSource

Parameter

+

Mandatory

+

Type

+

Description

+

name

+

No

+

String

+

Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names

+

optional

+

No

+

Boolean

+

Specify whether the Secret must be defined

+
+
+ +
+ + + + + + + + + + + + + + + + +
Table 27 io.cci.otc.api.pkg.apis.versioned.cci.v2.Lifecycle

Parameter

+

Mandatory

+

Type

+

Description

+

postStart

+

No

+

io.cci.otc.api.pkg.apis.versioned.cci.v2.LifecycleHandler object

+

PostStart is called immediately after a container is created. If the handler fails, the container is terminated and restarted according to its restart policy. Other management of the container blocks until the hook completes. More info: https://kubernetes.io/docs/concepts/containers/container-lifecycle-hooks/#container-hooks

+

preStop

+

No

+

io.cci.otc.api.pkg.apis.versioned.cci.v2.LifecycleHandler object

+

PreStop is called immediately before a container is terminated due to an API request or management event such as liveness/startup probe failure, preemption, resource contention, etc. The handler is not called if the container crashes or exits. The Pod's termination grace period countdown begins before the PreStop hook is executed. Regardless of the outcome of the handler, the container will eventually terminate within the Pod's termination grace period (unless delayed by finalizers). Other management of the container blocks until the hook completes or until the termination grace period is reached. More info: https://kubernetes.io/docs/concepts/containers/container-lifecycle-hooks/#container-hooks

+
+
+ +
+ + + + + + + + + + + + + + + + +
Table 28 io.cci.otc.api.pkg.apis.versioned.cci.v2.LifecycleHandler

Parameter

+

Mandatory

+

Type

+

Description

+

exec

+

No

+

io.cci.otc.api.pkg.apis.versioned.cci.v2.ExecAction object

+

Exec specifies the action to take.

+

httpGet

+

No

+

io.cci.otc.api.pkg.apis.versioned.cci.v2.HTTPGetAction object

+

HTTPGet specifies the http request to perform.

+
+
+ +
+ + + + + + + + + + + + + + + + + + + + + +
Table 29 io.cci.otc.api.pkg.apis.versioned.cci.v2.ContainerPort

Parameter

+

Mandatory

+

Type

+

Description

+

containerPort

+

Yes

+

Integer

+

Number of port to expose on the pod's IP address. This must be

+

a valid port number, 0 < x < 65536.

+

name

+

No

+

String

+

If specified, this must be an IANA_SVC_NAME and unique within

+

the pod. Each named port in a pod must have a unique name. Name for the

+

port that can be referred to by services.

+

protocol

+

No

+

String

+

Protocol for port. Must be UDP, TCP, or SCTP. Defaults to "TCP".

+

Possible enum values:

+
  • "SCTP" is the SCTP protocol.
  • "TCP" is the TCP protocol.
  • "UDP" is the UDP protocol.
+
+
+ +
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Table 30 io.cci.otc.api.pkg.apis.versioned.cci.v2.SecurityContext

Parameter

+

Mandatory

+

Type

+

Description

+

capabilities

+

No

+

io.cci.otc.api.pkg.apis.versioned.cci.v2.Capabilities object

+

The capabilities to add/drop when running containers. Defaults

+

to the default set of capabilities granted by the container runtime. Note

+

that this field cannot be set when spec.os.name is windows.

+

procMount

+

No

+

String

+

procMount denotes the type of proc mount to use for the containers.

+

The default is DefaultProcMount which uses the container runtime defaults

+

for readonly paths and masked paths. This requires the ProcMountType feature

+

flag to be enabled. Note that this field cannot be set when spec.os.name

+

is windows.

+

readOnlyRootFilesystem

+

No

+

Boolean

+

Whether this container has a read-only root filesystem. Default

+

is false. Note that this field cannot be set when spec.os.name is windows.

+

runAsGroup

+

No

+

Long

+

The GID to run the entrypoint of the container process. Uses

+

runtime default if unset. May also be set in PodSecurityContext. If set

+

in both SecurityContext and PodSecurityContext, the value specified in SecurityContext

+

takes precedence. Note that this field cannot be set when spec.os.name is

+

windows.

+

runAsNonRoot

+

No

+

Boolean

+

Indicates that the container must run as a non-root user. If

+

true, the Kubelet will validate the image at runtime to ensure that it does

+

not run as UID 0 (root) and fail to start the container if it does. If unset

+

or false, no such validation will be performed. May also be set in PodSecurityContext. If

+

set in both SecurityContext and PodSecurityContext, the value specified

+

in SecurityContext takes precedence.

+

runAsUser

+

No

+

Long

+

The UID to run the entrypoint of the container process. Defaults

+

to user specified in image metadata if unspecified. May also be set in PodSecurityContext. If

+

set in both SecurityContext and PodSecurityContext, the value specified

+

in SecurityContext takes precedence. Note that this field cannot be set

+

when spec.os.name is windows.

+
+
+ +
+ + + + + + + + + + + + + + + + +
Table 31 io.cci.otc.api.pkg.apis.versioned.cci.v2.Capabilities

Parameter

+

Mandatory

+

Type

+

Description

+

add

+

No

+

Array of strings

+

Added capabilities

+

drop

+

No

+

Array of strings

+

Removed capabilities

+
+
+ +
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Table 32 io.cci.otc.api.pkg.apis.versioned.cci.v2.Probe

Parameter

+

Mandatory

+

Type

+

Description

+

exec

+

No

+

io.cci.otc.api.pkg.apis.versioned.cci.v2.ExecAction object

+

Exec specifies the action to take.

+

failureThreshold

+

No

+

Integer

+

Minimum consecutive failures for the probe to be considered failed

+

after having succeeded. Defaults to 3. Minimum value is 1.

+

httpGet

+

No

+

io.cci.otc.api.pkg.apis.versioned.cci.v2.HTTPGetAction object

+

HTTPGet specifies the http request to perform.

+

initialDelaySeconds

+

No

+

Integer

+

Number of seconds after the container has started before liveness probes are initiated. More info: https://kubernetes.io/docs/concepts/workloads/pods/pod-lifecycle#container-probes

+

periodSeconds

+

No

+

Integer

+

How often (in seconds) to perform the probe. Default to 10 seconds.

+

Minimum value is 1.

+

successThreshold

+

No

+

Integer

+

Minimum consecutive successes for the probe to be considered

+

successful after having failed. Defaults to 1. Must be 1 for liveness and

+

startup. Minimum value is 1.

+

tcpSocket

+

No

+

io.cci.otc.api.pkg.apis.versioned.cci.v2.TCPSocketAction object

+

TCPSocket specifies an action involving a TCP port.

+

terminationGracePeriodSeconds

+

No

+

Long

+

Optional duration in seconds the pod needs to terminate gracefully

+

upon probe failure. The grace period is the duration in seconds after the

+

processes running in the pod are sent a termination signal and the time

+

when the processes are forcibly halted with a kill signal. Set this value

+

longer than the expected cleanup time for your process. If this value is

+

nil, the pod's terminationGracePeriodSeconds will be used. Otherwise, this

+

value overrides the value provided by the pod spec. Value must be non-negative

+

integer. The value zero indicates stop immediately via the kill signal (no

+

opportunity to shut down). This is a beta field and requires enabling ProbeTerminationGracePeriod

+

feature gate. Minimum value is 1. spec.terminationGracePeriodSeconds is

+

used if unset.

+

timeoutSeconds

+

No

+

Integer

+

Number of seconds after which the probe times out. Defaults to 1 second. Minimum value is 1. More info: https://kubernetes.io/docs/concepts/workloads/pods/pod-lifecycle#container-probes

+
+
+ +
+ + + + + + + + + + + +
Table 33 io.cci.otc.api.pkg.apis.versioned.cci.v2.ExecAction

Parameter

+

Mandatory

+

Type

+

Description

+

command

+

No

+

Array of strings

+

Command is the command line to execute inside the container,

+

the working directory for the command is root ('/') in the container's

+

filesystem. The command is simply exec'd, it is not run inside a shell,

+

so traditional shell instructions ('|', etc) won't work. To use a shell,

+

you need to explicitly call out to that shell. Exit status of 0 is treated

+

as live/healthy and non-zero is unhealthy.

+
+
+ +
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Table 34 io.cci.otc.api.pkg.apis.versioned.cci.v2.HTTPGetAction

Parameter

+

Mandatory

+

Type

+

Description

+

host

+

No

+

String

+

Host name to connect to, defaults to the pod IP. You probably

+

want to set "Host" in httpHeaders instead.

+

httpHeaders

+

No

+

Array of io.cci.otc.api.pkg.apis.versioned.cci.v2.HTTPHeader objects

+

Custom headers to set in the request. HTTP allows repeated headers.

+

path

+

No

+

String

+

Path to access on the HTTP server.

+

port

+

Yes

+

String

+

Name or number of the port to access on the container. Number

+

must be in the range 1 to 65535. Name must be an IANA_SVC_NAME.

+

scheme

+

No

+

String

+

Scheme to use for connecting to the host. Defaults to HTTP.

+

Possible enum values:

+
  • "HTTP" means that the scheme used will be http://
  • "HTTPS" means that the scheme used will be https://
+
+
+ +
+ + + + + + + + + + + + + + + + +
Table 35 io.cci.otc.api.pkg.apis.versioned.cci.v2.HTTPHeader

Parameter

+

Mandatory

+

Type

+

Description

+

name

+

Yes

+

String

+

The header field name

+

value

+

Yes

+

String

+

The header field value

+
+
+ +
+ + + + + + + + + + + + + + + + +
Table 36 io.cci.otc.api.pkg.apis.versioned.cci.v2.TCPSocketAction

Parameter

+

Mandatory

+

Type

+

Description

+

host

+

No

+

String

+

Optional: Host name to connect to, defaults to the pod IP.

+

port

+

Yes

+

String

+

Number or name of the port to access on the container. Number

+

must be in the range 1 to 65535. Name must be an IANA_SVC_NAME.

+
+
+ +
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Table 37 io.cci.otc.api.pkg.apis.versioned.cci.v2.VolumeMount

Parameter

+

Mandatory

+

Type

+

Description

+

extendPathMode

+

No

+

String

+

Extend the volume path by appending the pod metadata to the path

+

according to specified pattern. which provide a way of directory isolation

+

and help prevent the writing conflict between different pods.

+

mountPath

+

Yes

+

String

+

Path within the container at which the volume should be mounted. Must

+

not contain ':'.

+

name

+

Yes

+

String

+

This must match the Name of a Volume.

+

readOnly

+

No

+

Boolean

+

Mounted read-only if true, read-write otherwise (false or unspecified).

+

Defaults to false.

+

subPath

+

No

+

String

+

Path within the volume from which the container's volume should

+

be mounted. Defaults to "" (volume's root).

+

subPathExpr

+

No

+

String

+

Expanded path within the volume from which the container's volume

+

should be mounted. Behaves similarly to SubPath but environment variable

+

references $(VAR_NAME) are expanded using the container's environment. Defaults

+

to "" (volume's root). SubPathExpr and SubPath are mutually exclusive.

+
+
+ +
+ + + + + + + + + + + +
Table 38 io.cci.otc.api.pkg.apis.versioned.cci.v2.PodReadinessGate

Parameter

+

Mandatory

+

Type

+

Description

+

conditionType

+

Yes

+

String

+

ConditionType refers to a condition in the pod's condition list

+

with matching type.

+
+
+ +
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Table 39 io.cci.otc.api.pkg.apis.versioned.cci.v2.PodSecurityContext

Parameter

+

Mandatory

+

Type

+

Description

+

fsGroup

+

No

+

Long

+

A special supplemental group that applies to all containers in a pod. Some volume types allow the Kubelet to change the ownership of that volume to be owned by the pod:

+
  1. The owning GID will be the FSGroup 2. The setgid bit is set (new files created in the volume will be owned by FSGroup) 3. The permission bits are OR'd with rw-rw----
+

If unset, the Kubelet will not modify the ownership and permissions of any volume. Note that this field cannot be set when spec.os.name is windows.

+

fsGroupChangePolicy

+

No

+

String

+

fsGroupChangePolicy defines behavior of changing ownership and permission of the volume before being exposed inside Pod. This field will only apply to volume types which support fsGroup based ownership(and permissions). It will have no effect on ephemeral volume types such as: secret, configmaps and emptydir. Valid values are "OnRootMismatch" and "Always". If not specified, "Always" is used. Note that this field cannot be set when spec.os.name is windows.

+

runAsGroup

+

No

+

Long

+

The GID to run the entrypoint of the container process. Uses

+

runtime default if unset. May also be set in SecurityContext. If set in

+

both SecurityContext and PodSecurityContext, the value specified in SecurityContext

+

takes precedence for that container. Note that this field cannot be set

+

when spec.os.name is windows.

+

runAsNonRoot

+

No

+

Boolean

+

Indicates that the container must run as a non-root user. If

+

true, the Kubelet will validate the image at runtime to ensure that it does

+

not run as UID 0 (root) and fail to start the container if it does. If unset

+

or false, no such validation will be performed. May also be set in SecurityContext. If

+

set in both SecurityContext and PodSecurityContext, the value specified

+

in SecurityContext takes precedence.

+

runAsUser

+

No

+

Long

+

The UID to run the entrypoint of the container process. Defaults

+

to user specified in image metadata if unspecified. May also be set in SecurityContext. If

+

set in both SecurityContext and PodSecurityContext, the value specified

+

in SecurityContext takes precedence for that container. Note that this field

+

cannot be set when spec.os.name is windows.

+

supplementalGroups

+

No

+

Array of longs

+

A list of groups applied to the first process run in each container,

+

in addition to the container's primary GID. If unspecified, no groups will

+

be added to any container. Note that this field cannot be set when spec.os.name

+

is windows.

+

sysctls

+

No

+

Array of io.cci.otc.api.pkg.apis.versioned.cci.v2.Sysctl objects

+

Sysctls hold a list of namespaced sysctls used for the pod. Pods

+

with unsupported sysctls (by the container runtime) might fail to launch.

+

Note that this field cannot be set when spec.os.name is windows.

+
+
+ +
+ + + + + + + + + + + + + + + + +
Table 40 io.cci.otc.api.pkg.apis.versioned.cci.v2.Sysctl

Parameter

+

Mandatory

+

Type

+

Description

+

name

+

Yes

+

String

+

Name of a property to set

+

value

+

Yes

+

String

+

Value of a property to set

+
+
+ +
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Table 41 io.cci.otc.api.pkg.apis.versioned.cci.v2.TopologySpreadConstraint

Parameter

+

Mandatory

+

Type

+

Description

+

labelSelector

+

No

+

io.k8s.apimachinery.pkg.apis.meta.v1.LabelSelector object

+

LabelSelector is used to find matching pods. Pods that match

+

this label selector are counted to determine the number of pods in their

+

corresponding topology domain.

+

matchLabelKeys

+

No

+

Array of strings

+

MatchLabelKeys is a set of pod label keys to select the pods

+

over which spreading will be calculated. The keys are used to lookup values

+

from the incoming pod labels, those key-value labels are ANDed with labelSelector

+

to select the group of existing pods over which spreading will be calculated

+

for the incoming pod. Keys that don't exist in the incoming pod labels will

+

be ignored. A null or empty list means only match against labelSelector.

+

maxSkew

+

Yes

+

Integer

+

MaxSkew describes the degree to which pods may be unevenly distributed. When whenUnsatisfiable=DoNotSchedule, it is the maximum permitted difference between the number of matching pods in the target topology and the global minimum. The global minimum is the minimum number of matching pods in an eligible domain or zero if the number of eligible domains is less than MinDomains. For example, in a 3-zone cluster, MaxSkew is set to 1, and pods with the same labelSelector spread as 2/2/1: In this case, the global minimum is 1. | zone1 | zone2 | zone3 | | P P | P P | P | - if MaxSkew is 1, incoming pod can only be scheduled to zone3 to become 2/2/2; scheduling it onto zone1(zone2) would make the ActualSkew(3-1) on zone1(zone2) violate MaxSkew(1). - if MaxSkew is 2, incoming pod can be scheduled onto any zone. When whenUnsatisfiable=ScheduleAnyway, it is used to give higher precedence to topologies that satisfy it. It's a required field. Default value is 1 and 0 is not allowed.

+

minDomains

+

No

+

Integer

+

MinDomains indicates a minimum number of eligible domains. When the number of eligible domains with matching topology keys is less than minDomains, Pod Topology Spread treats "global minimum" as 0, and then the calculation of Skew is performed. And when the number of eligible domains with matching topology keys equals or greater than minDomains, this value has no effect on scheduling. As a result, when the number of eligible domains is less than minDomains, scheduler won't schedule more than maxSkew Pods to those domains. If value is nil, the constraint behaves as if MinDomains is equal to 1. Valid values are integers greater than 0. When value is not nil, WhenUnsatisfiable must be DoNotSchedule.

+

For example, in a 3-zone cluster, MaxSkew is set to 2, MinDomains is set to 5 and pods with the same labelSelector spread as 2/2/2: | zone1 | zone2 | zone3 | | P P | P P | P P | The number of domains is less than 5(MinDomains), so "global minimum" is treated as 0. In this situation, new pod with the same labelSelector cannot be scheduled, because computed skew will be 3(3 - 0) if new Pod is scheduled to any of the three zones, it will violate MaxSkew.

+

This is a beta field and requires the MinDomainsInPodTopologySpread feature gate to be enabled (enabled by default).

+

nodeAffinityPolicy

+

No

+

String

+

NodeAffinityPolicy indicates how we will treat Pod's nodeAffinity/nodeSelector when calculating pod topology spread skew. Options are: - Honor: only nodes matching nodeAffinity/nodeSelector are included in the calculations. - Ignore: nodeAffinity/nodeSelector are ignored. All nodes are included in the calculations.

+

If this value is nil, the behavior is equivalent to the Honor policy. This is a alpha-level feature enabled by the NodeInclusionPolicyInPodTopologySpread feature flag.

+

nodeTaintsPolicy

+

No

+

String

+

NodeTaintsPolicy indicates how we will treat node taints when calculating pod topology spread skew. Options are: - Honor: nodes without taints, along with tainted nodes for which the incoming pod has a toleration, are included. - Ignore: node taints are ignored. All nodes are included.

+

If this value is nil, the behavior is equivalent to the Ignore policy. This is a alpha-level feature enabled by the NodeInclusionPolicyInPodTopologySpread feature flag.

+

topologyKey

+

Yes

+

String

+

TopologyKey is the key of node labels. Nodes that have a label

+

with this key and identical values are considered to be in the same topology.

+

We consider each <key, value> as a "bucket", and try to put balanced number

+

of pods into each bucket. We define a domain as a particular instance of

+

a topology. Also, we define an eligible domain as a domain whose nodes meet

+

the requirements of nodeAffinityPolicy and nodeTaintsPolicy. e.g. If TopologyKey

+

is "kubernetes.io/hostname", each Node is a domain of that topology. And,

+

if TopologyKey is "topology.kubernetes.io/zone", each zone is a domain of

+

that topology. It's a required field.

+

whenUnsatisfiable

+

Yes

+

String

+

WhenUnsatisfiable indicates how to deal with a pod if it doesn't satisfy the spread constraint. - DoNotSchedule (default) tells the scheduler not to schedule it. - ScheduleAnyway tells the scheduler to schedule the pod in any location,

+

but giving higher precedence to topologies that would help reduce the

+

skew.

+

A constraint is considered "Unsatisfiable" for an incoming pod if and only if every possible node assignment for that pod would violate "MaxSkew" on some topology. For example, in a 3-zone cluster, MaxSkew is set to 1, and pods with the same labelSelector spread as 3/1/1: | zone1 | zone2 | zone3 | | P P P | P | P | If WhenUnsatisfiable is set to DoNotSchedule, incoming pod can only be scheduled to zone2(zone3) to become 3/2/1(3/1/2) as ActualSkew(2-1) on zone2(zone3) satisfies MaxSkew(1). In other words, the cluster can still be imbalanced, but scheduler won't make it more imbalanced. It's a required field.

+

Possible enum values:

+
  • "DoNotSchedule" instructs the scheduler not to schedule the pod when constraints are not satisfied.
  • "ScheduleAnyway" instructs the scheduler to schedule the pod even if constraints are not satisfied.
+
+
+ +
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Table 42 io.cci.otc.api.pkg.apis.versioned.cci.v2.Volume

Parameter

+

Mandatory

+

Type

+

Description

+

configMap

+

No

+

io.cci.otc.api.pkg.apis.versioned.cci.v2.ConfigMapVolumeSource object

+

configMap represents a configMap that should populate this volume

+

downwardAPI

+

No

+

io.cci.otc.api.pkg.apis.versioned.cci.v2.DownwardAPIVolumeSource object

+

downwardAPI represents downward API about the pod that should

+

populate this volume

+

emptyDir

+

No

+

io.cci.otc.api.pkg.apis.versioned.cci.v2.EmptyDirVolumeSource object

+

emptyDir represents a temporary directory that shares a pod's lifetime. More info: https://kubernetes.io/docs/concepts/storage/volumes#emptydir

+

ephemeral

+

No

+

io.cci.otc.api.pkg.apis.versioned.cci.v2.EphemeralVolumeSource object

+

ephemeral represents a volume that is handled by a cluster storage driver. The volume's lifecycle is tied to the pod that defines it - it will be created before the pod starts, and deleted when the pod is removed.

+

Use this if: a) the volume is only needed while the pod runs, b) features of normal volumes like restoring from snapshot or capacity

+

tracking are needed,

+

c) the storage driver is specified through a storage class, and d) the storage driver supports dynamic volume provisioning through

+

a PersistentVolumeClaim (see EphemeralVolumeSource for more

+

information on the connection between this volume type

+

and PersistentVolumeClaim).

+

Use PersistentVolumeClaim or one of the vendor-specific APIs for volumes that persist for longer than the lifecycle of an individual pod.

+

Use CSI for light-weight local ephemeral volumes if the CSI driver is meant to be used that way - see the documentation of the driver for more information.

+

A pod can use both types of ephemeral volumes and persistent volumes at the same time.

+

name

+

Yes

+

String

+

name of the volume. Must be a DNS_LABEL and unique within the pod. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names

+

nfs

+

No

+

io.cci.otc.api.pkg.apis.versioned.cci.v2.NFSVolumeSource object

+

nfs represents an NFS mount on the host that shares a pod's lifetime More info: https://kubernetes.io/docs/concepts/storage/volumes#nfs

+

persistentVolumeClaim

+

No

+

io.cci.otc.api.pkg.apis.versioned.cci.v2.PersistentVolumeClaimVolumeSource object

+

persistentVolumeClaimVolumeSource represents a reference to a PersistentVolumeClaim in the same namespace. More info: https://kubernetes.io/docs/concepts/storage/persistent-volumes#persistentvolumeclaims

+

projected

+

No

+

io.cci.otc.api.pkg.apis.versioned.cci.v2.ProjectedVolumeSource object

+

projected items for all in one resources secrets, configmaps,

+

and downward API

+

secret

+

No

+

io.cci.otc.api.pkg.apis.versioned.cci.v2.SecretVolumeSource object

+

secret represents a secret that should populate this volume. More info: https://kubernetes.io/docs/concepts/storage/volumes#secret

+
+
+ +
+ + + + + + + + + + + + + + + + + + + + + + + + + + +
Table 43 io.cci.otc.api.pkg.apis.versioned.cci.v2.ConfigMapVolumeSource

Parameter

+

Mandatory

+

Type

+

Description

+

defaultMode

+

No

+

Integer

+

defaultMode is optional: mode bits used to set permissions on created files by default. Must be an octal value between 0000 and 0777 or a decimal value between 0 and 511. YAML accepts both octal and decimal values, JSON requires decimal values for mode bits. Defaults to 0644. Directories within the path are not affected by this setting. This might be in conflict with other options that affect the file mode, like fsGroup, and the result can be other mode bits set.

+

items

+

No

+

Array of io.cci.otc.api.pkg.apis.versioned.cci.v2.KeyToPath objects

+

items if unspecified, each key-value pair in the Data field of

+

the referenced ConfigMap will be projected into the volume as a file whose

+

name is the key and content is the value. If specified, the listed keys

+

will be projected into the specified paths, and unlisted keys will not be

+

present. If a key is specified which is not present in the ConfigMap, the

+

volume setup will error unless it is marked optional. Paths must be relative

+

and may not contain the '..' path or start with '..'.

+

name

+

No

+

String

+

Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names

+

optional

+

No

+

Boolean

+

optional specify whether the ConfigMap or its keys must be defined

+
+
+ +
+ + + + + + + + + + + + + + + + +
Table 44 io.cci.otc.api.pkg.apis.versioned.cci.v2.DownwardAPIVolumeSource

Parameter

+

Mandatory

+

Type

+

Description

+

defaultMode

+

No

+

Integer

+

Optional: mode bits to use on created files by default. Must be a Optional: mode bits used to set permissions on created files by default. Must be an octal value between 0000 and 0777 or a decimal value between 0 and 511. YAML accepts both octal and decimal values, JSON requires decimal values for mode bits. Defaults to 0644. Directories within the path are not affected by this setting. This might be in conflict with other options that affect the file mode, like fsGroup, and the result can be other mode bits set.

+

items

+

No

+

Array of io.cci.otc.api.pkg.apis.versioned.cci.v2.DownwardAPIVolumeFile objects

+

Items is a list of downward API volume file

+
+
+ +
+ + + + + + + + + + + + + + + + +
Table 45 io.cci.otc.api.pkg.apis.versioned.cci.v2.EmptyDirVolumeSource

Parameter

+

Mandatory

+

Type

+

Description

+

medium

+

No

+

String

+

medium represents what type of storage medium should back this directory. The default is "" which means to use the node's default medium. Must be an empty string (default) or Memory. More info: https://kubernetes.io/docs/concepts/storage/volumes#emptydir

+

sizeLimit

+

No

+

String

+

sizeLimit is the total amount of local storage required for this EmptyDir volume. The size limit is also applicable for memory medium. The maximum usage on memory medium EmptyDir would be the minimum value between the SizeLimit specified here and the sum of memory limits of all containers in a pod. The default is nil which means that the limit is undefined. More info: http://kubernetes.io/docs/user-guide/volumes#emptydir

+
+
+ +
+ + + + + + + + + + + +
Table 46 io.cci.otc.api.pkg.apis.versioned.cci.v2.EphemeralVolumeSource

Parameter

+

Mandatory

+

Type

+

Description

+

volumeClaimTemplate

+

No

+

io.cci.otc.api.pkg.apis.versioned.cci.v2.PersistentVolumeClaimTemplate object

+

Will be used to create a stand-alone PVC to provision the volume. The pod in which this EphemeralVolumeSource is embedded will be the owner of the PVC, i.e. the PVC will be deleted together with the pod. The name of the PVC will be <pod name>-<volume name> where <volume name> is the name from the PodSpec.Volumes array entry. Pod validation will reject the pod if the concatenated name is not valid for a PVC (for example, too long).

+

An existing PVC with that name that is not owned by the pod will not be used for the pod to avoid using an unrelated volume by mistake. Starting the pod is then blocked until the unrelated PVC is removed. If such a pre-created PVC is meant to be used by the pod, the PVC has to updated with an owner reference to the pod once the pod exists. Normally this should not be necessary, but it may be useful when manually reconstructing a broken cluster.

+

This field is read-only and no changes will be made by Kubernetes to the PVC after it has been created.

+

Required, must not be nil.

+
+
+ +
+ + + + + + + + + + + + + + + + +
Table 47 io.cci.otc.api.pkg.apis.versioned.cci.v2.PersistentVolumeClaimTemplate

Parameter

+

Mandatory

+

Type

+

Description

+

metadata

+

No

+

io.k8s.apimachinery.pkg.apis.meta.v1.ObjectMeta object

+

May contain labels and annotations that will be copied into the

+

PVC when creating it. No other fields are allowed and will be rejected during

+

validation.

+

spec

+

Yes

+

io.cci.otc.api.pkg.apis.versioned.cci.v2.PersistentVolumeClaimSpec object

+

The specification for the PersistentVolumeClaim. The entire content

+

is copied unchanged into the PVC that gets created from this template. The

+

same fields as in a PersistentVolumeClaim are also valid here.

+
+
+ +
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Table 48 io.k8s.apimachinery.pkg.apis.meta.v1.ObjectMeta

Parameter

+

Mandatory

+

Type

+

Description

+

annotations

+

No

+

Map<String,String>

+

Annotations is an unstructured key value map stored with a resource that may be set by external tools to store and retrieve arbitrary metadata. They are not queryable and should be preserved when modifying objects. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/annotations/

+

clusterName

+

No

+

String

+

The name of the cluster which the object belongs to. This is

+

used to distinguish resources with same name and namespace in different

+

clusters. This field is not set anywhere right now and apiserver is going

+

to ignore it if set in create or update request.

+

creationTimestamp

+

No

+

String

+

CreationTimestamp is a timestamp representing the server time when this object was created. It is not guaranteed to be set in happens-before order across separate operations. Clients may not set this value. It is represented in RFC3339 form and is in UTC.

+

Populated by the system. Read-only. Null for lists. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata

+

deletionGracePeriodSeconds

+

No

+

Long

+

Number of seconds allowed for this object to gracefully terminate

+

before it will be removed from the system. Only set when deletionTimestamp

+

is also set. May only be shortened. Read-only.

+

deletionTimestamp

+

No

+

String

+

DeletionTimestamp is RFC 3339 date and time at which this resource will be deleted. This field is set by the server when a graceful deletion is requested by the user, and is not directly settable by a client. The resource is expected to be deleted (no longer visible from resource lists, and not reachable by name) after the time in this field, once the finalizers list is empty. As long as the finalizers list contains items, deletion is blocked. Once the deletionTimestamp is set, this value may not be unset or be set further into the future, although it may be shortened or the resource may be deleted prior to this time. For example, a user may request that a pod is deleted in 30 seconds. The Kubelet will react by sending a graceful termination signal to the containers in the pod. After that 30 seconds, the Kubelet will send a hard termination signal (SIGKILL) to the container and after cleanup, remove the pod from the API. In the presence of network partitions, this object may still exist after this timestamp, until an administrator or automated process can determine the resource is fully terminated. If not set, graceful deletion of the object has not been requested.

+

Populated by the system when a graceful deletion is requested. Read-only. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata

+

enable

+

No

+

Boolean

+

Enable identifies whether the resource is available

+

finalizers

+

No

+

Array of strings

+

Must be empty before the object is deleted from the registry.

+

Each entry is an identifier for the responsible component that will remove

+

the entry from the list. If the deletionTimestamp of the object is non-nil,

+

entries in this list can only be removed. Finalizers may be processed and

+

removed in any order. Order is NOT enforced because it introduces significant

+

risk of stuck finalizers. finalizers is a shared field, any actor with permission

+

can reorder it. If the finalizer list is processed in order, then this can

+

lead to a situation in which the component responsible for the first finalizer

+

in the list is waiting for a signal (field value, external system, or other)

+

produced by a component responsible for a finalizer later in the list, resulting

+

in a deadlock. Without enforced ordering finalizers are free to order amongst

+

themselves and are not vulnerable to ordering changes in the list.

+

generateName

+

No

+

String

+

GenerateName is an optional prefix, used by the server, to generate a unique name ONLY IF the Name field has not been provided. If this field is used, the name returned to the client will be different than the name passed. This value will also be combined with a unique suffix. The provided value has the same validation rules as the Name field, and may be truncated by the length of the suffix required to make the value unique on the server.

+

If this field is specified and the generated name exists, the server will NOT return a 409 - instead, it will either return 201 Created or 500 with Reason ServerTimeout indicating a unique name could not be found in the time allotted, and the client should retry (optionally after the time indicated in the Retry-After header).

+

Applied only if Name is not specified. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#idempotency

+

generation

+

No

+

Long

+

A sequence number representing a specific generation of the desired

+

state. Populated by the system. Read-only.

+

labels

+

No

+

Map<String,String>

+

Map of string keys and values that can be used to organize and categorize (scope and select) objects. May match selectors of replication controllers and services. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/labels/

+

managedFields

+

No

+

Array of io.k8s.apimachinery.pkg.apis.meta.v1.ManagedFieldsEntry objects

+

ManagedFields maps workflow-id and version to the set of fields

+

that are managed by that workflow. This is mostly for internal housekeeping,

+

and users typically shouldn't need to set or understand this field. A workflow

+

can be the user's name, a controller's name, or the name of a specific apply

+

path like "ci-cd". The set of fields is always in the version that the workflow

+

used when modifying the object.

+

name

+

No

+

String

+

Name must be unique within a namespace. Is required when creating resources, although some resources may allow a client to request the generation of an appropriate name automatically. Name is primarily intended for creation idempotence and configuration definition. Cannot be updated. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names

+

namespace

+

No

+

String

+

Namespace defines the space within which each name must be unique. An empty namespace is equivalent to the "default" namespace, but "default" is the canonical representation. Not all objects are required to be scoped to a namespace - the value of this field for those objects will be empty.

+

Must be a DNS_LABEL. Cannot be updated. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/namespaces/

+

ownerReferences

+

No

+

Array of io.k8s.apimachinery.pkg.apis.meta.v1.OwnerReference objects

+

List of objects depended by this object. If ALL objects in the

+

list have been deleted, this object will be garbage collected. If this object

+

is managed by a controller, then an entry in this list will point to this

+

controller, with the controller field set to true. There cannot be more

+

than one managing controller.

+

resourceVersion

+

No

+

String

+

An opaque value that represents the internal version of this object that can be used by clients to determine when objects have changed. May be used for optimistic concurrency, change detection, and the watch operation on a resource or set of resources. Clients must treat these values as opaque and passed unmodified back to the server. They may only be valid for a particular resource or set of resources.

+

Populated by the system. Read-only. Value must be treated as opaque by clients and . More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#concurrency-control-and-consistency

+

selfLink

+

No

+

String

+

SelfLink is a URL representing this object. Populated by the system. Read-only.

+

DEPRECATED Kubernetes will stop propagating this field in 1.20 release and the field is planned to be removed in 1.21 release.

+

uid

+

No

+

String

+

UID is the unique in time and space value for this object. It is typically generated by the server on successful creation of a resource and is not allowed to change on PUT operations.

+

Populated by the system. Read-only. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#uids

+
+
+ +
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Table 49 io.k8s.apimachinery.pkg.apis.meta.v1.ManagedFieldsEntry

Parameter

+

Mandatory

+

Type

+

Description

+

apiVersion

+

No

+

String

+

APIVersion defines the version of this resource that this field

+

set applies to. The format is "group/version" just like the top-level APIVersion

+

field. It is necessary to track the version of a field set because it cannot

+

be automatically converted.

+

fieldsType

+

No

+

String

+

FieldsType is the discriminator for the different fields format and version. There is currently only one possible value: "FieldsV1"

+

fieldsV1

+

No

+

Object

+

FieldsV1 holds the first JSON version format as described in

+

the "FieldsV1" type.

+

manager

+

No

+

String

+

Manager is an identifier of the workflow managing these fields.

+

operation

+

No

+

String

+

Operation is the type of operation which lead to this ManagedFieldsEntry

+

being created. The only valid values for this field are 'Apply' and 'Update'.

+

time

+

No

+

String

+

Time is timestamp of when these fields were set. It should always

+

be empty if Operation is 'Apply'

+
+
+ +
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Table 50 io.k8s.apimachinery.pkg.apis.meta.v1.OwnerReference

Parameter

+

Mandatory

+

Type

+

Description

+

apiVersion

+

Yes

+

String

+

API version of the referent.

+

blockOwnerDeletion

+

No

+

Boolean

+

If true, AND if the owner has the "foregroundDeletion" finalizer,

+

then the owner cannot be deleted from the key-value store until this reference

+

is removed. Defaults to false. To set this field, a user needs "delete"

+

permission of the owner, otherwise 422 (Unprocessable Entity) will be returned.

+

controller

+

No

+

Boolean

+

If true, this reference points to the managing controller.

+

kind

+

Yes

+

String

+

Kind of the referent. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds

+

name

+

Yes

+

String

+

Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names

+

uid

+

Yes

+

String

+

UID of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#uids

+
+
+ +
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Table 51 io.cci.otc.api.pkg.apis.versioned.cci.v2.PersistentVolumeClaimSpec

Parameter

+

Mandatory

+

Type

+

Description

+

accessModes

+

No

+

Array of strings

+

accessModes contains the desired access modes the volume should have. More info: https://kubernetes.io/docs/concepts/storage/persistent-volumes#access-modes-1

+

dataSource

+

No

+

io.cci.otc.api.pkg.apis.versioned.cci.v2.TypedLocalObjectReference object

+

dataSource field can be used to specify either: * An existing VolumeSnapshot object (snapshot.storage.k8s.io/VolumeSnapshot) * An existing PVC (PersistentVolumeClaim) If the provisioner or an external controller can support the specified data source, it will create a new volume based on the contents of the specified data source. If the AnyVolumeDataSource feature gate is enabled, this field will always have the same contents as the DataSourceRef field.

+

dataSourceRef

+

No

+

io.cci.otc.api.pkg.apis.versioned.cci.v2.TypedLocalObjectReference object

+

dataSourceRef specifies the object from which to populate the volume with data, if a non-empty volume is desired. This may be any local object from a non-empty API group (non core object) or a PersistentVolumeClaim object. When this field is specified, volume binding will only succeed if the type of the specified object matches some installed volume populator or dynamic provisioner. This field will replace the functionality of the DataSource field and as such if both fields are non-empty, they must have the same value. For backwards compatibility, both fields (DataSource and DataSourceRef) will be set to the same value automatically if one of them is empty and the other is non-empty. There are two important differences between DataSource and DataSourceRef: * While DataSource only allows two specific types of objects, DataSourceRef

+

allows any non-core object, as well as PersistentVolumeClaim objects.

+
  • While DataSource ignores disallowed values (dropping them), DataSourceRef

    preserves all values, and generates an error if a disallowed value is

    +

    specified.

    +

    (Beta) Using this field requires the AnyVolumeDataSource feature gate to be enabled.

    +
+

resources

+

No

+

io.cci.otc.api.pkg.apis.versioned.cci.v2.ResourceRequirements object

+

resources represents the minimum resources the volume should have. If RecoverVolumeExpansionFailure feature is enabled users are allowed to specify resource requirements that are lower than previous value but must still be higher than capacity recorded in the status field of the claim. More info: https://kubernetes.io/docs/concepts/storage/persistent-volumes#resources

+

selector

+

No

+

io.k8s.apimachinery.pkg.apis.meta.v1.LabelSelector object

+

selector is a label query over volumes to consider for binding.

+

storageClassName

+

No

+

String

+

storageClassName is the name of the StorageClass required by the claim. More info: https://kubernetes.io/docs/concepts/storage/persistent-volumes#class-1

+

volumeMode

+

No

+

String

+

volumeMode defines what type of volume is required by the claim.

+

Value of Filesystem is implied when not included in claim spec.

+

volumeName

+

No

+

String

+

volumeName is the binding reference to the PersistentVolume backing

+

this claim.

+
+
+ +
+ + + + + + + + + + + + + + + + + + + + + +
Table 52 io.cci.otc.api.pkg.apis.versioned.cci.v2.TypedLocalObjectReference

Parameter

+

Mandatory

+

Type

+

Description

+

apiGroup

+

No

+

String

+

APIGroup is the group for the resource being referenced. If APIGroup

+

is not specified, the specified Kind must be in the core API group. For

+

any other third-party types, APIGroup is required.

+

kind

+

Yes

+

String

+

Kind is the type of resource being referenced

+

name

+

Yes

+

String

+

Name is the name of resource being referenced

+
+
+ +
+ + + + + + + + + + + + + + + + +
Table 53 io.cci.otc.api.pkg.apis.versioned.cci.v2.ResourceRequirements

Parameter

+

Mandatory

+

Type

+

Description

+

limits

+

No

+

Map<String,String>

+

Limits describes the maximum amount of compute resources allowed. More info: https://kubernetes.io/docs/concepts/configuration/manage-resources-containers/

+

requests

+

No

+

Map<String,String>

+

Requests describes the minimum amount of compute resources required. If Requests is omitted for a container, it defaults to Limits if that is explicitly specified, otherwise to an implementation-defined value. More info: https://kubernetes.io/docs/concepts/configuration/manage-resources-containers/

+
+
+ +
+ + + + + + + + + + + +
Table 54 io.k8s.apimachinery.pkg.api.resource.Quantity

Parameter

+

Mandatory

+

Type

+

Description

+

-

+

No

+

String

+

Quantity is a fixed-point representation of a number. It provides convenient marshaling/unmarshaling in JSON and YAML, in addition to String() and AsInt64() accessors.

+

The serialization format is:

+

[/topic/body/section/table/tgroup/tbody/row/entry/p/br {""}) (br] ::= [/topic/body/section/table/tgroup/tbody/row/entry/p/br {""}) (br][/topic/body/section/table/tgroup/tbody/row/entry/p/br {""}) (br]

+

(Note that [/topic/body/section/table/tgroup/tbody/row/entry/p/br {""}) (br] may be empty, from the "" case in [/topic/body/section/table/tgroup/tbody/row/entry/p/br {""}) (br].)

+

[/topic/body/section/table/tgroup/tbody/row/entry/p/br {""}) (br] ::= 0 | 1 | ... | 9 [/topic/body/section/table/tgroup/tbody/row/entry/p/br {""}) (br] ::= [/topic/body/section/table/tgroup/tbody/row/entry/p/br {""}) (br] | [/topic/body/section/table/tgroup/tbody/row/entry/p/br {""}) (br][/topic/body/section/table/tgroup/tbody/row/entry/p/br {""}) (br] [/topic/body/section/table/tgroup/tbody/row/entry/p/br {""}) (br] ::= [/topic/body/section/table/tgroup/tbody/row/entry/p/br {""}) (br] | [/topic/body/section/table/tgroup/tbody/row/entry/p/br {""}) (br].[/topic/body/section/table/tgroup/tbody/row/entry/p/br {""}) (br] | [/topic/body/section/table/tgroup/tbody/row/entry/p/br {""}) (br]. | .[/topic/body/section/table/tgroup/tbody/row/entry/p/br {""}) (br] [/topic/body/section/table/tgroup/tbody/row/entry/p/br {""}) (br] ::= "+" | "-" [/topic/body/section/table/tgroup/tbody/row/entry/p/br {""}) (br] ::= [/topic/body/section/table/tgroup/tbody/row/entry/p/br {""}) (br] | [/topic/body/section/table/tgroup/tbody/row/entry/p/br {""}) (br][/topic/body/section/table/tgroup/tbody/row/entry/p/br {""}) (br] [/topic/body/section/table/tgroup/tbody/row/entry/p/br {""}) (br] ::= [/topic/body/section/table/tgroup/tbody/row/entry/p/br {""}) (br] | [/topic/body/section/table/tgroup/tbody/row/entry/p/br {""}) (br] | [/topic/body/section/table/tgroup/tbody/row/entry/p/br {""}) (br] [/topic/body/section/table/tgroup/tbody/row/entry/p/br {""}) (br] ::= Ki | Mi | Gi | Ti | Pi | Ei

+

(International System of units; See: http://physics.nist.gov/cuu/Units/binary.html)

+

[/topic/body/section/table/tgroup/tbody/row/entry/p/br {""}) (br] ::= m | "" | k | M | G | T | P | E

+

(Note that 1024 = 1Ki but 1000 = 1k; I didn't choose the capitalization.)

+

[/topic/body/section/table/tgroup/tbody/row/entry/p/br {""}) (br] ::= "e" [/topic/body/section/table/tgroup/tbody/row/entry/p/br {""}) (br] | "E" [/topic/body/section/table/tgroup/tbody/row/entry/p/br {""}) (br]

+

No matter which of the three exponent forms is used, no quantity may represent a number greater than 2^63-1 in magnitude, nor may it have more than 3 decimal places. Numbers larger or more precise will be capped or rounded up. (E.g.: 0.1m will rounded up to 1m.) This may be extended in the future if we require larger or smaller quantities.

+

When a Quantity is parsed from a string, it will remember the type of suffix it had, and will use the same type again when it is serialized.

+

Before serializing, Quantity will be put in "canonical form". This means that Exponent/suffix will be adjusted up or down (with a corresponding increase or decrease in Mantissa) such that:

+

a. No precision is lost

+

b. No fractional digits will be emitted

+

c. The exponent (or suffix) is as large as possible.

+

The sign will be omitted unless the number is negative.

+

Examples:

+

1.5 will be serialized as "1500m"

+

1.5Gi will be serialized as "1536Mi"

+

Note that the quantity will NEVER be internally represented by a floating point number. That is the whole point of this exercise.

+

Non-canonical values will still parse as long as they are well formed, but will be re-emitted in their canonical form. (So always use canonical form, or don't diff.)

+

This format is intended to make it difficult to use these numbers without writing some sort of special handling code in the hopes that that will cause implementors to also use a fixed point implementation.

+
+
+ +
+ + + + + + + + + + + + + + + + +
Table 55 io.k8s.apimachinery.pkg.apis.meta.v1.LabelSelector

Parameter

+

Mandatory

+

Type

+

Description

+

matchExpressions

+

No

+

Array of io.k8s.apimachinery.pkg.apis.meta.v1.LabelSelectorRequirement objects

+

matchExpressions is a list of label selector requirements. The

+

requirements are ANDed.

+

matchLabels

+

No

+

Map<String,String>

+

matchLabels is a map of {key,value} pairs. A single {key,value}

+

in the matchLabels map is equivalent to an element of matchExpressions,

+

whose key field is "key", the operator is "In", and the values array contains

+

only "value". The requirements are ANDed.

+
+
+ +
+ + + + + + + + + + + + + + + + + + + + + +
Table 56 io.k8s.apimachinery.pkg.apis.meta.v1.LabelSelectorRequirement

Parameter

+

Mandatory

+

Type

+

Description

+

key

+

Yes

+

String

+

key is the label key that the selector applies to.

+

operator

+

Yes

+

String

+

operator represents a key's relationship to a set of values.

+

Valid operators are In, NotIn, Exists and DoesNotExist.

+

values

+

No

+

Array of strings

+

values is an array of string values. If the operator is In or

+

NotIn, the values array must be non-empty. If the operator is Exists or

+

DoesNotExist, the values array must be empty. This array is replaced during

+

a strategic merge patch.

+
+
+ +
+ + + + + + + + + + + + + + + + + + + + + +
Table 57 io.cci.otc.api.pkg.apis.versioned.cci.v2.NFSVolumeSource

Parameter

+

Mandatory

+

Type

+

Description

+

path

+

Yes

+

String

+

path that is exported by the NFS server. More info: https://kubernetes.io/docs/concepts/storage/volumes#nfs

+

readOnly

+

No

+

Boolean

+

readOnly here will force the NFS export to be mounted with read-only permissions. Defaults to false. More info: https://kubernetes.io/docs/concepts/storage/volumes#nfs

+

server

+

Yes

+

String

+

server is the hostname or IP address of the NFS server. More info: https://kubernetes.io/docs/concepts/storage/volumes#nfs

+
+
+ +
+ + + + + + + + + + + + + + + + +
Table 58 io.cci.otc.api.pkg.apis.versioned.cci.v2.PersistentVolumeClaimVolumeSource

Parameter

+

Mandatory

+

Type

+

Description

+

claimName

+

Yes

+

String

+

claimName is the name of a PersistentVolumeClaim in the same namespace as the pod using this volume. More info: https://kubernetes.io/docs/concepts/storage/persistent-volumes#persistentvolumeclaims

+

readOnly

+

No

+

Boolean

+

readOnly Will force the ReadOnly setting in VolumeMounts. Default

+

false.

+
+
+ +
+ + + + + + + + + + + + + + + + +
Table 59 io.cci.otc.api.pkg.apis.versioned.cci.v2.ProjectedVolumeSource

Parameter

+

Mandatory

+

Type

+

Description

+

defaultMode

+

No

+

Integer

+

defaultMode are the mode bits used to set permissions on created

+

files by default. Must be an octal value between 0000 and 0777 or a decimal

+

value between 0 and 511. YAML accepts both octal and decimal values, JSON

+

requires decimal values for mode bits. Directories within the path are not

+

affected by this setting. This might be in conflict with other options that

+

affect the file mode, like fsGroup, and the result can be other mode bits

+

set.

+

sources

+

No

+

Array of io.cci.otc.api.pkg.apis.versioned.cci.v2.VolumeProjection objects

+

sources is the list of volume projections

+
+
+ +
+ + + + + + + + + + + + + + + + + + + + + +
Table 60 io.cci.otc.api.pkg.apis.versioned.cci.v2.VolumeProjection

Parameter

+

Mandatory

+

Type

+

Description

+

configMap

+

No

+

io.cci.otc.api.pkg.apis.versioned.cci.v2.ConfigMapProjection object

+

configMap information about the configMap data to project

+

downwardAPI

+

No

+

io.cci.otc.api.pkg.apis.versioned.cci.v2.DownwardAPIProjection object

+

downwardAPI information about the downwardAPI data to project

+

secret

+

No

+

io.cci.otc.api.pkg.apis.versioned.cci.v2.SecretProjection object

+

secret information about the secret data to project

+
+
+ +
+ + + + + + + + + + + + + + + + + + + + + +
Table 61 io.cci.otc.api.pkg.apis.versioned.cci.v2.ConfigMapProjection

Parameter

+

Mandatory

+

Type

+

Description

+

items

+

No

+

Array of io.cci.otc.api.pkg.apis.versioned.cci.v2.KeyToPath objects

+

items if unspecified, each key-value pair in the Data field of

+

the referenced ConfigMap will be projected into the volume as a file whose

+

name is the key and content is the value. If specified, the listed keys

+

will be projected into the specified paths, and unlisted keys will not be

+

present. If a key is specified which is not present in the ConfigMap, the

+

volume setup will error unless it is marked optional. Paths must be relative

+

and may not contain the '..' path or start with '..'.

+

name

+

No

+

String

+

Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names

+

optional

+

No

+

Boolean

+

optional specify whether the ConfigMap or its keys must be defined

+
+
+ +
+ + + + + + + + + + + +
Table 62 io.cci.otc.api.pkg.apis.versioned.cci.v2.DownwardAPIProjection

Parameter

+

Mandatory

+

Type

+

Description

+

items

+

No

+

Array of io.cci.otc.api.pkg.apis.versioned.cci.v2.DownwardAPIVolumeFile objects

+

Items is a list of DownwardAPIVolume file

+
+
+ +
+ + + + + + + + + + + + + + + + + + + + + + + + + + +
Table 63 io.cci.otc.api.pkg.apis.versioned.cci.v2.DownwardAPIVolumeFile

Parameter

+

Mandatory

+

Type

+

Description

+

fieldRef

+

No

+

io.cci.otc.api.pkg.apis.versioned.cci.v2.ObjectFieldSelector object

+

Required: Selects a field of the pod: only annotations, labels, name and namespace are supported.

+

mode

+

No

+

Integer

+

Optional: mode bits used to set permissions on this file, must be an octal value between 0000 and 0777 or a decimal value between 0 and 511. YAML accepts both octal and decimal values, JSON requires decimal values for mode bits. If not specified, the volume defaultMode will be used. This might be in conflict with other options that affect the file mode, like fsGroup, and the result can be other mode bits set.

+

path

+

Yes

+

String

+

Required: Path is the relative path name of the file to be created. Must not be absolute or contain the '..' path. Must be utf-8 encoded. The first item of the relative path must not start with '..'

+

resourceFieldRef

+

No

+

io.cci.otc.api.pkg.apis.versioned.cci.v2.ResourceFieldSelector object

+

Selects a resource of the container: only resources limits and requests (limits.cpu, limits.memory, requests.cpu and requests.memory) are currently supported.

+
+
+ +
+ + + + + + + + + + + + + + + + +
Table 64 io.cci.otc.api.pkg.apis.versioned.cci.v2.ObjectFieldSelector

Parameter

+

Mandatory

+

Type

+

Description

+

apiVersion

+

No

+

String

+

Version of the schema the FieldPath is written in terms of, defaults

+

to "v1".

+

fieldPath

+

Yes

+

String

+

Path of the field to select in the specified API version.

+
+
+ +
+ + + + + + + + + + + + + + + + + + + + + +
Table 65 io.cci.otc.api.pkg.apis.versioned.cci.v2.ResourceFieldSelector

Parameter

+

Mandatory

+

Type

+

Description

+

containerName

+

No

+

String

+

Container name: required for volumes, optional for env vars

+

divisor

+

No

+

String

+

Specifies the output format of the exposed resources, defaults

+

to "1"

+

resource

+

Yes

+

String

+

Required: resource to select

+
+
+ +
+ + + + + + + + + + + + + + + + + + + + + +
Table 66 io.cci.otc.api.pkg.apis.versioned.cci.v2.SecretProjection

Parameter

+

Mandatory

+

Type

+

Description

+

items

+

No

+

Array of io.cci.otc.api.pkg.apis.versioned.cci.v2.KeyToPath objects

+

items if unspecified, each key-value pair in the Data field of

+

the referenced Secret will be projected into the volume as a file whose

+

name is the key and content is the value. If specified, the listed keys

+

will be projected into the specified paths, and unlisted keys will not be

+

present. If a key is specified which is not present in the Secret, the volume

+

setup will error unless it is marked optional. Paths must be relative and

+

may not contain the '..' path or start with '..'.

+

name

+

No

+

String

+

Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names

+

optional

+

No

+

Boolean

+

optional field specify whether the Secret or its key must be

+

defined

+
+
+ +
+ + + + + + + + + + + + + + + + + + + + + + + + + + +
Table 67 io.cci.otc.api.pkg.apis.versioned.cci.v2.SecretVolumeSource

Parameter

+

Mandatory

+

Type

+

Description

+

defaultMode

+

No

+

Integer

+

defaultMode is Optional: mode bits used to set permissions on created files by default. Must be an octal value between 0000 and 0777 or a decimal value between 0 and 511. YAML accepts both octal and decimal values, JSON requires decimal values for mode bits. Defaults to 0644. Directories within the path are not affected by this setting. This might be in conflict with other options that affect the file mode, like fsGroup, and the result can be other mode bits set.

+

items

+

No

+

Array of io.cci.otc.api.pkg.apis.versioned.cci.v2.KeyToPath objects

+

items If unspecified, each key-value pair in the Data field of

+

the referenced Secret will be projected into the volume as a file whose

+

name is the key and content is the value. If specified, the listed keys

+

will be projected into the specified paths, and unlisted keys will not be

+

present. If a key is specified which is not present in the Secret, the volume

+

setup will error unless it is marked optional. Paths must be relative and

+

may not contain the '..' path or start with '..'.

+

optional

+

No

+

Boolean

+

optional field specify whether the Secret or its keys must be

+

defined

+

secretName

+

No

+

String

+

secretName is the name of the secret in the pod's namespace to use. More info: https://kubernetes.io/docs/concepts/storage/volumes#secret

+
+
+ +
+ + + + + + + + + + + + + + + + + + + + + +
Table 68 io.cci.otc.api.pkg.apis.versioned.cci.v2.KeyToPath

Parameter

+

Mandatory

+

Type

+

Description

+

key

+

Yes

+

String

+

key is the key to project.

+

mode

+

No

+

Integer

+

mode is Optional: mode bits used to set permissions on this file. Must be an octal value between 0000 and 0777 or a decimal value between 0 and 511. YAML accepts both octal and decimal values, JSON requires decimal values for mode bits. If not specified, the volume defaultMode will be used. This might be in conflict with other options that affect the file mode, like fsGroup, and the result can be other mode bits set.

+

path

+

Yes

+

String

+

path is the relative path of the file to map the key to. May

+

not be an absolute path. May not contain the path element '..'. May not

+

start with the string '..'.

+
+
+ +
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Table 69 io.cci.otc.api.pkg.apis.versioned.cci.v2.PodStatus

Parameter

+

Mandatory

+

Type

+

Description

+

conditions

+

No

+

Array of io.cci.otc.api.pkg.apis.versioned.cci.v2.PodCondition objects

+

Current service state of pod. More info: https://kubernetes.io/docs/concepts/workloads/pods/pod-lifecycle#pod-conditions

+

containerStatuses

+

No

+

Array of io.cci.otc.api.pkg.apis.versioned.cci.v2.ContainerStatus objects

+

The list has one entry per container in the manifest. More info: https://kubernetes.io/docs/concepts/workloads/pods/pod-lifecycle#pod-and-container-status

+

ephemeralContainerStatuses

+

No

+

Array of io.cci.otc.api.pkg.apis.versioned.cci.v2.ContainerStatus objects

+

Status for any ephemeral containers that have run in this pod.

+

hostIP

+

No

+

String

+

IP address of the host to which the pod is assigned. Empty if

+

not yet scheduled.

+

initContainerStatuses

+

No

+

Array of io.cci.otc.api.pkg.apis.versioned.cci.v2.ContainerStatus objects

+

The list has one entry per init container in the manifest. The most recent successful init container will have ready = true, the most recently started container will have startTime set. More info: https://kubernetes.io/docs/concepts/workloads/pods/pod-lifecycle#pod-and-container-status

+

message

+

No

+

String

+

A human readable message indicating details about why the pod

+

is in this condition.

+

nominatedNodeName

+

No

+

String

+

nominatedNodeName is set only when this pod preempts other pods

+

on the node, but it cannot be scheduled right away as preemption victims

+

receive their graceful termination periods. This field does not guarantee

+

that the pod will be scheduled on this node. Scheduler may decide to place

+

the pod elsewhere if other nodes become available sooner. Scheduler may

+

also decide to give the resources on this node to a higher priority pod

+

that is created after preemption. As a result, this field may be different

+

than PodSpec.nodeName when the pod is scheduled.

+

phase

+

No

+

String

+

The phase of a Pod is a simple, high-level summary of where the Pod is in its lifecycle. The conditions array, the reason and message fields, and the individual container status arrays contain more detail about the pod's status. There are five possible phase values:

+

Pending: The pod has been accepted by the Kubernetes system, but one or more of the container images has not been created. This includes time before being scheduled as well as time spent downloading images over the network, which could take a while. Running: The pod has been bound to a node, and all of the containers have been created. At least one container is still running, or is in the process of starting or restarting. Succeeded: All containers in the pod have terminated in success, and will not be restarted. Failed: All containers in the pod have terminated, and at least one container has terminated in failure. The container either exited with non-zero status or was terminated by the system. Unknown: For some reason the state of the pod could not be obtained, typically due to an error in communicating with the host of the pod.

+

More info: https://kubernetes.io/docs/concepts/workloads/pods/pod-lifecycle#pod-phase

+

Possible enum values:

+
  • "Failed" means that all containers in the pod have terminated, and at least one container has terminated in a failure (exited with a non-zero exit code or was stopped by the system).
  • "Pending" means the pod has been accepted by the system, but one or more of the containers has not been started. This includes time before being bound to a node, as well as time spent pulling images onto the host.
  • "Running" means the pod has been bound to a node and all of the containers have been started. At least one container is still running or is in the process of being restarted.
  • "Succeeded" means that all containers in the pod have voluntarily terminated with a container exit code of 0, and the system is not going to restart any of these containers.
  • "Unknown" means that for some reason the state of the pod could not be obtained, typically due to an error in communicating with the host of the pod. Deprecated: It isn't being set since 2015 (74da3b14b0c0f658b3bb8d2def5094686d0e9095)
+

podIP

+

No

+

String

+

IP address allocated to the pod. Routable at least within the

+

cluster. Empty if not yet allocated.

+

podIPs

+

No

+

Array of io.cci.otc.api.pkg.apis.versioned.cci.v2.PodIP objects

+

podIPs holds the IP addresses allocated to the pod. If this field

+

is specified, the 0th entry must match the podIP field. Pods may be allocated

+

at most 1 value for each of IPv4 and IPv6. This list is empty if no IPs

+

have been allocated yet.

+

qosClass

+

No

+

String

+

The Quality of Service (QOS) classification assigned to the pod based on resource requirements See PodQOSClass type for available QOS classes More info: https://git.k8s.io/community/contributors/design-proposals/node/resource-qos.md

+

Possible enum values:

+
  • "BestEffort" is the BestEffort qos class.
  • "Burstable" is the Burstable qos class.
  • "Guaranteed" is the Guaranteed qos class.
+

reason

+

No

+

String

+

A brief CamelCase message indicating details about why the pod

+

is in this state. e.g. 'Evicted'

+

startTime

+

No

+

String

+

RFC 3339 date and time at which the object was acknowledged by

+

the Kubelet. This is before the Kubelet pulled the container image(s) for

+

the pod.

+
+
+ +
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Table 70 io.cci.otc.api.pkg.apis.versioned.cci.v2.PodCondition

Parameter

+

Mandatory

+

Type

+

Description

+

lastProbeTime

+

No

+

String

+

Last time we probed the condition.

+

lastTransitionTime

+

No

+

String

+

Last time the condition transitioned from one status to another.

+

message

+

No

+

String

+

Human-readable message indicating details about last transition.

+

reason

+

No

+

String

+

Unique, one-word, CamelCase reason for the condition's last transition.

+

status

+

Yes

+

String

+

Status is the status of the condition. Can be True, False, Unknown. More info: https://kubernetes.io/docs/concepts/workloads/pods/pod-lifecycle#pod-conditions

+

type

+

Yes

+

String

+

Type is the type of the condition. More info: https://kubernetes.io/docs/concepts/workloads/pods/pod-lifecycle#pod-conditions

+
+
+ +
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Table 71 io.cci.otc.api.pkg.apis.versioned.cci.v2.ContainerStatus

Parameter

+

Mandatory

+

Type

+

Description

+

containerID

+

No

+

String

+

Container's ID in the format '[/topic/body/section/table/tgroup/tbody/row/entry/p/br {""}) (br]://<container_id>'.

+

image

+

Yes

+

String

+

The image the container is running. More info: https://kubernetes.io/docs/concepts/containers/images.

+

imageID

+

Yes

+

String

+

ImageID of the container's image.

+

lastState

+

No

+

io.cci.otc.api.pkg.apis.versioned.cci.v2.ContainerState object

+

Details about the container's last termination condition.

+

name

+

Yes

+

String

+

This must be a DNS_LABEL. Each container in a pod must have a

+

unique name. Cannot be updated.

+

ready

+

Yes

+

Boolean

+

Specifies whether the container has passed its readiness probe.

+

restartCount

+

Yes

+

Integer

+

The number of times the container has been restarted.

+

started

+

No

+

Boolean

+

Specifies whether the container has passed its startup probe.

+

Initialized as false, becomes true after startupProbe is considered successful.

+

Resets to false when the container is restarted, or if kubelet loses state

+

temporarily. Is always true when no startupProbe is defined.

+

state

+

No

+

io.cci.otc.api.pkg.apis.versioned.cci.v2.ContainerState object

+

Details about the container's current condition.

+
+
+ +
+ + + + + + + + + + + + + + + + + + + + + +
Table 72 io.cci.otc.api.pkg.apis.versioned.cci.v2.ContainerState

Parameter

+

Mandatory

+

Type

+

Description

+

running

+

No

+

io.cci.otc.api.pkg.apis.versioned.cci.v2.ContainerStateRunning object

+

Details about a running container

+

terminated

+

No

+

io.cci.otc.api.pkg.apis.versioned.cci.v2.ContainerStateTerminated object

+

Details about a terminated container

+

waiting

+

No

+

io.cci.otc.api.pkg.apis.versioned.cci.v2.ContainerStateWaiting object

+

Details about a waiting container

+
+
+ +
+ + + + + + + + + + + +
Table 73 io.cci.otc.api.pkg.apis.versioned.cci.v2.ContainerStateRunning

Parameter

+

Mandatory

+

Type

+

Description

+

startedAt

+

No

+

String

+

Time at which the container was last (re-)started

+
+
+ +
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Table 74 io.cci.otc.api.pkg.apis.versioned.cci.v2.ContainerStateTerminated

Parameter

+

Mandatory

+

Type

+

Description

+

containerID

+

No

+

String

+

Container's ID in the format '[/topic/body/section/table/tgroup/tbody/row/entry/p/br {""}) (br]://<container_id>'

+

exitCode

+

Yes

+

Integer

+

Exit status from the last termination of the container

+

finishedAt

+

No

+

String

+

Time at which the container last terminated

+

message

+

No

+

String

+

Message regarding the last termination of the container

+

reason

+

No

+

String

+

(brief) reason from the last termination of the container

+

signal

+

No

+

Integer

+

Signal from the last termination of the container

+

startedAt

+

No

+

String

+

Time at which previous execution of the container started

+
+
+ +
+ + + + + + + + + + + + + + + + +
Table 75 io.cci.otc.api.pkg.apis.versioned.cci.v2.ContainerStateWaiting

Parameter

+

Mandatory

+

Type

+

Description

+

message

+

No

+

String

+

Message regarding why the container is not yet running.

+

reason

+

No

+

String

+

(brief) reason the container is not yet running.

+
+
+ +
+ + + + + + + + + + + +
Table 76 io.cci.otc.api.pkg.apis.versioned.cci.v2.PodIP

Parameter

+

Mandatory

+

Type

+

Description

+

ip

+

No

+

String

+

ip is an IP address (IPv4 or IPv6) assigned to the pod

+
+
+
+

Response Parameters

Status code: 200

+ +
+ + + + + + + + + + + + + + + + + + + + + + + + + +
Table 77 Response body parameters

Parameter

+

Type

+

Description

+

apiVersion

+

String

+

APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#resources

+

kind

+

String

+

Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds

+

metadata

+

io.k8s.apimachinery.pkg.apis.meta.v1.ObjectMeta object

+

Standard object's metadata. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata

+

spec

+

io.cci.otc.api.pkg.apis.versioned.cci.v2.PodSpec object

+

Specification of the desired behavior of the pod. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#spec-and-status

+

status

+

io.cci.otc.api.pkg.apis.versioned.cci.v2.PodStatus object

+

Most recently observed status of the pod. This data may not be up to date. Populated by the system. Read-only. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#spec-and-status

+
+
+ +
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Table 78 io.cci.otc.api.pkg.apis.versioned.cci.v2.PodSpec

Parameter

+

Type

+

Description

+

activeDeadlineSeconds

+

Long

+

Optional duration in seconds the pod may be active on the node

+

relative to StartTime before the system will actively try to mark it failed

+

and kill associated containers. Value must be a positive integer.

+

affinity

+

io.cci.otc.api.pkg.apis.versioned.cci.v2.Affinity object

+

If specified, the pod's scheduling constraints

+

containers

+

Array of io.cci.otc.api.pkg.apis.versioned.cci.v2.Container objects

+

List of containers belonging to the pod. Containers cannot currently

+

be added or removed. There must be at least one container in a Pod. Cannot

+

be updated.

+

dnsConfig

+

io.cci.otc.api.pkg.apis.versioned.cci.v2.PodDNSConfig object

+

Specifies the DNS parameters of a pod. Parameters specified here

+

will be merged to the generated DNS configuration based on DNSPolicy.

+

dnsPolicy

+

String

+

Set DNS policy for the pod. Defaults to "ClusterFirst". Valid values are 'ClusterFirstWithHostNet', 'ClusterFirst', 'Default' or 'None'. DNS parameters given in DNSConfig will be merged with the policy selected with DNSPolicy. To have DNS options set along with hostNetwork, you have to specify DNS policy explicitly to 'ClusterFirstWithHostNet'.

+

Possible enum values:

+
  • "ClusterFirst" indicates that the pod should use cluster DNS first unless hostNetwork is true, if it is available, then fall back on the default (as determined by kubelet) DNS settings.
  • "ClusterFirstWithHostNet" indicates that the pod should use cluster DNS first, if it is available, then fall back on the default (as determined by kubelet) DNS settings.
  • "Default" indicates that the pod should use the default (as determined by kubelet) DNS settings.
  • "None" indicates that the pod should use empty DNS settings. DNS parameters such as nameservers and search paths should be defined via DNSConfig.
+

ephemeralContainers

+

Array of io.cci.otc.api.pkg.apis.versioned.cci.v2.EphemeralContainer objects

+

List of ephemeral containers run in this pod. Ephemeral containers

+

may be run in an existing pod to perform user-initiated actions such as

+

debugging. This list cannot be specified when creating a pod, and it cannot

+

be modified by updating the pod spec. In order to add an ephemeral container

+

to an existing pod, use the pod's ephemeralcontainers subresource.

+

hostAliases

+

Array of io.cci.otc.api.pkg.apis.versioned.cci.v2.HostAlias objects

+

HostAliases is an optional list of hosts and IPs that will be

+

injected into the pod's hosts file if specified. This is only valid for

+

non-hostNetwork pods.

+

hostname

+

String

+

Specifies the hostName of the Pod. If not specified, the pod's

+

hostname will be set to a system-defined value.

+

imagePullSecrets

+

Array of io.cci.otc.api.pkg.apis.versioned.cci.v2.LocalObjectReference objects

+

ImagePullSecrets is an optional list of references to secrets in the same namespace to use for pulling any of the images used by this PodSpec. If specified, these secrets will be passed to individual puller implementations for them to use. More info: https://kubernetes.io/docs/concepts/containers/images#specifying-imagepullsecrets-on-a-pod

+

initContainers

+

Array of io.cci.otc.api.pkg.apis.versioned.cci.v2.Container objects

+

List of initialization containers belonging to the pod. Init containers are executed in order prior to containers being started. If any init container fails, the pod is considered to have failed and is handled according to its restartPolicy. The name for an init container or normal container must be unique among all containers. Init containers may not have Lifecycle actions, Readiness probes, Liveness probes, or Startup probes. The resourceRequirements of an init container are taken into account during scheduling by finding the highest request/limit for each resource type, and then using the max of of that value or the sum of the normal containers. Limits are applied to init containers in a similar fashion. Init containers cannot currently be added or removed. Cannot be updated. More info: https://kubernetes.io/docs/concepts/workloads/pods/init-containers/

+

nodeName

+

String

+

NodeName is a request to schedule this pod onto a specific node.

+

If it is non-empty, the scheduler simply schedules this pod onto that node,

+

assuming that it fits resource requirements.

+

overhead

+

Map<String,String>

+

Overhead represents the resource overhead associated with running a pod for a given RuntimeClass. This field will be autopopulated at admission time by the RuntimeClass admission controller. If the RuntimeClass admission controller is enabled, overhead must not be set in Pod create requests. The RuntimeClass admission controller will reject Pod create requests which have the overhead already set. If RuntimeClass is configured and selected in the PodSpec, Overhead will be set to the value defined in the corresponding RuntimeClass, otherwise it will remain unset and treated as zero. More info: https://git.k8s.io/enhancements/keps/sig-node/688-pod-overhead/README.md

+

readinessGates

+

Array of io.cci.otc.api.pkg.apis.versioned.cci.v2.PodReadinessGate objects

+

If specified, all readiness gates will be evaluated for pod readiness. A pod is ready when all its containers are ready AND all conditions specified in the readiness gates have status equal to "True" More info: https://git.k8s.io/enhancements/keps/sig-network/580-pod-readiness-gates

+

restartPolicy

+

String

+

Restart policy for all containers within the pod. One of Always, OnFailure, Never. Default to Always. More info: https://kubernetes.io/docs/concepts/workloads/pods/pod-lifecycle/#restart-policy

+

Possible enum values:

+
  • "Always"
  • "Never"
  • "OnFailure"
+

schedulerName

+

String

+

If specified, the pod will be dispatched by specified scheduler.

+

If not specified, the pod will be dispatched by default scheduler.

+

securityContext

+

io.cci.otc.api.pkg.apis.versioned.cci.v2.PodSecurityContext object

+

SecurityContext holds pod-level security attributes and common container settings. Optional: Defaults to empty. See type description for default values of each field.

+

setHostnameAsFQDN

+

Boolean

+

If true the pod's hostname will be configured as the pod's FQDN,

+

rather than the leaf name (the default). In Linux containers, this means

+

setting the FQDN in the hostname field of the kernel (the nodename field

+

of struct utsname). In Windows containers, this means setting the registry

+

value of hostname for the registry key HKEY_LOCAL_MACHINE\SYSTEM\CurrentControlSet\Services\Tcpip\Parameters

+

to FQDN. If a pod does not have FQDN, this has no effect. Default to false.

+

shareProcessNamespace

+

Boolean

+

Share a single process namespace between all of the containers in a pod. When this is set containers will be able to view and signal processes from other containers in the same pod, and the first process in each container will not be assigned PID 1. HostPID and ShareProcessNamespace cannot both be set. Optional: Default to false.

+

terminationGracePeriodSeconds

+

Long

+

Optional duration in seconds the pod needs to terminate gracefully.

+

May be decreased in delete request. Value must be non-negative integer.

+

The value zero indicates stop immediately via the kill signal (no opportunity

+

to shut down). If this value is nil, the default grace period will be used

+

instead. The grace period is the duration in seconds after the processes

+

running in the pod are sent a termination signal and the time when the processes

+

are forcibly halted with a kill signal. Set this value longer than the expected

+

cleanup time for your process. Defaults to 30 seconds.

+

topologySpreadConstraints

+

Array of io.cci.otc.api.pkg.apis.versioned.cci.v2.TopologySpreadConstraint objects

+

TopologySpreadConstraints describes how a group of pods ought

+

to spread across topology domains. Scheduler will schedule pods in a way

+

which abides by the constraints. All topologySpreadConstraints are ANDed.

+

volumes

+

Array of io.cci.otc.api.pkg.apis.versioned.cci.v2.Volume objects

+

List of volumes that can be mounted by containers belonging to the pod. More info: https://kubernetes.io/docs/concepts/storage/volumes

+
+
+ +
+ + + + + + + + + + + + + +
Table 79 io.cci.otc.api.pkg.apis.versioned.cci.v2.Affinity

Parameter

+

Type

+

Description

+

nodeAffinity

+

io.cci.otc.api.pkg.apis.versioned.cci.v2.NodeAffinity object

+

Describes node affinity scheduling rules for the pod.

+

podAntiAffinity

+

io.cci.otc.api.pkg.apis.versioned.cci.v2.PodAntiAffinity object

+

Describes pod anti-affinity scheduling rules (e.g. avoid putting

+

this pod in the same zone, etc. as some other pod(s)).

+
+
+ +
+ + + + + + + + + +
Table 80 io.cci.otc.api.pkg.apis.versioned.cci.v2.NodeAffinity

Parameter

+

Type

+

Description

+

requiredDuringSchedulingIgnoredDuringExecution

+

io.cci.otc.api.pkg.apis.versioned.cci.v2.NodeSelector object

+

If the affinity requirements specified by this field are not

+

met at scheduling time, the pod will not be scheduled onto the node. If

+

the affinity requirements specified by this field cease to be met at some

+

point during pod execution (e.g. due to an update), the system may or may

+

not try to eventually evict the pod from its node.

+
+
+ +
+ + + + + + + + + +
Table 81 io.cci.otc.api.pkg.apis.versioned.cci.v2.NodeSelector

Parameter

+

Type

+

Description

+

nodeSelectorTerms

+

Array of io.cci.otc.api.pkg.apis.versioned.cci.v2.NodeSelectorTerm objects

+

Required. A list of node selector terms. The terms are ORed.

+
+
+ +
+ + + + + + + + + +
Table 82 io.cci.otc.api.pkg.apis.versioned.cci.v2.NodeSelectorTerm

Parameter

+

Type

+

Description

+

matchExpressions

+

Array of io.cci.otc.api.pkg.apis.versioned.cci.v2.NodeSelectorRequirement objects

+

A list of node selector requirements by node's labels.

+
+
+ +
+ + + + + + + + + + + + + + + + + +
Table 83 io.cci.otc.api.pkg.apis.versioned.cci.v2.NodeSelectorRequirement

Parameter

+

Type

+

Description

+

key

+

String

+

The label key that the selector applies to.

+

operator

+

String

+

Represents a key's relationship to a set of values. Valid operators are In, NotIn, Exists, DoesNotExist. Gt, and Lt.

+

Possible enum values:

+
  • "DoesNotExist"
  • "Exists"
  • "Gt"
  • "In"
  • "Lt"
  • "NotIn"
+

values

+

Array of strings

+

An array of string values. If the operator is In or NotIn, the

+

values array must be non-empty. If the operator is Exists or DoesNotExist,

+

the values array must be empty. If the operator is Gt or Lt, the values

+

array must have a single element, which will be interpreted as an integer.

+

This array is replaced during a strategic merge patch.

+
+
+ +
+ + + + + + + + + + + + + +
Table 84 io.cci.otc.api.pkg.apis.versioned.cci.v2.PodAntiAffinity

Parameter

+

Type

+

Description

+

preferredDuringSchedulingIgnoredDuringExecution

+

Array of io.cci.otc.api.pkg.apis.versioned.cci.v2.WeightedPodAffinityTerm objects

+

The scheduler will prefer to schedule pods to nodes that satisfy

+

the anti-affinity expressions specified by this field, but it may choose

+

a node that violates one or more of the expressions. The node that is most

+

preferred is the one with the greatest sum of weights, i.e. for each node

+

that meets all of the scheduling requirements (resource request, requiredDuringScheduling

+

anti-affinity expressions, etc.), compute a sum by iterating through the

+

elements of this field and adding "weight" to the sum if the node has pods

+

which matches the corresponding podAffinityTerm; the node(s) with the highest

+

sum are the most preferred.

+

requiredDuringSchedulingIgnoredDuringExecution

+

Array of io.cci.otc.api.pkg.apis.versioned.cci.v2.PodAffinityTerm objects

+

If the anti-affinity requirements specified by this field are

+

not met at scheduling time, the pod will not be scheduled onto the node.

+

If the anti-affinity requirements specified by this field cease to be met

+

at some point during pod execution (e.g. due to a pod label update), the

+

system may or may not try to eventually evict the pod from its node. When

+

there are multiple elements, the lists of nodes corresponding to each podAffinityTerm

+

are intersected, i.e. all terms must be satisfied.

+
+
+ +
+ + + + + + + + + + + + + +
Table 85 io.cci.otc.api.pkg.apis.versioned.cci.v2.WeightedPodAffinityTerm

Parameter

+

Type

+

Description

+

podAffinityTerm

+

io.cci.otc.api.pkg.apis.versioned.cci.v2.PodAffinityTerm object

+

Required. A pod affinity term, associated with the corresponding

+

weight.

+

weight

+

Integer

+

weight associated with matching the corresponding podAffinityTerm,

+

in the range 1-100.

+
+
+ +
+ + + + + + + + + + + + + + + + + +
Table 86 io.cci.otc.api.pkg.apis.versioned.cci.v2.PodAffinityTerm

Parameter

+

Type

+

Description

+

labelSelector

+

io.k8s.apimachinery.pkg.apis.meta.v1.LabelSelector object

+

A label query over a set of resources, in this case pods.

+

namespaces

+

Array of strings

+

namespaces specifies a static list of namespace names that the

+

term applies to. The term is applied to the union of the namespaces listed

+

in this field and the ones selected by namespaceSelector. null or empty

+

namespaces list and null namespaceSelector means "this pod's namespace".

+

topologyKey

+

String

+

This pod should be co-located (affinity) or not co-located (anti-affinity)

+

with the pods matching the labelSelector in the specified namespaces, where

+

co-located is defined as running on a node whose value of the label with

+

key topologyKey matches that of any node on which any of the selected pods

+

is running. Empty topologyKey is not allowed.

+
+
+ +
+ + + + + + + + + + + + + + + + + +
Table 87 io.cci.otc.api.pkg.apis.versioned.cci.v2.PodDNSConfig

Parameter

+

Type

+

Description

+

nameservers

+

Array of strings

+

A list of DNS name server IP addresses. This will be appended

+

to the base nameservers generated from DNSPolicy. Duplicated nameservers

+

will be removed.

+

options

+

Array of io.cci.otc.api.pkg.apis.versioned.cci.v2.PodDNSConfigOption objects

+

A list of DNS resolver options. This will be merged with the

+

base options generated from DNSPolicy. Duplicated entries will be removed.

+

Resolution options given in Options will override those that appear in the

+

base DNSPolicy.

+

searches

+

Array of strings

+

A list of DNS search domains for host-name lookup. This will

+

be appended to the base search paths generated from DNSPolicy. Duplicated

+

search paths will be removed.

+
+
+ +
+ + + + + + + + + + + + + +
Table 88 io.cci.otc.api.pkg.apis.versioned.cci.v2.PodDNSConfigOption

Parameter

+

Type

+

Description

+

name

+

String

+

Required.

+

value

+

String

+		  
+
+ +
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Table 89 io.cci.otc.api.pkg.apis.versioned.cci.v2.EphemeralContainer

Parameter

+

Type

+

Description

+

args

+

Array of strings

+

Arguments to the entrypoint. The image's CMD is used if this is not provided. Variable references $(VAR_NAME) are expanded using the container's environment. If a variable cannot be resolved, the reference in the input string will be unchanged. Double $$ are reduced to a single $, which allows for escaping the $(VAR_NAME) syntax: i.e. "$$(VAR_NAME)" will produce the string literal "$(VAR_NAME)". Escaped references will never be expanded, regardless of whether the variable exists or not. Cannot be updated. More info: https://kubernetes.io/docs/tasks/inject-data-application/define-command-argument-container/#running-a-command-in-a-shell

+

command

+

Array of strings

+

Entrypoint array. Not executed within a shell. The image's ENTRYPOINT is used if this is not provided. Variable references $(VAR_NAME) are expanded using the container's environment. If a variable cannot be resolved, the reference in the input string will be unchanged. Double $$ are reduced to a single $, which allows for escaping the $(VAR_NAME) syntax: i.e. "$$(VAR_NAME)" will produce the string literal "$(VAR_NAME)". Escaped references will never be expanded, regardless of whether the variable exists or not. Cannot be updated. More info: https://kubernetes.io/docs/tasks/inject-data-application/define-command-argument-container/#running-a-command-in-a-shell

+

env

+

Array of io.cci.otc.api.pkg.apis.versioned.cci.v2.EnvVar objects

+

List of environment variables to set in the container. Cannot

+

be updated.

+

envFrom

+

Array of io.cci.otc.api.pkg.apis.versioned.cci.v2.EnvFromSource objects

+

List of sources to populate environment variables in the container.

+

The keys defined within a source must be a C_IDENTIFIER. All invalid keys

+

will be reported as an event when the container is starting. When a key

+

exists in multiple sources, the value associated with the last source will

+

take precedence. Values defined by an Env with a duplicate key will take

+

precedence. Cannot be updated.

+

image

+

String

+

Container image name. More info: https://kubernetes.io/docs/concepts/containers/images

+

lifecycle

+

io.cci.otc.api.pkg.apis.versioned.cci.v2.Lifecycle object

+

Lifecycle is not allowed for ephemeral containers.

+

livenessProbe

+

io.cci.otc.api.pkg.apis.versioned.cci.v2.Probe object

+

Probes are not allowed for ephemeral containers.

+

name

+

String

+

Name of the ephemeral container specified as a DNS_LABEL. This

+

name must be unique among all containers, init containers and ephemeral

+

containers.

+

ports

+

Array of io.cci.otc.api.pkg.apis.versioned.cci.v2.ContainerPort objects

+

Ports are not allowed for ephemeral containers.

+

readinessProbe

+

io.cci.otc.api.pkg.apis.versioned.cci.v2.Probe object

+

Probes are not allowed for ephemeral containers.

+

resources

+

io.cci.otc.api.pkg.apis.versioned.cci.v2.ResourceRequirements object

+

Resources are not allowed for ephemeral containers. Ephemeral

+

containers use spare resources already allocated to the pod.

+

securityContext

+

io.cci.otc.api.pkg.apis.versioned.cci.v2.SecurityContext object

+

Optional: SecurityContext defines the security options the ephemeral container should be run with. If set, the fields of SecurityContext override the equivalent fields of PodSecurityContext.

+

startupProbe

+

io.cci.otc.api.pkg.apis.versioned.cci.v2.Probe object

+

Probes are not allowed for ephemeral containers.

+

stdin

+

Boolean

+

Whether this container should allocate a buffer for stdin in

+

the container runtime. If this is not set, reads from stdin in the container

+

will always result in EOF. Default is false.

+

stdinOnce

+

Boolean

+

Whether the container runtime should close the stdin channel

+

after it has been opened by a single attach. When stdin is true the stdin

+

stream will remain open across multiple attach sessions. If stdinOnce is

+

set to true, stdin is opened on container start, is empty until the first

+

client attaches to stdin, and then remains open and accepts data until the

+

client disconnects, at which time stdin is closed and remains closed until

+

the container is restarted. If this flag is false, a container processes

+

that reads from stdin will never receive an EOF. Default is false

+

targetContainerName

+

String

+

If set, the name of the container from PodSpec that this ephemeral container targets. The ephemeral container will be run in the namespaces (IPC, PID, etc) of this container. If not set then the ephemeral container uses the namespaces configured in the Pod spec.

+

The container runtime must implement support for this feature. If the runtime does not support namespace targeting then the result of setting this field is undefined.

+

terminationMessagePath

+

String

+

Optional: Path at which the file to which the container's termination message will be written is mounted into the container's filesystem. Message written is intended to be brief final status, such as an assertion failure message. Will be truncated by the node if greater than 4096 bytes. The total message length across all containers will be limited to 12kb. Defaults to /dev/termination-log. Cannot be updated.

+

terminationMessagePolicy

+

String

+

Indicate how the termination message should be populated. File will use the contents of terminationMessagePath to populate the container status message on both success and failure. FallbackToLogsOnError will use the last chunk of container log output if the termination message file is empty and the container exited with an error. The log output is limited to 2048 bytes or 80 lines, whichever is smaller. Defaults to File. Cannot be updated.

+

Possible enum values:

+
  • "FallbackToLogsOnError" will read the most recent contents of the container logs for the container status message when the container exits with an error and the terminationMessagePath has no contents.
  • "File" is the default behavior and will set the container status message to the contents of the container's terminationMessagePath when the container exits.
+

tty

+

Boolean

+

Whether this container should allocate a TTY for itself, also

+

requires 'stdin' to be true. Default is false.

+

volumeMounts

+

Array of io.cci.otc.api.pkg.apis.versioned.cci.v2.VolumeMount objects

+

Pod volumes to mount into the container's filesystem. Subpath

+

mounts are not allowed for ephemeral containers. Cannot be updated.

+

workingDir

+

String

+

Container's working directory. If not specified, the container

+

runtime's default will be used, which might be configured in the container

+

image. Cannot be updated.

+
+
+ +
+ + + + + + + + + + + + + +
Table 90 io.cci.otc.api.pkg.apis.versioned.cci.v2.HostAlias

Parameter

+

Type

+

Description

+

hostnames

+

Array of strings

+

Hostnames for the above IP address.

+

ip

+

String

+

IP address of the host file entry.

+
+
+ +
+ + + + + + + + + +
Table 91 io.cci.otc.api.pkg.apis.versioned.cci.v2.LocalObjectReference

Parameter

+

Type

+

Description

+

name

+

String

+

Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names

+
+
+ +
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Table 92 io.cci.otc.api.pkg.apis.versioned.cci.v2.Container

Parameter

+

Type

+

Description

+

args

+

Array of strings

+

Arguments to the entrypoint. The container image's CMD is used if this is not provided. Variable references $(VAR_NAME) are expanded using the container's environment. If a variable cannot be resolved, the reference in the input string will be unchanged. Double $$ are reduced to a single $, which allows for escaping the $(VAR_NAME) syntax: i.e. "$$(VAR_NAME)" will produce the string literal "$(VAR_NAME)". Escaped references will never be expanded, regardless of whether the variable exists or not. Cannot be updated. More info: https://kubernetes.io/docs/tasks/inject-data-application/define-command-argument-container/#running-a-command-in-a-shell

+

command

+

Array of strings

+

Entrypoint array. Not executed within a shell. The container image's ENTRYPOINT is used if this is not provided. Variable references $(VAR_NAME) are expanded using the container's environment. If a variable cannot be resolved, the reference in the input string will be unchanged. Double $$ are reduced to a single $, which allows for escaping the $(VAR_NAME) syntax: i.e. "$$(VAR_NAME)" will produce the string literal "$(VAR_NAME)". Escaped references will never be expanded, regardless of whether the variable exists or not. Cannot be updated. More info: https://kubernetes.io/docs/tasks/inject-data-application/define-command-argument-container/#running-a-command-in-a-shell

+

env

+

Array of io.cci.otc.api.pkg.apis.versioned.cci.v2.EnvVar objects

+

List of environment variables to set in the container. Cannot

+

be updated.

+

envFrom

+

Array of io.cci.otc.api.pkg.apis.versioned.cci.v2.EnvFromSource objects

+

List of sources to populate environment variables in the container.

+

The keys defined within a source must be a C_IDENTIFIER. All invalid keys

+

will be reported as an event when the container is starting. When a key

+

exists in multiple sources, the value associated with the last source will

+

take precedence. Values defined by an Env with a duplicate key will take

+

precedence. Cannot be updated.

+

image

+

String

+

Container image name. More info: https://kubernetes.io/docs/concepts/containers/images This field is optional to allow higher level config management to default or override container images in workload controllers like Deployments and StatefulSets.

+

lifecycle

+

io.cci.otc.api.pkg.apis.versioned.cci.v2.Lifecycle object

+

Actions that the management system should take in response to

+

container lifecycle events. Cannot be updated.

+

livenessProbe

+

io.cci.otc.api.pkg.apis.versioned.cci.v2.Probe object

+

Periodic probe of container liveness. Container will be restarted if the probe fails. Cannot be updated. More info: https://kubernetes.io/docs/concepts/workloads/pods/pod-lifecycle#container-probes

+

name

+

String

+

Name of the container specified as a DNS_LABEL. Each container

+

in a pod must have a unique name (DNS_LABEL). Cannot be updated.

+

ports

+

Array of io.cci.otc.api.pkg.apis.versioned.cci.v2.ContainerPort objects

+

List of ports to expose from the container. Not specifying a

+

port here DOES NOT prevent that port from being exposed. Any port which

+

is listening on the default "0.0.0.0" address inside a container will be

+

accessible from the network. Modifying this array with strategic merge patch

+

may corrupt the data. For more information See https://github.com/kubernetes/kubernetes/issues/108255.

+

Cannot be updated.

+

readinessProbe

+

io.cci.otc.api.pkg.apis.versioned.cci.v2.Probe object

+

Periodic probe of container service readiness. Container will be removed from service endpoints if the probe fails. Cannot be updated. More info: https://kubernetes.io/docs/concepts/workloads/pods/pod-lifecycle#container-probes

+

resources

+

io.cci.otc.api.pkg.apis.versioned.cci.v2.ResourceRequirements object

+

Compute Resources required by this container. Cannot be updated. More info: https://kubernetes.io/docs/concepts/configuration/manage-resources-containers/

+

securityContext

+

io.cci.otc.api.pkg.apis.versioned.cci.v2.SecurityContext object

+

SecurityContext defines the security options the container should be run with. If set, the fields of SecurityContext override the equivalent fields of PodSecurityContext. More info: https://kubernetes.io/docs/tasks/configure-pod-container/security-context/

+

startupProbe

+

io.cci.otc.api.pkg.apis.versioned.cci.v2.Probe object

+

StartupProbe indicates that the Pod has successfully initialized. If specified, no other probes are executed until this completes successfully. If this probe fails, the Pod will be restarted, just as if the livenessProbe failed. This can be used to provide different probe parameters at the beginning of a Pod's lifecycle, when it might take a long time to load data or warm a cache, than during steady-state operation. This cannot be updated. More info: https://kubernetes.io/docs/concepts/workloads/pods/pod-lifecycle#container-probes

+

stdin

+

Boolean

+

Whether this container should allocate a buffer for stdin in

+

the container runtime. If this is not set, reads from stdin in the container

+

will always result in EOF. Default is false.

+

stdinOnce

+

Boolean

+

Whether the container runtime should close the stdin channel

+

after it has been opened by a single attach. When stdin is true the stdin

+

stream will remain open across multiple attach sessions. If stdinOnce is

+

set to true, stdin is opened on container start, is empty until the first

+

client attaches to stdin, and then remains open and accepts data until the

+

client disconnects, at which time stdin is closed and remains closed until

+

the container is restarted. If this flag is false, a container processes

+

that reads from stdin will never receive an EOF. Default is false

+

terminationMessagePath

+

String

+

Optional: Path at which the file to which the container's termination message will be written is mounted into the container's filesystem. Message written is intended to be brief final status, such as an assertion failure message. Will be truncated by the node if greater than 4096 bytes. The total message length across all containers will be limited to 12kb. Defaults to /dev/termination-log. Cannot be updated.

+

terminationMessagePolicy

+

String

+

Indicate how the termination message should be populated. File will use the contents of terminationMessagePath to populate the container status message on both success and failure. FallbackToLogsOnError will use the last chunk of container log output if the termination message file is empty and the container exited with an error. The log output is limited to 2048 bytes or 80 lines, whichever is smaller. Defaults to File. Cannot be updated.

+

Possible enum values:

+
  • "FallbackToLogsOnError" will read the most recent contents of the container logs for the container status message when the container exits with an error and the terminationMessagePath has no contents.
  • "File" is the default behavior and will set the container status message to the contents of the container's terminationMessagePath when the container exits.
+

tty

+

Boolean

+

Whether this container should allocate a TTY for itself, also

+

requires 'stdin' to be true. Default is false.

+

volumeMounts

+

Array of io.cci.otc.api.pkg.apis.versioned.cci.v2.VolumeMount objects

+

Pod volumes to mount into the container's filesystem. Cannot

+

be updated.

+

workingDir

+

String

+

Container's working directory. If not specified, the container

+

runtime's default will be used, which might be configured in the container

+

image. Cannot be updated.

+
+
+ +
+ + + + + + + + + + + + + + + + + +
Table 93 io.cci.otc.api.pkg.apis.versioned.cci.v2.EnvVar

Parameter

+

Type

+

Description

+

name

+

String

+

Name of the environment variable. Must be a C_IDENTIFIER.

+

value

+

String

+

Variable references $(VAR_NAME) are expanded using the previously defined environment variables in the container and any service environment variables. If a variable cannot be resolved, the reference in the input string will be unchanged. Double $$ are reduced to a single $, which allows for escaping the $(VAR_NAME) syntax: i.e. "$$(VAR_NAME)" will produce the string literal "$(VAR_NAME)". Escaped references will never be expanded, regardless of whether the variable exists or not. Defaults to "".

+

valueFrom

+

io.cci.otc.api.pkg.apis.versioned.cci.v2.EnvVarSource object

+

Source for the environment variable's value. Cannot be used if

+

value is not empty.

+
+
+ +
+ + + + + + + + + + + + + + + + + + + + + +
Table 94 io.cci.otc.api.pkg.apis.versioned.cci.v2.EnvVarSource

Parameter

+

Type

+

Description

+

configMapKeyRef

+

io.cci.otc.api.pkg.apis.versioned.cci.v2.ConfigMapKeySelector object

+

Selects a key of a ConfigMap.

+

fieldRef

+

io.cci.otc.api.pkg.apis.versioned.cci.v2.ObjectFieldSelector object

+

Selects a field of the pod: supports metadata.name, metadata.namespace, metadata.labels['<KEY>'], metadata.annotations['<KEY>'], spec.nodeName, spec.serviceAccountName, status.hostIP, status.podIP, status.podIPs.

+

resourceFieldRef

+

io.cci.otc.api.pkg.apis.versioned.cci.v2.ResourceFieldSelector object

+

Selects a resource of the container: only resources limits and requests (limits.cpu, limits.memory, limits.ephemeral-storage, requests.cpu, requests.memory and requests.ephemeral-storage) are currently supported.

+

secretKeyRef

+

io.cci.otc.api.pkg.apis.versioned.cci.v2.SecretKeySelector object

+

Selects a key of a secret in the pod's namespace

+
+
+ +
+ + + + + + + + + + + + + + + + + +
Table 95 io.cci.otc.api.pkg.apis.versioned.cci.v2.ConfigMapKeySelector

Parameter

+

Type

+

Description

+

key

+

String

+

The key to select.

+

name

+

String

+

Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names

+

optional

+

Boolean

+

Specify whether the ConfigMap or its key must be defined

+
+
+ +
+ + + + + + + + + + + + + + + + + +
Table 96 io.cci.otc.api.pkg.apis.versioned.cci.v2.SecretKeySelector

Parameter

+

Type

+

Description

+

key

+

String

+

The key of the secret to select from. Must be a valid secret

+

key.

+

name

+

String

+

Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names

+

optional

+

Boolean

+

Specify whether the Secret or its key must be defined

+
+
+ +
+ + + + + + + + + + + + + + + + + +
Table 97 io.cci.otc.api.pkg.apis.versioned.cci.v2.EnvFromSource

Parameter

+

Type

+

Description

+

configMapRef

+

io.cci.otc.api.pkg.apis.versioned.cci.v2.ConfigMapEnvSource object

+

The ConfigMap to select from

+

prefix

+

String

+

An optional identifier to prepend to each key in the ConfigMap.

+

Must be a C_IDENTIFIER.

+

secretRef

+

io.cci.otc.api.pkg.apis.versioned.cci.v2.SecretEnvSource object

+

The Secret to select from

+
+
+ +
+ + + + + + + + + + + + + +
Table 98 io.cci.otc.api.pkg.apis.versioned.cci.v2.ConfigMapEnvSource

Parameter

+

Type

+

Description

+

name

+

String

+

Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names

+

optional

+

Boolean

+

Specify whether the ConfigMap must be defined

+
+
+ +
+ + + + + + + + + + + + + +
Table 99 io.cci.otc.api.pkg.apis.versioned.cci.v2.SecretEnvSource

Parameter

+

Type

+

Description

+

name

+

String

+

Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names

+

optional

+

Boolean

+

Specify whether the Secret must be defined

+
+
+ +
+ + + + + + + + + + + + + +
Table 100 io.cci.otc.api.pkg.apis.versioned.cci.v2.Lifecycle

Parameter

+

Type

+

Description

+

postStart

+

io.cci.otc.api.pkg.apis.versioned.cci.v2.LifecycleHandler object

+

PostStart is called immediately after a container is created. If the handler fails, the container is terminated and restarted according to its restart policy. Other management of the container blocks until the hook completes. More info: https://kubernetes.io/docs/concepts/containers/container-lifecycle-hooks/#container-hooks

+

preStop

+

io.cci.otc.api.pkg.apis.versioned.cci.v2.LifecycleHandler object

+

PreStop is called immediately before a container is terminated due to an API request or management event such as liveness/startup probe failure, preemption, resource contention, etc. The handler is not called if the container crashes or exits. The Pod's termination grace period countdown begins before the PreStop hook is executed. Regardless of the outcome of the handler, the container will eventually terminate within the Pod's termination grace period (unless delayed by finalizers). Other management of the container blocks until the hook completes or until the termination grace period is reached. More info: https://kubernetes.io/docs/concepts/containers/container-lifecycle-hooks/#container-hooks

+
+
+ +
+ + + + + + + + + + + + + +
Table 101 io.cci.otc.api.pkg.apis.versioned.cci.v2.LifecycleHandler

Parameter

+

Type

+

Description

+

exec

+

io.cci.otc.api.pkg.apis.versioned.cci.v2.ExecAction object

+

Exec specifies the action to take.

+

httpGet

+

io.cci.otc.api.pkg.apis.versioned.cci.v2.HTTPGetAction object

+

HTTPGet specifies the http request to perform.

+
+
+ +
+ + + + + + + + + + + + + + + + + +
Table 102 io.cci.otc.api.pkg.apis.versioned.cci.v2.ContainerPort

Parameter

+

Type

+

Description

+

containerPort

+

Integer

+

Number of port to expose on the pod's IP address. This must be

+

a valid port number, 0 < x < 65536.

+

name

+

String

+

If specified, this must be an IANA_SVC_NAME and unique within

+

the pod. Each named port in a pod must have a unique name. Name for the

+

port that can be referred to by services.

+

protocol

+

String

+

Protocol for port. Must be UDP, TCP, or SCTP. Defaults to "TCP".

+

Possible enum values:

+
  • "SCTP" is the SCTP protocol.
  • "TCP" is the TCP protocol.
  • "UDP" is the UDP protocol.
+
+
+ +
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Table 103 io.cci.otc.api.pkg.apis.versioned.cci.v2.SecurityContext

Parameter

+

Type

+

Description

+

capabilities

+

io.cci.otc.api.pkg.apis.versioned.cci.v2.Capabilities object

+

The capabilities to add/drop when running containers. Defaults

+

to the default set of capabilities granted by the container runtime. Note

+

that this field cannot be set when spec.os.name is windows.

+

procMount

+

String

+

procMount denotes the type of proc mount to use for the containers.

+

The default is DefaultProcMount which uses the container runtime defaults

+

for readonly paths and masked paths. This requires the ProcMountType feature

+

flag to be enabled. Note that this field cannot be set when spec.os.name

+

is windows.

+

readOnlyRootFilesystem

+

Boolean

+

Whether this container has a read-only root filesystem. Default

+

is false. Note that this field cannot be set when spec.os.name is windows.

+

runAsGroup

+

Long

+

The GID to run the entrypoint of the container process. Uses

+

runtime default if unset. May also be set in PodSecurityContext. If set

+

in both SecurityContext and PodSecurityContext, the value specified in SecurityContext

+

takes precedence. Note that this field cannot be set when spec.os.name is

+

windows.

+

runAsNonRoot

+

Boolean

+

Indicates that the container must run as a non-root user. If

+

true, the Kubelet will validate the image at runtime to ensure that it does

+

not run as UID 0 (root) and fail to start the container if it does. If unset

+

or false, no such validation will be performed. May also be set in PodSecurityContext. If

+

set in both SecurityContext and PodSecurityContext, the value specified

+

in SecurityContext takes precedence.

+

runAsUser

+

Long

+

The UID to run the entrypoint of the container process. Defaults

+

to user specified in image metadata if unspecified. May also be set in PodSecurityContext. If

+

set in both SecurityContext and PodSecurityContext, the value specified

+

in SecurityContext takes precedence. Note that this field cannot be set

+

when spec.os.name is windows.

+
+
+ +
+ + + + + + + + + + + + + +
Table 104 io.cci.otc.api.pkg.apis.versioned.cci.v2.Capabilities

Parameter

+

Type

+

Description

+

add

+

Array of strings

+

Added capabilities

+

drop

+

Array of strings

+

Removed capabilities

+
+
+ +
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Table 105 io.cci.otc.api.pkg.apis.versioned.cci.v2.Probe

Parameter

+

Type

+

Description

+

exec

+

io.cci.otc.api.pkg.apis.versioned.cci.v2.ExecAction object

+

Exec specifies the action to take.

+

failureThreshold

+

Integer

+

Minimum consecutive failures for the probe to be considered failed

+

after having succeeded. Defaults to 3. Minimum value is 1.

+

httpGet

+

io.cci.otc.api.pkg.apis.versioned.cci.v2.HTTPGetAction object

+

HTTPGet specifies the http request to perform.

+

initialDelaySeconds

+

Integer

+

Number of seconds after the container has started before liveness probes are initiated. More info: https://kubernetes.io/docs/concepts/workloads/pods/pod-lifecycle#container-probes

+

periodSeconds

+

Integer

+

How often (in seconds) to perform the probe. Default to 10 seconds.

+

Minimum value is 1.

+

successThreshold

+

Integer

+

Minimum consecutive successes for the probe to be considered

+

successful after having failed. Defaults to 1. Must be 1 for liveness and

+

startup. Minimum value is 1.

+

tcpSocket

+

io.cci.otc.api.pkg.apis.versioned.cci.v2.TCPSocketAction object

+

TCPSocket specifies an action involving a TCP port.

+

terminationGracePeriodSeconds

+

Long

+

Optional duration in seconds the pod needs to terminate gracefully

+

upon probe failure. The grace period is the duration in seconds after the

+

processes running in the pod are sent a termination signal and the time

+

when the processes are forcibly halted with a kill signal. Set this value

+

longer than the expected cleanup time for your process. If this value is

+

nil, the pod's terminationGracePeriodSeconds will be used. Otherwise, this

+

value overrides the value provided by the pod spec. Value must be non-negative

+

integer. The value zero indicates stop immediately via the kill signal (no

+

opportunity to shut down). This is a beta field and requires enabling ProbeTerminationGracePeriod

+

feature gate. Minimum value is 1. spec.terminationGracePeriodSeconds is

+

used if unset.

+

timeoutSeconds

+

Integer

+

Number of seconds after which the probe times out. Defaults to 1 second. Minimum value is 1. More info: https://kubernetes.io/docs/concepts/workloads/pods/pod-lifecycle#container-probes

+
+
+ +
+ + + + + + + + + +
Table 106 io.cci.otc.api.pkg.apis.versioned.cci.v2.ExecAction

Parameter

+

Type

+

Description

+

command

+

Array of strings

+

Command is the command line to execute inside the container,

+

the working directory for the command is root ('/') in the container's

+

filesystem. The command is simply exec'd, it is not run inside a shell,

+

so traditional shell instructions ('|', etc) won't work. To use a shell,

+

you need to explicitly call out to that shell. Exit status of 0 is treated

+

as live/healthy and non-zero is unhealthy.

+
+
+ +
+ + + + + + + + + + + + + + + + + + + + + + + + + +
Table 107 io.cci.otc.api.pkg.apis.versioned.cci.v2.HTTPGetAction

Parameter

+

Type

+

Description

+

host

+

String

+

Host name to connect to, defaults to the pod IP. You probably

+

want to set "Host" in httpHeaders instead.

+

httpHeaders

+

Array of io.cci.otc.api.pkg.apis.versioned.cci.v2.HTTPHeader objects

+

Custom headers to set in the request. HTTP allows repeated headers.

+

path

+

String

+

Path to access on the HTTP server.

+

port

+

String

+

Name or number of the port to access on the container. Number

+

must be in the range 1 to 65535. Name must be an IANA_SVC_NAME.

+

scheme

+

String

+

Scheme to use for connecting to the host. Defaults to HTTP.

+

Possible enum values:

+
  • "HTTP" means that the scheme used will be http://
  • "HTTPS" means that the scheme used will be https://
+
+
+ +
+ + + + + + + + + + + + + +
Table 108 io.cci.otc.api.pkg.apis.versioned.cci.v2.HTTPHeader

Parameter

+

Type

+

Description

+

name

+

String

+

The header field name

+

value

+

String

+

The header field value

+
+
+ +
+ + + + + + + + + + + + + +
Table 109 io.cci.otc.api.pkg.apis.versioned.cci.v2.TCPSocketAction

Parameter

+

Type

+

Description

+

host

+

String

+

Optional: Host name to connect to, defaults to the pod IP.

+

port

+

String

+

Number or name of the port to access on the container. Number

+

must be in the range 1 to 65535. Name must be an IANA_SVC_NAME.

+
+
+ +
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Table 110 io.cci.otc.api.pkg.apis.versioned.cci.v2.VolumeMount

Parameter

+

Type

+

Description

+

extendPathMode

+

String

+

Extend the volume path by appending the pod metadata to the path

+

according to specified pattern. which provide a way of directory isolation

+

and help prevent the writing conflict between different pods.

+

mountPath

+

String

+

Path within the container at which the volume should be mounted. Must

+

not contain ':'.

+

name

+

String

+

This must match the Name of a Volume.

+

readOnly

+

Boolean

+

Mounted read-only if true, read-write otherwise (false or unspecified).

+

Defaults to false.

+

subPath

+

String

+

Path within the volume from which the container's volume should

+

be mounted. Defaults to "" (volume's root).

+

subPathExpr

+

String

+

Expanded path within the volume from which the container's volume

+

should be mounted. Behaves similarly to SubPath but environment variable

+

references $(VAR_NAME) are expanded using the container's environment. Defaults

+

to "" (volume's root). SubPathExpr and SubPath are mutually exclusive.

+
+
+ +
+ + + + + + + + + +
Table 111 io.cci.otc.api.pkg.apis.versioned.cci.v2.PodReadinessGate

Parameter

+

Type

+

Description

+

conditionType

+

String

+

ConditionType refers to a condition in the pod's condition list

+

with matching type.

+
+
+ +
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Table 112 io.cci.otc.api.pkg.apis.versioned.cci.v2.PodSecurityContext

Parameter

+

Type

+

Description

+

fsGroup

+

Long

+

A special supplemental group that applies to all containers in a pod. Some volume types allow the Kubelet to change the ownership of that volume to be owned by the pod:

+
  1. The owning GID will be the FSGroup 2. The setgid bit is set (new files created in the volume will be owned by FSGroup) 3. The permission bits are OR'd with rw-rw----
+

If unset, the Kubelet will not modify the ownership and permissions of any volume. Note that this field cannot be set when spec.os.name is windows.

+

fsGroupChangePolicy

+

String

+

fsGroupChangePolicy defines behavior of changing ownership and permission of the volume before being exposed inside Pod. This field will only apply to volume types which support fsGroup based ownership(and permissions). It will have no effect on ephemeral volume types such as: secret, configmaps and emptydir. Valid values are "OnRootMismatch" and "Always". If not specified, "Always" is used. Note that this field cannot be set when spec.os.name is windows.

+

runAsGroup

+

Long

+

The GID to run the entrypoint of the container process. Uses

+

runtime default if unset. May also be set in SecurityContext. If set in

+

both SecurityContext and PodSecurityContext, the value specified in SecurityContext

+

takes precedence for that container. Note that this field cannot be set

+

when spec.os.name is windows.

+

runAsNonRoot

+

Boolean

+

Indicates that the container must run as a non-root user. If

+

true, the Kubelet will validate the image at runtime to ensure that it does

+

not run as UID 0 (root) and fail to start the container if it does. If unset

+

or false, no such validation will be performed. May also be set in SecurityContext. If

+

set in both SecurityContext and PodSecurityContext, the value specified

+

in SecurityContext takes precedence.

+

runAsUser

+

Long

+

The UID to run the entrypoint of the container process. Defaults

+

to user specified in image metadata if unspecified. May also be set in SecurityContext. If

+

set in both SecurityContext and PodSecurityContext, the value specified

+

in SecurityContext takes precedence for that container. Note that this field

+

cannot be set when spec.os.name is windows.

+

supplementalGroups

+

Array of longs

+

A list of groups applied to the first process run in each container,

+

in addition to the container's primary GID. If unspecified, no groups will

+

be added to any container. Note that this field cannot be set when spec.os.name

+

is windows.

+

sysctls

+

Array of io.cci.otc.api.pkg.apis.versioned.cci.v2.Sysctl objects

+

Sysctls hold a list of namespaced sysctls used for the pod. Pods

+

with unsupported sysctls (by the container runtime) might fail to launch.

+

Note that this field cannot be set when spec.os.name is windows.

+
+
+ +
+ + + + + + + + + + + + + +
Table 113 io.cci.otc.api.pkg.apis.versioned.cci.v2.Sysctl

Parameter

+

Type

+

Description

+

name

+

String

+

Name of a property to set

+

value

+

String

+

Value of a property to set

+
+
+ +
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Table 114 io.cci.otc.api.pkg.apis.versioned.cci.v2.TopologySpreadConstraint

Parameter

+

Type

+

Description

+

labelSelector

+

io.k8s.apimachinery.pkg.apis.meta.v1.LabelSelector object

+

LabelSelector is used to find matching pods. Pods that match

+

this label selector are counted to determine the number of pods in their

+

corresponding topology domain.

+

matchLabelKeys

+

Array of strings

+

MatchLabelKeys is a set of pod label keys to select the pods

+

over which spreading will be calculated. The keys are used to lookup values

+

from the incoming pod labels, those key-value labels are ANDed with labelSelector

+

to select the group of existing pods over which spreading will be calculated

+

for the incoming pod. Keys that don't exist in the incoming pod labels will

+

be ignored. A null or empty list means only match against labelSelector.

+

maxSkew

+

Integer

+

MaxSkew describes the degree to which pods may be unevenly distributed. When whenUnsatisfiable=DoNotSchedule, it is the maximum permitted difference between the number of matching pods in the target topology and the global minimum. The global minimum is the minimum number of matching pods in an eligible domain or zero if the number of eligible domains is less than MinDomains. For example, in a 3-zone cluster, MaxSkew is set to 1, and pods with the same labelSelector spread as 2/2/1: In this case, the global minimum is 1. | zone1 | zone2 | zone3 | | P P | P P | P | - if MaxSkew is 1, incoming pod can only be scheduled to zone3 to become 2/2/2; scheduling it onto zone1(zone2) would make the ActualSkew(3-1) on zone1(zone2) violate MaxSkew(1). - if MaxSkew is 2, incoming pod can be scheduled onto any zone. When whenUnsatisfiable=ScheduleAnyway, it is used to give higher precedence to topologies that satisfy it. It's a required field. Default value is 1 and 0 is not allowed.

+

minDomains

+

Integer

+

MinDomains indicates a minimum number of eligible domains. When the number of eligible domains with matching topology keys is less than minDomains, Pod Topology Spread treats "global minimum" as 0, and then the calculation of Skew is performed. And when the number of eligible domains with matching topology keys equals or greater than minDomains, this value has no effect on scheduling. As a result, when the number of eligible domains is less than minDomains, scheduler won't schedule more than maxSkew Pods to those domains. If value is nil, the constraint behaves as if MinDomains is equal to 1. Valid values are integers greater than 0. When value is not nil, WhenUnsatisfiable must be DoNotSchedule.

+

For example, in a 3-zone cluster, MaxSkew is set to 2, MinDomains is set to 5 and pods with the same labelSelector spread as 2/2/2: | zone1 | zone2 | zone3 | | P P | P P | P P | The number of domains is less than 5(MinDomains), so "global minimum" is treated as 0. In this situation, new pod with the same labelSelector cannot be scheduled, because computed skew will be 3(3 - 0) if new Pod is scheduled to any of the three zones, it will violate MaxSkew.

+

This is a beta field and requires the MinDomainsInPodTopologySpread feature gate to be enabled (enabled by default).

+

nodeAffinityPolicy

+

String

+

NodeAffinityPolicy indicates how we will treat Pod's nodeAffinity/nodeSelector when calculating pod topology spread skew. Options are: - Honor: only nodes matching nodeAffinity/nodeSelector are included in the calculations. - Ignore: nodeAffinity/nodeSelector are ignored. All nodes are included in the calculations.

+

If this value is nil, the behavior is equivalent to the Honor policy. This is a alpha-level feature enabled by the NodeInclusionPolicyInPodTopologySpread feature flag.

+

nodeTaintsPolicy

+

String

+

NodeTaintsPolicy indicates how we will treat node taints when calculating pod topology spread skew. Options are: - Honor: nodes without taints, along with tainted nodes for which the incoming pod has a toleration, are included. - Ignore: node taints are ignored. All nodes are included.

+

If this value is nil, the behavior is equivalent to the Ignore policy. This is a alpha-level feature enabled by the NodeInclusionPolicyInPodTopologySpread feature flag.

+

topologyKey

+

String

+

TopologyKey is the key of node labels. Nodes that have a label

+

with this key and identical values are considered to be in the same topology.

+

We consider each <key, value> as a "bucket", and try to put balanced number

+

of pods into each bucket. We define a domain as a particular instance of

+

a topology. Also, we define an eligible domain as a domain whose nodes meet

+

the requirements of nodeAffinityPolicy and nodeTaintsPolicy. e.g. If TopologyKey

+

is "kubernetes.io/hostname", each Node is a domain of that topology. And,

+

if TopologyKey is "topology.kubernetes.io/zone", each zone is a domain of

+

that topology. It's a required field.

+

whenUnsatisfiable

+

String

+

WhenUnsatisfiable indicates how to deal with a pod if it doesn't satisfy the spread constraint. - DoNotSchedule (default) tells the scheduler not to schedule it. - ScheduleAnyway tells the scheduler to schedule the pod in any location,

+

but giving higher precedence to topologies that would help reduce the

+

skew.

+

A constraint is considered "Unsatisfiable" for an incoming pod if and only if every possible node assignment for that pod would violate "MaxSkew" on some topology. For example, in a 3-zone cluster, MaxSkew is set to 1, and pods with the same labelSelector spread as 3/1/1: | zone1 | zone2 | zone3 | | P P P | P | P | If WhenUnsatisfiable is set to DoNotSchedule, incoming pod can only be scheduled to zone2(zone3) to become 3/2/1(3/1/2) as ActualSkew(2-1) on zone2(zone3) satisfies MaxSkew(1). In other words, the cluster can still be imbalanced, but scheduler won't make it more imbalanced. It's a required field.

+

Possible enum values:

+
  • "DoNotSchedule" instructs the scheduler not to schedule the pod when constraints are not satisfied.
  • "ScheduleAnyway" instructs the scheduler to schedule the pod even if constraints are not satisfied.
+
+
+ +
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Table 115 io.cci.otc.api.pkg.apis.versioned.cci.v2.Volume

Parameter

+

Type

+

Description

+

configMap

+

io.cci.otc.api.pkg.apis.versioned.cci.v2.ConfigMapVolumeSource object

+

configMap represents a configMap that should populate this volume

+

downwardAPI

+

io.cci.otc.api.pkg.apis.versioned.cci.v2.DownwardAPIVolumeSource object

+

downwardAPI represents downward API about the pod that should

+

populate this volume

+

emptyDir

+

io.cci.otc.api.pkg.apis.versioned.cci.v2.EmptyDirVolumeSource object

+

emptyDir represents a temporary directory that shares a pod's lifetime. More info: https://kubernetes.io/docs/concepts/storage/volumes#emptydir

+

ephemeral

+

io.cci.otc.api.pkg.apis.versioned.cci.v2.EphemeralVolumeSource object

+

ephemeral represents a volume that is handled by a cluster storage driver. The volume's lifecycle is tied to the pod that defines it - it will be created before the pod starts, and deleted when the pod is removed.

+

Use this if: a) the volume is only needed while the pod runs, b) features of normal volumes like restoring from snapshot or capacity

+

tracking are needed,

+

c) the storage driver is specified through a storage class, and d) the storage driver supports dynamic volume provisioning through

+

a PersistentVolumeClaim (see EphemeralVolumeSource for more

+

information on the connection between this volume type

+

and PersistentVolumeClaim).

+

Use PersistentVolumeClaim or one of the vendor-specific APIs for volumes that persist for longer than the lifecycle of an individual pod.

+

Use CSI for light-weight local ephemeral volumes if the CSI driver is meant to be used that way - see the documentation of the driver for more information.

+

A pod can use both types of ephemeral volumes and persistent volumes at the same time.

+

name

+

String

+

name of the volume. Must be a DNS_LABEL and unique within the pod. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names

+

nfs

+

io.cci.otc.api.pkg.apis.versioned.cci.v2.NFSVolumeSource object

+

nfs represents an NFS mount on the host that shares a pod's lifetime More info: https://kubernetes.io/docs/concepts/storage/volumes#nfs

+

persistentVolumeClaim

+

io.cci.otc.api.pkg.apis.versioned.cci.v2.PersistentVolumeClaimVolumeSource object

+

persistentVolumeClaimVolumeSource represents a reference to a PersistentVolumeClaim in the same namespace. More info: https://kubernetes.io/docs/concepts/storage/persistent-volumes#persistentvolumeclaims

+

projected

+

io.cci.otc.api.pkg.apis.versioned.cci.v2.ProjectedVolumeSource object

+

projected items for all in one resources secrets, configmaps,

+

and downward API

+

secret

+

io.cci.otc.api.pkg.apis.versioned.cci.v2.SecretVolumeSource object

+

secret represents a secret that should populate this volume. More info: https://kubernetes.io/docs/concepts/storage/volumes#secret

+
+
+ +
+ + + + + + + + + + + + + + + + + + + + + +
Table 116 io.cci.otc.api.pkg.apis.versioned.cci.v2.ConfigMapVolumeSource

Parameter

+

Type

+

Description

+

defaultMode

+

Integer

+

defaultMode is optional: mode bits used to set permissions on created files by default. Must be an octal value between 0000 and 0777 or a decimal value between 0 and 511. YAML accepts both octal and decimal values, JSON requires decimal values for mode bits. Defaults to 0644. Directories within the path are not affected by this setting. This might be in conflict with other options that affect the file mode, like fsGroup, and the result can be other mode bits set.

+

items

+

Array of io.cci.otc.api.pkg.apis.versioned.cci.v2.KeyToPath objects

+

items if unspecified, each key-value pair in the Data field of

+

the referenced ConfigMap will be projected into the volume as a file whose

+

name is the key and content is the value. If specified, the listed keys

+

will be projected into the specified paths, and unlisted keys will not be

+

present. If a key is specified which is not present in the ConfigMap, the

+

volume setup will error unless it is marked optional. Paths must be relative

+

and may not contain the '..' path or start with '..'.

+

name

+

String

+

Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names

+

optional

+

Boolean

+

optional specify whether the ConfigMap or its keys must be defined

+
+
+ +
+ + + + + + + + + + + + + +
Table 117 io.cci.otc.api.pkg.apis.versioned.cci.v2.DownwardAPIVolumeSource

Parameter

+

Type

+

Description

+

defaultMode

+

Integer

+

Optional: mode bits to use on created files by default. Must be a Optional: mode bits used to set permissions on created files by default. Must be an octal value between 0000 and 0777 or a decimal value between 0 and 511. YAML accepts both octal and decimal values, JSON requires decimal values for mode bits. Defaults to 0644. Directories within the path are not affected by this setting. This might be in conflict with other options that affect the file mode, like fsGroup, and the result can be other mode bits set.

+

items

+

Array of io.cci.otc.api.pkg.apis.versioned.cci.v2.DownwardAPIVolumeFile objects

+

Items is a list of downward API volume file

+
+
+ +
+ + + + + + + + + + + + + +
Table 118 io.cci.otc.api.pkg.apis.versioned.cci.v2.EmptyDirVolumeSource

Parameter

+

Type

+

Description

+

medium

+

String

+

medium represents what type of storage medium should back this directory. The default is "" which means to use the node's default medium. Must be an empty string (default) or Memory. More info: https://kubernetes.io/docs/concepts/storage/volumes#emptydir

+

sizeLimit

+

String

+

sizeLimit is the total amount of local storage required for this EmptyDir volume. The size limit is also applicable for memory medium. The maximum usage on memory medium EmptyDir would be the minimum value between the SizeLimit specified here and the sum of memory limits of all containers in a pod. The default is nil which means that the limit is undefined. More info: http://kubernetes.io/docs/user-guide/volumes#emptydir

+
+
+ +
+ + + + + + + + + +
Table 119 io.cci.otc.api.pkg.apis.versioned.cci.v2.EphemeralVolumeSource

Parameter

+

Type

+

Description

+

volumeClaimTemplate

+

io.cci.otc.api.pkg.apis.versioned.cci.v2.PersistentVolumeClaimTemplate object

+

Will be used to create a stand-alone PVC to provision the volume. The pod in which this EphemeralVolumeSource is embedded will be the owner of the PVC, i.e. the PVC will be deleted together with the pod. The name of the PVC will be <pod name>-<volume name> where <volume name> is the name from the PodSpec.Volumes array entry. Pod validation will reject the pod if the concatenated name is not valid for a PVC (for example, too long).

+

An existing PVC with that name that is not owned by the pod will not be used for the pod to avoid using an unrelated volume by mistake. Starting the pod is then blocked until the unrelated PVC is removed. If such a pre-created PVC is meant to be used by the pod, the PVC has to updated with an owner reference to the pod once the pod exists. Normally this should not be necessary, but it may be useful when manually reconstructing a broken cluster.

+

This field is read-only and no changes will be made by Kubernetes to the PVC after it has been created.

+

Required, must not be nil.

+
+
+ +
+ + + + + + + + + + + + + +
Table 120 io.cci.otc.api.pkg.apis.versioned.cci.v2.PersistentVolumeClaimTemplate

Parameter

+

Type

+

Description

+

metadata

+

io.k8s.apimachinery.pkg.apis.meta.v1.ObjectMeta object

+

May contain labels and annotations that will be copied into the

+

PVC when creating it. No other fields are allowed and will be rejected during

+

validation.

+

spec

+

io.cci.otc.api.pkg.apis.versioned.cci.v2.PersistentVolumeClaimSpec object

+

The specification for the PersistentVolumeClaim. The entire content

+

is copied unchanged into the PVC that gets created from this template. The

+

same fields as in a PersistentVolumeClaim are also valid here.

+
+
+ +
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Table 121 io.k8s.apimachinery.pkg.apis.meta.v1.ObjectMeta

Parameter

+

Type

+

Description

+

annotations

+

Map<String,String>

+

Annotations is an unstructured key value map stored with a resource that may be set by external tools to store and retrieve arbitrary metadata. They are not queryable and should be preserved when modifying objects. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/annotations/

+

clusterName

+

String

+

The name of the cluster which the object belongs to. This is

+

used to distinguish resources with same name and namespace in different

+

clusters. This field is not set anywhere right now and apiserver is going

+

to ignore it if set in create or update request.

+

creationTimestamp

+

String

+

CreationTimestamp is a timestamp representing the server time when this object was created. It is not guaranteed to be set in happens-before order across separate operations. Clients may not set this value. It is represented in RFC3339 form and is in UTC.

+

Populated by the system. Read-only. Null for lists. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata

+

deletionGracePeriodSeconds

+

Long

+

Number of seconds allowed for this object to gracefully terminate

+

before it will be removed from the system. Only set when deletionTimestamp

+

is also set. May only be shortened. Read-only.

+

deletionTimestamp

+

String

+

DeletionTimestamp is RFC 3339 date and time at which this resource will be deleted. This field is set by the server when a graceful deletion is requested by the user, and is not directly settable by a client. The resource is expected to be deleted (no longer visible from resource lists, and not reachable by name) after the time in this field, once the finalizers list is empty. As long as the finalizers list contains items, deletion is blocked. Once the deletionTimestamp is set, this value may not be unset or be set further into the future, although it may be shortened or the resource may be deleted prior to this time. For example, a user may request that a pod is deleted in 30 seconds. The Kubelet will react by sending a graceful termination signal to the containers in the pod. After that 30 seconds, the Kubelet will send a hard termination signal (SIGKILL) to the container and after cleanup, remove the pod from the API. In the presence of network partitions, this object may still exist after this timestamp, until an administrator or automated process can determine the resource is fully terminated. If not set, graceful deletion of the object has not been requested.

+

Populated by the system when a graceful deletion is requested. Read-only. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata

+

enable

+

Boolean

+

Enable identifies whether the resource is available

+

finalizers

+

Array of strings

+

Must be empty before the object is deleted from the registry.

+

Each entry is an identifier for the responsible component that will remove

+

the entry from the list. If the deletionTimestamp of the object is non-nil,

+

entries in this list can only be removed. Finalizers may be processed and

+

removed in any order. Order is NOT enforced because it introduces significant

+

risk of stuck finalizers. finalizers is a shared field, any actor with permission

+

can reorder it. If the finalizer list is processed in order, then this can

+

lead to a situation in which the component responsible for the first finalizer

+

in the list is waiting for a signal (field value, external system, or other)

+

produced by a component responsible for a finalizer later in the list, resulting

+

in a deadlock. Without enforced ordering finalizers are free to order amongst

+

themselves and are not vulnerable to ordering changes in the list.

+

generateName

+

String

+

GenerateName is an optional prefix, used by the server, to generate a unique name ONLY IF the Name field has not been provided. If this field is used, the name returned to the client will be different than the name passed. This value will also be combined with a unique suffix. The provided value has the same validation rules as the Name field, and may be truncated by the length of the suffix required to make the value unique on the server.

+

If this field is specified and the generated name exists, the server will NOT return a 409 - instead, it will either return 201 Created or 500 with Reason ServerTimeout indicating a unique name could not be found in the time allotted, and the client should retry (optionally after the time indicated in the Retry-After header).

+

Applied only if Name is not specified. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#idempotency

+

generation

+

Long

+

A sequence number representing a specific generation of the desired

+

state. Populated by the system. Read-only.

+

labels

+

Map<String,String>

+

Map of string keys and values that can be used to organize and categorize (scope and select) objects. May match selectors of replication controllers and services. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/labels/

+

managedFields

+

Array of io.k8s.apimachinery.pkg.apis.meta.v1.ManagedFieldsEntry objects

+

ManagedFields maps workflow-id and version to the set of fields

+

that are managed by that workflow. This is mostly for internal housekeeping,

+

and users typically shouldn't need to set or understand this field. A workflow

+

can be the user's name, a controller's name, or the name of a specific apply

+

path like "ci-cd". The set of fields is always in the version that the workflow

+

used when modifying the object.

+

name

+

String

+

Name must be unique within a namespace. Is required when creating resources, although some resources may allow a client to request the generation of an appropriate name automatically. Name is primarily intended for creation idempotence and configuration definition. Cannot be updated. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names

+

namespace

+

String

+

Namespace defines the space within which each name must be unique. An empty namespace is equivalent to the "default" namespace, but "default" is the canonical representation. Not all objects are required to be scoped to a namespace - the value of this field for those objects will be empty.

+

Must be a DNS_LABEL. Cannot be updated. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/namespaces/

+

ownerReferences

+

Array of io.k8s.apimachinery.pkg.apis.meta.v1.OwnerReference objects

+

List of objects depended by this object. If ALL objects in the

+

list have been deleted, this object will be garbage collected. If this object

+

is managed by a controller, then an entry in this list will point to this

+

controller, with the controller field set to true. There cannot be more

+

than one managing controller.

+

resourceVersion

+

String

+

An opaque value that represents the internal version of this object that can be used by clients to determine when objects have changed. May be used for optimistic concurrency, change detection, and the watch operation on a resource or set of resources. Clients must treat these values as opaque and passed unmodified back to the server. They may only be valid for a particular resource or set of resources.

+

Populated by the system. Read-only. Value must be treated as opaque by clients and . More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#concurrency-control-and-consistency

+

selfLink

+

String

+

SelfLink is a URL representing this object. Populated by the system. Read-only.

+

DEPRECATED Kubernetes will stop propagating this field in 1.20 release and the field is planned to be removed in 1.21 release.

+

uid

+

String

+

UID is the unique in time and space value for this object. It is typically generated by the server on successful creation of a resource and is not allowed to change on PUT operations.

+

Populated by the system. Read-only. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#uids

+
+
+ +
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Table 122 io.k8s.apimachinery.pkg.apis.meta.v1.ManagedFieldsEntry

Parameter

+

Type

+

Description

+

apiVersion

+

String

+

APIVersion defines the version of this resource that this field

+

set applies to. The format is "group/version" just like the top-level APIVersion

+

field. It is necessary to track the version of a field set because it cannot

+

be automatically converted.

+

fieldsType

+

String

+

FieldsType is the discriminator for the different fields format and version. There is currently only one possible value: "FieldsV1"

+

fieldsV1

+

Object

+

FieldsV1 holds the first JSON version format as described in

+

the "FieldsV1" type.

+

manager

+

String

+

Manager is an identifier of the workflow managing these fields.

+

operation

+

String

+

Operation is the type of operation which lead to this ManagedFieldsEntry

+

being created. The only valid values for this field are 'Apply' and 'Update'.

+

time

+

String

+

Time is timestamp of when these fields were set. It should always

+

be empty if Operation is 'Apply'

+
+
+ +
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Table 123 io.k8s.apimachinery.pkg.apis.meta.v1.OwnerReference

Parameter

+

Type

+

Description

+

apiVersion

+

String

+

API version of the referent.

+

blockOwnerDeletion

+

Boolean

+

If true, AND if the owner has the "foregroundDeletion" finalizer,

+

then the owner cannot be deleted from the key-value store until this reference

+

is removed. Defaults to false. To set this field, a user needs "delete"

+

permission of the owner, otherwise 422 (Unprocessable Entity) will be returned.

+

controller

+

Boolean

+

If true, this reference points to the managing controller.

+

kind

+

String

+

Kind of the referent. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds

+

name

+

String

+

Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names

+

uid

+

String

+

UID of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#uids

+
+
+ +
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Table 124 io.cci.otc.api.pkg.apis.versioned.cci.v2.PersistentVolumeClaimSpec

Parameter

+

Type

+

Description

+

accessModes

+

Array of strings

+

accessModes contains the desired access modes the volume should have. More info: https://kubernetes.io/docs/concepts/storage/persistent-volumes#access-modes-1

+

dataSource

+

io.cci.otc.api.pkg.apis.versioned.cci.v2.TypedLocalObjectReference object

+

dataSource field can be used to specify either: * An existing VolumeSnapshot object (snapshot.storage.k8s.io/VolumeSnapshot) * An existing PVC (PersistentVolumeClaim) If the provisioner or an external controller can support the specified data source, it will create a new volume based on the contents of the specified data source. If the AnyVolumeDataSource feature gate is enabled, this field will always have the same contents as the DataSourceRef field.

+

dataSourceRef

+

io.cci.otc.api.pkg.apis.versioned.cci.v2.TypedLocalObjectReference object

+

dataSourceRef specifies the object from which to populate the volume with data, if a non-empty volume is desired. This may be any local object from a non-empty API group (non core object) or a PersistentVolumeClaim object. When this field is specified, volume binding will only succeed if the type of the specified object matches some installed volume populator or dynamic provisioner. This field will replace the functionality of the DataSource field and as such if both fields are non-empty, they must have the same value. For backwards compatibility, both fields (DataSource and DataSourceRef) will be set to the same value automatically if one of them is empty and the other is non-empty. There are two important differences between DataSource and DataSourceRef: * While DataSource only allows two specific types of objects, DataSourceRef

+

allows any non-core object, as well as PersistentVolumeClaim objects.

+
  • While DataSource ignores disallowed values (dropping them), DataSourceRef

    preserves all values, and generates an error if a disallowed value is

    +

    specified.

    +

    (Beta) Using this field requires the AnyVolumeDataSource feature gate to be enabled.

    +
+

resources

+

io.cci.otc.api.pkg.apis.versioned.cci.v2.ResourceRequirements object

+

resources represents the minimum resources the volume should have. If RecoverVolumeExpansionFailure feature is enabled users are allowed to specify resource requirements that are lower than previous value but must still be higher than capacity recorded in the status field of the claim. More info: https://kubernetes.io/docs/concepts/storage/persistent-volumes#resources

+

selector

+

io.k8s.apimachinery.pkg.apis.meta.v1.LabelSelector object

+

selector is a label query over volumes to consider for binding.

+

storageClassName

+

String

+

storageClassName is the name of the StorageClass required by the claim. More info: https://kubernetes.io/docs/concepts/storage/persistent-volumes#class-1

+

volumeMode

+

String

+

volumeMode defines what type of volume is required by the claim.

+

Value of Filesystem is implied when not included in claim spec.

+

volumeName

+

String

+

volumeName is the binding reference to the PersistentVolume backing

+

this claim.

+
+
+ +
+ + + + + + + + + + + + + + + + + +
Table 125 io.cci.otc.api.pkg.apis.versioned.cci.v2.TypedLocalObjectReference

Parameter

+

Type

+

Description

+

apiGroup

+

String

+

APIGroup is the group for the resource being referenced. If APIGroup

+

is not specified, the specified Kind must be in the core API group. For

+

any other third-party types, APIGroup is required.

+

kind

+

String

+

Kind is the type of resource being referenced

+

name

+

String

+

Name is the name of resource being referenced

+
+
+ +
+ + + + + + + + + + + + + +
Table 126 io.cci.otc.api.pkg.apis.versioned.cci.v2.ResourceRequirements

Parameter

+

Type

+

Description

+

limits

+

Map<String,String>

+

Limits describes the maximum amount of compute resources allowed. More info: https://kubernetes.io/docs/concepts/configuration/manage-resources-containers/

+

requests

+

Map<String,String>

+

Requests describes the minimum amount of compute resources required. If Requests is omitted for a container, it defaults to Limits if that is explicitly specified, otherwise to an implementation-defined value. More info: https://kubernetes.io/docs/concepts/configuration/manage-resources-containers/

+
+
+ +
+ + + + + + + + + +
Table 127 io.k8s.apimachinery.pkg.api.resource.Quantity

Parameter

+

Type

+

Description

+

-

+

String

+

Quantity is a fixed-point representation of a number. It provides convenient marshaling/unmarshaling in JSON and YAML, in addition to String() and AsInt64() accessors.

+

The serialization format is:

+

[/topic/body/section/table/tgroup/tbody/row/entry/p/br {""}) (br] ::= [/topic/body/section/table/tgroup/tbody/row/entry/p/br {""}) (br][/topic/body/section/table/tgroup/tbody/row/entry/p/br {""}) (br]

+

(Note that [/topic/body/section/table/tgroup/tbody/row/entry/p/br {""}) (br] may be empty, from the "" case in [/topic/body/section/table/tgroup/tbody/row/entry/p/br {""}) (br].)

+

[/topic/body/section/table/tgroup/tbody/row/entry/p/br {""}) (br] ::= 0 | 1 | ... | 9 [/topic/body/section/table/tgroup/tbody/row/entry/p/br {""}) (br] ::= [/topic/body/section/table/tgroup/tbody/row/entry/p/br {""}) (br] | [/topic/body/section/table/tgroup/tbody/row/entry/p/br {""}) (br][/topic/body/section/table/tgroup/tbody/row/entry/p/br {""}) (br] [/topic/body/section/table/tgroup/tbody/row/entry/p/br {""}) (br] ::= [/topic/body/section/table/tgroup/tbody/row/entry/p/br {""}) (br] | [/topic/body/section/table/tgroup/tbody/row/entry/p/br {""}) (br].[/topic/body/section/table/tgroup/tbody/row/entry/p/br {""}) (br] | [/topic/body/section/table/tgroup/tbody/row/entry/p/br {""}) (br]. | .[/topic/body/section/table/tgroup/tbody/row/entry/p/br {""}) (br] [/topic/body/section/table/tgroup/tbody/row/entry/p/br {""}) (br] ::= "+" | "-" [/topic/body/section/table/tgroup/tbody/row/entry/p/br {""}) (br] ::= [/topic/body/section/table/tgroup/tbody/row/entry/p/br {""}) (br] | [/topic/body/section/table/tgroup/tbody/row/entry/p/br {""}) (br][/topic/body/section/table/tgroup/tbody/row/entry/p/br {""}) (br] [/topic/body/section/table/tgroup/tbody/row/entry/p/br {""}) (br] ::= [/topic/body/section/table/tgroup/tbody/row/entry/p/br {""}) (br] | [/topic/body/section/table/tgroup/tbody/row/entry/p/br {""}) (br] | [/topic/body/section/table/tgroup/tbody/row/entry/p/br {""}) (br] [/topic/body/section/table/tgroup/tbody/row/entry/p/br {""}) (br] ::= Ki | Mi | Gi | Ti | Pi | Ei

+

(International System of units; See: http://physics.nist.gov/cuu/Units/binary.html)

+

[/topic/body/section/table/tgroup/tbody/row/entry/p/br {""}) (br] ::= m | "" | k | M | G | T | P | E

+

(Note that 1024 = 1Ki but 1000 = 1k; I didn't choose the capitalization.)

+

[/topic/body/section/table/tgroup/tbody/row/entry/p/br {""}) (br] ::= "e" [/topic/body/section/table/tgroup/tbody/row/entry/p/br {""}) (br] | "E" [/topic/body/section/table/tgroup/tbody/row/entry/p/br {""}) (br]

+

No matter which of the three exponent forms is used, no quantity may represent a number greater than 2^63-1 in magnitude, nor may it have more than 3 decimal places. Numbers larger or more precise will be capped or rounded up. (E.g.: 0.1m will rounded up to 1m.) This may be extended in the future if we require larger or smaller quantities.

+

When a Quantity is parsed from a string, it will remember the type of suffix it had, and will use the same type again when it is serialized.

+

Before serializing, Quantity will be put in "canonical form". This means that Exponent/suffix will be adjusted up or down (with a corresponding increase or decrease in Mantissa) such that:

+

a. No precision is lost

+

b. No fractional digits will be emitted

+

c. The exponent (or suffix) is as large as possible.

+

The sign will be omitted unless the number is negative.

+

Examples:

+

1.5 will be serialized as "1500m"

+

1.5Gi will be serialized as "1536Mi"

+

Note that the quantity will NEVER be internally represented by a floating point number. That is the whole point of this exercise.

+

Non-canonical values will still parse as long as they are well formed, but will be re-emitted in their canonical form. (So always use canonical form, or don't diff.)

+

This format is intended to make it difficult to use these numbers without writing some sort of special handling code in the hopes that that will cause implementors to also use a fixed point implementation.

+
+
+ +
+ + + + + + + + + + + + + +
Table 128 io.k8s.apimachinery.pkg.apis.meta.v1.LabelSelector

Parameter

+

Type

+

Description

+

matchExpressions

+

Array of io.k8s.apimachinery.pkg.apis.meta.v1.LabelSelectorRequirement objects

+

matchExpressions is a list of label selector requirements. The

+

requirements are ANDed.

+

matchLabels

+

Map<String,String>

+

matchLabels is a map of {key,value} pairs. A single {key,value}

+

in the matchLabels map is equivalent to an element of matchExpressions,

+

whose key field is "key", the operator is "In", and the values array contains

+

only "value". The requirements are ANDed.

+
+
+ +
+ + + + + + + + + + + + + + + + + +
Table 129 io.k8s.apimachinery.pkg.apis.meta.v1.LabelSelectorRequirement

Parameter

+

Type

+

Description

+

key

+

String

+

key is the label key that the selector applies to.

+

operator

+

String

+

operator represents a key's relationship to a set of values.

+

Valid operators are In, NotIn, Exists and DoesNotExist.

+

values

+

Array of strings

+

values is an array of string values. If the operator is In or

+

NotIn, the values array must be non-empty. If the operator is Exists or

+

DoesNotExist, the values array must be empty. This array is replaced during

+

a strategic merge patch.

+
+
+ +
+ + + + + + + + + + + + + + + + + +
Table 130 io.cci.otc.api.pkg.apis.versioned.cci.v2.NFSVolumeSource

Parameter

+

Type

+

Description

+

path

+

String

+

path that is exported by the NFS server. More info: https://kubernetes.io/docs/concepts/storage/volumes#nfs

+

readOnly

+

Boolean

+

readOnly here will force the NFS export to be mounted with read-only permissions. Defaults to false. More info: https://kubernetes.io/docs/concepts/storage/volumes#nfs

+

server

+

String

+

server is the hostname or IP address of the NFS server. More info: https://kubernetes.io/docs/concepts/storage/volumes#nfs

+
+
+ +
+ + + + + + + + + + + + + +
Table 131 io.cci.otc.api.pkg.apis.versioned.cci.v2.PersistentVolumeClaimVolumeSource

Parameter

+

Type

+

Description

+

claimName

+

String

+

claimName is the name of a PersistentVolumeClaim in the same namespace as the pod using this volume. More info: https://kubernetes.io/docs/concepts/storage/persistent-volumes#persistentvolumeclaims

+

readOnly

+

Boolean

+

readOnly Will force the ReadOnly setting in VolumeMounts. Default

+

false.

+
+
+ +
+ + + + + + + + + + + + + +
Table 132 io.cci.otc.api.pkg.apis.versioned.cci.v2.ProjectedVolumeSource

Parameter

+

Type

+

Description

+

defaultMode

+

Integer

+

defaultMode are the mode bits used to set permissions on created

+

files by default. Must be an octal value between 0000 and 0777 or a decimal

+

value between 0 and 511. YAML accepts both octal and decimal values, JSON

+

requires decimal values for mode bits. Directories within the path are not

+

affected by this setting. This might be in conflict with other options that

+

affect the file mode, like fsGroup, and the result can be other mode bits

+

set.

+

sources

+

Array of io.cci.otc.api.pkg.apis.versioned.cci.v2.VolumeProjection objects

+

sources is the list of volume projections

+
+
+ +
+ + + + + + + + + + + + + + + + + +
Table 133 io.cci.otc.api.pkg.apis.versioned.cci.v2.VolumeProjection

Parameter

+

Type

+

Description

+

configMap

+

io.cci.otc.api.pkg.apis.versioned.cci.v2.ConfigMapProjection object

+

configMap information about the configMap data to project

+

downwardAPI

+

io.cci.otc.api.pkg.apis.versioned.cci.v2.DownwardAPIProjection object

+

downwardAPI information about the downwardAPI data to project

+

secret

+

io.cci.otc.api.pkg.apis.versioned.cci.v2.SecretProjection object

+

secret information about the secret data to project

+
+
+ +
+ + + + + + + + + + + + + + + + + +
Table 134 io.cci.otc.api.pkg.apis.versioned.cci.v2.ConfigMapProjection

Parameter

+

Type

+

Description

+

items

+

Array of io.cci.otc.api.pkg.apis.versioned.cci.v2.KeyToPath objects

+

items if unspecified, each key-value pair in the Data field of

+

the referenced ConfigMap will be projected into the volume as a file whose

+

name is the key and content is the value. If specified, the listed keys

+

will be projected into the specified paths, and unlisted keys will not be

+

present. If a key is specified which is not present in the ConfigMap, the

+

volume setup will error unless it is marked optional. Paths must be relative

+

and may not contain the '..' path or start with '..'.

+

name

+

String

+

Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names

+

optional

+

Boolean

+

optional specify whether the ConfigMap or its keys must be defined

+
+
+ +
+ + + + + + + + + +
Table 135 io.cci.otc.api.pkg.apis.versioned.cci.v2.DownwardAPIProjection

Parameter

+

Type

+

Description

+

items

+

Array of io.cci.otc.api.pkg.apis.versioned.cci.v2.DownwardAPIVolumeFile objects

+

Items is a list of DownwardAPIVolume file

+
+
+ +
+ + + + + + + + + + + + + + + + + + + + + +
Table 136 io.cci.otc.api.pkg.apis.versioned.cci.v2.DownwardAPIVolumeFile

Parameter

+

Type

+

Description

+

fieldRef

+

io.cci.otc.api.pkg.apis.versioned.cci.v2.ObjectFieldSelector object

+

Required: Selects a field of the pod: only annotations, labels, name and namespace are supported.

+

mode

+

Integer

+

Optional: mode bits used to set permissions on this file, must be an octal value between 0000 and 0777 or a decimal value between 0 and 511. YAML accepts both octal and decimal values, JSON requires decimal values for mode bits. If not specified, the volume defaultMode will be used. This might be in conflict with other options that affect the file mode, like fsGroup, and the result can be other mode bits set.

+

path

+

String

+

Required: Path is the relative path name of the file to be created. Must not be absolute or contain the '..' path. Must be utf-8 encoded. The first item of the relative path must not start with '..'

+

resourceFieldRef

+

io.cci.otc.api.pkg.apis.versioned.cci.v2.ResourceFieldSelector object

+

Selects a resource of the container: only resources limits and requests (limits.cpu, limits.memory, requests.cpu and requests.memory) are currently supported.

+
+
+ +
+ + + + + + + + + + + + + +
Table 137 io.cci.otc.api.pkg.apis.versioned.cci.v2.ObjectFieldSelector

Parameter

+

Type

+

Description

+

apiVersion

+

String

+

Version of the schema the FieldPath is written in terms of, defaults

+

to "v1".

+

fieldPath

+

String

+

Path of the field to select in the specified API version.

+
+
+ +
+ + + + + + + + + + + + + + + + + +
Table 138 io.cci.otc.api.pkg.apis.versioned.cci.v2.ResourceFieldSelector

Parameter

+

Type

+

Description

+

containerName

+

String

+

Container name: required for volumes, optional for env vars

+

divisor

+

String

+

Specifies the output format of the exposed resources, defaults

+

to "1"

+

resource

+

String

+

Required: resource to select

+
+
+ +
+ + + + + + + + + + + + + + + + + +
Table 139 io.cci.otc.api.pkg.apis.versioned.cci.v2.SecretProjection

Parameter

+

Type

+

Description

+

items

+

Array of io.cci.otc.api.pkg.apis.versioned.cci.v2.KeyToPath objects

+

items if unspecified, each key-value pair in the Data field of

+

the referenced Secret will be projected into the volume as a file whose

+

name is the key and content is the value. If specified, the listed keys

+

will be projected into the specified paths, and unlisted keys will not be

+

present. If a key is specified which is not present in the Secret, the volume

+

setup will error unless it is marked optional. Paths must be relative and

+

may not contain the '..' path or start with '..'.

+

name

+

String

+

Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names

+

optional

+

Boolean

+

optional field specify whether the Secret or its key must be

+

defined

+
+
+ +
+ + + + + + + + + + + + + + + + + + + + + +
Table 140 io.cci.otc.api.pkg.apis.versioned.cci.v2.SecretVolumeSource

Parameter

+

Type

+

Description

+

defaultMode

+

Integer

+

defaultMode is Optional: mode bits used to set permissions on created files by default. Must be an octal value between 0000 and 0777 or a decimal value between 0 and 511. YAML accepts both octal and decimal values, JSON requires decimal values for mode bits. Defaults to 0644. Directories within the path are not affected by this setting. This might be in conflict with other options that affect the file mode, like fsGroup, and the result can be other mode bits set.

+

items

+

Array of io.cci.otc.api.pkg.apis.versioned.cci.v2.KeyToPath objects

+

items If unspecified, each key-value pair in the Data field of

+

the referenced Secret will be projected into the volume as a file whose

+

name is the key and content is the value. If specified, the listed keys

+

will be projected into the specified paths, and unlisted keys will not be

+

present. If a key is specified which is not present in the Secret, the volume

+

setup will error unless it is marked optional. Paths must be relative and

+

may not contain the '..' path or start with '..'.

+

optional

+

Boolean

+

optional field specify whether the Secret or its keys must be

+

defined

+

secretName

+

String

+

secretName is the name of the secret in the pod's namespace to use. More info: https://kubernetes.io/docs/concepts/storage/volumes#secret

+
+
+ +
+ + + + + + + + + + + + + + + + + +
Table 141 io.cci.otc.api.pkg.apis.versioned.cci.v2.KeyToPath

Parameter

+

Type

+

Description

+

key

+

String

+

key is the key to project.

+

mode

+

Integer

+

mode is Optional: mode bits used to set permissions on this file. Must be an octal value between 0000 and 0777 or a decimal value between 0 and 511. YAML accepts both octal and decimal values, JSON requires decimal values for mode bits. If not specified, the volume defaultMode will be used. This might be in conflict with other options that affect the file mode, like fsGroup, and the result can be other mode bits set.

+

path

+

String

+

path is the relative path of the file to map the key to. May

+

not be an absolute path. May not contain the path element '..'. May not

+

start with the string '..'.

+
+
+ +
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Table 142 io.cci.otc.api.pkg.apis.versioned.cci.v2.PodStatus

Parameter

+

Type

+

Description

+

conditions

+

Array of io.cci.otc.api.pkg.apis.versioned.cci.v2.PodCondition objects

+

Current service state of pod. More info: https://kubernetes.io/docs/concepts/workloads/pods/pod-lifecycle#pod-conditions

+

containerStatuses

+

Array of io.cci.otc.api.pkg.apis.versioned.cci.v2.ContainerStatus objects

+

The list has one entry per container in the manifest. More info: https://kubernetes.io/docs/concepts/workloads/pods/pod-lifecycle#pod-and-container-status

+

ephemeralContainerStatuses

+

Array of io.cci.otc.api.pkg.apis.versioned.cci.v2.ContainerStatus objects

+

Status for any ephemeral containers that have run in this pod.

+

hostIP

+

String

+

IP address of the host to which the pod is assigned. Empty if

+

not yet scheduled.

+

initContainerStatuses

+

Array of io.cci.otc.api.pkg.apis.versioned.cci.v2.ContainerStatus objects

+

The list has one entry per init container in the manifest. The most recent successful init container will have ready = true, the most recently started container will have startTime set. More info: https://kubernetes.io/docs/concepts/workloads/pods/pod-lifecycle#pod-and-container-status

+

message

+

String

+

A human readable message indicating details about why the pod

+

is in this condition.

+

nominatedNodeName

+

String

+

nominatedNodeName is set only when this pod preempts other pods

+

on the node, but it cannot be scheduled right away as preemption victims

+

receive their graceful termination periods. This field does not guarantee

+

that the pod will be scheduled on this node. Scheduler may decide to place

+

the pod elsewhere if other nodes become available sooner. Scheduler may

+

also decide to give the resources on this node to a higher priority pod

+

that is created after preemption. As a result, this field may be different

+

than PodSpec.nodeName when the pod is scheduled.

+

phase

+

String

+

The phase of a Pod is a simple, high-level summary of where the Pod is in its lifecycle. The conditions array, the reason and message fields, and the individual container status arrays contain more detail about the pod's status. There are five possible phase values:

+

Pending: The pod has been accepted by the Kubernetes system, but one or more of the container images has not been created. This includes time before being scheduled as well as time spent downloading images over the network, which could take a while. Running: The pod has been bound to a node, and all of the containers have been created. At least one container is still running, or is in the process of starting or restarting. Succeeded: All containers in the pod have terminated in success, and will not be restarted. Failed: All containers in the pod have terminated, and at least one container has terminated in failure. The container either exited with non-zero status or was terminated by the system. Unknown: For some reason the state of the pod could not be obtained, typically due to an error in communicating with the host of the pod.

+

More info: https://kubernetes.io/docs/concepts/workloads/pods/pod-lifecycle#pod-phase

+

Possible enum values:

+
  • "Failed" means that all containers in the pod have terminated, and at least one container has terminated in a failure (exited with a non-zero exit code or was stopped by the system).
  • "Pending" means the pod has been accepted by the system, but one or more of the containers has not been started. This includes time before being bound to a node, as well as time spent pulling images onto the host.
  • "Running" means the pod has been bound to a node and all of the containers have been started. At least one container is still running or is in the process of being restarted.
  • "Succeeded" means that all containers in the pod have voluntarily terminated with a container exit code of 0, and the system is not going to restart any of these containers.
  • "Unknown" means that for some reason the state of the pod could not be obtained, typically due to an error in communicating with the host of the pod. Deprecated: It isn't being set since 2015 (74da3b14b0c0f658b3bb8d2def5094686d0e9095)
+

podIP

+

String

+

IP address allocated to the pod. Routable at least within the

+

cluster. Empty if not yet allocated.

+

podIPs

+

Array of io.cci.otc.api.pkg.apis.versioned.cci.v2.PodIP objects

+

podIPs holds the IP addresses allocated to the pod. If this field

+

is specified, the 0th entry must match the podIP field. Pods may be allocated

+

at most 1 value for each of IPv4 and IPv6. This list is empty if no IPs

+

have been allocated yet.

+

qosClass

+

String

+

The Quality of Service (QOS) classification assigned to the pod based on resource requirements See PodQOSClass type for available QOS classes More info: https://git.k8s.io/community/contributors/design-proposals/node/resource-qos.md

+

Possible enum values:

+
  • "BestEffort" is the BestEffort qos class.
  • "Burstable" is the Burstable qos class.
  • "Guaranteed" is the Guaranteed qos class.
+

reason

+

String

+

A brief CamelCase message indicating details about why the pod

+

is in this state. e.g. 'Evicted'

+

startTime

+

String

+

RFC 3339 date and time at which the object was acknowledged by

+

the Kubelet. This is before the Kubelet pulled the container image(s) for

+

the pod.

+
+
+ +
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Table 143 io.cci.otc.api.pkg.apis.versioned.cci.v2.PodCondition

Parameter

+

Type

+

Description

+

lastProbeTime

+

String

+

Last time we probed the condition.

+

lastTransitionTime

+

String

+

Last time the condition transitioned from one status to another.

+

message

+

String

+

Human-readable message indicating details about last transition.

+

reason

+

String

+

Unique, one-word, CamelCase reason for the condition's last transition.

+

status

+

String

+

Status is the status of the condition. Can be True, False, Unknown. More info: https://kubernetes.io/docs/concepts/workloads/pods/pod-lifecycle#pod-conditions

+

type

+

String

+

Type is the type of the condition. More info: https://kubernetes.io/docs/concepts/workloads/pods/pod-lifecycle#pod-conditions

+
+
+ +
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Table 144 io.cci.otc.api.pkg.apis.versioned.cci.v2.ContainerStatus

Parameter

+

Type

+

Description

+

containerID

+

String

+

Container's ID in the format '[/topic/body/section/table/tgroup/tbody/row/entry/p/br {""}) (br]://<container_id>'.

+

image

+

String

+

The image the container is running. More info: https://kubernetes.io/docs/concepts/containers/images.

+

imageID

+

String

+

ImageID of the container's image.

+

lastState

+

io.cci.otc.api.pkg.apis.versioned.cci.v2.ContainerState object

+

Details about the container's last termination condition.

+

name

+

String

+

This must be a DNS_LABEL. Each container in a pod must have a

+

unique name. Cannot be updated.

+

ready

+

Boolean

+

Specifies whether the container has passed its readiness probe.

+

restartCount

+

Integer

+

The number of times the container has been restarted.

+

started

+

Boolean

+

Specifies whether the container has passed its startup probe.

+

Initialized as false, becomes true after startupProbe is considered successful.

+

Resets to false when the container is restarted, or if kubelet loses state

+

temporarily. Is always true when no startupProbe is defined.

+

state

+

io.cci.otc.api.pkg.apis.versioned.cci.v2.ContainerState object

+

Details about the container's current condition.

+
+
+ +
+ + + + + + + + + + + + + + + + + +
Table 145 io.cci.otc.api.pkg.apis.versioned.cci.v2.ContainerState

Parameter

+

Type

+

Description

+

running

+

io.cci.otc.api.pkg.apis.versioned.cci.v2.ContainerStateRunning object

+

Details about a running container

+

terminated

+

io.cci.otc.api.pkg.apis.versioned.cci.v2.ContainerStateTerminated object

+

Details about a terminated container

+

waiting

+

io.cci.otc.api.pkg.apis.versioned.cci.v2.ContainerStateWaiting object

+

Details about a waiting container

+
+
+ +
+ + + + + + + + + +
Table 146 io.cci.otc.api.pkg.apis.versioned.cci.v2.ContainerStateRunning

Parameter

+

Type

+

Description

+

startedAt

+

String

+

Time at which the container was last (re-)started

+
+
+ +
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Table 147 io.cci.otc.api.pkg.apis.versioned.cci.v2.ContainerStateTerminated

Parameter

+

Type

+

Description

+

containerID

+

String

+

Container's ID in the format '[/topic/body/section/table/tgroup/tbody/row/entry/p/br {""}) (br]://<container_id>'

+

exitCode

+

Integer

+

Exit status from the last termination of the container

+

finishedAt

+

String

+

Time at which the container last terminated

+

message

+

String

+

Message regarding the last termination of the container

+

reason

+

String

+

(brief) reason from the last termination of the container

+

signal

+

Integer

+

Signal from the last termination of the container

+

startedAt

+

String

+

Time at which previous execution of the container started

+
+
+ +
+ + + + + + + + + + + + + +
Table 148 io.cci.otc.api.pkg.apis.versioned.cci.v2.ContainerStateWaiting

Parameter

+

Type

+

Description

+

message

+

String

+

Message regarding why the container is not yet running.

+

reason

+

String

+

(brief) reason the container is not yet running.

+
+
+ +
+ + + + + + + + + +
Table 149 io.cci.otc.api.pkg.apis.versioned.cci.v2.PodIP

Parameter

+

Type

+

Description

+

ip

+

String

+

ip is an IP address (IPv4 or IPv6) assigned to the pod

+
+
+

Status code: 201

+ +
+ + + + + + + + + + + + + + + + + + + + + + + + + +
Table 150 Response body parameters

Parameter

+

Type

+

Description

+

apiVersion

+

String

+

APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#resources

+

kind

+

String

+

Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds

+

metadata

+

io.k8s.apimachinery.pkg.apis.meta.v1.ObjectMeta object

+

Standard object's metadata. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata

+

spec

+

io.cci.otc.api.pkg.apis.versioned.cci.v2.PodSpec object

+

Specification of the desired behavior of the pod. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#spec-and-status

+

status

+

io.cci.otc.api.pkg.apis.versioned.cci.v2.PodStatus object

+

Most recently observed status of the pod. This data may not be up to date. Populated by the system. Read-only. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#spec-and-status

+
+
+ +
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Table 151 io.cci.otc.api.pkg.apis.versioned.cci.v2.PodSpec

Parameter

+

Type

+

Description

+

activeDeadlineSeconds

+

Long

+

Optional duration in seconds the pod may be active on the node

+

relative to StartTime before the system will actively try to mark it failed

+

and kill associated containers. Value must be a positive integer.

+

affinity

+

io.cci.otc.api.pkg.apis.versioned.cci.v2.Affinity object

+

If specified, the pod's scheduling constraints

+

containers

+

Array of io.cci.otc.api.pkg.apis.versioned.cci.v2.Container objects

+

List of containers belonging to the pod. Containers cannot currently

+

be added or removed. There must be at least one container in a Pod. Cannot

+

be updated.

+

dnsConfig

+

io.cci.otc.api.pkg.apis.versioned.cci.v2.PodDNSConfig object

+

Specifies the DNS parameters of a pod. Parameters specified here

+

will be merged to the generated DNS configuration based on DNSPolicy.

+

dnsPolicy

+

String

+

Set DNS policy for the pod. Defaults to "ClusterFirst". Valid values are 'ClusterFirstWithHostNet', 'ClusterFirst', 'Default' or 'None'. DNS parameters given in DNSConfig will be merged with the policy selected with DNSPolicy. To have DNS options set along with hostNetwork, you have to specify DNS policy explicitly to 'ClusterFirstWithHostNet'.

+

Possible enum values:

+
  • "ClusterFirst" indicates that the pod should use cluster DNS first unless hostNetwork is true, if it is available, then fall back on the default (as determined by kubelet) DNS settings.
  • "ClusterFirstWithHostNet" indicates that the pod should use cluster DNS first, if it is available, then fall back on the default (as determined by kubelet) DNS settings.
  • "Default" indicates that the pod should use the default (as determined by kubelet) DNS settings.
  • "None" indicates that the pod should use empty DNS settings. DNS parameters such as nameservers and search paths should be defined via DNSConfig.
+

ephemeralContainers

+

Array of io.cci.otc.api.pkg.apis.versioned.cci.v2.EphemeralContainer objects

+

List of ephemeral containers run in this pod. Ephemeral containers

+

may be run in an existing pod to perform user-initiated actions such as

+

debugging. This list cannot be specified when creating a pod, and it cannot

+

be modified by updating the pod spec. In order to add an ephemeral container

+

to an existing pod, use the pod's ephemeralcontainers subresource.

+

hostAliases

+

Array of io.cci.otc.api.pkg.apis.versioned.cci.v2.HostAlias objects

+

HostAliases is an optional list of hosts and IPs that will be

+

injected into the pod's hosts file if specified. This is only valid for

+

non-hostNetwork pods.

+

hostname

+

String

+

Specifies the hostName of the Pod. If not specified, the pod's

+

hostname will be set to a system-defined value.

+

imagePullSecrets

+

Array of io.cci.otc.api.pkg.apis.versioned.cci.v2.LocalObjectReference objects

+

ImagePullSecrets is an optional list of references to secrets in the same namespace to use for pulling any of the images used by this PodSpec. If specified, these secrets will be passed to individual puller implementations for them to use. More info: https://kubernetes.io/docs/concepts/containers/images#specifying-imagepullsecrets-on-a-pod

+

initContainers

+

Array of io.cci.otc.api.pkg.apis.versioned.cci.v2.Container objects

+

List of initialization containers belonging to the pod. Init containers are executed in order prior to containers being started. If any init container fails, the pod is considered to have failed and is handled according to its restartPolicy. The name for an init container or normal container must be unique among all containers. Init containers may not have Lifecycle actions, Readiness probes, Liveness probes, or Startup probes. The resourceRequirements of an init container are taken into account during scheduling by finding the highest request/limit for each resource type, and then using the max of of that value or the sum of the normal containers. Limits are applied to init containers in a similar fashion. Init containers cannot currently be added or removed. Cannot be updated. More info: https://kubernetes.io/docs/concepts/workloads/pods/init-containers/

+

nodeName

+

String

+

NodeName is a request to schedule this pod onto a specific node.

+

If it is non-empty, the scheduler simply schedules this pod onto that node,

+

assuming that it fits resource requirements.

+

overhead

+

Map<String,String>

+

Overhead represents the resource overhead associated with running a pod for a given RuntimeClass. This field will be autopopulated at admission time by the RuntimeClass admission controller. If the RuntimeClass admission controller is enabled, overhead must not be set in Pod create requests. The RuntimeClass admission controller will reject Pod create requests which have the overhead already set. If RuntimeClass is configured and selected in the PodSpec, Overhead will be set to the value defined in the corresponding RuntimeClass, otherwise it will remain unset and treated as zero. More info: https://git.k8s.io/enhancements/keps/sig-node/688-pod-overhead/README.md

+

readinessGates

+

Array of io.cci.otc.api.pkg.apis.versioned.cci.v2.PodReadinessGate objects

+

If specified, all readiness gates will be evaluated for pod readiness. A pod is ready when all its containers are ready AND all conditions specified in the readiness gates have status equal to "True" More info: https://git.k8s.io/enhancements/keps/sig-network/580-pod-readiness-gates

+

restartPolicy

+

String

+

Restart policy for all containers within the pod. One of Always, OnFailure, Never. Default to Always. More info: https://kubernetes.io/docs/concepts/workloads/pods/pod-lifecycle/#restart-policy

+

Possible enum values:

+
  • "Always"
  • "Never"
  • "OnFailure"
+

schedulerName

+

String

+

If specified, the pod will be dispatched by specified scheduler.

+

If not specified, the pod will be dispatched by default scheduler.

+

securityContext

+

io.cci.otc.api.pkg.apis.versioned.cci.v2.PodSecurityContext object

+

SecurityContext holds pod-level security attributes and common container settings. Optional: Defaults to empty. See type description for default values of each field.

+

setHostnameAsFQDN

+

Boolean

+

If true the pod's hostname will be configured as the pod's FQDN,

+

rather than the leaf name (the default). In Linux containers, this means

+

setting the FQDN in the hostname field of the kernel (the nodename field

+

of struct utsname). In Windows containers, this means setting the registry

+

value of hostname for the registry key HKEY_LOCAL_MACHINE\SYSTEM\CurrentControlSet\Services\Tcpip\Parameters

+

to FQDN. If a pod does not have FQDN, this has no effect. Default to false.

+

shareProcessNamespace

+

Boolean

+

Share a single process namespace between all of the containers in a pod. When this is set containers will be able to view and signal processes from other containers in the same pod, and the first process in each container will not be assigned PID 1. HostPID and ShareProcessNamespace cannot both be set. Optional: Default to false.

+

terminationGracePeriodSeconds

+

Long

+

Optional duration in seconds the pod needs to terminate gracefully.

+

May be decreased in delete request. Value must be non-negative integer.

+

The value zero indicates stop immediately via the kill signal (no opportunity

+

to shut down). If this value is nil, the default grace period will be used

+

instead. The grace period is the duration in seconds after the processes

+

running in the pod are sent a termination signal and the time when the processes

+

are forcibly halted with a kill signal. Set this value longer than the expected

+

cleanup time for your process. Defaults to 30 seconds.

+

topologySpreadConstraints

+

Array of io.cci.otc.api.pkg.apis.versioned.cci.v2.TopologySpreadConstraint objects

+

TopologySpreadConstraints describes how a group of pods ought

+

to spread across topology domains. Scheduler will schedule pods in a way

+

which abides by the constraints. All topologySpreadConstraints are ANDed.

+

volumes

+

Array of io.cci.otc.api.pkg.apis.versioned.cci.v2.Volume objects

+

List of volumes that can be mounted by containers belonging to the pod. More info: https://kubernetes.io/docs/concepts/storage/volumes

+
+
+ +
+ + + + + + + + + + + + + +
Table 152 io.cci.otc.api.pkg.apis.versioned.cci.v2.Affinity

Parameter

+

Type

+

Description

+

nodeAffinity

+

io.cci.otc.api.pkg.apis.versioned.cci.v2.NodeAffinity object

+

Describes node affinity scheduling rules for the pod.

+

podAntiAffinity

+

io.cci.otc.api.pkg.apis.versioned.cci.v2.PodAntiAffinity object

+

Describes pod anti-affinity scheduling rules (e.g. avoid putting

+

this pod in the same zone, etc. as some other pod(s)).

+
+
+ +
+ + + + + + + + + +
Table 153 io.cci.otc.api.pkg.apis.versioned.cci.v2.NodeAffinity

Parameter

+

Type

+

Description

+

requiredDuringSchedulingIgnoredDuringExecution

+

io.cci.otc.api.pkg.apis.versioned.cci.v2.NodeSelector object

+

If the affinity requirements specified by this field are not

+

met at scheduling time, the pod will not be scheduled onto the node. If

+

the affinity requirements specified by this field cease to be met at some

+

point during pod execution (e.g. due to an update), the system may or may

+

not try to eventually evict the pod from its node.

+
+
+ +
+ + + + + + + + + +
Table 154 io.cci.otc.api.pkg.apis.versioned.cci.v2.NodeSelector

Parameter

+

Type

+

Description

+

nodeSelectorTerms

+

Array of io.cci.otc.api.pkg.apis.versioned.cci.v2.NodeSelectorTerm objects

+

Required. A list of node selector terms. The terms are ORed.

+
+
+ +
+ + + + + + + + + +
Table 155 io.cci.otc.api.pkg.apis.versioned.cci.v2.NodeSelectorTerm

Parameter

+

Type

+

Description

+

matchExpressions

+

Array of io.cci.otc.api.pkg.apis.versioned.cci.v2.NodeSelectorRequirement objects

+

A list of node selector requirements by node's labels.

+
+
+ +
+ + + + + + + + + + + + + + + + + +
Table 156 io.cci.otc.api.pkg.apis.versioned.cci.v2.NodeSelectorRequirement

Parameter

+

Type

+

Description

+

key

+

String

+

The label key that the selector applies to.

+

operator

+

String

+

Represents a key's relationship to a set of values. Valid operators are In, NotIn, Exists, DoesNotExist. Gt, and Lt.

+

Possible enum values:

+
  • "DoesNotExist"
  • "Exists"
  • "Gt"
  • "In"
  • "Lt"
  • "NotIn"
+

values

+

Array of strings

+

An array of string values. If the operator is In or NotIn, the

+

values array must be non-empty. If the operator is Exists or DoesNotExist,

+

the values array must be empty. If the operator is Gt or Lt, the values

+

array must have a single element, which will be interpreted as an integer.

+

This array is replaced during a strategic merge patch.

+
+
+ +
+ + + + + + + + + + + + + +
Table 157 io.cci.otc.api.pkg.apis.versioned.cci.v2.PodAntiAffinity

Parameter

+

Type

+

Description

+

preferredDuringSchedulingIgnoredDuringExecution

+

Array of io.cci.otc.api.pkg.apis.versioned.cci.v2.WeightedPodAffinityTerm objects

+

The scheduler will prefer to schedule pods to nodes that satisfy

+

the anti-affinity expressions specified by this field, but it may choose

+

a node that violates one or more of the expressions. The node that is most

+

preferred is the one with the greatest sum of weights, i.e. for each node

+

that meets all of the scheduling requirements (resource request, requiredDuringScheduling

+

anti-affinity expressions, etc.), compute a sum by iterating through the

+

elements of this field and adding "weight" to the sum if the node has pods

+

which matches the corresponding podAffinityTerm; the node(s) with the highest

+

sum are the most preferred.

+

requiredDuringSchedulingIgnoredDuringExecution

+

Array of io.cci.otc.api.pkg.apis.versioned.cci.v2.PodAffinityTerm objects

+

If the anti-affinity requirements specified by this field are

+

not met at scheduling time, the pod will not be scheduled onto the node.

+

If the anti-affinity requirements specified by this field cease to be met

+

at some point during pod execution (e.g. due to a pod label update), the

+

system may or may not try to eventually evict the pod from its node. When

+

there are multiple elements, the lists of nodes corresponding to each podAffinityTerm

+

are intersected, i.e. all terms must be satisfied.

+
+
+ +
+ + + + + + + + + + + + + +
Table 158 io.cci.otc.api.pkg.apis.versioned.cci.v2.WeightedPodAffinityTerm

Parameter

+

Type

+

Description

+

podAffinityTerm

+

io.cci.otc.api.pkg.apis.versioned.cci.v2.PodAffinityTerm object

+

Required. A pod affinity term, associated with the corresponding

+

weight.

+

weight

+

Integer

+

weight associated with matching the corresponding podAffinityTerm,

+

in the range 1-100.

+
+
+ +
+ + + + + + + + + + + + + + + + + +
Table 159 io.cci.otc.api.pkg.apis.versioned.cci.v2.PodAffinityTerm

Parameter

+

Type

+

Description

+

labelSelector

+

io.k8s.apimachinery.pkg.apis.meta.v1.LabelSelector object

+

A label query over a set of resources, in this case pods.

+

namespaces

+

Array of strings

+

namespaces specifies a static list of namespace names that the

+

term applies to. The term is applied to the union of the namespaces listed

+

in this field and the ones selected by namespaceSelector. null or empty

+

namespaces list and null namespaceSelector means "this pod's namespace".

+

topologyKey

+

String

+

This pod should be co-located (affinity) or not co-located (anti-affinity)

+

with the pods matching the labelSelector in the specified namespaces, where

+

co-located is defined as running on a node whose value of the label with

+

key topologyKey matches that of any node on which any of the selected pods

+

is running. Empty topologyKey is not allowed.

+
+
+ +
+ + + + + + + + + + + + + + + + + +
Table 160 io.cci.otc.api.pkg.apis.versioned.cci.v2.PodDNSConfig

Parameter

+

Type

+

Description

+

nameservers

+

Array of strings

+

A list of DNS name server IP addresses. This will be appended

+

to the base nameservers generated from DNSPolicy. Duplicated nameservers

+

will be removed.

+

options

+

Array of io.cci.otc.api.pkg.apis.versioned.cci.v2.PodDNSConfigOption objects

+

A list of DNS resolver options. This will be merged with the

+

base options generated from DNSPolicy. Duplicated entries will be removed.

+

Resolution options given in Options will override those that appear in the

+

base DNSPolicy.

+

searches

+

Array of strings

+

A list of DNS search domains for host-name lookup. This will

+

be appended to the base search paths generated from DNSPolicy. Duplicated

+

search paths will be removed.

+
+
+ +
+ + + + + + + + + + + + + +
Table 161 io.cci.otc.api.pkg.apis.versioned.cci.v2.PodDNSConfigOption

Parameter

+

Type

+

Description

+

name

+

String

+

Required.

+

value

+

String

+		  
+
+ +
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Table 162 io.cci.otc.api.pkg.apis.versioned.cci.v2.EphemeralContainer

Parameter

+

Type

+

Description

+

args

+

Array of strings

+

Arguments to the entrypoint. The image's CMD is used if this is not provided. Variable references $(VAR_NAME) are expanded using the container's environment. If a variable cannot be resolved, the reference in the input string will be unchanged. Double $$ are reduced to a single $, which allows for escaping the $(VAR_NAME) syntax: i.e. "$$(VAR_NAME)" will produce the string literal "$(VAR_NAME)". Escaped references will never be expanded, regardless of whether the variable exists or not. Cannot be updated. More info: https://kubernetes.io/docs/tasks/inject-data-application/define-command-argument-container/#running-a-command-in-a-shell

+

command

+

Array of strings

+

Entrypoint array. Not executed within a shell. The image's ENTRYPOINT is used if this is not provided. Variable references $(VAR_NAME) are expanded using the container's environment. If a variable cannot be resolved, the reference in the input string will be unchanged. Double $$ are reduced to a single $, which allows for escaping the $(VAR_NAME) syntax: i.e. "$$(VAR_NAME)" will produce the string literal "$(VAR_NAME)". Escaped references will never be expanded, regardless of whether the variable exists or not. Cannot be updated. More info: https://kubernetes.io/docs/tasks/inject-data-application/define-command-argument-container/#running-a-command-in-a-shell

+

env

+

Array of io.cci.otc.api.pkg.apis.versioned.cci.v2.EnvVar objects

+

List of environment variables to set in the container. Cannot

+

be updated.

+

envFrom

+

Array of io.cci.otc.api.pkg.apis.versioned.cci.v2.EnvFromSource objects

+

List of sources to populate environment variables in the container.

+

The keys defined within a source must be a C_IDENTIFIER. All invalid keys

+

will be reported as an event when the container is starting. When a key

+

exists in multiple sources, the value associated with the last source will

+

take precedence. Values defined by an Env with a duplicate key will take

+

precedence. Cannot be updated.

+

image

+

String

+

Container image name. More info: https://kubernetes.io/docs/concepts/containers/images

+

lifecycle

+

io.cci.otc.api.pkg.apis.versioned.cci.v2.Lifecycle object

+

Lifecycle is not allowed for ephemeral containers.

+

livenessProbe

+

io.cci.otc.api.pkg.apis.versioned.cci.v2.Probe object

+

Probes are not allowed for ephemeral containers.

+

name

+

String

+

Name of the ephemeral container specified as a DNS_LABEL. This

+

name must be unique among all containers, init containers and ephemeral

+

containers.

+

ports

+

Array of io.cci.otc.api.pkg.apis.versioned.cci.v2.ContainerPort objects

+

Ports are not allowed for ephemeral containers.

+

readinessProbe

+

io.cci.otc.api.pkg.apis.versioned.cci.v2.Probe object

+

Probes are not allowed for ephemeral containers.

+

resources

+

io.cci.otc.api.pkg.apis.versioned.cci.v2.ResourceRequirements object

+

Resources are not allowed for ephemeral containers. Ephemeral

+

containers use spare resources already allocated to the pod.

+

securityContext

+

io.cci.otc.api.pkg.apis.versioned.cci.v2.SecurityContext object

+

Optional: SecurityContext defines the security options the ephemeral container should be run with. If set, the fields of SecurityContext override the equivalent fields of PodSecurityContext.

+

startupProbe

+

io.cci.otc.api.pkg.apis.versioned.cci.v2.Probe object

+

Probes are not allowed for ephemeral containers.

+

stdin

+

Boolean

+

Whether this container should allocate a buffer for stdin in

+

the container runtime. If this is not set, reads from stdin in the container

+

will always result in EOF. Default is false.

+

stdinOnce

+

Boolean

+

Whether the container runtime should close the stdin channel

+

after it has been opened by a single attach. When stdin is true the stdin

+

stream will remain open across multiple attach sessions. If stdinOnce is

+

set to true, stdin is opened on container start, is empty until the first

+

client attaches to stdin, and then remains open and accepts data until the

+

client disconnects, at which time stdin is closed and remains closed until

+

the container is restarted. If this flag is false, a container processes

+

that reads from stdin will never receive an EOF. Default is false

+

targetContainerName

+

String

+

If set, the name of the container from PodSpec that this ephemeral container targets. The ephemeral container will be run in the namespaces (IPC, PID, etc) of this container. If not set then the ephemeral container uses the namespaces configured in the Pod spec.

+

The container runtime must implement support for this feature. If the runtime does not support namespace targeting then the result of setting this field is undefined.

+

terminationMessagePath

+

String

+

Optional: Path at which the file to which the container's termination message will be written is mounted into the container's filesystem. Message written is intended to be brief final status, such as an assertion failure message. Will be truncated by the node if greater than 4096 bytes. The total message length across all containers will be limited to 12kb. Defaults to /dev/termination-log. Cannot be updated.

+

terminationMessagePolicy

+

String

+

Indicate how the termination message should be populated. File will use the contents of terminationMessagePath to populate the container status message on both success and failure. FallbackToLogsOnError will use the last chunk of container log output if the termination message file is empty and the container exited with an error. The log output is limited to 2048 bytes or 80 lines, whichever is smaller. Defaults to File. Cannot be updated.

+

Possible enum values:

+
  • "FallbackToLogsOnError" will read the most recent contents of the container logs for the container status message when the container exits with an error and the terminationMessagePath has no contents.
  • "File" is the default behavior and will set the container status message to the contents of the container's terminationMessagePath when the container exits.
+

tty

+

Boolean

+

Whether this container should allocate a TTY for itself, also

+

requires 'stdin' to be true. Default is false.

+

volumeMounts

+

Array of io.cci.otc.api.pkg.apis.versioned.cci.v2.VolumeMount objects

+

Pod volumes to mount into the container's filesystem. Subpath

+

mounts are not allowed for ephemeral containers. Cannot be updated.

+

workingDir

+

String

+

Container's working directory. If not specified, the container

+

runtime's default will be used, which might be configured in the container

+

image. Cannot be updated.

+
+
+ +
+ + + + + + + + + + + + + +
Table 163 io.cci.otc.api.pkg.apis.versioned.cci.v2.HostAlias

Parameter

+

Type

+

Description

+

hostnames

+

Array of strings

+

Hostnames for the above IP address.

+

ip

+

String

+

IP address of the host file entry.

+
+
+ +
+ + + + + + + + + +
Table 164 io.cci.otc.api.pkg.apis.versioned.cci.v2.LocalObjectReference

Parameter

+

Type

+

Description

+

name

+

String

+

Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names

+
+
+ +
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Table 165 io.cci.otc.api.pkg.apis.versioned.cci.v2.Container

Parameter

+

Type

+

Description

+

args

+

Array of strings

+

Arguments to the entrypoint. The container image's CMD is used if this is not provided. Variable references $(VAR_NAME) are expanded using the container's environment. If a variable cannot be resolved, the reference in the input string will be unchanged. Double $$ are reduced to a single $, which allows for escaping the $(VAR_NAME) syntax: i.e. "$$(VAR_NAME)" will produce the string literal "$(VAR_NAME)". Escaped references will never be expanded, regardless of whether the variable exists or not. Cannot be updated. More info: https://kubernetes.io/docs/tasks/inject-data-application/define-command-argument-container/#running-a-command-in-a-shell

+

command

+

Array of strings

+

Entrypoint array. Not executed within a shell. The container image's ENTRYPOINT is used if this is not provided. Variable references $(VAR_NAME) are expanded using the container's environment. If a variable cannot be resolved, the reference in the input string will be unchanged. Double $$ are reduced to a single $, which allows for escaping the $(VAR_NAME) syntax: i.e. "$$(VAR_NAME)" will produce the string literal "$(VAR_NAME)". Escaped references will never be expanded, regardless of whether the variable exists or not. Cannot be updated. More info: https://kubernetes.io/docs/tasks/inject-data-application/define-command-argument-container/#running-a-command-in-a-shell

+

env

+

Array of io.cci.otc.api.pkg.apis.versioned.cci.v2.EnvVar objects

+

List of environment variables to set in the container. Cannot

+

be updated.

+

envFrom

+

Array of io.cci.otc.api.pkg.apis.versioned.cci.v2.EnvFromSource objects

+

List of sources to populate environment variables in the container.

+

The keys defined within a source must be a C_IDENTIFIER. All invalid keys

+

will be reported as an event when the container is starting. When a key

+

exists in multiple sources, the value associated with the last source will

+

take precedence. Values defined by an Env with a duplicate key will take

+

precedence. Cannot be updated.

+

image

+

String

+

Container image name. More info: https://kubernetes.io/docs/concepts/containers/images This field is optional to allow higher level config management to default or override container images in workload controllers like Deployments and StatefulSets.

+

lifecycle

+

io.cci.otc.api.pkg.apis.versioned.cci.v2.Lifecycle object

+

Actions that the management system should take in response to

+

container lifecycle events. Cannot be updated.

+

livenessProbe

+

io.cci.otc.api.pkg.apis.versioned.cci.v2.Probe object

+

Periodic probe of container liveness. Container will be restarted if the probe fails. Cannot be updated. More info: https://kubernetes.io/docs/concepts/workloads/pods/pod-lifecycle#container-probes

+

name

+

String

+

Name of the container specified as a DNS_LABEL. Each container

+

in a pod must have a unique name (DNS_LABEL). Cannot be updated.

+

ports

+

Array of io.cci.otc.api.pkg.apis.versioned.cci.v2.ContainerPort objects

+

List of ports to expose from the container. Not specifying a

+

port here DOES NOT prevent that port from being exposed. Any port which

+

is listening on the default "0.0.0.0" address inside a container will be

+

accessible from the network. Modifying this array with strategic merge patch

+

may corrupt the data. For more information See https://github.com/kubernetes/kubernetes/issues/108255.

+

Cannot be updated.

+

readinessProbe

+

io.cci.otc.api.pkg.apis.versioned.cci.v2.Probe object

+

Periodic probe of container service readiness. Container will be removed from service endpoints if the probe fails. Cannot be updated. More info: https://kubernetes.io/docs/concepts/workloads/pods/pod-lifecycle#container-probes

+

resources

+

io.cci.otc.api.pkg.apis.versioned.cci.v2.ResourceRequirements object

+

Compute Resources required by this container. Cannot be updated. More info: https://kubernetes.io/docs/concepts/configuration/manage-resources-containers/

+

securityContext

+

io.cci.otc.api.pkg.apis.versioned.cci.v2.SecurityContext object

+

SecurityContext defines the security options the container should be run with. If set, the fields of SecurityContext override the equivalent fields of PodSecurityContext. More info: https://kubernetes.io/docs/tasks/configure-pod-container/security-context/

+

startupProbe

+

io.cci.otc.api.pkg.apis.versioned.cci.v2.Probe object

+

StartupProbe indicates that the Pod has successfully initialized. If specified, no other probes are executed until this completes successfully. If this probe fails, the Pod will be restarted, just as if the livenessProbe failed. This can be used to provide different probe parameters at the beginning of a Pod's lifecycle, when it might take a long time to load data or warm a cache, than during steady-state operation. This cannot be updated. More info: https://kubernetes.io/docs/concepts/workloads/pods/pod-lifecycle#container-probes

+

stdin

+

Boolean

+

Whether this container should allocate a buffer for stdin in

+

the container runtime. If this is not set, reads from stdin in the container

+

will always result in EOF. Default is false.

+

stdinOnce

+

Boolean

+

Whether the container runtime should close the stdin channel

+

after it has been opened by a single attach. When stdin is true the stdin

+

stream will remain open across multiple attach sessions. If stdinOnce is

+

set to true, stdin is opened on container start, is empty until the first

+

client attaches to stdin, and then remains open and accepts data until the

+

client disconnects, at which time stdin is closed and remains closed until

+

the container is restarted. If this flag is false, a container processes

+

that reads from stdin will never receive an EOF. Default is false

+

terminationMessagePath

+

String

+

Optional: Path at which the file to which the container's termination message will be written is mounted into the container's filesystem. Message written is intended to be brief final status, such as an assertion failure message. Will be truncated by the node if greater than 4096 bytes. The total message length across all containers will be limited to 12kb. Defaults to /dev/termination-log. Cannot be updated.

+

terminationMessagePolicy

+

String

+

Indicate how the termination message should be populated. File will use the contents of terminationMessagePath to populate the container status message on both success and failure. FallbackToLogsOnError will use the last chunk of container log output if the termination message file is empty and the container exited with an error. The log output is limited to 2048 bytes or 80 lines, whichever is smaller. Defaults to File. Cannot be updated.

+

Possible enum values:

+
  • "FallbackToLogsOnError" will read the most recent contents of the container logs for the container status message when the container exits with an error and the terminationMessagePath has no contents.
  • "File" is the default behavior and will set the container status message to the contents of the container's terminationMessagePath when the container exits.
+

tty

+

Boolean

+

Whether this container should allocate a TTY for itself, also

+

requires 'stdin' to be true. Default is false.

+

volumeMounts

+

Array of io.cci.otc.api.pkg.apis.versioned.cci.v2.VolumeMount objects

+

Pod volumes to mount into the container's filesystem. Cannot

+

be updated.

+

workingDir

+

String

+

Container's working directory. If not specified, the container

+

runtime's default will be used, which might be configured in the container

+

image. Cannot be updated.

+
+
+ +
+ + + + + + + + + + + + + + + + + +
Table 166 io.cci.otc.api.pkg.apis.versioned.cci.v2.EnvVar

Parameter

+

Type

+

Description

+

name

+

String

+

Name of the environment variable. Must be a C_IDENTIFIER.

+

value

+

String

+

Variable references $(VAR_NAME) are expanded using the previously defined environment variables in the container and any service environment variables. If a variable cannot be resolved, the reference in the input string will be unchanged. Double $$ are reduced to a single $, which allows for escaping the $(VAR_NAME) syntax: i.e. "$$(VAR_NAME)" will produce the string literal "$(VAR_NAME)". Escaped references will never be expanded, regardless of whether the variable exists or not. Defaults to "".

+

valueFrom

+

io.cci.otc.api.pkg.apis.versioned.cci.v2.EnvVarSource object

+

Source for the environment variable's value. Cannot be used if

+

value is not empty.

+
+
+ +
+ + + + + + + + + + + + + + + + + + + + + +
Table 167 io.cci.otc.api.pkg.apis.versioned.cci.v2.EnvVarSource

Parameter

+

Type

+

Description

+

configMapKeyRef

+

io.cci.otc.api.pkg.apis.versioned.cci.v2.ConfigMapKeySelector object

+

Selects a key of a ConfigMap.

+

fieldRef

+

io.cci.otc.api.pkg.apis.versioned.cci.v2.ObjectFieldSelector object

+

Selects a field of the pod: supports metadata.name, metadata.namespace, metadata.labels['<KEY>'], metadata.annotations['<KEY>'], spec.nodeName, spec.serviceAccountName, status.hostIP, status.podIP, status.podIPs.

+

resourceFieldRef

+

io.cci.otc.api.pkg.apis.versioned.cci.v2.ResourceFieldSelector object

+

Selects a resource of the container: only resources limits and requests (limits.cpu, limits.memory, limits.ephemeral-storage, requests.cpu, requests.memory and requests.ephemeral-storage) are currently supported.

+

secretKeyRef

+

io.cci.otc.api.pkg.apis.versioned.cci.v2.SecretKeySelector object

+

Selects a key of a secret in the pod's namespace

+
+
+ +
+ + + + + + + + + + + + + + + + + +
Table 168 io.cci.otc.api.pkg.apis.versioned.cci.v2.ConfigMapKeySelector

Parameter

+

Type

+

Description

+

key

+

String

+

The key to select.

+

name

+

String

+

Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names

+

optional

+

Boolean

+

Specify whether the ConfigMap or its key must be defined

+
+
+ +
+ + + + + + + + + + + + + + + + + +
Table 169 io.cci.otc.api.pkg.apis.versioned.cci.v2.SecretKeySelector

Parameter

+

Type

+

Description

+

key

+

String

+

The key of the secret to select from. Must be a valid secret

+

key.

+

name

+

String

+

Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names

+

optional

+

Boolean

+

Specify whether the Secret or its key must be defined

+
+
+ +
+ + + + + + + + + + + + + + + + + +
Table 170 io.cci.otc.api.pkg.apis.versioned.cci.v2.EnvFromSource

Parameter

+

Type

+

Description

+

configMapRef

+

io.cci.otc.api.pkg.apis.versioned.cci.v2.ConfigMapEnvSource object

+

The ConfigMap to select from

+

prefix

+

String

+

An optional identifier to prepend to each key in the ConfigMap.

+

Must be a C_IDENTIFIER.

+

secretRef

+

io.cci.otc.api.pkg.apis.versioned.cci.v2.SecretEnvSource object

+

The Secret to select from

+
+
+ +
+ + + + + + + + + + + + + +
Table 171 io.cci.otc.api.pkg.apis.versioned.cci.v2.ConfigMapEnvSource

Parameter

+

Type

+

Description

+

name

+

String

+

Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names

+

optional

+

Boolean

+

Specify whether the ConfigMap must be defined

+
+
+ +
+ + + + + + + + + + + + + +
Table 172 io.cci.otc.api.pkg.apis.versioned.cci.v2.SecretEnvSource

Parameter

+

Type

+

Description

+

name

+

String

+

Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names

+

optional

+

Boolean

+

Specify whether the Secret must be defined

+
+
+ +
+ + + + + + + + + + + + + +
Table 173 io.cci.otc.api.pkg.apis.versioned.cci.v2.Lifecycle

Parameter

+

Type

+

Description

+

postStart

+

io.cci.otc.api.pkg.apis.versioned.cci.v2.LifecycleHandler object

+

PostStart is called immediately after a container is created. If the handler fails, the container is terminated and restarted according to its restart policy. Other management of the container blocks until the hook completes. More info: https://kubernetes.io/docs/concepts/containers/container-lifecycle-hooks/#container-hooks

+

preStop

+

io.cci.otc.api.pkg.apis.versioned.cci.v2.LifecycleHandler object

+

PreStop is called immediately before a container is terminated due to an API request or management event such as liveness/startup probe failure, preemption, resource contention, etc. The handler is not called if the container crashes or exits. The Pod's termination grace period countdown begins before the PreStop hook is executed. Regardless of the outcome of the handler, the container will eventually terminate within the Pod's termination grace period (unless delayed by finalizers). Other management of the container blocks until the hook completes or until the termination grace period is reached. More info: https://kubernetes.io/docs/concepts/containers/container-lifecycle-hooks/#container-hooks

+
+
+ +
+ + + + + + + + + + + + + +
Table 174 io.cci.otc.api.pkg.apis.versioned.cci.v2.LifecycleHandler

Parameter

+

Type

+

Description

+

exec

+

io.cci.otc.api.pkg.apis.versioned.cci.v2.ExecAction object

+

Exec specifies the action to take.

+

httpGet

+

io.cci.otc.api.pkg.apis.versioned.cci.v2.HTTPGetAction object

+

HTTPGet specifies the http request to perform.

+
+
+ +
+ + + + + + + + + + + + + + + + + +
Table 175 io.cci.otc.api.pkg.apis.versioned.cci.v2.ContainerPort

Parameter

+

Type

+

Description

+

containerPort

+

Integer

+

Number of port to expose on the pod's IP address. This must be

+

a valid port number, 0 < x < 65536.

+

name

+

String

+

If specified, this must be an IANA_SVC_NAME and unique within

+

the pod. Each named port in a pod must have a unique name. Name for the

+

port that can be referred to by services.

+

protocol

+

String

+

Protocol for port. Must be UDP, TCP, or SCTP. Defaults to "TCP".

+

Possible enum values:

+
  • "SCTP" is the SCTP protocol.
  • "TCP" is the TCP protocol.
  • "UDP" is the UDP protocol.
+
+
+ +
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Table 176 io.cci.otc.api.pkg.apis.versioned.cci.v2.SecurityContext

Parameter

+

Type

+

Description

+

capabilities

+

io.cci.otc.api.pkg.apis.versioned.cci.v2.Capabilities object

+

The capabilities to add/drop when running containers. Defaults

+

to the default set of capabilities granted by the container runtime. Note

+

that this field cannot be set when spec.os.name is windows.

+

procMount

+

String

+

procMount denotes the type of proc mount to use for the containers.

+

The default is DefaultProcMount which uses the container runtime defaults

+

for readonly paths and masked paths. This requires the ProcMountType feature

+

flag to be enabled. Note that this field cannot be set when spec.os.name

+

is windows.

+

readOnlyRootFilesystem

+

Boolean

+

Whether this container has a read-only root filesystem. Default

+

is false. Note that this field cannot be set when spec.os.name is windows.

+

runAsGroup

+

Long

+

The GID to run the entrypoint of the container process. Uses

+

runtime default if unset. May also be set in PodSecurityContext. If set

+

in both SecurityContext and PodSecurityContext, the value specified in SecurityContext

+

takes precedence. Note that this field cannot be set when spec.os.name is

+

windows.

+

runAsNonRoot

+

Boolean

+

Indicates that the container must run as a non-root user. If

+

true, the Kubelet will validate the image at runtime to ensure that it does

+

not run as UID 0 (root) and fail to start the container if it does. If unset

+

or false, no such validation will be performed. May also be set in PodSecurityContext. If

+

set in both SecurityContext and PodSecurityContext, the value specified

+

in SecurityContext takes precedence.

+

runAsUser

+

Long

+

The UID to run the entrypoint of the container process. Defaults

+

to user specified in image metadata if unspecified. May also be set in PodSecurityContext. If

+

set in both SecurityContext and PodSecurityContext, the value specified

+

in SecurityContext takes precedence. Note that this field cannot be set

+

when spec.os.name is windows.

+
+
+ +
+ + + + + + + + + + + + + +
Table 177 io.cci.otc.api.pkg.apis.versioned.cci.v2.Capabilities

Parameter

+

Type

+

Description

+

add

+

Array of strings

+

Added capabilities

+

drop

+

Array of strings

+

Removed capabilities

+
+
+ +
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Table 178 io.cci.otc.api.pkg.apis.versioned.cci.v2.Probe

Parameter

+

Type

+

Description

+

exec

+

io.cci.otc.api.pkg.apis.versioned.cci.v2.ExecAction object

+

Exec specifies the action to take.

+

failureThreshold

+

Integer

+

Minimum consecutive failures for the probe to be considered failed

+

after having succeeded. Defaults to 3. Minimum value is 1.

+

httpGet

+

io.cci.otc.api.pkg.apis.versioned.cci.v2.HTTPGetAction object

+

HTTPGet specifies the http request to perform.

+

initialDelaySeconds

+

Integer

+

Number of seconds after the container has started before liveness probes are initiated. More info: https://kubernetes.io/docs/concepts/workloads/pods/pod-lifecycle#container-probes

+

periodSeconds

+

Integer

+

How often (in seconds) to perform the probe. Default to 10 seconds.

+

Minimum value is 1.

+

successThreshold

+

Integer

+

Minimum consecutive successes for the probe to be considered

+

successful after having failed. Defaults to 1. Must be 1 for liveness and

+

startup. Minimum value is 1.

+

tcpSocket

+

io.cci.otc.api.pkg.apis.versioned.cci.v2.TCPSocketAction object

+

TCPSocket specifies an action involving a TCP port.

+

terminationGracePeriodSeconds

+

Long

+

Optional duration in seconds the pod needs to terminate gracefully

+

upon probe failure. The grace period is the duration in seconds after the

+

processes running in the pod are sent a termination signal and the time

+

when the processes are forcibly halted with a kill signal. Set this value

+

longer than the expected cleanup time for your process. If this value is

+

nil, the pod's terminationGracePeriodSeconds will be used. Otherwise, this

+

value overrides the value provided by the pod spec. Value must be non-negative

+

integer. The value zero indicates stop immediately via the kill signal (no

+

opportunity to shut down). This is a beta field and requires enabling ProbeTerminationGracePeriod

+

feature gate. Minimum value is 1. spec.terminationGracePeriodSeconds is

+

used if unset.

+

timeoutSeconds

+

Integer

+

Number of seconds after which the probe times out. Defaults to 1 second. Minimum value is 1. More info: https://kubernetes.io/docs/concepts/workloads/pods/pod-lifecycle#container-probes

+
+
+ +
+ + + + + + + + + +
Table 179 io.cci.otc.api.pkg.apis.versioned.cci.v2.ExecAction

Parameter

+

Type

+

Description

+

command

+

Array of strings

+

Command is the command line to execute inside the container,

+

the working directory for the command is root ('/') in the container's

+

filesystem. The command is simply exec'd, it is not run inside a shell,

+

so traditional shell instructions ('|', etc) won't work. To use a shell,

+

you need to explicitly call out to that shell. Exit status of 0 is treated

+

as live/healthy and non-zero is unhealthy.

+
+
+ +
+ + + + + + + + + + + + + + + + + + + + + + + + + +
Table 180 io.cci.otc.api.pkg.apis.versioned.cci.v2.HTTPGetAction

Parameter

+

Type

+

Description

+

host

+

String

+

Host name to connect to, defaults to the pod IP. You probably

+

want to set "Host" in httpHeaders instead.

+

httpHeaders

+

Array of io.cci.otc.api.pkg.apis.versioned.cci.v2.HTTPHeader objects

+

Custom headers to set in the request. HTTP allows repeated headers.

+

path

+

String

+

Path to access on the HTTP server.

+

port

+

String

+

Name or number of the port to access on the container. Number

+

must be in the range 1 to 65535. Name must be an IANA_SVC_NAME.

+

scheme

+

String

+

Scheme to use for connecting to the host. Defaults to HTTP.

+

Possible enum values:

+
  • "HTTP" means that the scheme used will be http://
  • "HTTPS" means that the scheme used will be https://
+
+
+ +
+ + + + + + + + + + + + + +
Table 181 io.cci.otc.api.pkg.apis.versioned.cci.v2.HTTPHeader

Parameter

+

Type

+

Description

+

name

+

String

+

The header field name

+

value

+

String

+

The header field value

+
+
+ +
+ + + + + + + + + + + + + +
Table 182 io.cci.otc.api.pkg.apis.versioned.cci.v2.TCPSocketAction

Parameter

+

Type

+

Description

+

host

+

String

+

Optional: Host name to connect to, defaults to the pod IP.

+

port

+

String

+

Number or name of the port to access on the container. Number

+

must be in the range 1 to 65535. Name must be an IANA_SVC_NAME.

+
+
+ +
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Table 183 io.cci.otc.api.pkg.apis.versioned.cci.v2.VolumeMount

Parameter

+

Type

+

Description

+

extendPathMode

+

String

+

Extend the volume path by appending the pod metadata to the path

+

according to specified pattern. which provide a way of directory isolation

+

and help prevent the writing conflict between different pods.

+

mountPath

+

String

+

Path within the container at which the volume should be mounted. Must

+

not contain ':'.

+

name

+

String

+

This must match the Name of a Volume.

+

readOnly

+

Boolean

+

Mounted read-only if true, read-write otherwise (false or unspecified).

+

Defaults to false.

+

subPath

+

String

+

Path within the volume from which the container's volume should

+

be mounted. Defaults to "" (volume's root).

+

subPathExpr

+

String

+

Expanded path within the volume from which the container's volume

+

should be mounted. Behaves similarly to SubPath but environment variable

+

references $(VAR_NAME) are expanded using the container's environment. Defaults

+

to "" (volume's root). SubPathExpr and SubPath are mutually exclusive.

+
+
+ +
+ + + + + + + + + +
Table 184 io.cci.otc.api.pkg.apis.versioned.cci.v2.PodReadinessGate

Parameter

+

Type

+

Description

+

conditionType

+

String

+

ConditionType refers to a condition in the pod's condition list

+

with matching type.

+
+
+ +
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Table 185 io.cci.otc.api.pkg.apis.versioned.cci.v2.PodSecurityContext

Parameter

+

Type

+

Description

+

fsGroup

+

Long

+

A special supplemental group that applies to all containers in a pod. Some volume types allow the Kubelet to change the ownership of that volume to be owned by the pod:

+
  1. The owning GID will be the FSGroup 2. The setgid bit is set (new files created in the volume will be owned by FSGroup) 3. The permission bits are OR'd with rw-rw----
+

If unset, the Kubelet will not modify the ownership and permissions of any volume. Note that this field cannot be set when spec.os.name is windows.

+

fsGroupChangePolicy

+

String

+

fsGroupChangePolicy defines behavior of changing ownership and permission of the volume before being exposed inside Pod. This field will only apply to volume types which support fsGroup based ownership(and permissions). It will have no effect on ephemeral volume types such as: secret, configmaps and emptydir. Valid values are "OnRootMismatch" and "Always". If not specified, "Always" is used. Note that this field cannot be set when spec.os.name is windows.

+

runAsGroup

+

Long

+

The GID to run the entrypoint of the container process. Uses

+

runtime default if unset. May also be set in SecurityContext. If set in

+

both SecurityContext and PodSecurityContext, the value specified in SecurityContext

+

takes precedence for that container. Note that this field cannot be set

+

when spec.os.name is windows.

+

runAsNonRoot

+

Boolean

+

Indicates that the container must run as a non-root user. If

+

true, the Kubelet will validate the image at runtime to ensure that it does

+

not run as UID 0 (root) and fail to start the container if it does. If unset

+

or false, no such validation will be performed. May also be set in SecurityContext. If

+

set in both SecurityContext and PodSecurityContext, the value specified

+

in SecurityContext takes precedence.

+

runAsUser

+

Long

+

The UID to run the entrypoint of the container process. Defaults

+

to user specified in image metadata if unspecified. May also be set in SecurityContext. If

+

set in both SecurityContext and PodSecurityContext, the value specified

+

in SecurityContext takes precedence for that container. Note that this field

+

cannot be set when spec.os.name is windows.

+

supplementalGroups

+

Array of longs

+

A list of groups applied to the first process run in each container,

+

in addition to the container's primary GID. If unspecified, no groups will

+

be added to any container. Note that this field cannot be set when spec.os.name

+

is windows.

+

sysctls

+

Array of io.cci.otc.api.pkg.apis.versioned.cci.v2.Sysctl objects

+

Sysctls hold a list of namespaced sysctls used for the pod. Pods

+

with unsupported sysctls (by the container runtime) might fail to launch.

+

Note that this field cannot be set when spec.os.name is windows.

+
+
+ +
+ + + + + + + + + + + + + +
Table 186 io.cci.otc.api.pkg.apis.versioned.cci.v2.Sysctl

Parameter

+

Type

+

Description

+

name

+

String

+

Name of a property to set

+

value

+

String

+

Value of a property to set

+
+
+ +
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Table 187 io.cci.otc.api.pkg.apis.versioned.cci.v2.TopologySpreadConstraint

Parameter

+

Type

+

Description

+

labelSelector

+

io.k8s.apimachinery.pkg.apis.meta.v1.LabelSelector object

+

LabelSelector is used to find matching pods. Pods that match

+

this label selector are counted to determine the number of pods in their

+

corresponding topology domain.

+

matchLabelKeys

+

Array of strings

+

MatchLabelKeys is a set of pod label keys to select the pods

+

over which spreading will be calculated. The keys are used to lookup values

+

from the incoming pod labels, those key-value labels are ANDed with labelSelector

+

to select the group of existing pods over which spreading will be calculated

+

for the incoming pod. Keys that don't exist in the incoming pod labels will

+

be ignored. A null or empty list means only match against labelSelector.

+

maxSkew

+

Integer

+

MaxSkew describes the degree to which pods may be unevenly distributed. When whenUnsatisfiable=DoNotSchedule, it is the maximum permitted difference between the number of matching pods in the target topology and the global minimum. The global minimum is the minimum number of matching pods in an eligible domain or zero if the number of eligible domains is less than MinDomains. For example, in a 3-zone cluster, MaxSkew is set to 1, and pods with the same labelSelector spread as 2/2/1: In this case, the global minimum is 1. | zone1 | zone2 | zone3 | | P P | P P | P | - if MaxSkew is 1, incoming pod can only be scheduled to zone3 to become 2/2/2; scheduling it onto zone1(zone2) would make the ActualSkew(3-1) on zone1(zone2) violate MaxSkew(1). - if MaxSkew is 2, incoming pod can be scheduled onto any zone. When whenUnsatisfiable=ScheduleAnyway, it is used to give higher precedence to topologies that satisfy it. It's a required field. Default value is 1 and 0 is not allowed.

+

minDomains

+

Integer

+

MinDomains indicates a minimum number of eligible domains. When the number of eligible domains with matching topology keys is less than minDomains, Pod Topology Spread treats "global minimum" as 0, and then the calculation of Skew is performed. And when the number of eligible domains with matching topology keys equals or greater than minDomains, this value has no effect on scheduling. As a result, when the number of eligible domains is less than minDomains, scheduler won't schedule more than maxSkew Pods to those domains. If value is nil, the constraint behaves as if MinDomains is equal to 1. Valid values are integers greater than 0. When value is not nil, WhenUnsatisfiable must be DoNotSchedule.

+

For example, in a 3-zone cluster, MaxSkew is set to 2, MinDomains is set to 5 and pods with the same labelSelector spread as 2/2/2: | zone1 | zone2 | zone3 | | P P | P P | P P | The number of domains is less than 5(MinDomains), so "global minimum" is treated as 0. In this situation, new pod with the same labelSelector cannot be scheduled, because computed skew will be 3(3 - 0) if new Pod is scheduled to any of the three zones, it will violate MaxSkew.

+

This is a beta field and requires the MinDomainsInPodTopologySpread feature gate to be enabled (enabled by default).

+

nodeAffinityPolicy

+

String

+

NodeAffinityPolicy indicates how we will treat Pod's nodeAffinity/nodeSelector when calculating pod topology spread skew. Options are: - Honor: only nodes matching nodeAffinity/nodeSelector are included in the calculations. - Ignore: nodeAffinity/nodeSelector are ignored. All nodes are included in the calculations.

+

If this value is nil, the behavior is equivalent to the Honor policy. This is a alpha-level feature enabled by the NodeInclusionPolicyInPodTopologySpread feature flag.

+

nodeTaintsPolicy

+

String

+

NodeTaintsPolicy indicates how we will treat node taints when calculating pod topology spread skew. Options are: - Honor: nodes without taints, along with tainted nodes for which the incoming pod has a toleration, are included. - Ignore: node taints are ignored. All nodes are included.

+

If this value is nil, the behavior is equivalent to the Ignore policy. This is a alpha-level feature enabled by the NodeInclusionPolicyInPodTopologySpread feature flag.

+

topologyKey

+

String

+

TopologyKey is the key of node labels. Nodes that have a label

+

with this key and identical values are considered to be in the same topology.

+

We consider each <key, value> as a "bucket", and try to put balanced number

+

of pods into each bucket. We define a domain as a particular instance of

+

a topology. Also, we define an eligible domain as a domain whose nodes meet

+

the requirements of nodeAffinityPolicy and nodeTaintsPolicy. e.g. If TopologyKey

+

is "kubernetes.io/hostname", each Node is a domain of that topology. And,

+

if TopologyKey is "topology.kubernetes.io/zone", each zone is a domain of

+

that topology. It's a required field.

+

whenUnsatisfiable

+

String

+

WhenUnsatisfiable indicates how to deal with a pod if it doesn't satisfy the spread constraint. - DoNotSchedule (default) tells the scheduler not to schedule it. - ScheduleAnyway tells the scheduler to schedule the pod in any location,

+

but giving higher precedence to topologies that would help reduce the

+

skew.

+

A constraint is considered "Unsatisfiable" for an incoming pod if and only if every possible node assignment for that pod would violate "MaxSkew" on some topology. For example, in a 3-zone cluster, MaxSkew is set to 1, and pods with the same labelSelector spread as 3/1/1: | zone1 | zone2 | zone3 | | P P P | P | P | If WhenUnsatisfiable is set to DoNotSchedule, incoming pod can only be scheduled to zone2(zone3) to become 3/2/1(3/1/2) as ActualSkew(2-1) on zone2(zone3) satisfies MaxSkew(1). In other words, the cluster can still be imbalanced, but scheduler won't make it more imbalanced. It's a required field.

+

Possible enum values:

+
  • "DoNotSchedule" instructs the scheduler not to schedule the pod when constraints are not satisfied.
  • "ScheduleAnyway" instructs the scheduler to schedule the pod even if constraints are not satisfied.
+
+
+ +
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Table 188 io.cci.otc.api.pkg.apis.versioned.cci.v2.Volume

Parameter

+

Type

+

Description

+

configMap

+

io.cci.otc.api.pkg.apis.versioned.cci.v2.ConfigMapVolumeSource object

+

configMap represents a configMap that should populate this volume

+

downwardAPI

+

io.cci.otc.api.pkg.apis.versioned.cci.v2.DownwardAPIVolumeSource object

+

downwardAPI represents downward API about the pod that should

+

populate this volume

+

emptyDir

+

io.cci.otc.api.pkg.apis.versioned.cci.v2.EmptyDirVolumeSource object

+

emptyDir represents a temporary directory that shares a pod's lifetime. More info: https://kubernetes.io/docs/concepts/storage/volumes#emptydir

+

ephemeral

+

io.cci.otc.api.pkg.apis.versioned.cci.v2.EphemeralVolumeSource object

+

ephemeral represents a volume that is handled by a cluster storage driver. The volume's lifecycle is tied to the pod that defines it - it will be created before the pod starts, and deleted when the pod is removed.

+

Use this if: a) the volume is only needed while the pod runs, b) features of normal volumes like restoring from snapshot or capacity

+

tracking are needed,

+

c) the storage driver is specified through a storage class, and d) the storage driver supports dynamic volume provisioning through

+

a PersistentVolumeClaim (see EphemeralVolumeSource for more

+

information on the connection between this volume type

+

and PersistentVolumeClaim).

+

Use PersistentVolumeClaim or one of the vendor-specific APIs for volumes that persist for longer than the lifecycle of an individual pod.

+

Use CSI for light-weight local ephemeral volumes if the CSI driver is meant to be used that way - see the documentation of the driver for more information.

+

A pod can use both types of ephemeral volumes and persistent volumes at the same time.

+

name

+

String

+

name of the volume. Must be a DNS_LABEL and unique within the pod. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names

+

nfs

+

io.cci.otc.api.pkg.apis.versioned.cci.v2.NFSVolumeSource object

+

nfs represents an NFS mount on the host that shares a pod's lifetime More info: https://kubernetes.io/docs/concepts/storage/volumes#nfs

+

persistentVolumeClaim

+

io.cci.otc.api.pkg.apis.versioned.cci.v2.PersistentVolumeClaimVolumeSource object

+

persistentVolumeClaimVolumeSource represents a reference to a PersistentVolumeClaim in the same namespace. More info: https://kubernetes.io/docs/concepts/storage/persistent-volumes#persistentvolumeclaims

+

projected

+

io.cci.otc.api.pkg.apis.versioned.cci.v2.ProjectedVolumeSource object

+

projected items for all in one resources secrets, configmaps,

+

and downward API

+

secret

+

io.cci.otc.api.pkg.apis.versioned.cci.v2.SecretVolumeSource object

+

secret represents a secret that should populate this volume. More info: https://kubernetes.io/docs/concepts/storage/volumes#secret

+
+
+ +
+ + + + + + + + + + + + + + + + + + + + + +
Table 189 io.cci.otc.api.pkg.apis.versioned.cci.v2.ConfigMapVolumeSource

Parameter

+

Type

+

Description

+

defaultMode

+

Integer

+

defaultMode is optional: mode bits used to set permissions on created files by default. Must be an octal value between 0000 and 0777 or a decimal value between 0 and 511. YAML accepts both octal and decimal values, JSON requires decimal values for mode bits. Defaults to 0644. Directories within the path are not affected by this setting. This might be in conflict with other options that affect the file mode, like fsGroup, and the result can be other mode bits set.

+

items

+

Array of io.cci.otc.api.pkg.apis.versioned.cci.v2.KeyToPath objects

+

items if unspecified, each key-value pair in the Data field of

+

the referenced ConfigMap will be projected into the volume as a file whose

+

name is the key and content is the value. If specified, the listed keys

+

will be projected into the specified paths, and unlisted keys will not be

+

present. If a key is specified which is not present in the ConfigMap, the

+

volume setup will error unless it is marked optional. Paths must be relative

+

and may not contain the '..' path or start with '..'.

+

name

+

String

+

Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names

+

optional

+

Boolean

+

optional specify whether the ConfigMap or its keys must be defined

+
+
+ +
+ + + + + + + + + + + + + +
Table 190 io.cci.otc.api.pkg.apis.versioned.cci.v2.DownwardAPIVolumeSource

Parameter

+

Type

+

Description

+

defaultMode

+

Integer

+

Optional: mode bits to use on created files by default. Must be a Optional: mode bits used to set permissions on created files by default. Must be an octal value between 0000 and 0777 or a decimal value between 0 and 511. YAML accepts both octal and decimal values, JSON requires decimal values for mode bits. Defaults to 0644. Directories within the path are not affected by this setting. This might be in conflict with other options that affect the file mode, like fsGroup, and the result can be other mode bits set.

+

items

+

Array of io.cci.otc.api.pkg.apis.versioned.cci.v2.DownwardAPIVolumeFile objects

+

Items is a list of downward API volume file

+
+
+ +
+ + + + + + + + + + + + + +
Table 191 io.cci.otc.api.pkg.apis.versioned.cci.v2.EmptyDirVolumeSource

Parameter

+

Type

+

Description

+

medium

+

String

+

medium represents what type of storage medium should back this directory. The default is "" which means to use the node's default medium. Must be an empty string (default) or Memory. More info: https://kubernetes.io/docs/concepts/storage/volumes#emptydir

+

sizeLimit

+

String

+

sizeLimit is the total amount of local storage required for this EmptyDir volume. The size limit is also applicable for memory medium. The maximum usage on memory medium EmptyDir would be the minimum value between the SizeLimit specified here and the sum of memory limits of all containers in a pod. The default is nil which means that the limit is undefined. More info: http://kubernetes.io/docs/user-guide/volumes#emptydir

+
+
+ +
+ + + + + + + + + +
Table 192 io.cci.otc.api.pkg.apis.versioned.cci.v2.EphemeralVolumeSource

Parameter

+

Type

+

Description

+

volumeClaimTemplate

+

io.cci.otc.api.pkg.apis.versioned.cci.v2.PersistentVolumeClaimTemplate object

+

Will be used to create a stand-alone PVC to provision the volume. The pod in which this EphemeralVolumeSource is embedded will be the owner of the PVC, i.e. the PVC will be deleted together with the pod. The name of the PVC will be <pod name>-<volume name> where <volume name> is the name from the PodSpec.Volumes array entry. Pod validation will reject the pod if the concatenated name is not valid for a PVC (for example, too long).

+

An existing PVC with that name that is not owned by the pod will not be used for the pod to avoid using an unrelated volume by mistake. Starting the pod is then blocked until the unrelated PVC is removed. If such a pre-created PVC is meant to be used by the pod, the PVC has to updated with an owner reference to the pod once the pod exists. Normally this should not be necessary, but it may be useful when manually reconstructing a broken cluster.

+

This field is read-only and no changes will be made by Kubernetes to the PVC after it has been created.

+

Required, must not be nil.

+
+
+ +
+ + + + + + + + + + + + + +
Table 193 io.cci.otc.api.pkg.apis.versioned.cci.v2.PersistentVolumeClaimTemplate

Parameter

+

Type

+

Description

+

metadata

+

io.k8s.apimachinery.pkg.apis.meta.v1.ObjectMeta object

+

May contain labels and annotations that will be copied into the

+

PVC when creating it. No other fields are allowed and will be rejected during

+

validation.

+

spec

+

io.cci.otc.api.pkg.apis.versioned.cci.v2.PersistentVolumeClaimSpec object

+

The specification for the PersistentVolumeClaim. The entire content

+

is copied unchanged into the PVC that gets created from this template. The

+

same fields as in a PersistentVolumeClaim are also valid here.

+
+
+ +
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Table 194 io.k8s.apimachinery.pkg.apis.meta.v1.ObjectMeta

Parameter

+

Type

+

Description

+

annotations

+

Map<String,String>

+

Annotations is an unstructured key value map stored with a resource that may be set by external tools to store and retrieve arbitrary metadata. They are not queryable and should be preserved when modifying objects. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/annotations/

+

clusterName

+

String

+

The name of the cluster which the object belongs to. This is

+

used to distinguish resources with same name and namespace in different

+

clusters. This field is not set anywhere right now and apiserver is going

+

to ignore it if set in create or update request.

+

creationTimestamp

+

String

+

CreationTimestamp is a timestamp representing the server time when this object was created. It is not guaranteed to be set in happens-before order across separate operations. Clients may not set this value. It is represented in RFC3339 form and is in UTC.

+

Populated by the system. Read-only. Null for lists. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata

+

deletionGracePeriodSeconds

+

Long

+

Number of seconds allowed for this object to gracefully terminate

+

before it will be removed from the system. Only set when deletionTimestamp

+

is also set. May only be shortened. Read-only.

+

deletionTimestamp

+

String

+

DeletionTimestamp is RFC 3339 date and time at which this resource will be deleted. This field is set by the server when a graceful deletion is requested by the user, and is not directly settable by a client. The resource is expected to be deleted (no longer visible from resource lists, and not reachable by name) after the time in this field, once the finalizers list is empty. As long as the finalizers list contains items, deletion is blocked. Once the deletionTimestamp is set, this value may not be unset or be set further into the future, although it may be shortened or the resource may be deleted prior to this time. For example, a user may request that a pod is deleted in 30 seconds. The Kubelet will react by sending a graceful termination signal to the containers in the pod. After that 30 seconds, the Kubelet will send a hard termination signal (SIGKILL) to the container and after cleanup, remove the pod from the API. In the presence of network partitions, this object may still exist after this timestamp, until an administrator or automated process can determine the resource is fully terminated. If not set, graceful deletion of the object has not been requested.

+

Populated by the system when a graceful deletion is requested. Read-only. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata

+

enable

+

Boolean

+

Enable identifies whether the resource is available

+

finalizers

+

Array of strings

+

Must be empty before the object is deleted from the registry.

+

Each entry is an identifier for the responsible component that will remove

+

the entry from the list. If the deletionTimestamp of the object is non-nil,

+

entries in this list can only be removed. Finalizers may be processed and

+

removed in any order. Order is NOT enforced because it introduces significant

+

risk of stuck finalizers. finalizers is a shared field, any actor with permission

+

can reorder it. If the finalizer list is processed in order, then this can

+

lead to a situation in which the component responsible for the first finalizer

+

in the list is waiting for a signal (field value, external system, or other)

+

produced by a component responsible for a finalizer later in the list, resulting

+

in a deadlock. Without enforced ordering finalizers are free to order amongst

+

themselves and are not vulnerable to ordering changes in the list.

+

generateName

+

String

+

GenerateName is an optional prefix, used by the server, to generate a unique name ONLY IF the Name field has not been provided. If this field is used, the name returned to the client will be different than the name passed. This value will also be combined with a unique suffix. The provided value has the same validation rules as the Name field, and may be truncated by the length of the suffix required to make the value unique on the server.

+

If this field is specified and the generated name exists, the server will NOT return a 409 - instead, it will either return 201 Created or 500 with Reason ServerTimeout indicating a unique name could not be found in the time allotted, and the client should retry (optionally after the time indicated in the Retry-After header).

+

Applied only if Name is not specified. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#idempotency

+

generation

+

Long

+

A sequence number representing a specific generation of the desired

+

state. Populated by the system. Read-only.

+

labels

+

Map<String,String>

+

Map of string keys and values that can be used to organize and categorize (scope and select) objects. May match selectors of replication controllers and services. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/labels/

+

managedFields

+

Array of io.k8s.apimachinery.pkg.apis.meta.v1.ManagedFieldsEntry objects

+

ManagedFields maps workflow-id and version to the set of fields

+

that are managed by that workflow. This is mostly for internal housekeeping,

+

and users typically shouldn't need to set or understand this field. A workflow

+

can be the user's name, a controller's name, or the name of a specific apply

+

path like "ci-cd". The set of fields is always in the version that the workflow

+

used when modifying the object.

+

name

+

String

+

Name must be unique within a namespace. Is required when creating resources, although some resources may allow a client to request the generation of an appropriate name automatically. Name is primarily intended for creation idempotence and configuration definition. Cannot be updated. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names

+

namespace

+

String

+

Namespace defines the space within which each name must be unique. An empty namespace is equivalent to the "default" namespace, but "default" is the canonical representation. Not all objects are required to be scoped to a namespace - the value of this field for those objects will be empty.

+

Must be a DNS_LABEL. Cannot be updated. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/namespaces/

+

ownerReferences

+

Array of io.k8s.apimachinery.pkg.apis.meta.v1.OwnerReference objects

+

List of objects depended by this object. If ALL objects in the

+

list have been deleted, this object will be garbage collected. If this object

+

is managed by a controller, then an entry in this list will point to this

+

controller, with the controller field set to true. There cannot be more

+

than one managing controller.

+

resourceVersion

+

String

+

An opaque value that represents the internal version of this object that can be used by clients to determine when objects have changed. May be used for optimistic concurrency, change detection, and the watch operation on a resource or set of resources. Clients must treat these values as opaque and passed unmodified back to the server. They may only be valid for a particular resource or set of resources.

+

Populated by the system. Read-only. Value must be treated as opaque by clients and . More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#concurrency-control-and-consistency

+

selfLink

+

String

+

SelfLink is a URL representing this object. Populated by the system. Read-only.

+

DEPRECATED Kubernetes will stop propagating this field in 1.20 release and the field is planned to be removed in 1.21 release.

+

uid

+

String

+

UID is the unique in time and space value for this object. It is typically generated by the server on successful creation of a resource and is not allowed to change on PUT operations.

+

Populated by the system. Read-only. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#uids

+
+
+ +
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Table 195 io.k8s.apimachinery.pkg.apis.meta.v1.ManagedFieldsEntry

Parameter

+

Type

+

Description

+

apiVersion

+

String

+

APIVersion defines the version of this resource that this field

+

set applies to. The format is "group/version" just like the top-level APIVersion

+

field. It is necessary to track the version of a field set because it cannot

+

be automatically converted.

+

fieldsType

+

String

+

FieldsType is the discriminator for the different fields format and version. There is currently only one possible value: "FieldsV1"

+

fieldsV1

+

Object

+

FieldsV1 holds the first JSON version format as described in

+

the "FieldsV1" type.

+

manager

+

String

+

Manager is an identifier of the workflow managing these fields.

+

operation

+

String

+

Operation is the type of operation which lead to this ManagedFieldsEntry

+

being created. The only valid values for this field are 'Apply' and 'Update'.

+

time

+

String

+

Time is timestamp of when these fields were set. It should always

+

be empty if Operation is 'Apply'

+
+
+ +
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Table 196 io.k8s.apimachinery.pkg.apis.meta.v1.OwnerReference

Parameter

+

Type

+

Description

+

apiVersion

+

String

+

API version of the referent.

+

blockOwnerDeletion

+

Boolean

+

If true, AND if the owner has the "foregroundDeletion" finalizer,

+

then the owner cannot be deleted from the key-value store until this reference

+

is removed. Defaults to false. To set this field, a user needs "delete"

+

permission of the owner, otherwise 422 (Unprocessable Entity) will be returned.

+

controller

+

Boolean

+

If true, this reference points to the managing controller.

+

kind

+

String

+

Kind of the referent. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds

+

name

+

String

+

Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names

+

uid

+

String

+

UID of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#uids

+
+
+ +
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Table 197 io.cci.otc.api.pkg.apis.versioned.cci.v2.PersistentVolumeClaimSpec

Parameter

+

Type

+

Description

+

accessModes

+

Array of strings

+

accessModes contains the desired access modes the volume should have. More info: https://kubernetes.io/docs/concepts/storage/persistent-volumes#access-modes-1

+

dataSource

+

io.cci.otc.api.pkg.apis.versioned.cci.v2.TypedLocalObjectReference object

+

dataSource field can be used to specify either: * An existing VolumeSnapshot object (snapshot.storage.k8s.io/VolumeSnapshot) * An existing PVC (PersistentVolumeClaim) If the provisioner or an external controller can support the specified data source, it will create a new volume based on the contents of the specified data source. If the AnyVolumeDataSource feature gate is enabled, this field will always have the same contents as the DataSourceRef field.

+

dataSourceRef

+

io.cci.otc.api.pkg.apis.versioned.cci.v2.TypedLocalObjectReference object

+

dataSourceRef specifies the object from which to populate the volume with data, if a non-empty volume is desired. This may be any local object from a non-empty API group (non core object) or a PersistentVolumeClaim object. When this field is specified, volume binding will only succeed if the type of the specified object matches some installed volume populator or dynamic provisioner. This field will replace the functionality of the DataSource field and as such if both fields are non-empty, they must have the same value. For backwards compatibility, both fields (DataSource and DataSourceRef) will be set to the same value automatically if one of them is empty and the other is non-empty. There are two important differences between DataSource and DataSourceRef: * While DataSource only allows two specific types of objects, DataSourceRef

+

allows any non-core object, as well as PersistentVolumeClaim objects.

+
  • While DataSource ignores disallowed values (dropping them), DataSourceRef

    preserves all values, and generates an error if a disallowed value is

    +

    specified.

    +

    (Beta) Using this field requires the AnyVolumeDataSource feature gate to be enabled.

    +
+

resources

+

io.cci.otc.api.pkg.apis.versioned.cci.v2.ResourceRequirements object

+

resources represents the minimum resources the volume should have. If RecoverVolumeExpansionFailure feature is enabled users are allowed to specify resource requirements that are lower than previous value but must still be higher than capacity recorded in the status field of the claim. More info: https://kubernetes.io/docs/concepts/storage/persistent-volumes#resources

+

selector

+

io.k8s.apimachinery.pkg.apis.meta.v1.LabelSelector object

+

selector is a label query over volumes to consider for binding.

+

storageClassName

+

String

+

storageClassName is the name of the StorageClass required by the claim. More info: https://kubernetes.io/docs/concepts/storage/persistent-volumes#class-1

+

volumeMode

+

String

+

volumeMode defines what type of volume is required by the claim.

+

Value of Filesystem is implied when not included in claim spec.

+

volumeName

+

String

+

volumeName is the binding reference to the PersistentVolume backing

+

this claim.

+
+
+ +
+ + + + + + + + + + + + + + + + + +
Table 198 io.cci.otc.api.pkg.apis.versioned.cci.v2.TypedLocalObjectReference

Parameter

+

Type

+

Description

+

apiGroup

+

String

+

APIGroup is the group for the resource being referenced. If APIGroup

+

is not specified, the specified Kind must be in the core API group. For

+

any other third-party types, APIGroup is required.

+

kind

+

String

+

Kind is the type of resource being referenced

+

name

+

String

+

Name is the name of resource being referenced

+
+
+ +
+ + + + + + + + + + + + + +
Table 199 io.cci.otc.api.pkg.apis.versioned.cci.v2.ResourceRequirements

Parameter

+

Type

+

Description

+

limits

+

Map<String,String>

+

Limits describes the maximum amount of compute resources allowed. More info: https://kubernetes.io/docs/concepts/configuration/manage-resources-containers/

+

requests

+

Map<String,String>

+

Requests describes the minimum amount of compute resources required. If Requests is omitted for a container, it defaults to Limits if that is explicitly specified, otherwise to an implementation-defined value. More info: https://kubernetes.io/docs/concepts/configuration/manage-resources-containers/

+
+
+ +
+ + + + + + + + + +
Table 200 io.k8s.apimachinery.pkg.api.resource.Quantity

Parameter

+

Type

+

Description

+

-

+

String

+

Quantity is a fixed-point representation of a number. It provides convenient marshaling/unmarshaling in JSON and YAML, in addition to String() and AsInt64() accessors.

+

The serialization format is:

+

[/topic/body/section/table/tgroup/tbody/row/entry/p/br {""}) (br] ::= [/topic/body/section/table/tgroup/tbody/row/entry/p/br {""}) (br][/topic/body/section/table/tgroup/tbody/row/entry/p/br {""}) (br]

+

(Note that [/topic/body/section/table/tgroup/tbody/row/entry/p/br {""}) (br] may be empty, from the "" case in [/topic/body/section/table/tgroup/tbody/row/entry/p/br {""}) (br].)

+

[/topic/body/section/table/tgroup/tbody/row/entry/p/br {""}) (br] ::= 0 | 1 | ... | 9 [/topic/body/section/table/tgroup/tbody/row/entry/p/br {""}) (br] ::= [/topic/body/section/table/tgroup/tbody/row/entry/p/br {""}) (br] | [/topic/body/section/table/tgroup/tbody/row/entry/p/br {""}) (br][/topic/body/section/table/tgroup/tbody/row/entry/p/br {""}) (br] [/topic/body/section/table/tgroup/tbody/row/entry/p/br {""}) (br] ::= [/topic/body/section/table/tgroup/tbody/row/entry/p/br {""}) (br] | [/topic/body/section/table/tgroup/tbody/row/entry/p/br {""}) (br].[/topic/body/section/table/tgroup/tbody/row/entry/p/br {""}) (br] | [/topic/body/section/table/tgroup/tbody/row/entry/p/br {""}) (br]. | .[/topic/body/section/table/tgroup/tbody/row/entry/p/br {""}) (br] [/topic/body/section/table/tgroup/tbody/row/entry/p/br {""}) (br] ::= "+" | "-" [/topic/body/section/table/tgroup/tbody/row/entry/p/br {""}) (br] ::= [/topic/body/section/table/tgroup/tbody/row/entry/p/br {""}) (br] | [/topic/body/section/table/tgroup/tbody/row/entry/p/br {""}) (br][/topic/body/section/table/tgroup/tbody/row/entry/p/br {""}) (br] [/topic/body/section/table/tgroup/tbody/row/entry/p/br {""}) (br] ::= [/topic/body/section/table/tgroup/tbody/row/entry/p/br {""}) (br] | [/topic/body/section/table/tgroup/tbody/row/entry/p/br {""}) (br] | [/topic/body/section/table/tgroup/tbody/row/entry/p/br {""}) (br] [/topic/body/section/table/tgroup/tbody/row/entry/p/br {""}) (br] ::= Ki | Mi | Gi | Ti | Pi | Ei

+

(International System of units; See: http://physics.nist.gov/cuu/Units/binary.html)

+

[/topic/body/section/table/tgroup/tbody/row/entry/p/br {""}) (br] ::= m | "" | k | M | G | T | P | E

+

(Note that 1024 = 1Ki but 1000 = 1k; I didn't choose the capitalization.)

+

[/topic/body/section/table/tgroup/tbody/row/entry/p/br {""}) (br] ::= "e" [/topic/body/section/table/tgroup/tbody/row/entry/p/br {""}) (br] | "E" [/topic/body/section/table/tgroup/tbody/row/entry/p/br {""}) (br]

+

No matter which of the three exponent forms is used, no quantity may represent a number greater than 2^63-1 in magnitude, nor may it have more than 3 decimal places. Numbers larger or more precise will be capped or rounded up. (E.g.: 0.1m will rounded up to 1m.) This may be extended in the future if we require larger or smaller quantities.

+

When a Quantity is parsed from a string, it will remember the type of suffix it had, and will use the same type again when it is serialized.

+

Before serializing, Quantity will be put in "canonical form". This means that Exponent/suffix will be adjusted up or down (with a corresponding increase or decrease in Mantissa) such that:

+

a. No precision is lost

+

b. No fractional digits will be emitted

+

c. The exponent (or suffix) is as large as possible.

+

The sign will be omitted unless the number is negative.

+

Examples:

+

1.5 will be serialized as "1500m"

+

1.5Gi will be serialized as "1536Mi"

+

Note that the quantity will NEVER be internally represented by a floating point number. That is the whole point of this exercise.

+

Non-canonical values will still parse as long as they are well formed, but will be re-emitted in their canonical form. (So always use canonical form, or don't diff.)

+

This format is intended to make it difficult to use these numbers without writing some sort of special handling code in the hopes that that will cause implementors to also use a fixed point implementation.

+
+
+ +
+ + + + + + + + + + + + + +
Table 201 io.k8s.apimachinery.pkg.apis.meta.v1.LabelSelector

Parameter

+

Type

+

Description

+

matchExpressions

+

Array of io.k8s.apimachinery.pkg.apis.meta.v1.LabelSelectorRequirement objects

+

matchExpressions is a list of label selector requirements. The

+

requirements are ANDed.

+

matchLabels

+

Map<String,String>

+

matchLabels is a map of {key,value} pairs. A single {key,value}

+

in the matchLabels map is equivalent to an element of matchExpressions,

+

whose key field is "key", the operator is "In", and the values array contains

+

only "value". The requirements are ANDed.

+
+
+ +
+ + + + + + + + + + + + + + + + + +
Table 202 io.k8s.apimachinery.pkg.apis.meta.v1.LabelSelectorRequirement

Parameter

+

Type

+

Description

+

key

+

String

+

key is the label key that the selector applies to.

+

operator

+

String

+

operator represents a key's relationship to a set of values.

+

Valid operators are In, NotIn, Exists and DoesNotExist.

+

values

+

Array of strings

+

values is an array of string values. If the operator is In or

+

NotIn, the values array must be non-empty. If the operator is Exists or

+

DoesNotExist, the values array must be empty. This array is replaced during

+

a strategic merge patch.

+
+
+ +
+ + + + + + + + + + + + + + + + + +
Table 203 io.cci.otc.api.pkg.apis.versioned.cci.v2.NFSVolumeSource

Parameter

+

Type

+

Description

+

path

+

String

+

path that is exported by the NFS server. More info: https://kubernetes.io/docs/concepts/storage/volumes#nfs

+

readOnly

+

Boolean

+

readOnly here will force the NFS export to be mounted with read-only permissions. Defaults to false. More info: https://kubernetes.io/docs/concepts/storage/volumes#nfs

+

server

+

String

+

server is the hostname or IP address of the NFS server. More info: https://kubernetes.io/docs/concepts/storage/volumes#nfs

+
+
+ +
+ + + + + + + + + + + + + +
Table 204 io.cci.otc.api.pkg.apis.versioned.cci.v2.PersistentVolumeClaimVolumeSource

Parameter

+

Type

+

Description

+

claimName

+

String

+

claimName is the name of a PersistentVolumeClaim in the same namespace as the pod using this volume. More info: https://kubernetes.io/docs/concepts/storage/persistent-volumes#persistentvolumeclaims

+

readOnly

+

Boolean

+

readOnly Will force the ReadOnly setting in VolumeMounts. Default

+

false.

+
+
+ +
+ + + + + + + + + + + + + +
Table 205 io.cci.otc.api.pkg.apis.versioned.cci.v2.ProjectedVolumeSource

Parameter

+

Type

+

Description

+

defaultMode

+

Integer

+

defaultMode are the mode bits used to set permissions on created

+

files by default. Must be an octal value between 0000 and 0777 or a decimal

+

value between 0 and 511. YAML accepts both octal and decimal values, JSON

+

requires decimal values for mode bits. Directories within the path are not

+

affected by this setting. This might be in conflict with other options that

+

affect the file mode, like fsGroup, and the result can be other mode bits

+

set.

+

sources

+

Array of io.cci.otc.api.pkg.apis.versioned.cci.v2.VolumeProjection objects

+

sources is the list of volume projections

+
+
+ +
+ + + + + + + + + + + + + + + + + +
Table 206 io.cci.otc.api.pkg.apis.versioned.cci.v2.VolumeProjection

Parameter

+

Type

+

Description

+

configMap

+

io.cci.otc.api.pkg.apis.versioned.cci.v2.ConfigMapProjection object

+

configMap information about the configMap data to project

+

downwardAPI

+

io.cci.otc.api.pkg.apis.versioned.cci.v2.DownwardAPIProjection object

+

downwardAPI information about the downwardAPI data to project

+

secret

+

io.cci.otc.api.pkg.apis.versioned.cci.v2.SecretProjection object

+

secret information about the secret data to project

+
+
+ +
+ + + + + + + + + + + + + + + + + +
Table 207 io.cci.otc.api.pkg.apis.versioned.cci.v2.ConfigMapProjection

Parameter

+

Type

+

Description

+

items

+

Array of io.cci.otc.api.pkg.apis.versioned.cci.v2.KeyToPath objects

+

items if unspecified, each key-value pair in the Data field of

+

the referenced ConfigMap will be projected into the volume as a file whose

+

name is the key and content is the value. If specified, the listed keys

+

will be projected into the specified paths, and unlisted keys will not be

+

present. If a key is specified which is not present in the ConfigMap, the

+

volume setup will error unless it is marked optional. Paths must be relative

+

and may not contain the '..' path or start with '..'.

+

name

+

String

+

Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names

+

optional

+

Boolean

+

optional specify whether the ConfigMap or its keys must be defined

+
+
+ +
+ + + + + + + + + +
Table 208 io.cci.otc.api.pkg.apis.versioned.cci.v2.DownwardAPIProjection

Parameter

+

Type

+

Description

+

items

+

Array of io.cci.otc.api.pkg.apis.versioned.cci.v2.DownwardAPIVolumeFile objects

+

Items is a list of DownwardAPIVolume file

+
+
+ +
+ + + + + + + + + + + + + + + + + + + + + +
Table 209 io.cci.otc.api.pkg.apis.versioned.cci.v2.DownwardAPIVolumeFile

Parameter

+

Type

+

Description

+

fieldRef

+

io.cci.otc.api.pkg.apis.versioned.cci.v2.ObjectFieldSelector object

+

Required: Selects a field of the pod: only annotations, labels, name and namespace are supported.

+

mode

+

Integer

+

Optional: mode bits used to set permissions on this file, must be an octal value between 0000 and 0777 or a decimal value between 0 and 511. YAML accepts both octal and decimal values, JSON requires decimal values for mode bits. If not specified, the volume defaultMode will be used. This might be in conflict with other options that affect the file mode, like fsGroup, and the result can be other mode bits set.

+

path

+

String

+

Required: Path is the relative path name of the file to be created. Must not be absolute or contain the '..' path. Must be utf-8 encoded. The first item of the relative path must not start with '..'

+

resourceFieldRef

+

io.cci.otc.api.pkg.apis.versioned.cci.v2.ResourceFieldSelector object

+

Selects a resource of the container: only resources limits and requests (limits.cpu, limits.memory, requests.cpu and requests.memory) are currently supported.

+
+
+ +
+ + + + + + + + + + + + + +
Table 210 io.cci.otc.api.pkg.apis.versioned.cci.v2.ObjectFieldSelector

Parameter

+

Type

+

Description

+

apiVersion

+

String

+

Version of the schema the FieldPath is written in terms of, defaults

+

to "v1".

+

fieldPath

+

String

+

Path of the field to select in the specified API version.

+
+
+ +
+ + + + + + + + + + + + + + + + + +
Table 211 io.cci.otc.api.pkg.apis.versioned.cci.v2.ResourceFieldSelector

Parameter

+

Type

+

Description

+

containerName

+

String

+

Container name: required for volumes, optional for env vars

+

divisor

+

String

+

Specifies the output format of the exposed resources, defaults

+

to "1"

+

resource

+

String

+

Required: resource to select

+
+
+ +
+ + + + + + + + + + + + + + + + + +
Table 212 io.cci.otc.api.pkg.apis.versioned.cci.v2.SecretProjection

Parameter

+

Type

+

Description

+

items

+

Array of io.cci.otc.api.pkg.apis.versioned.cci.v2.KeyToPath objects

+

items if unspecified, each key-value pair in the Data field of

+

the referenced Secret will be projected into the volume as a file whose

+

name is the key and content is the value. If specified, the listed keys

+

will be projected into the specified paths, and unlisted keys will not be

+

present. If a key is specified which is not present in the Secret, the volume

+

setup will error unless it is marked optional. Paths must be relative and

+

may not contain the '..' path or start with '..'.

+

name

+

String

+

Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names

+

optional

+

Boolean

+

optional field specify whether the Secret or its key must be

+

defined

+
+
+ +
+ + + + + + + + + + + + + + + + + + + + + +
Table 213 io.cci.otc.api.pkg.apis.versioned.cci.v2.SecretVolumeSource

Parameter

+

Type

+

Description

+

defaultMode

+

Integer

+

defaultMode is Optional: mode bits used to set permissions on created files by default. Must be an octal value between 0000 and 0777 or a decimal value between 0 and 511. YAML accepts both octal and decimal values, JSON requires decimal values for mode bits. Defaults to 0644. Directories within the path are not affected by this setting. This might be in conflict with other options that affect the file mode, like fsGroup, and the result can be other mode bits set.

+

items

+

Array of io.cci.otc.api.pkg.apis.versioned.cci.v2.KeyToPath objects

+

items If unspecified, each key-value pair in the Data field of

+

the referenced Secret will be projected into the volume as a file whose

+

name is the key and content is the value. If specified, the listed keys

+

will be projected into the specified paths, and unlisted keys will not be

+

present. If a key is specified which is not present in the Secret, the volume

+

setup will error unless it is marked optional. Paths must be relative and

+

may not contain the '..' path or start with '..'.

+

optional

+

Boolean

+

optional field specify whether the Secret or its keys must be

+

defined

+

secretName

+

String

+

secretName is the name of the secret in the pod's namespace to use. More info: https://kubernetes.io/docs/concepts/storage/volumes#secret

+
+
+ +
+ + + + + + + + + + + + + + + + + +
Table 214 io.cci.otc.api.pkg.apis.versioned.cci.v2.KeyToPath

Parameter

+

Type

+

Description

+

key

+

String

+

key is the key to project.

+

mode

+

Integer

+

mode is Optional: mode bits used to set permissions on this file. Must be an octal value between 0000 and 0777 or a decimal value between 0 and 511. YAML accepts both octal and decimal values, JSON requires decimal values for mode bits. If not specified, the volume defaultMode will be used. This might be in conflict with other options that affect the file mode, like fsGroup, and the result can be other mode bits set.

+

path

+

String

+

path is the relative path of the file to map the key to. May

+

not be an absolute path. May not contain the path element '..'. May not

+

start with the string '..'.

+
+
+ +
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Table 215 io.cci.otc.api.pkg.apis.versioned.cci.v2.PodStatus

Parameter

+

Type

+

Description

+

conditions

+

Array of io.cci.otc.api.pkg.apis.versioned.cci.v2.PodCondition objects

+

Current service state of pod. More info: https://kubernetes.io/docs/concepts/workloads/pods/pod-lifecycle#pod-conditions

+

containerStatuses

+

Array of io.cci.otc.api.pkg.apis.versioned.cci.v2.ContainerStatus objects

+

The list has one entry per container in the manifest. More info: https://kubernetes.io/docs/concepts/workloads/pods/pod-lifecycle#pod-and-container-status

+

ephemeralContainerStatuses

+

Array of io.cci.otc.api.pkg.apis.versioned.cci.v2.ContainerStatus objects

+

Status for any ephemeral containers that have run in this pod.

+

hostIP

+

String

+

IP address of the host to which the pod is assigned. Empty if

+

not yet scheduled.

+

initContainerStatuses

+

Array of io.cci.otc.api.pkg.apis.versioned.cci.v2.ContainerStatus objects

+

The list has one entry per init container in the manifest. The most recent successful init container will have ready = true, the most recently started container will have startTime set. More info: https://kubernetes.io/docs/concepts/workloads/pods/pod-lifecycle#pod-and-container-status

+

message

+

String

+

A human readable message indicating details about why the pod

+

is in this condition.

+

nominatedNodeName

+

String

+

nominatedNodeName is set only when this pod preempts other pods

+

on the node, but it cannot be scheduled right away as preemption victims

+

receive their graceful termination periods. This field does not guarantee

+

that the pod will be scheduled on this node. Scheduler may decide to place

+

the pod elsewhere if other nodes become available sooner. Scheduler may

+

also decide to give the resources on this node to a higher priority pod

+

that is created after preemption. As a result, this field may be different

+

than PodSpec.nodeName when the pod is scheduled.

+

phase

+

String

+

The phase of a Pod is a simple, high-level summary of where the Pod is in its lifecycle. The conditions array, the reason and message fields, and the individual container status arrays contain more detail about the pod's status. There are five possible phase values:

+

Pending: The pod has been accepted by the Kubernetes system, but one or more of the container images has not been created. This includes time before being scheduled as well as time spent downloading images over the network, which could take a while. Running: The pod has been bound to a node, and all of the containers have been created. At least one container is still running, or is in the process of starting or restarting. Succeeded: All containers in the pod have terminated in success, and will not be restarted. Failed: All containers in the pod have terminated, and at least one container has terminated in failure. The container either exited with non-zero status or was terminated by the system. Unknown: For some reason the state of the pod could not be obtained, typically due to an error in communicating with the host of the pod.

+

More info: https://kubernetes.io/docs/concepts/workloads/pods/pod-lifecycle#pod-phase

+

Possible enum values:

+
  • "Failed" means that all containers in the pod have terminated, and at least one container has terminated in a failure (exited with a non-zero exit code or was stopped by the system).
  • "Pending" means the pod has been accepted by the system, but one or more of the containers has not been started. This includes time before being bound to a node, as well as time spent pulling images onto the host.
  • "Running" means the pod has been bound to a node and all of the containers have been started. At least one container is still running or is in the process of being restarted.
  • "Succeeded" means that all containers in the pod have voluntarily terminated with a container exit code of 0, and the system is not going to restart any of these containers.
  • "Unknown" means that for some reason the state of the pod could not be obtained, typically due to an error in communicating with the host of the pod. Deprecated: It isn't being set since 2015 (74da3b14b0c0f658b3bb8d2def5094686d0e9095)
+

podIP

+

String

+

IP address allocated to the pod. Routable at least within the

+

cluster. Empty if not yet allocated.

+

podIPs

+

Array of io.cci.otc.api.pkg.apis.versioned.cci.v2.PodIP objects

+

podIPs holds the IP addresses allocated to the pod. If this field

+

is specified, the 0th entry must match the podIP field. Pods may be allocated

+

at most 1 value for each of IPv4 and IPv6. This list is empty if no IPs

+

have been allocated yet.

+

qosClass

+

String

+

The Quality of Service (QOS) classification assigned to the pod based on resource requirements See PodQOSClass type for available QOS classes More info: https://git.k8s.io/community/contributors/design-proposals/node/resource-qos.md

+

Possible enum values:

+
  • "BestEffort" is the BestEffort qos class.
  • "Burstable" is the Burstable qos class.
  • "Guaranteed" is the Guaranteed qos class.
+

reason

+

String

+

A brief CamelCase message indicating details about why the pod

+

is in this state. e.g. 'Evicted'

+

startTime

+

String

+

RFC 3339 date and time at which the object was acknowledged by

+

the Kubelet. This is before the Kubelet pulled the container image(s) for

+

the pod.

+
+
+ +
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Table 216 io.cci.otc.api.pkg.apis.versioned.cci.v2.PodCondition

Parameter

+

Type

+

Description

+

lastProbeTime

+

String

+

Last time we probed the condition.

+

lastTransitionTime

+

String

+

Last time the condition transitioned from one status to another.

+

message

+

String

+

Human-readable message indicating details about last transition.

+

reason

+

String

+

Unique, one-word, CamelCase reason for the condition's last transition.

+

status

+

String

+

Status is the status of the condition. Can be True, False, Unknown. More info: https://kubernetes.io/docs/concepts/workloads/pods/pod-lifecycle#pod-conditions

+

type

+

String

+

Type is the type of the condition. More info: https://kubernetes.io/docs/concepts/workloads/pods/pod-lifecycle#pod-conditions

+
+
+ +
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Table 217 io.cci.otc.api.pkg.apis.versioned.cci.v2.ContainerStatus

Parameter

+

Type

+

Description

+

containerID

+

String

+

Container's ID in the format '[/topic/body/section/table/tgroup/tbody/row/entry/p/br {""}) (br]://<container_id>'.

+

image

+

String

+

The image the container is running. More info: https://kubernetes.io/docs/concepts/containers/images.

+

imageID

+

String

+

ImageID of the container's image.

+

lastState

+

io.cci.otc.api.pkg.apis.versioned.cci.v2.ContainerState object

+

Details about the container's last termination condition.

+

name

+

String

+

This must be a DNS_LABEL. Each container in a pod must have a

+

unique name. Cannot be updated.

+

ready

+

Boolean

+

Specifies whether the container has passed its readiness probe.

+

restartCount

+

Integer

+

The number of times the container has been restarted.

+

started

+

Boolean

+

Specifies whether the container has passed its startup probe.

+

Initialized as false, becomes true after startupProbe is considered successful.

+

Resets to false when the container is restarted, or if kubelet loses state

+

temporarily. Is always true when no startupProbe is defined.

+

state

+

io.cci.otc.api.pkg.apis.versioned.cci.v2.ContainerState object

+

Details about the container's current condition.

+
+
+ +
+ + + + + + + + + + + + + + + + + +
Table 218 io.cci.otc.api.pkg.apis.versioned.cci.v2.ContainerState

Parameter

+

Type

+

Description

+

running

+

io.cci.otc.api.pkg.apis.versioned.cci.v2.ContainerStateRunning object

+

Details about a running container

+

terminated

+

io.cci.otc.api.pkg.apis.versioned.cci.v2.ContainerStateTerminated object

+

Details about a terminated container

+

waiting

+

io.cci.otc.api.pkg.apis.versioned.cci.v2.ContainerStateWaiting object

+

Details about a waiting container

+
+
+ +
+ + + + + + + + + +
Table 219 io.cci.otc.api.pkg.apis.versioned.cci.v2.ContainerStateRunning

Parameter

+

Type

+

Description

+

startedAt

+

String

+

Time at which the container was last (re-)started

+
+
+ +
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Table 220 io.cci.otc.api.pkg.apis.versioned.cci.v2.ContainerStateTerminated

Parameter

+

Type

+

Description

+

containerID

+

String

+

Container's ID in the format '[/topic/body/section/table/tgroup/tbody/row/entry/p/br {""}) (br]://<container_id>'

+

exitCode

+

Integer

+

Exit status from the last termination of the container

+

finishedAt

+

String

+

Time at which the container last terminated

+

message

+

String

+

Message regarding the last termination of the container

+

reason

+

String

+

(brief) reason from the last termination of the container

+

signal

+

Integer

+

Signal from the last termination of the container

+

startedAt

+

String

+

Time at which previous execution of the container started

+
+
+ +
+ + + + + + + + + + + + + +
Table 221 io.cci.otc.api.pkg.apis.versioned.cci.v2.ContainerStateWaiting

Parameter

+

Type

+

Description

+

message

+

String

+

Message regarding why the container is not yet running.

+

reason

+

String

+

(brief) reason the container is not yet running.

+
+
+ +
+ + + + + + + + + +
Table 222 io.cci.otc.api.pkg.apis.versioned.cci.v2.PodIP

Parameter

+

Type

+

Description

+

ip

+

String

+

ip is an IP address (IPv4 or IPv6) assigned to the pod

+
+
+
+

Example Requests

{
+  "apiVersion" : "cci/v2",
+  "kind" : "Pod",
+  "metadata" : {
+    "annotations" : {
+      "cni.yangtse.io/network-status" : "[{\"macAddress\":\"fa:16:3e:1d:75:3a\",\"ipv4Info\":{\"subnet\":\"192.168.0.0/24\",\"ipAddress\":\"192.168.0.197\",\"gateway\":\"192.168.0.1\"},\"name\":\"test-api\",\"portID\":\"b471658c-caac-4377-94f4-2eeff1192d2b\",\"ips\":[\"192.168.0.197\"],\"vlanID\":3687}]",
+      "networking.cci.io/vm-network-info" : "{\"vmID\":\"fda21659-a816-4449-abcf-193ac5a47b4a\",\"eniID\":\"ec9f8fae-ae74-445b-b8bb-b533e5342dbd\",\"maxEniNum\":2,\"maxSubEniNum\":16}",
+      "openvessel.io/monitoring-aominfo" : "08a2*************************c03:4257ecf3-7c47-43a3-86d2-d2b4d4aa3a20",
+      "resource.cci.io/pod-size-specs" : "2.00_4.0",
+      "resource.cci.io/size" : "2.00_4.0",
+      "scheduling.k8s.io/group-name" : "podgroup-ade5799e-9371-4c9f-ab77-0472e97211f8",
+      "tenant.cci.io/tenant-id" : "08a2*************************c03",
+      "topology.kubernetes.io/region" : "region1",
+      "topology.kubernetes.io/zone" : "region1c"
+    },
+    "creationTimestamp" : "2024-10-09T16:11:23Z",
+    "finalizers" : [ "billing.kubernetes.io/podbilling-finalizer" ],
+    "labels" : {
+      "scheduling.cci.io/vmid" : "fda21659-a816-4449-abcf-193ac5a47b4a",
+      "sys_enterprise_project_id" : "0",
+      "tenant.cci.io/tenant-id" : "08a2*************************c03",
+      "tenant.kubernetes.io/domain-id" : "08a*************************ee60",
+      "tenant.kubernetes.io/project-id" : "08a2*************************c03"
+    },
+    "name" : "test",
+    "namespace" : "test-api",
+    "resourceVersion" : "391095556",
+    "uid" : "ade5799e-9371-4c9f-ab77-0472e97211f8"
+  },
+  "spec" : {
+    "containers" : [ {
+      "env" : [ {
+        "name" : "ENV1",
+        "value" : "false"
+      }, {
+        "name" : "ENV2",
+        "value" : "xxx"
+      } ],
+      "image" : "nginx:latest",
+      "name" : "deploy-example",
+      "resources" : {
+        "limits" : {
+          "cpu" : "500m",
+          "memory" : "1Gi"
+        },
+        "requests" : {
+          "cpu" : "500m",
+          "memory" : "1Gi"
+        }
+      },
+      "terminationMessagePath" : "/dev/termination-log",
+      "terminationMessagePolicy" : "File"
+    } ],
+    "dnsPolicy" : "Default",
+    "imagePullSecrets" : [ {
+      "name" : "imagepull-secret"
+    } ],
+    "nodeName" : "compute-cell-001",
+    "restartPolicy" : "Always",
+    "schedulerName" : "volcano",
+    "securityContext" : { },
+    "terminationGracePeriodSeconds" : 30
+  },
+  "status" : {
+    "conditions" : [ {
+      "lastProbeTime" : null,
+      "lastTransitionTime" : "2024-10-09T16:11:24Z",
+      "status" : "True",
+      "type" : "Initialized"
+    }, {
+      "lastProbeTime" : null,
+      "lastTransitionTime" : "2024-10-09T16:11:28Z",
+      "status" : "True",
+      "type" : "Ready"
+    }, {
+      "lastProbeTime" : null,
+      "lastTransitionTime" : "2024-10-09T16:11:28Z",
+      "status" : "True",
+      "type" : "ContainersReady"
+    }, {
+      "lastProbeTime" : null,
+      "lastTransitionTime" : "2024-10-09T16:11:23Z",
+      "status" : "True",
+      "type" : "PodScheduled"
+    } ],
+    "containerStatuses" : [ {
+      "containerID" : "containerd://a44eef6b753babaff802d212e78afef2422959e90bd79ab5b385adb302aa3d1e",
+      "image" : "nginx:latest",
+      "imageID" : "docker.io/library/nginx@sha256:416d511ffa63777489af47f250b70d1570e428b67666567085f2bece3571ad83",
+      "lastState" : { },
+      "name" : "deploy-example",
+      "ready" : true,
+      "restartCount" : 0,
+      "started" : true,
+      "state" : {
+        "running" : {
+          "startedAt" : "2024-10-09T16:11:27Z"
+        }
+      }
+    } ],
+    "phase" : "Running",
+    "podIP" : "192.168.0.197",
+    "podIPs" : [ {
+      "ip" : "192.168.0.197"
+    } ],
+    "qosClass" : "Guaranteed",
+    "startTime" : "2024-10-09T16:11:24Z"
+  }
+}
+
+

Example Responses

Status code: 200

+

OK

+
{
+  "apiVersion" : "cci/v2",
+  "kind" : "Pod",
+  "metadata" : {
+    "annotations" : {
+      "cni.yangtse.io/network-status" : "[{\"macAddress\":\"fa:16:3e:1d:75:3a\",\"ipv4Info\":{\"subnet\":\"192.168.0.0/24\",\"ipAddress\":\"192.168.0.197\",\"gateway\":\"192.168.0.1\"},\"name\":\"test-api\",\"portID\":\"b471658c-caac-4377-94f4-2eeff1192d2b\",\"ips\":[\"192.168.0.197\"],\"vlanID\":3687}]",
+      "networking.cci.io/vm-network-info" : "{\"vmID\":\"fda21659-a816-4449-abcf-193ac5a47b4a\",\"eniID\":\"ec9f8fae-ae74-445b-b8bb-b533e5342dbd\",\"maxEniNum\":2,\"maxSubEniNum\":16}",
+      "openvessel.io/monitoring-aominfo" : "08a2*************************c03:4257ecf3-7c47-43a3-86d2-d2b4d4aa3a20",
+      "resource.cci.io/pod-size-specs" : "2.00_4.0",
+      "resource.cci.io/size" : "2.00_4.0",
+      "scheduling.k8s.io/group-name" : "podgroup-ade5799e-9371-4c9f-ab77-0472e97211f8",
+      "tenant.cci.io/tenant-id" : "08a2*************************c03",
+      "topology.kubernetes.io/region" : "region1",
+      "topology.kubernetes.io/zone" : "region1c"
+    },
+    "creationTimestamp" : "2024-10-09T16:11:23Z",
+    "finalizers" : [ "billing.kubernetes.io/podbilling-finalizer" ],
+    "labels" : {
+      "scheduling.cci.io/vmid" : "fda21659-a816-4449-abcf-193ac5a47b4a",
+      "sys_enterprise_project_id" : "0",
+      "tenant.cci.io/tenant-id" : "08a2*************************c03",
+      "tenant.kubernetes.io/domain-id" : "08a*************************ee60",
+      "tenant.kubernetes.io/project-id" : "08a2*************************c03"
+    },
+    "name" : "test",
+    "namespace" : "test-api",
+    "resourceVersion" : "391095556",
+    "uid" : "ade5799e-9371-4c9f-ab77-0472e97211f8"
+  },
+  "spec" : {
+    "containers" : [ {
+      "env" : [ {
+        "name" : "ENV1",
+        "value" : "false"
+      }, {
+        "name" : "ENV2",
+        "value" : "xxx"
+      } ],
+      "image" : "nginx:latest",
+      "name" : "deploy-example",
+      "resources" : {
+        "limits" : {
+          "cpu" : "500m",
+          "memory" : "1Gi"
+        },
+        "requests" : {
+          "cpu" : "500m",
+          "memory" : "1Gi"
+        }
+      },
+      "terminationMessagePath" : "/dev/termination-log",
+      "terminationMessagePolicy" : "File"
+    } ],
+    "dnsPolicy" : "Default",
+    "imagePullSecrets" : [ {
+      "name" : "imagepull-secret"
+    } ],
+    "nodeName" : "compute-cell-001",
+    "restartPolicy" : "Always",
+    "schedulerName" : "volcano",
+    "securityContext" : { },
+    "terminationGracePeriodSeconds" : 30
+  },
+  "status" : {
+    "conditions" : [ {
+      "lastProbeTime" : null,
+      "lastTransitionTime" : "2024-10-09T16:11:24Z",
+      "status" : "True",
+      "type" : "Initialized"
+    }, {
+      "lastProbeTime" : null,
+      "lastTransitionTime" : "2024-10-09T16:11:28Z",
+      "status" : "True",
+      "type" : "Ready"
+    }, {
+      "lastProbeTime" : null,
+      "lastTransitionTime" : "2024-10-09T16:11:28Z",
+      "status" : "True",
+      "type" : "ContainersReady"
+    }, {
+      "lastProbeTime" : null,
+      "lastTransitionTime" : "2024-10-09T16:11:23Z",
+      "status" : "True",
+      "type" : "PodScheduled"
+    } ],
+    "containerStatuses" : [ {
+      "containerID" : "containerd://a44eef6b753babaff802d212e78afef2422959e90bd79ab5b385adb302aa3d1e",
+      "image" : "nginx:latest",
+      "imageID" : "docker.io/library/nginx@sha256:416d511ffa63777489af47f250b70d1570e428b67666567085f2bece3571ad83",
+      "lastState" : { },
+      "name" : "deploy-example",
+      "ready" : true,
+      "restartCount" : 0,
+      "started" : true,
+      "state" : {
+        "running" : {
+          "startedAt" : "2024-10-09T16:11:27Z"
+        }
+      }
+    } ],
+    "phase" : "Running",
+    "podIP" : "192.168.0.197",
+    "podIPs" : [ {
+      "ip" : "192.168.0.197"
+    } ],
+    "qosClass" : "Guaranteed",
+    "startTime" : "2024-10-09T16:11:24Z"
+  }
+}
+
+

Status Codes

+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +

Status Code

+

Description

+

200

+

OK

+

201

+

Created

+

400

+

BadRequest

+

401

+

Unauthorized

+

403

+

Forbidden

+

404

+

NotFound

+

405

+

MethodNotAllowed

+

406

+

NotAcceptable

+

409

+

Conflict

+

415

+

UnsupportedMediaType

+

422

+

Invalid

+

429

+

TooManyRequests

+

500

+

InternalError

+

503

+

ServiceUnavailable

+

504

+

ServerTimeout

+
+
+
+
+
+
+
Parent topic: Proprietary APIs
+
+
+ diff --git a/docs/cci/api-ref/replaceCciV2NamespacedSecret.html b/docs/cci/api-ref/replaceCciV2NamespacedSecret.html new file mode 100644 index 00000000..409f5f1b --- /dev/null +++ b/docs/cci/api-ref/replaceCciV2NamespacedSecret.html @@ -0,0 +1,1405 @@ + + +

Replacing the Specified Secret

+

Function

Replace the specified Secret.

+

The following fields can be updated:

+ +
  • If type is set to Opaque, the key and value of data can be updated.
  • If type is not set to Opaque, only the value of data can be updated.
+
+
+

Calling Method

For details, see Calling APIs.

+
+

URI

PUT /apis/cci/v2/namespaces/{namespace}/secrets/{name}

+ +
+ + + + + + + + + + + + + + + + +
Table 1 Path Parameters

Parameter

+

Mandatory

+

Type

+

Description

+

name

+

Yes

+

String

+

name of the Secret

+

namespace

+

Yes

+

String

+

Object name and auth scope, such as for teams and projects.

+
+
+ +
+ + + + + + + + + + + + + + + + + + + + + +
Table 2 Query Parameters

Parameter

+

Mandatory

+

Type

+

Description

+

dryRun

+

No

+

String

+

When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed

+

fieldManager

+

No

+

String

+

fieldManager is a name associated with the actor or entity that

+

is making these changes. The value must be less than or 128 characters long,

+

and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint.

+

pretty

+

No

+

String

+

If 'true', then the output is pretty printed.

+
+
+
+

Request Parameters

+
+ + + + + + + + + + + + + + + + +
Table 3 Request header parameters

Parameter

+

Mandatory

+

Type

+

Description

+

X-Auth-Token

+

Yes

+

String

+

User token.

+

It can be obtained through the IAM API used to obtain a user token. The value of X-Subject-Token in the response header is the user token.

+

Content-Type

+

Yes

+

String

+

The type of the message body, with a default value of "application/JSON".

+
+
+ +
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Table 4 Request body parameters

Parameter

+

Mandatory

+

Type

+

Description

+

apiVersion

+

No

+

String

+

APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#resources

+

data

+

No

+

Map<String,String>

+

Data contains the secret data. Each key must consist of alphanumeric

+

characters, '-', '_' or '.'. The serialized form of the secret data is a

+

base64 encoded string, representing the arbitrary (possibly non-string)

+

data value here. Described in https://tools.ietf.org/html/rfc4648#section-4

+

immutable

+

No

+

Boolean

+

Immutable, if set to true, ensures that data stored in the Secret

+

cannot be updated (only object metadata can be modified). If not set to

+

true, the field can be modified at any time. Defaulted to nil.

+

kind

+

No

+

String

+

Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds

+

metadata

+

No

+

io.k8s.apimachinery.pkg.apis.meta.v1.ObjectMeta object

+

Standard object's metadata. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata

+

stringData

+

No

+

Map<String,String>

+

stringData allows specifying non-binary secret data in string

+

form. It is provided as a write-only input field for convenience. All keys

+

and values are merged into the data field on write, overwriting any existing

+

values. The stringData field is never output when reading from the API.

+

type

+

No

+

String

+

Used to facilitate programmatic handling of secret data. More info: https://kubernetes.io/docs/concepts/configuration/secret/#secret-types

+
+
+ +
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Table 5 io.k8s.apimachinery.pkg.apis.meta.v1.ObjectMeta

Parameter

+

Mandatory

+

Type

+

Description

+

annotations

+

No

+

Map<String,String>

+

Annotations is an unstructured key value map stored with a resource that may be set by external tools to store and retrieve arbitrary metadata. They are not queryable and should be preserved when modifying objects. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/annotations/

+

clusterName

+

No

+

String

+

The name of the cluster which the object belongs to. This is

+

used to distinguish resources with same name and namespace in different

+

clusters. This field is not set anywhere right now and apiserver is going

+

to ignore it if set in create or update request.

+

creationTimestamp

+

No

+

String

+

CreationTimestamp is a timestamp representing the server time when this object was created. It is not guaranteed to be set in happens-before order across separate operations. Clients may not set this value. It is represented in RFC3339 form and is in UTC.

+

Populated by the system. Read-only. Null for lists. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata

+

deletionGracePeriodSeconds

+

No

+

Long

+

Number of seconds allowed for this object to gracefully terminate

+

before it will be removed from the system. Only set when deletionTimestamp

+

is also set. May only be shortened. Read-only.

+

deletionTimestamp

+

No

+

String

+

DeletionTimestamp is RFC 3339 date and time at which this resource will be deleted. This field is set by the server when a graceful deletion is requested by the user, and is not directly settable by a client. The resource is expected to be deleted (no longer visible from resource lists, and not reachable by name) after the time in this field, once the finalizers list is empty. As long as the finalizers list contains items, deletion is blocked. Once the deletionTimestamp is set, this value may not be unset or be set further into the future, although it may be shortened or the resource may be deleted prior to this time. For example, a user may request that a pod is deleted in 30 seconds. The Kubelet will react by sending a graceful termination signal to the containers in the pod. After that 30 seconds, the Kubelet will send a hard termination signal (SIGKILL) to the container and after cleanup, remove the pod from the API. In the presence of network partitions, this object may still exist after this timestamp, until an administrator or automated process can determine the resource is fully terminated. If not set, graceful deletion of the object has not been requested.

+

Populated by the system when a graceful deletion is requested. Read-only. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata

+

enable

+

No

+

Boolean

+

Enable identifies whether the resource is available

+

finalizers

+

No

+

Array of strings

+

Must be empty before the object is deleted from the registry.

+

Each entry is an identifier for the responsible component that will remove

+

the entry from the list. If the deletionTimestamp of the object is non-nil,

+

entries in this list can only be removed. Finalizers may be processed and

+

removed in any order. Order is NOT enforced because it introduces significant

+

risk of stuck finalizers. finalizers is a shared field, any actor with permission

+

can reorder it. If the finalizer list is processed in order, then this can

+

lead to a situation in which the component responsible for the first finalizer

+

in the list is waiting for a signal (field value, external system, or other)

+

produced by a component responsible for a finalizer later in the list, resulting

+

in a deadlock. Without enforced ordering finalizers are free to order amongst

+

themselves and are not vulnerable to ordering changes in the list.

+

generateName

+

No

+

String

+

GenerateName is an optional prefix, used by the server, to generate a unique name ONLY IF the Name field has not been provided. If this field is used, the name returned to the client will be different than the name passed. This value will also be combined with a unique suffix. The provided value has the same validation rules as the Name field, and may be truncated by the length of the suffix required to make the value unique on the server.

+

If this field is specified and the generated name exists, the server will NOT return a 409 - instead, it will either return 201 Created or 500 with Reason ServerTimeout indicating a unique name could not be found in the time allotted, and the client should retry (optionally after the time indicated in the Retry-After header).

+

Applied only if Name is not specified. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#idempotency

+

generation

+

No

+

Long

+

A sequence number representing a specific generation of the desired

+

state. Populated by the system. Read-only.

+

labels

+

No

+

Map<String,String>

+

Map of string keys and values that can be used to organize and categorize (scope and select) objects. May match selectors of replication controllers and services. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/labels/

+

managedFields

+

No

+

Array of io.k8s.apimachinery.pkg.apis.meta.v1.ManagedFieldsEntry objects

+

ManagedFields maps workflow-id and version to the set of fields

+

that are managed by that workflow. This is mostly for internal housekeeping,

+

and users typically shouldn't need to set or understand this field. A workflow

+

can be the user's name, a controller's name, or the name of a specific apply

+

path like "ci-cd". The set of fields is always in the version that the workflow

+

used when modifying the object.

+

name

+

No

+

String

+

Name must be unique within a namespace. Is required when creating resources, although some resources may allow a client to request the generation of an appropriate name automatically. Name is primarily intended for creation idempotence and configuration definition. Cannot be updated. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names

+

namespace

+

No

+

String

+

Namespace defines the space within which each name must be unique. An empty namespace is equivalent to the "default" namespace, but "default" is the canonical representation. Not all objects are required to be scoped to a namespace - the value of this field for those objects will be empty.

+

Must be a DNS_LABEL. Cannot be updated. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/namespaces/

+

ownerReferences

+

No

+

Array of io.k8s.apimachinery.pkg.apis.meta.v1.OwnerReference objects

+

List of objects depended by this object. If ALL objects in the

+

list have been deleted, this object will be garbage collected. If this object

+

is managed by a controller, then an entry in this list will point to this

+

controller, with the controller field set to true. There cannot be more

+

than one managing controller.

+

resourceVersion

+

No

+

String

+

An opaque value that represents the internal version of this object that can be used by clients to determine when objects have changed. May be used for optimistic concurrency, change detection, and the watch operation on a resource or set of resources. Clients must treat these values as opaque and passed unmodified back to the server. They may only be valid for a particular resource or set of resources.

+

Populated by the system. Read-only. Value must be treated as opaque by clients and . More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#concurrency-control-and-consistency

+

selfLink

+

No

+

String

+

SelfLink is a URL representing this object. Populated by the system. Read-only.

+

DEPRECATED Kubernetes will stop propagating this field in 1.20 release and the field is planned to be removed in 1.21 release.

+

uid

+

No

+

String

+

UID is the unique in time and space value for this object. It is typically generated by the server on successful creation of a resource and is not allowed to change on PUT operations.

+

Populated by the system. Read-only. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#uids

+
+
+ +
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Table 6 io.k8s.apimachinery.pkg.apis.meta.v1.ManagedFieldsEntry

Parameter

+

Mandatory

+

Type

+

Description

+

apiVersion

+

No

+

String

+

APIVersion defines the version of this resource that this field

+

set applies to. The format is "group/version" just like the top-level APIVersion

+

field. It is necessary to track the version of a field set because it cannot

+

be automatically converted.

+

fieldsType

+

No

+

String

+

FieldsType is the discriminator for the different fields format and version. There is currently only one possible value: "FieldsV1"

+

fieldsV1

+

No

+

Object

+

FieldsV1 holds the first JSON version format as described in

+

the "FieldsV1" type.

+

manager

+

No

+

String

+

Manager is an identifier of the workflow managing these fields.

+

operation

+

No

+

String

+

Operation is the type of operation which lead to this ManagedFieldsEntry

+

being created. The only valid values for this field are 'Apply' and 'Update'.

+

time

+

No

+

String

+

Time is timestamp of when these fields were set. It should always

+

be empty if Operation is 'Apply'

+
+
+ +
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Table 7 io.k8s.apimachinery.pkg.apis.meta.v1.OwnerReference

Parameter

+

Mandatory

+

Type

+

Description

+

apiVersion

+

Yes

+

String

+

API version of the referent.

+

blockOwnerDeletion

+

No

+

Boolean

+

If true, AND if the owner has the "foregroundDeletion" finalizer,

+

then the owner cannot be deleted from the key-value store until this reference

+

is removed. Defaults to false. To set this field, a user needs "delete"

+

permission of the owner, otherwise 422 (Unprocessable Entity) will be returned.

+

controller

+

No

+

Boolean

+

If true, this reference points to the managing controller.

+

kind

+

Yes

+

String

+

Kind of the referent. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds

+

name

+

Yes

+

String

+

Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names

+

uid

+

Yes

+

String

+

UID of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#uids

+
+
+
+

Response Parameters

Status code: 200

+ +
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Table 8 Response body parameters

Parameter

+

Type

+

Description

+

apiVersion

+

String

+

APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#resources

+

data

+

Map<String,String>

+

Data contains the secret data. Each key must consist of alphanumeric

+

characters, '-', '_' or '.'. The serialized form of the secret data is a

+

base64 encoded string, representing the arbitrary (possibly non-string)

+

data value here. Described in https://tools.ietf.org/html/rfc4648#section-4

+

immutable

+

Boolean

+

Immutable, if set to true, ensures that data stored in the Secret

+

cannot be updated (only object metadata can be modified). If not set to

+

true, the field can be modified at any time. Defaulted to nil.

+

kind

+

String

+

Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds

+

metadata

+

io.k8s.apimachinery.pkg.apis.meta.v1.ObjectMeta object

+

Standard object's metadata. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata

+

stringData

+

Map<String,String>

+

stringData allows specifying non-binary secret data in string

+

form. It is provided as a write-only input field for convenience. All keys

+

and values are merged into the data field on write, overwriting any existing

+

values. The stringData field is never output when reading from the API.

+

type

+

String

+

Used to facilitate programmatic handling of secret data. More info: https://kubernetes.io/docs/concepts/configuration/secret/#secret-types

+
+
+ +
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Table 9 io.k8s.apimachinery.pkg.apis.meta.v1.ObjectMeta

Parameter

+

Type

+

Description

+

annotations

+

Map<String,String>

+

Annotations is an unstructured key value map stored with a resource that may be set by external tools to store and retrieve arbitrary metadata. They are not queryable and should be preserved when modifying objects. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/annotations/

+

clusterName

+

String

+

The name of the cluster which the object belongs to. This is

+

used to distinguish resources with same name and namespace in different

+

clusters. This field is not set anywhere right now and apiserver is going

+

to ignore it if set in create or update request.

+

creationTimestamp

+

String

+

CreationTimestamp is a timestamp representing the server time when this object was created. It is not guaranteed to be set in happens-before order across separate operations. Clients may not set this value. It is represented in RFC3339 form and is in UTC.

+

Populated by the system. Read-only. Null for lists. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata

+

deletionGracePeriodSeconds

+

Long

+

Number of seconds allowed for this object to gracefully terminate

+

before it will be removed from the system. Only set when deletionTimestamp

+

is also set. May only be shortened. Read-only.

+

deletionTimestamp

+

String

+

DeletionTimestamp is RFC 3339 date and time at which this resource will be deleted. This field is set by the server when a graceful deletion is requested by the user, and is not directly settable by a client. The resource is expected to be deleted (no longer visible from resource lists, and not reachable by name) after the time in this field, once the finalizers list is empty. As long as the finalizers list contains items, deletion is blocked. Once the deletionTimestamp is set, this value may not be unset or be set further into the future, although it may be shortened or the resource may be deleted prior to this time. For example, a user may request that a pod is deleted in 30 seconds. The Kubelet will react by sending a graceful termination signal to the containers in the pod. After that 30 seconds, the Kubelet will send a hard termination signal (SIGKILL) to the container and after cleanup, remove the pod from the API. In the presence of network partitions, this object may still exist after this timestamp, until an administrator or automated process can determine the resource is fully terminated. If not set, graceful deletion of the object has not been requested.

+

Populated by the system when a graceful deletion is requested. Read-only. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata

+

enable

+

Boolean

+

Enable identifies whether the resource is available

+

finalizers

+

Array of strings

+

Must be empty before the object is deleted from the registry.

+

Each entry is an identifier for the responsible component that will remove

+

the entry from the list. If the deletionTimestamp of the object is non-nil,

+

entries in this list can only be removed. Finalizers may be processed and

+

removed in any order. Order is NOT enforced because it introduces significant

+

risk of stuck finalizers. finalizers is a shared field, any actor with permission

+

can reorder it. If the finalizer list is processed in order, then this can

+

lead to a situation in which the component responsible for the first finalizer

+

in the list is waiting for a signal (field value, external system, or other)

+

produced by a component responsible for a finalizer later in the list, resulting

+

in a deadlock. Without enforced ordering finalizers are free to order amongst

+

themselves and are not vulnerable to ordering changes in the list.

+

generateName

+

String

+

GenerateName is an optional prefix, used by the server, to generate a unique name ONLY IF the Name field has not been provided. If this field is used, the name returned to the client will be different than the name passed. This value will also be combined with a unique suffix. The provided value has the same validation rules as the Name field, and may be truncated by the length of the suffix required to make the value unique on the server.

+

If this field is specified and the generated name exists, the server will NOT return a 409 - instead, it will either return 201 Created or 500 with Reason ServerTimeout indicating a unique name could not be found in the time allotted, and the client should retry (optionally after the time indicated in the Retry-After header).

+

Applied only if Name is not specified. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#idempotency

+

generation

+

Long

+

A sequence number representing a specific generation of the desired

+

state. Populated by the system. Read-only.

+

labels

+

Map<String,String>

+

Map of string keys and values that can be used to organize and categorize (scope and select) objects. May match selectors of replication controllers and services. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/labels/

+

managedFields

+

Array of io.k8s.apimachinery.pkg.apis.meta.v1.ManagedFieldsEntry objects

+

ManagedFields maps workflow-id and version to the set of fields

+

that are managed by that workflow. This is mostly for internal housekeeping,

+

and users typically shouldn't need to set or understand this field. A workflow

+

can be the user's name, a controller's name, or the name of a specific apply

+

path like "ci-cd". The set of fields is always in the version that the workflow

+

used when modifying the object.

+

name

+

String

+

Name must be unique within a namespace. Is required when creating resources, although some resources may allow a client to request the generation of an appropriate name automatically. Name is primarily intended for creation idempotence and configuration definition. Cannot be updated. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names

+

namespace

+

String

+

Namespace defines the space within which each name must be unique. An empty namespace is equivalent to the "default" namespace, but "default" is the canonical representation. Not all objects are required to be scoped to a namespace - the value of this field for those objects will be empty.

+

Must be a DNS_LABEL. Cannot be updated. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/namespaces/

+

ownerReferences

+

Array of io.k8s.apimachinery.pkg.apis.meta.v1.OwnerReference objects

+

List of objects depended by this object. If ALL objects in the

+

list have been deleted, this object will be garbage collected. If this object

+

is managed by a controller, then an entry in this list will point to this

+

controller, with the controller field set to true. There cannot be more

+

than one managing controller.

+

resourceVersion

+

String

+

An opaque value that represents the internal version of this object that can be used by clients to determine when objects have changed. May be used for optimistic concurrency, change detection, and the watch operation on a resource or set of resources. Clients must treat these values as opaque and passed unmodified back to the server. They may only be valid for a particular resource or set of resources.

+

Populated by the system. Read-only. Value must be treated as opaque by clients and . More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#concurrency-control-and-consistency

+

selfLink

+

String

+

SelfLink is a URL representing this object. Populated by the system. Read-only.

+

DEPRECATED Kubernetes will stop propagating this field in 1.20 release and the field is planned to be removed in 1.21 release.

+

uid

+

String

+

UID is the unique in time and space value for this object. It is typically generated by the server on successful creation of a resource and is not allowed to change on PUT operations.

+

Populated by the system. Read-only. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#uids

+
+
+ +
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Table 10 io.k8s.apimachinery.pkg.apis.meta.v1.ManagedFieldsEntry

Parameter

+

Type

+

Description

+

apiVersion

+

String

+

APIVersion defines the version of this resource that this field

+

set applies to. The format is "group/version" just like the top-level APIVersion

+

field. It is necessary to track the version of a field set because it cannot

+

be automatically converted.

+

fieldsType

+

String

+

FieldsType is the discriminator for the different fields format and version. There is currently only one possible value: "FieldsV1"

+

fieldsV1

+

Object

+

FieldsV1 holds the first JSON version format as described in

+

the "FieldsV1" type.

+

manager

+

String

+

Manager is an identifier of the workflow managing these fields.

+

operation

+

String

+

Operation is the type of operation which lead to this ManagedFieldsEntry

+

being created. The only valid values for this field are 'Apply' and 'Update'.

+

time

+

String

+

Time is timestamp of when these fields were set. It should always

+

be empty if Operation is 'Apply'

+
+
+ +
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Table 11 io.k8s.apimachinery.pkg.apis.meta.v1.OwnerReference

Parameter

+

Type

+

Description

+

apiVersion

+

String

+

API version of the referent.

+

blockOwnerDeletion

+

Boolean

+

If true, AND if the owner has the "foregroundDeletion" finalizer,

+

then the owner cannot be deleted from the key-value store until this reference

+

is removed. Defaults to false. To set this field, a user needs "delete"

+

permission of the owner, otherwise 422 (Unprocessable Entity) will be returned.

+

controller

+

Boolean

+

If true, this reference points to the managing controller.

+

kind

+

String

+

Kind of the referent. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds

+

name

+

String

+

Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names

+

uid

+

String

+

UID of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#uids

+
+
+

Status code: 201

+ +
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Table 12 Response body parameters

Parameter

+

Type

+

Description

+

apiVersion

+

String

+

APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#resources

+

data

+

Map<String,String>

+

Data contains the secret data. Each key must consist of alphanumeric

+

characters, '-', '_' or '.'. The serialized form of the secret data is a

+

base64 encoded string, representing the arbitrary (possibly non-string)

+

data value here. Described in https://tools.ietf.org/html/rfc4648#section-4

+

immutable

+

Boolean

+

Immutable, if set to true, ensures that data stored in the Secret

+

cannot be updated (only object metadata can be modified). If not set to

+

true, the field can be modified at any time. Defaulted to nil.

+

kind

+

String

+

Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds

+

metadata

+

io.k8s.apimachinery.pkg.apis.meta.v1.ObjectMeta object

+

Standard object's metadata. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata

+

stringData

+

Map<String,String>

+

stringData allows specifying non-binary secret data in string

+

form. It is provided as a write-only input field for convenience. All keys

+

and values are merged into the data field on write, overwriting any existing

+

values. The stringData field is never output when reading from the API.

+

type

+

String

+

Used to facilitate programmatic handling of secret data. More info: https://kubernetes.io/docs/concepts/configuration/secret/#secret-types

+
+
+ +
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Table 13 io.k8s.apimachinery.pkg.apis.meta.v1.ObjectMeta

Parameter

+

Type

+

Description

+

annotations

+

Map<String,String>

+

Annotations is an unstructured key value map stored with a resource that may be set by external tools to store and retrieve arbitrary metadata. They are not queryable and should be preserved when modifying objects. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/annotations/

+

clusterName

+

String

+

The name of the cluster which the object belongs to. This is

+

used to distinguish resources with same name and namespace in different

+

clusters. This field is not set anywhere right now and apiserver is going

+

to ignore it if set in create or update request.

+

creationTimestamp

+

String

+

CreationTimestamp is a timestamp representing the server time when this object was created. It is not guaranteed to be set in happens-before order across separate operations. Clients may not set this value. It is represented in RFC3339 form and is in UTC.

+

Populated by the system. Read-only. Null for lists. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata

+

deletionGracePeriodSeconds

+

Long

+

Number of seconds allowed for this object to gracefully terminate

+

before it will be removed from the system. Only set when deletionTimestamp

+

is also set. May only be shortened. Read-only.

+

deletionTimestamp

+

String

+

DeletionTimestamp is RFC 3339 date and time at which this resource will be deleted. This field is set by the server when a graceful deletion is requested by the user, and is not directly settable by a client. The resource is expected to be deleted (no longer visible from resource lists, and not reachable by name) after the time in this field, once the finalizers list is empty. As long as the finalizers list contains items, deletion is blocked. Once the deletionTimestamp is set, this value may not be unset or be set further into the future, although it may be shortened or the resource may be deleted prior to this time. For example, a user may request that a pod is deleted in 30 seconds. The Kubelet will react by sending a graceful termination signal to the containers in the pod. After that 30 seconds, the Kubelet will send a hard termination signal (SIGKILL) to the container and after cleanup, remove the pod from the API. In the presence of network partitions, this object may still exist after this timestamp, until an administrator or automated process can determine the resource is fully terminated. If not set, graceful deletion of the object has not been requested.

+

Populated by the system when a graceful deletion is requested. Read-only. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata

+

enable

+

Boolean

+

Enable identifies whether the resource is available

+

finalizers

+

Array of strings

+

Must be empty before the object is deleted from the registry.

+

Each entry is an identifier for the responsible component that will remove

+

the entry from the list. If the deletionTimestamp of the object is non-nil,

+

entries in this list can only be removed. Finalizers may be processed and

+

removed in any order. Order is NOT enforced because it introduces significant

+

risk of stuck finalizers. finalizers is a shared field, any actor with permission

+

can reorder it. If the finalizer list is processed in order, then this can

+

lead to a situation in which the component responsible for the first finalizer

+

in the list is waiting for a signal (field value, external system, or other)

+

produced by a component responsible for a finalizer later in the list, resulting

+

in a deadlock. Without enforced ordering finalizers are free to order amongst

+

themselves and are not vulnerable to ordering changes in the list.

+

generateName

+

String

+

GenerateName is an optional prefix, used by the server, to generate a unique name ONLY IF the Name field has not been provided. If this field is used, the name returned to the client will be different than the name passed. This value will also be combined with a unique suffix. The provided value has the same validation rules as the Name field, and may be truncated by the length of the suffix required to make the value unique on the server.

+

If this field is specified and the generated name exists, the server will NOT return a 409 - instead, it will either return 201 Created or 500 with Reason ServerTimeout indicating a unique name could not be found in the time allotted, and the client should retry (optionally after the time indicated in the Retry-After header).

+

Applied only if Name is not specified. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#idempotency

+

generation

+

Long

+

A sequence number representing a specific generation of the desired

+

state. Populated by the system. Read-only.

+

labels

+

Map<String,String>

+

Map of string keys and values that can be used to organize and categorize (scope and select) objects. May match selectors of replication controllers and services. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/labels/

+

managedFields

+

Array of io.k8s.apimachinery.pkg.apis.meta.v1.ManagedFieldsEntry objects

+

ManagedFields maps workflow-id and version to the set of fields

+

that are managed by that workflow. This is mostly for internal housekeeping,

+

and users typically shouldn't need to set or understand this field. A workflow

+

can be the user's name, a controller's name, or the name of a specific apply

+

path like "ci-cd". The set of fields is always in the version that the workflow

+

used when modifying the object.

+

name

+

String

+

Name must be unique within a namespace. Is required when creating resources, although some resources may allow a client to request the generation of an appropriate name automatically. Name is primarily intended for creation idempotence and configuration definition. Cannot be updated. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names

+

namespace

+

String

+

Namespace defines the space within which each name must be unique. An empty namespace is equivalent to the "default" namespace, but "default" is the canonical representation. Not all objects are required to be scoped to a namespace - the value of this field for those objects will be empty.

+

Must be a DNS_LABEL. Cannot be updated. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/namespaces/

+

ownerReferences

+

Array of io.k8s.apimachinery.pkg.apis.meta.v1.OwnerReference objects

+

List of objects depended by this object. If ALL objects in the

+

list have been deleted, this object will be garbage collected. If this object

+

is managed by a controller, then an entry in this list will point to this

+

controller, with the controller field set to true. There cannot be more

+

than one managing controller.

+

resourceVersion

+

String

+

An opaque value that represents the internal version of this object that can be used by clients to determine when objects have changed. May be used for optimistic concurrency, change detection, and the watch operation on a resource or set of resources. Clients must treat these values as opaque and passed unmodified back to the server. They may only be valid for a particular resource or set of resources.

+

Populated by the system. Read-only. Value must be treated as opaque by clients and . More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#concurrency-control-and-consistency

+

selfLink

+

String

+

SelfLink is a URL representing this object. Populated by the system. Read-only.

+

DEPRECATED Kubernetes will stop propagating this field in 1.20 release and the field is planned to be removed in 1.21 release.

+

uid

+

String

+

UID is the unique in time and space value for this object. It is typically generated by the server on successful creation of a resource and is not allowed to change on PUT operations.

+

Populated by the system. Read-only. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#uids

+
+
+ +
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Table 14 io.k8s.apimachinery.pkg.apis.meta.v1.ManagedFieldsEntry

Parameter

+

Type

+

Description

+

apiVersion

+

String

+

APIVersion defines the version of this resource that this field

+

set applies to. The format is "group/version" just like the top-level APIVersion

+

field. It is necessary to track the version of a field set because it cannot

+

be automatically converted.

+

fieldsType

+

String

+

FieldsType is the discriminator for the different fields format and version. There is currently only one possible value: "FieldsV1"

+

fieldsV1

+

Object

+

FieldsV1 holds the first JSON version format as described in

+

the "FieldsV1" type.

+

manager

+

String

+

Manager is an identifier of the workflow managing these fields.

+

operation

+

String

+

Operation is the type of operation which lead to this ManagedFieldsEntry

+

being created. The only valid values for this field are 'Apply' and 'Update'.

+

time

+

String

+

Time is timestamp of when these fields were set. It should always

+

be empty if Operation is 'Apply'

+
+
+ +
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Table 15 io.k8s.apimachinery.pkg.apis.meta.v1.OwnerReference

Parameter

+

Type

+

Description

+

apiVersion

+

String

+

API version of the referent.

+

blockOwnerDeletion

+

Boolean

+

If true, AND if the owner has the "foregroundDeletion" finalizer,

+

then the owner cannot be deleted from the key-value store until this reference

+

is removed. Defaults to false. To set this field, a user needs "delete"

+

permission of the owner, otherwise 422 (Unprocessable Entity) will be returned.

+

controller

+

Boolean

+

If true, this reference points to the managing controller.

+

kind

+

String

+

Kind of the referent. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds

+

name

+

String

+

Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names

+

uid

+

String

+

UID of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#uids

+
+
+
+

Example Requests

{
+  "apiVersion" : "cci/v2",
+  "data" : {
+    "key" : "eHh4Cg=="
+  },
+  "kind" : "Secret",
+  "metadata" : {
+    "annotations" : {
+      "secret.cci.io/namespace-uid" : "8fd96f2d-ecfa-4e4f-8f5f-4070766d333c",
+      "tenant.cci.io/tenant-id" : "08a2*************************c03"
+    },
+    "creationTimestamp" : "2024-10-09T17:13:08Z",
+    "labels" : {
+      "sys_enterprise_project_id" : "0",
+      "tenant.cci.io/tenant-id" : "08a2*************************c03",
+      "tenant.kubernetes.io/domain-id" : "08a*************************ee60",
+      "tenant.kubernetes.io/project-id" : "08a2*************************c03"
+    },
+    "name" : "test-secret",
+    "namespace" : "test-api",
+    "resourceVersion" : "391114527",
+    "uid" : "77d8dedc-b7ae-40a1-b9a6-6f37cca2c4d1"
+  },
+  "type" : "Opaque"
+}
+
+

Example Responses

Status code: 200

+

OK

+
{
+  "apiVersion" : "cci/v2",
+  "data" : {
+    "key" : "eHh4Cg=="
+  },
+  "kind" : "Secret",
+  "metadata" : {
+    "annotations" : {
+      "secret.cci.io/namespace-uid" : "8fd96f2d-ecfa-4e4f-8f5f-4070766d333c",
+      "tenant.cci.io/tenant-id" : "08a2*************************c03"
+    },
+    "creationTimestamp" : "2024-10-09T17:13:08Z",
+    "labels" : {
+      "sys_enterprise_project_id" : "0",
+      "tenant.cci.io/tenant-id" : "08a2*************************c03",
+      "tenant.kubernetes.io/domain-id" : "08a*************************ee60",
+      "tenant.kubernetes.io/project-id" : "08a2*************************c03"
+    },
+    "name" : "test-secret",
+    "namespace" : "test-api",
+    "resourceVersion" : "391114527",
+    "uid" : "77d8dedc-b7ae-40a1-b9a6-6f37cca2c4d1"
+  },
+  "type" : "Opaque"
+}
+
+

Status Codes

+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +

Status Code

+

Description

+

200

+

OK

+

201

+

Created

+

400

+

BadRequest

+

401

+

Unauthorized

+

403

+

Forbidden

+

404

+

NotFound

+

405

+

MethodNotAllowed

+

406

+

NotAcceptable

+

409

+

Conflict

+

415

+

UnsupportedMediaType

+

422

+

Invalid

+

429

+

TooManyRequests

+

500

+

InternalError

+

503

+

ServiceUnavailable

+

504

+

ServerTimeout

+
+
+
+
+
+
+
Parent topic: Proprietary APIs
+
+
+ diff --git a/docs/cci/api-ref/replaceYangtseV2NamespacedNetwork.html b/docs/cci/api-ref/replaceYangtseV2NamespacedNetwork.html new file mode 100644 index 00000000..cda693be --- /dev/null +++ b/docs/cci/api-ref/replaceYangtseV2NamespacedNetwork.html @@ -0,0 +1,1860 @@ + + +

Replacing the Specified Network

+

Function

Replace the specified Network.

+
+

Calling Method

For details, see Calling APIs.

+
+

URI

PUT /apis/yangtse/v2/namespaces/{namespace}/networks/{name}

+ +
+ + + + + + + + + + + + + + + + +
Table 1 Path Parameters

Parameter

+

Mandatory

+

Type

+

Description

+

name

+

Yes

+

String

+

Name of the Network.

+

namespace

+

Yes

+

String

+

Object name and auth scope, such as for teams and projects.

+
+
+ +
+ + + + + + + + + + + + + + + + + + + + + + + + + + +
Table 2 Query Parameters

Parameter

+

Mandatory

+

Type

+

Description

+

dryRun

+

No

+

String

+

When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed

+

fieldManager

+

No

+

String

+

fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint.

+

fieldValidation

+

No

+

String

+

fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields, provided that the ServerSideFieldValidation feature gate is also enabled. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23 and is the default behavior when the ServerSideFieldValidation feature gate is disabled. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default when the ServerSideFieldValidation feature gate is enabled. - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered.

+

pretty

+

No

+

String

+

If 'true', then the output is pretty printed.

+
+
+
+

Request Parameters

+
+ + + + + + + + + + + + + + + + +
Table 3 Request header parameters

Parameter

+

Mandatory

+

Type

+

Description

+

X-Auth-Token

+

Yes

+

String

+

User token.

+

It can be obtained through the IAM API used to obtain a user token. The value of X-Subject-Token in the response header is the user token.

+

Content-Type

+

Yes

+

String

+

The type of the message body, with a default value of "application/JSON".

+
+
+ +
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Table 4 Request body parameters

Parameter

+

Mandatory

+

Type

+

Description

+

apiVersion

+

No

+

String

+

APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#resources

+

kind

+

No

+

String

+

Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds

+

metadata

+

No

+

io.k8s.apimachinery.pkg.apis.meta.v1.ObjectMeta object

+

ObjectMeta is metadata that all persisted resources must have, which includes all objects users must create.

+

spec

+

No

+

com.otc.paas-core.yangtse.pkg.apis.yangtse.v2.NetworkSpec object

+

Specification of the desired behavior of network.

+

status

+

No

+

com.otc.paas-core.yangtse.pkg.apis.yangtse.v2.NetworkStatus object

+

Most recently observed status of the network.

+
+
+ +
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Table 5 io.k8s.apimachinery.pkg.apis.meta.v1.ObjectMeta

Parameter

+

Mandatory

+

Type

+

Description

+

annotations

+

No

+

Map<String,String>

+

Annotations is an unstructured key value map stored with a resource that may be set by external tools to store and retrieve arbitrary metadata. They are not queryable and should be preserved when modifying objects. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/annotations/

+

clusterName

+

No

+

String

+

The name of the cluster which the object belongs to. This is used to distinguish resources with same name and namespace in different clusters. This field is not set anywhere right now and apiserver is going to ignore it if set in create or update request.

+

creationTimestamp

+

No

+

String

+

CreationTimestamp is a timestamp representing the server time when this object was created. It is not guaranteed to be set in happens-before order across separate operations. Clients may not set this value. It is represented in RFC3339 form and is in UTC.

+

Populated by the system. Read-only. Null for lists. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata

+

deletionGracePeriodSeconds

+

No

+

Long

+

Number of seconds allowed for this object to gracefully terminate before it will be removed from the system. Only set when deletionTimestamp is also set. May only be shortened. Read-only.

+

deletionTimestamp

+

No

+

String

+

DeletionTimestamp is RFC 3339 date and time at which this resource will be deleted. This field is set by the server when a graceful deletion is requested by the user, and is not directly settable by a client. The resource is expected to be deleted (no longer visible from resource lists, and not reachable by name) after the time in this field, once the finalizers list is empty. As long as the finalizers list contains items, deletion is blocked. Once the deletionTimestamp is set, this value may not be unset or be set further into the future, although it may be shortened or the resource may be deleted prior to this time. For example, a user may request that a pod is deleted in 30 seconds. The Kubelet will react by sending a graceful termination signal to the containers in the pod. After that 30 seconds, the Kubelet will send a hard termination signal (SIGKILL) to the container and after cleanup, remove the pod from the API. In the presence of network partitions, this object may still exist after this timestamp, until an administrator or automated process can determine the resource is fully terminated. If not set, graceful deletion of the object has not been requested.

+

Populated by the system when a graceful deletion is requested. Read-only. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata

+

enable

+

No

+

Boolean

+

Enable identifies whether the resource is available

+

finalizers

+

No

+

Array of strings

+

Must be empty before the object is deleted from the registry.

+

Each entry is an identifier for the responsible component that will remove the entry from the list. If the deletionTimestamp of the object is non-nil, entries in this list can only be removed. Finalizers may be processed and removed in any order. Order is NOT enforced because it introduces significant risk of stuck finalizers. finalizers is a shared field, any actor with permission can reorder it. If the finalizer list is processed in order, then this can lead to a situation in which the component responsible for the first finalizer in the list is waiting for a signal (field value, external system, or other) produced by a component responsible for a finalizer later in the list, resulting in a deadlock. Without enforced ordering finalizers are free to order amongst themselves and are not vulnerable to ordering changes in the list.

+

generateName

+

No

+

String

+

GenerateName is an optional prefix, used by the server, to generate a unique name ONLY IF the Name field has not been provided. If this field is used, the name returned to the client will be different than the name passed. This value will also be combined with a unique suffix. The provided value has the same validation rules as the Name field, and may be truncated by the length of the suffix required to make the value unique on the server.

+

If this field is specified and the generated name exists, the server will NOT return a 409 - instead, it will either return 201 Created or 500 with Reason ServerTimeout indicating a unique name could not be found in the time allotted, and the client should retry (optionally after the time indicated in the Retry-After header).

+

Applied only if Name is not specified. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#idempotency

+

generation

+

No

+

Long

+

A sequence number representing a specific generation of the desired state. Populated by the system. Read-only.

+

labels

+

No

+

Map<String,String>

+

Map of string keys and values that can be used to organize and categorize (scope and select) objects. May match selectors of replication controllers and services. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/labels/

+

managedFields

+

No

+

Array of io.k8s.apimachinery.pkg.apis.meta.v1.ManagedFieldsEntry objects

+

ManagedFields maps workflow-id and version to the set of fields

+

that are managed by that workflow. This is mostly for internal housekeeping,

+

and users typically shouldn't need to set or understand this field. A workflow

+

can be the user's name, a controller's name, or the name of a specific apply

+

path like "ci-cd". The set of fields is always in the version that the workflow

+

used when modifying the object.

+

name

+

No

+

String

+

Name must be unique within a namespace. Is required when creating resources, although some resources may allow a client to request the generation of an appropriate name automatically. Name is primarily intended for creation idempotence and configuration definition. Cannot be updated. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names

+

namespace

+

No

+

String

+

Namespace defines the space within which each name must be unique. An empty namespace is equivalent to the "default" namespace, but "default" is the canonical representation. Not all objects are required to be scoped to a namespace - the value of this field for those objects will be empty.

+

Must be a DNS_LABEL. Cannot be updated. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/namespaces/

+

ownerReferences

+

No

+

Array of io.k8s.apimachinery.pkg.apis.meta.v1.OwnerReference objects

+

List of objects depended by this object. If ALL objects in the

+

list have been deleted, this object will be garbage collected. If this object

+

is managed by a controller, then an entry in this list will point to this

+

controller, with the controller field set to true. There cannot be more

+

than one managing controller.

+

resourceVersion

+

No

+

String

+

An opaque value that represents the internal version of this object that can be used by clients to determine when objects have changed. May be used for optimistic concurrency, change detection, and the watch operation on a resource or set of resources. Clients must treat these values as opaque and passed unmodified back to the server. They may only be valid for a particular resource or set of resources.

+

Populated by the system. Read-only. Value must be treated as opaque by clients and . More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#concurrency-control-and-consistency

+

selfLink

+

No

+

String

+

SelfLink is a URL representing this object. Populated by the system. Read-only.

+

DEPRECATED Kubernetes will stop propagating this field in 1.20 release and the field is planned to be removed in 1.21 release.

+

uid

+

No

+

String

+

UID is the unique in time and space value for this object. It is typically generated by the server on successful creation of a resource and is not allowed to change on PUT operations.

+

Populated by the system. Read-only. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#uids

+
+
+ +
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Table 6 io.k8s.apimachinery.pkg.apis.meta.v1.ManagedFieldsEntry

Parameter

+

Mandatory

+

Type

+

Description

+

apiVersion

+

No

+

String

+

APIVersion defines the version of this resource that this field set applies to. The format is "group/version" just like the top-level APIVersion field. It is necessary to track the version of a field set because it cannot be automatically converted.

+

fieldsType

+

No

+

String

+

FieldsType is the discriminator for the different fields format and version. There is currently only one possible value: "FieldsV1"

+

fieldsV1

+

No

+

Object

+

FieldsV1 holds the first JSON version format as described in the "FieldsV1" type.

+

manager

+

No

+

String

+

Manager is an identifier of the workflow managing these fields.

+

operation

+

No

+

String

+

Operation is the type of operation which lead to this ManagedFieldsEntry being created. The only valid values for this field are 'Apply' and 'Update'.

+

time

+

No

+

String

+

Time is timestamp of when these fields were set. It should always be empty if Operation is 'Apply'

+
+
+ +
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Table 7 io.k8s.apimachinery.pkg.apis.meta.v1.OwnerReference

Parameter

+

Mandatory

+

Type

+

Description

+

apiVersion

+

Yes

+

String

+

API version of the referent.

+

blockOwnerDeletion

+

No

+

Boolean

+

If true, AND if the owner has the "foregroundDeletion" finalizer, then the owner cannot be deleted from the key-value store until this reference is removed. Defaults to false. To set this field, a user needs "delete"

+

permission of the owner, otherwise 422 (Unprocessable Entity) will be returned.

+

+

controller

+

No

+

Boolean

+

If true, this reference points to the managing controller.

+

kind

+

Yes

+

String

+

Kind of the referent. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds

+

name

+

Yes

+

String

+

Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names

+

uid

+

Yes

+

String

+

UID of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#uids

+
+
+ +
+ + + + + + + + + + + + + + + + + + + + + + + + + + +
Table 8 com.otc.paas-core.yangtse.pkg.apis.yangtse.v2.NetworkSpec

Parameter

+

Mandatory

+

Type

+

Description

+

ipFamilies

+

No

+

Array of strings

+

IPFamilies of Network, can be "IPv4" or "IPv6".

+

networkType

+

No

+

String

+

Type of network, only support "underlay-neutron".

+

securityGroups

+

No

+

Array of strings

+

SecurityGroups of the network NOTE: 1. nil means not enable security group; 2. [""] means enable security group but deny all; 3. ["xxx,yyy"] means enable security group and allow with security group ids;

+

subnets

+

No

+

Array of com.otc.paas-core.yangtse.pkg.apis.yangtse.v2.SubnetConf objects

+

Describes the subnets of the network.

+
+
+ +
+ + + + + + + + + + + +
Table 9 com.otc.paas-core.yangtse.pkg.apis.yangtse.v2.SubnetConf

Parameter

+

Mandatory

+

Type

+

Description

+

subnetID

+

No

+

String

+

SubnetID subnetV4ID of the subnet.

+
+
+ +
+ + + + + + + + + + + + + + + + + + + + + +
Table 10 com.otc.paas-core.yangtse.pkg.apis.yangtse.v2.NetworkStatus

Parameter

+

Mandatory

+

Type

+

Description

+

conditions

+

No

+

Array of io.k8s.apimachinery.pkg.apis.meta.v1.Condition objects

+

Conditions describe the current conditions of the Network.

+

status

+

No

+

String

+

Status of network, can be "Ready" or "Failed" or "IPInsufficient"

+

subnetAttrs

+

No

+

Array of com.otc.paas-core.yangtse.pkg.apis.yangtse.v2.SubnetAttr objects

+

SubnetAttrs describe the current subnet information of the Network.

+
+
+ +
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Table 11 io.k8s.apimachinery.pkg.apis.meta.v1.Condition

Parameter

+

Mandatory

+

Type

+

Description

+

lastTransitionTime

+

Yes

+

String

+

lastTransitionTime is the last time the condition transitioned from one status to another. This should be when the underlying condition changed. If that is not known, then using the time when the API field changed is acceptable.

+

message

+

Yes

+

String

+

message is a human readable message indicating details about the transition. This may be an empty string.

+

observedGeneration

+

No

+

Long

+

observedGeneration represents the .metadata.generation that the condition was set based upon. For instance, if .metadata.generation is currently 12, but the .status.conditions[x].observedGeneration is 9, the condition is out of date with respect to the current state of the instance.

+

reason

+

Yes

+

String

+

reason contains a programmatic identifier indicating the reason for the condition's last transition. Producers of specific condition types may define expected values and meanings for this field, and whether the values are considered a guaranteed API. The value should be a CamelCase string. This field may not be empty.

+

status

+

Yes

+

String

+

status of the condition, one of True, False, Unknown.

+

type

+

Yes

+

String

+

type of condition in CamelCase or in foo.example.com/CamelCase.

+
+
+ +
+ + + + + + + + + + + + + + + + + + + + + +
Table 12 com.otc.paas-core.yangtse.pkg.apis.yangtse.v2.SubnetAttr

Parameter

+

Mandatory

+

Type

+

Description

+

networkID

+

No

+

String

+		  

subnetV4ID

+

No

+

String

+		  

subnetV6ID

+

No

+

String

+		  
+
+
+

Response Parameters

Status code: 200

+ +
+ + + + + + + + + + + + + + + + + + + + + + + + + +
Table 13 Response body parameters

Parameter

+

Type

+

Description

+

apiVersion

+

String

+

APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#resources

+

kind

+

String

+

Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds

+

metadata

+

io.k8s.apimachinery.pkg.apis.meta.v1.ObjectMeta object

+

ObjectMeta is metadata that all persisted resources must have, which includes all objects users must create.

+

spec

+

com.otc.paas-core.yangtse.pkg.apis.yangtse.v2.NetworkSpec object

+

Specification of the desired behavior of network.

+

status

+

com.otc.paas-core.yangtse.pkg.apis.yangtse.v2.NetworkStatus object

+

Most recently observed status of the network.

+
+
+ +
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Table 14 io.k8s.apimachinery.pkg.apis.meta.v1.ObjectMeta

Parameter

+

Type

+

Description

+

annotations

+

Map<String,String>

+

Annotations is an unstructured key value map stored with a resource that may be set by external tools to store and retrieve arbitrary metadata. They are not queryable and should be preserved when modifying objects. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/annotations/

+

clusterName

+

String

+

The name of the cluster which the object belongs to. This is used to distinguish resources with same name and namespace in different clusters. This field is not set anywhere right now and apiserver is going to ignore it if set in create or update request.

+

creationTimestamp

+

String

+

CreationTimestamp is a timestamp representing the server time when this object was created. It is not guaranteed to be set in happens-before order across separate operations. Clients may not set this value. It is represented in RFC3339 form and is in UTC.

+

Populated by the system. Read-only. Null for lists. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata

+

deletionGracePeriodSeconds

+

Long

+

Number of seconds allowed for this object to gracefully terminate before it will be removed from the system. Only set when deletionTimestamp is also set. May only be shortened. Read-only.

+

deletionTimestamp

+

String

+

DeletionTimestamp is RFC 3339 date and time at which this resource will be deleted. This field is set by the server when a graceful deletion is requested by the user, and is not directly settable by a client. The resource is expected to be deleted (no longer visible from resource lists, and not reachable by name) after the time in this field, once the finalizers list is empty. As long as the finalizers list contains items, deletion is blocked. Once the deletionTimestamp is set, this value may not be unset or be set further into the future, although it may be shortened or the resource may be deleted prior to this time. For example, a user may request that a pod is deleted in 30 seconds. The Kubelet will react by sending a graceful termination signal to the containers in the pod. After that 30 seconds, the Kubelet will send a hard termination signal (SIGKILL) to the container and after cleanup, remove the pod from the API. In the presence of network partitions, this object may still exist after this timestamp, until an administrator or automated process can determine the resource is fully terminated. If not set, graceful deletion of the object has not been requested.

+

Populated by the system when a graceful deletion is requested. Read-only. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata

+

enable

+

Boolean

+

Enable identifies whether the resource is available

+

finalizers

+

Array of strings

+

Must be empty before the object is deleted from the registry.

+

Each entry is an identifier for the responsible component that will remove the entry from the list. If the deletionTimestamp of the object is non-nil, entries in this list can only be removed. Finalizers may be processed and removed in any order. Order is NOT enforced because it introduces significant risk of stuck finalizers. finalizers is a shared field, any actor with permission can reorder it. If the finalizer list is processed in order, then this can lead to a situation in which the component responsible for the first finalizer in the list is waiting for a signal (field value, external system, or other) produced by a component responsible for a finalizer later in the list, resulting in a deadlock. Without enforced ordering finalizers are free to order amongst themselves and are not vulnerable to ordering changes in the list.

+

generateName

+

String

+

GenerateName is an optional prefix, used by the server, to generate a unique name ONLY IF the Name field has not been provided. If this field is used, the name returned to the client will be different than the name passed. This value will also be combined with a unique suffix. The provided value has the same validation rules as the Name field, and may be truncated by the length of the suffix required to make the value unique on the server.

+

If this field is specified and the generated name exists, the server will NOT return a 409 - instead, it will either return 201 Created or 500 with Reason ServerTimeout indicating a unique name could not be found in the time allotted, and the client should retry (optionally after the time indicated in the Retry-After header).

+

Applied only if Name is not specified. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#idempotency

+

generation

+

Long

+

A sequence number representing a specific generation of the desired state. Populated by the system. Read-only.

+

labels

+

Map<String,String>

+

Map of string keys and values that can be used to organize and categorize (scope and select) objects. May match selectors of replication controllers and services. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/labels/

+

managedFields

+

Array of io.k8s.apimachinery.pkg.apis.meta.v1.ManagedFieldsEntry objects

+

ManagedFields maps workflow-id and version to the set of fields that are managed by that workflow. This is mostly for internal housekeeping, and users typically shouldn't need to set or understand this field. A workflow can be the user's name, a controller's name, or the name of a specific apply path like "ci-cd". The set of fields is always in the version that the workflow used when modifying the object.

+

name

+

String

+

Name must be unique within a namespace. Is required when creating resources, although some resources may allow a client to request the generation of an appropriate name automatically. Name is primarily intended for creation idempotence and configuration definition. Cannot be updated. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names

+

namespace

+

String

+

Namespace defines the space within which each name must be unique. An empty namespace is equivalent to the "default" namespace, but "default" is the canonical representation. Not all objects are required to be scoped to a namespace - the value of this field for those objects will be empty.

+

Must be a DNS_LABEL. Cannot be updated. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/namespaces/

+

ownerReferences

+

Array of io.k8s.apimachinery.pkg.apis.meta.v1.OwnerReference objects

+

List of objects depended by this object. If ALL objects in the list have been deleted, this object will be garbage collected. If this object is managed by a controller, then an entry in this list will point to this controller, with the controller field set to true. There cannot be more than one managing controller.

+

resourceVersion

+

String

+

An opaque value that represents the internal version of this object that can be used by clients to determine when objects have changed. May be used for optimistic concurrency, change detection, and the watch operation on a resource or set of resources. Clients must treat these values as opaque and passed unmodified back to the server. They may only be valid for a particular resource or set of resources.

+

Populated by the system. Read-only. Value must be treated as opaque by clients and . More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#concurrency-control-and-consistency

+

selfLink

+

String

+

SelfLink is a URL representing this object. Populated by the system. Read-only.

+

DEPRECATED Kubernetes will stop propagating this field in 1.20 release and the field is planned to be removed in 1.21 release.

+

uid

+

String

+

UID is the unique in time and space value for this object. It is typically generated by the server on successful creation of a resource and is not allowed to change on PUT operations.

+

Populated by the system. Read-only. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#uids

+
+
+ +
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Table 15 io.k8s.apimachinery.pkg.apis.meta.v1.ManagedFieldsEntry

Parameter

+

Type

+

Description

+

apiVersion

+

String

+

APIVersion defines the version of this resource that this field set applies to. The format is "group/version" just like the top-level APIVersion field. It is necessary to track the version of a field set because it cannot be automatically converted.

+

fieldsType

+

String

+

FieldsType is the discriminator for the different fields format and version. There is currently only one possible value: "FieldsV1"

+

fieldsV1

+

Object

+

FieldsV1 holds the first JSON version format as described in the "FieldsV1" type.

+

manager

+

String

+

Manager is an identifier of the workflow managing these fields.

+

operation

+

String

+

Operation is the type of operation which lead to this ManagedFieldsEntry

+

being created. The only valid values for this field are 'Apply' and 'Update'.

+

time

+

String

+

Time is timestamp of when these fields were set. It should always be empty if Operation is 'Apply'

+
+
+ +
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Table 16 io.k8s.apimachinery.pkg.apis.meta.v1.OwnerReference

Parameter

+

Type

+

Description

+

apiVersion

+

String

+

API version of the referent.

+

blockOwnerDeletion

+

Boolean

+

If true, AND if the owner has the "foregroundDeletion" finalizer, then the owner cannot be deleted from the key-value store until this reference is removed. Defaults to false. To set this field, a user needs "delete" permission of the owner, otherwise 422 (Unprocessable Entity) will be returned.

+

controller

+

Boolean

+

If true, this reference points to the managing controller.

+

kind

+

String

+

Kind of the referent. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds

+

name

+

String

+

Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names

+

uid

+

String

+

UID of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#uids

+
+
+ +
+ + + + + + + + + + + + + + + + + + + + + +
Table 17 com.otc.paas-core.yangtse.pkg.apis.yangtse.v2.NetworkSpec

Parameter

+

Type

+

Description

+

ipFamilies

+

Array of strings

+

IPFamilies of Network, can be "IPv4" or "IPv6".

+

networkType

+

String

+

Type of network, only support "underlay-neutron".

+

securityGroups

+

Array of strings

+

SecurityGroups of the network NOTE: 1. nil means not enable security group; 2. [""] means enable security group but deny all; 3. ["xxx,yyy"] means enable security group and allow with security group ids;

+

subnets

+

Array of com.otc.paas-core.yangtse.pkg.apis.yangtse.v2.SubnetConf objects

+

Describes the subnets of the network

+
+
+ +
+ + + + + + + + + +
Table 18 com.otc.paas-core.yangtse.pkg.apis.yangtse.v2.SubnetConf

Parameter

+

Type

+

Description

+

subnetID

+

String

+

SubnetID subnetV4ID of the subnet

+
+
+ +
+ + + + + + + + + + + + + + + + + +
Table 19 com.otc.paas-core.yangtse.pkg.apis.yangtse.v2.NetworkStatus

Parameter

+

Type

+

Description

+

conditions

+

Array of io.k8s.apimachinery.pkg.apis.meta.v1.Condition objects

+

Conditions describe the current conditions of the Network.

+

status

+

String

+

Status of network, can be "Ready" or "Failed" or "IPInsufficient"

+

subnetAttrs

+

Array of com.otc.paas-core.yangtse.pkg.apis.yangtse.v2.SubnetAttr objects

+

SubnetAttrs describe the current subnet information of the Network

+
+
+ +
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Table 20 io.k8s.apimachinery.pkg.apis.meta.v1.Condition

Parameter

+

Type

+

Description

+

lastTransitionTime

+

String

+

lastTransitionTime is the last time the condition transitioned from one status to another. This should be when the underlying condition changed. If that is not known, then using the time when the API field changed is acceptable.

+

message

+

String

+

message is a human readable message indicating details about the transition. This may be an empty string.

+

observedGeneration

+

Long

+

observedGeneration represents the .metadata.generation that the condition was set based upon. For instance, if .metadata.generation is currently 12, but the .status.conditions[x].observedGeneration is 9, the condition is out of date with respect to the current state of the instance.

+

reason

+

String

+

reason contains a programmatic identifier indicating the reason for the condition's last transition. Producers of specific condition types may define expected values and meanings for this field, and whether the values are considered a guaranteed API. The value should be a CamelCase string. This field may not be empty.

+

status

+

String

+

status of the condition, one of True, False, Unknown.

+

type

+

String

+

type of condition in CamelCase or in foo.example.com/CamelCase.

+
+
+ +
+ + + + + + + + + + + + + + + + + +
Table 21 com.otc.paas-core.yangtse.pkg.apis.yangtse.v2.SubnetAttr

Parameter

+

Type

+

Description

+

networkID

+

String

+		  

subnetV4ID

+

String

+		  

subnetV6ID

+

String

+		  
+
+

Status code: 201

+ +
+ + + + + + + + + + + + + + + + + + + + + + + + + +
Table 22 Response body parameters

Parameter

+

Type

+

Description

+

apiVersion

+

String

+

APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#resources

+

kind

+

String

+

Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds

+

metadata

+

io.k8s.apimachinery.pkg.apis.meta.v1.ObjectMeta object

+

ObjectMeta is metadata that all persisted resources must have, which includes all objects users must create.

+

spec

+

com.otc.paas-core.yangtse.pkg.apis.yangtse.v2.NetworkSpec object

+

Specification of the desired behavior of network.

+

status

+

com.otc.paas-core.yangtse.pkg.apis.yangtse.v2.NetworkStatus object

+

Most recently observed status of the network.

+
+
+ +
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Table 23 io.k8s.apimachinery.pkg.apis.meta.v1.ObjectMeta

Parameter

+

Type

+

Description

+

annotations

+

Map<String,String>

+

Annotations is an unstructured key value map stored with a resource that may be set by external tools to store and retrieve arbitrary metadata. They are not queryable and should be preserved when modifying objects. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/annotations/

+

clusterName

+

String

+

The name of the cluster which the object belongs to. This is used to distinguish resources with same name and namespace in different clusters. This field is not set anywhere right now and apiserver is going to ignore it if set in create or update request.

+

creationTimestamp

+

String

+

CreationTimestamp is a timestamp representing the server time when this object was created. It is not guaranteed to be set in happens-before order across separate operations. Clients may not set this value. It is represented in RFC3339 form and is in UTC.

+

Populated by the system. Read-only. Null for lists. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata

+

deletionGracePeriodSeconds

+

Long

+

Number of seconds allowed for this object to gracefully terminate before it will be removed from the system. Only set when deletionTimestamp is also set. May only be shortened. Read-only.

+

deletionTimestamp

+

String

+

DeletionTimestamp is RFC 3339 date and time at which this resource will be deleted. This field is set by the server when a graceful deletion is requested by the user, and is not directly settable by a client. The resource is expected to be deleted (no longer visible from resource lists, and not reachable by name) after the time in this field, once the finalizers list is empty. As long as the finalizers list contains items, deletion is blocked. Once the deletionTimestamp is set, this value may not be unset or be set further into the future, although it may be shortened or the resource may be deleted prior to this time. For example, a user may request that a pod is deleted in 30 seconds. The Kubelet will react by sending a graceful termination signal to the containers in the pod. After that 30 seconds, the Kubelet will send a hard termination signal (SIGKILL) to the container and after cleanup, remove the pod from the API. In the presence of network partitions, this object may still exist after this timestamp, until an administrator or automated process can determine the resource is fully terminated. If not set, graceful deletion of the object has not been requested.

+

Populated by the system when a graceful deletion is requested. Read-only. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata

+

enable

+

Boolean

+

Enable identifies whether the resource is available

+

finalizers

+

Array of strings

+

Must be empty before the object is deleted from the registry.

+

Each entry is an identifier for the responsible component that will remove the entry from the list. If the deletionTimestamp of the object is non-nil, entries in this list can only be removed. Finalizers may be processed and removed in any order. Order is NOT enforced because it introduces significant risk of stuck finalizers. finalizers is a shared field, any actor with permission can reorder it. If the finalizer list is processed in order, then this can lead to a situation in which the component responsible for the first finalizer in the list is waiting for a signal (field value, external system, or other) produced by a component responsible for a finalizer later in the list, resulting in a deadlock. Without enforced ordering finalizers are free to order amongst themselves and are not vulnerable to ordering changes in the list.

+

generateName

+

String

+

GenerateName is an optional prefix, used by the server, to generate a unique name ONLY IF the Name field has not been provided. If this field is used, the name returned to the client will be different than the name passed. This value will also be combined with a unique suffix. The provided value has the same validation rules as the Name field, and may be truncated by the length of the suffix required to make the value unique on the server.

+

If this field is specified and the generated name exists, the server will NOT return a 409 - instead, it will either return 201 Created or 500 with Reason ServerTimeout indicating a unique name could not be found in the time allotted, and the client should retry (optionally after the time indicated in the Retry-After header).

+

Applied only if Name is not specified. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#idempotency

+

generation

+

Long

+

A sequence number representing a specific generation of the desired state. Populated by the system. Read-only.

+

labels

+

Map<String,String>

+

Map of string keys and values that can be used to organize and categorize (scope and select) objects. May match selectors of replication controllers and services. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/labels/

+

managedFields

+

Array of io.k8s.apimachinery.pkg.apis.meta.v1.ManagedFieldsEntry objects

+

ManagedFields maps workflow-id and version to the set of fields that are managed by that workflow. This is mostly for internal housekeeping, and users typically shouldn't need to set or understand this field. A workflow can be the user's name, a controller's name, or the name of a specific apply path like "ci-cd". The set of fields is always in the version that the workflow used when modifying the object.

+

name

+

String

+

Name must be unique within a namespace. Is required when creating resources, although some resources may allow a client to request the generation of an appropriate name automatically. Name is primarily intended for creation idempotence and configuration definition. Cannot be updated. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names

+

namespace

+

String

+

Namespace defines the space within which each name must be unique. An empty namespace is equivalent to the "default" namespace, but "default" is the canonical representation. Not all objects are required to be scoped to a namespace - the value of this field for those objects will be empty.

+

Must be a DNS_LABEL. Cannot be updated. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/namespaces/

+

ownerReferences

+

Array of io.k8s.apimachinery.pkg.apis.meta.v1.OwnerReference objects

+

List of objects depended by this object. If ALL objects in the list have been deleted, this object will be garbage collected. If this object is managed by a controller, then an entry in this list will point to this controller, with the controller field set to true. There cannot be more than one managing controller.

+

resourceVersion

+

String

+

An opaque value that represents the internal version of this object that can be used by clients to determine when objects have changed. May be used for optimistic concurrency, change detection, and the watch operation on a resource or set of resources. Clients must treat these values as opaque and passed unmodified back to the server. They may only be valid for a particular resource or set of resources.

+

Populated by the system. Read-only. Value must be treated as opaque by clients and . More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#concurrency-control-and-consistency

+

selfLink

+

String

+

SelfLink is a URL representing this object. Populated by the system. Read-only.

+

DEPRECATED Kubernetes will stop propagating this field in 1.20 release and the field is planned to be removed in 1.21 release.

+

uid

+

String

+

UID is the unique in time and space value for this object. It is typically generated by the server on successful creation of a resource and is not allowed to change on PUT operations.

+

Populated by the system. Read-only. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#uids

+
+
+ +
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Table 24 io.k8s.apimachinery.pkg.apis.meta.v1.ManagedFieldsEntry

Parameter

+

Type

+

Description

+

apiVersion

+

String

+

APIVersion defines the version of this resource that this field set applies to. The format is "group/version" just like the top-level APIVersion field. It is necessary to track the version of a field set because it cannot be automatically converted.

+

fieldsType

+

String

+

FieldsType is the discriminator for the different fields format and version. There is currently only one possible value: "FieldsV1"

+

fieldsV1

+

Object

+

FieldsV1 holds the first JSON version format as described in the "FieldsV1" type.

+

manager

+

String

+

Manager is an identifier of the workflow managing these fields.

+

operation

+

String

+

Operation is the type of operation which lead to this ManagedFieldsEntry being created. The only valid values for this field are 'Apply' and 'Update'.

+

time

+

String

+

Time is timestamp of when these fields were set. It should always be empty if Operation is 'Apply'

+
+
+ +
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Table 25 io.k8s.apimachinery.pkg.apis.meta.v1.OwnerReference

Parameter

+

Type

+

Description

+

apiVersion

+

String

+

API version of the referent.

+

blockOwnerDeletion

+

Boolean

+

If true, AND if the owner has the "foregroundDeletion" finalizer, then the owner cannot be deleted from the key-value store until this reference is removed. Defaults to false. To set this field, a user needs "delete" permission of the owner, otherwise 422 (Unprocessable Entity) will be returned.

+

controller

+

Boolean

+

If true, this reference points to the managing controller.

+

kind

+

String

+

Kind of the referent. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds

+

name

+

String

+

Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names

+

uid

+

String

+

UID of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#uids

+
+
+ +
+ + + + + + + + + + + + + + + + + + + + + +
Table 26 com.otc.paas-core.yangtse.pkg.apis.yangtse.v2.NetworkSpec

Parameter

+

Type

+

Description

+

ipFamilies

+

Array of strings

+

IPFamilies of Network, can be "IPv4" or "IPv6"

+

networkType

+

String

+

Type of network, only support "underlay-neutron"

+

securityGroups

+

Array of strings

+

SecurityGroups of the network. NOTE: 1. nil means not enable security group; 2. [""] means enable security group but deny all; 3. ["xxx,yyy"] means enable security group and allow with security group ids;

+

subnets

+

Array of com.otc.paas-core.yangtse.pkg.apis.yangtse.v2.SubnetConf objects

+

Describes the subnets of the network.

+
+
+ +
+ + + + + + + + + +
Table 27 com.otc.paas-core.yangtse.pkg.apis.yangtse.v2.SubnetConf

Parameter

+

Type

+

Description

+

subnetID

+

String

+

SubnetID subnetV4ID of the subnet

+
+
+ +
+ + + + + + + + + + + + + + + + + +
Table 28 com.otc.paas-core.yangtse.pkg.apis.yangtse.v2.NetworkStatus

Parameter

+

Type

+

Description

+

conditions

+

Array of io.k8s.apimachinery.pkg.apis.meta.v1.Condition objects

+

Conditions describe the current conditions of the Network.

+

status

+

String

+

Status of network, can be "Ready" or "Failed" or "IPInsufficient".

+

subnetAttrs

+

Array of com.otc.paas-core.yangtse.pkg.apis.yangtse.v2.SubnetAttr objects

+

SubnetAttrs describe the current subnet information of the Network.

+
+
+ +
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Table 29 io.k8s.apimachinery.pkg.apis.meta.v1.Condition

Parameter

+

Type

+

Description

+

lastTransitionTime

+

String

+

lastTransitionTime is the last time the condition transitioned from one status to another. This should be when the underlying condition changed. If that is not known, then using the time when the API field changed is acceptable.

+

message

+

String

+

message is a human readable message indicating details about the transition. This may be an empty string.

+

observedGeneration

+

Long

+

observedGeneration represents the .metadata.generation that the condition was set based upon. For instance, if .metadata.generation is currently 12, but the .status.conditions[x].observedGeneration is 9, the condition is out of date with respect to the current state of the instance.

+

reason

+

String

+

reason contains a programmatic identifier indicating the reason for the condition's last transition. Producers of specific condition types may define expected values and meanings for this field, and whether the values are considered a guaranteed API. The value should be a CamelCase string. This field may not be empty.

+

status

+

String

+

status of the condition, one of True, False, Unknown.

+

type

+

String

+

type of condition in CamelCase or in foo.example.com/CamelCase.

+
+
+ +
+ + + + + + + + + + + + + + + + + +
Table 30 com.otc.paas-core.yangtse.pkg.apis.yangtse.v2.SubnetAttr

Parameter

+

Type

+

Description

+

networkID

+

String

+		  

subnetV4ID

+

String

+		  

subnetV6ID

+

String

+		  
+
+
+

Example Requests

{
+  "apiVersion" : "yangtse/v2",
+  "kind" : "Network",
+  "metadata" : {
+    "annotations" : {
+      "yangtse.io/domain-id" : "08a*************************ee60",
+      "yangtse.io/project-id" : "08a2*************************c03",
+      "yangtse.io/warm-pool-recycle-interval" : "1",
+      "yangtse.io/warm-pool-size" : "10"
+    },
+    "creationTimestamp" : "2024-03-25T09:27:52Z",
+    "finalizers" : [ "yangtse.io/network-cleanup" ],
+    "name" : "test-api",
+    "namespace" : "test-api",
+    "resourceVersion" : "17365331",
+    "uid" : "70c20697-a233-4405-b512-ebec1d3c58d0"
+  },
+  "spec" : {
+    "networkType" : "underlay_neutron",
+    "securityGroups" : [ "4120c2f9-3a1d-453e-9b64-f51b92861e26" ],
+    "subnets" : [ {
+      "subnetID" : "2eb62e19-cf1a-4741-90cc-90fb127b20ab"
+    } ]
+  },
+  "status" : {
+    "conditions" : [ {
+      "lastTransitionTime" : "2024-03-25T09:27:53Z",
+      "message" : "",
+      "reason" : "",
+      "status" : "True",
+      "type" : "NetworkSynced"
+    }, {
+      "lastTransitionTime" : "2024-08-12T15:40:03Z",
+      "message" : "",
+      "reason" : "",
+      "status" : "True",
+      "type" : "NetworkExternalDependenciesSynced"
+    } ],
+    "status" : "Ready",
+    "subnetAttrs" : [ {
+      "networkID" : "377b6228-d2a7-47ab-bdb0-f7fc59802198",
+      "subnetV4ID" : "2eb62e19-cf1a-4741-90cc-90fb127b20ab"
+    } ]
+  }
+}
+
+

Example Responses

Status code: 200

+

OK

+
{
+  "apiVersion" : "yangtse/v2",
+  "kind" : "Network",
+  "metadata" : {
+    "annotations" : {
+      "yangtse.io/domain-id" : "08a*************************ee60",
+      "yangtse.io/project-id" : "08a2*************************c03",
+      "yangtse.io/warm-pool-recycle-interval" : "1",
+      "yangtse.io/warm-pool-size" : "10"
+    },
+    "creationTimestamp" : "2024-03-25T09:27:52Z",
+    "finalizers" : [ "yangtse.io/network-cleanup" ],
+    "name" : "test-api",
+    "namespace" : "test-api",
+    "resourceVersion" : "17365331",
+    "uid" : "70c20697-a233-4405-b512-ebec1d3c58d0"
+  },
+  "spec" : {
+    "networkType" : "underlay_neutron",
+    "securityGroups" : [ "4120c2f9-3a1d-453e-9b64-f51b92861e26" ],
+    "subnets" : [ {
+      "subnetID" : "2eb62e19-cf1a-4741-90cc-90fb127b20ab"
+    } ]
+  },
+  "status" : {
+    "conditions" : [ {
+      "lastTransitionTime" : "2024-03-25T09:27:53Z",
+      "message" : "",
+      "reason" : "",
+      "status" : "True",
+      "type" : "NetworkSynced"
+    }, {
+      "lastTransitionTime" : "2024-08-12T15:40:03Z",
+      "message" : "",
+      "reason" : "",
+      "status" : "True",
+      "type" : "NetworkExternalDependenciesSynced"
+    } ],
+    "status" : "Ready",
+    "subnetAttrs" : [ {
+      "networkID" : "377b6228-d2a7-47ab-bdb0-f7fc59802198",
+      "subnetV4ID" : "2eb62e19-cf1a-4741-90cc-90fb127b20ab"
+    } ]
+  }
+}
+
+

Status Codes

+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +

Status Code

+

Description

+

200

+

OK

+

201

+

Created

+

400

+

BadRequest

+

401

+

Unauthorized

+

403

+

Forbidden

+

404

+

NotFound

+

405

+

MethodNotAllowed

+

406

+

NotAcceptable

+

409

+

Conflict

+

415

+

UnsupportedMediaType

+

422

+

Invalid

+

429

+

TooManyRequests

+

500

+

InternalError

+

503

+

ServiceUnavailable

+

504

+

ServerTimeout

+
+
+
+
+
+
+
Parent topic: Proprietary APIs
+
+
+