-
Notifications
You must be signed in to change notification settings - Fork 205
doc: Migration guide for mongodbatlas_project_invitation
resource and data source to the mongodbatlas_cloud_user_project_assignment
resource
#3602
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
Conversation
APIx bot: a message has been sent to Docs Slack channel |
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.
Pull Request Overview
This PR creates comprehensive documentation and examples for migrating from the deprecated mongodbatlas_project_invitation
resource to the new mongodbatlas_cloud_user_project_assignment
resource. The migration addresses the transition from managing pending invitations to managing active project memberships.
- Adds a complete migration guide with step-by-step instructions for handling pending invitations
- Creates three-phase example configurations (v1: deprecated resource, v2: migration phase, v3: final state)
- Updates documentation templates and existing resource documentation with proper migration guide links
Reviewed Changes
Copilot reviewed 25 out of 25 changed files in this pull request and generated 1 comment.
Show a summary per file
File | Description |
---|---|
docs/guides/project-invitation-to-cloud-user-project-assignment-migration-guide.md |
Main migration guide with detailed instructions and examples |
examples/migrate_project_invitation_to_cloud_user_project_assignment/ |
Complete example configurations demonstrating the three-phase migration approach |
templates/resources/cloud_user_project_assignment.md.tmpl |
Updates placeholder link to point to the actual migration guide |
templates/data-sources/cloud_user_project_assignment.md.tmpl |
Updates placeholder link to point to the actual migration guide |
docs/resources/project_invitation.md |
Adds deprecation notice with migration guide reference |
docs/data-sources/project_invitation.md |
Adds deprecation notice with migration guide reference |
docs/resources/cloud_user_project_assignment.md |
Updates placeholder link to point to the actual migration guide |
docs/data-sources/cloud_user_project_assignment.md |
Updates placeholder link to point to the actual migration guide |
Tip: Customize your code reviews with copilot-instructions.md. Create the file or learn how to get started.
examples/migrate_project_invitation_to_cloud_user_project_assignment/v2/versions.tf
Show resolved
Hide resolved
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.
LGTM
|
||
## Migrating PENDING invitation (resource exists in config) | ||
|
||
Original configuration (note: `user_id` does not exist on `mongodbatlas_project_invitation`): |
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.
curious why this clarification of user_id is needed
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.
not needed here, was a left over when copying a section from other migration guide. good catch
docs/guides/project-invitation-to-cloud-user-project-assignment-migration-guide.md
Outdated
Show resolved
Hide resolved
### v2: Migration Phase (Re-creation with Removed Block) | ||
Demonstrates the migration approach: | ||
- Adds new `mongodbatlas_cloud_user_project_assignment` resource | ||
- Uses `removed` block to cleanly remove old resource from state |
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.
q: Does migration work if old mongodbatlas_project_invitation
is directly removed, calling a delete? Just checking if the migration can be even more simple
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.
Yes, it would work deleting the resource directly. In my opinion, this could raise concerns in customers doing the migration and could add a bit of friction to entirely destroy/delete the invitation. Removing it from the state is less definitive and less "scary"
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.
LGTM!
…t-migration-guide.md Co-authored-by: Agustin Bettati <[email protected]>
Description
Migration guide for
mongodbatlas_project_invitation
resource and data source to themongodbatlas_cloud_user_project_assignment
resourceLink to any related issue(s): CLOUDP-336762
Type of change:
Required Checklist:
Further comments