Oracle Cloud Infrastructure

v0.5.0 published on Monday, Sep 12, 2022 by Pulumi

Cluster

This resource provides the Cluster resource in Oracle Cloud Infrastructure Container Engine service.

Create a new cluster.

Create a Cluster Resource

new Cluster(name: string, args: ClusterArgs, opts?: CustomResourceOptions);
@overload
def Cluster(resource_name: str,
            opts: Optional[ResourceOptions] = None,
            cluster_pod_network_options: Optional[Sequence[_containerengine.ClusterClusterPodNetworkOptionArgs]] = None,
            compartment_id: Optional[str] = None,
            defined_tags: Optional[Mapping[str, Any]] = None,
            endpoint_config: Optional[_containerengine.ClusterEndpointConfigArgs] = None,
            freeform_tags: Optional[Mapping[str, Any]] = None,
            image_policy_config: Optional[_containerengine.ClusterImagePolicyConfigArgs] = None,
            kms_key_id: Optional[str] = None,
            kubernetes_version: Optional[str] = None,
            name: Optional[str] = None,
            options: Optional[_containerengine.ClusterOptionsArgs] = None,
            vcn_id: Optional[str] = None)
@overload
def Cluster(resource_name: str,
            args: ClusterArgs,
            opts: Optional[ResourceOptions] = None)
func NewCluster(ctx *Context, name string, args ClusterArgs, opts ...ResourceOption) (*Cluster, error)
public Cluster(string name, ClusterArgs args, CustomResourceOptions? opts = null)
public Cluster(String name, ClusterArgs args)
public Cluster(String name, ClusterArgs args, CustomResourceOptions options)
type: oci:ContainerEngine:Cluster
properties: # The arguments to resource properties.
options: # Bag of options to control resource's behavior.

name string
The unique name of the resource.
args ClusterArgs
The arguments to resource properties.
opts CustomResourceOptions
Bag of options to control resource's behavior.
resource_name str
The unique name of the resource.
args ClusterArgs
The arguments to resource properties.
opts ResourceOptions
Bag of options to control resource's behavior.
ctx Context
Context object for the current deployment.
name string
The unique name of the resource.
args ClusterArgs
The arguments to resource properties.
opts ResourceOption
Bag of options to control resource's behavior.
name string
The unique name of the resource.
args ClusterArgs
The arguments to resource properties.
opts CustomResourceOptions
Bag of options to control resource's behavior.
name String
The unique name of the resource.
args ClusterArgs
The arguments to resource properties.
options CustomResourceOptions
Bag of options to control resource's behavior.

Cluster Resource Properties

To learn more about resource properties and how to use them, see Inputs and Outputs in the Architecture and Concepts docs.

Inputs

The Cluster resource accepts the following input properties:

CompartmentId string

The OCID of the compartment in which to create the cluster.

KubernetesVersion string

(Updatable) The version of Kubernetes to install into the cluster masters.

VcnId string

The OCID of the virtual cloud network (VCN) in which to create the cluster.

ClusterPodNetworkOptions List<ClusterClusterPodNetworkOptionArgs>

Available CNIs and network options for existing and new node pools of the cluster

DefinedTags Dictionary<string, object>

(Updatable) Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see Resource Tags. Example: {"Operations.CostCenter": "42"}

EndpointConfig ClusterEndpointConfigArgs

The network configuration for access to the Cluster control plane.

FreeformTags Dictionary<string, object>

(Updatable) 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. Example: {"Department": "Finance"}

ImagePolicyConfig ClusterImagePolicyConfigArgs

(Updatable) 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 string

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.

Name string

(Updatable) The name of the cluster. Avoid entering confidential information.

Options ClusterOptionsArgs

(Updatable) Optional attributes for the cluster.

CompartmentId string

The OCID of the compartment in which to create the cluster.

KubernetesVersion string

(Updatable) The version of Kubernetes to install into the cluster masters.

VcnId string

The OCID of the virtual cloud network (VCN) in which to create the cluster.

ClusterPodNetworkOptions []ClusterClusterPodNetworkOptionArgs

Available CNIs and network options for existing and new node pools of the cluster

DefinedTags map[string]interface{}

(Updatable) Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see Resource Tags. Example: {"Operations.CostCenter": "42"}

EndpointConfig ClusterEndpointConfigArgs

The network configuration for access to the Cluster control plane.

FreeformTags map[string]interface{}

(Updatable) 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. Example: {"Department": "Finance"}

ImagePolicyConfig ClusterImagePolicyConfigArgs

(Updatable) 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 string

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.

Name string

(Updatable) The name of the cluster. Avoid entering confidential information.

Options ClusterOptionsArgs

(Updatable) Optional attributes for the cluster.

compartmentId String

The OCID of the compartment in which to create the cluster.

kubernetesVersion String

(Updatable) The version of Kubernetes to install into the cluster masters.

vcnId String

The OCID of the virtual cloud network (VCN) in which to create the cluster.

clusterPodNetworkOptions List<ClusterClusterPodNetworkOptionArgs>

Available CNIs and network options for existing and new node pools of the cluster

definedTags Map<String,Object>

(Updatable) Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see Resource Tags. Example: {"Operations.CostCenter": "42"}

