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

Document how to use CustomizeDiff in MMv1 #18392

Open
melinath opened this issue Jun 11, 2024 · 2 comments
Open

Document how to use CustomizeDiff in MMv1 #18392

melinath opened this issue Jun 11, 2024 · 2 comments
Labels
documentation mmv1-generator Provider-wide changes to resource templates or other generator changes service/terraform size/m technical-debt

Comments

@melinath
Copy link
Collaborator

What kind of contribution is this issue about?

MMv1-based resource

Details

In MMv1, you can add CustomizeDiff functions with the custom_diff attribute in YAML. However, this is not currently documented anywhere. We should document it on the MMv1 resource reference (similar to https://googlecloudplatform.github.io/magic-modules/develop/field-reference/#diff_suppress_func), as well as mention cases when it should be used on Fix a permadiff.

References

No response

@melinath
Copy link
Collaborator Author

Hashicorp documentation is at https://developer.hashicorp.com/terraform/plugin/sdkv2/resources/customizing-differences - we may want to be a bit more involved than what's laid out there.

@melinath melinath added this to the Near-Term Goals milestone Jun 17, 2024
@melinath melinath added service/terraform mmv1-generator Provider-wide changes to resource templates or other generator changes labels Jun 17, 2024
@melinath
Copy link
Collaborator Author

We should explicitly document how to use it for cross-field validation.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation mmv1-generator Provider-wide changes to resource templates or other generator changes service/terraform size/m technical-debt
Projects
None yet
Development

No branches or pull requests

1 participant