Kubernetes

class Kubernetes : KotlinCustomResource

This resource will help you to manage a Kubernetes Cluster in Alibaba Cloud Kubernetes Service, see What is kubernetes.

NOTE: Available since v1.9.0. NOTE: Kubernetes cluster only supports VPC network and it can access internet while creating kubernetes cluster. A Nat Gateway and configuring a SNAT for it can ensure one VPC network access internet. If there is no nat gateway in the VPC, you can set new_nat_gateway to "true" to create one automatically. NOTE: Each kubernetes cluster contains 3 master nodes and those number cannot be changed at now. NOTE: Creating kubernetes cluster need to install several packages and it will cost about 15 minutes. Please be patient. NOTE: From version 1.9.4, the provider supports to download kube config, client certificate, client key and cluster ca certificate after creating cluster successfully, and you can put them into the specified location, like '~/.kube/config'. NOTE: From version 1.16.0, the provider supports Multiple Availability Zones Kubernetes Cluster. To create a cluster of this kind, you must specify 3 or 5 items in master_vswitch_ids and master_instance_types. NOTE: From version 1.20.0, the provider supports disabling internet load balancer for API Server by setting false to slb_internet_enabled. NOTE: If you want to manage Kubernetes, you can use Kubernetes Provider. NOTE: You need to activate several other products and confirm Authorization Policy used by Container Service before using this resource. Please refer to the Authorization management and Cluster management sections in the Document Center. NOTE: From version 1.75.0, Some parameters have been removed from resource,You can check them below and re-import the cluster if necessary. NOTE: From version 1.101.0+, We supported the professional managed clusters(ack-pro), You can create a pro cluster by setting the the value of cluster_spec. NOTE: From version 1.177.0+, exclude_autoscaler_nodes,worker_number,worker_vswitch_ids,worker_instance_types,password,key_name,kms_encrypted_password,kms_encryption_context,worker_instance_charge_type,worker_period,worker_period_unit,worker_auto_renew,worker_auto_renew_period,worker_disk_category,worker_disk_size,worker_data_disks,node_name_mode,node_port_range,os_type,platform,cpu_policy,user_data,taints,worker_disk_performance_level,worker_disk_snapshot_policy_id are deprecated. We Suggest you using resource alicloud.cs.NodePool to manage your cluster worker nodes.

Import

Kubernetes cluster can be imported using the id, e.g. Then complete the main.tf accords to the result of pulumi preview.

$ pulumi import alicloud:cs/kubernetes:Kubernetes main cluster-id

Properties

Link copied to clipboard
val addons: Output<List<KubernetesAddon>>?

The addon you want to install in cluster. See addons below.

Link copied to clipboard
val apiAudiences: Output<List<String>>?

A list of API audiences for Service Account Token Volume Projection. Set this to ["https://kubernetes&#46;default&#46;svc"] if you want to enable the Token Volume Projection feature requires specifying service_account_issuer as well. From cluster version 1.22+, Service Account Token Volume Projection will be enabled by default.

Link copied to clipboard

The Zone where new kubernetes cluster will be located. If it is not be specified, the vswitch_ids should be set, its value will be vswitch's zone. Removed params

Link copied to clipboard

Nested attribute containing certificate authority data for your cluster.

Link copied to clipboard
val clientCert: Output<String>?

The path of client certificate, like ~/.kube/client-cert.pem.

Link copied to clipboard
val clientKey: Output<String>?

The path of client key, like ~/.kube/client-key.pem.

Link copied to clipboard
val clusterCaCert: Output<String>?

The path of cluster ca certificate, like ~/.kube/cluster-ca-cert.pem

Link copied to clipboard
val clusterDomain: Output<String>?

Cluster local domain name, Default to cluster.local. A domain name consists of one or more sections separated by a decimal point (.), each of which is up to 63 characters long, and can be lowercase, numerals, and underscores (-), and must be lowercase or numerals at the beginning and end.

Link copied to clipboard

Map of kubernetes cluster connection information.

Link copied to clipboard
val cpuPolicy: Output<String>?

Kubelet cpu policy. For Kubernetes 1.12.6 and later, its valid value is either static or none. Default to none.

Link copied to clipboard
val customSan: Output<String>?

Customize the certificate SAN, multiple IP or domain names are separated by English commas (,).

Link copied to clipboard

Whether to enable cluster deletion protection.

Link copied to clipboard
val enableSsh: Output<Boolean>?

Enable login to the node through SSH. Default to false.

Link copied to clipboard

Exclude autoscaler nodes from worker_nodes. Default to false.

Link copied to clipboard
val id: Output<String>
Link copied to clipboard
val imageId: Output<String>?

Custom Image support. Must based on CentOS7 or AliyunLinux2.

Link copied to clipboard

Install cloud monitor agent on ECS. Default to true.

Link copied to clipboard

Enable to create advanced security group. default: false. See Advanced security group.

Link copied to clipboard
val keyName: Output<String>?

The keypair of ssh login cluster node, you have to create it first. You have to specify one of password key_name kms_encrypted_password fields.

Link copied to clipboard

