`azurerm_kubernetes_cluster`, `azurerm_kubernetes_cluster_node_pool` - deprecate preview features #26863

ms-henglu · 2024-07-30T06:10:48Z

Community Note

Please vote on this PR by adding a 👍 reaction to the original PR to help the community and maintainers prioritize for review
Please do not leave comments along the lines of "+1", "me too" or "any updates", they generate extra noise for PR followers and do not help prioritize for review

Description

This PR deprecates the following preview features:

azurerm_kubernetes_cluster data source:
1. custom_ca_trust_certificates_base64 deprecated and removed in 4.0
2. storage_profile.disk_driver_version is deprecated and removed in 4.0
azurerm_kubernetes_cluster resource:
1. custom_ca_trust_certificates_base64 is deprecated and removed in 4.0
2. api_server_access_profile.subnet_id is deprecated and removed in 4.0
3. api_server_access_profile. vnet_integration_enabled is deprecated and removed in 4.0
4. default_node_pool. custom_ca_trust_enabled is deprecated and removed in 4.0
5. default_node_pool. message_of_the_day is deprecated and removed in 4.0
6. default_node_pool. workload_runtime 's allowed value KataMshvVmIsolation is deprecated and removed in 4.0
7. storage_profile.disk_driver_version is deprecated and removed in 4.0
azurerm_kubernetes_cluster_node_pool is deprecated and removed in 4.0
1. custom_ca_trust_enabled is deprecated and removed in 4.0
2. message_of_the_day is removed
3. workload_runtime 's allowed value KataMshvVmIsolation is deprecated and removed in 4.0

After this PR, I'll open another PR to switch the SDK to stable api-version

PR Checklist

I have followed the guidelines in our Contributing Documentation.
I have checked to ensure there aren't other open Pull Requests for the same update/change.
I have checked if my changes close any open issues. If so please include appropriate closing keywords below.
I have updated/added Documentation as required written in a helpful and kind way to assist users that may be unfamiliar with the resource / data source.
I have used a meaningful PR title to help maintainers and other users understand this change and help prevent duplicate work.
For example: “resource_name_here - description of change e.g. adding property new_property_name_here”

Changes to existing Resource / Data Source

I have added an explanation of what my changes do and why I'd like you to include them (This may be covered by linking to an issue above, but may benefit from additional explanation).
I have written new tests for my resource or datasource changes & updated any relevent documentation.
I have successfully run tests with my changes locally. If not, please provide details on testing challenges that prevented you running the tests.
(For changes that include a state migration only). I have manually tested the migration path between relevant versions of the provider.

Testing

My submission includes Test coverage as described in the Contribution Guide and the tests pass. (if this is not possible for any reason, please include details of why you did or could not add test coverage)

Change Log

Below please provide what should go into the changelog (if anything) conforming to the Changelog Format documented here.

azurerm_resource - support for the thing1 property [GH-00000]

This is a (please select all that apply):

Bug Fix
New Feature (ie adding a service, resource, or data source)
Enhancement
Breaking Change

Related Issue(s)

Fixes #0000

Note

If this PR changes meaningfully during the course of review please update the title and description as required.

…- deprecate preview features

magodo · 2024-07-30T07:52:02Z

@ms-henglu Thank you for submitting this! It mostly LGTM. The only concern is that all the remaining properties are supported by the stable API version. For that reason, I think it might be a good idea to combine the API version changes in this PR as well, so that we can run the test to ensure everything else is working fine?

ms-henglu · 2024-07-30T07:55:39Z

@ms-henglu Thank you for submitting this! It mostly LGTM. The only concern is that all the remaining properties are supported by the stable API version. For that reason, I think it might be a good idea to combine the API version changes in this PR as well, so that we can run the test to ensure everything else is working fine?

Thanks for the suggestion, but actually I think it's difficult to do that, because the stable API version doesn't have the preview features which will make the compilation fail and having both stable and preview API SDK will make it difficult to maintain.

stephybun · 2024-08-01T08:05:02Z

internal/services/containers/kubernetes_cluster_data_source_test.go

@@ -554,26 +554,6 @@ func TestAccDataSourceKubernetesCluster_microsoftDefender(t *testing.T) {
 	})
 }

