Deploying Kyvos on Azure
This documentation is for Kyvos 2026.8.x. To view documentation for other Kyvos versions, click here. |
|---|
Overview
This guide explains how to deploy Kyvos on Azure using Azure Template Specs to automate the creation and configuration of the required infrastructure and deployment parameters.
During deployment, you'll select the compute cluster Azure uses to process the semantic model through Kyvos Native.
You can choose from:
Compute option | Best for |
|---|---|
Kubernetes | Flexible, containerized deployments where semantic model processing runs on Kubernetes-based compute nodes. Best when you already have or want to use a Kubernetes environment for Kyvos compute. |
Shared Query Engines | Cost-efficient deployments where the Query Engines handle both query serving and semantic model processing. Best when you want to reuse Query Engine resources for compute. |
Dedicated Compute | Workload isolation and scalable semantic model processing where semantic model processing runs on dedicated compute nodes, independently of Query Engines. Best when you need dedicated resources for processing workloads. |
On this page:
Deploying Kyvos through Azure Template Specs
To deploy Kyvos through Azure Template specs, perform the following steps.
Log in to the Azure Portal using an account with sufficient permissions, as described in the prerequisites.
On the Azure Portal Home page, click Cloud Shell.
In Cloud Shell, click Upload, then upload both files from the Azure Installation Files package:
formUiDefinition.jsonmainTemplate.json
After uploading the template, in the Cloud Shell area, execute the following command to create Template Specs.
az ts create --name <TemplateSpecName> --version <“VersionNumber”> --resource-group <Resource Group name> --location <“Location”> --template-file "MainTemplatePath" --ui-form-definition "FormFilePath"For example,
az ts create --name kyvosspec --version "v1.0.33" --resource-group Kyvos_RG2 --location "Central US" --template-file "./mainTemplate.json" --ui-form-definition "./formUiDefinition.json"Close Cloud Shell. In the Azure Portal search box, search for and open Template specs.
On the Template specs page, search for the Template Spec you created in Step 4.
Browse the selected Template specs and then click Deploy to launch the Kyvos deployment form.
The Kyvos Deployment form is displayed with the parameters required for deployment.
Fill in the required deployment parameters. Fields marked with * are mandatory.
After completing the information on the Tags tab, click Next, and this displays the Review + Create page. The system validates your inputs and displays a summary of the provided inputs.
To continue with deployment, click Create. This will creates all the resources and services required for deploying the Kyvos cluster.
You can also click the Previous button to navigate to the previous screens.The Outputs page displays the details for all your services and the Kyvos Manager URL.
Note
If you have deployed Kyvos with System Managed Identity, you must set the value of the VM_IDENTITY property to Both.
After completing the deployment, you must complete post deployment steps on Azure for processing semantic model through Kyvos Native Compute Engines.
To access the Usage Dashboard, you need to provide permissions after completing the deployment.
If you have deployed the cluster with Web Portal HA, you can enable TLS for Web Portal.
Next: Access Kyvos Manager and Kyvos