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.

Sign up for GitHub

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
Merged

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

Show file tree
Hide file tree
Changes from 2 commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
a9758c3
removed kubernetes and kubernetesconfiguration from required.go
stephybun Jul 18, 2023
06c1d3e
add Note in docs about user permissions
stephybun Jul 18, 2023
78f745f
review suggestion
stephybun Jul 18, 2023
7f0477b
shorten to managed identity for consistent nomenclature
stephybun Jul 18, 2023
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 0 additions & 2 deletions internal/resourceproviders/required.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -47,8 +47,6 @@ func Required() map[string]struct{} {
"Microsoft.HealthcareApis": {},
"Microsoft.GuestConfiguration": {},
"Microsoft.KeyVault": {},
"Microsoft.Kubernetes": {},
"Microsoft.KubernetesConfiguration": {},
"Microsoft.Kusto": {},
"microsoft.insights": {},
"Microsoft.Logic": {},
Expand Down
6 changes: 5 additions & 1 deletion website/docs/index.html.markdown
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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.
stephybun marked this conversation as resolved.
Show resolved Hide resolved
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.


## Example Usage

```hcl
Expand All @@ -45,7 +47,9 @@ terraform {

# Configure the Microsoft Azure Provider
provider "azurerm" {
features {}
features {
skip_provider_registration = true # This is only required when the user running Terraform lacks the permissions to register Azure Resource Providers.
stephybun marked this conversation as resolved.
Show resolved Hide resolved
}
}

# Create a resource group
Expand Down