azurerm_redhat_openshift_cluster - support for custom managed_resource_group_name

[teowa]

Community Note

• Please vote on this PR by adding a 👍 reaction to the original PR to help the community and maintainers prioritize for review
• Please do not leave "+1" or "me too" comments, they generate extra noise for PR followers and do not help prioritize for review

Description

Support for custom target resource group name, in cluster_profile.0.managed_resource_group_name, but uppercase char cannot be used for this field due to Azure API limitation.
https://learn.microsoft.com/en-us/azure/openshift/quickstart-openshift-arm-bicep-template?pivots=aro-arm#azuredeployjson-parameters

For the domain parameter, specify the domain prefix that will be used as part of the auto-generated DNS name for OpenShift console and API servers. This prefix is also used as part of the name of the resource group that is created to host the cluster VMs.

PR Checklist

• I have followed the guidelines in our Contributing Documentation.
• I have checked to ensure there aren't other open Pull Requests for the same update/change.
• I have checked if my changes close any open issues. If so please include appropriate closing keywords below.
• I have updated/added Documentation as required written in a helpful and kind way to assist users that may be unfamiliar with the resource / data source.
• I have used a meaningful PR title to help maintainers and other users understand this change and help prevent duplicate work.
  For example: “resource_name_here - description of change e.g. adding property new_property_name_here”

Changes to existing Resource / Data Source

• I have added an explanation of what my changes do and why I'd like you to include them (This may be covered by linking to an issue above, but may benefit from additional explanation).
• I have written new tests for my resource or datasource changes & updated any relevent documentation.
• I have successfully run tests with my changes locally. If not, please provide details on testing challenges that prevented you running the tests.
• (For changes that include a state migration only). I have manually tested the migration path between relevant versions of the provider.

Testing

• My submission includes Test coverage as described in the Contribution Guide and the tests pass. (if this is not possible for any reason, please include details of why you did or could not add test coverage)

Change Log

Below please provide what should go into the changelog (if anything) conforming to the Changelog Format documented here.

azurerm_redhat_openshift_cluster - support for custom target resource group name

This is a (please select all that apply):

• Bug Fix
• New Feature (ie adding a service, resource, or data source)
• Enhancement
• Breaking Change

Related Issue(s)

Resolves #24959
Resolves #26147

Note

If this PR changes meaningfully during the course of review please update the title and description as required.

[martin-aders]

Nice - thanks a lot for this PR. It may be worth to prevent users from trying to use the same resource group for the cluster and for the cluster profile / add an equality check as a further validation. Using the same resource group is disallowed and yields the following error:

performing CreateOrUpdate: unexpected status 400 with error: InvalidParameter: The provided resource group
  '/subscriptions/.../resourceGroups/aro-<domain>' is invalid: must be different from resourceGroup of the 
  OpenShift cluster object.

[stephybun]

The name of this is quite confusing and clashes with the existing resource_group_id. Please give a more descriptive name for this.

[teowa]

resource_group_name is to set the resource group which will be created by Azure RedHat OpenShift RP to deploy dependency resources. I have confirmed with service team they won't support RG in another subscription so I only expose it as resource_group_name. And before we expose this resource_group_name property, the resource group name is default to aro-{domain} as portal does, where domain is another configurable property.

The resource_group_id is a computed property to display the above resource group ID.

Do we need change this to target_resource_group_name or dependency_resource_group_name? Or can we keep it similar format to resource_group_id?

[stephybun]

Separate question, can ARO only deploy it's resources to a resource group that it creates? Or can it deploy it's resources to an already existing one?

[teowa]

Separate question, can ARO only deploy it's resources to a resource group that it creates? Or can it deploy it's resources to an already existing one?

From service team, it must be a resource group that it creates. In other word, the resource group name sent in this field must be a non-existing one.

[katbyte]

LGTM 🏖️

[github-actions]

I'm going to lock this pull request because it has been closed for 30 days ⏳. This helps our maintainers find and focus on the active contributions.
If you have found a problem that seems related to this change, please open a new issue and complete the issue template so we can capture all the details necessary to investigate further.