Skip to content
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

Merged
merged 7 commits into from
Oct 14, 2024

Conversation

wonjekang
Copy link
Contributor

Currently, ASM Submodule is not supported / managed anymore by ASM team. Highly recommending customers using GKEHub TF module to install ASM.

@wonjekang wonjekang requested review from ericyz, gtsorbo and a team as code owners March 11, 2024 23:44
@apeabody apeabody changed the title Add NOTE to direct ASM users using GKEHub TF Module chore(docs): Add NOTE to direct ASM users using GKEHub TF Module Mar 11, 2024
modules/asm/README.md Outdated Show resolved Hide resolved
Copy link
Member

@bharathkkb bharathkkb left a 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 Show resolved Hide resolved
@wonjekang
Copy link
Contributor Author

@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.

@bharathkkb
Copy link
Member

I think adding this context in the migration guide is a good idea. Do we have a timeline to have it?

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.

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.

Even if we remove the module, users can still use continue to use released versions. Only new module releases will not have this submodule.

@wonjekang
Copy link
Contributor Author

@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:

  1. Remove the ASM submodule package.
  2. Add the context to use gkehub resources for ASM installation in migration guide document(?)

@bharathkkb
Copy link
Member

Copy link
Contributor

@apeabody apeabody left a 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

Copy link

This PR is stale because it has been open 60 days with no activity. Remove stale label or comment or this will be closed in 7 days

@github-actions github-actions bot added the Stale label Jul 29, 2024
@github-actions github-actions bot closed this Aug 5, 2024
@apeabody apeabody reopened this Sep 9, 2024
@github-actions github-actions bot removed the Stale label Sep 9, 2024
Copy link
Contributor

@apeabody apeabody left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Hi @wonjekang - Let's retool this as a deprecation message for v34, and remove entirely in a future version.

modules/asm/README.md Outdated Show resolved Hide resolved
modules/asm/README.md Outdated Show resolved Hide resolved
@apeabody apeabody merged commit 9354444 into terraform-google-modules:master Oct 14, 2024
4 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

4 participants