New data-source: azurerm_kubernetes_service_versions #3382

alexsomesan · 2019-05-06T13:12:10Z

This datasource retrieves available versions of container orchestrators.

It enables users to dynamically select one of the supported Kubernetes versions when provisioning
AKS clusters, for example.

Tested locally

» TF_ACC=1 ./azurerm.test -test.v -test.run '^TestAccDataSourceArmContainerOrchestratorVersions'                                                                                                                                         alex@alexs-macbook
=== RUN   TestAccDataSourceArmContainerOrchestratorVersions_basic
--- PASS: TestAccDataSourceArmContainerOrchestratorVersions_basic (29.06s)
=== RUN   TestAccDataSourceArmContainerOrchestratorVersions_filtered
--- PASS: TestAccDataSourceArmContainerOrchestratorVersions_filtered (27.23s)
PASS
------------------------------------------------------------

azurerm/data_source_container_orchestrator_versions.go

alexsomesan · 2019-05-06T17:11:52Z

Tests still pass.

paultyng

LGTM, should probably have @katbyte or @tombuildsstuff take a peek prior to merging though.

alexsomesan · 2019-05-06T18:01:51Z

I'd prefer that they do as well.
I'm going to leave it up to them to merge, unless more changes are needed.

katbyte

Left a few comments inline

azurerm/data_source_azurerm_container_orchestrator_versions_test.go

website/docs/d/container_orchestrator_versions.html.markdown

azurerm/data_source_container_orchestrator_versions.go

azurerm/data_source_azurerm_container_orchestrator_versions_test.go

katbyte

Thanks for the revisions @alexsomesan, LGTM now

however I think @tombuildsstuff had a comment on the resource's name so I will hold off merging until he comments

alexsomesan · 2019-05-10T23:40:36Z

I am unconvinced myself about the name. It's rather unwieldy, TBH.

For lack of a better option I went with what the convention dictated and composed it from the name of the API resource. I'm open to any other suggestions.

katbyte · 2019-05-12T21:03:30Z

@alexsomesan, discussed with @ tombuildsstuff, and as much as orchestrator is a fantastic word i'd like to use as much as possible we think renaming it to azurerm_kubernetes_version and dropping the type parameter is the ideal path forward.

alexsomesan · 2019-05-13T13:33:48Z

That sounds fine by me. I'll make the necessary adaptations.

I guess we do still want to filter the output of ListOrchestrators by OrchestratorType == "Kubernetes" even if we drop the type parameter, right?

tombuildsstuff

hey @alexsomesan

Thanks for pushing those changes - as discussed IRL can we make this azurerm_kubernetes_service_versions rather than container_orchestrator_versions?

Thanks!

azurerm/provider.go

azurerm/data_source_container_orchestrator_versions.go

tombuildsstuff · 2019-05-14T12:23:15Z

azurerm/data_source_container_orchestrator_versions.go

