Skip to main content
Version: 9.4

Azure Requirements

This page describes Azure requirements and input variables used when deploying a new Qrvey instance.

AKS Support

Azure Kubernetes Service (AKS) v1.33 is the default version starting in v9.2.5. AKS v1.32 discontinued standard support on March 23, 2026. Qrvey recommends that all v9.2.x customers upgrade to v9.2.5. If you have a question about AKS support on the Qrvey platform, contact Qrvey Support.

Requirements

  • Registry User and Password - Provided by the Qrvey Support team.
  • OWNER Access Permissions - Required for an Azure subscription or resource group to create a service principal and assign it a contributor role to the resource group being used.
  • Minimum CIDR - The VPC (or equivalent) used to deploy the Qrvey Platform must have a minimum CIDR of /22.
  • Docker - Required to run the auto-deploy script.
  • Docker Image - The Docker Image for the desired version, found in the release notes.
  • Azure Portal Subscription - Needed for billing and resource installation in Azure.
  • Azure Resource Group - Groups all Qrvey resources.
  • Azure Storage Account - Stores an Azure container.
  • Azure Synapse - Analytics service. For more information, see Synapse Configuration.
  • Azure Container - Stores Terraform state.
  • SMTP Server - Used to send emails.
  • DNS Hosted Zone (Optional) - Generates valid SSL certificates for the Qrvey Composer domain. If no domain is set up, Qrvey generates a default domain in the format: $deployment_id.mp.qrveyapp.com.

Note: Before deploying, ensure your Azure subscription quotas are sufficient for the required resources. You might need to request quota increases for the following:

  • Epdsv6 family: 100 vCPU
  • Dpdsv6 family: 100 vCPU
  • Spot cores: +50–100 vCPU (depending on expected spot usage) Quota increases can be requested through the Azure Portal. Insufficient quotas can cause deployment failures. The initial deployment does not use all of these CPUs. The higher quota is required to support autoscaling as your environment grows.

Azure Deployment Input Variables

This section describes the input variables available for Azure deployment using Terraform. Each variable can be customized to fit your deployment requirements. Refer to the table below for variable names, types, default values, and descriptions.

Variable NameTypeDefault ValueDescription
aks_cluster_versionstring""Upgrade only. Upgrades AKS to v1.33 when performing a Qrvey upgrade to v9.2.5. Required value: "1.33.0".
Requires an additional command when running the Qrvey upgrade.
aks_nodepool_versionstring""Upgrade only. Upgrades AKS to v1.33 when performing a Qrvey upgrade to v9.2.5. Required value: "1.33.0".
Requires an additional command when running the Qrvey upgrade.
ARM_CLIENT_IDstring""Required. Azure Service Principal Client ID.
ARM_CLIENT_SECRETstring""Required. Azure Service Principal Client Secret.
ARM_TENANT_IDstring""Required. Azure Tenant ID.
ARM_SUBSCRIPTION_IDstring""Required. Azure Subscription ID.
resource_group_namestring""Required. Name of the Azure Resource Group.
storage_account_namestring""Name of the Azure Storage Account.
container_namestring""Name of the Azure Storage Container.
keystring"terraform.tfstate"Name of the Terraform state file.
dns_zone_namestring""DNS zone name (optional).
enable_monitoringboolfalseEnable monitoring features. When enabled, Grafana credentials are added to Qrvey environment variables. For more information, see Configure Monitoring and Logging.
registry_userstring""Required. Qrvey registry user.
registry_keystring""Required. Qrvey registry key.
qrvey_chart_versionstring""Required. Qrvey chart version.
locationstring"eastus2"Azure location for resources.
enable_location_servicesboolfalseEnable location services.
enable_synapseboolfalseDeploy Synapse chart.
managed_nat_gatewayboolfalseUse managed NAT gateway for outbound connectivity.
es_configobject{}Elasticsearch config (size, count).
customer_infoobject{}Required. An object containing customer information.
initial_admin_emailstring""Required. Initial admin email.
globalizationobject{}Globalization settings (google_client_email, google_client_private_key, and so on).
create_resource_groupboolfalseCreate a resource group or use an existing one.
storage_account_replication_typestring"LRS"Storage account replication type. Valid values are LRS, GRS, RAGRS or ZRS.
network_pluginstring"azure"Network plugin to use.
network_policystring"azure"Network policy to use.
network_address_spacelist(string)["10.208.0.0/12"]Network address space.
subnet_address_prefixeslist(string)["10.220.0.0/20"]Subnet address prefixes.
openai_api_keystring"sk-xxxxxxxxxx"OpenAI API key.
security_headersobject{}Allows customers to modify security headers in the HTTP response. For an example, see HTTP Response Security Headers.
table_hierarchy_enabledboolfalseEnable table hierarchy feature.
rabbitmq_replica_countnumber3Number of replicas for the RabbitMQ cluster. If you are upgrading from v9.1.x to 9.2.2 or later, use this flag to retain the replica count at 3.
dataload_configobject{}(Available starting version 9.2.2) Configuration for dataset loading microservices. Allows setting min/max replicas for each datarouter pod. All properties are optional.

customer_info

{
"firstname": "string",
"lastname": "string",
"email": "string",
"company": "string"
}

es_config

{
"size": "large", // can be small, medium, large, xlarge, 2xlarge, 4xlarge
"count": 1
}

globalization

{
"google_client_email": "", // optional
"google_client_private_key": "", // optional
"google_document_id": "", // optional
"google_document_sheet_title": "" // optional
}

HTTP Response Security Headers

