Added support for load_balancer_profile #277

mazilu88 · 2022-11-21T12:36:06Z

Describe your changes

Added support for load_balancer_profile

Issue number

#274

Checklist before requesting a review

The pr title can be used to describe what this pr did in CHANGELOG.md file
I have executed pre-commit on my machine
I have passed pr-check on my machine

Thanks for your cooperation!

mazilu88 · 2022-11-21T12:42:02Z

@microsoft-github-policy-service agree

moved load_balancer_profile and load_balancer_sku under network

main.tf

zioproto · 2022-11-21T18:44:11Z

variables.tf

+  type        = bool
+  description = "(Optional) A load_balancer_profile block. This can only be specified when load_balancer_sku is set to standard."
+  default     = null
+  nullable    = true


nit: if the default is null you can omit the nullable = true.
asking @lonegunmanb for confirmation on this style issue

Agreed, could you change the default to false here?

main.tf

zioproto · 2022-11-21T18:56:56Z

@lonegunmanb can we please start the E2E tests for this PR ? it looks good for testing

General Question: what is the best option to test this functionality in the E2E tests ? should we patch an existing one or creating a new one to test just this feature ?

Thanks

lonegunmanb

Hello @mazilu88, thanks for opening this pr. I've some comments for you, and most of your new added variables are for the locad_balancer_profile block, could we add a locad_balancer_profile_ prefix to all these variables' name? For example, the nat_gateway_profile block also has an argument named idle_timeout_in_minutes, once we want to support this nat_gateway_profile block we might meet a conflict with this pr.

Another thought is whether we should use an object type for load_balancer_profile variable and include all related variables as it's fields. The cons of this object solution is, we cannot write clear descriptions for the object's fields.

We can add prefix to there variables' names, or we can make them an object with the help of Optional Object Type Attributes, and that would require Terraform 1.3+.

lonegunmanb · 2022-11-23T00:55:44Z

variables.tf

+  type        = bool
+  description = "(Optional) A load_balancer_profile block. This can only be specified when load_balancer_sku is set to standard."
+  default     = null
+  nullable    = true


Agreed, could you change the default to false here?

lonegunmanb · 2022-11-23T00:56:03Z

variables.tf

@@ -216,6 +223,24 @@ variable "kubernetes_version" {
  default     = null
 }