endpointConfig ClusterEndpointConfigArgs

The network configuration for access to the Cluster control plane.

freeformTags Map<String,Object>

(Updatable) 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. Example: {"Department": "Finance"}

imagePolicyConfig ClusterImagePolicyConfigArgs

(Updatable) 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 String

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.

name String

(Updatable) The name of the cluster. Avoid entering confidential information.

options ClusterOptionsArgs

(Updatable) Optional attributes for the cluster.

compartmentId string

The OCID of the compartment in which to create the cluster.

kubernetesVersion string

(Updatable) The version of Kubernetes to install into the cluster masters.

vcnId string

The OCID of the virtual cloud network (VCN) in which to create the cluster.

clusterPodNetworkOptions ClusterClusterPodNetworkOptionArgs[]

Available CNIs and network options for existing and new node pools of the cluster

definedTags {[key: string]: any}

(Updatable) Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see Resource Tags. Example: {"Operations.CostCenter": "42"}

endpointConfig ClusterEndpointConfigArgs

The network configuration for access to the Cluster control plane.

freeformTags {[key: string]: any}

(Updatable) 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. Example: {"Department": "Finance"}

imagePolicyConfig ClusterImagePolicyConfigArgs

(Updatable) 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 string

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.

name string

(Updatable) The name of the cluster. Avoid entering confidential information.

options ClusterOptionsArgs

(Updatable) Optional attributes for the cluster.

compartment_id str

The OCID of the compartment in which to create the cluster.

kubernetes_version str

(Updatable) The version of Kubernetes to install into the cluster masters.

vcn_id str

The OCID of the virtual cloud network (VCN) in which to create the cluster.

cluster_pod_network_options ClusterClusterPodNetworkOptionArgs]

Available CNIs and network options for existing and new node pools of the cluster

defined_tags Mapping[str, Any]

(Updatable) Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see Resource Tags. Example: {"Operations.CostCenter": "42"}

endpoint_config ClusterEndpointConfigArgs

The network configuration for access to the Cluster control plane.

freeform_tags Mapping[str, Any]

(Updatable) 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. Example: {"Department": "Finance"}

image_policy_config ClusterImagePolicyConfigArgs

(Updatable) 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.

kms_key_id str

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.

name str

(Updatable) The name of the cluster. Avoid entering confidential information.

options ClusterOptionsArgs

(Updatable) Optional attributes for the cluster.

compartmentId String

The OCID of the compartment in which to create the cluster.

kubernetesVersion String

(Updatable) The version of Kubernetes to install into the cluster masters.

vcnId String

The OCID of the virtual cloud network (VCN) in which to create the cluster.

clusterPodNetworkOptions List<Property Map>

Available CNIs and network options for existing and new node pools of the cluster

definedTags Map<Any>

(Updatable) Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see Resource Tags. Example: {"Operations.CostCenter": "42"}

endpointConfig Property Map

The network configuration for access to the Cluster control plane.

freeformTags Map<Any>

(Updatable) 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. Example: {"Department": "Finance"}

imagePolicyConfig Property Map

(Updatable) 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 String

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.

name String

(Updatable) The name of the cluster. Avoid entering confidential information.

options Property Map

(Updatable) Optional attributes for the cluster.

Outputs

All input properties are implicitly available as output properties. Additionally, the Cluster resource produces the following output properties:

AvailableKubernetesUpgrades List<string>

Available Kubernetes versions to which the clusters masters may be upgraded.

Endpoints List<ClusterEndpoint>

Endpoints served up by the cluster masters.

Id string

The provider-assigned unique ID for this managed resource.

LifecycleDetails string

Details about the state of the cluster masters.

Metadatas List<ClusterMetadata>

Metadata about the cluster.

State string

The state of the cluster masters.

AvailableKubernetesUpgrades []string

Available Kubernetes versions to which the clusters masters may be upgraded.

Endpoints []ClusterEndpoint

Endpoints served up by the cluster masters.

Id string

The provider-assigned unique ID for this managed resource.

LifecycleDetails string

Details about the state of the cluster masters.

Metadatas []ClusterMetadata

Metadata about the cluster.

State string

The state of the cluster masters.

availableKubernetesUpgrades List<String>

Available Kubernetes versions to which the clusters masters may be upgraded.

endpoints List<ClusterEndpoint>

Endpoints served up by the cluster masters.

id String

The provider-assigned unique ID for this managed resource.

lifecycleDetails String

Details about the state of the cluster masters.

metadatas List<ClusterMetadata>

Metadata about the cluster.

state String

The state of the cluster masters.

availableKubernetesUpgrades string[]

Available Kubernetes versions to which the clusters masters may be upgraded.

endpoints ClusterEndpoint[]

Endpoints served up by the cluster masters.

id string

The provider-assigned unique ID for this managed resource.

lifecycleDetails string

Details about the state of the cluster masters.

metadatas ClusterMetadata[]

Metadata about the cluster.

state string

The state of the cluster masters.

available_kubernetes_upgrades Sequence[str]

Available Kubernetes versions to which the clusters masters may be upgraded.

endpoints ClusterEndpoint]

Endpoints served up by the cluster masters.