-func TestAccDataSourceKubernetesCluster_customCaTrustCerts(t *testing.T) {


We shouldn't be removing these tests until after 4.0

We still need the ability to run these in case there are severe issues with any features that are still available in 3.x

In case of unforeseen consequences that may require us to roll back anything

Can you please skip the tests using the flag for now. We can worry about cleaning up unused tests and configs post major release.

Got it! I've updated this PR as suggested.

stephybun

Thanks @ms-henglu.

Can you please update all of the deprecation messages with the suggestion left in-line. In addition can you also fix the panic introduced by these changes?

------- Stdout: -------
=== RUN   TestAccKubernetesClusterNodePool_autoScale
=== PAUSE TestAccKubernetesClusterNodePool_autoScale
=== CONT  TestAccKubernetesClusterNodePool_autoScale
------- Stderr: -------
panic: Invalid address to set: []string{"custom_ca_trust_enabled"}
goroutine 766 [running]:
github.com/hashicorp/terraform-plugin-sdk/v2/helper/schema.(*ResourceData).Set(0xc0001e9180, {0x8628d88, 0x17}, {0x707a560, 0x0})
  /opt/teamcity-agent/work/3337027aeff310bf/vendor/github.com/hashicorp/terraform-plugin-sdk/v2/helper/schema/resource_data.go:233 +0x2b5
github.com/hashicorp/terraform-provider-azurerm/internal/services/containers.resourceKubernetesClusterNodePoolRead(0xc0001e9180, {0x75851e0?, 0xc0015dc900?})
  /opt/teamcity-agent/work/3337027aeff310bf/internal/services/containers/kubernetes_cluster_node_pool_resource.go:994 +0xa1f
github.com/hashicorp/terraform-provider-azurerm/internal/services/containers.resourceKubernetesClusterNodePoolCreate(0x0?, {0x75851e0?, 0xc0015dc900?})
  /opt/teamcity-agent/work/3337027aeff310bf/internal/services/containers/kubernetes_cluster_node_pool_resource.go:773 +0x3655
github.com/hashicorp/terraform-plugin-sdk/v2/helper/schema.(*Resource).create(0x8ec3508?, {0x8ec3508?, 0xc002b9b530?}, 0xd?, {0x75851e0?, 0xc0015dc900?})

------- Stdout: -------
=== RUN   TestAccKubernetesClusterNodePoolDataSource_basic
=== PAUSE TestAccKubernetesClusterNodePoolDataSource_basic
=== CONT  TestAccKubernetesClusterNodePoolDataSource_basic
------- Stderr: -------
panic: Invalid address to set: []string{"custom_ca_trust_enabled"}
goroutine 735 [running]:
github.com/hashicorp/terraform-plugin-sdk/v2/helper/schema.(*ResourceData).Set(0xc003d19f00, {0x8628d88, 0x17}, {0x707a560, 0x0})
  /opt/teamcity-agent/work/3337027aeff310bf/vendor/github.com/hashicorp/terraform-plugin-sdk/v2/helper/schema/resource_data.go:233 +0x2b5
github.com/hashicorp/terraform-provider-azurerm/internal/services/containers.resourceKubernetesClusterNodePoolRead(0xc003d19f00, {0x75851e0?, 0xc002947200?})
  /opt/teamcity-agent/work/3337027aeff310bf/internal/services/containers/kubernetes_cluster_node_pool_resource.go:994 +0xa1f
github.com/hashicorp/terraform-provider-azurerm/internal/services/containers.resourceKubernetesClusterNodePoolCreate(0x0?, {0x75851e0?, 0xc002947200?})
  /opt/teamcity-agent/work/3337027aeff310bf/internal/services/containers/kubernetes_cluster_node_pool_resource.go:773 +0x3655

Once that's done this should be good to go!

stephybun · 2024-08-13T05:52:01Z

internal/services/containers/kubernetes_cluster_data_source.go

@@ -745,6 +733,21 @@ func dataSourceKubernetesCluster() *pluginsdk.Resource {
 			Computed:   true,
 			Deprecated: "This property is deprecated and will be removed in v4.0 of the AzureRM Provider in favour of the `node_public_ip_enabled` property.",
 		}
+		resource.Schema["storage_profile"].Elem.(*pluginsdk.Resource).Schema["disk_driver_version"] = &pluginsdk.Schema{
+			Deprecated: "This feature is a preview feature and will be removed in version 4.0 of the AzureRM Provider.",


Please update all of the deprecation messages to the following:
This property is not available in the stable API and will be removed in v4.0 of the Azure Provider. Please see https://registry.terraform.io/providers/hashicorp/azurerm/latest/docs/guides/4.0-upgrade-guide#aks-migration-to-stable-api for more details

The link in the message isn't accessible right now, but it will be when the release goes out this week.

ms-henglu · 2024-08-14T01:36:03Z

Hi @stephybun - I've fixed the panic, and the failed tests are not related to this change.

stephybun

Thanks @ms-henglu LGTM 👍

github-actions · 2024-09-16T02:15:36Z

I'm going to lock this pull request because it has been closed for 30 days ⏳. This helps our maintainers find and focus on the active contributions.
If you have found a problem that seems related to this change, please open a new issue and complete the issue template so we can capture all the details necessary to investigate further.

azurerm_kubernetes_cluster, azurerm_kubernetes_cluster_node_pool …

b7b3833

…- deprecate preview features

github-actions bot added documentation size/XL waiting-response labels Jul 30, 2024

make terrafmt

30998ff

github-actions bot added waiting-response and removed waiting-response labels Jul 30, 2024

github-actions bot removed the waiting-response label Jul 30, 2024

only set custom_ca_trust_enabled if it's not 4.0 for node pool

5a2fa72

github-actions bot added the waiting-response label Jul 30, 2024

remove tests

a08406c

github-actions bot added waiting-response and removed waiting-response labels Jul 31, 2024

ms-henglu marked this pull request as ready for review July 31, 2024 03:01

stephybun reviewed Aug 1, 2024

View reviewed changes

add skip on the tests

4fd4f6b

github-actions bot added waiting-response and removed waiting-response labels Aug 1, 2024

fix tests format

11f3a28

github-actions bot added waiting-response and removed waiting-response labels Aug 1, 2024

manicminer self-assigned this Aug 5, 2024

stephybun requested changes Aug 13, 2024

View reviewed changes

Merge branch 'main' into ticket-27055303-aks-switch-sdk-2024-05-01

8940da2

github-actions bot added waiting-response and removed waiting-response labels Aug 13, 2024

update the deprecate messages

7938c00

github-actions bot removed the waiting-response label Aug 13, 2024

github-actions bot added the waiting-response label Aug 13, 2024

fix panic

bbaba18

github-actions bot added waiting-response and removed waiting-response labels Aug 13, 2024

ms-henglu requested a review from stephybun August 14, 2024 01:36

github-actions bot removed the waiting-response label Aug 14, 2024

stephybun approved these changes Aug 15, 2024

View reviewed changes

stephybun added service/kubernetes-cluster deprecation labels Aug 15, 2024

stephybun merged commit 0f1638d into hashicorp:main Aug 15, 2024
33 of 34 checks passed

github-actions bot added this to the v3.116.0 milestone Aug 15, 2024

stephybun added a commit that referenced this pull request Aug 15, 2024

Update for #26863 #26941 #26928 #26878 #26254

b1d480a

mloskot mentioned this pull request Aug 22, 2024

[FEAT] Remove use of derecated api_server_access_profile. vnet_integration_enabled claranet/terraform-azurerm-aks-light#14

Open

rcskosir mentioned this pull request Aug 28, 2024

custom_ca_trust_enabled remove in 3.116.0 #27229

Closed

1 task

github-actions bot locked as resolved and limited conversation to collaborators Sep 16, 2024

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

`azurerm_kubernetes_cluster`, `azurerm_kubernetes_cluster_node_pool` - deprecate preview features #26863

`azurerm_kubernetes_cluster`, `azurerm_kubernetes_cluster_node_pool` - deprecate preview features #26863

ms-henglu commented Jul 30, 2024 •

edited

Loading

magodo commented Jul 30, 2024

ms-henglu commented Jul 30, 2024

stephybun Aug 1, 2024 •

edited

Loading

ms-henglu Aug 1, 2024

stephybun left a comment

stephybun Aug 13, 2024

ms-henglu commented Aug 14, 2024

stephybun left a comment

github-actions bot commented Sep 16, 2024

azurerm_kubernetes_cluster, azurerm_kubernetes_cluster_node_pool - deprecate preview features #26863

azurerm_kubernetes_cluster, azurerm_kubernetes_cluster_node_pool - deprecate preview features #26863

Conversation

ms-henglu commented Jul 30, 2024 • edited Loading

Community Note

Description

PR Checklist

Changes to existing Resource / Data Source

Testing

Change Log

Related Issue(s)

magodo commented Jul 30, 2024

ms-henglu commented Jul 30, 2024

stephybun Aug 1, 2024 • edited Loading

Choose a reason for hiding this comment

ms-henglu Aug 1, 2024

Choose a reason for hiding this comment

stephybun left a comment

Choose a reason for hiding this comment

stephybun Aug 13, 2024

Choose a reason for hiding this comment

ms-henglu commented Aug 14, 2024

stephybun left a comment

Choose a reason for hiding this comment

github-actions bot commented Sep 16, 2024

`azurerm_kubernetes_cluster`, `azurerm_kubernetes_cluster_node_pool` - deprecate preview features #26863

`azurerm_kubernetes_cluster`, `azurerm_kubernetes_cluster_node_pool` - deprecate preview features #26863

ms-henglu commented Jul 30, 2024 •

edited

Loading

stephybun Aug 1, 2024 •

edited

Loading