Installing Sidra via the Azure Portal¶
License Requirement
A valid Sidra license is required before installation. To request a license or get assistance, please contact us.
This guide explains how to deploy Sidra into your Azure subscription using the Azure Portal. This is the recommended method for most scenarios. For more advanced or customized setups, see the Advanced Deployment Scenarios.
Overview of the Deployment Process¶
Sidra is deployed in two main stages:
- A bootstrap resource group is created. This group hosts the bootstrapper, a web-based interface that initiates and guides the deployment process.
- After configuration, the bootstrapper deploys the Sidra environment into a dedicated managed resource group.
Each bootstrapper manages one Sidra environment (e.g., development, test, production), and multiple environments can coexist in the same Azure subscription.
Deployment Flow¶
- Deploy the bootstrapper using the Azure Portal into a new or existing resource group.
- Configure the Sidra environment using the bootstrapper's web UI. This step launches the deployment of the core managed resource group and the Supervisor service.
- Access the Supervisor once it's deployed to continue installing the remaining Sidra services and infrastructure.
Installation Walkthrough¶
The next sections provide a step-by-step guide to deploying a new Sidra environment using the Azure bootstrapper.
Deploying the Bootstrapper¶
Sidra environments are deployed using a lightweight installer known as the Sidra Bootstrapper, which is provisioned through a Managed Application hosted by Sidra on Microsoft Azure.
Info
To gain access to the Sidra managed application, please contact us. We will enable the application in your subscription.
To deploy the Bootstrapper, you will need to provide a few configuration parameters. These do not yet affect your Sidra services or data — they are used exclusively to provision the initial deployment infrastructure.
Parameter | Description |
---|---|
Subscription | The target Azure subscription where the Sidra environment will be deployed. |
Resource Group | The resource group that will host the bootstrapper(s). This is not where Sidra services or customer data will reside—only the bootstrap utilities. |
Region | The Azure region where the bootstrapper’s managed application will be deployed. This does not dictate the region of Sidra services or customer data. |
Installer Name | The name of the Sidra Managed Application instance. |
Application Name | The name of the Bootstrapper. We recommend naming it after the environment you’re creating (e.g., Dev , Test , Prod , QA , Demo ). |
Application Resources RG Name | The name of the Managed Resource Group where the Bootstrapper and all Sidra services will be deployed, starting with the Supervisor. |
For this tutorial, we’ll deploy a new Sidra environment called Tutorial, using the following values:
- Subscription:
Demos
- Resource Group:
Sidra.Bootstrap
- Region:
West US 3
- Installer Name:
sidra-bootstrap-tutorial-20250515171300
- Application Name:
Tutorial
- Application Resources RG Name:
Sidra.Tutorial
Once the Managed Application has been deployed, click Go to resource to open its configuration screen. You’ll see a brief explanation of how to access the Bootstrapper Web UI.
The most direct way to launch the interface is by navigating to: Settings → Parameters and Outputs
Then, copy the URL shown under the containerUri
field in the Outputs section.
Configuring the Bootstrapper¶
Now that we have the bootstrapper properly deployed, we need to set it up and to ensure we satisfy all the pre-requirements to continue with the next stage of the deployment flow, which is deploying Sidra's Supervisor. Let's open a browser and navigate to the URL you copied in the previous step:
You will be greeted with a description of the process and pre-requisites that need to be met to be able to continue with the installation of Sidra.
Requirements Checklist¶
Sidra License¶
A valid Sidra license is required.
Azure Access¶
-
Access to Azure Portal
You must have access to the Azure Portal and the target subscription where Sidra will be deployed. -
Azure Built-In Roles (at Subscription Scope)
The following roles must be assigned at the subscription level:
-
Contributor
Grants permission to create and manage Azure resources (e.g., Key Vaults, Container Apps, Storage Accounts).
This role must be assigned to the Supervisor’s managed identity to enable deployment of Sidra Services. -
Role Based Access Control Administrator (Preview) or User Access Administrator
Required to execute the PowerShell script that resets the password of the Active Directory app registrations created during pre-deployment.
Preview vs. Legacy
Role Based Access Control Administrator (Preview) is the preferred role due to more limited permissions.
If unavailable, the legacy User Access Administrator role can be used as an alternative.You can verify assigned roles by navigating to Access control (IAM) in the Azure Portal:
-
-
Microsoft Entra ID (formerly Azure Active Directory) Roles
The following Microsoft Entra ID roles must be assigned to your user account:
-
Application Administrator
Required to create and manage Azure AD applications, such as:<<appRegistrationName>>.Manager
<<appRegistrationName>>.IdentityServerAdAccess
-
Privileged Role Administrator
Required to assign roles (such as Contributor) to users, groups, or managed identities — including those with privileged access.
This role is necessary to assign the Contributor role to the Supervisor’s managed identity during deployment.
You can verify these roles in the Privileged Identity Management section of the Azure Portal:
-
Resource Providers¶
- Ensure all the required Azure resource providers are registered:
List of required Azure Resource Providers
Azure Resource Provider | Documentation Link |
---|---|
Microsoft.ADHybridHealthService | Link |
Microsoft.Advisor | Link |
Microsoft.AlertsManagement | Link |
Microsoft.Authorization | Link |
Microsoft.App | Link |
Microsoft.CognitiveServices | Link |
Microsoft.Compute | Link |
Microsoft.ContainerInstance | Link |
Microsoft.ContainerRegistry | Link |
Microsoft.ContainerService | Link |
Microsoft.CostManagement | Link |
Microsoft.Databricks | Link |
Microsoft.DataFactory | Link |
Microsoft.EventGrid | Link |
Microsoft.Features | Link |
Microsoft.Insights | Link |
Microsoft.KeyVault | Link |
Microsoft.ManagedIdentity | Link |
Microsoft.MarketplaceOrdering | Link |
Microsoft.Network | Link |
Microsoft.OperationalInsights | Link |
Microsoft.Portal | Link |
Microsoft.ResourceGraph | Link |
Microsoft.Resources | Link |
Microsoft.Search | Link |
Microsoft.SerialConsole | Link |
Microsoft.SignalRService | Link |
Microsoft.Sql | Link |
Microsoft.Storage | Link |
Microsoft.Support | Link |
What does it mean to register Azure resource providers?
In Azure, resource providers are services that enable specific resource types (e.g., Databricks, Key Vault, Storage). These providers must be registered at the subscription level before you can deploy related resources.
Sidra relies on a variety of these providers. If any required provider is not registered, the deployment will fail.
How to check and register providers
In Azure Portal: 1. Open the Azure Portal. 2. Navigate to Subscriptions and select your subscription. 3. Select Resource providers from the left-hand menu. 4. Search for the provider (e.g., Microsoft.Databricks
). 5. If the status is NotRegistered, click Register.
Using Azure CLI:
# Check registration status
az provider show --namespace Microsoft.Databricks --query "registrationState"
# Register the provider
az provider register --namespace Microsoft.Databricks
For full details, see Microsoft's documentation.
Required Tools¶
Ensure the following tools are installed on the system where the script will run:
- Azure CLI: v2.49.0 or later (download here)
- PowerShell: v7.3.6 or later (download here)
Pre-Deployment Script¶
Sidra requires the creation of Microsoft Entra ID applications and managed identities before the Supervisor can be deployed. This is handled via a PowerShell script that should be executed prior to installation. You will run the script with your environment-specific parameters later but for now download the script archive and extract its contents locally.
Running the Pre-Deployment Script¶
We recommend running the script on a lightweight VM deployed in the same resource group as the Bootstrapper (e.g., Sidra.Bootstrap
). This allows reproducible execution for future environments or maintenance tasks. However, running it locally is also supported.
Before running the script, set the PowerShell execution policy:
With the required tools installed and the script extracted, you're ready to run the pre-deployment script. Simply copy the script command — including all required parameters — from the Bootstrapper Web UI and execute it in your terminal.
.\Pre-deploy.ps1 -appRegistrationName "Sidra.Tutorial" `
-tenantId "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx" `
-subscriptionId "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx" `
-resourceGroupName "Sidra.Tutorial" `
-resourceGroupLocation "westus3"
You can find all parameters, except appRegistrationName
, directly in the Subscription Details section of the Bootstrapper Web UI:
We recommend using a naming convention like Sidra.<Environment>
for the appRegistrationName
.
More Details on the Pre-Deployment Script
This script ensures all prerequisite assets are deployed before the Supervisor. The script accepts the following parameters:
Parameter name | Description | Example | Required |
---|---|---|---|
appRegistrationName | Name prefix used to create the AAD app registrations | Sidra.Dev | Yes |
subscriptionId | The subscription's ID in which the resources are going to be deployed | 000000-0000-0000-0000-000000000000 | Yes |
tenantId | The directory ID of the used subscription | 000000-0000-0000-0000-000000000000 | Yes |
resourceGroupName | Name of the resource group which will have the created managed identities. This name is going to be used later for Sidra's resource group name | Sidra.Dev | Yes |
resourceGroupLocation | Location where the resource group is created | northeurope | Yes |
resourceGroupTags | Tags to be included in any Sidra resource group | tag1=value1, tag2=value2 |
The subscriptionId
and tenantId
can also be found in the Azure Portal:
Once executed, the script provisions the following resources in Azure:
-
Managed Identities:
- One identity with
Directory Readers
privileges - One identity with
Application Administrator
privileges
- One identity with
-
Entra ID App Registrations
Two app registrations are created using the provided
appRegistrationName
:- Manager App Registration Used by the Supervisor and DSU deployments. Related secrets stored in Key Vault:
AADApplications--Manager--Password
-
AADApplications--Manager--ApplicationId
-
Authentication App Registration Used by the Authentication Service. Related secrets:
AADApplications--IdentityServer--ApplicationId
AADApplications--IdentityServer--Password
AAD--0--ClientSecret
Take note of the output
Once completed, take note of the generated outputs:
Authentication - Application Id
Manager - Application Id
These values will be required during deployment configuration.
After execution, verify that the resource group Sidra.Tutorial
was created and includes the expected pre-deployment assets.
Unity Catalog Configuration¶
Starting with version 2024.07
, Sidra supports Databricks Unity Catalog as the metastore backend for its data workloads.
What is Unity Catalog?
Learn more about Unity Catalog in the official Databricks documentation.
This configuration step cannot be automated and must be performed manually, between the pre-deployment script execution and the Supervisor deployment.
Step-by-Step Instructions
-
Access the Databricks Account Console:
Navigate to the Databricks Account Console using a user with Account Administrator privileges.
- If this is your first Databricks deployment, use a Microsoft Entra Global Administrator to access the console and assign the necessary roles.
- If the Account Console is not accessible, deploy a temporary Databricks workspace from the Azure Portal. This action will initialize the console, which will remain available even after deleting the workspace.
-
Note the Databricks Account ID:
This value will be required later. It can be found in the upper-right corner of the Account Console:
-
Assign Account Admin to the Sidra Manager Service Principal:
Use the App Registration Manager ID returned by the pre-deployment script. - Go to Users and Groups:
- Under the Service Principals tab, click Add service principal:
- Choose
Microsoft Entra ID managed
, enter the Manager - Application Id value that was produced by the output of the Pre-Deployment script, and provide a name (e.g:Sidra.Tutorial.Manager
):- Click Add Service Principal, then assign the Account Admin role in the roles section:
-
Generate and Save the Client Secret:
Navigate back to the Principal Information section, and generate a Client Secret. Copy and store it securely, as it cannot be retrieved later:
Deploying the Supervisor¶
With all prerequisites now in place, you're ready to deploy Sidra’s Supervisor service. At this stage:
- The pre-deployment script has been executed, provisioning the necessary Azure identities and app registrations.
- Unity Catalog access has been granted to the Manager service principal.
To proceed, review and accept the End User License Agreement, then click Begin:
Before the deployment begins, the bootstrapper will display a final checklist summarizing the required prerequisites. Click Continue to launch the Supervisor deployment process:
Next, you’ll be prompted to populate the configuration parameters required for the Supervisor deployment. These values are retrieved from the earlier steps — specifically from the pre-deployment script output and the Databricks setup.
Detailed Parameter Information
The parameters listed below are required to configure the Supervisor deployment. While the Bootstrapper UI includes tooltips for each field, this table provides a consolidated reference with descriptions and sample values.
Parameter name | Description | Example | Required |
---|---|---|---|
Manager Application Id | Client ID of the Azure AD app registration used by the Supervisor to authenticate in Azure. | 8bfead2e-c5f7-47e7-9b01-8a8d08516dc6 | Yes |
Manager Secret | Client secret for the Supervisor's Manager app registration, used to authenticate against Azure. | GP49Q~JkE4nk40UlwHI3.QXwyry4AASgLIkYkbll | Yes |
Prefix | Global prefix applied to all resource names in this Sidra deployment. | sds | Yes |
Environment | Name of the environment being deployed (e.g., dev, test, prod). Used in resource naming. | prod | Yes |
Sidra's Admin Email | Email address of the initial Sidra administrator. | [email protected] | Yes |
Authentication Application Id | Client ID of the Azure AD app registration used by the Authentication Service. | 22009ce7-863e-48d5-89a6-02a1257c472e | Yes |
Manager Service Principal (Object Id) | Object ID of the service principal for the Supervisor’s Manager application. | c7ba8e52-dbe1-4d2b-8626-269232ea1c52 | Yes |
Company Name | Name of the organization. Used as part of the naming convention for app registrations and resources. | Sidra | Yes |
Databricks Account Id | Databricks Account ID associated with Unity Catalog configuration. | d68fb9b9-30c6-4040-9a1c-9bf9c7561c32 | Yes |
Databricks Admin Client Secret | Client secret for the Manager service principal in Databricks, used for Unity Catalog access. | dose219c112cac9ca66345691daff331019a | Yes |
Data Catalog AI Search Tier | Azure tier to use for AI-powered search in the Data Catalog (e.g., Basic, Standard). | Basic | Yes |
Default DSU AI Search Tier | Azure tier to use for the default DSU AI search service. Set to None if search is not required. | None | Yes |
Although this guide focuses on the default deployment scenario, an advanced configuration is available. By enabling the checkbox labeled "Choose this option to deploy Sidra in an existing VNet" at the bottom of the Bootstrapper UI, additional parameters for custom VNet integration will appear.
Parameter name | Description | Example | Required |
---|---|---|---|
VNet Name | Name of the existing Azure Virtual Network where Sidra resources will be deployed. | MyCompanyVNet | Yes |
VNet Resource Group Name | Name of the resource group that contains the specified VNet. | MyCompany.VNet | Yes |
Database Subnet Name | Name of the subnet within the VNet that will host database-related resources (e.g., SQL databases). | database | Yes |
Container App Subnet Name | Name of the subnet designated for Container Apps (e.g., Supervisor or service containers). | container_app | Yes |
Storage Subnet Name | Name of the subnet used for storage accounts and blob services. | storage | Yes |
App Subnet Name | Name of the general-purpose subnet for web apps and APIs. | app | Yes |
Default Subnet Name | Fallback subnet used by default for services not assigned to a specific subnet. | app | Yes |
DSU Databricks Host Subnet Name | Subnet for the public-facing Databricks VNet injection (host) in the Data Storage Unit (DSU). | databricks_host | Yes |
DSU Databricks Cluster Subnet Name | Subnet for the private Databricks cluster nodes in the DSU. | databricks_cluster | Yes |
Once the Supervisor deployment begins, the bootstrapper will provide a link to monitor the provisioning of Azure resources. After the deployment completes, a checklist of post-deployment actions will appear:
Supervisor Deployment Time
Deploying Sidra’s Supervisor involves provisioning and configuring a wide range of Azure resources. This step typically takes 30 minutes or more. While the bootstrapper will notify you when the process finishes, we strongly recommend using the provided deployment link to monitor progress in real time.
At this stage, the Supervisor has been successfully deployed. It acts as the central management hub for Sidra’s installation, overseeing the deployment and update of all core services — including Sidra Service, Authentication, and Authorization.
To access the Supervisor web interface:
- Navigate to the Supervisor Resource Group in the Azure Portal.
-
Locate and open the Container App for the Supervisor Web UI, then click the application URL.
-
Enter your Sidra license key when prompted.
-
Sidra will begin installing its core services — Sidra Service, Authentication, and Authorization. This automated process typically takes 45–60 minutes.
-
When installation completes, the Supervisor dashboard will display the list of deployed services. From here, you can install, upgrade, or manage additional platform components.
Your Sidra environment is now fully deployed and ready to use. The Supervisor is installed, the core services are running, and your platform is primed for action.
Next Steps¶
Now that your environment is up and running, you can start building value with Sidra. Here are a few key actions you can take next:
Create Your First Data Intake Process (DIP)¶
Start bringing data into your environment with Sidra’s guided, connector-driven ingestion system. The DIP workflow will help you configure source metadata, manage schemas, and kick off fully automated ingestion pipelines.
Follow the step-by-step tutorial to create a DIP
Deploy a New Data Product¶
Ready to build a solution with your ingested data? Sidra Data Products allow you to define domain-oriented, secure, and independent workloads for BI, ML, APIs, and more.
Learn how to deploy your first Data Product
If you encounter any issues or need assistance, don’t hesitate to reach out to us at [email protected]. We're here to help you succeed.