Skip to content

Commit 6dc44af

Browse files
committed
fix: update vars to use community prefix, and add docs
Signed-off-by: Carus Kyle <[email protected]>
1 parent eae8a83 commit 6dc44af

File tree

3 files changed

+15
-4
lines changed

3 files changed

+15
-4
lines changed

docs/community/community_config_vars.md

Lines changed: 11 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -27,3 +27,14 @@ To enable a Spot node pool in your AKS cluster using this module, configure the
2727
| community_eviction_policy | (Optional) The Eviction Policy which should be used for Virtual Machines within the Virtual Machine Scale Set powering this Node Pool. Possible values are Deallocate and Delete. Changing this forces a new resource to be created. | string | `Delete` | 10.3.0 | |
2828
| community_spot_max_price | (Optional) The maximum price you're willing to pay in USD per Virtual Machine. Valid values are -1 (the current on-demand price for a Virtual Machine) or a positive value with up to five decimal places. Changing this forces a new resource to be created. | string | `-1` | 10.3.0 | |
2929

30+
31+
## OS Disk Type and Kubelet Disk Type
32+
33+
This gives the user the ability to choose the use the local temporary storage available to some nodes for the Operating system, and or the Kubelet.
34+
The benefit of doing this is the local temporary disk is typically a high performance type of storage medium. If the kubelet is set to use this fast storage, then local emptyDir volume can be used for workloads such as SASWORK. This configuration works well on E-series machines where there is one local temporary disk. For L-series machines with many high performance nvme drives, consider using Azure Container storage instead.
35+
36+
| Name | Description | Type | Default | Release Added | Notes |
37+
| :--- | ---: | ---: | ---: | ---: | ---: |
38+
| community_os_disk_type | (Optional) The type of disk which should be used for the Operating System. Possible values are Ephemeral and Managed. Changing this forces a new resource to be created | string | `null` | 10.3.0 | |
39+
| community_kubelet_disk_type | (Optional) The type of disk which should be used for the Kubelet. Possible values are OS (Where the OS Disk Type is then used) and Temporary. Defaults to Managed. Changing this forces a new resource to be created | string | `null` | 10.3.0 | |
40+

modules/aks_node_pool/main.tf

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -14,8 +14,6 @@ resource "azurerm_kubernetes_cluster_node_pool" "autoscale_node_pool" {
1414
proximity_placement_group_id = var.proximity_placement_group_id == "" ? null : var.proximity_placement_group_id
1515
vm_size = var.machine_type
1616
os_disk_size_gb = var.os_disk_size
17-
os_disk_type = var.os_disk_type
18-
kubelet_disk_type = var.kubelet_disk_type
1917
os_type = var.os_type
2018
auto_scaling_enabled = var.auto_scaling_enabled
2119
node_public_ip_enabled = var.node_public_ip_enabled
@@ -30,6 +28,8 @@ resource "azurerm_kubernetes_cluster_node_pool" "autoscale_node_pool" {
3028
priority = var.community_priority
3129
eviction_policy = var.community_eviction_policy
3230
spot_max_price = var.community_spot_max_price
31+
os_disk_type = var.community_os_disk_type
32+
kubelet_disk_type = var.community_kubelet_disk_type
3333

3434
lifecycle {
3535
ignore_changes = [node_count]

modules/aks_node_pool/variables.tf

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -46,13 +46,13 @@ variable "os_disk_size" {
4646
default = 100
4747
}
4848

49-
variable "os_disk_type" {
49+
variable "community_os_disk_type" {
5050
description = "(Optional) The type of disk which should be used for the Operating System. Possible values are Ephemeral and Managed. Changing this forces a new resource to be created"
5151
type = string
5252
default = null
5353
}
5454

55-
variable "kubelet_disk_type" {
55+
variable "community_kubelet_disk_type" {
5656
description = "(Optional) The type of disk which should be used for the Kubelet. Possible values are OS (Where the OS Disk Type is then used) and Temporary. Defaults to Managed. Changing this forces a new resource to be created"
5757
type = string
5858
default = null

0 commit comments

Comments
 (0)