Azure Deployment

This page describes how to deploy a new Qrvey MultiPlatform Environment in Azure.

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 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, a default domain will be generated in the format: $deployment_id.mp.qrveyapp.com.

Installation

Create Service Principal

Run the following command in a terminal within your Azure account. Ensure the account has OWNER access permissions.

az ad sp create-for-rbac --role="Contributor" --scopes="/subscriptions/20000000-0000-0000-0000-000000000000"

The output will contain your Service Principal details, similar to the following:

{
  "appId": "00000000-0000-0000-0000-000000000000", # ARM_CLIENT_ID
  "displayName": "azure-cli-2017-60-05-10-42-15",
  "name": "http://azure-cli-2017-60-05-10-42-15",
  "password": "0000-0000-0000-0000-000000000000", # ARM_CLIENT_SECRET
  "tenant": "00000000-0000-0000-0000-000000000000" # ARM_TENANT_ID
}

Create Azure Resources

Using default configurations, create the following resources:

1. Create a Resource Group in Azure.
2. Within the Resource Group, create a Storage Account.
3. Inside the Storage Account, create a Container.

Ensure these resources are created in the same datacenter region as your Qrvey application.

This is what your Resource Group should look like before installing Qrvey.

Prepare Installation Files

To install Qrvey in your Azure account, create the following file:

{
  "account_config": {
    "resource_group_name": "resourceGroupName",
    "storage_account_name": "statestorageaccount",
    "container_name": "statecontainer",
    "key": "terraform.tfstate",
      "ARM_CLIENT_ID": "$sp.appId",        
      "ARM_CLIENT_SECRET": "$sp.password", 
      "ARM_TENANT_ID": "$sp.tenant",
      "ARM_SUBSCRIPTION_ID": "$subscription_id"
  },
  "variables": {
    "dns_zone_name": "", // (Optional)
    "registry_user": "registry username provided by qrvey",
    "registry_key": "registry password provided by qrvey",
    "qrvey_chart_version": "9.0.1",
    "location": "eastus2", // Azure location for resources 
    "enable_location_services": true,
    "enable_trino": true,
    "managed_nat_gateway": false,
    "es_config": {  // ElasticSearch Config
      "size": "large",
      "count": 1
    },
    "customer_info": {
      "firstname": "",
      "lastname": "",
      "email": "email@company.com",
      "company": "Company Name"
    },
    "initial_admin_email": "admin@company.tld",
    "globalization": {
      "google_client_email": "",
      "google_client_private_key": "",
      "google_document_id": "",
      "google_document_sheet_title": ""
    }
  }
}

Installation

Once these prerequisites are ready, install Qrvey.

1. Navigate to the directory containing the configuration files.
2. Log in to the Qrvey Registry:

docker login qrvey.azurecr.io --username $registry_user --password-stdin <<< $registry_key

3. Run the installation command with the desired Terraform option (plan, apply, output, or destroy). For installation, use apply. The installation process should take about 45 minutes to an hour.

docker run -v $(pwd)/config.json:/app/qrvey/config.json -it --rm qrvey.azurecr.io/qrvey-terraform:${qrvey_version} apply

After running the apply command, wait until the process finishes and review the resources created. You should see something similar to the following image:

At the end of the installation, you will find the following output:

    ##########                                           
    ###      ####                                         
  ###          ###    +++ +++      +++  +++++  +++      ++
  ##            ### ++++   +++    +++ +++   +++ ++     +++
  ##            ### ++      ++   +++ +++   ++++  ++   +++ 
  ##            ### ++       ++  ++  ++++++++    +++  ++  
  ###          ###  ++       ++++++  +++          ++++++  
    ####    #####   ++        ++++    +++   +++    ++++   
      ########      ++         ++      +++++++     +++    
      #####      #                                 ++    
          ########                              ++++    

============================================================
               Qrvey Environment Details
============================================================
Deployment ID:            deployment-id
Environment URL:          https://deployment-id.mp.qrveyapp.com
Admin Portal URL:         https://deployment-id.mp.qrveyapp.com/admin/app/
Admin User:               admin@company.tld
Admin Password:           generated_admin_password
Qrvey API Key:            qrvey_api_key
------------------------------------------------------------
PostgreSQL Connection:    postgres://qrvey_usr:db_password@deployment-id-qrvey-db.postgres.database.azure.com:5432/postgres
------------------------------------------------------------
Elasticsearch Host:       https://1.2.3.4:9200/
Elasticsearch User:       elastic
Elasticsearch Password:   elastic_password
------------------------------------------------------------
RabbitMQ Host:            http://Qrvey:rabbit_password@rabbit_host:15672/#/
============================================================

5. For the first login, use the admin username and password provided in the deployment output.

Note:
If you want to use a custom domain for your deployment, set the property "dns_zone_name" under the "variables" object in your config.json to the desired URL.
After deployment, you will receive a Load Balancer URL in the output. Set this Load Balancer URL as the target for the CNAME record of your custom domain in your DNS provider.

Upgrading to a Newer Version

To upgrade your Qrvey MultiPlatform Environment to a newer version, follow the same steps as in the Installation section above. The only change required is in Installation JSON file:

• Update the qrvey_chart_version variable in your config.json file to the desired new version.

After updating the version, repeat Steps 1–5 from the Installation section, using the updated qrvey_version value in the relevant commands.

This will apply the upgrade and update your environment to the specified version.

Troubleshooting

Helm Release Error: Another Operation in Progress

If the deployment fails with the following error:

Error: another operation (install/upgrade/rollback) is in progress

with helm_release.qrvey[0],
on k8s-cr.tf line 606, in resource "helm_release" "qrvey":
606: resource "helm_release" "qrvey" {

Then add the --refresh-helm flag after the apply command:

docker run -v $(pwd)/config.json:/app/qrvey/config.json -it --rm qrvey.azurecr.io/qrvey-terraform:${qrvey_version} apply --refresh-helm

Note: This flag should be used only in these cases, as it triggers an aggressive upgrade process in which Qrvey containers are forcefully recreated.