From b32728757744053bd4456abdafc7205b8c25c97b Mon Sep 17 00:00:00 2001 From: Nils Hanke Date: Wed, 1 Mar 2023 14:35:46 +0100 Subject: [PATCH] docs: mention resource provider registration for Azure (#1308) Co-authored-by: Thomas Tendyck <51411342+thomasten@users.noreply.github.com> --- docs/docs/getting-started/install.md | 8 ++++++ docs/docs/workflows/troubleshooting.md | 28 +++++++++++++++++++ .../version-2.2/getting-started/install.md | 8 ++++++ .../version-2.2/workflows/troubleshooting.md | 28 +++++++++++++++++++ .../version-2.3/getting-started/install.md | 8 ++++++ .../version-2.3/workflows/troubleshooting.md | 28 +++++++++++++++++++ .../version-2.4/getting-started/install.md | 8 ++++++ .../version-2.4/workflows/troubleshooting.md | 28 +++++++++++++++++++ .../version-2.5/getting-started/install.md | 8 ++++++ .../version-2.5/workflows/troubleshooting.md | 28 +++++++++++++++++++ 10 files changed, 180 insertions(+) diff --git a/docs/docs/getting-started/install.md b/docs/docs/getting-started/install.md index f5399322a..47eefd50e 100644 --- a/docs/docs/getting-started/install.md +++ b/docs/docs/getting-started/install.md @@ -111,6 +111,14 @@ If you don't have a cloud subscription, you can try [MiniConstellation](first-st +The following [resource providers need to be registered](https://learn.microsoft.com/en-us/azure/azure-resource-manager/management/resource-providers-and-types#register-resource-provider) in your subscription: +* `Microsoft.Compute` +* `Microsoft.ManagedIdentity` +* `Microsoft.Network` +* `microsoft.insights` + +By default, Constellation tries to register these automatically if they haven't been registered before. + You need the following permissions for your user account: - `Contributor` (to create cloud resources) diff --git a/docs/docs/workflows/troubleshooting.md b/docs/docs/workflows/troubleshooting.md index 85a64696d..7d3cb16fe 100644 --- a/docs/docs/workflows/troubleshooting.md +++ b/docs/docs/workflows/troubleshooting.md @@ -2,6 +2,34 @@ This section aids you in finding problems when working with Constellation. +## Azure: Resource Providers can't be registered + +On Azure, you may receive the following error when running `create` or `terminate` with limited IAM permissions: +```shell-session +Error: Error ensuring Resource Providers are registered. + +Terraform automatically attempts to register the Resource Providers it supports to +ensure it's able to provision resources. + +If you don't have permission to register Resource Providers you may wish to use the +"skip_provider_registration" flag in the Provider block to disable this functionality. + +[...] +``` + +To continue, please ensure that the [required resource providers](../getting-started/install.md#required-permissions) have been registered in your subscription by your administrator. + +Afterward, set `ARM_SKIP_PROVIDER_REGISTRATION=true` as an environment variable and either run the `create` or `terminate` step again. +For example: +```bash +ARM_SKIP_PROVIDER_REGISTRATION=true constellation create --control-plane-nodes 1 --worker-nodes 2 -y +``` + +Or alternatively, for `terminate`: +```bash +ARM_SKIP_PROVIDER_REGISTRATION=true constellation terminate +``` + ## Cloud logging To provide information during early stages of the node's boot process, Constellation logs messages into the cloud providers' log systems. Since these offerings **aren't** confidential, only generic information without any sensitive values are stored. This provides administrators with a high level understanding of the current state of a node. diff --git a/docs/versioned_docs/version-2.2/getting-started/install.md b/docs/versioned_docs/version-2.2/getting-started/install.md index f5399322a..19bae1d03 100644 --- a/docs/versioned_docs/version-2.2/getting-started/install.md +++ b/docs/versioned_docs/version-2.2/getting-started/install.md @@ -111,6 +111,14 @@ If you don't have a cloud subscription, you can try [MiniConstellation](first-st +The following resource providers need to be need to be [registered](https://learn.microsoft.com/en-us/azure/azure-resource-manager/management/resource-providers-and-types#register-resource-provider) in your subscription: +* `Microsoft.Compute` +* `Microsoft.ManagedIdentity` +* `Microsoft.Network` +* `microsoft.insights` + +By default, Constellation tries to register these automatically if they haven't been registered before. + You need the following permissions for your user account: - `Contributor` (to create cloud resources) diff --git a/docs/versioned_docs/version-2.2/workflows/troubleshooting.md b/docs/versioned_docs/version-2.2/workflows/troubleshooting.md index 8ac5b5dc9..830b27bea 100644 --- a/docs/versioned_docs/version-2.2/workflows/troubleshooting.md +++ b/docs/versioned_docs/version-2.2/workflows/troubleshooting.md @@ -2,6 +2,34 @@ This section aids you in finding problems when working with Constellation. +## Azure: Resource Providers can't be registered + +On Azure, you may receive the following error when running `create` or `terminate` step with limited IAM permissions: +```shell-session +Error: Error ensuring Resource Providers are registered. + +Terraform automatically attempts to register the Resource Providers it supports to +ensure it's able to provision resources. + +If you don't have permission to register Resource Providers you may wish to use the +"skip_provider_registration" flag in the Provider block to disable this functionality. + +[...] +``` + +To continue, please ensure that the [required resource providers](../getting-started/install.md#required-permissions) have been registered in your subscription by your administrator. + +Afterward, set `ARM_SKIP_PROVIDER_REGISTRATION=true` as an environment variable and either run the `create` or `terminate` step again. +For example: +```bash +ARM_SKIP_PROVIDER_REGISTRATION=true constellation create --control-plane-nodes 1 --worker-nodes 2 -y +``` + +Or alternatively, for `terminate`: +```bash +ARM_SKIP_PROVIDER_REGISTRATION=true constellation terminate +``` + ## Cloud logging To provide information during early stages of the node's boot process, Constellation logs messages into the cloud providers' log systems. Since these offerings **aren't** confidential, only generic information without any sensitive values are stored. This provides administrators with a high level understanding of the current state of a node. diff --git a/docs/versioned_docs/version-2.3/getting-started/install.md b/docs/versioned_docs/version-2.3/getting-started/install.md index f5399322a..19bae1d03 100644 --- a/docs/versioned_docs/version-2.3/getting-started/install.md +++ b/docs/versioned_docs/version-2.3/getting-started/install.md @@ -111,6 +111,14 @@ If you don't have a cloud subscription, you can try [MiniConstellation](first-st +The following resource providers need to be need to be [registered](https://learn.microsoft.com/en-us/azure/azure-resource-manager/management/resource-providers-and-types#register-resource-provider) in your subscription: +* `Microsoft.Compute` +* `Microsoft.ManagedIdentity` +* `Microsoft.Network` +* `microsoft.insights` + +By default, Constellation tries to register these automatically if they haven't been registered before. + You need the following permissions for your user account: - `Contributor` (to create cloud resources) diff --git a/docs/versioned_docs/version-2.3/workflows/troubleshooting.md b/docs/versioned_docs/version-2.3/workflows/troubleshooting.md index 85a64696d..a1da6537f 100644 --- a/docs/versioned_docs/version-2.3/workflows/troubleshooting.md +++ b/docs/versioned_docs/version-2.3/workflows/troubleshooting.md @@ -2,6 +2,34 @@ This section aids you in finding problems when working with Constellation. +## Azure: Resource Providers can't be registered + +On Azure, you may receive the following error when running `create` or `terminate` step with limited IAM permissions: +```shell-session +Error: Error ensuring Resource Providers are registered. + +Terraform automatically attempts to register the Resource Providers it supports to +ensure it's able to provision resources. + +If you don't have permission to register Resource Providers you may wish to use the +"skip_provider_registration" flag in the Provider block to disable this functionality. + +[...] +``` + +To continue, please ensure that the [required resource providers](../getting-started/install.md#required-permissions) have been registered in your subscription by your administrator. + +Afterward, set `ARM_SKIP_PROVIDER_REGISTRATION=true` as an environment variable and either run the `create` or `terminate` step again. +For example: +```bash +ARM_SKIP_PROVIDER_REGISTRATION=true constellation create --control-plane-nodes 1 --worker-nodes 2 -y +``` + +Or alternatively, for `terminate`: +```bash +ARM_SKIP_PROVIDER_REGISTRATION=true constellation terminate +``` + ## Cloud logging To provide information during early stages of the node's boot process, Constellation logs messages into the cloud providers' log systems. Since these offerings **aren't** confidential, only generic information without any sensitive values are stored. This provides administrators with a high level understanding of the current state of a node. diff --git a/docs/versioned_docs/version-2.4/getting-started/install.md b/docs/versioned_docs/version-2.4/getting-started/install.md index f5399322a..19bae1d03 100644 --- a/docs/versioned_docs/version-2.4/getting-started/install.md +++ b/docs/versioned_docs/version-2.4/getting-started/install.md @@ -111,6 +111,14 @@ If you don't have a cloud subscription, you can try [MiniConstellation](first-st +The following resource providers need to be need to be [registered](https://learn.microsoft.com/en-us/azure/azure-resource-manager/management/resource-providers-and-types#register-resource-provider) in your subscription: +* `Microsoft.Compute` +* `Microsoft.ManagedIdentity` +* `Microsoft.Network` +* `microsoft.insights` + +By default, Constellation tries to register these automatically if they haven't been registered before. + You need the following permissions for your user account: - `Contributor` (to create cloud resources) diff --git a/docs/versioned_docs/version-2.4/workflows/troubleshooting.md b/docs/versioned_docs/version-2.4/workflows/troubleshooting.md index 85a64696d..a1da6537f 100644 --- a/docs/versioned_docs/version-2.4/workflows/troubleshooting.md +++ b/docs/versioned_docs/version-2.4/workflows/troubleshooting.md @@ -2,6 +2,34 @@ This section aids you in finding problems when working with Constellation. +## Azure: Resource Providers can't be registered + +On Azure, you may receive the following error when running `create` or `terminate` step with limited IAM permissions: +```shell-session +Error: Error ensuring Resource Providers are registered. + +Terraform automatically attempts to register the Resource Providers it supports to +ensure it's able to provision resources. + +If you don't have permission to register Resource Providers you may wish to use the +"skip_provider_registration" flag in the Provider block to disable this functionality. + +[...] +``` + +To continue, please ensure that the [required resource providers](../getting-started/install.md#required-permissions) have been registered in your subscription by your administrator. + +Afterward, set `ARM_SKIP_PROVIDER_REGISTRATION=true` as an environment variable and either run the `create` or `terminate` step again. +For example: +```bash +ARM_SKIP_PROVIDER_REGISTRATION=true constellation create --control-plane-nodes 1 --worker-nodes 2 -y +``` + +Or alternatively, for `terminate`: +```bash +ARM_SKIP_PROVIDER_REGISTRATION=true constellation terminate +``` + ## Cloud logging To provide information during early stages of the node's boot process, Constellation logs messages into the cloud providers' log systems. Since these offerings **aren't** confidential, only generic information without any sensitive values are stored. This provides administrators with a high level understanding of the current state of a node. diff --git a/docs/versioned_docs/version-2.5/getting-started/install.md b/docs/versioned_docs/version-2.5/getting-started/install.md index f5399322a..19bae1d03 100644 --- a/docs/versioned_docs/version-2.5/getting-started/install.md +++ b/docs/versioned_docs/version-2.5/getting-started/install.md @@ -111,6 +111,14 @@ If you don't have a cloud subscription, you can try [MiniConstellation](first-st +The following resource providers need to be need to be [registered](https://learn.microsoft.com/en-us/azure/azure-resource-manager/management/resource-providers-and-types#register-resource-provider) in your subscription: +* `Microsoft.Compute` +* `Microsoft.ManagedIdentity` +* `Microsoft.Network` +* `microsoft.insights` + +By default, Constellation tries to register these automatically if they haven't been registered before. + You need the following permissions for your user account: - `Contributor` (to create cloud resources) diff --git a/docs/versioned_docs/version-2.5/workflows/troubleshooting.md b/docs/versioned_docs/version-2.5/workflows/troubleshooting.md index 85a64696d..a1da6537f 100644 --- a/docs/versioned_docs/version-2.5/workflows/troubleshooting.md +++ b/docs/versioned_docs/version-2.5/workflows/troubleshooting.md @@ -2,6 +2,34 @@ This section aids you in finding problems when working with Constellation. +## Azure: Resource Providers can't be registered + +On Azure, you may receive the following error when running `create` or `terminate` step with limited IAM permissions: +```shell-session +Error: Error ensuring Resource Providers are registered. + +Terraform automatically attempts to register the Resource Providers it supports to +ensure it's able to provision resources. + +If you don't have permission to register Resource Providers you may wish to use the +"skip_provider_registration" flag in the Provider block to disable this functionality. + +[...] +``` + +To continue, please ensure that the [required resource providers](../getting-started/install.md#required-permissions) have been registered in your subscription by your administrator. + +Afterward, set `ARM_SKIP_PROVIDER_REGISTRATION=true` as an environment variable and either run the `create` or `terminate` step again. +For example: +```bash +ARM_SKIP_PROVIDER_REGISTRATION=true constellation create --control-plane-nodes 1 --worker-nodes 2 -y +``` + +Or alternatively, for `terminate`: +```bash +ARM_SKIP_PROVIDER_REGISTRATION=true constellation terminate +``` + ## Cloud logging To provide information during early stages of the node's boot process, Constellation logs messages into the cloud providers' log systems. Since these offerings **aren't** confidential, only generic information without any sensitive values are stored. This provides administrators with a high level understanding of the current state of a node.