Skip to content

Commit

Permalink
Deprecation of private_link_enabled for enable_private_cluster
Browse files Browse the repository at this point in the history
  • Loading branch information
Aris van Ommeren committed Apr 9, 2020
1 parent 18e516b commit 8feb90d
Show file tree
Hide file tree
Showing 7 changed files with 69 additions and 39 deletions.
13 changes: 11 additions & 2 deletions azurerm/internal/services/containers/data_source_kubernetes_cluster.go
View file
Expand Up @@ -212,8 +212,16 @@ func dataSourceArmKubernetesCluster() *schema.Resource {
},

"private_link_enabled": {
Type: schema.TypeBool,
Computed: true,
Type: schema.TypeBool,
Computed: true,
ConflictsWith: []string{"enable_private_cluster"},
Deprecated: "Deprecated in favor of `enable_private_cluster`", // TODO -- remove this in next major version
},

"enable_private_cluster": {
Type: schema.TypeBool,
Computed: true, // TODO -- remove this when deprecation resolves
ConflictsWith: []string{"private_link_enabled"},
},

"private_fqdn": {
Expand Down Expand Up @@ -493,6 +501,7 @@ func dataSourceArmKubernetesClusterRead(d *schema.ResourceData, meta interface{}
}

d.Set("private_link_enabled", accessProfile.EnablePrivateCluster)
d.Set("enable_private_cluster", accessProfile.EnablePrivateCluster)
}

addonProfiles := flattenKubernetesClusterDataSourceAddonProfiles(props.AddonProfiles)
Expand Down
37 changes: 31 additions & 6 deletions azurerm/internal/services/containers/resource_arm_kubernetes_cluster.go
View file
Expand Up @@ -298,9 +298,20 @@ func resourceArmKubernetesCluster() *schema.Resource {
},

"private_link_enabled": {
Type: schema.TypeBool,
Optional: true,
ForceNew: true,
Type: schema.TypeBool,
Optional: true,
ForceNew: true,
Computed: true,
ConflictsWith: []string{"enable_private_cluster"},
Deprecated: "Deprecated in favor of `enable_private_cluster`", // TODO -- remove this in next major version
},

"enable_private_cluster": {
Type: schema.TypeBool,
Optional: true,
ForceNew: true,
Computed: true, // TODO -- remove this when deprecation resolves
ConflictsWith: []string{"private_link_enabled"},
},

