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

ibm_resource_access_tag name is not consistent #5522

Closed
mkrudele opened this issue Jul 22, 2024 · 4 comments · Fixed by #5567
Closed

ibm_resource_access_tag name is not consistent #5522

mkrudele opened this issue Jul 22, 2024 · 4 comments · Fixed by #5567
Labels
service/Resource Management Issues related to Resource Manager or Resource controller Issues

Comments

@mkrudele
Copy link

mkrudele commented Jul 22, 2024

Community Note

  • Please vote on this issue by adding a 👍 reaction to the original issue to help the community and maintainers prioritize this request
  • Please do not leave "+1" or other comments that do not add relevant new information or questions, they generate extra noise for issue followers and do not help prioritize the request
  • If you are interested in working on this issue or have submitted a pull request, please leave a comment

Terraform CLI and Terraform IBM Provider Version

Affected Resource(s)

  • ibm_resource_access_tag

Terraform Configuration Files

Please include all Terraform configurations required to reproduce the bug. Bug reports without a functional reproduction may be closed without investigation.

# Copy-paste your Terraform configurations here - for large Terraform configs,
# please share a link to the ZIP file.

Debug Output

Panic Output

Expected Behavior

Actual Behavior

It has recently been added the possibility to create an access management tag, which is good. However, the name is inconsistent in my opinion. Let me explain why:
There is the ibm_resource_tag Terraform resource that handles tag attachment with a resource. So, it models the relation between an user or access tag with a resource.
The new resource ibm_resource_access_tag is not modelling a relation between an access tag and a resource. Instead, it models an access tag. So, its name should have been ibm_iam_access_tag, as I suggested some time ago #2608 (comment).
Who reviewed the documentation and the consistency? Was the Global Search Tagging (GhoST) team involved in the development of this new feature? GhoST is the component in the cloud that owns tagging.

Steps to Reproduce

  1. terraform apply

Important Factoids

References

  • #0000
@github-actions github-actions bot added the service/Resource Management Issues related to Resource Manager or Resource controller Issues label Jul 22, 2024
@JunliWang
Copy link
Contributor

as an user, I was confused about how to attach an access tag to an instance, thought ibm_resource_access_tag should work in the same way as ibm_resource_tag, but actually ibm_resource_access_tag does not have resource_id to specify the resource to attach to. it is to create access tag itself.
I would vote for the rename to avoid such confusion.

@addison-martin1
Copy link

Hi, I'm a content designer and I was asked to review this name change 🙂

For this change: ibm_resource_access_tag —> ibm_iam_access_tag

Would these be the steps to create and attach an access management tag?

  1. Use ibm_iam_access_tag to create the access management tag
  2. Use ibm_resource_tag to attach the access management tag to a resource

Ultimately I think this renaming makes sense 👍

I think we would need to update our documentation here: https://cloud.ibm.com/docs/account?topic=account-tag&interface=terraform#create-access-terraform — who can I contact to review this and confirm the updates needed?

@mkrudele
Copy link
Author

@addison-martin1 You can contact me. However before updating that documentation, we need to make the code changes and update the Terraform documentation here https://registry.terraform.io/providers/IBM-Cloud/ibm/latest/docs/resources/resource_access_tag.
My team can do the change. Let's wait for the IAM team feedback before moving on.

@veetil09
Copy link

I think this rename makes sense to avoid the confusion for the end user.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
service/Resource Management Issues related to Resource Manager or Resource controller Issues
Projects
None yet
4 participants