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

Remove Kubernetes and KubernetesConfiguration from required resource providers list. #22580

Merged
merged 4 commits into from Jul 18, 2023

Conversation

stephybun
Copy link
Member

Closes #22515

Copy link
Member

@jackofallops jackofallops left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thanks @stephybun - One suggestion, but otherwise LGTM 👍

website/docs/index.html.markdown Outdated Show resolved Hide resolved
Co-authored-by: jackofallops <11830746+jackofallops@users.noreply.github.com>
website/docs/index.html.markdown Outdated Show resolved Hide resolved
Co-authored-by: Tom Bamford <tom@bamford.io>
@@ -29,6 +29,8 @@ Terraform supports a number of different methods for authenticating to Azure:

We recommend using either a Service Principal or Managed Service Identity when running Terraform non-interactively (such as when running Terraform in a CI server) - and authenticating using the Azure CLI when running Terraform locally.

->**Note:** The Service Principal or Managed Service Identity running Terraform should have permissions to register [Azure Resource Providers](https://learn.microsoft.com/en-us/azure/azure-resource-manager/management/resource-providers-and-types). If the user running Terraform has insufficient permissions to register Resource Providers then we recommend setting the property [skip_provider_registration](#skip_provider_registration) in the provider block to prevent auto-registration.
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
->**Note:** The Service Principal or Managed Service Identity running Terraform should have permissions to register [Azure Resource Providers](https://learn.microsoft.com/en-us/azure/azure-resource-manager/management/resource-providers-and-types). If the user running Terraform has insufficient permissions to register Resource Providers then we recommend setting the property [skip_provider_registration](#skip_provider_registration) in the provider block to prevent auto-registration.
->**NOTE:** The Service Principal or Managed Service Identity running Terraform should have permissions to register [Azure Resource Providers](https://learn.microsoft.com/en-us/azure/azure-resource-manager/management/resource-providers-and-types). If the user running Terraform has insufficient permissions to register Resource Providers then we recommend setting the property [skip_provider_registration](#skip_provider_registration) in the provider block to prevent auto-registration.

Not sure if there is a Hashi guideline/best practice for this, but thought I would mention this super minor documentation inconsistency here. Should Note: be, NOTE:, Note: or note:?

Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

AFAIK there's no guidelines and it's wildly inconsistent across all the docs - I personally go for Note: and in resources that I take care of I try be consistent with what's already in there. Uppercasing this to NOTE: would introduce an inconsistency to this particular page in the docs since all the other Notes are not uppercased.

@stephybun stephybun merged commit 99d056b into main Jul 18, 2023
24 checks passed
@stephybun stephybun deleted the f/remove-kubernetes-configuration-from-required-rps branch July 18, 2023 09:42
@github-actions github-actions bot added this to the v3.66.0 milestone Jul 18, 2023
stephybun added a commit that referenced this pull request Jul 18, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
4 participants