+variable "load_balancer_profile" {


Would load_balancer_enabled be better here?

lonegunmanb · 2022-11-23T00:57:58Z

variables.tf

@@ -216,6 +223,24 @@ variable "kubernetes_version" {
  default     = null
 }

+variable "load_balancer_profile" {
+  type        = bool
+  description = "(Optional) A load_balancer_profile block. This can only be specified when load_balancer_sku is set to standard."


This bool variable doesn't seem like a block, could we change a better description here?
Could we also add a precondition block in aks resource to enforce this pre condition?

lonegunmanb · 2022-11-23T01:03:42Z

variables.tf

+
+variable "load_balancer_sku" {
+  type        = string
+  description = "(Optional) Specifies the SKU of the Load Balancer used for this Kubernetes Cluster. Possible values are basic and standard. Defaults to standard."


According to the provider code the load_balancer_sku argument is a ForceNew argument, which means that if we change this variable's value, the aks cluster would be re-created. The official document need to be upgrade, could we append Changing this forces a new kubernetes cluster to be created. to the description?

lonegunmanb · 2022-11-23T01:04:35Z

variables.tf

+
+  validation {
+    condition     = var.load_balancer_sku == "basic" || var.load_balancer_sku == "standard"
+    error_message = "Possible values are basic and standard"


Could we change the error message to the following code?:

error_message = "Possible values are `basic` and `standard`"

lonegunmanb · 2022-11-23T01:29:03Z

variables.tf

+  type        = number
+  description = "(Optional) Number of desired SNAT port for each VM in the clusters load balancer. Must be between 0 and 64000 inclusive. Defaults to 0"
+  default     = 0
+  nullable    = false


According to the provider schema, the outbound_ports_allocated is optional, which means we could set it to null here.

lonegunmanb · 2022-11-23T01:30:47Z

variables.tf

+
+variable "outbound_ports_allocated" {
+  type        = number
+  description = "(Optional) Number of desired SNAT port for each VM in the clusters load balancer. Must be between 0 and 64000 inclusive. Defaults to 0"


We also need to backquote the number as the official document did here.

lonegunmanb · 2022-11-23T01:32:35Z

variables.tf

+  default     = "standard"
+
+  validation {
+    condition     = var.load_balancer_sku == "basic" || var.load_balancer_sku == "standard"


Would the following code be better?:

condition = contains(["basic", "standard"], var.load_balancer_sku)

lonegunmanb · 2022-11-23T01:42:42Z

variables.tf

@@ -172,6 +172,13 @@ variable "identity_type" {
  }
 }

+variable "idle_timeout_in_minutes" {
+  type        = number
+  description = "(Optional) Desired outbound flow idle timeout in minutes for the cluster load balancer. Must be between 4 and 120 inclusive."


Could we backquote the number as official document did here? And I think we should declare the default value in the description too.

lonegunmanb · 2022-11-23T01:43:37Z

variables.tf

+  type        = number
+  description = "(Optional) Desired outbound flow idle timeout in minutes for the cluster load balancer. Must be between 4 and 120 inclusive."
+  default     = 30
+  nullable    = false


According to the provider schema, the idle_timeout_in_minutes argument is optional, which means we can set it to null.

mazilu88 · 2022-11-29T11:52:24Z

Hello @lonegunmanb. Thank you for the review. I hope I understood all the recommendations correctly and made the appropriate changes.

The only thing I skipped was the precondition. Is it really needed if we check prior to enabling the profile with this?

for_each = var.enable_load_balancer_profile == true && var.load_balancer_sku == "standard" ? ["load_balancer_profile"] : []

lonegunmanb

Thanks @mazilu88 for this update, almost LGTM but some tiny suggestions.

lonegunmanb · 2022-11-30T01:16:34Z

variables.tf

@@ -143,6 +143,12 @@ variable "enable_host_encryption" {
  default     = false
 }

+variable "enable_load_balancer_profile" {


Could we rename this variable to load_balancer_profile_enabled since now in AzureRM provider we're following such naming convention? Now there're many legacy variables with enable_xxx name but we'd like to keep them to keep backward compatible, but for new variables we`d like to follow the latest naming convention. Thanks!

lonegunmanb · 2022-11-30T01:18:03Z

variables.tf

+variable "enable_load_balancer_profile" {
+  type        = bool
+  description = "(Optional) Enable a load_balancer_profile block. This can only be used when load_balancer_sku is set to `standard`."
+  default     = false


I'd like to restrict this variable as nullable = false since I don't think anyone should set this variable to null.

lonegunmanb · 2022-11-30T01:19:23Z

main.tf

    network_policy     = var.network_policy
    outbound_type      = var.net_profile_outbound_type
    pod_cidr           = var.net_profile_pod_cidr
    service_cidr       = var.net_profile_service_cidr
+
+    dynamic "load_balancer_profile" {
+      for_each = var.enable_load_balancer_profile == true && var.load_balancer_sku == "standard" ? ["load_balancer_profile"] : []


Since the var.enable_load_balancer_profile should not be null, could we simplify the expression to the following code?:

for_each = var.enable_load_balancer_profile && var.load_balancer_sku == "standard" ? ["load_balancer_profile"] : []

lonegunmanb · 2022-11-30T01:23:02Z

variables.tf

+  type        = number
+  description = "(Optional) Desired outbound flow idle timeout in minutes for the cluster load balancer. Must be between `4` and `120` inclusive."
+  default     = null
+  nullable    = true