id str

The provider-assigned unique ID for this managed resource.

lifecycle_details str

Details about the state of the cluster masters.

metadatas ClusterMetadata]

Metadata about the cluster.

state str

The state of the cluster masters.

availableKubernetesUpgrades List<String>

Available Kubernetes versions to which the clusters masters may be upgraded.

endpoints List<Property Map>

Endpoints served up by the cluster masters.

id String

The provider-assigned unique ID for this managed resource.

lifecycleDetails String

Details about the state of the cluster masters.

metadatas List<Property Map>

Metadata about the cluster.

state String

The state of the cluster masters.

Look up an Existing Cluster Resource

Get an existing Cluster resource’s state with the given name, ID, and optional extra properties used to qualify the lookup.

public static get(name: string, id: Input<ID>, state?: ClusterState, opts?: CustomResourceOptions): Cluster
@staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        available_kubernetes_upgrades: Optional[Sequence[str]] = None,
        cluster_pod_network_options: Optional[Sequence[_containerengine.ClusterClusterPodNetworkOptionArgs]] = None,
        compartment_id: Optional[str] = None,
        defined_tags: Optional[Mapping[str, Any]] = None,
        endpoint_config: Optional[_containerengine.ClusterEndpointConfigArgs] = None,
        endpoints: Optional[Sequence[_containerengine.ClusterEndpointArgs]] = None,
        freeform_tags: Optional[Mapping[str, Any]] = None,
        image_policy_config: Optional[_containerengine.ClusterImagePolicyConfigArgs] = None,
        kms_key_id: Optional[str] = None,
        kubernetes_version: Optional[str] = None,
        lifecycle_details: Optional[str] = None,
        metadatas: Optional[Sequence[_containerengine.ClusterMetadataArgs]] = None,
        name: Optional[str] = None,
        options: Optional[_containerengine.ClusterOptionsArgs] = None,
        state: Optional[str] = None,
        vcn_id: Optional[str] = None) -> Cluster
func GetCluster(ctx *Context, name string, id IDInput, state *ClusterState, opts ...ResourceOption) (*Cluster, error)
public static Cluster Get(string name, Input<string> id, ClusterState? state, CustomResourceOptions? opts = null)
public static Cluster get(String name, Output<String> id, ClusterState state, CustomResourceOptions options)
Resource lookup is not supported in YAML
name
The unique name of the resulting resource.
id
The unique provider ID of the resource to lookup.
state
Any extra arguments used during the lookup.
opts
A bag of options that control this resource's behavior.
resource_name
The unique name of the resulting resource.
id
The unique provider ID of the resource to lookup.
name
The unique name of the resulting resource.
id
The unique provider ID of the resource to lookup.
state
Any extra arguments used during the lookup.
opts
A bag of options that control this resource's behavior.
name
The unique name of the resulting resource.
id
The unique provider ID of the resource to lookup.
state
Any extra arguments used during the lookup.
opts
A bag of options that control this resource's behavior.
name
The unique name of the resulting resource.
id
The unique provider ID of the resource to lookup.
state
Any extra arguments used during the lookup.
opts
A bag of options that control this resource's behavior.
The following state arguments are supported:
AvailableKubernetesUpgrades List<string>

Available Kubernetes versions to which the clusters masters may be upgraded.

ClusterPodNetworkOptions List<ClusterClusterPodNetworkOptionArgs>

Available CNIs and network options for existing and new node pools of the cluster

CompartmentId string

The OCID of the compartment in which to create the cluster.

DefinedTags Dictionary<string, object>

(Updatable) Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see Resource Tags. Example: {"Operations.CostCenter": "42"}

EndpointConfig ClusterEndpointConfigArgs

The network configuration for access to the Cluster control plane.

Endpoints List<ClusterEndpointArgs>

Endpoints served up by the cluster masters.

FreeformTags Dictionary<string, object>

(Updatable) 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. Example: {"Department": "Finance"}

ImagePolicyConfig ClusterImagePolicyConfigArgs

(Updatable) 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 string

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.

KubernetesVersion string

(Updatable) The version of Kubernetes to install into the cluster masters.

LifecycleDetails string

Details about the state of the cluster masters.

Metadatas List<ClusterMetadataArgs>

Metadata about the cluster.

Name string

(Updatable) The name of the cluster. Avoid entering confidential information.

Options ClusterOptionsArgs

(Updatable) Optional attributes for the cluster.

State string

The state of the cluster masters.

VcnId string

The OCID of the virtual cloud network (VCN) in which to create the cluster.

AvailableKubernetesUpgrades []string

Available Kubernetes versions to which the clusters masters may be upgraded.

ClusterPodNetworkOptions []ClusterClusterPodNetworkOptionArgs

Available CNIs and network options for existing and new node pools of the cluster

CompartmentId string

The OCID of the compartment in which to create the cluster.

DefinedTags map[string]interface{}

(Updatable) Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see Resource Tags. Example: {"Operations.CostCenter": "42"}

EndpointConfig ClusterEndpointConfigArgs

The network configuration for access to the Cluster control plane.

Endpoints []ClusterEndpointArgs

Endpoints served up by the cluster masters.