"role_based_access_control": {
Expand Down Expand Up @@ -559,10 +570,16 @@ func resourceArmKubernetesClusterCreate(d *schema.ResourceData, meta interface{}
apiServerAuthorizedIPRangesRaw := d.Get("api_server_authorized_ip_ranges").(*schema.Set).List()
apiServerAuthorizedIPRanges := utils.ExpandStringSlice(apiServerAuthorizedIPRangesRaw)

enablePrivateLink := d.Get("private_link_enabled").(bool)
enablePrivateCluster := false
if v, ok := d.GetOk("private_link_enabled"); ok {
enablePrivateCluster = v.(bool)
}
if v, ok := d.GetOk("enable_private_cluster"); ok {
enablePrivateCluster = v.(bool)
}

apiAccessProfile := containerservice.ManagedClusterAPIServerAccessProfile{
EnablePrivateCluster: &enablePrivateLink,
EnablePrivateCluster: &enablePrivateCluster,
AuthorizedIPRanges: apiServerAuthorizedIPRanges,
}

Expand Down Expand Up @@ -743,7 +760,14 @@ func resourceArmKubernetesClusterUpdate(d *schema.ResourceData, meta interface{}
if d.HasChange("api_server_authorized_ip_ranges") {
updateCluster = true
apiServerAuthorizedIPRangesRaw := d.Get("api_server_authorized_ip_ranges").(*schema.Set).List()
enablePrivateCluster := d.Get("private_link_enabled").(bool)

enablePrivateCluster := false
if v, ok := d.GetOk("private_link_enabled"); ok {
enablePrivateCluster = v.(bool)
}
if v, ok := d.GetOk("enable_private_cluster"); ok {
enablePrivateCluster = v.(bool)
}
existing.ManagedClusterProperties.APIServerAccessProfile = &containerservice.ManagedClusterAPIServerAccessProfile{
AuthorizedIPRanges: utils.ExpandStringSlice(apiServerAuthorizedIPRangesRaw),
EnablePrivateCluster: &enablePrivateCluster,
Expand Down Expand Up @@ -906,6 +930,7 @@ func resourceArmKubernetesClusterRead(d *schema.ResourceData, meta interface{})
}

d.Set("private_link_enabled", accessProfile.EnablePrivateCluster)
d.Set("enable_private_cluster", accessProfile.EnablePrivateCluster)
}

addonProfiles := flattenKubernetesAddOnProfiles(props.AddonProfiles)
Expand Down
10 changes: 5 additions & 5 deletions azurerm/internal/services/containers/tests/data_source_kubernetes_cluster_test.go
View file
Expand Up @@ -42,12 +42,12 @@ func testAccDataSourceAzureRMKubernetesCluster_basic(t *testing.T) {
})
}

func TestAccDataSourceAzureRMKubernetesCluster_privateLink(t *testing.T) {
func TestAccDataSourceAzureRMKubernetesCluster_privateCluster(t *testing.T) {
checkIfShouldRunTestsIndividually(t)
testAccDataSourceAzureRMKubernetesCluster_privateLink(t)
testAccDataSourceAzureRMKubernetesCluster_privateCluster(t)
}

func testAccDataSourceAzureRMKubernetesCluster_privateLink(t *testing.T) {
func testAccDataSourceAzureRMKubernetesCluster_privateCluster(t *testing.T) {
data := acceptance.BuildTestData(t, "azurerm_kubernetes_cluster", "test")

resource.Test(t, resource.TestCase{
Expand All @@ -56,11 +56,11 @@ func testAccDataSourceAzureRMKubernetesCluster_privateLink(t *testing.T) {
CheckDestroy: testCheckAzureRMKubernetesClusterDestroy,
Steps: []resource.TestStep{
{
Config: testAccAzureRMKubernetesCluster_privateLinkConfig(data, true),
Config: testAccAzureRMKubernetesCluster_privateClusterConfig(data, true),
Check: resource.ComposeTestCheckFunc(
testCheckAzureRMKubernetesClusterExists(data.ResourceName),
resource.TestCheckResourceAttrSet(data.ResourceName, "private_fqdn"),
resource.TestCheckResourceAttr(data.ResourceName, "private_link_enabled", "true"),
resource.TestCheckResourceAttr(data.ResourceName, "enable_private_cluster", "true"),
),
},
data.ImportStep("service_principal.0.client_secret"),
Expand Down
34 changes: 17 additions & 17 deletions azurerm/internal/services/containers/tests/resource_arm_kubernetes_cluster_network_test.go
View file
Expand Up @@ -330,12 +330,12 @@ func testAccAzureRMKubernetesCluster_outboundTypeUserDefinedRouting(t *testing.T
})
}

func TestAccAzureRMKubernetesCluster_privateLinkOn(t *testing.T) {
func TestAccAzureRMKubernetesCluster_privateClusterOn(t *testing.T) {
checkIfShouldRunTestsIndividually(t)
testAccAzureRMKubernetesCluster_privateLinkOn(t)
testAccAzureRMKubernetesCluster_privateClusterOn(t)
}

func testAccAzureRMKubernetesCluster_privateLinkOn(t *testing.T) {
func testAccAzureRMKubernetesCluster_privateClusterOn(t *testing.T) {
data := acceptance.BuildTestData(t, "azurerm_kubernetes_cluster", "test")

resource.ParallelTest(t, resource.TestCase{
Expand All @@ -344,24 +344,24 @@ func testAccAzureRMKubernetesCluster_privateLinkOn(t *testing.T) {
CheckDestroy: testCheckAzureRMKubernetesClusterDestroy,
Steps: []resource.TestStep{
{
Config: testAccAzureRMKubernetesCluster_privateLinkConfig(data, true),
Config: testAccAzureRMKubernetesCluster_privateClusterConfig(data, true),
Check: resource.ComposeTestCheckFunc(
testCheckAzureRMKubernetesClusterExists(data.ResourceName),
resource.TestCheckResourceAttrSet(data.ResourceName, "private_fqdn"),
resource.TestCheckResourceAttr(data.ResourceName, "private_link_enabled", "true"),
resource.TestCheckResourceAttr(data.ResourceName, "enable_private_cluster", "true"),
),
},
data.ImportStep(),
},
})
}

func TestAccAzureRMKubernetesCluster_privateLinkOff(t *testing.T) {
func TestAccAzureRMKubernetesCluster_privateClusterOff(t *testing.T) {
checkIfShouldRunTestsIndividually(t)
testAccAzureRMKubernetesCluster_privateLinkOff(t)
testAccAzureRMKubernetesCluster_privateClusterOff(t)
}

func testAccAzureRMKubernetesCluster_privateLinkOff(t *testing.T) {
func testAccAzureRMKubernetesCluster_privateClusterOff(t *testing.T) {
data := acceptance.BuildTestData(t, "azurerm_kubernetes_cluster", "test")

resource.ParallelTest(t, resource.TestCase{
Expand All @@ -370,10 +370,10 @@ func testAccAzureRMKubernetesCluster_privateLinkOff(t *testing.T) {
CheckDestroy: testCheckAzureRMKubernetesClusterDestroy,
Steps: []resource.TestStep{
{
Config: testAccAzureRMKubernetesCluster_privateLinkConfig(data, false),
Config: testAccAzureRMKubernetesCluster_privateClusterConfig(data, false),
Check: resource.ComposeTestCheckFunc(
testCheckAzureRMKubernetesClusterExists(data.ResourceName),
resource.TestCheckResourceAttr(data.ResourceName, "private_link_enabled", "false"),
resource.TestCheckResourceAttr(data.ResourceName, "enable_private_cluster", "false"),
),
},
data.ImportStep(),
Expand Down Expand Up @@ -1014,7 +1014,7 @@ resource "azurerm_kubernetes_cluster" "test" {
`, data.RandomInteger, data.Locations.Primary, data.RandomInteger, data.RandomInteger, data.RandomInteger, data.RandomInteger)
}

func testAccAzureRMKubernetesCluster_privateLinkConfig(data acceptance.TestData, enablePrivateLink bool) string {
func testAccAzureRMKubernetesCluster_privateClusterConfig(data acceptance.TestData, enablePrivateCluster bool) string {
return fmt.Sprintf(`
provider "azurerm" {
features {}
Expand All @@ -1026,11 +1026,11 @@ resource "azurerm_resource_group" "test" {
}
resource "azurerm_kubernetes_cluster" "test" {
name = "acctestaks%d"
location = azurerm_resource_group.test.location
resource_group_name = azurerm_resource_group.test.name
dns_prefix = "acctestaks%d"
private_link_enabled = %t
name = "acctestaks%d"
location = azurerm_resource_group.test.location
resource_group_name = azurerm_resource_group.test.name
dns_prefix = "acctestaks%d"
enable_private_cluster = %t
linux_profile {
admin_username = "acctestuser%d"
Expand All @@ -1055,7 +1055,7 @@ resource "azurerm_kubernetes_cluster" "test" {
load_balancer_sku = "standard"
}
}
`, data.RandomInteger, data.Locations.Primary, data.RandomInteger, data.RandomInteger, enablePrivateLink, data.RandomInteger)
`, data.RandomInteger, data.Locations.Primary, data.RandomInteger, data.RandomInteger, enablePrivateCluster, data.RandomInteger)
}

func testAccAzureRMKubernetesCluster_standardLoadBalancerConfig(data acceptance.TestData) string {
Expand Down
6 changes: 3 additions & 3 deletions azurerm/internal/services/containers/tests/resource_arm_kubernetes_cluster_test.go
View file
Expand Up @@ -91,8 +91,8 @@ func TestAccAzureRMKubernetes_all(t *testing.T) {
"windowsProfile": testAccAzureRMKubernetesCluster_windowsProfile,
"outboundTypeLoadBalancer": testAccAzureRMKubernetesCluster_outboundTypeLoadBalancer,
"outboundTypeUserDefinedRouting": testAccAzureRMKubernetesCluster_outboundTypeUserDefinedRouting,
"privateLinkOn": testAccAzureRMKubernetesCluster_privateLinkOn,
"privateLinkOff": testAccAzureRMKubernetesCluster_privateLinkOff,
"privateClusterOn": testAccAzureRMKubernetesCluster_privateClusterOn,
"privateClusterOff": testAccAzureRMKubernetesCluster_privateClusterOff,
},
"scaling": {
"addAgent": testAccAzureRMKubernetesCluster_addAgent,
Expand Down Expand Up @@ -127,7 +127,7 @@ func TestAccAzureRMKubernetes_all(t *testing.T) {
"nodeLabels": testAccDataSourceAzureRMKubernetesCluster_nodeLabels,
"nodeTaints": testAccDataSourceAzureRMKubernetesCluster_nodeTaints,
"enableNodePublicIP": testAccDataSourceAzureRMKubernetesCluster_enableNodePublicIP,
"privateLink": testAccDataSourceAzureRMKubernetesCluster_privateLink,
"privateCluster": testAccDataSourceAzureRMKubernetesCluster_privateCluster,
},
}

Expand Down
4 changes: 1 addition & 3 deletions website/docs/d/kubernetes_cluster.html.markdown
View file
Expand Up @@ -62,9 +62,7 @@ The following attributes are exported:

* `kubernetes_version` - The version of Kubernetes used on the managed Kubernetes Cluster.

* `private_link_enabled` - Does this Kubernetes Cluster have the Kubernetes API exposed via Private Link?

-> **NOTE:** At this time Private Link is in Public Preview
* `enable_private_cluster` - If the cluster has the Kubernetes API only exposed on internal IP addresses.

* `location` - The Azure Region in which the managed Kubernetes Cluster exists.

Expand Down
4 changes: 1 addition & 3 deletions website/docs/r/kubernetes_cluster.html.markdown
View file
Expand Up @@ -100,9 +100,7 @@ In addition, one of either `identity` or `service_principal` must be specified.

-> **NOTE:** Azure requires that a new, non-existent Resource Group is used, as otherwise the provisioning of the Kubernetes Service will fail.

* `private_link_enabled` Should this Kubernetes Cluster have Private Link Enabled? This provides a Private IP Address for the Kubernetes API on the Virtual Network where the Kubernetes Cluster is located. Defaults to `false`. Changing this forces a new resource to be created.

-> **NOTE:** At this time Private Link is in Public Preview. For an example of how to enable a Preview feature, please visit [Private Azure Kubernetes Service cluster](https://docs.microsoft.com/en-gb/azure/aks/private-clusters)
* `enable_private_cluster` Should this Kubernetes Cluster have it's API server only exposed on internal IP addresses? This provides a Private IP Address for the Kubernetes API on the Virtual Network where the Kubernetes Cluster is located. Defaults to `false`. Changing this forces a new resource to be created.

* `role_based_access_control` - (Optional) A `role_based_access_control` block. Changing this forces a new resource to be created.

Expand Down

0 comments on commit 8feb90d

Please sign in to comment.