You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: docs/resources/cluster.md
+13-4Lines changed: 13 additions & 4 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -1914,14 +1914,20 @@ The following arguments are supported:
1914
1914
1915
1915
The following arguments are supported:
1916
1916
1917
+
*`cluster_type` - (Optional) Choose `basic` or `enhanced`. Default `basic` (string)
1917
1918
*`compartment_id` - (Required) The OCID of the compartment in which to create resources OKE cluster and related resources (string)
1919
+
*`control_plane_subnet_name` - (Optional) The name of an existing subnet to use for the Kubernetes API endpoint. `vcn_name` is also required when specifying an existing subnet. (string)
1918
1920
*`custom_boot_volume_size` - (Optional) Optional custom boot volume size (GB) for all nodes. If you specify 0, it will apply the default according to the `node_image` specified. Default `0` (int)
1919
1921
*`description` - (Optional) An optional description of this cluster (string)
1920
1922
*`enable_private_control_plane` - (Optional) Specifies whether Kubernetes API endpoint is a private IP only accessible from within the VCN. Default `false` for Rancher v2.5.10 and above (bool)
1921
1923
*`enable_kubernetes_dashboard` - (Optional) Specifies whether to enable the Kubernetes dashboard. Default `false` (bool)
1922
1924
*`enable_private_nodes` - (Optional) Specifies whether worker nodes will be deployed into a new, private, subnet. Default `false` (bool)
1923
-
*`fingerprint` - (Required) The fingerprint corresponding to the specified user's private API Key (string)
1925
+
*`eviction_grace_duration` - (Optional) Specifies the grace period in minutes (ISO 8601 format) to allow cordon and drain to complete. Default `\"PT5M\"` (string)
1926
+
*`fingerprint` - (Required) The fingerprint corresponding to the specified user's private API Key. Required unless using instance principals or workload identity to authenticate (string)
1924
1927
*`flex_ocpus` - (Optional) Specifies number of OCPUs for nodes (requires flexible shape specified with `node_shape`) (int)
1928
+
*`flex_memory_in_gbs` - (Optional) Specifies number amount of memory in GB for nodes (requires flexible shape specified with `node_shape`) (int)
1929
+
*`force_delete_after_grace_duration` - (Optional) Specifies whether to send a SIGKILL signal if a pod does not terminate within the specified grace period. See also `eviction_grace_duration`. Default `false` (bool)
1930
+
*`image_verification_kms_key_id` - (Optional) Comma separated list of OCID(s) of the KMS key to verify the image signatures (string)
1925
1931
*`kms_key_id` - (Optional) The OCID of a KMS vault master key used to encrypt secrets at rest. See [here](https://docs.oracle.com/en-us/iaas/Content/ContEng/Tasks/contengencryptingdata.htm) for help creating a vault and master encryption key. For Rancher v2.5.9 and above (string)
1926
1932
*`kubernetes_version` - (Required) The Kubernetes version that will be used for your master *and* OKE worker nodes (string)
1927
1933
*`limit_node_count` - (Optional) The maximum number of worker nodes. Can limit `quantity_per_subnet`. Default `0` (no limit) (int)
@@ -1932,17 +1938,20 @@ The following arguments are supported:
1932
1938
*`node_pool_subnet_name` - (Optional) Name for node pool subnet. Default `nodedns` (string)
1933
1939
*`node_public_key_contents` - (Optional) The contents of the SSH public key file to use for the nodes (string)
1934
1940
*`node_shape` - (Required) The shape of the node (determines number of CPUs and amount of memory on each OKE node) (string)
1941
+
*`node_user_data_contents` - (Optional) The contents of custom cloud-init / user_data for the nodes. String will be base64 encoded internally if it is not already. See [here](https://docs.oracle.com/en-us/iaas/Content/ContEng/Tasks/contengusingcustomcloudinitscripts.htm) for more information (string)
1935
1942
*`pod_cidr` - (Optional) A CIDR IP range from which to assign Kubernetes Pod IPs (string)
1936
-
*`private_key_contents` - (Required/Sensitive) The private API key file contents for the specified user, in PEM format (string)
1937
-
*`private_key_passphrase` - (Optional/Sensitive) The passphrase (if any) of the private key for the OKE cluster (string)
1943
+
*`pod_network` - (Optional) Choose `flannel` or `native` CNI for pod networking. Default `flannel` (string)
1944
+
*`pod_subnet_name` - (Optional) An optional pre-existing subnet that pods will be assigned IPs from when using OCI VCN-Native CNI pod networking (string)
1945
+
*`private_key_contents` - (Required/Sensitive) The private API key file contents for the specified user, in PEM format. Required unless using instance principals or workload identity to authenticate (string)
1946
+
*`private_key_passphrase` - (Optional/Sensitive) The passphrase (if any) of the private key for the OKE cluster. Required unless using instance principals or workload identity to authenticate (string)
1938
1947
*`quantity_of_node_subnets` - (Optional) Number of node subnets. Default `1` (int)
1939
1948
*`quantity_per_subnet` - (Optional) Number of OKE worker nodes in each subnet / availability domain. Default `1` (int)
1940
1949
*`region` - (Required) The availability domain within the region to host the cluster. See [here](https://docs.cloud.oracle.com/en-us/iaas/Content/General/Concepts/regions.htm) for a list of region names. (string)
1941
1950
*`service_cidr` - (Optional) A CIDR IP range from which to assign Kubernetes Service IPs (string)
1942
1951
*`service_dns_domain_name` - (Optional) Name for DNS domain of service subnet. Default `svcdns` (string)
1943
1952
*`skip_vcn_delete` - (Optional) Specifies whether to skip deleting the virtual cloud network (VCN) on destroy. Default `false` (bool)
1944
1953
*`tenancy_id` - (Required) The OCID of the tenancy in which to create resources (string)
1945
-
*`user_ocid` - (Required) The OCID of a user who has access to the tenancy/compartment (string)
1954
+
*`user_ocid` - (Required) The OCID of a user who has access to the tenancy/compartment. Required unless using instance principals or workload identity to authenticate (string)
1946
1955
*`vcn_compartment_id` - (Optional) The OCID of the compartment (if different from `compartment_id`) in which to find the pre-existing virtual network set with `vcn_name`. (string)
1947
1956
*`vcn_name` - (Optional) The name of an existing virtual network to use for the cluster creation. If set, you must also set `load_balancer_subnet_name_1`. A VCN and subnets will be created if none are specified. (string)
1948
1957
*`worker_node_ingress_cidr` - (Optional) Additional CIDR from which to allow ingress to worker nodes (string)
0 commit comments