FreeformTags map[string]interface{}

(Updatable) 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. Example: {"Department": "Finance"}

ImagePolicyConfig ClusterImagePolicyConfigArgs

(Updatable) 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 string

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.

KubernetesVersion string

(Updatable) The version of Kubernetes to install into the cluster masters.

LifecycleDetails string

Details about the state of the cluster masters.

Metadatas []ClusterMetadataArgs

Metadata about the cluster.

Name string

(Updatable) The name of the cluster. Avoid entering confidential information.

Options ClusterOptionsArgs

(Updatable) Optional attributes for the cluster.

State string

The state of the cluster masters.

VcnId string

The OCID of the virtual cloud network (VCN) in which to create the cluster.

availableKubernetesUpgrades List<String>

Available Kubernetes versions to which the clusters masters may be upgraded.

clusterPodNetworkOptions List<ClusterClusterPodNetworkOptionArgs>

Available CNIs and network options for existing and new node pools of the cluster

compartmentId String

The OCID of the compartment in which to create the cluster.

definedTags Map<String,Object>

(Updatable) Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see Resource Tags. Example: {"Operations.CostCenter": "42"}

endpointConfig ClusterEndpointConfigArgs

The network configuration for access to the Cluster control plane.

endpoints List<ClusterEndpointArgs>

Endpoints served up by the cluster masters.

freeformTags Map<String,Object>

(Updatable) 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. Example: {"Department": "Finance"}

imagePolicyConfig ClusterImagePolicyConfigArgs

(Updatable) 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 String

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.

kubernetesVersion String

(Updatable) The version of Kubernetes to install into the cluster masters.

lifecycleDetails String

Details about the state of the cluster masters.

metadatas List<ClusterMetadataArgs>

Metadata about the cluster.

name String

(Updatable) The name of the cluster. Avoid entering confidential information.

options ClusterOptionsArgs

(Updatable) Optional attributes for the cluster.

state String

The state of the cluster masters.

vcnId String

The OCID of the virtual cloud network (VCN) in which to create the cluster.

availableKubernetesUpgrades string[]

Available Kubernetes versions to which the clusters masters may be upgraded.

clusterPodNetworkOptions ClusterClusterPodNetworkOptionArgs[]

Available CNIs and network options for existing and new node pools of the cluster

compartmentId string

The OCID of the compartment in which to create the cluster.

definedTags {[key: string]: any}

(Updatable) Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see Resource Tags. Example: {"Operations.CostCenter": "42"}

endpointConfig ClusterEndpointConfigArgs

The network configuration for access to the Cluster control plane.

endpoints ClusterEndpointArgs[]

Endpoints served up by the cluster masters.

freeformTags {[key: string]: any}

(Updatable) 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. Example: {"Department": "Finance"}

imagePolicyConfig ClusterImagePolicyConfigArgs

(Updatable) 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 string

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.

kubernetesVersion string

(Updatable) The version of Kubernetes to install into the cluster masters.

lifecycleDetails string

Details about the state of the cluster masters.

metadatas ClusterMetadataArgs[]

Metadata about the cluster.

name string

(Updatable) The name of the cluster. Avoid entering confidential information.

options ClusterOptionsArgs

(Updatable) Optional attributes for the cluster.

state string

The state of the cluster masters.

vcnId string

The OCID of the virtual cloud network (VCN) in which to create the cluster.

available_kubernetes_upgrades Sequence[str]

Available Kubernetes versions to which the clusters masters may be upgraded.

cluster_pod_network_options ClusterClusterPodNetworkOptionArgs]

Available CNIs and network options for existing and new node pools of the cluster

compartment_id str

The OCID of the compartment in which to create the cluster.

defined_tags Mapping[str, Any]

(Updatable) Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see Resource Tags. Example: {"Operations.CostCenter": "42"}

endpoint_config ClusterEndpointConfigArgs

The network configuration for access to the Cluster control plane.

endpoints ClusterEndpointArgs]

Endpoints served up by the cluster masters.

freeform_tags Mapping[str, Any]

(Updatable) 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. Example: {"Department": "Finance"}

image_policy_config ClusterImagePolicyConfigArgs

(Updatable) 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.

kms_key_id str

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.

kubernetes_version str

(Updatable) The version of Kubernetes to install into the cluster masters.

lifecycle_details str

Details about the state of the cluster masters.

metadatas ClusterMetadataArgs]

Metadata about the cluster.

name str

(Updatable) The name of the cluster. Avoid entering confidential information.

options ClusterOptionsArgs

(Updatable) Optional attributes for the cluster.

state str

The state of the cluster masters.

vcn_id str

The OCID of the virtual cloud network (VCN) in which to create the cluster.

availableKubernetesUpgrades List<String>

Available Kubernetes versions to which the clusters masters may be upgraded.

clusterPodNetworkOptions List<Property Map>

Available CNIs and network options for existing and new node pools of the cluster

compartmentId String

The OCID of the compartment in which to create the cluster.

definedTags Map<Any>

(Updatable) Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see Resource Tags. Example: {"Operations.CostCenter": "42"}

endpointConfig Property Map

The network configuration for access to the Cluster control plane.

endpoints List<Property Map>