An KMS encrypts password used to a cs kubernetes. You have to specify one of password key_name kms_encrypted_password fields.

Link copied to clipboard

An KMS encryption context used to decrypt kms_encrypted_password before creating or updating a cs kubernetes with kms_encrypted_password. See Encryption Context. It is valid when kms_encrypted_password is set.

Link copied to clipboard
val kubeConfig: Output<String>?

The path of kube config, like ~/.kube/config.

Link copied to clipboard
val loadBalancerSpec: Output<String>?

The cluster api server load balance instance specification, default slb.s1.small. For more information on how to select a LB instance specification, see SLB instance overview.

Link copied to clipboard
val masterAutoRenew: Output<Boolean>?

Enable master payment auto-renew, defaults to false.

Link copied to clipboard

Master payment auto-renew period, it can be one of {1, 2, 3, 6, 12}.

Link copied to clipboard

The system disk category of master node. Its valid value are cloud_ssd, cloud_essd and cloud_efficiency. Default to cloud_efficiency.

Link copied to clipboard

Master node system disk performance level. When master_disk_category values cloud_essd, the optional values are PL0, PL1, PL2 or PL3, but the specific performance level is related to the disk capacity. For more information, see Enhanced SSDs. Default is PL1.

Link copied to clipboard
val masterDiskSize: Output<Int>?

The system disk size of master node. Its valid value range 20~500 in GB. Default to 20.

Link copied to clipboard

Master node system disk auto snapshot policy. Worker params

Link copied to clipboard

Master payment type. or PostPaid or PrePaid, defaults to PostPaid. If value is PrePaid, the files master_period, master_period_unit, master_auto_renew and master_auto_renew_period are required.

Link copied to clipboard

The instance type of master node. Specify one type for single AZ Cluster, three types for MultiAZ Cluster.

Link copied to clipboard

The master nodes. See master_nodes below. Network params

Link copied to clipboard
val masterPeriod: Output<Int>?

Master payment period.Its valid value is one of {1, 2, 3, 6, 12, 24, 36, 48, 60}.

Link copied to clipboard
val masterPeriodUnit: Output<String>?

Master payment period unit, the valid value is Month.

Link copied to clipboard

The vswitches used by master, you can specific 3 or 5 vswitches because of the amount of masters. Detailed below.

Link copied to clipboard
val name: Output<String>

The kubernetes cluster's name. It is unique in one Alicloud account.

Link copied to clipboard
val namePrefix: Output<String>?
Link copied to clipboard
val natGatewayId: Output<String>

The ID of nat gateway used to launch kubernetes cluster.

Link copied to clipboard
val newNatGateway: Output<Boolean>?

Whether to create a new nat gateway while creating kubernetes cluster. Default to true. Then openapi in Alibaba Cloud are not all on intranet, So turn this option on is a good choice. Your cluster nodes and applications will have public network access. If there is a NAT gateway in the selected VPC, ACK will use this gateway by default; if there is no NAT gateway in the selected VPC, ACK will create a new NAT gateway for you and automatically configure SNAT rules.

Link copied to clipboard
val nodeCidrMask: Output<Int>?

The node cidr block to specific how many pods can run on single node. 24-28 is allowed. 24 means 2^(32-24)-1=255 and the node can run at most 255 pods. default: 24

Link copied to clipboard
val nodeNameMode: Output<String>?

Each node name consists of a prefix, an IP substring, and a suffix, the input format is customized,<prefix>,IPSubStringLen,<suffix>. For example "customized,aliyun.com-,5,-test", if the node IP address is 192.168.59.176, the prefix is aliyun.com-, IP substring length is 5, and the suffix is -test, the node name will be aliyun.com-59176-test.

Link copied to clipboard
val nodePortRange: Output<String>

The service port range of nodes, valid values: 30000 to 65535. Default to 30000-32767.

Link copied to clipboard
val osType: Output<String>?

The operating system of the nodes that run pods, its valid value is either Linux or Windows. Default to Linux.

Link copied to clipboard
val password: Output<String>?

The password of ssh login cluster node. You have to specify one of password key_name kms_encrypted_password fields.

Link copied to clipboard
val platform: Output<String>

The architecture of the nodes that run pods, its valid value is either CentOS or AliyunLinux. Default to CentOS.

Link copied to clipboard
val podCidr: Output<String>?

Flannel Specific The CIDR block for the pod network when using Flannel.

Link copied to clipboard
val podVswitchIds: Output<List<String>>?

Terway Specific The vswitches for the pod network when using Terway.Be careful the pod_vswitch_ids can not equal to worker_vswitch_ids or master_vswitch_ids but must be in same availability zones.

Link copied to clipboard
val proxyMode: Output<String>?

Proxy mode is option of kube-proxy. options: iptables | ipvs. default: ipvs.

Link copied to clipboard
val pulumiChildResources: Set<KotlinResource>
Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
val rdsInstances: Output<List<String>>?

RDS instance list, You can choose which RDS instances whitelist to add instances to.

Link copied to clipboard
val resourceGroupId: Output<String>

The ID of the resource group,by default these cloud resources are automatically assigned to the default resource group.

