Pre-installation checklist

On this page

  1. Check qualification
  2. Check quota
  3. Register resource providers
    1. Manual registration of resource providers
    2. Automatic registration of resource providers
    3. Verification script
  4. Configure firewall settings
  5. Configure network settings
    1. Define VNet
    2. Analyze CluedIn network configuration
  6. Analyze Azure policies and tagging
  7. CluedIn is a co-owner of the deployed resource groups
  8. Results
  9. Next steps

In this article, you will learn about the pre-installation processes that you must perform to ensure successful installation of CluedIn.

Pre-installation checklist

Check qualification

As a Microsoft Azure Administrator, you should have expertise in implementing, managing, and monitoring your organization’s Microsoft Azure environment.

Because CluedIn will be installed in your Azure resource group, you need to be the Owner of that resource group or at least the Contributor to that resource group.

In addition, you should have permission to purchase paid applications from the Azure Marketplace. Set the permission to Free + Paid to complete the purchase registration in the Azure Marketplace.

Check_qualification_Purchasing.png

To learn how to allow purchases, see Azure Marketplace purchasing.

Check quota

You should perform a quota check to make sure that your subscription has enough quotas for creating VMs required for CluedIn clusters.

There are 3 common VM family types that CluedIn will create as part of the AKS node pools. Your subscription must have enough spare vCPU quota to provision different nodes. For details on the quota for each VM, see the table below.

VM Quota
System Pool (1 x Standard_DS2_v2) At least 2 vCPUs in the Standard DSv2 Family vCPUs quota
General Pool (2 x Standard_D8s_v4) At least 16 vCPUs in the Standard DSv4 Family vCPUs quota
Data Pool (3 x Standard D8as_v5) At least 24 vCPUs in the Standard DASv5 Family vCPUs quota

In addition, check if you have enough quota for your plan.

Plan Quota
Essential At least 8 vCPUs in the StandardDASv5Family quota
Professional At least 16 vCPUs in the StandardDASv5Family quota
Elite At least 32 vCPUs in the StandardDASv5Family quota

You can check if you have enough quota by running a verification script.

Important! If the quota is not available, then the installation will fail.

Register resource providers

Before using a resource provider, register your Azure subscription for that specific resource provider.

Make sure that the following resource providers are registered:

  • Microsoft.Cache
  • Microsoft.Capacity
  • Microsoft.Compute
  • Microsoft.ContainerService
  • Microsoft.EventHub
  • Microsoft.KeyVault
  • Microsoft.ManagedIdentity
  • Microsoft.Network
  • Microsoft.OperationalInsights
  • Microsoft.OperationsManagement
  • Microsoft.Resources
  • Microsoft.Storage
  • Microsoft.Sql

You can register the resource providers in two ways: manually in the Azure portal and automatically by running a script.

After you register the resource providers, run the verification script to make sure that all resource providers are registered.

Manual registration of resource providers

This section contains the step-by-step procedure for manual registration of resource providers in the Azure portal.

To register resource providers

  1. In the Azure portal, find and select the subscription where you need to install CluedIn.

    For more information about the subscription, see Get subscription and tenant IDs in the Azure portal.

  2. On the left menu, under Settings, select Resource providers.

  3. One by one, find and select the resource providers that you want to register, and then select Register.

    Manual_Registration_1

    Wait until the status of the resource provider is changed from Registering to Registered.

    Manual_Registration_2

  4. Run the verification script to make sure that all resource providers are registered.

For more information about registering resource providers, see Azure documentation.

Automatic registration of resource providers

If you want a faster way to register the needed resource providers, run the script for automatic registration of resource providers.

Prerequisites

To run the script for registering resource providers

  1. Download this script.

  2. Open your PowerShell terminal and run the following:

    .\pre-checks.ps1 <subscrioptionId> -Register
    # e.g. .\pre-checks.ps1 abc68d12-8e99-4890-b3a0-ca25816b1c26 -Register
    

    You will get an autput similar to the following.

    output-automatic_registration.png