Endpoints served up by the cluster masters.

freeformTags Map<Any>

(Updatable) 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. Example: {"Department": "Finance"}

imagePolicyConfig Property Map

(Updatable) 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 String

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.

kubernetesVersion String

(Updatable) The version of Kubernetes to install into the cluster masters.

lifecycleDetails String

Details about the state of the cluster masters.

metadatas List<Property Map>

Metadata about the cluster.

name String

(Updatable) The name of the cluster. Avoid entering confidential information.

options Property Map

(Updatable) Optional attributes for the cluster.

state String

The state of the cluster masters.

vcnId String

The OCID of the virtual cloud network (VCN) in which to create the cluster.

Supporting Types

ClusterClusterPodNetworkOption

CniType string

The CNI used by the node pools of this cluster

CniType string

The CNI used by the node pools of this cluster

cniType String

The CNI used by the node pools of this cluster

cniType string

The CNI used by the node pools of this cluster

cni_type str

The CNI used by the node pools of this cluster

cniType String

The CNI used by the node pools of this cluster

ClusterEndpoint

Kubernetes string

The non-native networking Kubernetes API server endpoint.

PrivateEndpoint string

The private native networking Kubernetes API server endpoint.

PublicEndpoint string

The public native networking Kubernetes API server endpoint, if one was requested.

VcnHostnameEndpoint string

The FQDN assigned to the Kubernetes API private endpoint. Example: 'https://yourVcnHostnameEndpoint'

Kubernetes string

The non-native networking Kubernetes API server endpoint.

PrivateEndpoint string

The private native networking Kubernetes API server endpoint.

PublicEndpoint string

The public native networking Kubernetes API server endpoint, if one was requested.

VcnHostnameEndpoint string

The FQDN assigned to the Kubernetes API private endpoint. Example: 'https://yourVcnHostnameEndpoint'

kubernetes String

The non-native networking Kubernetes API server endpoint.

privateEndpoint String

The private native networking Kubernetes API server endpoint.

publicEndpoint String

The public native networking Kubernetes API server endpoint, if one was requested.

vcnHostnameEndpoint String

The FQDN assigned to the Kubernetes API private endpoint. Example: 'https://yourVcnHostnameEndpoint'

kubernetes string

The non-native networking Kubernetes API server endpoint.

privateEndpoint string

The private native networking Kubernetes API server endpoint.

publicEndpoint string

The public native networking Kubernetes API server endpoint, if one was requested.

vcnHostnameEndpoint string

The FQDN assigned to the Kubernetes API private endpoint. Example: 'https://yourVcnHostnameEndpoint'

kubernetes str

The non-native networking Kubernetes API server endpoint.

private_endpoint str

The private native networking Kubernetes API server endpoint.

public_endpoint str

The public native networking Kubernetes API server endpoint, if one was requested.

vcn_hostname_endpoint str

The FQDN assigned to the Kubernetes API private endpoint. Example: 'https://yourVcnHostnameEndpoint'

kubernetes String

The non-native networking Kubernetes API server endpoint.

privateEndpoint String

The private native networking Kubernetes API server endpoint.

publicEndpoint String

The public native networking Kubernetes API server endpoint, if one was requested.

vcnHostnameEndpoint String

The FQDN assigned to the Kubernetes API private endpoint. Example: 'https://yourVcnHostnameEndpoint'

ClusterEndpointConfig

SubnetId string

The OCID of the regional subnet in which to place the Cluster endpoint.

IsPublicIpEnabled bool

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.

NsgIds List<string>

A list of the OCIDs of the network security groups (NSGs) to apply to the cluster endpoint. For more information about NSGs, see NetworkSecurityGroup.

SubnetId string

The OCID of the regional subnet in which to place the Cluster endpoint.

IsPublicIpEnabled bool

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.

NsgIds []string

A list of the OCIDs of the network security groups (NSGs) to apply to the cluster endpoint. For more information about NSGs, see NetworkSecurityGroup.

subnetId String

The OCID of the regional subnet in which to place the Cluster endpoint.

isPublicIpEnabled Boolean

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.

nsgIds List<String>

A list of the OCIDs of the network security groups (NSGs) to apply to the cluster endpoint. For more information about NSGs, see NetworkSecurityGroup.

subnetId string

The OCID of the regional subnet in which to place the Cluster endpoint.

isPublicIpEnabled boolean

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.

nsgIds string[]

A list of the OCIDs of the network security groups (NSGs) to apply to the cluster endpoint. For more information about NSGs, see NetworkSecurityGroup.

subnet_id str

The OCID of the regional subnet in which to place the Cluster endpoint.

is_public_ip_enabled bool

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.

nsg_ids Sequence[str]

A list of the OCIDs of the network security groups (NSGs) to apply to the cluster endpoint. For more information about NSGs, see NetworkSecurityGroup.

subnetId String

The OCID of the regional subnet in which to place the Cluster endpoint.

isPublicIpEnabled Boolean

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.

nsgIds List<String>

A list of the OCIDs of the network security groups (NSGs) to apply to the cluster endpoint. For more information about NSGs, see NetworkSecurityGroup.

ClusterImagePolicyConfig

