New Resource: generating Kubernetes Fleet Member

[ms-henglu]

No description provided.

[zioproto]

Related to hashicorp/terraform-provider-azurerm#21468

[stephybun]

Thanks for trying to generate this resource with Pandora @ms-henglu, it is a good candidate for that.

In addition to the comments left in-line the following also needs to be done:

1. Rebase this PR - a lot of new functionality, changes and fixes have been made since this was opened, when we try and generate this resource with the current state of the repo the generation is skipped (this was a known bug that was fixed)
2. We need to update the common ID for fleet in go-azure-helpers to KubernetesFleetId, this is related to the comment left in-line on the fleet_id test dependency
3. We need to add a common_id_kubernetes_fleet_id.go file to this directory and also add this new common ID to the common_ids.go file

[stephybun]

Since we don't require a multi-line description in the docs, this can be simplified to

Suggested change

	description = <<HERE
	Manages a Kubernetes Fleet Member
	HERE
	description = "Manages a Kubernetes Fleet Member"

[stephybun]

Although this allows us to generate the required dependencies for the generated tests to work, we already have a resource ID associated with a Kubernetes Cluster dependency on line 176.

These dependencies coincide with how we refer to resource IDs in the azurerm provider. kubernetes_cluster_id follows our naming conventions and is used consistently throughout the provider, so the solution here should be to rename cluster_resource_id to kubernetes_cluster_id instead of defining duplicate dependency for the same thing.

We have the ability to do renames on properties in the resource definition now with overrides. I left a comment on resource definition config on what that should look like.

Suggested change

"cluster_resource_id": {dependencies.setNeedsKubernetesCluster, fmt.Sprintf("%s_kubernetes_cluster.test.id", providerPrefix)},

[stephybun]

This will rename the property cluster_resource_id to kubernetes_cluster_id which will allow us to use the existing test dependency defined for the tests.

Suggested change

	}
	overrides "cluster_resource_id" {
	updated_name = "kubernetes_cluster_id"
	}

[stephybun]

fleet_id isn't consistent with how we refer to specific resource IDs, in the majority of cases we include the service in the property name. This list of dependencies is a good demonstration of that e.g. key_vault_id, key_vault_key_id, machine_learning_workspace_id etc.

So this needs to become

Suggested change

	"fleet_id": {dependencies.setNeedsKubernetesFleetManager, fmt.Sprintf("%s_kubernetes_fleet_manager.test.id", providerPrefix)},
	"kubernetes_fleet_id": {dependencies.setNeedsKubernetesFleetManager, fmt.Sprintf("%s_kubernetes_fleet_manager.test.id", providerPrefix)},

[ms-henglu]

Hi @stephybun ,

About the review comment "changing fleet_id to kubernetes_fleet_id": #3416 (comment)

I did some tests and found that fleet_id is the generated field name and I can't override it to kubernetes_fleet_id by

        overrides "fleet_id" {
          updated_name = "kubernetes_fleet_id"
        }

I also checked the codes, it seems resource id fields doesn't support the overrides feature to update the name: https://github.com/hashicorp/pandora/blob/main/tools/importer-rest-api-specs/components/schema/fields_resource_id.go#L59

Please correct me if I was missing something. Thanks!

[ms-henglu]

Thanks @stephybun for the quick fix! I've rebased the PR, please take another look.

[stephybun]

I'd be happy to, but not all of the review points have been addressed, mainly point 2. and 3. in this comment at the very least 3. needs to be done otherwise the common ID won't be applied.

[ms-henglu]

To address the point 2: hashicorp/go-azure-helpers#212

[stephybun]

Thanks @ms-henglu, I think this probably about ready. Let's merge and see what happens in the provider! LGTM 👍