+	listResp, err := client.ListOrchestrators(ctx, location, "managedClusters")
+	if err != nil {
+		if utils.ResponseWasNotFound(listResp.Response) {
+			return fmt.Errorf("Error: Container Orchestrators not found for location %q", location)


what's the use-case for this, when AKS isn't supported in that region?

I would say yes, but I'm not 100% sure this is the right error to check for that case. Any idea how to confirm it?

The API docs only mention positive responses. Does that mean there can be no errors returned?
https://docs.microsoft.com/en-us/rest/api/container-service/container%20service%20client/listorchestrators

I'm 99% sure that'll come through as a 404; it's generally something along the lines of the API version '2019-01-01' was not found for the Resource Provider 'Microsoft.ContainerService'

azurerm/data_source_container_orchestrator_versions.go

website/docs/d/container_orchestrator_versions.html.markdown

tombuildsstuff

hey @alexsomesan

Thanks for pushing those changes - I've left some comments inline (mostly) around the renaming but this is otherwise looking good to me; so that we can get this released in the v1.28 release I'm going to push some commits to fix that, I hope you don't mind!

Thanks!

tombuildsstuff · 2019-05-16T14:33:03Z

azurerm/data_source_container_orchestrator_versions.go

+	client := meta.(*ArmClient).containerServicesClient
+	ctx := meta.(*ArmClient).StopContext
+
+	location := d.Get("location").(string)


we probably want to run this through azurermNormalizeLocation(location) to ensure this value's normalized?

tombuildsstuff · 2019-05-16T14:37:23Z

azurerm/data_source_container_orchestrator_versions.go

+	versions := []string{}
+	for _, rawV := range *listResp.Orchestrators {
+		if rawV.OrchestratorType != nil && rawV.OrchestratorVersion != nil {
+			if *rawV.OrchestratorType == "Kubernetes" {


given the history with some of the API's, we probably want to be doing this case insensitively:

Suggested change

if *rawV.OrchestratorType == "Kubernetes" {

if strings.EqualsFold(*rawV.OrchestratorType, "Kubernetes") {

azurerm/provider.go

tombuildsstuff · 2019-05-16T14:43:43Z

website/azurerm.erb

@@ -131,6 +131,10 @@
                    <a href="/docs/providers/azurerm/d/client_config.html">azurerm_client_config</a>
                </li>

+                <li<%= sidebar_current("docs-azurerm-datasource-container-orchestrator-versions") %>>


Suggested change

<li<%= sidebar_current("docs-azurerm-datasource-container-orchestrator-versions") %>>

<li<%= sidebar_current("docs-azurerm-datasource-kubernetes-service-versions") %>>

tombuildsstuff · 2019-05-16T14:43:55Z

website/azurerm.erb

@@ -131,6 +131,10 @@
                    <a href="/docs/providers/azurerm/d/client_config.html">azurerm_client_config</a>
                </li>

+                <li<%= sidebar_current("docs-azurerm-datasource-container-orchestrator-versions") %>>
+                    <a href="/docs/providers/azurerm/d/container_orchestrator_versions.html">container_orchestrator_versions</a>


Suggested change

<a href="/docs/providers/azurerm/d/container_orchestrator_versions.html">container_orchestrator_versions</a>

<a href="/docs/providers/azurerm/d/kubernetes_service_versions.html"> azurerm_kubernetes_service_versions</a>

tombuildsstuff · 2019-05-16T14:45:34Z

website/docs/d/container_orchestrator_versions.html.markdown

+}
+
+output "latest_version" {
+  value = "${data.azurerm_container_orchestrator_versions.current.latest_version}"


Suggested change

value = "${data.azurerm_container_orchestrator_versions.current.latest_version}"

value = "${data.azurerm_kubernetes_service_versions.current.latest_version}"

tombuildsstuff · 2019-05-16T14:46:01Z

website/docs/d/container_orchestrator_versions.html.markdown

+
+# Data Source: azurerm_container_orchestrator_versions
+
+Use this data source to access information about available versions of orchestrators supported by the Azure Container services.


Suggested change

Use this data source to access information about available versions of orchestrators supported by the Azure Container services.

Use this data source to access information about the available versions of Kubernetes supported by the Azure Kubernetes Service.

tombuildsstuff · 2019-05-16T14:46:05Z

website/docs/d/container_orchestrator_versions.html.markdown

@@ -0,0 +1,38 @@
+---
+layout: "azurerm"
+page_title: "Azure Resource Manager: azurerm_container_orchestrator_versions"


Suggested change

page_title: "Azure Resource Manager: azurerm_container_orchestrator_versions"

page_title: "Azure Resource Manager: azurerm_kubernetes_service_versions"

tombuildsstuff · 2019-05-16T14:47:56Z

website/docs/d/container_orchestrator_versions.html.markdown

+## Argument Reference
+
+* `location` - (Required) Specifies the location in which to query for versions.
+* `orchestrator_type` - (Optional) The type of orchestrator for which to fetch versions. Right now the only supported value is `Kubernetes`. If omitted, defaults to `Kubernetes`.


this has been removed so:

Suggested change

* `orchestrator_type` - (Optional) The type of orchestrator for which to fetch versions. Right now the only supported value is `Kubernetes`. If omitted, defaults to `Kubernetes`.

tombuildsstuff · 2019-05-16T14:51:14Z

website/docs/d/container_orchestrator_versions.html.markdown

+
+* `location` - (Required) Specifies the location in which to query for versions.
+* `orchestrator_type` - (Optional) The type of orchestrator for which to fetch versions. Right now the only supported value is `Kubernetes`. If omitted, defaults to `Kubernetes`.
+* `version_prefix` - (Optional) A string prefix used to filter the versions retrieved by the query. When this argument is specified, only the versions which match this prefix are returned.


Suggested change

* `version_prefix` - (Optional) A string prefix used to filter the versions retrieved by the query. When this argument is specified, only the versions which match this prefix are returned.

* `version_prefix` - (Optional) A prefix filter for the versions of Kubernetes which should be returned; for example `1.x` will return `1.9` to `1.14`, whereas `1.12` will return `1.12.2.

Retrieves available versions of container orchestrators.

Link documentation page into sidebar template.

Co-Authored-By: alexsomesan <alex.somesan@gmail.com>

…st.go Co-Authored-By: alexsomesan <alex.somesan@gmail.com>

Co-Authored-By: alexsomesan <alex.somesan@gmail.com>

Co-Authored-By: Tom Harvey <tombuildsstuff@users.noreply.github.com>

tombuildsstuff · 2019-05-16T15:16:46Z

Tests pass:

$ acctests azurerm TestAccDataSourceAzureRMKubernetesServiceVersions_
=== RUN   TestAccDataSourceAzureRMKubernetesServiceVersions_basic
--- PASS: TestAccDataSourceAzureRMKubernetesServiceVersions_basic (45.14s)
=== RUN   TestAccDataSourceAzureRMKubernetesServiceVersions_filtered
--- PASS: TestAccDataSourceAzureRMKubernetesServiceVersions_filtered (43.31s)
PASS
ok  	github.com/terraform-providers/terraform-provider-azurerm/azurerm	90.490s

alexsomesan · 2019-05-16T23:18:59Z

Thanks for pushing those changes, Tom!
I’m on PTO and respond slowly.

ghost · 2019-05-17T18:23:45Z

This has been released in version 1.28.0 of the provider. Please see the Terraform documentation on provider versioning or reach out if you need any assistance upgrading. As an example:

provider "azurerm" {
	version = "~> 1.28.0"
}
# ... other configuration ...

ghost · 2019-06-16T13:50:34Z

I'm going to lock this issue because it has been closed for 30 days ⏳. This helps our maintainers find and focus on the active issues.

If you feel this issue should be reopened, we encourage creating a new issue linking back to this one for added context. If you feel I made an error 🤖 🙉 , please reach out to my human friends 👉 hashibot-feedback@hashicorp.com. Thanks!

alexsomesan requested a review from a team May 6, 2019 13:12

ghost added size/L documentation labels May 6, 2019

paultyng suggested changes May 6, 2019

View reviewed changes

azurerm/data_source_container_orchestrator_versions.go Outdated Show resolved Hide resolved

paultyng suggested changes May 6, 2019

View reviewed changes

azurerm/data_source_container_orchestrator_versions.go Outdated Show resolved Hide resolved

paultyng approved these changes May 6, 2019

View reviewed changes

katbyte requested changes May 6, 2019

View reviewed changes

katbyte added this to the v1.28.0 milestone May 6, 2019

katbyte added new-data-source service/kubernetes-cluster waiting-response labels May 7, 2019

katbyte assigned tombuildsstuff May 10, 2019

katbyte approved these changes May 10, 2019

View reviewed changes

katbyte removed the waiting-response label May 10, 2019

katbyte force-pushed the master branch from 77d8dd0 to fa53685 Compare May 12, 2019 19:43

katbyte added the waiting-response label May 12, 2019

tombuildsstuff suggested changes May 14, 2019

View reviewed changes

katbyte changed the title ~~New data-source: azurerm_container_orchestrator_versions~~ New data-source: azurerm_kubernetes_service_versions May 16, 2019

tombuildsstuff removed the waiting-response label May 16, 2019

tombuildsstuff approved these changes May 16, 2019

View reviewed changes

alexsomesan and others added 5 commits May 16, 2019 16:55

Add new data-source 'azurerm_container_orchestrator_versions'.

0d6fa53

Retrieves available versions of container orchestrators.

Align test names to newer convention.

4ef2bbe

Rename source files to match convention.

c15b0c8

Link documentation page into sidebar template.

Remove 'Optional' property from output attributes.

feac28b

Update website/docs/d/container_orchestrator_versions.html.markdown

ba71df7

Co-Authored-By: alexsomesan <alex.somesan@gmail.com>

katbyte and others added 13 commits May 16, 2019 16:55

Update azurerm/data_source_azurerm_container_orchestrator_versions_te…

6849c3a

…st.go Co-Authored-By: alexsomesan <alex.somesan@gmail.com>

Update azurerm/data_source_azurerm_container_orchestrator_versions_te…

17825ba

…st.go Co-Authored-By: alexsomesan <alex.somesan@gmail.com>

Align file names and format test configuration HCL

1f4c50e

Update website/docs/d/container_orchestrator_versions.html.markdown

1878dec

Co-Authored-By: alexsomesan <alex.somesan@gmail.com>

Use templated schema for 'location' attribute

6c86dbe

Update website/docs/d/container_orchestrator_versions.html.markdown

ea40f6a

Co-Authored-By: Tom Harvey <tombuildsstuff@users.noreply.github.com>

Update azurerm/data_source_container_orchestrator_versions.go

371097b

Co-Authored-By: Tom Harvey <tombuildsstuff@users.noreply.github.com>

Update azurerm/data_source_container_orchestrator_versions.go

71dd6e9

Co-Authored-By: Tom Harvey <tombuildsstuff@users.noreply.github.com>

Update azurerm/data_source_container_orchestrator_versions.go

ec79385

Co-Authored-By: Tom Harvey <tombuildsstuff@users.noreply.github.com>

Update azurerm/data_source_container_orchestrator_versions.go

825e79f

Co-Authored-By: Tom Harvey <tombuildsstuff@users.noreply.github.com>

Update azurerm/provider.go

d605108

Co-Authored-By: Tom Harvey <tombuildsstuff@users.noreply.github.com>

Updates per PR comments

aee5af7

Renaming things per PR comments

a53f6d7

tombuildsstuff force-pushed the orchestrator-versions-ds branch from cfdb7fa to a53f6d7 Compare May 16, 2019 14:56

d/kubernetes_service_versions: changes from code review

e9c1542

Update kubernetes_service_versions.html.markdown

516ae20

katbyte added a commit that referenced this pull request May 16, 2019

Update CHANGELOG,md to include #3382

b656e3d

katbyte merged commit 969fbf8 into master May 16, 2019

katbyte deleted the orchestrator-versions-ds branch May 16, 2019 16:22

ghost locked and limited conversation to collaborators Jun 16, 2019

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

New data-source: azurerm_kubernetes_service_versions #3382

New data-source: azurerm_kubernetes_service_versions #3382

alexsomesan commented May 6, 2019

alexsomesan commented May 6, 2019

paultyng left a comment

alexsomesan commented May 6, 2019

katbyte left a comment

katbyte left a comment

alexsomesan commented May 10, 2019

katbyte commented May 12, 2019

alexsomesan commented May 13, 2019

tombuildsstuff left a comment

tombuildsstuff May 14, 2019

alexsomesan May 15, 2019

tombuildsstuff May 16, 2019

tombuildsstuff left a comment

tombuildsstuff May 16, 2019

tombuildsstuff May 16, 2019

tombuildsstuff May 16, 2019

tombuildsstuff May 16, 2019

tombuildsstuff May 16, 2019

tombuildsstuff May 16, 2019

tombuildsstuff May 16, 2019

tombuildsstuff May 16, 2019

tombuildsstuff May 16, 2019

tombuildsstuff commented May 16, 2019

alexsomesan commented May 16, 2019

ghost commented May 17, 2019

ghost commented Jun 16, 2019

	if *rawV.OrchestratorType == "Kubernetes" {
	if strings.EqualsFold(*rawV.OrchestratorType, "Kubernetes") {

	<li<%= sidebar_current("docs-azurerm-datasource-container-orchestrator-versions") %>>
	<li<%= sidebar_current("docs-azurerm-datasource-kubernetes-service-versions") %>>

	<a href="/docs/providers/azurerm/d/container_orchestrator_versions.html">container_orchestrator_versions</a>
	<a href="/docs/providers/azurerm/d/kubernetes_service_versions.html"> azurerm_kubernetes_service_versions</a>

	value = "${data.azurerm_container_orchestrator_versions.current.latest_version}"
	value = "${data.azurerm_kubernetes_service_versions.current.latest_version}"


		# Data Source: azurerm_container_orchestrator_versions

		Use this data source to access information about available versions of orchestrators supported by the Azure Container services.

	page_title: "Azure Resource Manager: azurerm_container_orchestrator_versions"
	page_title: "Azure Resource Manager: azurerm_kubernetes_service_versions"

	* `version_prefix` - (Optional) A string prefix used to filter the versions retrieved by the query. When this argument is specified, only the versions which match this prefix are returned.
	* `version_prefix` - (Optional) A prefix filter for the versions of Kubernetes which should be returned; for example `1.x` will return `1.9` to `1.14`, whereas `1.12` will return `1.12.2.

New data-source: azurerm_kubernetes_service_versions #3382

New data-source: azurerm_kubernetes_service_versions #3382

Conversation

alexsomesan commented May 6, 2019

alexsomesan commented May 6, 2019

paultyng left a comment

Choose a reason for hiding this comment

alexsomesan commented May 6, 2019

katbyte left a comment

Choose a reason for hiding this comment

katbyte left a comment

Choose a reason for hiding this comment

alexsomesan commented May 10, 2019

katbyte commented May 12, 2019

alexsomesan commented May 13, 2019

tombuildsstuff left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

tombuildsstuff left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

tombuildsstuff commented May 16, 2019

alexsomesan commented May 16, 2019

ghost commented May 17, 2019

ghost commented Jun 16, 2019