IsPolicyEnabled bool

(Updatable) Whether the image verification policy is enabled. Defaults to false. If set to true, the images will be verified against the policy at runtime.

KeyDetails List<ClusterImagePolicyConfigKeyDetail>

(Updatable) A list of KMS key details.

IsPolicyEnabled bool

(Updatable) Whether the image verification policy is enabled. Defaults to false. If set to true, the images will be verified against the policy at runtime.

KeyDetails []ClusterImagePolicyConfigKeyDetail

(Updatable) A list of KMS key details.

isPolicyEnabled Boolean

(Updatable) Whether the image verification policy is enabled. Defaults to false. If set to true, the images will be verified against the policy at runtime.

keyDetails List<ClusterImagePolicyConfigKeyDetail>

(Updatable) A list of KMS key details.

isPolicyEnabled boolean

(Updatable) Whether the image verification policy is enabled. Defaults to false. If set to true, the images will be verified against the policy at runtime.

keyDetails ClusterImagePolicyConfigKeyDetail[]

(Updatable) A list of KMS key details.

is_policy_enabled bool

(Updatable) Whether the image verification policy is enabled. Defaults to false. If set to true, the images will be verified against the policy at runtime.

key_details ClusterImagePolicyConfigKeyDetail]

(Updatable) A list of KMS key details.

isPolicyEnabled Boolean

(Updatable) Whether the image verification policy is enabled. Defaults to false. If set to true, the images will be verified against the policy at runtime.

keyDetails List<Property Map>

(Updatable) A list of KMS key details.

ClusterImagePolicyConfigKeyDetail

KmsKeyId string

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.

KmsKeyId string

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.

kmsKeyId String

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.

kmsKeyId string

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.

kms_key_id str

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.

kmsKeyId String

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.

ClusterMetadata

CreatedByUserId string

The user who created the cluster.

CreatedByWorkRequestId string

The OCID of the work request which created the cluster.

DeletedByUserId string

The user who deleted the cluster.

DeletedByWorkRequestId string

The OCID of the work request which deleted the cluster.

TimeCreated string

The time the cluster was created.

TimeDeleted string

The time the cluster was deleted.

TimeUpdated string

The time the cluster was updated.

UpdatedByUserId string

The user who updated the cluster.

UpdatedByWorkRequestId string

The OCID of the work request which updated the cluster.

CreatedByUserId string

The user who created the cluster.

CreatedByWorkRequestId string

The OCID of the work request which created the cluster.

DeletedByUserId string

The user who deleted the cluster.

DeletedByWorkRequestId string

The OCID of the work request which deleted the cluster.

TimeCreated string

The time the cluster was created.

TimeDeleted string

The time the cluster was deleted.

TimeUpdated string

The time the cluster was updated.

UpdatedByUserId string

The user who updated the cluster.

UpdatedByWorkRequestId string

The OCID of the work request which updated the cluster.

createdByUserId String

The user who created the cluster.

createdByWorkRequestId String

The OCID of the work request which created the cluster.

deletedByUserId String

The user who deleted the cluster.

deletedByWorkRequestId String

The OCID of the work request which deleted the cluster.

timeCreated String

The time the cluster was created.

timeDeleted String

The time the cluster was deleted.

timeUpdated String

The time the cluster was updated.

updatedByUserId String

The user who updated the cluster.

updatedByWorkRequestId String

The OCID of the work request which updated the cluster.

createdByUserId string

The user who created the cluster.

createdByWorkRequestId string

The OCID of the work request which created the cluster.

deletedByUserId string

The user who deleted the cluster.

deletedByWorkRequestId string

The OCID of the work request which deleted the cluster.

timeCreated string

The time the cluster was created.

timeDeleted string

The time the cluster was deleted.

timeUpdated string

The time the cluster was updated.

updatedByUserId string

The user who updated the cluster.

updatedByWorkRequestId string

The OCID of the work request which updated the cluster.

created_by_user_id str

The user who created the cluster.

created_by_work_request_id str

The OCID of the work request which created the cluster.

deleted_by_user_id str

The user who deleted the cluster.

deleted_by_work_request_id str

The OCID of the work request which deleted the cluster.

time_created str

The time the cluster was created.

time_deleted str

The time the cluster was deleted.

time_updated str

The time the cluster was updated.

updated_by_user_id str

The user who updated the cluster.

updated_by_work_request_id str

The OCID of the work request which updated the cluster.

createdByUserId String

The user who created the cluster.

createdByWorkRequestId String

The OCID of the work request which created the cluster.

deletedByUserId String

The user who deleted the cluster.

deletedByWorkRequestId String

The OCID of the work request which deleted the cluster.

timeCreated String

The time the cluster was created.

timeDeleted String

The time the cluster was deleted.

timeUpdated String

The time the cluster was updated.

updatedByUserId String

The user who updated the cluster.

updatedByWorkRequestId String

The OCID of the work request which updated the cluster.

ClusterOptions

AddOns ClusterOptionsAddOns

Configurable cluster add-ons

AdmissionControllerOptions ClusterOptionsAdmissionControllerOptions

(Updatable) Configurable cluster admission controllers

KubernetesNetworkConfig ClusterOptionsKubernetesNetworkConfig

