Skip to content

Container Engine for Kubernetes: Cluster

Manage OCI Container Engine for Kubernetes clusters. This page is generated from checked-in package metadata, CRD schemas, and sample manifests.

Resource Snapshot

Field Value
Service containerengine
Resource Cluster
API Version containerengine.oracle.com/v1beta1
Package Container Engine for Kubernetes
Support Status Preview
Latest Released Version v2.1.0-alpha
Install Namespace oci-service-operator-containerengine-system

Spec Fields

This summary shows the top-level spec fields. Use the full API reference for nested fields, defaults, and enum values.

Field Description Type Required
clusterPodNetworkOptions Available CNIs and network options for existing and new node pools of the cluster list[object] No
compartmentId The OCID of the compartment in which to create the cluster. string Yes
definedTags Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see Resource Tags (https://docs.oracle.com/iaas/Content/General/Concepts/resourcetags.htm). Example: {"Operations": {"CostCenter": "42"}} map[string, map[string, string]] No
endpointConfig The network configuration for access to the Cluster control plane. object No
freeformTags 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 (https://docs.oracle.com/iaas/Content/General/Concepts/resourcetags.htm). Example: {"Department": "Finance"} map[string, string] No
imagePolicyConfig 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. object No
kmsKeyId 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. string No
kubernetesVersion The version of Kubernetes to install into the cluster masters. string Yes
name The name of the cluster. Avoid entering confidential information. string Yes
options Optional attributes for the cluster. object No
type Type of cluster string No
vcnId The OCID of the virtual cloud network (VCN) in which to create the cluster. string Yes

Status Fields

This summary shows the top-level status fields. Use the full API reference for nested fields, defaults, and enum values.

Field Description Type Required
availableKubernetesUpgrades Available Kubernetes versions to which the clusters masters may be upgraded. list[string] No
clusterPodNetworkOptions Available CNIs and network options for existing and new node pools of the cluster list[object] No
compartmentId The OCID of the compartment in which the cluster exists. string No
definedTags Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see Resource Tags (https://docs.oracle.com/iaas/Content/General/Concepts/resourcetags.htm). Example: {"Operations": {"CostCenter": "42"}} map[string, map[string, string]] No
endpointConfig The network configuration for access to the Cluster control plane. object No
endpoints Endpoints served up by the cluster masters. object No
freeformTags 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 (https://docs.oracle.com/iaas/Content/General/Concepts/resourcetags.htm). Example: {"Department": "Finance"} map[string, string] No
id The OCID of the cluster. string No
imagePolicyConfig The image verification policy for signature validation. object No
kmsKeyId The OCID of the KMS key to be used as the master encryption key for Kubernetes secret encryption. string No
kubernetesVersion The version of Kubernetes running on the cluster masters. string No
lifecycleDetails Details about the state of the cluster masters. string No
lifecycleState The state of the cluster masters. For more information, see Monitoring Clusters (https://docs.oracle.com/iaas/Content/ContEng/Tasks/contengmonitoringclusters.htm) string No
metadata Metadata about the cluster. object No
name The name of the cluster. string No
openIdConnectDiscoveryEndpoint The cluster-specific OpenID Connect Discovery endpoint string No
openIdConnectDiscoveryKey The cluster-specific OpenID Connect Discovery Key to derive the DiscoveryEndpoint string No
options Optional attributes for the cluster. object No
status - object Yes
systemTags Usage of system tag keys. These predefined keys are scoped to namespaces. Example: {"orcl-cloud": {"free-tier-retained": "true"}} map[string, map[string, string]] No
type Type of cluster string No
vcnId The OCID of the virtual cloud network (VCN) in which the cluster exists. string No

Sample Manifest

This example is generated from the checked-in sample manifest at config/samples/containerengine_v1beta1_cluster.yaml. Replace placeholder values before applying it.

Open the rendered sample page

#
# Copyright (c) 2021, Oracle and/or its affiliates. All rights reserved.
# Licensed under the Universal Permissive License v 1.0 as shown at http://oss.oracle.com/licenses/upl.
#

#
# Replace the OCI identifiers below before running e2e.
# Update metadata.name and spec.name if you want to force a fresh create instead of
# binding to an existing Cluster with the same name in the same compartment.
# Replace spec.kubernetesVersion with a currently supported OKE version for your
# region before running this sample.
#
apiVersion: containerengine.oracle.com/v1beta1
kind: Cluster
metadata:
  name: cluster-sample
spec:
  name: "cluster-sample"
  compartmentId: ocid1.compartment.oc1..exampleuniqueID
  vcnId: ocid1.vcn.oc1..exampleuniqueID
  kubernetesVersion: "v1.30.1"
  endpointConfig:
    subnetId: ocid1.subnet.oc1..exampleuniqueID
    nsgIds:
      - ocid1.networksecuritygroup.oc1..exampleuniqueID
    isPublicIpEnabled: false
  options:
    serviceLbSubnetIds:
      - ocid1.subnet.oc1..exampleuniqueID