"security_headers": {
"content_security_policy": "default-src * 'unsafe-inline' 'unsafe-eval' data: blob:; script-src * 'unsafe-inline' 'unsafe-eval'; style-src * 'unsafe-inline';",
"x_frame_options": "SAMEORIGIN",
"cache_control": "no-cache, no-store, must-revalidate",
"referrer_policy": "unsafe-url"
}

dataload_config

The dataload_config object allows you to configure resource requests/limits and autoscaling for each microservice involved in dataset loading. All properties under dataload_config are optional. If you do not specify some properties, the system uses default values as shown in the following example. Available starting version 9.2.2.

Note: Changing these properties directly impacts the data loading process and can increase or decrease performance. Increasing the maximum number of replicas can improve throughput, but also increases cloud costs. Adjust these values carefully based on your needs and budget.

{
"dr_file_pump": {
"resources": {
"requests": {
"memory": "768Mi",
"cpu": "15m"
},
"limits": {
"memory": "768Mi",
"cpu": "1500m"
}
},
"autoscaling": {
"min_replicas": 1,
"max_replicas": 2
}
},
"dr_db_pump": {
"resources": {
"requests": {
"memory": "512Mi",
"cpu": "15m"
},
"limits": {
"memory": "3072Mi",
"cpu": "1500m"
}
},
"autoscaling": {
"min_replicas": 1,
"max_replicas": 2
}
},
"dr_join_results_pump": {
"resources": {
"requests": {
"memory": "256Mi",
"cpu": "100m"
},
"limits": {
"memory": "1024Mi",
"cpu": "1"
}
},
"autoscaling": {
"min_replicas": 1,
"max_replicas": 10
}
},
"dr_transformation": {
"resources": {
"requests": {
"memory": "256Mi",
"cpu": "100m"
},
"limits": {
"memory": "2096Mi",
"cpu": "2"
}
},
"autoscaling": {
"min_replicas": 1,
"max_replicas": 5
}
},
"dr_put_chunk_to_lake": {
"resources": {
"requests": {
"memory": "256Mi",
"cpu": "50m"
},
"limits": {
"memory": "1536Mi",
"cpu": "1"
}
},
"autoscaling": {
"min_replicas": 1,
"max_replicas": 10
}
},
"dr_put_chunk_to_dl": {
"resources": {
"requests": {
"memory": "256Mi",
"cpu": "15m"
},
"limits": {
"memory": "1536Mi",
"cpu": "1"
}
},
"autoscaling": {
"min_replicas": 1,
"max_replicas": 10
}
}
}

Customize a Deployment

You can customize your existing Qrvey deployment by modifying the parameters in your config.json file and re-deploying the configuration. This allows you to change various settings without redeploying from scratch.

To customize your deployment:

  1. Navigate to the directory containing your config.json file.

  2. Edit the config.json file and modify the desired parameters under the "variables" object.

  3. Save the changes.

  4. Run the apply command to update your deployment:

    docker run --platform=linux/amd64 -v $(pwd)/config.json:/app/qrvey/config.json -v $(pwd)/terraform-output.yaml:/app/aws/terraform-output.yaml -v $(pwd)/terraform-output.yaml:/app/azure/terraform-output.yaml -v $(pwd)/work:/app/work -it --rm qrvey.azurecr.io/qrvey-terraform:{qrvey_version} apply
  5. Wait for the process to complete and review the output.

Example: Changing the Domain (DNS) for an Existing Instance

One common customization is setting up a custom domain for your Qrvey deployment.

  1. Update your config.json file.

    Set the dns_zone_name property under the "variables" object to your desired custom domain:

    {
    "account_config": {
    // ... existing account config ...
    },
    "variables": {
    // ... other variables ...
    "dns_zone_name": "qrvey.yourdomain.com"
    }
    }
  2. Apply the changes.

    Run the apply command to update your deployment:

    docker run --platform=linux/amd64 -v $(pwd)/config.json:/app/qrvey/config.json -v $(pwd)/terraform-output.yaml:/app/aws/terraform-output.yaml -v $(pwd)/terraform-output.yaml:/app/azure/terraform-output.yaml -v $(pwd)/work:/app/work -it --rm qrvey.azurecr.io/qrvey-terraform:{qrvey_version} apply
  3. Configure DNS.

    After the apply process completes, the output includes a Load Balancer URL entry. For example:

    Load Balancer URL: qrvey-lb-12345678.eastus2.cloudapp.azure.com

    Add a CNAME record to your DNS provider:

    • Name/Host - qrvey (or your desired subdomain)
    • Type - CNAME
    • Value/Target - The Load Balancer URL from the output (for example, qrvey-lb-12345678.eastus2.cloudapp.azure.com)
    • TTL - 300 (or your preferred value)

    After you add the CNAME record, DNS propagation can take a few minutes to several hours depending on your DNS provider and TTL settings.

  4. Access your deployment.

    After DNS propagation is complete, you can access your Qrvey deployment using your custom domain (for example, https://qrvey.yourdomain.com).

Note: Verify your DNS provider supports CNAME records for the subdomain you're configuring. Some providers might require additional configuration for apex domains (root domains without subdomains).

Property Descriptions

  • Each top-level key (for example, dr_file_pump, dr_db_pump) represents a microservice involved in dataset loading.
  • resources - Specifies CPU and memory resource requests and limits for each microservice pod.
    • requests - Minimum resources guaranteed for the pod.
    • limits - Maximum resources the pod can use.
  • autoscaling - Controls the minimum and maximum number of replicas for each microservice.
    • min_replicas - Minimum number of pods to run.
    • max_replicas - Maximum number of pods to run.

Additional Resources