Network configuration for Kubernetes.

PersistentVolumeConfig ClusterOptionsPersistentVolumeConfig

(Updatable) Configuration to be applied to block volumes created by Kubernetes Persistent Volume Claims (PVC)

ServiceLbConfig ClusterOptionsServiceLbConfig

(Updatable) Configuration to be applied to load balancers created by Kubernetes services

ServiceLbSubnetIds List<string>

The OCIDs of the subnets used for Kubernetes services load balancers.

AddOns ClusterOptionsAddOns

Configurable cluster add-ons

AdmissionControllerOptions ClusterOptionsAdmissionControllerOptions

(Updatable) Configurable cluster admission controllers

KubernetesNetworkConfig ClusterOptionsKubernetesNetworkConfig

Network configuration for Kubernetes.

PersistentVolumeConfig ClusterOptionsPersistentVolumeConfig

(Updatable) Configuration to be applied to block volumes created by Kubernetes Persistent Volume Claims (PVC)

ServiceLbConfig ClusterOptionsServiceLbConfig

(Updatable) Configuration to be applied to load balancers created by Kubernetes services

ServiceLbSubnetIds []string

The OCIDs of the subnets used for Kubernetes services load balancers.

addOns ClusterOptionsAddOns

Configurable cluster add-ons

admissionControllerOptions ClusterOptionsAdmissionControllerOptions

(Updatable) Configurable cluster admission controllers

kubernetesNetworkConfig ClusterOptionsKubernetesNetworkConfig

Network configuration for Kubernetes.

persistentVolumeConfig ClusterOptionsPersistentVolumeConfig

(Updatable) Configuration to be applied to block volumes created by Kubernetes Persistent Volume Claims (PVC)

serviceLbConfig ClusterOptionsServiceLbConfig

(Updatable) Configuration to be applied to load balancers created by Kubernetes services

serviceLbSubnetIds List<String>

The OCIDs of the subnets used for Kubernetes services load balancers.

addOns ClusterOptionsAddOns

Configurable cluster add-ons

admissionControllerOptions ClusterOptionsAdmissionControllerOptions

(Updatable) Configurable cluster admission controllers

kubernetesNetworkConfig ClusterOptionsKubernetesNetworkConfig

Network configuration for Kubernetes.

persistentVolumeConfig ClusterOptionsPersistentVolumeConfig

(Updatable) Configuration to be applied to block volumes created by Kubernetes Persistent Volume Claims (PVC)

serviceLbConfig ClusterOptionsServiceLbConfig

(Updatable) Configuration to be applied to load balancers created by Kubernetes services

serviceLbSubnetIds string[]

The OCIDs of the subnets used for Kubernetes services load balancers.

add_ons ClusterOptionsAddOns

Configurable cluster add-ons

admission_controller_options ClusterOptionsAdmissionControllerOptions

(Updatable) Configurable cluster admission controllers

kubernetes_network_config ClusterOptionsKubernetesNetworkConfig

Network configuration for Kubernetes.

persistent_volume_config ClusterOptionsPersistentVolumeConfig

(Updatable) Configuration to be applied to block volumes created by Kubernetes Persistent Volume Claims (PVC)

service_lb_config ClusterOptionsServiceLbConfig

(Updatable) Configuration to be applied to load balancers created by Kubernetes services

service_lb_subnet_ids Sequence[str]

The OCIDs of the subnets used for Kubernetes services load balancers.

addOns Property Map

Configurable cluster add-ons

admissionControllerOptions Property Map

(Updatable) Configurable cluster admission controllers

kubernetesNetworkConfig Property Map

Network configuration for Kubernetes.

persistentVolumeConfig Property Map

(Updatable) Configuration to be applied to block volumes created by Kubernetes Persistent Volume Claims (PVC)

serviceLbConfig Property Map

(Updatable) Configuration to be applied to load balancers created by Kubernetes services

serviceLbSubnetIds List<String>

The OCIDs of the subnets used for Kubernetes services load balancers.

ClusterOptionsAddOns

IsKubernetesDashboardEnabled bool

Whether or not to enable the Kubernetes Dashboard add-on.

IsTillerEnabled bool

Whether or not to enable the Tiller add-on.

IsKubernetesDashboardEnabled bool

Whether or not to enable the Kubernetes Dashboard add-on.

IsTillerEnabled bool

Whether or not to enable the Tiller add-on.

isKubernetesDashboardEnabled Boolean

Whether or not to enable the Kubernetes Dashboard add-on.

isTillerEnabled Boolean

Whether or not to enable the Tiller add-on.

isKubernetesDashboardEnabled boolean

Whether or not to enable the Kubernetes Dashboard add-on.

isTillerEnabled boolean

Whether or not to enable the Tiller add-on.

is_kubernetes_dashboard_enabled bool

Whether or not to enable the Kubernetes Dashboard add-on.

is_tiller_enabled bool

Whether or not to enable the Tiller add-on.

isKubernetesDashboardEnabled Boolean

Whether or not to enable the Kubernetes Dashboard add-on.

isTillerEnabled Boolean

Whether or not to enable the Tiller add-on.

