-
Notifications
You must be signed in to change notification settings - Fork 1.1k
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
chore(docs): Add NOTE to direct ASM users using GKEHub TF Module #1899
base: master
Are you sure you want to change the base?
Conversation
modules/asm/README.md
Outdated
@@ -2,6 +2,9 @@ | |||
|
|||
This module installs [Anthos Service Mesh](https://cloud.google.com/service-mesh/docs) (ASM) in a Kubernetes Engine (GKE) cluster. | |||
|
|||
> [!NOTE] | |||
> ASM Submodule is not supported / managed anymore and ASM team recommends to use [GKEHub TF module](https://registry.terraform.io/providers/hashicorp/google/latest/docs/resources/gke_hub_feature#example-usage---gkehub-feature-anthos-service-mesh) to install ASM. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I suggest the wording:
This module is no longer supported or recommended. Instead, use the google_gke_hub_feature
and google_gke_hub_feature_membership
modules to provision managed service mesh as shown at https://registry.terraform.io/providers/hashicorp/google/latest/docs/resources/gke_hub_feature_membership#example-usage---service-mesh
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
nit: google_gke_hub_feature
and google_gke_hub_feature_membership
are resources. Also would be great to show upgrade path on how to move from module to resource if possible.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
@wonjekang @djazayeri In this case could we remove the sub-module and add this note in our migration guide for next breaking release?
modules/asm/README.md
Outdated
@@ -2,6 +2,9 @@ | |||
|
|||
This module installs [Anthos Service Mesh](https://cloud.google.com/service-mesh/docs) (ASM) in a Kubernetes Engine (GKE) cluster. | |||
|
|||
> [!NOTE] | |||
> ASM Submodule is not supported / managed anymore and ASM team recommends to use [GKEHub TF module](https://registry.terraform.io/providers/hashicorp/google/latest/docs/resources/gke_hub_feature#example-usage---gkehub-feature-anthos-service-mesh) to install ASM. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
nit: google_gke_hub_feature
and google_gke_hub_feature_membership
are resources. Also would be great to show upgrade path on how to move from module to resource if possible.
@bharathkkb I think adding this context in the migration guide is a good idea. Do we have a timeline to have it? However, we still have ASM customers depend on this ASM submodule and we cannot remove it at this time. Let's keep this change at this time. |
If we are recommending to switch to the new resources, co-locating the migration guide in the PR would be good. Otherwise let's make it a fast follow.
Even if we remove the module, users can still use continue to use released versions. Only new module releases will not have this submodule. |
@bharathkkb Could you share the instruction to write the migration guide? I don't have any context where I can start from. IIUC, your recommendation in this PR is:
|
@wonjekang Yeah for 1 and 2. Example guides are in https://github.com/terraform-google-modules/terraform-google-kubernetes-engine/tree/master/docs and next major version would be 31. Here is a previous ASM example https://github.com/terraform-google-modules/terraform-google-kubernetes-engine/blob/master/docs/upgrading_to_v20.0.md#upgrading-to-v200 |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Thanks for the contribution @wonjekang!
Per the PR discussion in this (breaking) PR can you please remove the module and include a migration guide in docs/upgrading_to_v32.0.md
Currently, ASM Submodule is not supported / managed anymore by ASM team. Highly recommending customers using GKEHub TF module to install ASM.