Add upgrade guide for version 1.0.0 #214
Open
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
wdrbk
approved these changes
Jan 29, 2025
| ## v0.10.0-beta.9 | ||
| * Fix a bug in the `polaris_aws_cnp_permissions` data source where the data source's id was accidentally calculated for | ||
| This type was not properly converted on all code paths. | ||
| * Fix a bug in the `polaris_aws_cnp_permissions` data source where the data source's ID was accidentally calculated for |
There was a problem hiding this comment.
Suggested change
| * Fix a bug in the `polaris_aws_cnp_permissions` data source where the data source's ID was accidentally calculated for | |
| * Fix a bug in the `polaris_aws_cnp_permissions` data source where the data source's ID was incorrectly calculated for |
| * The authentication token cache can now be controlled by the `polaris` provider configuration. | ||
| * The `credentials` field of the `polaris` provider configuration is now optional. If omitted, the provider will look | ||
| for credentials in the `RUBRIK_POLARIS_*` environment variables. | ||
| * The `credentials` field of the `polaris` provider configuration now accepts, in addition to what it already accepts, |
There was a problem hiding this comment.
I'd suggest rephrasing this line:
The credentials field of the polaris provider configuration now also accepts the content of an RSC service account credentials file, in addition to its previously accepted input values.
| * Add the `permissions` field to the `polaris_aws_cnp_account_attachments` resource. The `permissions` field should be | ||
| used with the `id` field of the `polaris_aws_cnp_permissions` data source to trigger an update of the resource | ||
| whenever the permissions changes. This update will move the RSC cloud account from the missing permissions state. | ||
| * Fix a bug in the `polaris_aws_cnp_permissions` data source where the data source's id was accidentally calculated for |
There was a problem hiding this comment.
Suggested change
| * Fix a bug in the `polaris_aws_cnp_permissions` data source where the data source's id was accidentally calculated for | |
| * Fix a bug in the `polaris_aws_cnp_permissions` data source where the data source's id was incorrectly calculated for |
| * Add the field `manifest` to the `polaris_aws_exocompute_cluster_attachment` resource. The `manifest` field contains | ||
| a Kubernetes manifest that can be passed to the Kubernetes Terraform provider or `kubectl` to establish a connection | ||
| between the AWS EKS cluster and RSC. [[docs](../resources/aws_exocompute_cluster_attachment)] | ||
| * Deprecate the `setup_yaml` field in the `polaris_aws_exocompute_cluster_attachment` resource. Use the `manifest` field |
There was a problem hiding this comment.
Suggested change
| * Deprecate the `setup_yaml` field in the `polaris_aws_exocompute_cluster_attachment` resource. Use the `manifest` field | |
| * Deprecate the `setup_yaml` field in the `polaris_aws_exocompute_cluster_attachment` resource. The `manifest` field should be used |
| * The user-assigned managed identity for `cloud_native_archival_encryption` is not refreshed when the | ||
| `polaris_azure_subscription` resource is updated. This will be fixed in a future release. | ||
|
|
||
| In addition to the issues listed above, affecting this particular release of the provider, additional issues reported |
There was a problem hiding this comment.
I'd recommend rephrasing this sentence:
In addition to the issues listed above that affect this particular release of the provider, further reported issues can be found on GitHub
| ```bash | ||
| $ terraform init -upgrade | ||
| ``` | ||
| After the Terraform provider has been updated, validate the correctness of the Terraform configuration files by running: |
There was a problem hiding this comment.
Suggested change
| After the Terraform provider has been updated, validate the correctness of the Terraform configuration files by running: | |
| After the Terraform provider has been upgraded, validate the correctness of the Terraform configuration files by running: |
| } | ||
| } | ||
| ``` | ||
| This is expected since the new `permissions` field is being updated. Applying the diff will update the |
There was a problem hiding this comment.
Suggested change
| This is expected since the new `permissions` field is being updated. Applying the diff will update the | |
| This is expected as the new `permissions` field is being updated. Applying the diff will update the |
| be moved to the `CONNECTED` state. | ||
|
|
||
| ### polaris_azure_subscription | ||
| Because of the new Azure permission groups support, RSC feature fields will result in a diff similar to this: |
There was a problem hiding this comment.
Suggested change
| Because of the new Azure permission groups support, RSC feature fields will result in a diff similar to this: | |
| Because of the new Azure permission groups support, RSC feature fields will result in a diff similar to the following: |
| } | ||
| ``` | ||
| To remove the diff, copy the `permission_groups` values from the diff and add them to the Terraform configuration. Note, | ||
| for the `cloud_native_protection` field, you most likely don't need the `CLOUD_CLUSTER_ES` permission group. Removing it |
There was a problem hiding this comment.
Rather than suggest removing a particular permission group, it might be better to link to to this doc page which should ideally assist users with determining which groups they require: https://docs.rubrik.com/en-us/saas/saas/granular_manage_azr_perm_categories.html
You could then mention: "For example, if the Cloud Cluster ES feature is not being used, it would be advisable to remove the CLOUD_CLUSTER_ES permission group, as this will greatly reduce the number of permissions granted to RSC."
johan3141592
force-pushed
the
upgrade-guide
branch
from
e72f532 to
a85e8fd
Compare
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
No description provided.