ClusterOptionsAdmissionControllerOptions

IsPodSecurityPolicyEnabled bool

(Updatable) Whether or not to enable the Pod Security Policy admission controller.

IsPodSecurityPolicyEnabled bool

(Updatable) Whether or not to enable the Pod Security Policy admission controller.

isPodSecurityPolicyEnabled Boolean

(Updatable) Whether or not to enable the Pod Security Policy admission controller.

isPodSecurityPolicyEnabled boolean

(Updatable) Whether or not to enable the Pod Security Policy admission controller.

is_pod_security_policy_enabled bool

(Updatable) Whether or not to enable the Pod Security Policy admission controller.

isPodSecurityPolicyEnabled Boolean

(Updatable) Whether or not to enable the Pod Security Policy admission controller.

ClusterOptionsKubernetesNetworkConfig

PodsCidr string

The CIDR block for Kubernetes pods. Optional, defaults to 10.244.0.0/16.

ServicesCidr string

The CIDR block for Kubernetes services. Optional, defaults to 10.96.0.0/16.

PodsCidr string

The CIDR block for Kubernetes pods. Optional, defaults to 10.244.0.0/16.

ServicesCidr string

The CIDR block for Kubernetes services. Optional, defaults to 10.96.0.0/16.

podsCidr String

The CIDR block for Kubernetes pods. Optional, defaults to 10.244.0.0/16.

servicesCidr String

The CIDR block for Kubernetes services. Optional, defaults to 10.96.0.0/16.

podsCidr string

The CIDR block for Kubernetes pods. Optional, defaults to 10.244.0.0/16.

servicesCidr string

The CIDR block for Kubernetes services. Optional, defaults to 10.96.0.0/16.

pods_cidr str

The CIDR block for Kubernetes pods. Optional, defaults to 10.244.0.0/16.

services_cidr str

The CIDR block for Kubernetes services. Optional, defaults to 10.96.0.0/16.

podsCidr String

The CIDR block for Kubernetes pods. Optional, defaults to 10.244.0.0/16.

servicesCidr String

The CIDR block for Kubernetes services. Optional, defaults to 10.96.0.0/16.

ClusterOptionsPersistentVolumeConfig

DefinedTags Dictionary<string, object>

(Updatable) Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see Resource Tags. Example: {"Operations.CostCenter": "42"}

FreeformTags Dictionary<string, object>

(Updatable) 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. Example: {"Department": "Finance"}

DefinedTags map[string]interface{}

(Updatable) Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see Resource Tags. Example: {"Operations.CostCenter": "42"}

FreeformTags map[string]interface{}

(Updatable) 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. Example: {"Department": "Finance"}

definedTags Map<String,Object>

(Updatable) Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see Resource Tags. Example: {"Operations.CostCenter": "42"}

freeformTags Map<String,Object>

(Updatable) 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. Example: {"Department": "Finance"}

definedTags {[key: string]: any}

(Updatable) Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see Resource Tags. Example: {"Operations.CostCenter": "42"}

freeformTags {[key: string]: any}

(Updatable) 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. Example: {"Department": "Finance"}

defined_tags Mapping[str, Any]

(Updatable) Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see Resource Tags. Example: {"Operations.CostCenter": "42"}

freeform_tags Mapping[str, Any]

(Updatable) 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. Example: {"Department": "Finance"}

definedTags Map<Any>

(Updatable) Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see Resource Tags. Example: {"Operations.CostCenter": "42"}

freeformTags Map<Any>

(Updatable) 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. Example: {"Department": "Finance"}

ClusterOptionsServiceLbConfig

DefinedTags Dictionary<string, object>

(Updatable) Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see Resource Tags. Example: {"Operations.CostCenter": "42"}

FreeformTags Dictionary<string, object>

(Updatable) 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. Example: {"Department": "Finance"}

DefinedTags map[string]interface{}

(Updatable) Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see Resource Tags. Example: {"Operations.CostCenter": "42"}

FreeformTags map[string]interface{}

(Updatable) 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. Example: {"Department": "Finance"}

definedTags Map<String,Object>

(Updatable) Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see Resource Tags. Example: {"Operations.CostCenter": "42"}

freeformTags Map<String,Object>

(Updatable) 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. Example: {"Department": "Finance"}

definedTags {[key: string]: any}

(Updatable) Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see Resource Tags. Example: {"Operations.CostCenter": "42"}

freeformTags {[key: string]: any}

(Updatable) 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. Example: {"Department": "Finance"}

defined_tags Mapping[str, Any]

(Updatable) Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see Resource Tags. Example: {"Operations.CostCenter": "42"}

freeform_tags Mapping[str, Any]

(Updatable) 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. Example: {"Department": "Finance"}

definedTags Map<Any>

(Updatable) Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see Resource Tags. Example: {"Operations.CostCenter": "42"}

freeformTags Map<Any>

(Updatable) 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. Example: {"Department": "Finance"}

Import

Clusters can be imported using the id, e.g.

 $ pulumi import oci:ContainerEngine/cluster:Cluster test_cluster "id"

Package Details

Repository
https://github.com/pulumi/pulumi-oci
License
Apache-2.0
Notes

This Pulumi package is based on the oci Terraform Provider.