Verification script

The verification script checks if you have enough quota and if all required resource providers are registered.

Prerequisites

To run the verification script

  1. Download this verification script.
  2. Open your PowerShell terminal and run the following:
    .\check.ps1 -SubscriptionId <subscrioptionId> -Location <location>
    # e.g. .\check.ps1 -SubscriptionId abc68d12-8e99-4890-b3a0-ca25816b1c26 -Location uksouth
    

    As a result, you will get a file named results_location.json that will be stored in the same directory. The file will contain the details about the quota and the status of resource providers.

Example output of quota check

"Location": "westeurope",
  "Quotas": [
    {
      "Name": "Standard Dv4 Family vCPUs",
      "Plan": "All",
      "Required": 40,
      "Available": 50,
      "IncreaseRequired": false
    }

Example output of resource providers check

"Providers": [
    {
      "Name": "Microsoft.Authorization",
      "Registered": "Registered"
    },
    {
      "Name": "Microsoft.Cache",
      "Registered": "Registered"
    }

Configure firewall settings

Your Azure Firewall should cover the following:

For the list of firewall rules that should be added to your Azure Firewall, see Configure firewall.

Important! If the rules have not been added, the installation will fail.

Configure network settings

CluedIn is very flexible in terms of network configuration and comes out of the box with a new vnet with a predefined address space and subnet. CluedIn is isolated out of the box, and this should work for most setups, but we do allow granular control over the network to support zero-trust and integrations.

If you prefer to use an existing vnet or would like to do some advanced configuration, please contact one of our infrastructure experts before installation to ensure it’s properly implemented as it can be challenging to change post-deployment.

Define VNet

During the installation process, you will have the option to update the vnet from the default address space of 10.0.0.0/8 and a subnet 10.0.0.0/16 for the Azure Kubernetes Service.

If you have an existing VNet and you want to reuse it for CluedIn installation, contact one of our infrastructure experts for assistance. You can specify the existing VNet in the Advanced configuration step of CluedIn installation.

Analyze CluedIn network configuration

The following diagram shows default CluedIn network configuration after installation.

ama-network-1.jpeg

The deployed Azure Kubernetes Service is deployed with a single Azure Load Balancer that is used for both ingress and egress traffic. It is possible to update this post-deployment so that access is only possible via internal vnet integration, but it does require a number of steps.

If you would like support on this, please reach out to one of CluedIn’s infrastructure engineers to assist you with this change.

More information regarding networking can be found in Advanced network configuration.

Analyze Azure policies and tagging

The installation wizard supplies consumers to add resource tags during runtime. Please be aware of how tagging works before going through the installation as additional steps may be required.

Tags supplied at runtime will apply to the deployed CluedIn resources. This includes the AKS cluster, key vault, virtual network, log analytics, and a few other resources.

It does not apply to the managed resource group, the AKS node resource group, or the managed application resource itself. This is a limitation of how the Marketplace Applications works.

If your tenant has comprehensive tagging, it is recommended to add a temporary exemption for the subscription at install time, and then add tags post-deployment.

CluedIn is a co-owner of the deployed resource groups

As part of the onboarding via Azure Marketplace installation, the CluedIn support team gets co-ownership of the Managed Resource Group (MRG) where the application resources are deployed, along with the Node Resource Group that the Azure Kubernetes Service (AKS) deploys.

The accounts that have access to customer resources are protected by a number of security measures such as multi-factor authentication and the level of permissions is Publisher and customer access.

Please ensure this complies with your internal security teams policy before proceeding with installation.

For more information, refer to Publisher and customer permissions

Results

  1. You are qualified to perform the CluedIn installation process, and you have all the required permissions.
  2. Your Azure subscription can sustain the required quota.
  3. You have registered the required resource providers.
  4. Your firewall is ready and configured to support the installation of CluedIn.
  5. You have planned your network architecture.
  6. Your security team is comfortable with CluedIn having co-ownership of the deployed resources.

Next steps

Start the CluedIn installation process as described in our Installation guide.