Link copied to clipboard
val retainResources: Output<List<String>>?
Link copied to clipboard

The runtime of containers. If you select another container runtime, see How do I select between Docker and Sandboxed-Container. Detailed below.

Link copied to clipboard
val securityGroupId: Output<String>

The ID of the security group to which the ECS instances in the cluster belong. If it is not specified, a new Security group will be built.

Link copied to clipboard

The issuer of the Service Account token for Service Account Token Volume Projection, corresponds to the iss field in the token payload. Set this to "https://kubernetes.default.svc" to enable the Token Volume Projection feature (requires specifying api_audiences as well). From cluster version 1.22+, Service Account Token Volume Projection will be enabled by default.

Link copied to clipboard
val serviceCidr: Output<String>?

The CIDR block for the service network. It cannot be duplicated with the VPC CIDR and CIDR used by Kubernetes cluster in VPC, cannot be modified after creation.

Link copied to clipboard
val slbId: Output<String>

The ID of load balancer.

Link copied to clipboard
val slbInternet: Output<String>

The public ip of load balancer.

Link copied to clipboard

Whether to create internet load balancer for API Server. Default to true.

Link copied to clipboard
val slbIntranet: Output<String>

The ID of private load balancer where the current cluster master node is located.

Link copied to clipboard
val tags: Output<Map<String, Any>>?

Default nil, A map of tags assigned to the kubernetes cluster and work nodes.

Link copied to clipboard
val taints: Output<List<KubernetesTaint>>?

Taints ensure pods are not scheduled onto inappropriate nodes. One or more taints are applied to a node; this marks that the node should not accept any pods that do not tolerate the taints. For more information, see Taints and Tolerations. See taints below.

Link copied to clipboard
val timezone: Output<String>?

When you create a cluster, set the time zones for the Master and Worker nodes. You can only change the managed node time zone if you create a cluster. Once the cluster is created, you can only change the time zone of the Worker node.

Link copied to clipboard
val urn: Output<String>
Link copied to clipboard
val userCa: Output<String>?

The path of customized CA cert, you can use this CA to sign client certs to connect your cluster.

Link copied to clipboard
val userData: Output<String>?

Custom data that can execute on nodes. For more information, see Prepare user data.

Link copied to clipboard
val version: Output<String>

Desired Kubernetes version. If you do not specify a value, the latest available version at resource creation is used and no upgrades will occur except you set a higher version number. The value must be configured and increased to upgrade the version when desired. Downgrades are not supported by ACK.

Link copied to clipboard
val vpcId: Output<String>

The ID of VPC where the current cluster is located.

Link copied to clipboard
val workerAutoRenew: Output<Boolean>?

Enable worker payment auto-renew, defaults to false.

Link copied to clipboard

Worker payment auto-renew period, it can be one of {1, 2, 3, 6, 12}.

Link copied to clipboard

The data disk category of worker, use worker_data_disks to instead it.

Link copied to clipboard

The data disk configurations of worker nodes, such as the disk type and disk size. See worker_data_disks below.

Link copied to clipboard
val workerDataDiskSize: Output<Int>?

The data disk size of worker, use worker_data_disks to instead it.

Link copied to clipboard

The system disk category of worker node. Its valid value are cloud, cloud_ssd, cloud_essd and cloud_efficiency. Default to cloud_efficiency.

Link copied to clipboard

Worker node system disk performance level, when worker_disk_category values cloud_essd, the optional values are PL0, PL1, PL2 or PL3, but the specific performance level is related to the disk capacity. For more information, see Enhanced SSDs. Default is PL1.

Link copied to clipboard
val workerDiskSize: Output<Int>

The system disk size of worker node. Its valid value range 40~500 in GB.

Link copied to clipboard

Worker node system disk auto snapshot policy. Computed params You can set some file paths to save kube_config information, but this way is cumbersome. Since version 1.105.0, we've written it to tf state file. About its use,see export attribute certificate_authority. From version 1.187.0+, new DataSource alicloud.cs.getClusterCredential is recommended to manage cluster's kube_config.

Link copied to clipboard

Worker payment type, its valid value is either or PostPaid or PrePaid. Defaults to PostPaid. If value is PrePaid, the files worker_period, worker_period_unit, worker_auto_renew and worker_auto_renew_period are required, default is PostPaid.

Link copied to clipboard

The instance type of worker node. Specify one type for single AZ Cluster, three types for MultiAZ Cluster.

Link copied to clipboard

List of cluster worker nodes. See worker_nodes below.

Link copied to clipboard
val workerNumber: Output<Int>?

The worker node number of the kubernetes cluster. Default to 3. It is limited up to 50 and if you want to enlarge it, please apply white list or contact with us.

Link copied to clipboard
val workerPeriod: Output<Int>

Worker payment period. The unit is Month. Its valid value is one of {1, 2, 3, 6, 12, 24, 36, 48, 60}.

Link copied to clipboard

Worker payment period unit, the valid value is Month.

Link copied to clipboard

The RamRole Name attached to worker node.

Link copied to clipboard

The vswitches used by workers.