openapi: 3.2.0 info: description: 'API for the Kubernetes Engine service (also known as the Container Engine for Kubernetes service). Use this API to build, deploy, and manage cloud-native applications. For more information, see [Overview of Kubernetes Engine](/iaas/Content/ContEng/Concepts/contengoverview.htm). ' title: Kubernetes Engine Container Engine API version: '20180222' x-provenance: method: harvested first_party: true publisher: Oracle source: https://docs.oracle.com/en-us/iaas/api/specs/4df4f97c7c9ec6e110348e9f8c7ebf37694345f2f7c258ed63081514d82acb89.yaml harvested: '2026-08-04' note: Published by Oracle as the contract for the Kubernetes Engine API OCI service and stored verbatim; API Evangelist added only this provenance block. x-evidence: - url: https://docs.oracle.com/en-us/iaas/api/specs/index.json what: Oracle's own index of every OCI service specification - url: https://docs.oracle.com/en-us/iaas/api/specs/4df4f97c7c9ec6e110348e9f8c7ebf37694345f2f7c258ed63081514d82acb89.yaml what: the harvested document for Kubernetes Engine API servers: - url: /20180222 tags: - description: API operations for working with the container engine service. name: containerEngine paths: /addonOptions: get: description: Get list of supported addons for a specific kubernetes version. operationId: ListAddonOptions parameters: - $ref: '#/components/parameters/KubernetesVersionQueryParam' - $ref: '#/components/parameters/AddonNameQueryParam' - $ref: '#/components/parameters/RequestIdHeader' - $ref: '#/components/parameters/PaginationLimitQueryParam' - $ref: '#/components/parameters/PaginationTokenQueryParam' - $ref: '#/components/parameters/SortOrderQueryParam' - description: The optional field to sort the results by. in: query name: sortBy required: false schema: type: string enum: - NAME - TIME_CREATED - description: 'Specifies whether all add-on versions should be displayed. The default value is false. If set to true, the API will return all available add-on versions, including deprecated versions and detailed build numbers. Please note that the use of deprecated versions, as well as the specification of a particular build of a supported version, is not recommended for standard operations. ' in: query name: shouldShowAllVersions required: false schema: type: boolean default: false responses: '200': description: A list of addon option summary objects for a specific kubernetes version. headers: opc-next-page: description: 'For list pagination. When this header appears in the response, additional pages of results remain. For important details about how pagination works, see [List Pagination](/iaas/Content/API/Concepts/usingapi.htm#nine). ' schema: type: string opc-request-id: description: 'Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. ' schema: type: string content: application/json: schema: items: $ref: '#/components/schemas/AddonOptionSummary' type: array '401': $ref: '#/components/responses/NotAuthenticated' '404': $ref: '#/components/responses/NotAuthorizedOrNotFound' '429': $ref: '#/components/responses/TooManyRequests' '500': $ref: '#/components/responses/InternalServerError' default: $ref: '#/components/responses/DefaultError' summary: Get list of supported addons for a specific kubernetes version. tags: - containerEngine x-obmcs-authz-declarations: authorizationRequired: false /clusterOptions/{clusterOptionId}: get: description: Get options available for clusters. operationId: GetClusterOptions parameters: - $ref: '#/components/parameters/ClusterOptionIdPathParam' - $ref: '#/components/parameters/CompartmentIdOptionalQueryParam' - $ref: '#/components/parameters/ShouldListAllPatchVersionsQueryParam' - $ref: '#/components/parameters/RequestIdHeader' responses: '200': description: The cluster options. headers: opc-request-id: description: 'Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. ' schema: type: string content: application/json: schema: $ref: '#/components/schemas/ClusterOptions' '401': $ref: '#/components/responses/NotAuthenticated' '404': $ref: '#/components/responses/NotAuthorizedOrNotFound' '429': $ref: '#/components/responses/TooManyRequests' '500': $ref: '#/components/responses/InternalServerError' default: $ref: '#/components/responses/DefaultError' summary: Get cluster options. tags: - containerEngine /clusters: get: description: List all the cluster objects in a compartment. operationId: ListClusters parameters: - $ref: '#/components/parameters/CompartmentIdQueryParam' - $ref: '#/components/parameters/ClusterLifecycleStateFilterQueryParam' - $ref: '#/components/parameters/NameFilterQueryParam' - $ref: '#/components/parameters/PaginationLimitQueryParam' - $ref: '#/components/parameters/PaginationTokenQueryParam' - $ref: '#/components/parameters/SortOrderQueryParam' - description: The optional field to sort the results by. in: query name: sortBy required: false schema: type: string enum: - ID - NAME - TIME_CREATED - $ref: '#/components/parameters/RequestIdHeader' responses: '200': description: A list of cluster summary objects. headers: opc-next-page: description: 'For list pagination. When this header appears in the response, additional pages of results remain. For important details about how pagination works, see [List Pagination](/iaas/Content/API/Concepts/usingapi.htm#nine). ' schema: type: string opc-request-id: description: 'Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. ' schema: type: string content: application/json: schema: items: $ref: '#/components/schemas/ClusterSummary' type: array '401': $ref: '#/components/responses/NotAuthenticated' '404': $ref: '#/components/responses/NotAuthorizedOrNotFound' '429': $ref: '#/components/responses/TooManyRequests' '500': $ref: '#/components/responses/InternalServerError' default: $ref: '#/components/responses/DefaultError' summary: List all cluster objects. tags: - containerEngine post: description: Create a new cluster. operationId: CreateCluster parameters: - $ref: '#/components/parameters/IdempotencyTokenHeader' - $ref: '#/components/parameters/RequestIdHeader' responses: '202': $ref: '#/components/responses/Accepted' '400': $ref: '#/components/responses/BadRequest' '401': $ref: '#/components/responses/NotAuthenticated' '404': $ref: '#/components/responses/NotAuthorizedOrNotFound' '409': $ref: '#/components/responses/IncorrectState' '429': $ref: '#/components/responses/TooManyRequests' '500': $ref: '#/components/responses/InternalServerError' default: $ref: '#/components/responses/DefaultError' summary: Create a new cluster. tags: - containerEngine x-related-resource: '#/definitions/Cluster' requestBody: content: application/json: schema: $ref: '#/components/schemas/CreateClusterDetails' description: The details of the cluster to create. required: true /clusters/{clusterId}: delete: description: Delete a cluster. operationId: DeleteCluster parameters: - $ref: '#/components/parameters/ClusterIdPathParam' - $ref: '#/components/parameters/IfMatchHeader' - $ref: '#/components/parameters/RequestIdHeader' responses: '202': $ref: '#/components/responses/Accepted' '401': $ref: '#/components/responses/NotAuthenticated' '404': $ref: '#/components/responses/NotAuthorizedOrNotFound' '409': $ref: '#/components/responses/IncorrectState' '412': $ref: '#/components/responses/NoEtagMatch' '429': $ref: '#/components/responses/TooManyRequests' '500': $ref: '#/components/responses/InternalServerError' default: $ref: '#/components/responses/DefaultError' summary: Delete a cluster. tags: - containerEngine x-related-resource: '#/definitions/Cluster' get: description: Get the details of a cluster. operationId: GetCluster parameters: - $ref: '#/components/parameters/ClusterIdPathParam' - $ref: '#/components/parameters/RequestIdHeader' - $ref: '#/components/parameters/IsOpenIdConnectAuthConfigFileIncludedQueryParam' responses: '200': description: The cluster details. headers: etag: description: For optimistic concurrency control. See `if-match`. schema: type: string opc-request-id: description: 'Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. ' schema: type: string content: application/json: schema: $ref: '#/components/schemas/Cluster' '401': $ref: '#/components/responses/NotAuthenticated' '404': $ref: '#/components/responses/NotAuthorizedOrNotFound' '429': $ref: '#/components/responses/TooManyRequests' '500': $ref: '#/components/responses/InternalServerError' default: $ref: '#/components/responses/DefaultError' summary: Get cluster details. tags: - containerEngine put: description: Update the details of a cluster. operationId: UpdateCluster parameters: - $ref: '#/components/parameters/ClusterIdPathParam' - $ref: '#/components/parameters/IfMatchHeader' - $ref: '#/components/parameters/RequestIdHeader' responses: '202': $ref: '#/components/responses/Accepted' '400': $ref: '#/components/responses/BadRequest' '401': $ref: '#/components/responses/NotAuthenticated' '404': $ref: '#/components/responses/NotAuthorizedOrNotFound' '412': $ref: '#/components/responses/NoEtagMatch' '429': $ref: '#/components/responses/TooManyRequests' '500': $ref: '#/components/responses/InternalServerError' default: $ref: '#/components/responses/DefaultError' summary: Update cluster details. tags: - containerEngine x-related-resource: '#/definitions/Cluster' requestBody: content: application/json: schema: $ref: '#/components/schemas/UpdateClusterDetails' description: The details of the cluster to update. required: true /clusters/{clusterId}/actions/completeCredentialRotation: post: description: Complete cluster credential rotation. Retire old credentials from kubernetes components. operationId: CompleteCredentialRotation parameters: - $ref: '#/components/parameters/ClusterIdPathParam' - $ref: '#/components/parameters/IdempotencyTokenHeader' - $ref: '#/components/parameters/RequestIdHeader' - $ref: '#/components/parameters/IfMatchHeader' responses: '202': $ref: '#/components/responses/Accepted' '400': $ref: '#/components/responses/BadRequest' '401': $ref: '#/components/responses/NotAuthenticated' '404': $ref: '#/components/responses/NotAuthorizedOrNotFound' '409': $ref: '#/components/responses/IncorrectState' '412': $ref: '#/components/responses/NoEtagMatch' '429': $ref: '#/components/responses/TooManyRequests' '500': $ref: '#/components/responses/InternalServerError' default: $ref: '#/components/responses/DefaultError' summary: Complete cluster credential rotation. tags: - containerEngine x-related-resource: '#/definitions/Cluster' /clusters/{clusterId}/actions/extendEndpointDecommissionRollbackDeadline: post: description: 'Extend the rollback deadline of public api endpoint decommission for a cluster. The operation can only be performed within decommission rollback deadline. ' operationId: ExtendEndpointDecommissionRollbackDeadline parameters: - $ref: '#/components/parameters/ClusterIdPathParam' - $ref: '#/components/parameters/IdempotencyTokenHeader' - $ref: '#/components/parameters/RequestIdHeader' - $ref: '#/components/parameters/IfMatchHeader' responses: '200': description: The cluster's public api endpoint decommission status details. headers: etag: description: For optimistic concurrency control. See `if-match`. schema: type: string opc-request-id: description: 'Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. ' schema: type: string content: application/json: schema: $ref: '#/components/schemas/PublicApiEndpointDecommissionStatus' '400': $ref: '#/components/responses/BadRequest' '401': $ref: '#/components/responses/NotAuthenticated' '404': $ref: '#/components/responses/NotAuthorizedOrNotFound' '409': $ref: '#/components/responses/IncorrectState' '412': $ref: '#/components/responses/NoEtagMatch' '429': $ref: '#/components/responses/TooManyRequests' '500': $ref: '#/components/responses/InternalServerError' default: $ref: '#/components/responses/DefaultError' summary: Extend the rollback deadline of public api endpoint decommission for a cluster. tags: - containerEngine x-related-resource: '#/definitions/Cluster' requestBody: content: application/json: schema: $ref: '#/components/schemas/ExtendEndpointDecommissionRollbackDeadlineDetails' description: The details for a kubernetes cluster to extend public api endpoint decommission rollback deadline. required: true /clusters/{clusterId}/actions/migrateToNativeVcn: post: description: Initiates cluster migration to use native VCN. operationId: ClusterMigrateToNativeVcn parameters: - $ref: '#/components/parameters/ClusterIdPathParam' - $ref: '#/components/parameters/IfMatchHeader' - $ref: '#/components/parameters/RequestIdHeader' responses: '202': $ref: '#/components/responses/Accepted' '400': $ref: '#/components/responses/BadRequest' '401': $ref: '#/components/responses/NotAuthenticated' '404': $ref: '#/components/responses/NotAuthorizedOrNotFound' '409': $ref: '#/components/responses/IncorrectState' '412': $ref: '#/components/responses/NoEtagMatch' '429': $ref: '#/components/responses/TooManyRequests' '500': $ref: '#/components/responses/InternalServerError' default: $ref: '#/components/responses/DefaultError' summary: Initiates cluster migration to use native VCN. tags: - containerEngine x-related-resource: '#/definitions/Cluster' requestBody: content: application/json: schema: $ref: '#/components/schemas/ClusterMigrateToNativeVcnDetails' description: The details for the cluster's migration to native VCN. required: true /clusters/{clusterId}/actions/rollbackPublicApiEndpointDecommission: post: description: "Rollback public api endpoint decommission for a cluster, legacy kubernetes endpoint will be brought back once the operation is completed. \nThe operation can only be performed within decommission rollback deadline.\n" operationId: RollbackPublicApiEndpointDecommission parameters: - $ref: '#/components/parameters/ClusterIdPathParam' - $ref: '#/components/parameters/IdempotencyTokenHeader' - $ref: '#/components/parameters/RequestIdHeader' - $ref: '#/components/parameters/IfMatchHeader' responses: '202': $ref: '#/components/responses/Accepted' '400': $ref: '#/components/responses/BadRequest' '401': $ref: '#/components/responses/NotAuthenticated' '404': $ref: '#/components/responses/NotAuthorizedOrNotFound' '409': $ref: '#/components/responses/IncorrectState' '412': $ref: '#/components/responses/NoEtagMatch' '429': $ref: '#/components/responses/TooManyRequests' '500': $ref: '#/components/responses/InternalServerError' default: $ref: '#/components/responses/DefaultError' summary: Rollback public api endpoint decommission for a cluster. tags: - containerEngine x-related-resource: '#/definitions/Cluster' /clusters/{clusterId}/actions/startCredentialRotation: post: description: Start cluster credential rotation by adding new credentials, old credentials will still work after this operation. operationId: StartCredentialRotation parameters: - $ref: '#/components/parameters/ClusterIdPathParam' - $ref: '#/components/parameters/IdempotencyTokenHeader' - $ref: '#/components/parameters/RequestIdHeader' - $ref: '#/components/parameters/IfMatchHeader' responses: '202': $ref: '#/components/responses/Accepted' '400': $ref: '#/components/responses/BadRequest' '401': $ref: '#/components/responses/NotAuthenticated' '404': $ref: '#/components/responses/NotAuthorizedOrNotFound' '409': $ref: '#/components/responses/IncorrectState' '412': $ref: '#/components/responses/NoEtagMatch' '429': $ref: '#/components/responses/TooManyRequests' '500': $ref: '#/components/responses/InternalServerError' default: $ref: '#/components/responses/DefaultError' summary: Start cluster credential rotation. tags: - containerEngine x-related-resource: '#/definitions/Cluster' requestBody: content: application/json: schema: $ref: '#/components/schemas/StartCredentialRotationDetails' description: The details for a kubernetes cluster to start credential rotation. required: true /clusters/{clusterId}/actions/startPublicApiEndpointDecommission: post: description: Start public api endpoint decommission for a cluster, legacy kubernetes endpoint will no longer available after this operation. operationId: StartPublicApiEndpointDecommission parameters: - $ref: '#/components/parameters/ClusterIdPathParam' - $ref: '#/components/parameters/IdempotencyTokenHeader' - $ref: '#/components/parameters/RequestIdHeader' - $ref: '#/components/parameters/IfMatchHeader' responses: '202': $ref: '#/components/responses/Accepted' '400': $ref: '#/components/responses/BadRequest' '401': $ref: '#/components/responses/NotAuthenticated' '404': $ref: '#/components/responses/NotAuthorizedOrNotFound' '409': $ref: '#/components/responses/IncorrectState' '412': $ref: '#/components/responses/NoEtagMatch' '429': $ref: '#/components/responses/TooManyRequests' '500': $ref: '#/components/responses/InternalServerError' default: $ref: '#/components/responses/DefaultError' summary: Start public api endpoint decommission for a cluster. tags: - containerEngine x-related-resource: '#/definitions/Cluster' /clusters/{clusterId}/actions/updateEndpointConfig: post: description: Update the details of the cluster endpoint configuration. operationId: UpdateClusterEndpointConfig parameters: - $ref: '#/components/parameters/ClusterIdPathParam' - $ref: '#/components/parameters/IfMatchHeader' - $ref: '#/components/parameters/RequestIdHeader' responses: '202': $ref: '#/components/responses/Accepted' '400': $ref: '#/components/responses/BadRequest' '401': $ref: '#/components/responses/NotAuthenticated' '404': $ref: '#/components/responses/NotAuthorizedOrNotFound' '409': $ref: '#/components/responses/IncorrectState' '412': $ref: '#/components/responses/NoEtagMatch' '429': $ref: '#/components/responses/TooManyRequests' '500': $ref: '#/components/responses/InternalServerError' default: $ref: '#/components/responses/DefaultError' summary: Update cluster endpoint details. tags: - containerEngine x-related-resource: '#/definitions/Cluster' requestBody: content: application/json: schema: $ref: '#/components/schemas/UpdateClusterEndpointConfigDetails' description: The details of the cluster's endpoint to update. required: true /clusters/{clusterId}/addons: get: description: List addon for a provisioned cluster. operationId: ListAddons parameters: - $ref: '#/components/parameters/ClusterIdPathParam' - $ref: '#/components/parameters/RequestIdHeader' - $ref: '#/components/parameters/PaginationLimitQueryParam' - $ref: '#/components/parameters/PaginationTokenQueryParam' - $ref: '#/components/parameters/SortOrderQueryParam' - description: The optional field to sort the results by. in: query name: sortBy required: false schema: type: string enum: - NAME - TIME_CREATED responses: '200': description: A list of addon summary objects. headers: opc-next-page: description: 'For list pagination. When this header appears in the response, additional pages of results remain. For important details about how pagination works, see [List Pagination](/iaas/Content/API/Concepts/usingapi.htm#nine). ' schema: type: string opc-request-id: description: 'Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. ' schema: type: string content: application/json: schema: items: $ref: '#/components/schemas/AddonSummary' type: array '401': $ref: '#/components/responses/NotAuthenticated' '404': $ref: '#/components/responses/NotAuthorizedOrNotFound' '429': $ref: '#/components/responses/TooManyRequests' '500': $ref: '#/components/responses/InternalServerError' default: $ref: '#/components/responses/DefaultError' summary: List addon for a cluster. tags: - containerEngine x-related-resource: '#/definitions/Cluster' post: description: Install the specified addon for a cluster. operationId: InstallAddon parameters: - $ref: '#/components/parameters/ClusterIdPathParam' - $ref: '#/components/parameters/IdempotencyTokenHeader' - $ref: '#/components/parameters/RequestIdHeader' - $ref: '#/components/parameters/IfMatchHeader' responses: '202': $ref: '#/components/responses/Accepted' '400': $ref: '#/components/responses/BadRequest' '401': $ref: '#/components/responses/NotAuthenticated' '404': $ref: '#/components/responses/NotAuthorizedOrNotFound' '409': $ref: '#/components/responses/IncorrectState' '412': $ref: '#/components/responses/NoEtagMatch' '429': $ref: '#/components/responses/TooManyRequests' '500': $ref: '#/components/responses/InternalServerError' default: $ref: '#/components/responses/DefaultError' summary: Install addon for a cluster. tags: - containerEngine x-related-resource: '#/definitions/Cluster' requestBody: content: application/json: schema: $ref: '#/components/schemas/InstallAddonDetails' description: The details of the addon to be installed. required: true /clusters/{clusterId}/addons/{addonName}: delete: description: Disable addon for a provisioned cluster. operationId: DisableAddon parameters: - $ref: '#/components/parameters/ClusterIdPathParam' - $ref: '#/components/parameters/AddonNamePathParam' - $ref: '#/components/parameters/IsRemoveExistingAddOnQueryParam' - $ref: '#/components/parameters/IfMatchHeader' - $ref: '#/components/parameters/RequestIdHeader' responses: '202': $ref: '#/components/responses/Accepted' '400': $ref: '#/components/responses/BadRequest' '401': $ref: '#/components/responses/NotAuthenticated' '404': $ref: '#/components/responses/NotAuthorizedOrNotFound' '409': $ref: '#/components/responses/IncorrectState' '412': $ref: '#/components/responses/NoEtagMatch' '429': $ref: '#/components/responses/TooManyRequests' '500': $ref: '#/components/responses/InternalServerError' default: $ref: '#/components/responses/DefaultError' summary: Disable addon for a cluster. tags: - containerEngine x-related-resource: '#/definitions/Cluster' get: description: Get the specified addon for a cluster. operationId: GetAddon parameters: - $ref: '#/components/parameters/ClusterIdPathParam' - $ref: '#/components/parameters/AddonNamePathParam' - $ref: '#/components/parameters/RequestIdHeader' responses: '200': description: Addon details. headers: etag: description: For optimistic concurrency control. See `if-match`. schema: type: string opc-request-id: description: 'Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. ' schema: type: string content: application/json: schema: $ref: '#/components/schemas/Addon' '401': $ref: '#/components/responses/NotAuthenticated' '404': $ref: '#/components/responses/NotAuthorizedOrNotFound' '429': $ref: '#/components/responses/TooManyRequests' '500': $ref: '#/components/responses/InternalServerError' default: $ref: '#/components/responses/DefaultError' summary: Get addon details. tags: - containerEngine x-related-resource: '#/definitions/Cluster' put: description: Update addon details for a cluster. operationId: UpdateAddon parameters: - $ref: '#/components/parameters/ClusterIdPathParam' - $ref: '#/components/parameters/IfMatchHeader' - $ref: '#/components/parameters/AddonNamePathParam' - $ref: '#/components/parameters/RequestIdHeader' responses: '202': $ref: '#/components/responses/Accepted' '400': $ref: '#/components/responses/BadRequest' '401': $ref: '#/components/responses/NotAuthenticated' '404': $ref: '#/components/responses/NotAuthorizedOrNotFound' '409': $ref: '#/components/responses/IncorrectState' '412': $ref: '#/components/responses/NoEtagMatch' '429': $ref: '#/components/responses/TooManyRequests' '500': $ref: '#/components/responses/InternalServerError' default: $ref: '#/components/responses/DefaultError' summary: Update addon details for a cluster. tags: - containerEngine x-related-resource: '#/definitions/Cluster' requestBody: content: application/json: schema: $ref: '#/components/schemas/UpdateAddonDetails' description: The details of the addon to be updated. required: true /clusters/{clusterId}/credentialRotationStatus: get: description: Get cluster credential rotation status. operationId: GetCredentialRotationStatus parameters: - $ref: '#/components/parameters/ClusterIdPathParam' - $ref: '#/components/parameters/RequestIdHeader' responses: '200': description: The cluster credential rotation status details. headers: etag: description: For optimistic concurrency control. See `if-match`. schema: type: string opc-request-id: description: 'Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. ' schema: type: string content: application/json: schema: $ref: '#/components/schemas/CredentialRotationStatus' '400': $ref: '#/components/responses/BadRequest' '401': $ref: '#/components/responses/NotAuthenticated' '404': $ref: '#/components/responses/NotAuthorizedOrNotFound' '429': $ref: '#/components/responses/TooManyRequests' '500': $ref: '#/components/responses/InternalServerError' default: $ref: '#/components/responses/DefaultError' summary: Get cluster credential rotation status. tags: - containerEngine /clusters/{clusterId}/kubeconfig/content: post: description: Create the Kubeconfig YAML for a cluster. operationId: CreateKubeconfig parameters: - $ref: '#/components/parameters/ClusterIdPathParam' - $ref: '#/components/parameters/RequestIdHeader' responses: '200': description: 'The output binary file is a standard KubeConfig file. External Reference Documentation, https://github.com/kubernetes/kubernetes/blob/release-1.1/docs/user-guide/kubeconfig-file.md ' headers: opc-request-id: description: 'Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. ' schema: type: string content: application/x-yaml: schema: format: binary type: string '400': $ref: '#/components/responses/BadRequest' '401': $ref: '#/components/responses/NotAuthenticated' '404': $ref: '#/components/responses/NotAuthorizedOrNotFound' '409': $ref: '#/components/responses/IncorrectState' '429': $ref: '#/components/responses/TooManyRequests' '500': $ref: '#/components/responses/InternalServerError' default: $ref: '#/components/responses/DefaultError' summary: Create the cluster kubeconfig. tags: - containerEngine x-related-resource: '#/definitions/Cluster' requestBody: content: application/json: schema: $ref: '#/components/schemas/CreateClusterKubeconfigContentDetails' description: The details of the cluster kubeconfig to create. /clusters/{clusterId}/migrateToNativeVcnStatus: get: description: Get details on a cluster's migration to native VCN. operationId: GetClusterMigrateToNativeVcnStatus parameters: - $ref: '#/components/parameters/ClusterIdPathParam' - $ref: '#/components/parameters/RequestIdHeader' responses: '200': description: The cluster's native vcn migration status details. headers: etag: description: For optimistic concurrency control. See `if-match`. schema: type: string opc-request-id: description: 'Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. ' schema: type: string content: application/json: schema: $ref: '#/components/schemas/ClusterMigrateToNativeVcnStatus' '401': $ref: '#/components/responses/NotAuthenticated' '404': $ref: '#/components/responses/NotAuthorizedOrNotFound' '429': $ref: '#/components/responses/TooManyRequests' '500': $ref: '#/components/responses/InternalServerError' default: $ref: '#/components/responses/DefaultError' summary: Get details on a cluster's migration to native VCN. tags: - containerEngine /clusters/{clusterId}/nodes/{nodeId}/actions/reboot: post: description: perform reboot action to node in cluster operationId: RebootClusterNode parameters: - $ref: '#/components/parameters/ClusterIdPathParam' - $ref: '#/components/parameters/NodeIdPathParam' - $ref: '#/components/parameters/RequestIdHeader' - $ref: '#/components/parameters/IdempotencyTokenHeader' responses: '202': $ref: '#/components/responses/Accepted' '400': $ref: '#/components/responses/BadRequest' '401': $ref: '#/components/responses/NotAuthenticated' '404': $ref: '#/components/responses/NotAuthorizedOrNotFound' '409': $ref: '#/components/responses/IncorrectState' '412': $ref: '#/components/responses/NoEtagMatch' '429': $ref: '#/components/responses/TooManyRequests' '500': $ref: '#/components/responses/InternalServerError' default: $ref: '#/components/responses/DefaultError' summary: perform reboot action to node in cluster tags: - containerEngine x-related-resource: '#/definitions/Cluster' requestBody: content: application/json: schema: $ref: '#/components/schemas/RebootClusterNodeDetails' description: The fields to reboot a node. required: true /clusters/{clusterId}/nodes/{nodeId}/actions/replaceBootVolume: post: description: perform cycle action to node in cluster operationId: ReplaceBootVolumeClusterNode parameters: - $ref: '#/components/parameters/ClusterIdPathParam' - $ref: '#/components/parameters/NodeIdPathParam' - $ref: '#/components/parameters/RequestIdHeader' - $ref: '#/components/parameters/IdempotencyTokenHeader' responses: '202': $ref: '#/components/responses/Accepted' '400': $ref: '#/components/responses/BadRequest' '401': $ref: '#/components/responses/NotAuthenticated' '404': $ref: '#/components/responses/NotAuthorizedOrNotFound' '409': $ref: '#/components/responses/IncorrectState' '412': $ref: '#/components/responses/NoEtagMatch' '429': $ref: '#/components/responses/TooManyRequests' '500': $ref: '#/components/responses/InternalServerError' default: $ref: '#/components/responses/DefaultError' summary: perform boot volume replacement action to node in cluster tags: - containerEngine x-related-resource: '#/definitions/Cluster' requestBody: content: application/json: schema: $ref: '#/components/schemas/ReplaceBootVolumeClusterNodeDetails' description: The fields to replace boot volume of a node. required: true /clusters/{clusterId}/publicApiEndpointDecommissionStatus: get: description: Get cluster public api endpoint decommission status. operationId: GetPublicApiEndpointDecommissionStatus parameters: - $ref: '#/components/parameters/ClusterIdPathParam' - $ref: '#/components/parameters/RequestIdHeader' responses: '200': description: The cluster's public api endpoint decommission status details. headers: etag: description: For optimistic concurrency control. See `if-match`. schema: type: string opc-request-id: description: 'Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. ' schema: type: string content: application/json: schema: $ref: '#/components/schemas/PublicApiEndpointDecommissionStatus' '400': $ref: '#/components/responses/BadRequest' '401': $ref: '#/components/responses/NotAuthenticated' '404': $ref: '#/components/responses/NotAuthorizedOrNotFound' '429': $ref: '#/components/responses/TooManyRequests' '500': $ref: '#/components/responses/InternalServerError' default: $ref: '#/components/responses/DefaultError' summary: Get cluster public api endpoint decommission status. tags: - containerEngine x-related-resource: '#/definitions/Cluster' /clusters/{clusterId}/workloadMappings: get: description: List workloadMappings for a provisioned cluster. operationId: ListWorkloadMappings parameters: - $ref: '#/components/parameters/ClusterIdPathParam' - $ref: '#/components/parameters/RequestIdHeader' - $ref: '#/components/parameters/PaginationLimitQueryParam' - $ref: '#/components/parameters/PaginationTokenQueryParam' - $ref: '#/components/parameters/SortOrderQueryParam' - description: The optional field to sort the results by. in: query name: sortBy required: false schema: type: string enum: - NAMESPACE - TIMECREATED default: NAMESPACE responses: '200': description: A list of workloadMapping summary objects. headers: opc-next-page: description: 'For list pagination. When this header appears in the response, additional pages of results remain. For important details about how pagination works, see [List Pagination](/iaas/Content/API/Concepts/usingapi.htm#nine). ' schema: type: string opc-request-id: description: 'Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. ' schema: type: string content: application/json: schema: items: $ref: '#/components/schemas/WorkloadMappingSummary' type: array '401': $ref: '#/components/responses/NotAuthenticated' '404': $ref: '#/components/responses/NotAuthorizedOrNotFound' '429': $ref: '#/components/responses/TooManyRequests' '500': $ref: '#/components/responses/InternalServerError' default: $ref: '#/components/responses/DefaultError' summary: List workloadMappings for a cluster. tags: - containerEngine x-related-resource: '#/definitions/WorkloadMapping' post: description: Create the specified workloadMapping for a cluster. operationId: CreateWorkloadMapping parameters: - $ref: '#/components/parameters/ClusterIdPathParam' - $ref: '#/components/parameters/IdempotencyTokenHeader' - $ref: '#/components/parameters/RequestIdHeader' responses: '200': description: WorkloadMapping Created. headers: etag: description: For optimistic concurrency control. See `if-match`. schema: type: string opc-request-id: description: 'Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. ' schema: type: string content: application/json: schema: $ref: '#/components/schemas/WorkloadMapping' '400': $ref: '#/components/responses/BadRequest' '401': $ref: '#/components/responses/NotAuthenticated' '404': $ref: '#/components/responses/NotAuthorizedOrNotFound' '409': $ref: '#/components/responses/IncorrectState' '412': $ref: '#/components/responses/NoEtagMatch' '429': $ref: '#/components/responses/TooManyRequests' '500': $ref: '#/components/responses/InternalServerError' default: $ref: '#/components/responses/DefaultError' summary: Create workloadMapping for a cluster. tags: - containerEngine x-related-resource: '#/definitions/WorkloadMapping' requestBody: content: application/json: schema: $ref: '#/components/schemas/CreateWorkloadMappingDetails' description: The details of the workloadMapping to be create. required: true /clusters/{clusterId}/workloadMappings/{workloadMappingId}: delete: description: Delete workloadMapping for a provisioned cluster. operationId: DeleteWorkloadMapping parameters: - $ref: '#/components/parameters/ClusterIdPathParam' - $ref: '#/components/parameters/WorkloadMappingIdPathParam' - $ref: '#/components/parameters/IfMatchHeader' - $ref: '#/components/parameters/RequestIdHeader' responses: '204': description: WorkloadMapping Deleted. headers: opc-request-id: description: 'Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. ' schema: type: string '400': $ref: '#/components/responses/BadRequest' '401': $ref: '#/components/responses/NotAuthenticated' '404': $ref: '#/components/responses/NotAuthorizedOrNotFound' '409': $ref: '#/components/responses/IncorrectState' '412': $ref: '#/components/responses/NoEtagMatch' '429': $ref: '#/components/responses/TooManyRequests' '500': $ref: '#/components/responses/InternalServerError' default: $ref: '#/components/responses/DefaultError' summary: Delete workloadMapping for a cluster. tags: - containerEngine x-related-resource: '#/definitions/WorkloadMapping' get: description: Get the specified workloadMapping for a cluster. operationId: GetWorkloadMapping parameters: - $ref: '#/components/parameters/ClusterIdPathParam' - $ref: '#/components/parameters/WorkloadMappingIdPathParam' - $ref: '#/components/parameters/RequestIdHeader' responses: '200': description: WorkloadMapping details. headers: etag: description: For optimistic concurrency control. See `if-match`. schema: type: string opc-request-id: description: 'Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. ' schema: type: string content: application/json: schema: $ref: '#/components/schemas/WorkloadMapping' '401': $ref: '#/components/responses/NotAuthenticated' '404': $ref: '#/components/responses/NotAuthorizedOrNotFound' '429': $ref: '#/components/responses/TooManyRequests' '500': $ref: '#/components/responses/InternalServerError' default: $ref: '#/components/responses/DefaultError' summary: Get workloadMapping details. tags: - containerEngine x-related-resource: '#/definitions/WorkloadMapping' put: description: Update workloadMapping details for a cluster. operationId: UpdateWorkloadMapping parameters: - $ref: '#/components/parameters/ClusterIdPathParam' - $ref: '#/components/parameters/IfMatchHeader' - $ref: '#/components/parameters/WorkloadMappingIdPathParam' - $ref: '#/components/parameters/RequestIdHeader' responses: '200': description: WorkloadMapping Updated. headers: etag: description: For optimistic concurrency control. See `if-match`. schema: type: string opc-request-id: description: 'Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. ' schema: type: string content: application/json: schema: $ref: '#/components/schemas/WorkloadMapping' '400': $ref: '#/components/responses/BadRequest' '401': $ref: '#/components/responses/NotAuthenticated' '404': $ref: '#/components/responses/NotAuthorizedOrNotFound' '409': $ref: '#/components/responses/IncorrectState' '412': $ref: '#/components/responses/NoEtagMatch' '429': $ref: '#/components/responses/TooManyRequests' '500': $ref: '#/components/responses/InternalServerError' default: $ref: '#/components/responses/DefaultError' summary: Update workloadMapping details for a cluster. tags: - containerEngine x-related-resource: '#/definitions/WorkloadMapping' requestBody: content: application/json: schema: $ref: '#/components/schemas/UpdateWorkloadMappingDetails' description: The details of the workloadMapping to be updated. required: true /nodePoolOptions/{nodePoolOptionId}: get: description: Get options available for node pools. operationId: GetNodePoolOptions parameters: - $ref: '#/components/parameters/NodePoolOptionIdPathParam' - $ref: '#/components/parameters/CompartmentIdOptionalQueryParam' - $ref: '#/components/parameters/ShouldListAllPatchVersionsQueryParam' - $ref: '#/components/parameters/NodePoolOsTypeQueryParam' - $ref: '#/components/parameters/NodePoolOsArchQueryParam' - $ref: '#/components/parameters/NodePoolK8sVersionQueryParam' - $ref: '#/components/parameters/RequestIdHeader' responses: '200': description: The node pool options. headers: opc-request-id: description: 'Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. ' schema: type: string content: application/json: schema: $ref: '#/components/schemas/NodePoolOptions' '401': $ref: '#/components/responses/NotAuthenticated' '404': $ref: '#/components/responses/NotAuthorizedOrNotFound' '429': $ref: '#/components/responses/TooManyRequests' '500': $ref: '#/components/responses/InternalServerError' default: $ref: '#/components/responses/DefaultError' summary: Get node pool options. tags: - containerEngine /nodePools: get: description: List all the node pools in a compartment, and optionally filter by cluster. operationId: ListNodePools parameters: - $ref: '#/components/parameters/CompartmentIdQueryParam' - $ref: '#/components/parameters/ClusterIdQueryParam' - $ref: '#/components/parameters/NameFilterQueryParam' - $ref: '#/components/parameters/PaginationLimitQueryParam' - $ref: '#/components/parameters/PaginationTokenQueryParam' - $ref: '#/components/parameters/SortOrderQueryParam' - description: The optional field to sort the results by. in: query name: sortBy required: false schema: type: string enum: - ID - NAME - TIME_CREATED - $ref: '#/components/parameters/RequestIdHeader' - $ref: '#/components/parameters/NodePoolLifecycleStateFilterQueryParam' responses: '200': description: A list of node pool summary objects. headers: opc-next-page: description: 'For list pagination. When this header appears in the response, additional pages of results remain. For important details about how pagination works, see [List Pagination](/iaas/Content/API/Concepts/usingapi.htm#nine). ' schema: type: string opc-request-id: description: 'Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. ' schema: type: string content: application/json: schema: items: $ref: '#/components/schemas/NodePoolSummary' type: array '401': $ref: '#/components/responses/NotAuthenticated' '404': $ref: '#/components/responses/NotAuthorizedOrNotFound' '429': $ref: '#/components/responses/TooManyRequests' '500': $ref: '#/components/responses/InternalServerError' default: $ref: '#/components/responses/DefaultError' summary: List all node pools. tags: - containerEngine post: description: Create a new node pool. operationId: CreateNodePool parameters: - $ref: '#/components/parameters/IdempotencyTokenHeader' - $ref: '#/components/parameters/RequestIdHeader' responses: '202': $ref: '#/components/responses/Accepted' '400': $ref: '#/components/responses/BadRequest' '401': $ref: '#/components/responses/NotAuthenticated' '404': $ref: '#/components/responses/NotAuthorizedOrNotFound' '409': $ref: '#/components/responses/IncorrectState' '429': $ref: '#/components/responses/TooManyRequests' '500': $ref: '#/components/responses/InternalServerError' default: $ref: '#/components/responses/DefaultError' summary: Create a new node pool. tags: - containerEngine x-related-resource: '#/definitions/NodePool' requestBody: content: application/json: schema: $ref: '#/components/schemas/CreateNodePoolDetails' description: The details of the node pool to create. required: true /nodePools/{nodePoolId}: delete: description: Delete a node pool. operationId: DeleteNodePool parameters: - $ref: '#/components/parameters/NodePoolIdPathParam' - $ref: '#/components/parameters/IfMatchHeader' - $ref: '#/components/parameters/RequestIdHeader' - $ref: '#/components/parameters/OverrideEvictionGraceDurationQueryParam' - $ref: '#/components/parameters/IsForceDeletionAfterOverrideGraceDurationQueryParam' responses: '202': $ref: '#/components/responses/Accepted' '401': $ref: '#/components/responses/NotAuthenticated' '404': $ref: '#/components/responses/NotAuthorizedOrNotFound' '409': $ref: '#/components/responses/IncorrectState' '412': $ref: '#/components/responses/NoEtagMatch' '429': $ref: '#/components/responses/TooManyRequests' '500': $ref: '#/components/responses/InternalServerError' default: $ref: '#/components/responses/DefaultError' summary: Delete a node pool. tags: - containerEngine x-related-resource: '#/definitions/NodePool' get: description: Get the details of a node pool. operationId: GetNodePool parameters: - $ref: '#/components/parameters/NodePoolIdPathParam' - $ref: '#/components/parameters/RequestIdHeader' responses: '200': description: The node pool. headers: etag: description: For optimistic concurrency control. See `if-match`. schema: type: string opc-request-id: description: 'Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. ' schema: type: string content: application/json: schema: $ref: '#/components/schemas/NodePool' '401': $ref: '#/components/responses/NotAuthenticated' '404': $ref: '#/components/responses/NotAuthorizedOrNotFound' '429': $ref: '#/components/responses/TooManyRequests' '500': $ref: '#/components/responses/InternalServerError' default: $ref: '#/components/responses/DefaultError' summary: Get node pool details. tags: - containerEngine put: description: Update the details of a node pool. operationId: UpdateNodePool parameters: - $ref: '#/components/parameters/NodePoolIdPathParam' - $ref: '#/components/parameters/IfMatchHeader' - $ref: '#/components/parameters/RequestIdHeader' - $ref: '#/components/parameters/OverrideEvictionGraceDurationQueryParam' - $ref: '#/components/parameters/IsForceDeletionAfterOverrideGraceDurationQueryParam' responses: '202': $ref: '#/components/responses/Accepted' '400': $ref: '#/components/responses/BadRequest' '401': $ref: '#/components/responses/NotAuthenticated' '404': $ref: '#/components/responses/NotAuthorizedOrNotFound' '409': $ref: '#/components/responses/IncorrectState' '412': $ref: '#/components/responses/NoEtagMatch' '429': $ref: '#/components/responses/TooManyRequests' '500': $ref: '#/components/responses/InternalServerError' default: $ref: '#/components/responses/DefaultError' summary: Update node pool details. tags: - containerEngine x-related-resource: '#/definitions/NodePool' requestBody: content: application/json: schema: $ref: '#/components/schemas/UpdateNodePoolDetails' description: The fields to update in a node pool. required: true /nodePools/{nodePoolId}/node/{nodeId}: delete: description: Delete node. operationId: DeleteNode parameters: - $ref: '#/components/parameters/NodePoolIdPathParam' - $ref: '#/components/parameters/NodeIdPathParam' - $ref: '#/components/parameters/IsDecrementSizeQueryParam' - $ref: '#/components/parameters/IfMatchHeader' - $ref: '#/components/parameters/RequestIdHeader' - $ref: '#/components/parameters/OverrideEvictionGraceDurationQueryParam' - $ref: '#/components/parameters/IsForceDeletionAfterOverrideGraceDurationQueryParam' responses: '202': $ref: '#/components/responses/Accepted' '400': $ref: '#/components/responses/BadRequest' '401': $ref: '#/components/responses/NotAuthenticated' '404': $ref: '#/components/responses/NotAuthorizedOrNotFound' '409': $ref: '#/components/responses/IncorrectState' '412': $ref: '#/components/responses/NoEtagMatch' '429': $ref: '#/components/responses/TooManyRequests' '500': $ref: '#/components/responses/InternalServerError' default: $ref: '#/components/responses/DefaultError' summary: Delete node. tags: - containerEngine x-related-resource: '#/definitions/NodePool' /podShapes: get: description: List all the Pod Shapes in a compartment. operationId: ListPodShapes parameters: - $ref: '#/components/parameters/RequestIdHeader' - $ref: '#/components/parameters/CompartmentIdQueryParam' - $ref: '#/components/parameters/AvailabilityDomainQueryParam' - $ref: '#/components/parameters/NameFilterQueryParam' - $ref: '#/components/parameters/VnpPaginationLimitQueryParam' - $ref: '#/components/parameters/PaginationTokenQueryParam' - $ref: '#/components/parameters/VnpSortOrderQueryParam' - $ref: '#/components/parameters/SortByQueryParam' responses: '200': description: A list of pod shape summary objects. headers: opc-next-page: description: 'For list pagination. When this header appears in the response, additional pages of results remain. For important details about how pagination works, see [List Pagination](/iaas/Content/API/Concepts/usingapi.htm#nine). ' schema: type: string opc-request-id: description: 'Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. ' schema: type: string content: application/json: schema: items: $ref: '#/components/schemas/PodShapeSummary' type: array '401': $ref: '#/components/responses/NotAuthenticated' '404': $ref: '#/components/responses/NotAuthorizedOrNotFound' '429': $ref: '#/components/responses/TooManyRequests' '500': $ref: '#/components/responses/InternalServerError' default: $ref: '#/components/responses/DefaultError' summary: List Pod Shapes. tags: - containerEngine /virtualNodePools: get: description: List all the virtual node pools in a compartment, and optionally filter by cluster. operationId: ListVirtualNodePools parameters: - $ref: '#/components/parameters/RequestIdHeader' - $ref: '#/components/parameters/CompartmentIdQueryParam' - $ref: '#/components/parameters/ClusterIdQueryParam' - $ref: '#/components/parameters/NameFilterQueryParam' - $ref: '#/components/parameters/VnpPaginationLimitQueryParam' - $ref: '#/components/parameters/PaginationTokenQueryParam' - $ref: '#/components/parameters/VnpSortOrderQueryParam' - $ref: '#/components/parameters/SortByQueryParam' - $ref: '#/components/parameters/VirtualNodePoolLifecycleStateFilterQueryParam' responses: '200': description: A list of virtual node pool summary objects. headers: opc-next-page: description: 'For list pagination. When this header appears in the response, additional pages of results remain. For important details about how pagination works, see [List Pagination](/iaas/Content/API/Concepts/usingapi.htm#nine). ' schema: type: string opc-request-id: description: 'Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. ' schema: type: string content: application/json: schema: items: $ref: '#/components/schemas/VirtualNodePoolSummary' type: array '401': $ref: '#/components/responses/NotAuthenticated' '404': $ref: '#/components/responses/NotAuthorizedOrNotFound' '429': $ref: '#/components/responses/TooManyRequests' '500': $ref: '#/components/responses/InternalServerError' default: $ref: '#/components/responses/DefaultError' summary: List all virtual node pools. tags: - containerEngine post: description: Create a new virtual node pool. operationId: CreateVirtualNodePool parameters: - $ref: '#/components/parameters/IdempotencyTokenHeader' - $ref: '#/components/parameters/RequestIdHeader' responses: '202': $ref: '#/components/responses/Accepted' '400': $ref: '#/components/responses/BadRequest' '401': $ref: '#/components/responses/NotAuthenticated' '404': $ref: '#/components/responses/NotAuthorizedOrNotFound' '409': $ref: '#/components/responses/IncorrectState' '429': $ref: '#/components/responses/TooManyRequests' '500': $ref: '#/components/responses/InternalServerError' default: $ref: '#/components/responses/DefaultError' summary: Create a new virtual node pool. tags: - containerEngine x-related-resource: '#/definitions/VirtualNodePool' requestBody: content: application/json: schema: $ref: '#/components/schemas/CreateVirtualNodePoolDetails' description: The details of the virtual node pool to create. required: true /virtualNodePools/{virtualNodePoolId}: delete: description: Delete a virtual node pool. operationId: DeleteVirtualNodePool parameters: - $ref: '#/components/parameters/VirtualNodePoolIdPathParam' - $ref: '#/components/parameters/IfMatchHeader' - $ref: '#/components/parameters/RequestIdHeader' - $ref: '#/components/parameters/OverrideEvictionGraceDurationVnpQueryParam' - $ref: '#/components/parameters/IsForceDeletionAfterOverrideGraceDurationVnpQueryParam' responses: '202': $ref: '#/components/responses/Accepted' '401': $ref: '#/components/responses/NotAuthenticated' '404': $ref: '#/components/responses/NotAuthorizedOrNotFound' '409': $ref: '#/components/responses/IncorrectState' '412': $ref: '#/components/responses/NoEtagMatch' '429': $ref: '#/components/responses/TooManyRequests' '500': $ref: '#/components/responses/InternalServerError' default: $ref: '#/components/responses/DefaultError' summary: Delete a virtual node pool. tags: - containerEngine x-related-resource: '#/definitions/VirtualNodePool' get: description: Get the details of a virtual node pool. operationId: GetVirtualNodePool parameters: - $ref: '#/components/parameters/VirtualNodePoolIdPathParam' - $ref: '#/components/parameters/RequestIdHeader' responses: '200': description: The virtual node pool. headers: etag: description: For optimistic concurrency control. See `if-match`. schema: type: string opc-request-id: description: 'Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. ' schema: type: string content: application/json: schema: $ref: '#/components/schemas/VirtualNodePool' '401': $ref: '#/components/responses/NotAuthenticated' '404': $ref: '#/components/responses/NotAuthorizedOrNotFound' '429': $ref: '#/components/responses/TooManyRequests' '500': $ref: '#/components/responses/InternalServerError' default: $ref: '#/components/responses/DefaultError' summary: Get virtual node pool details. tags: - containerEngine put: description: Update the details of a virtual node pool. operationId: UpdateVirtualNodePool parameters: - $ref: '#/components/parameters/VirtualNodePoolIdPathParam' - $ref: '#/components/parameters/IfMatchHeader' - $ref: '#/components/parameters/RequestIdHeader' responses: '202': $ref: '#/components/responses/Accepted' '400': $ref: '#/components/responses/BadRequest' '401': $ref: '#/components/responses/NotAuthenticated' '404': $ref: '#/components/responses/NotAuthorizedOrNotFound' '409': $ref: '#/components/responses/IncorrectState' '412': $ref: '#/components/responses/NoEtagMatch' '429': $ref: '#/components/responses/TooManyRequests' '500': $ref: '#/components/responses/InternalServerError' default: $ref: '#/components/responses/DefaultError' summary: Update virtual node pool details. tags: - containerEngine x-related-resource: '#/definitions/VirtualNodePool' requestBody: content: application/json: schema: $ref: '#/components/schemas/UpdateVirtualNodePoolDetails' description: The fields to update in a virtual node pool. required: true /virtualNodePools/{virtualNodePoolId}/virtualNodes: get: description: List virtual nodes in a virtual node pool. operationId: ListVirtualNodes parameters: - $ref: '#/components/parameters/VirtualNodePoolIdPathParam' - $ref: '#/components/parameters/RequestIdHeader' - $ref: '#/components/parameters/NameFilterQueryParam' - $ref: '#/components/parameters/VnpPaginationLimitQueryParam' - $ref: '#/components/parameters/PaginationTokenQueryParam' - $ref: '#/components/parameters/VnpSortOrderQueryParam' - $ref: '#/components/parameters/SortByQueryParam' responses: '200': description: A list of virtual node summary in virtual node pool. headers: opc-next-page: description: 'For list pagination. When this header appears in the response, additional pages of results remain. For important details about how pagination works, see [List Pagination](/iaas/Content/API/Concepts/usingapi.htm#nine). ' schema: type: string opc-request-id: description: 'Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. ' schema: type: string content: application/json: schema: items: $ref: '#/components/schemas/VirtualNodeSummary' type: array '401': $ref: '#/components/responses/NotAuthenticated' '404': $ref: '#/components/responses/NotAuthorizedOrNotFound' '429': $ref: '#/components/responses/TooManyRequests' '500': $ref: '#/components/responses/InternalServerError' default: $ref: '#/components/responses/DefaultError' summary: List virtual nodes in a virtual node pool. tags: - containerEngine x-related-resource: '#/definitions/VirtualNodePool' /virtualNodePools/{virtualNodePoolId}/virtualNodes/{virtualNodeId}: get: description: Get the details of a virtual node. operationId: GetVirtualNode parameters: - $ref: '#/components/parameters/VirtualNodePoolIdPathParam' - $ref: '#/components/parameters/VirtualNodeIdPathParam' - $ref: '#/components/parameters/RequestIdHeader' responses: '200': description: The virtual node. headers: etag: description: For optimistic concurrency control. See `if-match`. schema: type: string opc-request-id: description: 'Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. ' schema: type: string content: application/json: schema: $ref: '#/components/schemas/VirtualNode' '401': $ref: '#/components/responses/NotAuthenticated' '404': $ref: '#/components/responses/NotAuthorizedOrNotFound' '429': $ref: '#/components/responses/TooManyRequests' '500': $ref: '#/components/responses/InternalServerError' default: $ref: '#/components/responses/DefaultError' summary: Get virtual node details. tags: - containerEngine x-related-resource: '#/definitions/VirtualNodePool' /workRequests: get: description: List all work requests in a compartment. operationId: ListWorkRequests parameters: - $ref: '#/components/parameters/CompartmentIdQueryParam' - $ref: '#/components/parameters/ClusterIdQueryParam' - $ref: '#/components/parameters/ResourceIdQueryParam' - $ref: '#/components/parameters/ResourceTypeQueryParam' - $ref: '#/components/parameters/WorkRequestStatusFilterQueryParam' - $ref: '#/components/parameters/PaginationLimitQueryParam' - $ref: '#/components/parameters/PaginationTokenQueryParam' - $ref: '#/components/parameters/SortOrderQueryParam' - description: The optional field to sort the results by. in: query name: sortBy required: false schema: type: string enum: - ID - OPERATION_TYPE - STATUS - TIME_ACCEPTED - TIME_STARTED - TIME_FINISHED - $ref: '#/components/parameters/RequestIdHeader' responses: '200': description: The list of work request summary objects. headers: opc-next-page: description: 'For list pagination. When this header appears in the response, additional pages of results remain. For important details about how pagination works, see [List Pagination](/iaas/Content/API/Concepts/usingapi.htm#nine). ' schema: type: string opc-request-id: description: 'Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. ' schema: type: string content: application/json: schema: items: $ref: '#/components/schemas/WorkRequestSummary' type: array '400': $ref: '#/components/responses/BadRequest' '401': $ref: '#/components/responses/NotAuthenticated' '404': $ref: '#/components/responses/NotAuthorizedOrNotFound' '429': $ref: '#/components/responses/TooManyRequests' '500': $ref: '#/components/responses/InternalServerError' default: $ref: '#/components/responses/DefaultError' summary: List all work requests. tags: - containerEngine /workRequests/{workRequestId}: delete: description: Cancel a work request that has not started. operationId: DeleteWorkRequest parameters: - $ref: '#/components/parameters/WorkRequestIdPathParam' - $ref: '#/components/parameters/IfMatchHeader' - $ref: '#/components/parameters/RequestIdHeader' responses: '204': description: No content. headers: opc-request-id: description: 'Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. ' schema: type: string '401': $ref: '#/components/responses/NotAuthenticated' '404': $ref: '#/components/responses/NotAuthorizedOrNotFound' '409': $ref: '#/components/responses/IncorrectState' '412': $ref: '#/components/responses/NoEtagMatch' '429': $ref: '#/components/responses/TooManyRequests' '500': $ref: '#/components/responses/InternalServerError' default: $ref: '#/components/responses/DefaultError' summary: Cancel a work request. tags: - containerEngine x-related-resource: '#/definitions/WorkRequest' get: description: Get the details of a work request. operationId: GetWorkRequest parameters: - $ref: '#/components/parameters/WorkRequestIdPathParam' - $ref: '#/components/parameters/RequestIdHeader' responses: '200': description: The work request. headers: etag: description: For optimistic concurrency control. See `if-match`. schema: type: string opc-request-id: description: 'Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. ' schema: type: string retry-after: description: the number of seconds to should wait before polling this endpoint again schema: type: integer content: application/json: schema: $ref: '#/components/schemas/WorkRequest' '401': $ref: '#/components/responses/NotAuthenticated' '404': $ref: '#/components/responses/NotAuthorizedOrNotFound' '429': $ref: '#/components/responses/TooManyRequests' '500': $ref: '#/components/responses/InternalServerError' default: $ref: '#/components/responses/DefaultError' summary: Get work request details. tags: - containerEngine /workRequests/{workRequestId}/errors: get: description: Get the errors of a work request. operationId: ListWorkRequestErrors parameters: - $ref: '#/components/parameters/CompartmentIdQueryParam' - $ref: '#/components/parameters/WorkRequestIdPathParam' - $ref: '#/components/parameters/RequestIdHeader' responses: '200': description: The list of errors for the work request. headers: opc-request-id: description: 'Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. ' schema: type: string content: application/json: schema: items: $ref: '#/components/schemas/WorkRequestError' type: array '401': $ref: '#/components/responses/NotAuthenticated' '404': $ref: '#/components/responses/NotAuthorizedOrNotFound' '429': $ref: '#/components/responses/TooManyRequests' '500': $ref: '#/components/responses/InternalServerError' default: $ref: '#/components/responses/DefaultError' summary: Get work request errors. tags: - containerEngine /workRequests/{workRequestId}/logs: get: description: Get the logs of a work request. operationId: ListWorkRequestLogs parameters: - $ref: '#/components/parameters/CompartmentIdQueryParam' - $ref: '#/components/parameters/WorkRequestIdPathParam' - $ref: '#/components/parameters/RequestIdHeader' responses: '200': description: The list of logs for the work request. headers: opc-request-id: description: 'Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. ' schema: type: string content: application/json: schema: items: $ref: '#/components/schemas/WorkRequestLogEntry' type: array '401': $ref: '#/components/responses/NotAuthenticated' '404': $ref: '#/components/responses/NotAuthorizedOrNotFound' '429': $ref: '#/components/responses/TooManyRequests' '500': $ref: '#/components/responses/InternalServerError' default: $ref: '#/components/responses/DefaultError' summary: Get work request logs. tags: - containerEngine components: parameters: AvailabilityDomainQueryParam: description: The availability domain of the pod shape. in: query name: availabilityDomain required: false schema: type: string NodePoolK8sVersionQueryParam: description: Filter node pool options by Kubernetes version. in: query name: nodePoolK8sVersion required: false x-default-description: options for all K8s versions schema: type: string VirtualNodeIdPathParam: description: The OCID of the virtual node. in: path name: virtualNodeId required: true schema: type: string KubernetesVersionQueryParam: description: The kubernetes version to fetch the addons. in: query name: kubernetesVersion required: true schema: type: string IfMatchHeader: description: 'For optimistic concurrency control. In the PUT or DELETE call for a resource, set the `if-match` parameter to the value of the etag from a previous GET or POST response for that resource. The resource will be updated or deleted only if the etag you provide matches the resource''s current etag value. ' in: header name: if-match schema: type: string AddonNameQueryParam: description: The name of the addon. in: query name: addonName required: false schema: type: string SortOrderQueryParam: description: The optional order in which to sort the results. in: query name: sortOrder required: false x-default-description: 'The default value depends upon `sortBy`, and in general is ''DESC'' when sorting by time and ''ASC'' otherwise. ' x-obmcs-top-level-enum: '#/definitions/SortOrder' schema: type: string enum: - ASC - DESC WorkRequestStatusFilterQueryParam: description: A work request status to filter on. Can have multiple parameters of this name. in: query name: status required: false style: form explode: true schema: type: array items: type: string AddonNamePathParam: description: The name of the addon. in: path name: addonName required: true schema: type: string VirtualNodePoolIdPathParam: description: The OCID of the virtual node pool. in: path name: virtualNodePoolId required: true schema: type: string ClusterLifecycleStateFilterQueryParam: description: A cluster lifecycle state to filter on. Can have multiple parameters of this name. For more information, see [Monitoring Clusters](/Content/ContEng/Tasks/contengmonitoringclusters.htm) in: query name: lifecycleState required: false style: form explode: true schema: type: array items: enum: - CREATING - ACTIVE - FAILED - DELETING - DELETED - UPDATING type: string x-obmcs-top-level-enum: '#/definitions/ClusterLifecycleState' RequestIdHeader: description: 'Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. ' in: header name: opc-request-id schema: type: string CompartmentIdOptionalQueryParam: description: The OCID of the compartment. in: query name: compartmentId required: false x-default-description: 'null' schema: type: string NodePoolLifecycleStateFilterQueryParam: description: A list of nodepool lifecycle states on which to filter on, matching any of the list items (OR logic). eg. [ACTIVE, DELETING]. For more information, see [Monitoring Clusters](/Content/ContEng/Tasks/contengmonitoringclusters.htm) in: query name: lifecycleState required: false style: form explode: true schema: type: array items: enum: - DELETED - CREATING - ACTIVE - UPDATING - DELETING - FAILED - INACTIVE - NEEDS_ATTENTION type: string x-obmcs-top-level-enum: '#/definitions/NodePoolLifecycleState' SortByQueryParam: description: The optional field to sort the results by. in: query name: sortBy required: false schema: type: string enum: - ID - NAME - TIME_CREATED default: NAME IsForceDeletionAfterOverrideGraceDurationVnpQueryParam: description: If the underlying virtual node should be force deleted if all the pods are not evicted in the evictionGraceDuration. in: query name: isForceDeletionAfterOverrideGraceDurationVnp required: false x-default-description: 'null' schema: type: boolean IsDecrementSizeQueryParam: description: If the nodepool should be scaled down after the node is deleted. in: query name: isDecrementSize required: false schema: type: boolean default: true NodePoolOsTypeQueryParam: description: Filter node pool options by OS type. in: query name: nodePoolOsType required: false x-default-description: options for all OS type schema: type: string enum: - OL7 - OL8 - UBUNTU IdempotencyTokenHeader: description: 'A token you supply to uniquely identify the request and provide idempotency if the request is retried. Idempotency tokens expire after 24 hours. ' in: header name: opc-retry-token schema: type: string maxLength: 64 minLength: 1 VirtualNodePoolLifecycleStateFilterQueryParam: description: A virtual node pool lifecycle state to filter on. Can have multiple parameters of this name. in: query name: lifecycleState required: false style: form explode: true schema: type: array items: enum: - CREATING - ACTIVE - UPDATING - DELETING - DELETED - FAILED - NEEDS_ATTENTION type: string x-obmcs-top-level-enum: '#/definitions/VirtualNodePoolLifecycleState' WorkRequestIdPathParam: description: The OCID of the work request. in: path name: workRequestId required: true schema: type: string OverrideEvictionGraceDurationQueryParam: description: 'Duration after which OKE will give up eviction of the pods on the node. PT0M will indicate you want to delete the node without cordon and drain. Default PT60M, Min PT0M, Max: PT60M. Format ISO 8601 e.g PT30M ' in: query name: overrideEvictionGraceDuration required: false x-default-description: PT60M schema: type: string format: x-obmcs-duration VnpSortOrderQueryParam: description: The optional order in which to sort the results. in: query name: sortOrder required: false x-obmcs-top-level-enum: '#/definitions/SortOrder' schema: type: string enum: - ASC - DESC default: ASC NodeIdPathParam: description: The OCID of the compute instance. in: path name: nodeId required: true schema: type: string ClusterIdPathParam: description: The OCID of the cluster. in: path name: clusterId required: true schema: type: string PaginationTokenQueryParam: description: 'For list pagination. The value of the `opc-next-page` response header from the previous "List" call. For important details about how pagination works, see [List Pagination](/iaas/Content/API/Concepts/usingapi.htm#nine). ' in: query name: page schema: type: string IsOpenIdConnectAuthConfigFileIncludedQueryParam: description: 'Boolean value to determine if the OpenIdConnectAuth configuration file should be displayed for the provided cluster. ' in: query name: shouldIncludeOidcConfigFile required: false x-default-description: 'null' schema: type: boolean OverrideEvictionGraceDurationVnpQueryParam: description: 'Duration after which SKE will give up eviction of the pods on the node. PT0M will indicate you want to delete the virtual node without cordon and drain. Default PT60M, Min PT0M, Max: PT60M. Format ISO 8601 e.g PT30M ' in: query name: overrideEvictionGraceDurationVnp required: false x-default-description: PT60M schema: type: string format: x-obmcs-duration ClusterIdQueryParam: description: The OCID of the cluster. in: query name: clusterId schema: type: string ShouldListAllPatchVersionsQueryParam: description: Option to show all kubernetes patch versions in: query name: shouldListAllPatchVersions required: false schema: type: boolean default: true NodePoolIdPathParam: description: The OCID of the node pool. in: path name: nodePoolId required: true schema: type: string IsRemoveExistingAddOnQueryParam: description: Whether existing addon resources should be deleted or not. True would remove the underlying resources completely. in: query name: isRemoveExistingAddOn required: true schema: type: boolean ResourceTypeQueryParam: description: Type of the resource associated with a work request in: query name: resourceType schema: type: string enum: - CLUSTER - NODEPOOL IsForceDeletionAfterOverrideGraceDurationQueryParam: description: If the underlying compute instance should be deleted if you cannot evict all the pods in grace period in: query name: isForceDeletionAfterOverrideGraceDuration required: false x-default-description: 'null' schema: type: boolean CompartmentIdQueryParam: description: The OCID of the compartment. in: query name: compartmentId required: true schema: type: string ClusterOptionIdPathParam: description: The id of the option set to retrieve. Use "all" get all options, or use a cluster ID to get options specific to the provided cluster. in: path name: clusterOptionId required: true schema: type: string PaginationLimitQueryParam: description: 'For list pagination. The maximum number of results per page, or items to return in a paginated "List" call. 1 is the minimum, 1000 is the maximum. For important details about how pagination works, see [List Pagination](/iaas/Content/API/Concepts/usingapi.htm#nine). ' in: query name: limit schema: type: integer default: 100 maximum: 1000 minimum: 1 NameFilterQueryParam: description: The name to filter on. in: query name: name schema: type: string WorkloadMappingIdPathParam: description: The OCID of the workloadMapping. in: path name: workloadMappingId required: true schema: type: string ResourceIdQueryParam: description: The OCID of the resource associated with a work request in: query name: resourceId schema: type: string NodePoolOptionIdPathParam: description: The id of the option set to retrieve. Use "all" get all options, or use a cluster ID to get options specific to the provided cluster. in: path name: nodePoolOptionId required: true schema: type: string VnpPaginationLimitQueryParam: description: 'For list pagination. The maximum number of results per page, or items to return in a paginated "List" call. 1 is the minimum, 1000 is the maximum. For important details about how pagination works, see [List Pagination](/iaas/Content/API/Concepts/usingapi.htm#nine). ' in: query name: limit schema: type: integer default: 100 maximum: 1000 minimum: 1 NodePoolOsArchQueryParam: description: Filter node pool options by OS architecture. in: query name: nodePoolOsArch required: false x-default-description: options for all OS architectures schema: type: string enum: - X86_64 - AARCH64 schemas: AddonConfiguration: description: Defines the configuration of available addons for a cluster properties: key: description: configuration key name example: foo maxLength: 255 minLength: 1 type: string value: description: configuration value name example: bar maxLength: 8191 minLength: 1 type: string type: object NodePoolSummary: description: The properties that define a node pool summary. properties: clusterId: description: The OCID of the cluster to which this node pool is attached. example: ocid1.cluster.oc1.iad.aaaaaaaaga3tombrmq3wgyrvmi3gcn3bmfsdizjwgy4wgyldmy3dcmtcmmyw type: string compartmentId: description: The OCID of the compartment in which the node pool exists. example: ocid1.compartment.oc1..aaaaaaaafqm2df7ckwmmbtdsl2bgxsw4fcpvkoojytxrqst24yww2tdmtqcq type: string definedTags: additionalProperties: additionalProperties: description: 'The value of the tag. Only the String type is supported. ' type: object description: 'Key-value pair representing a defined tag key and value, scoped to a namespace. Example: `{"CostCenter": "42"}` ' type: object description: 'Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see [Resource Tags](/Content/General/Concepts/resourcetags.htm). Example: `{"Operations": {"CostCenter": "42"}}` ' example: Operations: CostCenter: 42 type: object freeformTags: additionalProperties: type: string description: 'Free-form tags for this resource. Each tag is a simple key-value pair with no predefined name, type, or namespace. For more information, see [Resource Tags](/Content/General/Concepts/resourcetags.htm). Example: `{"Department": "Finance"}` ' example: Department: Finance type: object id: description: The OCID of the node pool. example: ocid1.nodepool.oc1.iad.aaaaaaaanifpelnyzmkvnepohbz4ntswkpl35syzzsugdxceth3oihe8hcfq type: string initialNodeLabels: description: A list of key/value pairs to add to nodes after they join the Kubernetes cluster. items: $ref: '#/components/schemas/KeyValue' type: array kubernetesVersion: description: The version of Kubernetes running on the nodes in the node pool. example: v1.9.4 type: string lifecycleDetails: description: Details about the state of the nodepool. type: string lifecycleState: description: The state of the nodepool. For more information, see [Monitoring Clusters](/Content/ContEng/Tasks/contengmonitoringclusters.htm) enum: - DELETED - CREATING - ACTIVE - UPDATING - DELETING - FAILED - INACTIVE - NEEDS_ATTENTION example: ACTIVE type: string x-obmcs-top-level-enum: '#/definitions/NodePoolLifecycleState' name: description: The name of the node pool. example: My Node Pool type: string networkLaunchType: description: Emulation type for the physical network interface card (NIC) for nodes enum: - VFIO - E1000 - PARAVIRTUALIZED type: string x-obmcs-top-level-enum: '#/definitions/NetworkLaunchType' nodeConfigDetails: $ref: '#/components/schemas/NodePoolNodeConfigDetails' description: The configuration of nodes in the node pool. nodeEvictionNodePoolSettings: $ref: '#/components/schemas/NodeEvictionNodePoolSettings' nodeImageId: description: 'Deprecated. see `nodeSource`. The OCID of the image running on the nodes in the node pool. ' example: ocid1.image.oc1.phx.aaaaaaaanclh465xnfvajjojj5bbjzqytunslgvnyvf3fepiiltalnglekoa type: string nodeImageName: description: 'Deprecated. see `nodeSource`. The name of the image running on the nodes in the node pool. ' example: Oracle-Linux-7.4 type: string nodePoolCyclingDetails: $ref: '#/components/schemas/NodePoolCyclingDetails' nodeShape: description: The name of the node shape of the nodes in the node pool. example: VM.Standard2.4 type: string nodeShapeConfig: $ref: '#/components/schemas/NodeShapeConfig' description: The shape configuration of the nodes. nodeSource: $ref: '#/components/schemas/NodeSourceOption' description: Deprecated. see `nodeSourceDetails`. Source running on the nodes in the node pool. type: object nodeSourceDetails: $ref: '#/components/schemas/NodeSourceDetails' description: Source running on the nodes in the node pool. type: object primaryVnic: $ref: '#/components/schemas/NodePoolPrimaryVnicDetails' quantityPerSubnet: description: The number of nodes in each subnet. example: 1 format: int32 type: integer secondaryVnics: description: A list of secondary vnics to attach to nodes items: $ref: '#/components/schemas/NodePoolSecondaryVnicDetails' maxItems: 64 type: array sshPublicKey: description: The SSH public key on each node in the node pool on launch. example: ssh-rsa AAAAB3NzaC1yc2abc123... type: string subnetIds: description: The OCIDs of the subnets in which to place nodes for this node pool. items: type: string type: array systemTags: additionalProperties: additionalProperties: description: 'The value of the tag. Only string, integer and boolean types are supported. ' type: object description: 'Key-value pair representing system tags'' keys and values scoped to a namespace. Example: `{"bar-key": "value"}` ' type: object description: 'Usage of system tag keys. These predefined keys are scoped to namespaces. Example: `{"orcl-cloud": {"free-tier-retained": "true"}}` ' type: object type: object Error: description: The properties that define an error. properties: code: description: A short error code that defines the error, meant for programmatic parsing. See [API Errors](https://docs.us-phoenix-1.oraclecloud.com/Content/API/References/apierrors.htm). example: UnknownError type: string message: description: A human-readable error string. example: error validating payload type: string required: - code - message type: object ClusterMigrateToNativeVcnStatus: description: Information regarding a cluster's move to Native VCN. properties: state: description: The current migration status of the cluster. enum: - NOT_STARTED - REQUESTED - IN_PROGRESS - PENDING_DECOMMISSION - COMPLETED example: IN_PROGRESS type: string timeDecommissionScheduled: description: The date and time the non-native VCN is due to be decommissioned. example: '2017-07-21T16:11:29Z' format: date-time type: string required: - state type: object Taint: description: taints properties: effect: description: The effect of the pair. example: myeffect type: string key: description: The key of the pair. example: mykey type: string value: description: The value of the pair. example: myvalue type: string type: object CreateNodePoolNodeConfigDetails: description: The size and placement configuration of nodes in the node pool. properties: computeClusterId: description: The OCID of the Compute Cluster to be associated with the worker node instance. maxLength: 255 minLength: 1 type: string definedTags: additionalProperties: additionalProperties: description: 'The value of the tag. Only the String type is supported. ' type: object description: 'Key-value pair representing a defined tag key and value, scoped to a namespace. Example: `{"CostCenter": "42"}` ' type: object description: 'Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see [Resource Tags](/Content/General/Concepts/resourcetags.htm). Example: `{"Operations": {"CostCenter": "42"}}` ' example: Operations: CostCenter: 42 type: object freeformTags: additionalProperties: type: string description: 'Free-form tags for this resource. Each tag is a simple key-value pair with no predefined name, type, or namespace. For more information, see [Resource Tags](/Content/General/Concepts/resourcetags.htm). Example: `{"Department": "Finance"}` ' example: Department: Finance type: object isPvEncryptionInTransitEnabled: default: false description: Whether to enable in-transit encryption for the data volume's paravirtualized attachment. This field applies to both block volumes and boot volumes. The default value is false. type: boolean kmsKeyId: description: The OCID of the Key Management Service key assigned to the boot volume. type: string nodePoolPodNetworkOptionDetails: $ref: '#/components/schemas/NodePoolPodNetworkOptionDetails' description: 'The CNI related configuration of pods in the node pool. ' nsgIds: description: 'The OCIDs of the Network Security Group(s) to associate nodes for this node pool with. For more information about NSGs, see [NetworkSecurityGroup](#/en/iaas/20160918/NetworkSecurityGroup/). ' items: maxLength: 255 minLength: 1 type: string maxItems: 5 type: array uniqueItems: true placementConfigs: description: 'The placement configurations for the node pool. Provide one placement configuration for each availability domain in which you intend to launch a node. To use the node pool with a regional subnet, provide a placement configuration for each availability domain, and include the regional subnet in each placement configuration. ' items: $ref: '#/components/schemas/NodePoolPlacementConfigDetails' type: array size: description: 'The number of nodes that should be in the node pool. ' format: int32 type: integer required: - size - placementConfigs type: object WorkloadMappingSummary: description: The properties that define an workloadMapping summary. properties: clusterId: description: The OCID of the cluster. example: ocid1.cluster.oc1.iad.aaaaaaaaga3tombrmq3wgyrvmi3gcn3bmfsdizjwgy4wgyldmy3dcmtcmmyw type: string definedTags: additionalProperties: additionalProperties: description: 'The value of the tag. Only the String type is supported. ' type: object description: 'Key-value pair representing a defined tag key and value, scoped to a namespace. Example: `{"CostCenter": "42"}` ' type: object description: 'Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see [Resource Tags](/Content/General/Concepts/resourcetags.htm). Example: `{"Operations": {"CostCenter": "42"}}` ' example: Operations: CostCenter: 42 type: object freeformTags: additionalProperties: type: string description: 'Free-form tags for this resource. Each tag is a simple key-value pair with no predefined name, type, or namespace. For more information, see [Resource Tags](/Content/General/Concepts/resourcetags.htm). Example: `{"Department": "Finance"}` ' example: Department: Finance type: object id: description: The ocid of the workloadMapping. example: ocid1.workloadmapping.ocX.us-ashburn-1.xtrdsa56sjasa72321 type: string lifecycleState: description: The state of the workloadMapping. enum: - CREATING - ACTIVE - FAILED - DELETING - DELETED - UPDATING example: UPDATING type: string x-obmcs-top-level-enum: '#/definitions/WorkloadMappingLifecycleState' mappedCompartmentId: description: The OCID of the mapped customer compartment. example: ocid1.compartment.oc1..aaaaaaaafqm2df7ckwmmbtdsl2bgxsw4fcpvkoojytxrqst24yww2tdmtqcq type: string mappedTenancyId: description: The OCID of the mapped customer tenancy. example: ocid1.tenancy.oc1..aaaaaaaafqm2df7ckwmmbtdsl2bgxsw4fcpvkoojytxrqst24yww2tdmtqcq type: string namespace: description: The namespace of the workloadMapping. example: kube-proxy type: string systemTags: additionalProperties: additionalProperties: description: 'The value of the tag. Only string, integer and boolean types are supported. ' type: object description: 'Key-value pair representing system tags'' keys and values scoped to a namespace. Example: `{"bar-key": "value"}` ' type: object description: 'Usage of system tag keys. These predefined keys are scoped to namespaces. Example: `{"orcl-cloud": {"free-tier-retained": "true"}}` ' type: object timeCreated: description: The time the cluster was created. example: '2017-07-21T16:11:29Z' format: date-time type: string required: - id - clusterId - namespace - mappedTenancyId - mappedCompartmentId - timeCreated - lifecycleState type: object PodShapeSummary: description: Pod shape. properties: memoryOptions: description: ShapeMemoryOptions. items: $ref: '#/components/schemas/ShapeMemoryOptions' type: array name: description: The name of the identifying shape. maxLength: 255 minLength: 1 type: string networkBandwidthOptions: description: ShapeNetworkBandwidthOptions. items: $ref: '#/components/schemas/ShapeNetworkBandwidthOptions' type: array ocpuOptions: description: Options for OCPU shape. items: $ref: '#/components/schemas/ShapeOcpuOptions' type: array processorDescription: description: A short description of the VM's processor (CPU). type: string required: - name type: object ImagePolicyConfig: description: The properties that define a image verification policy. properties: isPolicyEnabled: default: false description: Whether the image verification policy is enabled. Defaults to false. If set to true, the images will be verified against the policy at runtime. type: boolean keyDetails: description: A list of KMS key details. items: $ref: '#/components/schemas/KeyDetails' type: array type: object PublicApiEndpointDecommissionStatus: description: Information regarding a cluster's public api endpoint decommission. properties: status: description: The current public api endpoint decommission status of the cluster. enum: - PENDING - IN_PROGRESS - ROLLING_BACK - DECOMMISSIONED - FINALIZED - DECOMMISSION_FAILED - ROLLBACK_FAILED example: IN_PROGRESS type: string timeDecommissionRollbackDeadline: description: "The date and time of rollback deadline for public api endpoint decommission. \nOnce the date is passed, rollback is not able to be launched.\n" example: '2025-07-21T16:11:29Z' format: date-time type: string required: - timeDecommissionRollbackDeadline - status type: object WorkRequestSummary: description: The properties that define a work request summary. properties: compartmentId: description: The OCID of the compartment in which the work request exists. example: ocid1.compartment.oc1..aaaaaaaafqm2df7ckwmmbtdsl2bgxsw4fcpvkoojytxrqst24yww2tdmtqcq type: string id: description: The OCID of the work request. example: ocid1.clustersworkrequest.oc1.iad.aaaaaaaanifpelnyzmkvnepohbz4ntswkpl35syzzsugdxceth3oihe8hcfq type: string operationType: description: The type of work the work request is doing. enum: - CLUSTER_CREATE - CLUSTER_UPDATE - CLUSTER_DELETE - CREATE_NAMESPACE - NODEPOOL_CREATE - NODEPOOL_UPDATE - NODEPOOL_DELETE - NODEPOOL_RECONCILE - NODEPOOL_CYCLING - WORKREQUEST_CANCEL - VIRTUALNODEPOOL_CREATE - VIRTUALNODEPOOL_UPDATE - VIRTUALNODEPOOL_DELETE - VIRTUALNODE_DELETE - VIRTUALNODEPOOL_CYCLING - ENABLE_ADDON - UPDATE_ADDON - DISABLE_ADDON - RECONCILE_ADDON - CLUSTER_NODE_REBOOT - CLUSTER_NODE_REPLACE_BOOT_VOLUME - START_PUBLIC_API_ENDPOINT_DECOMMISSION - ROLLBACK_PUBLIC_API_ENDPOINT_DECOMMISSION example: CLUSTER_UPDATE type: string x-obmcs-top-level-enum: '#/definitions/WorkRequestOperationType' resources: description: The resources this work request affects. items: $ref: '#/components/schemas/WorkRequestResource' type: array status: description: The current status of the work request. enum: - ACCEPTED - IN_PROGRESS - FAILED - SUCCEEDED - CANCELING - CANCELED example: IN_PROGRESS type: string x-obmcs-top-level-enum: '#/definitions/WorkRequestStatus' timeAccepted: description: The time the work request was accepted. example: '2017-07-21T16:11:29Z' format: date-time type: string timeFinished: description: The time the work request was finished. example: '2017-07-21T16:11:29Z' format: date-time type: string timeStarted: description: The time the work request was started. example: '2017-07-21T16:11:29Z' format: date-time type: string type: object ShapeMemoryOptions: description: Memory properties. properties: defaultPerOcpuInGBs: description: The default amount of memory per OCPU available for this shape, in gigabytes. format: float minimum: 0.0 type: number maxInGBs: description: The maximum amount of memory, in gigabytes. format: float minimum: 0.0 type: number maxPerOcpuInGBs: description: The maximum amount of memory per OCPU available for this shape, in gigabytes. format: float minimum: 0.0 type: number minInGBs: description: The minimum amount of memory, in gigabytes. format: float minimum: 0.0 type: number minPerOcpuInGBs: description: The minimum amount of memory per OCPU available for this shape, in gigabytes. format: float minimum: 0.0 type: number type: object KubernetesVersionsFilters: description: The range of kubernetes versions an addon can be configured. properties: exactKubernetesVersions: description: 'The exact version of kubernetes that are compatible. ' items: maxLength: 255 minLength: 1 type: string type: array uniqueItems: true maximumVersion: description: The latest kubernetes version. example: 1.23.0 type: string minimalVersion: description: The earliest kubernetes version. example: 1.11.0 type: string type: object VirtualNodePoolSummary: description: The properties that define a virtual node pool summary. properties: clusterId: description: The cluster the virtual node pool is associated with. A virtual node pool can only be associated with one cluster. example: ocid1.cluster.oc1.iad.aaaaaaaaga3tombrmq3wgyrvmi3gcn3bmfsdizjwgy4wgyldmy3dcmtcmmyw maxLength: 255 minLength: 1 type: string compartmentId: description: Compartment of the virtual node pool. example: ocid1.compartment.oc1..aaaaaaaafqm2df7ckwmmbtdsl2bgxsw4fcpvkoojytxrqst24yww2tdmtqcq maxLength: 255 minLength: 1 type: string definedTags: additionalProperties: additionalProperties: description: 'The value of the tag. Only the String type is supported. ' type: object description: 'Key-value pair representing a defined tag key and value, scoped to a namespace. Example: `{"CostCenter": "42"}` ' type: object description: 'Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see [Resource Tags](/Content/General/Concepts/resourcetags.htm). Example: `{"Operations": {"CostCenter": "42"}}` ' example: Operations: CostCenter: 42 type: object displayName: description: Display name of the virtual node pool. This is a non-unique value. example: My Virtual Node Pool maxLength: 255 minLength: 1 type: string freeformTags: additionalProperties: type: string description: 'Free-form tags for this resource. Each tag is a simple key-value pair with no predefined name, type, or namespace. For more information, see [Resource Tags](/Content/General/Concepts/resourcetags.htm). Example: `{"Department": "Finance"}` ' example: Department: Finance type: object id: description: The OCID of the virtual node pool. example: ocid1.nodepool.oc1.iad.aaaaaaaanifpelnyzmkvnepohbz4ntswkpl35syzzsugdxceth3oihe8hcfq maxLength: 255 minLength: 1 type: string initialVirtualNodeLabels: description: Initial labels that will be added to the Kubernetes Virtual Node object when it registers. This is the same as virtualNodePool resources. items: $ref: '#/components/schemas/InitialVirtualNodeLabel' type: array kubernetesVersion: description: The version of Kubernetes running on the nodes in the node pool. example: v1.9.4 maxLength: 255 minLength: 1 type: string lifecycleDetails: description: Details about the state of the Virtual Node Pool. example: updating. type: string lifecycleState: description: The state of the Virtual Node Pool. enum: - CREATING - ACTIVE - UPDATING - DELETING - DELETED - FAILED - NEEDS_ATTENTION type: string x-obmcs-top-level-enum: '#/definitions/VirtualNodePoolLifecycleState' nsgIds: description: List of network security group id's applied to the Virtual Node VNIC. items: maxLength: 255 minLength: 1 type: string maxItems: 5 type: array uniqueItems: true placementConfigurations: description: The list of placement configurations which determines where Virtual Nodes will be provisioned across as it relates to the subnet and availability domains. The size attribute determines how many we evenly spread across these placement configurations items: $ref: '#/components/schemas/PlacementConfiguration' type: array podConfiguration: $ref: '#/components/schemas/PodConfiguration' description: The pod configuration for pods run on virtual nodes of this virtual node pool. size: description: The number of Virtual Nodes that should be in the Virtual Node Pool. The placement configurations determine where these virtual nodes are placed. format: int32 minimum: 0 type: integer systemTags: additionalProperties: additionalProperties: description: 'The value of the tag. Only string, integer and boolean types are supported. ' type: object description: 'Key-value pair representing system tags'' keys and values scoped to a namespace. Example: `{"bar-key": "value"}` ' type: object description: 'Usage of system tag keys. These predefined keys are scoped to namespaces. Example: `{"orcl-cloud": {"free-tier-retained": "true"}}` ' type: object taints: description: A taint is a collection of . These taints will be applied to the Virtual Nodes of this Virtual Node Pool for Kubernetes scheduling. items: $ref: '#/components/schemas/Taint' type: array timeCreated: description: The time the virtual node pool was created. example: '2017-07-21T16:11:29Z' format: date-time type: string timeUpdated: description: The time the virtual node pool was updated. example: '2017-07-21T16:11:29Z' format: date-time type: string virtualNodePoolCyclingDetails: $ref: '#/components/schemas/VirtualNodePoolCyclingDetails' virtualNodeTags: $ref: '#/components/schemas/VirtualNodeTags' required: - id - compartmentId - clusterId - displayName - kubernetesVersion - placementConfigurations - podConfiguration - size type: object KeyDetails: description: The properties that define the kms keys used by OKE for Image Signature verification. properties: kmsKeyId: description: 'The OCIDs of the KMS key that will be used to verify whether the images are signed by an approved source. ' maxLength: 255 minLength: 1 type: string type: object ExtendEndpointDecommissionRollbackDeadlineDetails: description: The properties that define a request to extend the rollback deadline for a public api endpoint decommission. properties: rollbackDeadlineDelay: description: "The optional override delay of the rollback deadline once decommission is finished. \nmaximum to 30 days could be added. Once Deadline is passed, rollback will not able to be launched.\n" example: P1DT6H format: x-obmcs-duration type: string required: - rollbackDeadlineDelay type: object AddOnOptions: description: The properties that define options for supported add-ons. properties: isKubernetesDashboardEnabled: description: Whether or not to enable the Kubernetes Dashboard add-on. example: true type: boolean isTillerEnabled: description: Whether or not to enable the Tiller add-on. example: true type: boolean type: object PodConfiguration: description: The pod configuration for pods run on virtual nodes of this virtual node pool. properties: nsgIds: description: List of network security group IDs applied to the Pod VNIC. items: maxLength: 255 minLength: 1 type: string maxItems: 5 type: array uniqueItems: true shape: description: Shape of the pods. type: string subnetId: description: The regional subnet where pods' VNIC will be placed. maxLength: 255 minLength: 1 type: string required: - subnetId - shape type: object Cluster: description: A Kubernetes cluster. Avoid entering confidential information. properties: availableKubernetesUpgrades: description: Available Kubernetes versions to which the clusters masters may be upgraded. items: example: v1.9.4 type: string type: array clusterPodNetworkOptions: description: Available CNIs and network options for existing and new node pools of the cluster items: $ref: '#/components/schemas/ClusterPodNetworkOptionDetails' maxItems: 255 type: array uniqueItems: true x-default-description: 'null' compartmentId: description: The OCID of the compartment in which the cluster exists. example: ocid1.compartment.oc1..aaaaaaaafqm2df7ckwmmbtdsl2bgxsw4fcpvkoojytxrqst24yww2tdmtqcq type: string definedTags: additionalProperties: additionalProperties: description: 'The value of the tag. Only the String type is supported. ' type: object description: 'Key-value pair representing a defined tag key and value, scoped to a namespace. Example: `{"CostCenter": "42"}` ' type: object description: 'Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see [Resource Tags](/Content/General/Concepts/resourcetags.htm). Example: `{"Operations": {"CostCenter": "42"}}` ' example: Operations: CostCenter: 42 type: object endpointConfig: $ref: '#/components/schemas/ClusterEndpointConfig' description: 'The network configuration for access to the Cluster control plane. ' endpoints: $ref: '#/components/schemas/ClusterEndpoints' description: Endpoints served up by the cluster masters. freeformTags: additionalProperties: type: string description: 'Free-form tags for this resource. Each tag is a simple key-value pair with no predefined name, type, or namespace. For more information, see [Resource Tags](/Content/General/Concepts/resourcetags.htm). Example: `{"Department": "Finance"}` ' example: Department: Finance type: object id: description: The OCID of the cluster. example: ocid1.cluster.oc1.iad.aaaaaaaaga3tombrmq3wgyrvmi3gcn3bmfsdizjwgy4wgyldmy3dcmtcmmyw type: string imagePolicyConfig: $ref: '#/components/schemas/ImagePolicyConfig' description: 'The image verification policy for signature validation. ' kmsKeyId: description: The OCID of the KMS key to be used as the master encryption key for Kubernetes secret encryption. type: string kubernetesVersion: description: The version of Kubernetes running on the cluster masters. example: v1.9.4 type: string lifecycleDetails: description: Details about the state of the cluster masters. example: waiting for node pools type: string lifecycleState: description: The state of the cluster masters. For more information, see [Monitoring Clusters](/Content/ContEng/Tasks/contengmonitoringclusters.htm) enum: - CREATING - ACTIVE - FAILED - DELETING - DELETED - UPDATING example: UPDATING type: string x-obmcs-top-level-enum: '#/definitions/ClusterLifecycleState' metadata: $ref: '#/components/schemas/ClusterMetadata' description: Metadata about the cluster. name: description: The name of the cluster. example: My Cluster type: string openIdConnectDiscoveryEndpoint: description: 'The cluster-specific OpenID Connect Discovery endpoint ' example: https://objectstorage.us-ashburn-1.oci.customer-oci.com/n/id9y6mi8tcky/b/oidc/o/a1936058-8b1c-4527-b21c-6766527236f6/.well-known/openid-configuration type: string openIdConnectDiscoveryKey: description: 'The cluster-specific OpenID Connect Discovery Key to derive the DiscoveryEndpoint ' example: a1936058-8b1c-4527-b21c-6766527236f6 type: string options: $ref: '#/components/schemas/ClusterCreateOptions' description: Optional attributes for the cluster. systemTags: additionalProperties: additionalProperties: description: 'The value of the tag. Only string, integer and boolean types are supported. ' type: object description: 'Key-value pair representing system tags'' keys and values scoped to a namespace. Example: `{"bar-key": "value"}` ' type: object description: 'Usage of system tag keys. These predefined keys are scoped to namespaces. Example: `{"orcl-cloud": {"free-tier-retained": "true"}}` ' type: object type: description: Type of cluster enum: - BASIC_CLUSTER - ENHANCED_CLUSTER example: ENHANCED_CLUSTER type: string x-obmcs-top-level-enum: '#/definitions/ClusterType' vcnId: description: The OCID of the virtual cloud network (VCN) in which the cluster exists. example: ocid1.vcn.oc1.iad.aaaaaaaa5e3hn7hk6y63awlhbvlhsumkn5p3ficbjcevbnoylvptcpkxtsaa type: string type: object AddonVersions: description: The properties that define a work request resource. properties: configurations: description: Addon version configuration details. items: $ref: '#/components/schemas/AddonVersionConfiguration' type: array description: description: Information about the addon version. example: Information about addon version and if any recent changes type: string kubernetesVersionFilters: $ref: '#/components/schemas/KubernetesVersionsFilters' description: The range of kubernetes versions an addon can be configured. status: description: Current state of the addon, only active will be visible to customer, visibility of versions in other status will be filtered based on limits property. enum: - ACTIVE - DEPRECATED - PREVIEW - RECALLED example: ACTIVE type: string versionNumber: description: Version number, need be comparable within an addon. example: x.y.z type: string type: object CreateVirtualNodePoolDetails: description: The properties that define a request to create a virtual node pool. properties: clusterId: description: The cluster the virtual node pool is associated with. A virtual node pool can only be associated with one cluster. example: ocid1.cluster.oc1.iad.aaaaaaaaga3tombrmq3wgyrvmi3gcn3bmfsdizjwgy4wgyldmy3dcmtcmmyw maxLength: 255 minLength: 1 type: string compartmentId: description: Compartment of the virtual node pool. example: ocid1.compartment.oc1..aaaaaaaafqm2df7ckwmmbtdsl2bgxsw4fcpvkoojytxrqst24yww2tdmtqcq maxLength: 255 minLength: 1 type: string definedTags: additionalProperties: additionalProperties: description: 'The value of the tag. Only the String type is supported. ' type: object description: 'Key-value pair representing a defined tag key and value, scoped to a namespace. Example: `{"CostCenter": "42"}` ' type: object description: 'Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see [Resource Tags](/Content/General/Concepts/resourcetags.htm). Example: `{"Operations": {"CostCenter": "42"}}` ' example: Operations: CostCenter: 42 type: object displayName: description: Display name of the virtual node pool. This is a non-unique value. example: My Virtual Node Pool maxLength: 255 minLength: 1 type: string freeformTags: additionalProperties: type: string description: 'Free-form tags for this resource. Each tag is a simple key-value pair with no predefined name, type, or namespace. For more information, see [Resource Tags](/Content/General/Concepts/resourcetags.htm). Example: `{"Department": "Finance"}` ' example: Department: Finance type: object initialVirtualNodeLabels: description: Initial labels that will be added to the Kubernetes Virtual Node object when it registers. items: $ref: '#/components/schemas/InitialVirtualNodeLabel' type: array nsgIds: description: List of network security group id's applied to the Virtual Node VNIC. items: maxLength: 255 minLength: 1 type: string maxItems: 5 type: array uniqueItems: true placementConfigurations: description: The list of placement configurations which determines where Virtual Nodes will be provisioned across as it relates to the subnet and availability domains. The size attribute determines how many we evenly spread across these placement configurations items: $ref: '#/components/schemas/PlacementConfiguration' minItems: 1 type: array podConfiguration: $ref: '#/components/schemas/PodConfiguration' description: The pod configuration for pods run on virtual nodes of this virtual node pool. size: description: The number of Virtual Nodes that should be in the Virtual Node Pool. The placement configurations determine where these virtual nodes are placed. format: int32 minimum: 0 type: integer taints: description: A taint is a collection of . These taints will be applied to the Virtual Nodes of this Virtual Node Pool for Kubernetes scheduling. items: $ref: '#/components/schemas/Taint' type: array virtualNodePoolCyclingDetails: $ref: '#/components/schemas/VirtualNodePoolCyclingDetails' virtualNodeTags: $ref: '#/components/schemas/VirtualNodeTags' required: - compartmentId - clusterId - displayName - placementConfigurations - podConfiguration - size type: object CreateImagePolicyConfigDetails: allOf: - $ref: '#/components/schemas/ImagePolicyConfig' description: The properties that define a image verification policy. ClusterOptions: description: Options for creating or updating clusters. properties: clusterPodNetworkOptions: description: Available CNIs and network options for existing and new node pools of the cluster items: $ref: '#/components/schemas/ClusterPodNetworkOptionDetails' maxItems: 255 type: array uniqueItems: true x-default-description: when unspecified in case of updates, the current value of this field will be preserved, else value set to null kubernetesVersions: description: Available Kubernetes versions. items: example: v1.9.4 type: string type: array type: object NodePoolNodeConfigDetails: description: The size and placement configuration of nodes in the node pool. properties: computeClusterId: description: The OCID of the Compute Cluster to be associated with the worker node instance. type: string definedTags: additionalProperties: additionalProperties: description: 'The value of the tag. Only the String type is supported. ' type: object description: 'Key-value pair representing a defined tag key and value, scoped to a namespace. Example: `{"CostCenter": "42"}` ' type: object description: 'Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see [Resource Tags](/Content/General/Concepts/resourcetags.htm). Example: `{"Operations": {"CostCenter": "42"}}` ' example: Operations: CostCenter: 42 type: object freeformTags: additionalProperties: type: string description: 'Free-form tags for this resource. Each tag is a simple key-value pair with no predefined name, type, or namespace. For more information, see [Resource Tags](/Content/General/Concepts/resourcetags.htm). Example: `{"Department": "Finance"}` ' example: Department: Finance type: object isPvEncryptionInTransitEnabled: default: false description: Whether to enable in-transit encryption for the data volume's paravirtualized attachment. This field applies to both block volumes and boot volumes. The default value is false. type: boolean kmsKeyId: description: The OCID of the Key Management Service key assigned to the boot volume. type: string nodePoolPodNetworkOptionDetails: $ref: '#/components/schemas/NodePoolPodNetworkOptionDetails' description: 'The CNI related configuration of pods in the node pool. ' nsgIds: description: 'The OCIDs of the Network Security Group(s) to associate nodes for this node pool with. For more information about NSGs, see [NetworkSecurityGroup](#/en/iaas/20160918/NetworkSecurityGroup/). ' items: maxLength: 255 minLength: 1 type: string maxItems: 5 type: array uniqueItems: true placementConfigs: description: 'The placement configurations for the node pool. Provide one placement configuration for each availability domain in which you intend to launch a node. To use the node pool with a regional subnet, provide a placement configuration for each availability domain, and include the regional subnet in each placement configuration. ' items: $ref: '#/components/schemas/NodePoolPlacementConfigDetails' type: array size: description: 'The number of nodes in the node pool. ' format: int32 type: integer type: object CreateNodePoolDetails: description: The properties that define a request to create a node pool. properties: clusterId: description: The OCID of the cluster to which this node pool is attached. example: ocid1.cluster.oc1.iad.aaaaaaaaga3tombrmq3wgyrvmi3gcn3bmfsdizjwgy4wgyldmy3dcmtcmmyw type: string compartmentId: description: The OCID of the compartment in which the node pool exists. example: ocid1.compartment.oc1..aaaaaaaafqm2df7ckwmmbtdsl2bgxsw4fcpvkoojytxrqst24yww2tdmtqcq type: string definedTags: additionalProperties: additionalProperties: description: 'The value of the tag. Only the String type is supported. ' type: object description: 'Key-value pair representing a defined tag key and value, scoped to a namespace. Example: `{"CostCenter": "42"}` ' type: object description: 'Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see [Resource Tags](/Content/General/Concepts/resourcetags.htm). Example: `{"Operations": {"CostCenter": "42"}}` ' example: Operations: CostCenter: 42 type: object freeformTags: additionalProperties: type: string description: 'Free-form tags for this resource. Each tag is a simple key-value pair with no predefined name, type, or namespace. For more information, see [Resource Tags](/Content/General/Concepts/resourcetags.htm). Example: `{"Department": "Finance"}` ' example: Department: Finance type: object initialNodeLabels: description: A list of key/value pairs to add to nodes after they join the Kubernetes cluster. items: $ref: '#/components/schemas/KeyValue' type: array kubernetesVersion: description: The version of Kubernetes to install on the nodes in the node pool. example: v1.9.4 type: string name: description: The name of the node pool. Avoid entering confidential information. example: My Node Pool type: string networkLaunchType: description: Emulation type for the physical network interface card (NIC) for nodes enum: - VFIO - E1000 - PARAVIRTUALIZED type: string x-default-description: 'null' x-obmcs-top-level-enum: '#/definitions/NetworkLaunchType' nodeConfigDetails: $ref: '#/components/schemas/CreateNodePoolNodeConfigDetails' description: 'The configuration of nodes in the node pool. Exactly one of the subnetIds or nodeConfigDetails properties must be specified. ' nodeEvictionNodePoolSettings: $ref: '#/components/schemas/NodeEvictionNodePoolSettings' nodeImageName: description: 'Deprecated. Use `nodeSourceDetails` instead. If you specify values for both, this value is ignored. The name of the image running on the nodes in the node pool. ' example: Oracle-Linux-7.4 type: string nodeMetadata: additionalProperties: type: string description: A list of key/value pairs to add to each underlying OCI instance in the node pool on launch. type: object nodePoolCyclingDetails: $ref: '#/components/schemas/NodePoolCyclingDetails' nodeShape: description: The name of the node shape of the nodes in the node pool. example: VM.Standard2.4 type: string nodeShapeConfig: $ref: '#/components/schemas/CreateNodeShapeConfigDetails' description: 'Specify the configuration of the shape to launch nodes in the node pool. ' nodeSourceDetails: $ref: '#/components/schemas/NodeSourceDetails' description: 'Specify the source to use to launch nodes in the node pool. Currently, image is the only supported source. ' primaryVnic: $ref: '#/components/schemas/NodePoolPrimaryVnicDetails' quantityPerSubnet: default: 1 description: 'Optional, default to 1. The number of nodes to create in each subnet specified in subnetIds property. When used, subnetIds is required. This property is deprecated, use nodeConfigDetails instead. ' example: 1 format: int32 type: integer secondaryVnics: description: A list of secondary vnics to attach to nodes items: $ref: '#/components/schemas/NodePoolSecondaryVnicDetails' maxItems: 64 type: array x-default-description: 'null' sshPublicKey: description: The SSH public key on each node in the node pool on launch. example: ssh-rsa AAAAB3NzaC1yc2abc123... type: string subnetIds: description: 'The OCIDs of the subnets in which to place nodes for this node pool. When used, quantityPerSubnet can be provided. This property is deprecated, use nodeConfigDetails. Exactly one of the subnetIds or nodeConfigDetails properties must be specified. ' items: maxLength: 255 minLength: 1 type: string type: array required: - compartmentId - clusterId - name - nodeShape type: object VirtualNodeSummary: description: The properties that define a virtual node summary. properties: availabilityDomain: description: The name of the availability domain in which this virtual node is placed maxLength: 255 minLength: 1 type: string definedTags: additionalProperties: additionalProperties: description: 'The value of the tag. Only the String type is supported. ' type: object description: 'Key-value pair representing a defined tag key and value, scoped to a namespace. Example: `{"CostCenter": "42"}` ' type: object description: 'Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see [Resource Tags](/Content/General/Concepts/resourcetags.htm). Example: `{"Operations": {"CostCenter": "42"}}` ' example: Operations: CostCenter: 42 type: object displayName: description: The name of the virtual node. example: My Kubernetes virtual Node maxLength: 255 minLength: 1 type: string faultDomain: description: The fault domain of this virtual node. maxLength: 255 minLength: 1 type: string freeformTags: additionalProperties: type: string description: 'Free-form tags for this resource. Each tag is a simple key-value pair with no predefined name, type, or namespace. For more information, see [Resource Tags](/Content/General/Concepts/resourcetags.htm). Example: `{"Department": "Finance"}` ' example: Department: Finance type: object id: description: The ocid of the virtual node. example: ocid1.virtualnode.oc1.iad.aaaaaaaaga3tombrmq3wgyrvmi3gcn3bmfsdizjwgyswgycdoy3tcmtctmyw maxLength: 255 minLength: 1 type: string kubernetesVersion: description: The version of Kubernetes this virtual node is running. example: v1.9.4 maxLength: 255 minLength: 1 type: string lifecycleDetails: description: Details about the state of the Virtual Node. type: string lifecycleState: description: The state of the Virtual Node. enum: - CREATING - ACTIVE - UPDATING - DELETING - DELETED - FAILED - NEEDS_ATTENTION type: string x-obmcs-top-level-enum: '#/definitions/VirtualNodeLifecycleState' nsgIds: description: NSG Ids applied to virtual node vnic. items: maxLength: 255 minLength: 1 type: string maxItems: 5 type: array privateIp: description: The private IP address of this Virtual Node. type: string subnetId: description: The OCID of the subnet in which this Virtual Node is placed. maxLength: 255 minLength: 1 type: string systemTags: additionalProperties: additionalProperties: description: 'The value of the tag. Only string, integer and boolean types are supported. ' type: object description: 'Key-value pair representing system tags'' keys and values scoped to a namespace. Example: `{"bar-key": "value"}` ' type: object description: 'Usage of system tag keys. These predefined keys are scoped to namespaces. Example: `{"orcl-cloud": {"free-tier-retained": "true"}}` ' type: object timeCreated: description: The time at which the virtual node was created. example: '2017-07-21T16:11:29Z' format: date-time type: string virtualNodeError: description: An error that may be associated with the virtual node. type: string virtualNodePoolId: description: The ocid of the virtual node pool this virtual node belongs to. example: ocid1.virtualnodepool.oc1.iad.aaaaaaaanifpelnyzmkvnepohbz4ntswkpl35syzzsugdxceth3oihe8hcfq maxLength: 255 minLength: 1 type: string required: - id - virtualNodePoolId - displayName type: object NodeSourceOption: description: The source option for the node. discriminator: propertyName: sourceType properties: sourceName: description: 'The user-friendly name of the entity corresponding to the OCID. ' maxLength: 255 minLength: 1 type: string sourceType: description: 'The source type of this option. `IMAGE` means the OCID is of an image. ' enum: - IMAGE type: string x-obmcs-top-level-enum: '#/definitions/NodeSourceType' required: - sourceType NodePoolPlacementConfigDetails: description: The location where a node pool will place nodes. properties: availabilityDomain: description: 'The availability domain in which to place nodes. Example: `Uocm:PHX-AD-1` ' maxLength: 255 minLength: 1 type: string capacityReservationId: description: The OCID of the compute capacity reservation in which to place the compute instance. maxLength: 255 minLength: 0 type: string faultDomains: description: 'A list of fault domains in which to place nodes. ' items: maxLength: 255 minLength: 0 type: string maxItems: 3 type: array uniqueItems: true hostGroupId: description: The OCID of the Host Group to be associated with the worker node instance. maxLength: 255 minLength: 0 type: string preemptibleNodeConfig: $ref: '#/components/schemas/PreemptibleNodeConfigDetails' subnetId: description: The OCID of the subnet in which to place nodes. maxLength: 255 minLength: 1 type: string required: - availabilityDomain - subnetId type: object PersistentVolumeConfigDetails: description: Configuration to be applied to block volumes created by Kubernetes Persistent Volume Claims (PVC) properties: definedTags: additionalProperties: additionalProperties: description: 'The value of the tag. Only the String type is supported. ' type: object description: 'Key-value pair representing a defined tag key and value, scoped to a namespace. Example: `{"CostCenter": "42"}` ' type: object description: 'Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see [Resource Tags](/Content/General/Concepts/resourcetags.htm). Example: `{"Operations": {"CostCenter": "42"}}` ' example: Operations: CostCenter: 42 type: object freeformTags: additionalProperties: type: string description: 'Free-form tags for this resource. Each tag is a simple key-value pair with no predefined name, type, or namespace. For more information, see [Resource Tags](/Content/General/Concepts/resourcetags.htm). Example: `{"Department": "Finance"}` ' example: Department: Finance type: object type: object UpdateNodePoolDetails: description: The properties that define a request to update a node pool. properties: definedTags: additionalProperties: additionalProperties: description: 'The value of the tag. Only the String type is supported. ' type: object description: 'Key-value pair representing a defined tag key and value, scoped to a namespace. Example: `{"CostCenter": "42"}` ' type: object description: 'Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see [Resource Tags](/Content/General/Concepts/resourcetags.htm). Example: `{"Operations": {"CostCenter": "42"}}` ' example: Operations: CostCenter: 42 type: object freeformTags: additionalProperties: type: string description: 'Free-form tags for this resource. Each tag is a simple key-value pair with no predefined name, type, or namespace. For more information, see [Resource Tags](/Content/General/Concepts/resourcetags.htm). Example: `{"Department": "Finance"}` ' example: Department: Finance type: object initialNodeLabels: description: A list of key/value pairs to add to nodes after they join the Kubernetes cluster. items: $ref: '#/components/schemas/KeyValue' type: array kubernetesVersion: description: The version of Kubernetes to which the nodes in the node pool should be upgraded. example: v1.9.4 type: string name: description: The new name for the cluster. Avoid entering confidential information. example: My Updated Node Pool type: string networkLaunchType: description: Emulation type for the physical network interface card (NIC) for nodes enum: - VFIO - E1000 - PARAVIRTUALIZED type: string x-obmcs-top-level-enum: '#/definitions/NetworkLaunchType' nodeConfigDetails: $ref: '#/components/schemas/UpdateNodePoolNodeConfigDetails' description: 'The configuration of nodes in the node pool. Only one of the subnetIds or nodeConfigDetails properties should be specified. If the current value of quantityPerSubnet is greater than 0, the node pool may still be scaled using quantityPerSubnet. Before you can use nodeConfigDetails, you must first scale the node pool to 0 nodes using quantityPerSubnet. ' nodeEvictionNodePoolSettings: $ref: '#/components/schemas/NodeEvictionNodePoolSettings' nodeMetadata: additionalProperties: type: string description: A list of key/value pairs to add to each underlying OCI instance in the node pool on launch. type: object nodePoolCyclingDetails: $ref: '#/components/schemas/NodePoolCyclingDetails' nodeShape: description: The name of the node shape of the nodes in the node pool used on launch. example: VM.Standard2.4 type: string nodeShapeConfig: $ref: '#/components/schemas/UpdateNodeShapeConfigDetails' description: 'Specify the configuration of the shape to launch nodes in the node pool. ' nodeSourceDetails: $ref: '#/components/schemas/NodeSourceDetails' description: 'Specify the source to use to launch nodes in the node pool. Currently, image is the only supported source. ' primaryVnic: $ref: '#/components/schemas/NodePoolPrimaryVnicDetails' quantityPerSubnet: description: 'The number of nodes to have in each subnet specified in the subnetIds property. This property is deprecated, use nodeConfigDetails instead. If the current value of quantityPerSubnet is greater than 0, you can only use quantityPerSubnet to scale the node pool. If the current value of quantityPerSubnet is equal to 0 and the current value of size in nodeConfigDetails is greater than 0, before you can use quantityPerSubnet, you must first scale the node pool to 0 nodes using nodeConfigDetails. ' example: 1 format: int32 type: integer secondaryVnics: description: A list of secondary vnics to attach to nodes items: $ref: '#/components/schemas/NodePoolSecondaryVnicDetails' maxItems: 64 type: array sshPublicKey: description: The SSH public key to add to each node in the node pool on launch. example: ssh-rsa AAAAB3NzaC1yc2abc123... type: string subnetIds: description: 'The OCIDs of the subnets in which to place nodes for this node pool. This property is deprecated, use nodeConfigDetails instead. Only one of the subnetIds or nodeConfigDetails properties can be specified. ' items: maxLength: 255 minLength: 1 type: string type: array type: object Addon: description: The properties that define an addon. properties: addonError: $ref: '#/components/schemas/AddonError' description: The error info of the addon. configurations: description: Addon configuration details. items: $ref: '#/components/schemas/AddonConfiguration' type: array currentInstalledVersion: description: current installed version of the addon example: x.y.z type: string lifecycleState: description: The state of the addon. enum: - CREATING - ACTIVE - DELETING - DELETED - UPDATING - NEEDS_ATTENTION - FAILED example: UPDATING type: string x-obmcs-top-level-enum: '#/definitions/AddonLifecycleState' name: description: The name of the addon. example: flannel type: string timeCreated: description: The time the cluster was created. example: '2017-07-21T16:11:29Z' format: date-time type: string version: description: selected addon version, or null indicates autoUpdate example: x.y.z type: string required: - lifecycleState - name type: object Ipv6AddressIpv6SubnetCidrPairDetails: description: 'Used to specify from which subnet prefixes an IPv6 address should be allocated, or to assign valid available IPv6 addresses ' properties: ipv6Address: description: 'An IPv6 address of your choice. Must be an available IPv6 address within the subnet''s prefix ' maxLength: 45 minLength: 1 type: string ipv6SubnetCidr: description: 'The IPv6 prefix allocated to the subnet ' maxLength: 45 minLength: 1 type: string type: object ClusterEndpoints: description: The properties that define endpoints for a cluster. properties: ipv6Endpoint: description: The IPv6 networking Kubernetes API server endpoint. example: https://yourIPv6Endpoint type: string kubernetes: description: The non-native networking Kubernetes API server endpoint. example: https://yourkubernetes type: string privateEndpoint: description: The private native networking Kubernetes API server endpoint. example: https://yourPrivateEndpoint type: string publicEndpoint: description: The public native networking Kubernetes API server endpoint, if one was requested. example: https://yourPublicEndpoint type: string vcnHostnameEndpoint: description: 'The FQDN assigned to the Kubernetes API private endpoint. Example: ''https://yourVcnHostnameEndpoint'' ' example: https://clusterinfo.subnetLabel.vcnLabel.oraclevcn.com:6443 type: string type: object AddonOptionSummary: description: The properties that define addon summary. properties: addonGroup: description: Addon group info, a namespace concept that groups addons with similar functionalities. example: oke/cluster-network type: string addonSchemaVersion: description: Addon definition schema version to validate addon. example: '0.1' type: string definedTags: additionalProperties: additionalProperties: description: 'The value of the tag. Only the String type is supported. ' type: object description: 'Key-value pair representing a defined tag key and value, scoped to a namespace. Example: `{"CostCenter": "42"}` ' type: object description: 'Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see [Resource Tags](/Content/General/Concepts/resourcetags.htm). Example: `{"Operations": {"CostCenter": "42"}}` ' example: Operations: CostCenter: 42 type: object description: description: Description on the addon. example: BlaBla type: string freeformTags: additionalProperties: type: string description: 'Free-form tags for this resource. Each tag is a simple key-value pair with no predefined name, type, or namespace. For more information, see [Resource Tags](/Content/General/Concepts/resourcetags.htm). Example: `{"Department": "Finance"}` ' example: Department: Finance type: object isEssential: description: Is it an essential addon for cluster operation or not. example: true type: boolean lifecycleState: description: The life cycle state of the addon. enum: - ACTIVE - INACTIVE example: ACTIVE type: string name: description: Name of the addon and it would be unique. example: flannel type: string systemTags: additionalProperties: additionalProperties: description: 'The value of the tag. Only string, integer and boolean types are supported. ' type: object description: 'Key-value pair representing system tags'' keys and values scoped to a namespace. Example: `{"bar-key": "value"}` ' type: object description: 'Usage of system tag keys. These predefined keys are scoped to namespaces. Example: `{"orcl-cloud": {"free-tier-retained": "true"}}` ' type: object timeCreated: description: The time the work request was created. example: '2017-07-21T16:11:29Z' format: date-time type: string versions: description: The resources this work request affects. items: $ref: '#/components/schemas/AddonVersions' type: array required: - versions - name - isEssential - lifecycleState type: object UpdateClusterOptionsDetails: description: The properties that define extra options updating a cluster. properties: admissionControllerOptions: $ref: '#/components/schemas/AdmissionControllerOptions' description: Configurable cluster admission controllers openIdConnectDiscovery: $ref: '#/components/schemas/OpenIdConnectDiscovery' openIdConnectTokenAuthenticationConfig: $ref: '#/components/schemas/OpenIdConnectTokenAuthenticationConfig' persistentVolumeConfig: $ref: '#/components/schemas/PersistentVolumeConfigDetails' serviceLbConfig: $ref: '#/components/schemas/ServiceLbConfigDetails' type: object PreemptionAction: description: The action to run when the preemptible node is interrupted for eviction. discriminator: propertyName: type properties: type: description: The type of action to run when the instance is interrupted for eviction. enum: - TERMINATE type: string required: - type InstallAddonDetails: description: The properties that define to install/enable addon on a cluster properties: addonName: description: The name of the addon. example: flannel type: string configurations: description: Addon configuration details. items: $ref: '#/components/schemas/AddonConfiguration' type: array isOverrideExisting: default: false description: Whether or not to override an existing addon installation. Defaults to false. If set to true, any existing addon installation would be overridden as per new installation details. example: 'true' type: boolean version: description: The version of addon to be installed. example: 2.2.2 type: string required: - addonName type: object ShapeNetworkBandwidthOptions: description: Properties of network bandwidth. properties: defaultPerOcpuInGbps: description: The default amount of networking bandwidth per OCPU, in gigabits per second. format: float minimum: 0.0 type: number maxInGbps: description: The maximum amount of networking bandwidth, in gigabits per second. format: float minimum: 0.0 type: number minInGbps: description: The minimum amount of networking bandwidth, in gigabits per second. format: float minimum: 0.0 type: number type: object AdmissionControllerOptions: description: The properties that define supported admission controllers. properties: isPodSecurityPolicyEnabled: default: false description: Whether or not to enable the Pod Security Policy admission controller. example: false type: boolean type: object CreateNodeShapeConfigDetails: allOf: - $ref: '#/components/schemas/NodeShapeConfig' description: The shape configuration of the nodes. PreemptibleNodeConfigDetails: description: Configuration options for preemptible nodes. properties: preemptionAction: $ref: '#/components/schemas/PreemptionAction' required: - preemptionAction type: object KeyValue: description: The properties that define a key value pair. properties: key: description: The key of the pair. example: mykey type: string value: description: The value of the pair. example: myvalue type: string type: object WorkRequestLogEntry: description: Log entries related to a specific work request. properties: message: description: The description of an action that occurred. example: error validating payload type: string timestamp: description: The date and time the log entry occurred. example: '2017-07-21T16:11:29Z' type: string type: object WorkRequest: description: An asynchronous work request. properties: compartmentId: description: The OCID of the compartment in which the work request exists. example: ocid1.compartment.oc1..aaaaaaaafqm2df7ckwmmbtdsl2bgxsw4fcpvkoojytxrqst24yww2tdmtqcq type: string id: description: The OCID of the work request. example: ocid1.clustersworkrequest.oc1.iad.aaaaaaaanifpelnyzmkvnepohbz4ntswkpl35syzzsugdxceth3oihe8hcfq type: string operationType: description: The type of work the work request is doing. enum: - CLUSTER_CREATE - CLUSTER_UPDATE - CLUSTER_DELETE - CREATE_NAMESPACE - NODEPOOL_CREATE - NODEPOOL_UPDATE - NODEPOOL_DELETE - NODEPOOL_RECONCILE - NODEPOOL_CYCLING - WORKREQUEST_CANCEL - VIRTUALNODEPOOL_CREATE - VIRTUALNODEPOOL_UPDATE - VIRTUALNODEPOOL_DELETE - VIRTUALNODE_DELETE - VIRTUALNODEPOOL_CYCLING - ENABLE_ADDON - UPDATE_ADDON - DISABLE_ADDON - RECONCILE_ADDON - CLUSTER_NODE_REBOOT - CLUSTER_NODE_REPLACE_BOOT_VOLUME - START_PUBLIC_API_ENDPOINT_DECOMMISSION - ROLLBACK_PUBLIC_API_ENDPOINT_DECOMMISSION example: CLUSTER_UPDATE type: string x-obmcs-top-level-enum: '#/definitions/WorkRequestOperationType' resources: description: The resources this work request affects. items: $ref: '#/components/schemas/WorkRequestResource' type: array status: description: The current status of the work request. enum: - ACCEPTED - IN_PROGRESS - FAILED - SUCCEEDED - CANCELING - CANCELED example: IN_PROGRESS type: string x-obmcs-top-level-enum: '#/definitions/WorkRequestStatus' timeAccepted: description: The time the work request was accepted. example: '2017-07-21T16:11:29Z' format: date-time type: string timeFinished: description: The time the work request was finished. example: '2017-07-21T16:11:29Z' format: date-time type: string timeStarted: description: The time the work request was started. example: '2017-07-21T16:11:29Z' format: date-time type: string type: object UpdateVirtualNodePoolDetails: description: The properties that define a request to update a virtual node pool. properties: definedTags: additionalProperties: additionalProperties: description: 'The value of the tag. Only the String type is supported. ' type: object description: 'Key-value pair representing a defined tag key and value, scoped to a namespace. Example: `{"CostCenter": "42"}` ' type: object description: 'Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see [Resource Tags](/Content/General/Concepts/resourcetags.htm). Example: `{"Operations": {"CostCenter": "42"}}` ' example: Operations: CostCenter: 42 type: object displayName: description: Display name of the virtual node pool. This is a non-unique value. example: My Virtual Node Pool maxLength: 255 minLength: 1 type: string freeformTags: additionalProperties: type: string description: 'Free-form tags for this resource. Each tag is a simple key-value pair with no predefined name, type, or namespace. For more information, see [Resource Tags](/Content/General/Concepts/resourcetags.htm). Example: `{"Department": "Finance"}` ' example: Department: Finance type: object initialVirtualNodeLabels: description: Initial labels that will be added to the Kubernetes Virtual Node object when it registers. items: $ref: '#/components/schemas/InitialVirtualNodeLabel' type: array nsgIds: description: List of network security group id's applied to the Virtual Node VNIC. items: maxLength: 255 minLength: 1 type: string maxItems: 5 type: array uniqueItems: true placementConfigurations: description: The list of placement configurations which determines where Virtual Nodes will be provisioned across as it relates to the subnet and availability domains. The size attribute determines how many we evenly spread across these placement configurations items: $ref: '#/components/schemas/PlacementConfiguration' minItems: 1 type: array podConfiguration: $ref: '#/components/schemas/PodConfiguration' description: The pod configuration for pods run on virtual nodes of this virtual node pool. size: description: The number of Virtual Nodes that should be in the Virtual Node Pool. The placement configurations determine where these virtual nodes are placed. format: int32 minimum: 0 type: integer taints: description: A taint is a collection of . These taints will be applied to the Virtual Nodes of this Virtual Node Pool for Kubernetes scheduling. items: $ref: '#/components/schemas/Taint' type: array virtualNodePoolCyclingDetails: $ref: '#/components/schemas/VirtualNodePoolCyclingDetails' virtualNodeTags: $ref: '#/components/schemas/VirtualNodeTags' type: object CreateClusterDetails: description: The properties that define a request to create a cluster. properties: clusterPodNetworkOptions: description: Available CNIs and network options for existing and new node pools of the cluster items: $ref: '#/components/schemas/ClusterPodNetworkOptionDetails' maxItems: 255 type: array uniqueItems: true x-default-description: 'null' compartmentId: description: The OCID of the compartment in which to create the cluster. example: ocid1.compartment.oc1..aaaaaaaafqm2df7ckwmmbtdsl2bgxsw4fcpvkoojytxrqst24yww2tdmtqcq type: string definedTags: additionalProperties: additionalProperties: description: 'The value of the tag. Only the String type is supported. ' type: object description: 'Key-value pair representing a defined tag key and value, scoped to a namespace. Example: `{"CostCenter": "42"}` ' type: object description: 'Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see [Resource Tags](/Content/General/Concepts/resourcetags.htm). Example: `{"Operations": {"CostCenter": "42"}}` ' example: Operations: CostCenter: 42 type: object endpointConfig: $ref: '#/components/schemas/CreateClusterEndpointConfigDetails' description: 'The network configuration for access to the Cluster control plane. ' freeformTags: additionalProperties: type: string description: 'Free-form tags for this resource. Each tag is a simple key-value pair with no predefined name, type, or namespace. For more information, see [Resource Tags](/Content/General/Concepts/resourcetags.htm). Example: `{"Department": "Finance"}` ' example: Department: Finance type: object imagePolicyConfig: $ref: '#/components/schemas/CreateImagePolicyConfigDetails' description: 'The image verification policy for signature validation. Once a policy is created and enabled with one or more kms keys, the policy will ensure all images deployed has been signed with the key(s) attached to the policy. ' kmsKeyId: description: 'The OCID of the KMS key to be used as the master encryption key for Kubernetes secret encryption. When used, `kubernetesVersion` must be at least `v1.13.0`. ' maxLength: 255 minLength: 1 type: string x-default-description: 'null' kubernetesVersion: description: The version of Kubernetes to install into the cluster masters. example: v1.9.4 type: string name: description: The name of the cluster. Avoid entering confidential information. example: My Cluster type: string options: $ref: '#/components/schemas/ClusterCreateOptions' description: Optional attributes for the cluster. type: description: Type of cluster enum: - BASIC_CLUSTER - ENHANCED_CLUSTER example: ENHANCED_CLUSTER type: string x-obmcs-top-level-enum: '#/definitions/ClusterType' vcnId: description: The OCID of the virtual cloud network (VCN) in which to create the cluster. example: ocid1.vcn.oc1.iad.aaaaaaaa5e3hn7hk6y63awlhbvlhsumkn5p3ficbjcevbnoylvptcpkxtsaa type: string required: - name - compartmentId - vcnId - kubernetesVersion type: object CreateClusterEndpointConfigDetails: allOf: - $ref: '#/components/schemas/ClusterEndpointConfig' description: The properties that define the network configuration for the Cluster endpoint. NodePoolOptions: description: Options for creating or updating node pools. properties: images: description: 'Deprecated. See sources. When creating a node pool using the `CreateNodePoolDetails` object, only image names contained in this property can be passed to the `nodeImageName` property. ' items: example: Oracle-Linux-7.4 type: string type: array kubernetesVersions: description: Available Kubernetes versions. items: example: v1.9.4 type: string type: array shapes: description: Available shapes for nodes. items: example: VM.Standard2.4 type: string type: array sources: description: Available source of the node. items: $ref: '#/components/schemas/NodeSourceOption' type: array type: object Node: description: The properties that define a node. properties: availabilityDomain: description: The name of the availability domain in which this node is placed. example: Rubf:PHX-AD-1 type: string definedTags: additionalProperties: additionalProperties: description: 'The value of the tag. Only the String type is supported. ' type: object description: 'Key-value pair representing a defined tag key and value, scoped to a namespace. Example: `{"CostCenter": "42"}` ' type: object description: 'Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see [Resource Tags](/Content/General/Concepts/resourcetags.htm). Example: `{"Operations": {"CostCenter": "42"}}` ' example: Operations: CostCenter: 42 type: object faultDomain: description: The fault domain of this node. example: FAULT-DOMAIN-1 type: string freeformTags: additionalProperties: type: string description: 'Free-form tags for this resource. Each tag is a simple key-value pair with no predefined name, type, or namespace. For more information, see [Resource Tags](/Content/General/Concepts/resourcetags.htm). Example: `{"Department": "Finance"}` ' example: Department: Finance type: object id: description: The OCID of the compute instance backing this node. example: ocid1.instance.oc1.iad.aaaaaaaaga3tombrmq3wgyrvmi3gcn3bmfsdizjwgyswgycdoy3tcmtctmyw type: string kubernetesVersion: description: The version of Kubernetes this node is running. example: v1.9.4 type: string lifecycleDetails: description: Details about the state of the node. example: waiting for SSH type: string lifecycleState: description: The state of the node. For more information, see [Monitoring Clusters](/Content/ContEng/Tasks/contengmonitoringclusters.htm) enum: - CREATING - ACTIVE - UPDATING - DELETING - DELETED - FAILING - INACTIVE example: UPDATING type: string name: description: The name of the node. example: My Kubernetes Node type: string nodeError: $ref: '#/components/schemas/NodeError' description: An error that may be associated with the node. nodePoolId: description: The OCID of the node pool to which this node belongs. example: ocid1.nodepool.oc1.iad.aaaaaaaanifpelnyzmkvnepohbz4ntswkpl35syzzsugdxceth3oihe8hcfq type: string privateIp: description: The private IP address of this node. example: 10.0.1.1 type: string publicIp: description: The public IP address of this node. example: 129.1.2.3 type: string subnetId: description: The OCID of the subnet in which this node is placed. example: ocid1.subnet.oc1.iad.aaaaaaaanifpelnyzmkvnepohbz4ntswkpl35syzzsugdxceth3ofzxtlyit type: string systemTags: additionalProperties: additionalProperties: description: 'The value of the tag. Only string, integer and boolean types are supported. ' type: object description: 'Key-value pair representing system tags'' keys and values scoped to a namespace. Example: `{"bar-key": "value"}` ' type: object description: 'Usage of system tag keys. These predefined keys are scoped to namespaces. Example: `{"orcl-cloud": {"free-tier-retained": "true"}}` ' type: object type: object NodePool: description: A pool of compute nodes attached to a cluster. Avoid entering confidential information. properties: clusterId: description: The OCID of the cluster to which this node pool is attached. example: ocid1.cluster.oc1.iad.aaaaaaaaga3tombrmq3wgyrvmi3gcn3bmfsdizjwgy4wgyldmy3dcmtcmmyw type: string compartmentId: description: The OCID of the compartment in which the node pool exists. example: ocid1.compartment.oc1..aaaaaaaafqm2df7ckwmmbtdsl2bgxsw4fcpvkoojytxrqst24yww2tdmtqcq type: string definedTags: additionalProperties: additionalProperties: description: 'The value of the tag. Only the String type is supported. ' type: object description: 'Key-value pair representing a defined tag key and value, scoped to a namespace. Example: `{"CostCenter": "42"}` ' type: object description: 'Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see [Resource Tags](/Content/General/Concepts/resourcetags.htm). Example: `{"Operations": {"CostCenter": "42"}}` ' example: Operations: CostCenter: 42 type: object freeformTags: additionalProperties: type: string description: 'Free-form tags for this resource. Each tag is a simple key-value pair with no predefined name, type, or namespace. For more information, see [Resource Tags](/Content/General/Concepts/resourcetags.htm). Example: `{"Department": "Finance"}` ' example: Department: Finance type: object id: description: The OCID of the node pool. example: ocid1.nodepool.oc1.iad.aaaaaaaanifpelnyzmkvnepohbz4ntswkpl35syzzsugdxceth3oihe8hcfq type: string initialNodeLabels: description: A list of key/value pairs to add to nodes after they join the Kubernetes cluster. items: $ref: '#/components/schemas/KeyValue' type: array kubernetesVersion: description: The version of Kubernetes running on the nodes in the node pool. example: v1.9.4 type: string lifecycleDetails: description: Details about the state of the nodepool. type: string lifecycleState: description: The state of the nodepool. For more information, see [Monitoring Clusters](/Content/ContEng/Tasks/contengmonitoringclusters.htm) enum: - DELETED - CREATING - ACTIVE - UPDATING - DELETING - FAILED - INACTIVE - NEEDS_ATTENTION example: ACTIVE type: string x-obmcs-top-level-enum: '#/definitions/NodePoolLifecycleState' name: description: The name of the node pool. example: My Node Pool type: string networkLaunchType: description: Emulation type for the physical network interface card (NIC) for nodes enum: - VFIO - E1000 - PARAVIRTUALIZED type: string x-obmcs-top-level-enum: '#/definitions/NetworkLaunchType' nodeConfigDetails: $ref: '#/components/schemas/NodePoolNodeConfigDetails' description: The configuration of nodes in the node pool. nodeEvictionNodePoolSettings: $ref: '#/components/schemas/NodeEvictionNodePoolSettings' nodeImageId: description: 'Deprecated. see `nodeSource`. The OCID of the image running on the nodes in the node pool. ' example: ocid1.image.oc1.phx.aaaaaaaanclh465xnfvajjojj5bbjzqytunslgvnyvf3fepiiltalnglekoa type: string nodeImageName: description: 'Deprecated. see `nodeSource`. The name of the image running on the nodes in the node pool. ' example: Oracle-Linux-7.4 type: string nodeMetadata: additionalProperties: type: string description: A list of key/value pairs to add to each underlying OCI instance in the node pool on launch. type: object nodePoolCyclingDetails: $ref: '#/components/schemas/NodePoolCyclingDetails' nodeShape: description: The name of the node shape of the nodes in the node pool. example: VM.Standard2.4 type: string nodeShapeConfig: $ref: '#/components/schemas/NodeShapeConfig' description: The shape configuration of the nodes. nodeSource: $ref: '#/components/schemas/NodeSourceOption' description: Deprecated. see `nodeSourceDetails`. Source running on the nodes in the node pool. type: object nodeSourceDetails: $ref: '#/components/schemas/NodeSourceDetails' description: Source running on the nodes in the node pool. type: object nodes: description: The nodes in the node pool. items: $ref: '#/components/schemas/Node' type: array primaryVnic: $ref: '#/components/schemas/NodePoolPrimaryVnicDetails' quantityPerSubnet: description: The number of nodes in each subnet. example: 1 format: int32 type: integer secondaryVnics: description: A list of secondary vnics to attach to nodes items: $ref: '#/components/schemas/NodePoolSecondaryVnicDetails' maxItems: 64 type: array sshPublicKey: description: The SSH public key on each node in the node pool on launch. example: ssh-rsa AAAAB3NzaC1yc2abc123... type: string subnetIds: description: The OCIDs of the subnets in which to place nodes for this node pool. items: type: string type: array systemTags: additionalProperties: additionalProperties: description: 'The value of the tag. Only string, integer and boolean types are supported. ' type: object description: 'Key-value pair representing system tags'' keys and values scoped to a namespace. Example: `{"bar-key": "value"}` ' type: object description: 'Usage of system tag keys. These predefined keys are scoped to namespaces. Example: `{"orcl-cloud": {"free-tier-retained": "true"}}` ' type: object type: object NodeEvictionSettings: description: Node Eviction Configuration properties: evictionGraceDuration: description: 'Duration after which OKE will give up eviction of the pods on the node. PT0M will indicate you want to perform node action without cordon and drain. Default PT60M, Min PT0M, Max: PT60M. Format ISO 8601 e.g PT30M ' example: PT30M type: string isForceActionAfterGraceDuration: default: false description: If the node action should be performed if not all the pods can be evicted in the grace period type: boolean type: object ClusterMigrateToNativeVcnDetails: description: The properties that define a request to migrate a cluster to Native VCN. properties: decommissionDelayDuration: description: The optional override of the non-native endpoint decommission time after migration is complete. Defaults to 30 days. example: P1DT6H format: x-obmcs-duration type: string endpointConfig: $ref: '#/components/schemas/ClusterEndpointConfig' description: 'The network configuration for access to the Cluster control plane. ' required: - endpointConfig type: object CredentialRotationStatus: description: Information regarding cluster's credential rotation. properties: status: description: 'Credential rotation status of a kubernetes cluster IN_PROGRESS: Issuing new credentials to kubernetes cluster control plane and worker nodes or retiring old credentials from kubernetes cluster control plane and worker nodes. WAITING: Waiting for customer to invoke the complete rotation action or the automcatic complete rotation action. COMPLETED: New credentials are functional on kuberentes cluster. ' enum: - IN_PROGRESS - WAITING - COMPLETED type: string statusDetails: description: 'Details of a kuberenetes cluster credential rotation status: ISSUING_NEW_CREDENTIALS: Credential rotation is in progress. Starting to issue new credentials to kubernetes cluster control plane and worker nodes. NEW_CREDENTIALS_ISSUED: New credentials are added. At this stage cluster has both old and new credentials and is awaiting old credentials retirement. RETIRING_OLD_CREDENTIALS: Retirement of old credentials is in progress. Starting to remove old credentials from kubernetes cluster control plane and worker nodes. COMPLETED: Credential rotation is complete. Old credentials are retired. ' enum: - ISSUING_NEW_CREDENTIALS - NEW_CREDENTIALS_ISSUED - RETIRING_OLD_CREDENTIALS - COMPLETED type: string timeAutoCompletionScheduled: description: The time by which retirement of old credentials should start. example: '2017-07-21T16:11:29Z' format: date-time type: string required: - status - statusDetails type: object RebootClusterNodeDetails: description: The properties that define a node reboot action. properties: nodeEvictionSettings: $ref: '#/components/schemas/NodeEvictionSettings' type: object AddonSummary: description: The properties that define an addon summary. properties: addonError: $ref: '#/components/schemas/AddonError' description: The error info of the addon. currentInstalledVersion: description: current installed version of the addon example: x.y.z type: string lifecycleState: description: The state of the addon. enum: - CREATING - ACTIVE - DELETING - DELETED - UPDATING - NEEDS_ATTENTION - FAILED example: UPDATING type: string x-obmcs-top-level-enum: '#/definitions/AddonLifecycleState' name: description: The name of the addon. example: Flannel type: string timeCreated: description: The time the cluster was created. example: '2017-07-21T16:11:29Z' format: date-time type: string version: description: selected addon version, or null indicates autoUpdate example: x.y.z type: string required: - name - lifecycleState type: object KubernetesNetworkConfig: description: The properties that define the network configuration for Kubernetes. properties: podsCidr: default: 10.244.0.0/16 description: The CIDR block for Kubernetes pods. Optional, defaults to 10.244.0.0/16. example: 10.244.0.0/16 type: string servicesCidr: default: 10.96.0.0/16 description: The CIDR block for Kubernetes services. Optional, defaults to 10.96.0.0/16. example: 10.96.0.0/16 type: string type: object UpdateClusterEndpointConfigDetails: description: The properties that define a request to update a cluster endpoint config. properties: isPublicIpEnabled: default: false description: Whether the cluster should be assigned a public IP address. Defaults to false. If set to true on a private subnet, the cluster update will fail. type: boolean nsgIds: description: 'A list of the OCIDs of the network security groups (NSGs) to apply to the cluster endpoint. For more information about NSGs, see [NetworkSecurityGroup](#/en/iaas/20160918/NetworkSecurityGroup/). ' items: maxLength: 255 minLength: 1 type: string maxItems: 5 type: array uniqueItems: true securityAttributes: additionalProperties: additionalProperties: description: 'The value of the tag. ' type: object description: 'Key-value pair representing a defined tag key and value, scoped to a [ZPR namespace](/iaas/Content/zero-trust-packet-routing/zpr-artifacts.htm#security-attribute-namespaces). ' type: object description: "[Security attributes](/iaas/Content/zero-trust-packet-routing/zpr-artifacts.htm#security-attributes) are labels\n for a resource that can be referenced in a [Zero Trust Packet Routing](/iaas/Content/zero-trust-packet-routing/overview.htm)\n (ZPR) policy to control access to ZPR-supported resources.\n" type: object type: object ClusterPodNetworkOptionDetails: description: The CNI type and relevant network details potentially applicable to the node pools of the cluster discriminator: propertyName: cniType properties: cniType: description: The CNI used by the node pools of this cluster enum: - OCI_VCN_IP_NATIVE - FLANNEL_OVERLAY maxLength: 255 minLength: 1 type: string required: - cniType NodeError: description: The properties that define an upstream error while managing a node. properties: code: description: A short error code that defines the upstream error, meant for programmatic parsing. See [API Errors](https://docs.us-phoenix-1.oraclecloud.com/Content/API/References/apierrors.htm). example: LimitExceeded type: string message: description: A human-readable error string of the upstream error. example: error validating payload type: string opc-request-id: description: Unique Oracle-assigned identifier for the upstream request. If you need to contact Oracle about a particular upstream request, please provide the request ID. example: BDA258F920471CFA70CF3655A836EAC3/AC26D111CE04292D5398192DCACCD85F/D74FF67547281CFA70CF3655A60B6DF5 type: string status: description: The status of the HTTP response encountered in the upstream error. example: '429' type: string required: - code - message type: object UpdateNodeShapeConfigDetails: allOf: - $ref: '#/components/schemas/NodeShapeConfig' description: The shape configuration of the nodes. CreateWorkloadMappingDetails: description: The properties that define a workloadMapping properties: definedTags: additionalProperties: additionalProperties: description: 'The value of the tag. Only the String type is supported. ' type: object description: 'Key-value pair representing a defined tag key and value, scoped to a namespace. Example: `{"CostCenter": "42"}` ' type: object description: 'Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see [Resource Tags](/Content/General/Concepts/resourcetags.htm). Example: `{"Operations": {"CostCenter": "42"}}` ' example: Operations: CostCenter: 42 type: object freeformTags: additionalProperties: type: string description: 'Free-form tags for this resource. Each tag is a simple key-value pair with no predefined name, type, or namespace. For more information, see [Resource Tags](/Content/General/Concepts/resourcetags.htm). Example: `{"Department": "Finance"}` ' example: Department: Finance type: object mappedCompartmentId: description: The OCID of the mapped customer compartment. example: ocid1.compartment.oc1..aaaaaaaafqm2df7ckwmmbtdsl2bgxsw4fcpvkoojytxrqst24yww2tdmtqcq type: string namespace: description: The namespace of the workloadMapping. example: kube-proxy type: string required: - namespace - mappedCompartmentId type: object WorkRequestResource: description: The properties that define a work request resource. properties: actionType: description: The way in which this resource was affected by the work tracked by the work request. enum: - CREATED - UPDATED - DELETED - RELATED - IN_PROGRESS - FAILED - CANCELED_CREATE - CANCELED_UPDATE - CANCELED_DELETE example: CREATED type: string entityType: description: The resource type the work request affects. example: cluster type: string entityUri: description: The URI path on which the user can issue a GET request to access the resource metadata. example: /20180401/clusters/ocid1.cluster.oc1.iad.aaaaaaaaga3tombrmq3wgyrvmi3gcn3bmfsdizjwgy4wgyldmy3dcmtcmmyw type: string identifier: description: The OCID of the resource the work request affects. example: ocid1.cluster.oc1.iad.aaaaaaaaga3tombrmq3wgyrvmi3gcn3bmfsdizjwgy4wgyldmy3dcmtcmmyw type: string type: object OpenIdConnectTokenAuthenticationConfig: description: 'The properties that configure OIDC token authentication in kube-apiserver. For more information, see [Configuring the API Server](https://kubernetes.io/docs/reference/access-authn-authz/authentication/#using-flags). ' properties: caCertificate: description: 'A Base64 encoded public RSA or ECDSA certificates used to signed your identity provider''s web certificate. ' minLength: 0 type: string clientId: description: 'A client id that all tokens must be issued for. ' example: kubernetes maxLength: 100 minLength: 0 type: string configurationFile: description: 'A Base64 encoded string of a Kubernetes OIDC Auth Config file. More info [here](https://kubernetes.io/docs/reference/access-authn-authz/authentication/#using-authentication-configuration) ' minLength: 0 type: string groupsClaim: description: 'JWT claim to use as the user''s group. If the claim is present it must be an array of strings. ' example: groups maxLength: 100 minLength: 0 type: string groupsPrefix: description: 'Prefix prepended to group claims to prevent clashes with existing names (such as system:groups). ' example: 'oidc:' maxLength: 100 minLength: 0 type: string isOpenIdConnectAuthEnabled: default: false description: 'Whether the cluster has OIDC Auth Config enabled. Defaults to false. ' type: boolean issuerUrl: description: "URL of the provider that allows the API server to discover public signing keys. \nOnly URLs that use the https:// scheme are accepted. This is typically the provider's discovery URL, \nchanged to have an empty path.\n" example: https://idp.com maxLength: 2048 minLength: 0 type: string requiredClaims: description: "A key=value pair that describes a required claim in the ID Token. If set, the claim is verified to be present \nin the ID Token with a matching value. Repeat this flag to specify multiple claims.\n" example: '["claim1=value1"]' items: $ref: '#/components/schemas/KeyValue' maxLength: 50 minLength: 0 type: array signingAlgorithms: description: 'The signing algorithms accepted. Default is ["RS256"]. ' items: example: '["RS256"]' maxLength: 100 minLength: 1 type: string maxLength: 10 minLength: 1 type: array usernameClaim: description: "JWT claim to use as the user name. By default sub, which is expected to be a unique identifier of the end \nuser. Admins can choose other claims, such as email or name, depending on their provider. However, claims \nother than email will be prefixed with the issuer URL to prevent naming clashes with other plugins.\n" example: sub maxLength: 100 type: string usernamePrefix: description: "Prefix prepended to username claims to prevent clashes with existing names (such as system:users). \nFor example, the value oidc: will create usernames like oidc:jane.doe. If this flag isn't provided and \n--oidc-username-claim is a value other than email the prefix defaults to ( Issuer URL )# where \n( Issuer URL ) is the value of --oidc-issuer-url. The value - can be used to disable all prefixing.\n" example: 'oidc:' maxLength: 100 minLength: 0 type: string required: - isOpenIdConnectAuthEnabled type: object UpdateWorkloadMappingDetails: description: The properties that define a workloadMapping properties: definedTags: additionalProperties: additionalProperties: description: 'The value of the tag. Only the String type is supported. ' type: object description: 'Key-value pair representing a defined tag key and value, scoped to a namespace. Example: `{"CostCenter": "42"}` ' type: object description: 'Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see [Resource Tags](/Content/General/Concepts/resourcetags.htm). Example: `{"Operations": {"CostCenter": "42"}}` ' example: Operations: CostCenter: 42 type: object freeformTags: additionalProperties: type: string description: 'Free-form tags for this resource. Each tag is a simple key-value pair with no predefined name, type, or namespace. For more information, see [Resource Tags](/Content/General/Concepts/resourcetags.htm). Example: `{"Department": "Finance"}` ' example: Department: Finance type: object mappedCompartmentId: description: The OCID of the mapped customer compartment. example: ocid1.compartment.oc1..aaaaaaaafqm2df7ckwmmbtdsl2bgxsw4fcpvkoojytxrqst24yww2tdmtqcq type: string type: object WorkloadMapping: description: The properties that define an workloadMapping. properties: clusterId: description: The OCID of the cluster. example: ocid1.cluster.oc1.iad.aaaaaaaaga3tombrmq3wgyrvmi3gcn3bmfsdizjwgy4wgyldmy3dcmtcmmyw type: string definedTags: additionalProperties: additionalProperties: description: 'The value of the tag. Only the String type is supported. ' type: object description: 'Key-value pair representing a defined tag key and value, scoped to a namespace. Example: `{"CostCenter": "42"}` ' type: object description: 'Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see [Resource Tags](/Content/General/Concepts/resourcetags.htm). Example: `{"Operations": {"CostCenter": "42"}}` ' example: Operations: CostCenter: 42 type: object freeformTags: additionalProperties: type: string description: 'Free-form tags for this resource. Each tag is a simple key-value pair with no predefined name, type, or namespace. For more information, see [Resource Tags](/Content/General/Concepts/resourcetags.htm). Example: `{"Department": "Finance"}` ' example: Department: Finance type: object id: description: The ocid of the workloadMapping. example: ocid1.workloadmapping.ocX.us-ashburn-1.xtrdsa56sjasa72321 type: string lifecycleState: description: The state of the workloadMapping. enum: - CREATING - ACTIVE - FAILED - DELETING - DELETED - UPDATING example: UPDATING type: string x-obmcs-top-level-enum: '#/definitions/WorkloadMappingLifecycleState' mappedCompartmentId: description: The OCID of the mapped customer compartment. example: ocid1.compartment.oc1..aaaaaaaafqm2df7ckwmmbtdsl2bgxsw4fcpvkoojytxrqst24yww2tdmtqcq type: string mappedTenancyId: description: The OCID of the mapped customer tenancy. example: ocid1.tenancy.oc1..aaaaaaaafqm2df7ckwmmbtdsl2bgxsw4fcpvkoojytxrqst24yww2tdmtqcq type: string namespace: description: The namespace of the workloadMapping. example: kube-proxy type: string systemTags: additionalProperties: additionalProperties: description: 'The value of the tag. Only string, integer and boolean types are supported. ' type: object description: 'Key-value pair representing system tags'' keys and values scoped to a namespace. Example: `{"bar-key": "value"}` ' type: object description: 'Usage of system tag keys. These predefined keys are scoped to namespaces. Example: `{"orcl-cloud": {"free-tier-retained": "true"}}` ' type: object timeCreated: description: The time the cluster was created. example: '2017-07-21T16:11:29Z' format: date-time type: string required: - id - clusterId - namespace - mappedTenancyId - mappedCompartmentId - timeCreated - lifecycleState type: object UpdateNodePoolNodeConfigDetails: description: The size and placement configuration of nodes in the node pool. properties: definedTags: additionalProperties: additionalProperties: description: 'The value of the tag. Only the String type is supported. ' type: object description: 'Key-value pair representing a defined tag key and value, scoped to a namespace. Example: `{"CostCenter": "42"}` ' type: object description: 'Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see [Resource Tags](/Content/General/Concepts/resourcetags.htm). Example: `{"Operations": {"CostCenter": "42"}}` ' example: Operations: CostCenter: 42 type: object freeformTags: additionalProperties: type: string description: 'Free-form tags for this resource. Each tag is a simple key-value pair with no predefined name, type, or namespace. For more information, see [Resource Tags](/Content/General/Concepts/resourcetags.htm). Example: `{"Department": "Finance"}` ' example: Department: Finance type: object isPvEncryptionInTransitEnabled: default: false description: Whether to enable in-transit encryption for the data volume's paravirtualized attachment. This field applies to both block volumes and boot volumes. The default value is false. type: boolean kmsKeyId: description: The OCID of the Key Management Service key assigned to the boot volume. type: string nodePoolPodNetworkOptionDetails: $ref: '#/components/schemas/NodePoolPodNetworkOptionDetails' description: 'The CNI related configuration of pods in the node pool. ' nsgIds: description: 'The OCIDs of the Network Security Group(s) to associate nodes for this node pool with. For more information about NSGs, see [NetworkSecurityGroup](#/en/iaas/20160918/NetworkSecurityGroup/). ' items: maxLength: 255 minLength: 1 type: string maxItems: 5 type: array uniqueItems: true placementConfigs: description: 'The placement configurations for the node pool. Provide one placement configuration for each availability domain in which you intend to launch a node. To use the node pool with a regional subnet, provide a placement configuration for each availability domain, and include the regional subnet in each placement configuration. ' items: $ref: '#/components/schemas/NodePoolPlacementConfigDetails' type: array size: description: 'The number of nodes in the node pool. ' format: int32 type: integer type: object ClusterSummary: description: The properties that define a cluster summary. properties: availableKubernetesUpgrades: description: Available Kubernetes versions to which the clusters masters may be upgraded. items: example: v1.9.4 type: string type: array clusterPodNetworkOptions: description: Available CNIs and network options for existing and new node pools of the cluster items: $ref: '#/components/schemas/ClusterPodNetworkOptionDetails' maxItems: 255 type: array uniqueItems: true x-default-description: 'null' compartmentId: description: The OCID of the compartment in which the cluster exists. example: ocid1.compartment.oc1..aaaaaaaafqm2df7ckwmmbtdsl2bgxsw4fcpvkoojytxrqst24yww2tdmtqcq type: string definedTags: additionalProperties: additionalProperties: description: 'The value of the tag. Only the String type is supported. ' type: object description: 'Key-value pair representing a defined tag key and value, scoped to a namespace. Example: `{"CostCenter": "42"}` ' type: object description: 'Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see [Resource Tags](/Content/General/Concepts/resourcetags.htm). Example: `{"Operations": {"CostCenter": "42"}}` ' example: Operations: CostCenter: 42 type: object endpointConfig: $ref: '#/components/schemas/ClusterEndpointConfig' description: 'The network configuration for access to the Cluster control plane. ' endpoints: $ref: '#/components/schemas/ClusterEndpoints' description: Endpoints served up by the cluster masters. freeformTags: additionalProperties: type: string description: 'Free-form tags for this resource. Each tag is a simple key-value pair with no predefined name, type, or namespace. For more information, see [Resource Tags](/Content/General/Concepts/resourcetags.htm). Example: `{"Department": "Finance"}` ' example: Department: Finance type: object id: description: The OCID of the cluster. example: ocid1.cluster.oc1.iad.aaaaaaaaga3tombrmq3wgyrvmi3gcn3bmfsdizjwgy4wgyldmy3dcmtcmmyw type: string imagePolicyConfig: $ref: '#/components/schemas/ImagePolicyConfig' description: 'The image verification policy for signature validation. ' kubernetesVersion: description: The version of Kubernetes running on the cluster masters. example: v1.9.4 type: string lifecycleDetails: description: Details about the state of the cluster masters. example: waiting for node pools type: string lifecycleState: description: The state of the cluster masters. For more information, see [Monitoring Clusters](/Content/ContEng/Tasks/contengmonitoringclusters.htm) enum: - CREATING - ACTIVE - FAILED - DELETING - DELETED - UPDATING example: UPDATING type: string x-obmcs-top-level-enum: '#/definitions/ClusterLifecycleState' metadata: $ref: '#/components/schemas/ClusterMetadata' description: Metadata about the cluster. name: description: The name of the cluster. example: My Cluster Summary type: string options: $ref: '#/components/schemas/ClusterCreateOptions' description: Optional attributes for the cluster. systemTags: additionalProperties: additionalProperties: description: 'The value of the tag. Only string, integer and boolean types are supported. ' type: object description: 'Key-value pair representing system tags'' keys and values scoped to a namespace. Example: `{"bar-key": "value"}` ' type: object description: 'Usage of system tag keys. These predefined keys are scoped to namespaces. Example: `{"orcl-cloud": {"free-tier-retained": "true"}}` ' type: object type: description: Type of cluster. Values can be BASIC_CLUSTER or ENHANCED_CLUSTER. For more information, see [Cluster Types](/Content/ContEng/Tasks/contengcomparingenhancedwithbasicclusters_topic.htm) enum: - BASIC_CLUSTER - ENHANCED_CLUSTER example: ENHANCED_CLUSTER type: string x-obmcs-top-level-enum: '#/definitions/ClusterType' vcnId: description: The OCID of the virtual cloud network (VCN) in which the cluster exists example: ocid1.vcn.oc1.iad.aaaaaaaa5e3hn7hk6y63awlhbvlhsumkn5p3ficbjcevbnoylvptcpkxtsaa type: string type: object ServiceLbConfigDetails: description: Configuration to be applied to load balancers created by Kubernetes services properties: backendNsgIds: description: 'A list of the OCIDs of the network security groups (NSGs) associated to backends to LBs (pods/nodes/virtual pods, etc.). Rules necessary for LB to backend communication would be added when rule management mode is set to NSG via annotations. see [NetworkSecurityGroup](#/en/iaas/20160918/NetworkSecurityGroup/). ' items: maxLength: 255 minLength: 1 type: string maxItems: 5 type: array uniqueItems: true definedTags: additionalProperties: additionalProperties: description: 'The value of the tag. Only the String type is supported. ' type: object description: 'Key-value pair representing a defined tag key and value, scoped to a namespace. Example: `{"CostCenter": "42"}` ' type: object description: 'Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see [Resource Tags](/Content/General/Concepts/resourcetags.htm). Example: `{"Operations": {"CostCenter": "42"}}` ' example: Operations: CostCenter: 42 type: object freeformTags: additionalProperties: type: string description: 'Free-form tags for this resource. Each tag is a simple key-value pair with no predefined name, type, or namespace. For more information, see [Resource Tags](/Content/General/Concepts/resourcetags.htm). Example: `{"Department": "Finance"}` ' example: Department: Finance type: object type: object VirtualNodePool: description: A pool of virtual nodes attached to a cluster. properties: clusterId: description: The cluster the virtual node pool is associated with. A virtual node pool can only be associated with one cluster. example: ocid1.cluster.oc1.iad.aaaaaaaaga3tombrmq3wgyrvmi3gcn3bmfsdizjwgy4wgyldmy3dcmtcmmyw maxLength: 255 minLength: 1 type: string compartmentId: description: Compartment of the virtual node pool. example: ocid1.compartment.oc1..aaaaaaaafqm2df7ckwmmbtdsl2bgxsw4fcpvkoojytxrqst24yww2tdmtqcq maxLength: 255 minLength: 1 type: string definedTags: additionalProperties: additionalProperties: description: 'The value of the tag. Only the String type is supported. ' type: object description: 'Key-value pair representing a defined tag key and value, scoped to a namespace. Example: `{"CostCenter": "42"}` ' type: object description: 'Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see [Resource Tags](/Content/General/Concepts/resourcetags.htm). Example: `{"Operations": {"CostCenter": "42"}}` ' example: Operations: CostCenter: 42 type: object displayName: description: Display name of the virtual node pool. This is a non-unique value. example: My Virtual Node Pool maxLength: 255 minLength: 1 type: string freeformTags: additionalProperties: type: string description: 'Free-form tags for this resource. Each tag is a simple key-value pair with no predefined name, type, or namespace. For more information, see [Resource Tags](/Content/General/Concepts/resourcetags.htm). Example: `{"Department": "Finance"}` ' example: Department: Finance type: object id: description: The OCID of the virtual node pool. example: ocid1.virtualnodepool.oc1.iad.aaaaaaaanifpelnyzmkvnepohbz4ntswkpl35syzzsugdxceth3oihe8hcfq maxLength: 255 minLength: 1 type: string initialVirtualNodeLabels: description: Initial labels that will be added to the Kubernetes Virtual Node object when it registers. This is the same as virtualNodePool resources. items: $ref: '#/components/schemas/InitialVirtualNodeLabel' type: array kubernetesVersion: description: The version of Kubernetes running on the nodes in the node pool. example: v1.9.4 maxLength: 255 minLength: 1 type: string lifecycleDetails: description: Details about the state of the Virtual Node Pool. example: updating. type: string lifecycleState: description: The state of the Virtual Node Pool. enum: - CREATING - ACTIVE - UPDATING - DELETING - DELETED - FAILED - NEEDS_ATTENTION type: string x-obmcs-top-level-enum: '#/definitions/VirtualNodePoolLifecycleState' nsgIds: description: List of network security group id's applied to the Virtual Node VNIC. items: maxLength: 255 minLength: 1 type: string maxItems: 5 type: array uniqueItems: true placementConfigurations: description: The list of placement configurations which determines where Virtual Nodes will be provisioned across as it relates to the subnet and availability domains. The size attribute determines how many we evenly spread across these placement configurations items: $ref: '#/components/schemas/PlacementConfiguration' type: array podConfiguration: $ref: '#/components/schemas/PodConfiguration' description: The pod configuration for pods run on virtual nodes of this virtual node pool. size: description: The number of Virtual Nodes that should be in the Virtual Node Pool. The placement configurations determine where these virtual nodes are placed. format: int32 minimum: 0 type: integer systemTags: additionalProperties: additionalProperties: description: 'The value of the tag. Only string, integer and boolean types are supported. ' type: object description: 'Key-value pair representing system tags'' keys and values scoped to a namespace. Example: `{"bar-key": "value"}` ' type: object description: 'Usage of system tag keys. These predefined keys are scoped to namespaces. Example: `{"orcl-cloud": {"free-tier-retained": "true"}}` ' type: object taints: description: A taint is a collection of . These taints will be applied to the Virtual Nodes of this Virtual Node Pool for Kubernetes scheduling. items: $ref: '#/components/schemas/Taint' type: array timeCreated: description: The time the virtual node pool was created. example: '2017-07-21T16:11:29Z' format: date-time type: string timeUpdated: description: The time the virtual node pool was updated. example: '2017-07-21T16:11:29Z' format: date-time type: string virtualNodePoolCyclingDetails: $ref: '#/components/schemas/VirtualNodePoolCyclingDetails' virtualNodeTags: $ref: '#/components/schemas/VirtualNodeTags' required: - id - compartmentId - clusterId - displayName - kubernetesVersion - placementConfigurations - podConfiguration - size type: object NodePoolPodNetworkOptionDetails: description: The CNI type and relevant network details for the pods of a given node pool discriminator: propertyName: cniType properties: cniType: description: The CNI plugin used by this node pool enum: - OCI_VCN_IP_NATIVE - FLANNEL_OVERLAY maxLength: 255 minLength: 1 type: string required: - cniType PlacementConfiguration: description: The information of virtual node placement in the virtual node pool. properties: availabilityDomain: description: 'The availability domain in which to place virtual nodes. Example: `Uocm:PHX-AD-1` ' maxLength: 255 minLength: 1 type: string faultDomain: description: The fault domain of this virtual node. items: maxLength: 255 minLength: 1 type: string type: array subnetId: description: The OCID of the subnet in which to place virtual nodes. maxLength: 255 minLength: 1 type: string required: - availabilityDomain - subnetId type: object StartCredentialRotationDetails: description: Properties that define a request to start credential rotation on a kubernetes cluster. properties: autoCompletionDelayDuration: description: The duration in days(in ISO 8601 notation eg. P5D) after which the old credentials should be retired. Maximum delay duration is 90 days. example: P5D maxLength: 255 minLength: 1 type: string required: - autoCompletionDelayDuration type: object VirtualNodePoolCyclingDetails: description: Virtual Node Pool Cycling Details properties: isVirtualNodeCyclingEnabled: default: false description: If virtual nodes in the virtual nodepool will be cycled to have new changes. type: boolean maximumSurge: default: '1' description: 'Maximum additional new virtual nodes that would be temporarily created and added to virtual nodepool during the cycling virtual nodepool process. OKE supports both integer and percentage input. Defaults to 1, Ranges from 0 to Virtual Nodepool size or 0% to 100% ' example: 10% maxLength: 4 minLength: 1 type: string maximumUnavailable: default: '0' description: 'Maximum active virtual nodes that would be terminated from virtual nodepool during the cycling virtual nodepool process. OKE supports both integer and percentage input. Defaults to 0, Ranges from 0 to Virtual Nodepool size or 0% to 100% ' example: '2' maxLength: 4 minLength: 1 type: string type: object VirtualNode: description: The properties that define a virtual node. properties: availabilityDomain: description: The name of the availability domain in which this virtual node is placed maxLength: 255 minLength: 1 type: string definedTags: additionalProperties: additionalProperties: description: 'The value of the tag. Only the String type is supported. ' type: object description: 'Key-value pair representing a defined tag key and value, scoped to a namespace. Example: `{"CostCenter": "42"}` ' type: object description: 'Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see [Resource Tags](/Content/General/Concepts/resourcetags.htm). Example: `{"Operations": {"CostCenter": "42"}}` ' example: Operations: CostCenter: 42 type: object displayName: description: The name of the virtual node. example: My Kubernetes virtual Node maxLength: 255 minLength: 1 type: string faultDomain: description: The fault domain of this virtual node. maxLength: 255 minLength: 1 type: string freeformTags: additionalProperties: type: string description: 'Free-form tags for this resource. Each tag is a simple key-value pair with no predefined name, type, or namespace. For more information, see [Resource Tags](/Content/General/Concepts/resourcetags.htm). Example: `{"Department": "Finance"}` ' example: Department: Finance type: object id: description: The ocid of the virtual node. example: ocid1.virtualnode.oc1.iad.aaaaaaaaga3tombrmq3wgyrvmi3gcn3bmfsdizjwgyswgycdoy3tcmtctmyw maxLength: 255 minLength: 1 type: string kubernetesVersion: description: The version of Kubernetes this virtual node is running. example: v1.9.4 maxLength: 255 minLength: 1 type: string lifecycleDetails: description: Details about the state of the Virtual Node. type: string lifecycleState: description: The state of the Virtual Node. enum: - CREATING - ACTIVE - UPDATING - DELETING - DELETED - FAILED - NEEDS_ATTENTION type: string x-obmcs-top-level-enum: '#/definitions/VirtualNodeLifecycleState' nsgIds: description: NSG Ids applied to virtual node vnic. items: maxLength: 255 minLength: 1 type: string maxItems: 5 type: array privateIp: description: The private IP address of this Virtual Node. type: string subnetId: description: The OCID of the subnet in which this Virtual Node is placed. maxLength: 255 minLength: 1 type: string systemTags: additionalProperties: additionalProperties: description: 'The value of the tag. Only string, integer and boolean types are supported. ' type: object description: 'Key-value pair representing system tags'' keys and values scoped to a namespace. Example: `{"bar-key": "value"}` ' type: object description: 'Usage of system tag keys. These predefined keys are scoped to namespaces. Example: `{"orcl-cloud": {"free-tier-retained": "true"}}` ' type: object timeCreated: description: The time at which the virtual node was created. example: '2017-07-21T16:11:29Z' format: date-time type: string virtualNodeError: description: An error that may be associated with the virtual node. type: string virtualNodePoolId: description: The ocid of the virtual node pool this virtual node belongs to. example: ocid1.virtualnodepool.oc1.iad.aaaaaaaanifpelnyzmkvnepohbz4ntswkpl35syzzsugdxceth3oihe8hcfq maxLength: 255 minLength: 1 type: string required: - id - virtualNodePoolId - displayName type: object WorkRequestError: description: Errors related to a specific work request. properties: code: description: A short error code that defines the error, meant for programmatic parsing. See [API Errors](https://docs.us-phoenix-1.oraclecloud.com/Content/API/References/apierrors.htm). example: UnknownError type: string message: description: A human-readable error string. example: error validating payload type: string timestamp: description: The date and time the error occurred. example: '2017-07-21T16:11:29Z' format: date-time type: string required: - code - message - timestamp type: object OpenIdConnectDiscovery: description: 'The property that define the status of the OIDC Discovery feature for a cluster. ' properties: isOpenIdConnectDiscoveryEnabled: default: false description: 'Whether the cluster has OIDC Discovery enabled. Defaults to false. If set to true, the cluster will be assigned a public OIDC Discovery endpoint. ' type: boolean type: object UpdateImagePolicyConfigDetails: allOf: - $ref: '#/components/schemas/ImagePolicyConfig' description: The properties that define a image verification policy. CreateVnicDetails: description: The properties of the secondary vnics properties: applicationResources: description: 'The application resource that corresponds to this secondary vnic. Used to map pods to this specific vnic for scheduling ' items: maxLength: 255 minLength: 1 type: string maxItems: 1 type: array uniqueItems: true assignIpv6Ip: description: 'Whether to allocate an IPv6 address at instance and VNIC creation from an IPv6 enabled subnet ' type: boolean assignPublicIp: description: 'Whether the VNIC should be assigned a public IP address ' type: boolean definedTags: additionalProperties: additionalProperties: description: 'The value of the tag. Only the String type is supported. ' type: object description: 'Key-value pair representing a defined tag key and value, scoped to a namespace. Example: `{"CostCenter": "42"}` ' type: object description: 'Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see [Resource Tags](/Content/General/Concepts/resourcetags.htm). Example: `{"Operations": {"CostCenter": "42"}}` ' example: Operations: CostCenter: 42 type: object displayName: description: Display name for secondary vnic maxLength: 255 minLength: 1 type: string freeformTags: additionalProperties: type: string description: 'Free-form tags for this resource. Each tag is a simple key-value pair with no predefined name, type, or namespace. For more information, see [Resource Tags](/Content/General/Concepts/resourcetags.htm). Example: `{"Department": "Finance"}` ' example: Department: Finance type: object ipCount: description: 'The number of ip addresses to attach to secondary vnic ' minimum: 1 type: integer x-default-description: when unspecified, ipCount will default to 256 when an ipv6 single stack subnet is specified and default to 32 in all other cases ipv6AddressIpv6SubnetCidrPairDetails: description: "A list of IPv6 prefixes from which the VNIC should be assigned an IPv6 address. You can provide only the prefix \nand OCI selects an available address from the range. You can optionally choose to leave the prefix range empty \nand instead provide the specific IPv6 address that should be used from within that range.\n" items: $ref: '#/components/schemas/Ipv6AddressIpv6SubnetCidrPairDetails' type: array nsgIds: description: 'A list of the OCIDs of the network security groups (NSGs) to add the VNIC to ' items: maxLength: 255 minLength: 1 type: string maxItems: 5 type: array uniqueItems: true securityAttributes: additionalProperties: additionalProperties: description: 'The value of the tag. ' type: object description: 'Key-value pair representing a defined tag key and value, scoped to a [ZPR namespace](/iaas/Content/zero-trust-packet-routing/zpr-artifacts.htm#security-attribute-namespaces). ' type: object description: "[Security attributes](/iaas/Content/zero-trust-packet-routing/zpr-artifacts.htm#security-attributes) are labels\n for a resource that can be referenced in a [Zero Trust Packet Routing](/iaas/Content/zero-trust-packet-routing/overview.htm)\n (ZPR) policy to control access to ZPR-supported resources.\n" type: object skipSourceDestCheck: description: 'Whether the source/destination check is disabled on the VNIC ' type: boolean subnetId: description: the ocid of the subnet to create the vnic in maxLength: 255 minLength: 1 type: string required: - subnetId type: object CreateClusterKubeconfigContentDetails: description: The properties that define a request to create a cluster kubeconfig. properties: endpoint: description: The endpoint to target. A cluster may have multiple endpoints exposed but the kubeconfig can only target one at a time. enum: - LEGACY_KUBERNETES - PUBLIC_ENDPOINT - PRIVATE_ENDPOINT - VCN_HOSTNAME example: PUBLIC_ENDPOINT type: string expiration: description: 'Deprecated. This field is no longer used. ' example: null type: integer x-default-description: null tokenVersion: default: 2.0.0 description: 'The version of the kubeconfig token. Supported value 2.0.0 ' example: 2.0.0 type: string type: object VirtualNodeTags: description: The tags associated to the virtual nodes in this virtual node pool. properties: definedTags: additionalProperties: additionalProperties: description: 'The value of the tag. Only the String type is supported. ' type: object description: 'Key-value pair representing a defined tag key and value, scoped to a namespace. Example: `{"CostCenter": "42"}` ' type: object description: 'Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see [Resource Tags](/Content/General/Concepts/resourcetags.htm). Example: `{"Operations": {"CostCenter": "42"}}` ' example: Operations: CostCenter: 42 type: object freeformTags: additionalProperties: type: string description: 'Free-form tags for this resource. Each tag is a simple key-value pair with no predefined name, type, or namespace. For more information, see [Resource Tags](/Content/General/Concepts/resourcetags.htm). Example: `{"Department": "Finance"}` ' example: Department: Finance type: object type: object ReplaceBootVolumeClusterNodeDetails: description: The properties that define a node boot volume replacement action. properties: nodeEvictionSettings: $ref: '#/components/schemas/NodeEvictionSettings' type: object UpdateClusterDetails: description: The properties that define a request to update a cluster. properties: definedTags: additionalProperties: additionalProperties: description: 'The value of the tag. Only the String type is supported. ' type: object description: 'Key-value pair representing a defined tag key and value, scoped to a namespace. Example: `{"CostCenter": "42"}` ' type: object description: 'Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see [Resource Tags](/Content/General/Concepts/resourcetags.htm). Example: `{"Operations": {"CostCenter": "42"}}` ' example: Operations: CostCenter: 42 type: object freeformTags: additionalProperties: type: string description: 'Free-form tags for this resource. Each tag is a simple key-value pair with no predefined name, type, or namespace. For more information, see [Resource Tags](/Content/General/Concepts/resourcetags.htm). Example: `{"Department": "Finance"}` ' example: Department: Finance type: object imagePolicyConfig: $ref: '#/components/schemas/UpdateImagePolicyConfigDetails' description: 'The image verification policy for signature validation. Once a policy is created and enabled with one or more kms keys, the policy will ensure all images deployed has been signed with the key(s) attached to the policy. ' kubernetesVersion: description: The version of Kubernetes to which the cluster masters should be upgraded. example: v1.9.4 type: string name: description: The new name for the cluster. Avoid entering confidential information. example: My Updated Cluster type: string options: $ref: '#/components/schemas/UpdateClusterOptionsDetails' type: description: Type of cluster enum: - BASIC_CLUSTER - ENHANCED_CLUSTER example: ENHANCED_CLUSTER type: string x-obmcs-top-level-enum: '#/definitions/ClusterType' type: object CycleMode: description: "BOOT_VOLUME_REPLACE cycling swaps the boot volume on the same node, while INSTANCE_REPLACE cycling deletes and recreates a new node with the changes applied.\nOnly a subset of fields (kubernetesVersion, imageId, bootVolumeSizeInGBs, nodeMetadata, sshPublicKey) can be changed with BOOT_VOLUME_REPLACE cycling. \nThe cycling operation will attempt to bring all nodes in the NodePool in sync with the NodePool specification. If BOOT_VOLUME_REPLACE cycling mode is chosen, and the node needs changes to fields that can not be updated via a BOOT_VOLUME_REPLACE cycle, the cycle attempt for that node will fail. The operation has to be retried with cycle mode changed to INSTANCE_REPLACE in this case.\n" enum: - BOOT_VOLUME_REPLACE - INSTANCE_REPLACE type: string NodePoolCyclingDetails: description: Node Pool Cycling Details properties: cycleModes: description: "An ordered list of cycle modes that should be performed on the OKE nodes. \n" items: $ref: '#/components/schemas/CycleMode' maxItems: 1 type: array isNodeCyclingEnabled: default: false description: If cycling operation should be performed on the nodes in the node pool. type: boolean maximumSurge: default: '1' description: 'Maximum additional new compute instances that would be temporarily created and added to nodepool during the cycling nodepool process. OKE supports both integer and percentage input. Defaults to 1, Ranges from 0 to Nodepool size or 0% to 100% ' example: 10% maxLength: 4 minLength: 1 type: string maximumUnavailable: default: '0' description: 'Maximum active nodes that would be terminated from nodepool during the cycling nodepool process. OKE supports both integer and percentage input. Defaults to 0, Ranges from 0 to Nodepool size or 0% to 100% ' example: '2' maxLength: 4 minLength: 1 type: string type: object NodePoolSecondaryVnicDetails: description: Details for secondary vnic attachments to Nodes properties: createVnicDetails: $ref: '#/components/schemas/CreateVnicDetails' displayName: description: Display name for vnic attachment maxLength: 255 minLength: 1 type: string nicIndex: description: Which physical network interface card (NIC) the VNIC will use maximum: 31 minimum: 0 type: integer required: - createVnicDetails type: object UpdateAddonDetails: description: The properties that define to update addon details. properties: configurations: description: Addon configuration details. items: $ref: '#/components/schemas/AddonConfiguration' type: array version: description: The version of the installed addon. example: 2.2.2 type: string type: object ClusterMetadata: description: The properties that define meta data for a cluster. properties: createdByUserId: description: The user who created the cluster. example: ocid1.user.oc1..aaaaaaaanifpelnyzmkvnepohbz4ntswkpl35syzzsugdxceth3oihe8hcfq type: string createdByWorkRequestId: description: The OCID of the work request which created the cluster. example: ocid1.clustersworkrequest.oc1.iad.aaaaaaaanifpelnyzmkvnepohbz4ntswkpl35syzzsugdxceth3oihe8hcfq type: string deletedByUserId: description: The user who deleted the cluster. example: ocid1.user.oc1..aaaaaaaanifpelnyzmkvnepohbz4ntswkpl35syzzsugdxceth3oihe8hcfq type: string deletedByWorkRequestId: description: The OCID of the work request which deleted the cluster. example: ocid1.clustersworkrequest.oc1.iad.aaaaaaaanifpelnyzmkvnepohbz4ntswkpl35syzzsugdxceth3oihe8hcfq type: string timeCreated: description: The time the cluster was created. example: '2017-07-21T16:11:29Z' format: date-time type: string timeCredentialExpiration: description: The time until which the cluster credential is valid. example: '2023-07-21T16:11:29Z' format: date-time type: string timeDeleted: description: The time the cluster was deleted. example: '2017-07-21T16:11:29Z' format: date-time type: string timeUpdated: description: The time the cluster was updated. example: '2017-07-21T16:11:29Z' format: date-time type: string updatedByUserId: description: The user who updated the cluster. example: ocid1.user.oc1..aaaaaaaanifpelnyzmkvnepohbz4ntswkpl35syzzsugdxceth3oihe8hcfq type: string updatedByWorkRequestId: description: The OCID of the work request which updated the cluster. example: ocid1.clustersworkrequest.oc1.iad.aaaaaaaanifpelnyzmkvnepohbz4ntswkpl35syzzsugdxceth3oihe8hcfq type: string type: object NodeSourceDetails: description: The details of the node's source. discriminator: propertyName: sourceType properties: sourceType: description: 'The source type for the node. Use `IMAGE` when specifying an OCID of an image. ' enum: - IMAGE type: string x-obmcs-top-level-enum: '#/definitions/NodeSourceType' required: - sourceType NodeShapeConfig: description: The shape configuration of the nodes. properties: memoryInGBs: description: 'The total amount of memory available to each node, in gigabytes. ' format: float minimum: 0.0 type: number x-default-description: 'null' ocpus: description: 'The total number of OCPUs available to each node in the node pool. See [here](https://docs.cloud.oracle.com/en-us/iaas/api/#/en/iaas/20160918/Shape/) for details. ' format: float minimum: 0.0 type: number AddonVersionConfiguration: description: Addon version configuration details. properties: description: description: Information about the addon version configuration. example: Addon version configuration information type: string displayName: description: Display name of addon version. example: LabelName type: string isRequired: description: If the the configuration is required or not. example: true type: boolean key: description: Addon configuration key example: labels type: string value: description: Addon configuration value example: value type: string type: object ClusterCreateOptions: description: The properties that define extra options for a cluster. properties: addOns: $ref: '#/components/schemas/AddOnOptions' description: Configurable cluster add-ons admissionControllerOptions: $ref: '#/components/schemas/AdmissionControllerOptions' description: Configurable cluster admission controllers ipFamilies: description: IP family to use for single stack or define the order of IP families for dual-stack items: enum: - IPv4 - IPv6 type: string type: array x-default-description: Default legacy behavior will be just IPv4 when property not provided kubernetesNetworkConfig: $ref: '#/components/schemas/KubernetesNetworkConfig' description: Network configuration for Kubernetes. openIdConnectDiscovery: $ref: '#/components/schemas/OpenIdConnectDiscovery' openIdConnectTokenAuthenticationConfig: $ref: '#/components/schemas/OpenIdConnectTokenAuthenticationConfig' persistentVolumeConfig: $ref: '#/components/schemas/PersistentVolumeConfigDetails' serviceLbConfig: $ref: '#/components/schemas/ServiceLbConfigDetails' serviceLbSubnetIds: description: The OCIDs of the subnets used for Kubernetes services load balancers. items: example: ocid1.subnet.oc1.iad.aaaaaaaanifpelnyzmkvnepohbz4ntswkpl35syzzsugdxceth3ofzxtlyit type: string type: array type: object AddonError: description: The error info of the addon. properties: code: description: A short error code that defines the upstream error, meant for programmatic parsing. See [API Errors](https://docs.us-phoenix-1.oraclecloud.com/Content/API/References/apierrors.htm). example: LimitExceeded type: string message: description: A human-readable error string of the upstream error. example: error validating payload type: string status: description: The status of the HTTP response encountered in the upstream error. example: '429' type: string type: object NodeEvictionNodePoolSettings: description: Node Eviction Details configuration properties: evictionGraceDuration: description: 'Duration after which OKE will give up eviction of the pods on the node. PT0M will indicate you want to delete the node without cordon and drain. Default PT60M, Min PT0M, Max: PT60M. Format ISO 8601 e.g PT30M ' example: PT30M type: string isForceActionAfterGraceDuration: default: false description: If the node action should be performed if not all the pods can be evicted in the grace period type: boolean isForceDeleteAfterGraceDuration: default: false description: If the underlying compute instance should be deleted if you cannot evict all the pods in grace period type: boolean type: object NodePoolPrimaryVnicDetails: description: Details for node's primary VNIC properties: securityAttributes: additionalProperties: additionalProperties: description: 'The value of the tag. ' type: object description: 'Key-value pair representing a defined tag key and value, scoped to a [ZPR namespace](/iaas/Content/zero-trust-packet-routing/zpr-artifacts.htm#security-attribute-namespaces). ' type: object description: "[Security attributes](/iaas/Content/zero-trust-packet-routing/zpr-artifacts.htm#security-attributes) are labels\n for a resource that can be referenced in a [Zero Trust Packet Routing](/iaas/Content/zero-trust-packet-routing/overview.htm)\n (ZPR) policy to control access to ZPR-supported resources.\n" type: object type: object ShapeOcpuOptions: description: Properties of OCPUs. properties: max: description: The maximum number of OCPUs. format: float minimum: 0.0 type: number min: description: The minimum number of OCPUs. format: float minimum: 0.0 type: number type: object ClusterEndpointConfig: description: The properties that define the network configuration for the Cluster endpoint. properties: isPublicIpEnabled: default: false description: Whether the cluster should be assigned a public IP address. Defaults to false. If set to true on a private subnet, the cluster provisioning will fail. type: boolean nsgIds: description: 'A list of the OCIDs of the network security groups (NSGs) to apply to the cluster endpoint. For more information about NSGs, see [NetworkSecurityGroup](#/en/iaas/20160918/NetworkSecurityGroup/). ' items: maxLength: 255 minLength: 1 type: string maxItems: 5 type: array uniqueItems: true securityAttributes: additionalProperties: additionalProperties: description: 'The value of the tag. ' type: object description: 'Key-value pair representing a defined tag key and value, scoped to a [ZPR namespace](/iaas/Content/zero-trust-packet-routing/zpr-artifacts.htm#security-attribute-namespaces). ' type: object description: "[Security attributes](/iaas/Content/zero-trust-packet-routing/zpr-artifacts.htm#security-attributes) are labels\n for a resource that can be referenced in a [Zero Trust Packet Routing](/iaas/Content/zero-trust-packet-routing/overview.htm)\n (ZPR) policy to control access to ZPR-supported resources.\n" type: object subnetId: description: The OCID of the regional subnet in which to place the Cluster endpoint. type: string type: object InitialVirtualNodeLabel: description: The properties that define a key value pair. properties: key: description: The key of the pair. example: mykey type: string value: description: The value of the pair. example: myvalue type: string type: object responses: NoEtagMatch: description: Precondition Failed headers: opc-request-id: description: Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. schema: type: string content: application/json: schema: $ref: '#/components/schemas/Error' NotAuthenticated: description: Unauthorized headers: opc-request-id: description: Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. schema: type: string content: application/json: schema: $ref: '#/components/schemas/Error' DefaultError: description: An error has occurred. headers: opc-request-id: description: Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. schema: type: string content: application/json: schema: $ref: '#/components/schemas/Error' BadRequest: description: Bad Request headers: opc-request-id: description: Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. schema: type: string content: application/json: schema: $ref: '#/components/schemas/Error' InternalServerError: description: Internal Server Error headers: opc-request-id: description: Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. schema: type: string content: application/json: schema: $ref: '#/components/schemas/Error' IncorrectState: description: Conflict headers: opc-request-id: description: Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. schema: type: string content: application/json: schema: $ref: '#/components/schemas/Error' NotAuthorizedOrNotFound: description: Not Found headers: opc-request-id: description: Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. schema: type: string content: application/json: schema: $ref: '#/components/schemas/Error' TooManyRequests: description: Too Many Requests headers: opc-request-id: description: Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. schema: type: string content: application/json: schema: $ref: '#/components/schemas/Error' Accepted: description: Accepted headers: opc-request-id: description: Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. schema: type: string opc-work-request-id: description: The OCID of the work request handling the operation. schema: type: string x-obmcs-client-retries-enabled: true x-properties: definedTags: additionalProperties: additionalProperties: description: 'The value of the tag. Only the String type is supported. ' type: object description: 'Key-value pair representing a defined tag key and value, scoped to a namespace. Example: `{"CostCenter": "42"}` ' type: object description: 'Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see [Resource Tags](/Content/General/Concepts/resourcetags.htm). Example: `{"Operations": {"CostCenter": "42"}}` ' example: Operations: CostCenter: 42 type: object freeformTags: additionalProperties: type: string description: 'Free-form tags for this resource. Each tag is a simple key-value pair with no predefined name, type, or namespace. For more information, see [Resource Tags](/Content/General/Concepts/resourcetags.htm). Example: `{"Department": "Finance"}` ' example: Department: Finance type: object securityAttributes: additionalProperties: additionalProperties: description: 'The value of the tag. ' type: object description: 'Key-value pair representing a defined tag key and value, scoped to a [ZPR namespace](/iaas/Content/zero-trust-packet-routing/zpr-artifacts.htm#security-attribute-namespaces). ' type: object description: "[Security attributes](/iaas/Content/zero-trust-packet-routing/zpr-artifacts.htm#security-attributes) are labels\n for a resource that can be referenced in a [Zero Trust Packet Routing](/iaas/Content/zero-trust-packet-routing/overview.htm)\n (ZPR) policy to control access to ZPR-supported resources.\n" type: object systemTags: additionalProperties: additionalProperties: description: 'The value of the tag. Only string, integer and boolean types are supported. ' type: object description: 'Key-value pair representing system tags'' keys and values scoped to a namespace. Example: `{"bar-key": "value"}` ' type: object description: 'Usage of system tag keys. These predefined keys are scoped to namespaces. Example: `{"orcl-cloud": {"free-tier-retained": "true"}}` ' type: object