containerengine.oracle.com/v1beta1
Back to API Reference
APIVersion: containerengine.oracle.com/v1beta1
This content is generated from the checked-in CRD schemas in config/crd/bases/. If a description is missing or incorrect, fix the source comments or generator inputs and rerun make generate manifests; do not hand-edit config/crd/bases/*.yaml.
Packages
No customer-visible package currently exposes containerengine.oracle.com/v1beta1.
Resources
Cluster
Manage OCI Container Engine for Kubernetes clusters.
Plural: clustersScope: NamespacedAPIVersion: containerengine.oracle.com/v1beta1Sample: Sample (config/samples/containerengine_v1beta1_cluster.yaml)Packages: Not currently exposed by a customer-visible package.
Spec
ClusterSpec defines the desired state of Cluster.
| Field |
Description |
Type |
Required |
Default |
Enum |
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 |
- |
- |
Spec.clusterPodNetworkOptions[]
Back to Cluster spec
ClusterPodNetworkOption defines nested fields for Cluster.ClusterPodNetworkOption.
| Field |
Description |
Type |
Required |
Default |
Enum |
cniType |
- |
string |
No |
- |
- |
jsonData |
- |
string |
No |
- |
- |
Spec.endpointConfig
Back to Cluster spec
The network configuration for access to the Cluster control plane.
| Field |
Description |
Type |
Required |
Default |
Enum |
isPublicIpEnabled |
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. |
boolean |
No |
- |
- |
nsgIds |
A list of the OCIDs of the network security groups (NSGs) to apply to the cluster endpoint. For more information about NSGs, see NetworkSecurityGroup. |
list[string] |
No |
- |
- |
subnetId |
The OCID of the regional subnet in which to place the Cluster endpoint. |
string |
No |
- |
- |
Spec.imagePolicyConfig
Back to Cluster spec
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.
| Field |
Description |
Type |
Required |
Default |
Enum |
isPolicyEnabled |
Whether the image verification policy is enabled. Defaults to false. If set to true, the images will be verified against the policy at runtime. |
boolean |
No |
- |
- |
keyDetails |
A list of KMS key details. |
list[object] |
No |
- |
- |
Spec.imagePolicyConfig.keyDetails[]
Back to Cluster spec
ClusterImagePolicyConfigKeyDetail defines nested fields for Cluster.ImagePolicyConfig.KeyDetail.
| Field |
Description |
Type |
Required |
Default |
Enum |
kmsKeyId |
The OCIDs of the KMS key that will be used to verify whether the images are signed by an approved source. |
string |
No |
- |
- |
Spec.options
Back to Cluster spec
Optional attributes for the cluster.
| Field |
Description |
Type |
Required |
Default |
Enum |
addOns |
Configurable cluster add-ons |
object |
No |
- |
- |
admissionControllerOptions |
Configurable cluster admission controllers |
object |
No |
- |
- |
ipFamilies |
IP family to use for single stack or define the order of IP families for dual-stack |
list[string] |
No |
- |
- |
kubernetesNetworkConfig |
Network configuration for Kubernetes. |
object |
No |
- |
- |
openIdConnectDiscovery |
ClusterOptionsOpenIdConnectDiscovery defines nested fields for Cluster.Options.OpenIdConnectDiscovery. |
object |
No |
- |
- |
openIdConnectTokenAuthenticationConfig |
ClusterOptionsOpenIdConnectTokenAuthenticationConfig defines nested fields for Cluster.Options.OpenIdConnectTokenAuthenticationConfig. |
object |
No |
- |
- |
persistentVolumeConfig |
ClusterOptionsPersistentVolumeConfig defines nested fields for Cluster.Options.PersistentVolumeConfig. |
object |
No |
- |
- |
serviceLbConfig |
ClusterOptionsServiceLbConfig defines nested fields for Cluster.Options.ServiceLbConfig. |
object |
No |
- |
- |
serviceLbSubnetIds |
The OCIDs of the subnets used for Kubernetes services load balancers. |
list[string] |
No |
- |
- |
Spec.options.addOns
Back to Cluster spec
Configurable cluster add-ons
| Field |
Description |
Type |
Required |
Default |
Enum |
isKubernetesDashboardEnabled |
Whether or not to enable the Kubernetes Dashboard add-on. |
boolean |
No |
- |
- |
isTillerEnabled |
Whether or not to enable the Tiller add-on. |
boolean |
No |
- |
- |
Spec.options.admissionControllerOptions
Back to Cluster spec
Configurable cluster admission controllers
| Field |
Description |
Type |
Required |
Default |
Enum |
isPodSecurityPolicyEnabled |
Whether or not to enable the Pod Security Policy admission controller. |
boolean |
No |
- |
- |
Spec.options.kubernetesNetworkConfig
Back to Cluster spec
Network configuration for Kubernetes.
| Field |
Description |
Type |
Required |
Default |
Enum |
podsCidr |
The CIDR block for Kubernetes pods. Optional, defaults to 10.244.0.0/16. |
string |
No |
- |
- |
servicesCidr |
The CIDR block for Kubernetes services. Optional, defaults to 10.96.0.0/16. |
string |
No |
- |
- |
Spec.options.openIdConnectDiscovery
Back to Cluster spec
ClusterOptionsOpenIdConnectDiscovery defines nested fields for Cluster.Options.OpenIdConnectDiscovery.
| Field |
Description |
Type |
Required |
Default |
Enum |
isOpenIdConnectDiscoveryEnabled |
Whether the cluster has OIDC Discovery enabled. Defaults to false. If set to true, the cluster will be assigned a public OIDC Discovery endpoint. |
boolean |
No |
- |
- |
Spec.options.openIdConnectTokenAuthenticationConfig
Back to Cluster spec
ClusterOptionsOpenIdConnectTokenAuthenticationConfig defines nested fields for Cluster.Options.OpenIdConnectTokenAuthenticationConfig.
| Field |
Description |
Type |
Required |
Default |
Enum |
caCertificate |
A Base64 encoded public RSA or ECDSA certificates used to signed your identity provider's web certificate. |
string |
No |
- |
- |
clientId |
A client id that all tokens must be issued for. |
string |
No |
- |
- |
configurationFile |
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) |
string |
No |
- |
- |
groupsClaim |
JWT claim to use as the user's group. If the claim is present it must be an array of strings. |
string |
No |
- |
- |
groupsPrefix |
Prefix prepended to group claims to prevent clashes with existing names (such as system:groups). |
string |
No |
- |
- |
isOpenIdConnectAuthEnabled |
Whether the cluster has OIDC Auth Config enabled. Defaults to false. |
boolean |
Yes |
- |
- |
issuerUrl |
URL of the provider that allows the API server to discover public signing keys. Only URLs that use the https:// scheme are accepted. This is typically the provider's discovery URL, changed to have an empty path. |
string |
No |
- |
- |
requiredClaims |
A key=value pair that describes a required claim in the ID Token. If set, the claim is verified to be present in the ID Token with a matching value. Repeat this flag to specify multiple claims. |
list[object] |
No |
- |
- |
signingAlgorithms |
The signing algorithms accepted. Default is ["RS256"]. |
list[string] |
No |
- |
- |
usernameClaim |
JWT claim to use as the user name. By default sub, which is expected to be a unique identifier of the end user. Admins can choose other claims, such as email or name, depending on their provider. However, claims other than email will be prefixed with the issuer URL to prevent naming clashes with other plugins. |
string |
No |
- |
- |
usernamePrefix |
Prefix prepended to username claims to prevent clashes with existing names (such as system:users). For example, the value oidc: will create usernames like oidc:jane.doe. If this flag isn't provided and --oidc-username-claim is a value other than email the prefix defaults to ( Issuer URL )# where ( Issuer URL ) is the value of --oidc-issuer-url. The value - can be used to disable all prefixing. |
string |
No |
- |
- |
Spec.options.openIdConnectTokenAuthenticationConfig.requiredClaims[]
Back to Cluster spec
ClusterOptionsOpenIdConnectTokenAuthenticationConfigRequiredClaim defines nested fields for Cluster.Options.OpenIdConnectTokenAuthenticationConfig.RequiredClaim.
| Field |
Description |
Type |
Required |
Default |
Enum |
key |
The key of the pair. |
string |
No |
- |
- |
value |
The value of the pair. |
string |
No |
- |
- |
Spec.options.persistentVolumeConfig
Back to Cluster spec
ClusterOptionsPersistentVolumeConfig defines nested fields for Cluster.Options.PersistentVolumeConfig.
| Field |
Description |
Type |
Required |
Default |
Enum |
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 |
- |
- |
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 |
- |
- |
Spec.options.serviceLbConfig
Back to Cluster spec
ClusterOptionsServiceLbConfig defines nested fields for Cluster.Options.ServiceLbConfig.
| Field |
Description |
Type |
Required |
Default |
Enum |
backendNsgIds |
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. |
list[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 |
- |
- |
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 |
- |
- |
Status
ClusterStatus defines the observed state of Cluster.
| Field |
Description |
Type |
Required |
Default |
Enum |
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 |
- |
- |
Status.clusterPodNetworkOptions[]
Back to Cluster status
ClusterPodNetworkOption defines nested fields for Cluster.ClusterPodNetworkOption.
| Field |
Description |
Type |
Required |
Default |
Enum |
cniType |
- |
string |
No |
- |
- |
jsonData |
- |
string |
No |
- |
- |
Status.endpointConfig
Back to Cluster status
The network configuration for access to the Cluster control plane.
| Field |
Description |
Type |
Required |
Default |
Enum |
isPublicIpEnabled |
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. |
boolean |
No |
- |
- |
nsgIds |
A list of the OCIDs of the network security groups (NSGs) to apply to the cluster endpoint. For more information about NSGs, see NetworkSecurityGroup. |
list[string] |
No |
- |
- |
subnetId |
The OCID of the regional subnet in which to place the Cluster endpoint. |
string |
No |
- |
- |
Status.endpoints
Back to Cluster status
Endpoints served up by the cluster masters.
| Field |
Description |
Type |
Required |
Default |
Enum |
ipv6Endpoint |
The IPv6 networking Kubernetes API server endpoint. |
string |
No |
- |
- |
kubernetes |
The non-native networking Kubernetes API server endpoint. |
string |
No |
- |
- |
privateEndpoint |
The private native networking Kubernetes API server endpoint. |
string |
No |
- |
- |
publicEndpoint |
The public native networking Kubernetes API server endpoint, if one was requested. |
string |
No |
- |
- |
vcnHostnameEndpoint |
The FQDN assigned to the Kubernetes API private endpoint. Example: 'https://yourVcnHostnameEndpoint' |
string |
No |
- |
- |
Status.imagePolicyConfig
Back to Cluster status
The image verification policy for signature validation.
| Field |
Description |
Type |
Required |
Default |
Enum |
isPolicyEnabled |
Whether the image verification policy is enabled. Defaults to false. If set to true, the images will be verified against the policy at runtime. |
boolean |
No |
- |
- |
keyDetails |
A list of KMS key details. |
list[object] |
No |
- |
- |
Status.imagePolicyConfig.keyDetails[]
Back to Cluster status
ClusterImagePolicyConfigKeyDetail defines nested fields for Cluster.ImagePolicyConfig.KeyDetail.
| Field |
Description |
Type |
Required |
Default |
Enum |
kmsKeyId |
The OCIDs of the KMS key that will be used to verify whether the images are signed by an approved source. |
string |
No |
- |
- |
Back to Cluster status
Metadata about the cluster.
| Field |
Description |
Type |
Required |
Default |
Enum |
createdByUserId |
The user who created the cluster. |
string |
No |
- |
- |
createdByWorkRequestId |
The OCID of the work request which created the cluster. |
string |
No |
- |
- |
deletedByUserId |
The user who deleted the cluster. |
string |
No |
- |
- |
deletedByWorkRequestId |
The OCID of the work request which deleted the cluster. |
string |
No |
- |
- |
timeCreated |
The time the cluster was created. |
string |
No |
- |
- |
timeCredentialExpiration |
The time until which the cluster credential is valid. |
string |
No |
- |
- |
timeDeleted |
The time the cluster was deleted. |
string |
No |
- |
- |
timeUpdated |
The time the cluster was updated. |
string |
No |
- |
- |
updatedByUserId |
The user who updated the cluster. |
string |
No |
- |
- |
updatedByWorkRequestId |
The OCID of the work request which updated the cluster. |
string |
No |
- |
- |
Status.options
Back to Cluster status
Optional attributes for the cluster.
| Field |
Description |
Type |
Required |
Default |
Enum |
addOns |
Configurable cluster add-ons |
object |
No |
- |
- |
admissionControllerOptions |
Configurable cluster admission controllers |
object |
No |
- |
- |
ipFamilies |
IP family to use for single stack or define the order of IP families for dual-stack |
list[string] |
No |
- |
- |
kubernetesNetworkConfig |
Network configuration for Kubernetes. |
object |
No |
- |
- |
openIdConnectDiscovery |
ClusterOptionsOpenIdConnectDiscovery defines nested fields for Cluster.Options.OpenIdConnectDiscovery. |
object |
No |
- |
- |
openIdConnectTokenAuthenticationConfig |
ClusterOptionsOpenIdConnectTokenAuthenticationConfig defines nested fields for Cluster.Options.OpenIdConnectTokenAuthenticationConfig. |
object |
No |
- |
- |
persistentVolumeConfig |
ClusterOptionsPersistentVolumeConfig defines nested fields for Cluster.Options.PersistentVolumeConfig. |
object |
No |
- |
- |
serviceLbConfig |
ClusterOptionsServiceLbConfig defines nested fields for Cluster.Options.ServiceLbConfig. |
object |
No |
- |
- |
serviceLbSubnetIds |
The OCIDs of the subnets used for Kubernetes services load balancers. |
list[string] |
No |
- |
- |
Status.options.addOns
Back to Cluster status
Configurable cluster add-ons
| Field |
Description |
Type |
Required |
Default |
Enum |
isKubernetesDashboardEnabled |
Whether or not to enable the Kubernetes Dashboard add-on. |
boolean |
No |
- |
- |
isTillerEnabled |
Whether or not to enable the Tiller add-on. |
boolean |
No |
- |
- |
Status.options.admissionControllerOptions
Back to Cluster status
Configurable cluster admission controllers
| Field |
Description |
Type |
Required |
Default |
Enum |
isPodSecurityPolicyEnabled |
Whether or not to enable the Pod Security Policy admission controller. |
boolean |
No |
- |
- |
Status.options.kubernetesNetworkConfig
Back to Cluster status
Network configuration for Kubernetes.
| Field |
Description |
Type |
Required |
Default |
Enum |
podsCidr |
The CIDR block for Kubernetes pods. Optional, defaults to 10.244.0.0/16. |
string |
No |
- |
- |
servicesCidr |
The CIDR block for Kubernetes services. Optional, defaults to 10.96.0.0/16. |
string |
No |
- |
- |
Status.options.openIdConnectDiscovery
Back to Cluster status
ClusterOptionsOpenIdConnectDiscovery defines nested fields for Cluster.Options.OpenIdConnectDiscovery.
| Field |
Description |
Type |
Required |
Default |
Enum |
isOpenIdConnectDiscoveryEnabled |
Whether the cluster has OIDC Discovery enabled. Defaults to false. If set to true, the cluster will be assigned a public OIDC Discovery endpoint. |
boolean |
No |
- |
- |
Status.options.openIdConnectTokenAuthenticationConfig
Back to Cluster status
ClusterOptionsOpenIdConnectTokenAuthenticationConfig defines nested fields for Cluster.Options.OpenIdConnectTokenAuthenticationConfig.
| Field |
Description |
Type |
Required |
Default |
Enum |
caCertificate |
A Base64 encoded public RSA or ECDSA certificates used to signed your identity provider's web certificate. |
string |
No |
- |
- |
clientId |
A client id that all tokens must be issued for. |
string |
No |
- |
- |
configurationFile |
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) |
string |
No |
- |
- |
groupsClaim |
JWT claim to use as the user's group. If the claim is present it must be an array of strings. |
string |
No |
- |
- |
groupsPrefix |
Prefix prepended to group claims to prevent clashes with existing names (such as system:groups). |
string |
No |
- |
- |
isOpenIdConnectAuthEnabled |
Whether the cluster has OIDC Auth Config enabled. Defaults to false. |
boolean |
Yes |
- |
- |
issuerUrl |
URL of the provider that allows the API server to discover public signing keys. Only URLs that use the https:// scheme are accepted. This is typically the provider's discovery URL, changed to have an empty path. |
string |
No |
- |
- |
requiredClaims |
A key=value pair that describes a required claim in the ID Token. If set, the claim is verified to be present in the ID Token with a matching value. Repeat this flag to specify multiple claims. |
list[object] |
No |
- |
- |
signingAlgorithms |
The signing algorithms accepted. Default is ["RS256"]. |
list[string] |
No |
- |
- |
usernameClaim |
JWT claim to use as the user name. By default sub, which is expected to be a unique identifier of the end user. Admins can choose other claims, such as email or name, depending on their provider. However, claims other than email will be prefixed with the issuer URL to prevent naming clashes with other plugins. |
string |
No |
- |
- |
usernamePrefix |
Prefix prepended to username claims to prevent clashes with existing names (such as system:users). For example, the value oidc: will create usernames like oidc:jane.doe. If this flag isn't provided and --oidc-username-claim is a value other than email the prefix defaults to ( Issuer URL )# where ( Issuer URL ) is the value of --oidc-issuer-url. The value - can be used to disable all prefixing. |
string |
No |
- |
- |
Status.options.openIdConnectTokenAuthenticationConfig.requiredClaims[]
Back to Cluster status
ClusterOptionsOpenIdConnectTokenAuthenticationConfigRequiredClaim defines nested fields for Cluster.Options.OpenIdConnectTokenAuthenticationConfig.RequiredClaim.
| Field |
Description |
Type |
Required |
Default |
Enum |
key |
The key of the pair. |
string |
No |
- |
- |
value |
The value of the pair. |
string |
No |
- |
- |
Status.options.persistentVolumeConfig
Back to Cluster status
ClusterOptionsPersistentVolumeConfig defines nested fields for Cluster.Options.PersistentVolumeConfig.
| Field |
Description |
Type |
Required |
Default |
Enum |
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 |
- |
- |
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 |
- |
- |
Status.options.serviceLbConfig
Back to Cluster status
ClusterOptionsServiceLbConfig defines nested fields for Cluster.Options.ServiceLbConfig.
| Field |
Description |
Type |
Required |
Default |
Enum |
backendNsgIds |
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. |
list[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 |
- |
- |
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 |
- |
- |
Status.status
Back to Cluster status
| Field |
Description |
Type |
Required |
Default |
Enum |
async |
Async is the canonical controller-owned async contract. Resource-local legacy work-request fields may remain as compatibility mirrors while follow-on migrations land, but new async state should project here first. |
object |
No |
- |
- |
conditions |
- |
list[object] |
No |
- |
- |
createdAt |
- |
string (date-time) |
No |
- |
- |
deletedAt |
- |
string (date-time) |
No |
- |
- |
message |
- |
string |
No |
- |
- |
ocid |
- |
string |
No |
- |
- |
opcRequestId |
OpcRequestID is the latest non-empty OCI request ID from a mutating OCI response or surfaced OCI service error that materially contributed to the current shared status projection. Headerless follow-up observations keep the last non-empty value intact. |
string |
No |
- |
- |
reason |
- |
string |
No |
- |
- |
requestedAt |
- |
string (date-time) |
No |
- |
- |
updatedAt |
- |
string (date-time) |
No |
- |
- |
Status.status.async
Back to Cluster status
Async is the canonical controller-owned async contract. Resource-local legacy work-request fields may remain as compatibility mirrors while follow-on migrations land, but new async state should project here first.
| Field |
Description |
Type |
Required |
Default |
Enum |
current |
- |
object |
No |
- |
- |
Status.status.async.current
Back to Cluster status
| Field |
Description |
Type |
Required |
Default |
Enum |
message |
- |
string |
No |
- |
- |
normalizedClass |
- |
string |
Yes |
- |
attention, canceled, failed, pending, succeeded, unknown |
percentComplete |
- |
number |
No |
- |
- |
phase |
- |
string |
Yes |
- |
create, delete, update |
rawOperationType |
- |
string |
No |
- |
- |
rawStatus |
- |
string |
No |
- |
- |
source |
- |
string |
Yes |
- |
lifecycle, none, workrequest |
updatedAt |
- |
string (date-time) |
Yes |
- |
- |
workRequestId |
- |
string |
No |
- |
- |
Status.status.conditions[]
Back to Cluster status
| Field |
Description |
Type |
Required |
Default |
Enum |
lastTransitionTime |
- |
string (date-time) |
No |
- |
- |
message |
- |
string |
No |
- |
- |
reason |
- |
string |
No |
- |
- |
status |
- |
string |
Yes |
- |
- |
type |
- |
string |
Yes |
- |
- |
NodePool
Manage OCI Container Engine for Kubernetes node pools.
Plural: nodepoolsScope: NamespacedAPIVersion: containerengine.oracle.com/v1beta1Sample: Sample (config/samples/containerengine_v1beta1_nodepool.yaml)Packages: Not currently exposed by a customer-visible package.
Spec
NodePoolSpec defines the desired state of NodePool.
| Field |
Description |
Type |
Required |
Default |
Enum |
clusterId |
The OCID of the cluster to which this node pool is attached. |
string |
Yes |
- |
- |
compartmentId |
The OCID of the compartment in which the node pool exists. |
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 |
- |
- |
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 |
- |
- |
initialNodeLabels |
A list of key/value pairs to add to nodes after they join the Kubernetes cluster. |
list[object] |
No |
- |
- |
kubernetesVersion |
The version of Kubernetes to install on the nodes in the node pool. |
string |
No |
- |
- |
name |
The name of the node pool. Avoid entering confidential information. |
string |
Yes |
- |
- |
nodeConfigDetails |
The configuration of nodes in the node pool. Exactly one of the subnetIds or nodeConfigDetails properties must be specified. |
object |
No |
- |
- |
nodeEvictionNodePoolSettings |
NodePoolNodeEvictionNodePoolSettings defines nested fields for NodePool.NodeEvictionNodePoolSettings. |
object |
No |
- |
- |
nodeImageName |
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. |
string |
No |
- |
- |
nodeMetadata |
A list of key/value pairs to add to each underlying OCI instance in the node pool on launch. |
map[string, string] |
No |
- |
- |
nodePoolCyclingDetails |
NodePoolCyclingDetails defines nested fields for NodePool.NodePoolCyclingDetails. |
object |
No |
- |
- |
nodeShape |
The name of the node shape of the nodes in the node pool. |
string |
Yes |
- |
- |
nodeShapeConfig |
Specify the configuration of the shape to launch nodes in the node pool. |
object |
No |
- |
- |
nodeSourceDetails |
Specify the source to use to launch nodes in the node pool. Currently, image is the only supported source. |
object |
No |
- |
- |
quantityPerSubnet |
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. |
integer |
No |
- |
- |
sshPublicKey |
The SSH public key on each node in the node pool on launch. |
string |
No |
- |
- |
subnetIds |
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. |
list[string] |
No |
- |
- |
Spec.initialNodeLabels[]
Back to NodePool spec
NodePoolInitialNodeLabel defines nested fields for NodePool.InitialNodeLabel.
| Field |
Description |
Type |
Required |
Default |
Enum |
key |
The key of the pair. |
string |
No |
- |
- |
value |
The value of the pair. |
string |
No |
- |
- |
Spec.nodeConfigDetails
Back to NodePool spec
The configuration of nodes in the node pool. Exactly one of the subnetIds or nodeConfigDetails properties must be specified.
| Field |
Description |
Type |
Required |
Default |
Enum |
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 |
- |
- |
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 |
- |
- |
isPvEncryptionInTransitEnabled |
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. |
boolean |
No |
- |
- |
kmsKeyId |
The OCID of the Key Management Service key assigned to the boot volume. |
string |
No |
- |
- |
nodePoolPodNetworkOptionDetails |
The CNI related configuration of pods in the node pool. |
object |
No |
- |
- |
nsgIds |
The OCIDs of the Network Security Group(s) to associate nodes for this node pool with. For more information about NSGs, see NetworkSecurityGroup. |
list[string] |
No |
- |
- |
placementConfigs |
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. |
list[object] |
Yes |
- |
- |
size |
The number of nodes that should be in the node pool. |
integer |
Yes |
- |
- |
Spec.nodeConfigDetails.nodePoolPodNetworkOptionDetails
Back to NodePool spec
The CNI related configuration of pods in the node pool.
| Field |
Description |
Type |
Required |
Default |
Enum |
cniType |
- |
string |
No |
- |
- |
jsonData |
- |
string |
No |
- |
- |
maxPodsPerNode |
The max number of pods per node in the node pool. This value will be limited by the number of VNICs attachable to the node pool shape |
integer |
No |
- |
- |
podNsgIds |
The OCIDs of the Network Security Group(s) to associate pods for this node pool with. For more information about NSGs, see NetworkSecurityGroup. |
list[string] |
No |
- |
- |
podSubnetIds |
The OCIDs of the subnets in which to place pods for this node pool. This can be one of the node pool subnet IDs |
list[string] |
No |
- |
- |
Spec.nodeConfigDetails.placementConfigs[]
Back to NodePool spec
NodePoolNodeConfigDetailsPlacementConfig defines nested fields for NodePool.NodeConfigDetails.PlacementConfig.
| Field |
Description |
Type |
Required |
Default |
Enum |
availabilityDomain |
The availability domain in which to place nodes. Example: Uocm:PHX-AD-1 |
string |
Yes |
- |
- |
capacityReservationId |
The OCID of the compute capacity reservation in which to place the compute instance. |
string |
No |
- |
- |
faultDomains |
A list of fault domains in which to place nodes. |
list[string] |
No |
- |
- |
preemptibleNodeConfig |
NodePoolNodeConfigDetailsPlacementConfigPreemptibleNodeConfig defines nested fields for NodePool.NodeConfigDetails.PlacementConfig.PreemptibleNodeConfig. |
object |
No |
- |
- |
subnetId |
The OCID of the subnet in which to place nodes. |
string |
Yes |
- |
- |
Spec.nodeConfigDetails.placementConfigs[].preemptibleNodeConfig
Back to NodePool spec
NodePoolNodeConfigDetailsPlacementConfigPreemptibleNodeConfig defines nested fields for NodePool.NodeConfigDetails.PlacementConfig.PreemptibleNodeConfig.
| Field |
Description |
Type |
Required |
Default |
Enum |
preemptionAction |
NodePoolNodeConfigDetailsPlacementConfigPreemptibleNodeConfigPreemptionAction defines nested fields for NodePool.NodeConfigDetails.PlacementConfig.PreemptibleNodeConfig.PreemptionAction. |
object |
Yes |
- |
- |
Spec.nodeConfigDetails.placementConfigs[].preemptibleNodeConfig.preemptionAction
Back to NodePool spec
NodePoolNodeConfigDetailsPlacementConfigPreemptibleNodeConfigPreemptionAction defines nested fields for NodePool.NodeConfigDetails.PlacementConfig.PreemptibleNodeConfig.PreemptionAction.
| Field |
Description |
Type |
Required |
Default |
Enum |
isPreserveBootVolume |
Whether to preserve the boot volume that was used to launch the preemptible instance when the instance is terminated. Defaults to false if not specified. |
boolean |
No |
- |
- |
jsonData |
- |
string |
No |
- |
- |
type |
- |
string |
No |
- |
- |
Spec.nodeEvictionNodePoolSettings
Back to NodePool spec
NodePoolNodeEvictionNodePoolSettings defines nested fields for NodePool.NodeEvictionNodePoolSettings.
| Field |
Description |
Type |
Required |
Default |
Enum |
evictionGraceDuration |
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 |
string |
No |
- |
- |
isForceActionAfterGraceDuration |
If the node action should be performed if not all the pods can be evicted in the grace period |
boolean |
No |
- |
- |
isForceDeleteAfterGraceDuration |
If the underlying compute instance should be deleted if you cannot evict all the pods in grace period |
boolean |
No |
- |
- |
Spec.nodePoolCyclingDetails
Back to NodePool spec
NodePoolCyclingDetails defines nested fields for NodePool.NodePoolCyclingDetails.
| Field |
Description |
Type |
Required |
Default |
Enum |
cycleModes |
An ordered list of cycle modes that should be performed on the OKE nodes. |
list[string] |
No |
- |
- |
isNodeCyclingEnabled |
If cycling operation should be performed on the nodes in the node pool. |
boolean |
No |
- |
- |
maximumSurge |
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% |
string |
No |
- |
- |
maximumUnavailable |
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% |
string |
No |
- |
- |
Spec.nodeShapeConfig
Back to NodePool spec
Specify the configuration of the shape to launch nodes in the node pool.
| Field |
Description |
Type |
Required |
Default |
Enum |
memoryInGBs |
The total amount of memory available to each node, in gigabytes. |
number |
No |
- |
- |
ocpus |
The total number of OCPUs available to each node in the node pool. See here (https://docs.oracle.com/iaas/en-us/iaas/api/#/en/iaas/20160918/Shape/) for details. |
number |
No |
- |
- |
Spec.nodeSourceDetails
Back to NodePool spec
Specify the source to use to launch nodes in the node pool. Currently, image is the only supported source.
| Field |
Description |
Type |
Required |
Default |
Enum |
bootVolumeSizeInGBs |
The size of the boot volume in GBs. Minimum value is 50 GB. See here (https://docs.oracle.com/iaas/en-us/iaas/Content/Block/Concepts/bootvolumes.htm) for max custom boot volume sizing and OS-specific requirements. |
integer (int64) |
No |
- |
- |
imageId |
The OCID of the image used to boot the node. |
string |
No |
- |
- |
jsonData |
- |
string |
No |
- |
- |
sourceType |
- |
string |
No |
- |
- |
Status
NodePoolStatus defines the observed state of NodePool.
| Field |
Description |
Type |
Required |
Default |
Enum |
clusterId |
The OCID of the cluster to which this node pool is attached. |
string |
No |
- |
- |
compartmentId |
The OCID of the compartment in which the node pool 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 |
- |
- |
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 node pool. |
string |
No |
- |
- |
initialNodeLabels |
A list of key/value pairs to add to nodes after they join the Kubernetes cluster. |
list[object] |
No |
- |
- |
kubernetesVersion |
The version of Kubernetes running on the nodes in the node pool. |
string |
No |
- |
- |
lifecycleDetails |
Details about the state of the nodepool. |
string |
No |
- |
- |
lifecycleState |
The state of the nodepool. For more information, see Monitoring Clusters (https://docs.oracle.com/iaas/Content/ContEng/Tasks/contengmonitoringclusters.htm) |
string |
No |
- |
- |
name |
The name of the node pool. |
string |
No |
- |
- |
nodeConfigDetails |
The configuration of nodes in the node pool. |
object |
No |
- |
- |
nodeEvictionNodePoolSettings |
NodePoolNodeEvictionNodePoolSettings defines nested fields for NodePool.NodeEvictionNodePoolSettings. |
object |
No |
- |
- |
nodeImageId |
Deprecated. see nodeSource. The OCID of the image running on the nodes in the node pool. |
string |
No |
- |
- |
nodeImageName |
Deprecated. see nodeSource. The name of the image running on the nodes in the node pool. |
string |
No |
- |
- |
nodeMetadata |
A list of key/value pairs to add to each underlying OCI instance in the node pool on launch. |
map[string, string] |
No |
- |
- |
nodePoolCyclingDetails |
NodePoolCyclingDetails defines nested fields for NodePool.NodePoolCyclingDetails. |
object |
No |
- |
- |
nodeShape |
The name of the node shape of the nodes in the node pool. |
string |
No |
- |
- |
nodeShapeConfig |
The shape configuration of the nodes. |
object |
No |
- |
- |
nodeSource |
Deprecated. see nodeSourceDetails. Source running on the nodes in the node pool. |
object |
No |
- |
- |
nodeSourceDetails |
Source running on the nodes in the node pool. |
object |
No |
- |
- |
nodes |
The nodes in the node pool. |
list[object] |
No |
- |
- |
quantityPerSubnet |
The number of nodes in each subnet. |
integer |
No |
- |
- |
sshPublicKey |
The SSH public key on each node in the node pool on launch. |
string |
No |
- |
- |
status |
- |
object |
Yes |
- |
- |
subnetIds |
The OCIDs of the subnets in which to place nodes for this node pool. |
list[string] |
No |
- |
- |
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 |
- |
- |
Status.initialNodeLabels[]
Back to NodePool status
NodePoolInitialNodeLabel defines nested fields for NodePool.InitialNodeLabel.
| Field |
Description |
Type |
Required |
Default |
Enum |
key |
The key of the pair. |
string |
No |
- |
- |
value |
The value of the pair. |
string |
No |
- |
- |
Status.nodeConfigDetails
Back to NodePool status
The configuration of nodes in the node pool.
| Field |
Description |
Type |
Required |
Default |
Enum |
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 |
- |
- |
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 |
- |
- |
isPvEncryptionInTransitEnabled |
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. |
boolean |
No |
- |
- |
kmsKeyId |
The OCID of the Key Management Service key assigned to the boot volume. |
string |
No |
- |
- |
nodePoolPodNetworkOptionDetails |
The CNI related configuration of pods in the node pool. |
object |
No |
- |
- |
nsgIds |
The OCIDs of the Network Security Group(s) to associate nodes for this node pool with. For more information about NSGs, see NetworkSecurityGroup. |
list[string] |
No |
- |
- |
placementConfigs |
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. |
list[object] |
Yes |
- |
- |
size |
The number of nodes that should be in the node pool. |
integer |
Yes |
- |
- |
Status.nodeConfigDetails.nodePoolPodNetworkOptionDetails
Back to NodePool status
The CNI related configuration of pods in the node pool.
| Field |
Description |
Type |
Required |
Default |
Enum |
cniType |
- |
string |
No |
- |
- |
jsonData |
- |
string |
No |
- |
- |
maxPodsPerNode |
The max number of pods per node in the node pool. This value will be limited by the number of VNICs attachable to the node pool shape |
integer |
No |
- |
- |
podNsgIds |
The OCIDs of the Network Security Group(s) to associate pods for this node pool with. For more information about NSGs, see NetworkSecurityGroup. |
list[string] |
No |
- |
- |
podSubnetIds |
The OCIDs of the subnets in which to place pods for this node pool. This can be one of the node pool subnet IDs |
list[string] |
No |
- |
- |
Status.nodeConfigDetails.placementConfigs[]
Back to NodePool status
NodePoolNodeConfigDetailsPlacementConfig defines nested fields for NodePool.NodeConfigDetails.PlacementConfig.
| Field |
Description |
Type |
Required |
Default |
Enum |
availabilityDomain |
The availability domain in which to place nodes. Example: Uocm:PHX-AD-1 |
string |
Yes |
- |
- |
capacityReservationId |
The OCID of the compute capacity reservation in which to place the compute instance. |
string |
No |
- |
- |
faultDomains |
A list of fault domains in which to place nodes. |
list[string] |
No |
- |
- |
preemptibleNodeConfig |
NodePoolNodeConfigDetailsPlacementConfigPreemptibleNodeConfig defines nested fields for NodePool.NodeConfigDetails.PlacementConfig.PreemptibleNodeConfig. |
object |
No |
- |
- |
subnetId |
The OCID of the subnet in which to place nodes. |
string |
Yes |
- |
- |
Status.nodeConfigDetails.placementConfigs[].preemptibleNodeConfig
Back to NodePool status
NodePoolNodeConfigDetailsPlacementConfigPreemptibleNodeConfig defines nested fields for NodePool.NodeConfigDetails.PlacementConfig.PreemptibleNodeConfig.
| Field |
Description |
Type |
Required |
Default |
Enum |
preemptionAction |
NodePoolNodeConfigDetailsPlacementConfigPreemptibleNodeConfigPreemptionAction defines nested fields for NodePool.NodeConfigDetails.PlacementConfig.PreemptibleNodeConfig.PreemptionAction. |
object |
Yes |
- |
- |
Status.nodeConfigDetails.placementConfigs[].preemptibleNodeConfig.preemptionAction
Back to NodePool status
NodePoolNodeConfigDetailsPlacementConfigPreemptibleNodeConfigPreemptionAction defines nested fields for NodePool.NodeConfigDetails.PlacementConfig.PreemptibleNodeConfig.PreemptionAction.
| Field |
Description |
Type |
Required |
Default |
Enum |
isPreserveBootVolume |
Whether to preserve the boot volume that was used to launch the preemptible instance when the instance is terminated. Defaults to false if not specified. |
boolean |
No |
- |
- |
jsonData |
- |
string |
No |
- |
- |
type |
- |
string |
No |
- |
- |
Status.nodeEvictionNodePoolSettings
Back to NodePool status
NodePoolNodeEvictionNodePoolSettings defines nested fields for NodePool.NodeEvictionNodePoolSettings.
| Field |
Description |
Type |
Required |
Default |
Enum |
evictionGraceDuration |
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 |
string |
No |
- |
- |
isForceActionAfterGraceDuration |
If the node action should be performed if not all the pods can be evicted in the grace period |
boolean |
No |
- |
- |
isForceDeleteAfterGraceDuration |
If the underlying compute instance should be deleted if you cannot evict all the pods in grace period |
boolean |
No |
- |
- |
Status.nodePoolCyclingDetails
Back to NodePool status
NodePoolCyclingDetails defines nested fields for NodePool.NodePoolCyclingDetails.
| Field |
Description |
Type |
Required |
Default |
Enum |
cycleModes |
An ordered list of cycle modes that should be performed on the OKE nodes. |
list[string] |
No |
- |
- |
isNodeCyclingEnabled |
If cycling operation should be performed on the nodes in the node pool. |
boolean |
No |
- |
- |
maximumSurge |
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% |
string |
No |
- |
- |
maximumUnavailable |
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% |
string |
No |
- |
- |
Status.nodeShapeConfig
Back to NodePool status
The shape configuration of the nodes.
| Field |
Description |
Type |
Required |
Default |
Enum |
memoryInGBs |
The total amount of memory available to each node, in gigabytes. |
number |
No |
- |
- |
ocpus |
The total number of OCPUs available to each node in the node pool. See here (https://docs.oracle.com/iaas/en-us/iaas/api/#/en/iaas/20160918/Shape/) for details. |
number |
No |
- |
- |
Status.nodeSource
Back to NodePool status
Deprecated. see nodeSourceDetails. Source running on the nodes in the node pool.
| Field |
Description |
Type |
Required |
Default |
Enum |
imageId |
The OCID of the image. |
string |
No |
- |
- |
jsonData |
- |
string |
No |
- |
- |
sourceName |
The user-friendly name of the entity corresponding to the OCID. |
string |
No |
- |
- |
sourceType |
- |
string |
No |
- |
- |
Status.nodeSourceDetails
Back to NodePool status
Source running on the nodes in the node pool.
| Field |
Description |
Type |
Required |
Default |
Enum |
bootVolumeSizeInGBs |
The size of the boot volume in GBs. Minimum value is 50 GB. See here (https://docs.oracle.com/iaas/en-us/iaas/Content/Block/Concepts/bootvolumes.htm) for max custom boot volume sizing and OS-specific requirements. |
integer (int64) |
No |
- |
- |
imageId |
The OCID of the image used to boot the node. |
string |
No |
- |
- |
jsonData |
- |
string |
No |
- |
- |
sourceType |
- |
string |
No |
- |
- |
Status.nodes[]
Back to NodePool status
NodePoolNode defines nested fields for NodePool.Node.
| Field |
Description |
Type |
Required |
Default |
Enum |
availabilityDomain |
The name of the availability domain in which this node is placed. |
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 |
- |
- |
faultDomain |
The fault domain of this node. |
string |
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 compute instance backing this node. |
string |
No |
- |
- |
kubernetesVersion |
The version of Kubernetes this node is running. |
string |
No |
- |
- |
lifecycleDetails |
Details about the state of the node. |
string |
No |
- |
- |
lifecycleState |
The state of the node. For more information, see Monitoring Clusters (https://docs.oracle.com/iaas/Content/ContEng/Tasks/contengmonitoringclusters.htm) |
string |
No |
- |
- |
name |
The name of the node. |
string |
No |
- |
- |
nodeError |
An error that may be associated with the node. |
object |
No |
- |
- |
nodePoolId |
The OCID of the node pool to which this node belongs. |
string |
No |
- |
- |
privateIp |
The private IP address of this node. |
string |
No |
- |
- |
publicIp |
The public IP address of this node. |
string |
No |
- |
- |
subnetId |
The OCID of the subnet in which this node is placed. |
string |
No |
- |
- |
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 |
- |
- |
Status.nodes[].nodeError
Back to NodePool status
An error that may be associated with the node.
| Field |
Description |
Type |
Required |
Default |
Enum |
code |
A short error code that defines the upstream error, meant for programmatic parsing. See API Errors (https://docs.oracle.com/iaas/Content/API/References/apierrors.htm). |
string |
No |
- |
- |
message |
A human-readable error string of the upstream error. |
string |
No |
- |
- |
opc-request-id |
Unique Oracle-assigned identifier for the upstream request. If you need to contact Oracle about a particular upstream request, please provide the request ID. |
string |
No |
- |
- |
status |
The status of the HTTP response encountered in the upstream error. |
string |
No |
- |
- |
Status.status
Back to NodePool status
| Field |
Description |
Type |
Required |
Default |
Enum |
async |
Async is the canonical controller-owned async contract. Resource-local legacy work-request fields may remain as compatibility mirrors while follow-on migrations land, but new async state should project here first. |
object |
No |
- |
- |
conditions |
- |
list[object] |
No |
- |
- |
createdAt |
- |
string (date-time) |
No |
- |
- |
deletedAt |
- |
string (date-time) |
No |
- |
- |
message |
- |
string |
No |
- |
- |
ocid |
- |
string |
No |
- |
- |
opcRequestId |
OpcRequestID is the latest non-empty OCI request ID from a mutating OCI response or surfaced OCI service error that materially contributed to the current shared status projection. Headerless follow-up observations keep the last non-empty value intact. |
string |
No |
- |
- |
reason |
- |
string |
No |
- |
- |
requestedAt |
- |
string (date-time) |
No |
- |
- |
updatedAt |
- |
string (date-time) |
No |
- |
- |
Status.status.async
Back to NodePool status
Async is the canonical controller-owned async contract. Resource-local legacy work-request fields may remain as compatibility mirrors while follow-on migrations land, but new async state should project here first.
| Field |
Description |
Type |
Required |
Default |
Enum |
current |
- |
object |
No |
- |
- |
Status.status.async.current
Back to NodePool status
| Field |
Description |
Type |
Required |
Default |
Enum |
message |
- |
string |
No |
- |
- |
normalizedClass |
- |
string |
Yes |
- |
attention, canceled, failed, pending, succeeded, unknown |
percentComplete |
- |
number |
No |
- |
- |
phase |
- |
string |
Yes |
- |
create, delete, update |
rawOperationType |
- |
string |
No |
- |
- |
rawStatus |
- |
string |
No |
- |
- |
source |
- |
string |
Yes |
- |
lifecycle, none, workrequest |
updatedAt |
- |
string (date-time) |
Yes |
- |
- |
workRequestId |
- |
string |
No |
- |
- |
Status.status.conditions[]
Back to NodePool status
| Field |
Description |
Type |
Required |
Default |
Enum |
lastTransitionTime |
- |
string (date-time) |
No |
- |
- |
message |
- |
string |
No |
- |
- |
reason |
- |
string |
No |
- |
- |
status |
- |
string |
Yes |
- |
- |
type |
- |
string |
Yes |
- |
- |