Setting Up the QPP NextGen Platform Server on Azure with Docker Compose
This section provides a step-by-step walkthrough for deploying Quark Publishing Platform NextGen on Azure using Docker Compose.
Before you begin, ensure you have the following:
-
Bash shell environment: A Linux virtual machine (VM) is required.
-
Docker
-
Definition: Docker is a platform for running applications in isolated containers.
-
Installation: Follow the official Docker installation guide for your Linux distribution (Ubuntu | Docker Docs).
-
-
Azure CLI
-
Definition: The Azure Command-Line Interface (CLI) is a tool to manage Azure resources.
-
Installation: Follow the official Azure CLI installation guide (Install the Azure CLI on Linux | Microsoft Learn).
-
Deployment Steps
-
Get Docker Compose Build
-
Please reach out to the Quark Support team to get the latest Docker Compose build and save it to your Linux VM.
-
-
Set Permissions
-
Make the start_sso.sh and stop_sso.sh scripts executable:
-
chmod +x start_sso.sh
-
chmod +x stop_sso.sh
-
-
-
Azure Login
-
Log in to your Azure subscription using the Azure CLI:
-
az login
-
-
-
Get Azure Credentials
-
To access Azure resources, you need the following Azure credentials:
-
AZURE_TENANT_ID
-
AZURE_CLIENT_ID
-
AZURE_CLIENT_SECRET
-
-
Create a Service Principal to obtain these credentials:
az ad sp create-for-rbac --name "${NAME_OF_SP}"
Replace ${NAME_OF_SP} with a descriptive name for your Service Principal.-
Assign the following roles to the Service Principal:
-
Azure Storage Blob Data Owner
-
Azure Service Bus Data Owner
-
-
How to Assign Roles:
-
Navigate to the specific resource (Storage Account, Container, Service Bus) in the Azure portal.
-
Select "Access control (IAM)".
-
Click "Add role assignment".
-
Choose the appropriate role (e.g., "Azure Storage Blob Data Owner").
-
Search for and select your Service Principal.
-
Click "Review + assign".
-
-
Ensure the Service Principal has these roles on the necessary resources (Storage Account, Container, Service Bus, etc.). If you lack the necessary permissions, contact your team's Azure Administrator.
-
-
Execute Script
-
Run the start_sso.sh script:
./start_sso.sh
-
-
Cloud Provider Selection
-
When prompted, choose AZURE as the cloud provider.
-
-
Azure Credentials Refresh
-
When asked if you need to refresh Azure Credentials, answer Yes to the initial setup.
-
-
Enter Azure Credentials
-
Provide the values from the Service Principal you created:
-
AZURE_TENANT_ID: The 'tenant' value from the Service Principal.
-
AZURE_CLIENT_ID: The 'appId' value from the Service Principal.
-
AZURE_CLIENT_SECRET: The 'password' from the Service Principal.
-
-
-
Azure Service Bus Namespace
-
Enter the namespace URL of your Azure Service Bus when prompted for AZURE_SERVICE_BUS. For detailed information about how to create Azure Service Bus, please refer to this documentation: Use the Azure portal to create a Service Bus topic and subscriptions to the topic.
-
-
Azure Storage Account
-
For detailed information about how to create Azure Storage Account, please refer to this documentation: Create an Azure storage account.
The script will automatically create a Storage Container (named after your Quark username) to store assets and configurations, including a folder with your tenant ID. -
-
Database and Elastic Files Location
-
You can optionally override the default locations for database and elastic files, or skip this step to use the defaults.
-
-
License Code
-
Enter a valid license code when prompted. To obtain a license code for your development setup, please submit a support ticket to the Engineering Team through the designated support channel.
-
-
QXPS and InDesign URL
-
Provide the URLs for QXPS and InDesign, which will be used for publishing.
-
-
Keycloak Realm Name
-
Set the Realm Name for Keycloak. It's recommended to use the same value as your tenant ID to avoid authentication issues.
-
-
Release Selection
-
Choose the desired release to deploy (dev or stable).
-
-
Image Handling
-
The script will create default folders for all services in the Azure Storage Container.
-
-
Image Pulling
-
Choose whether to pull the latest Docker images or use existing ones.
-
-
Keycloak Redeployment
-
Only redeploy Keycloak if you have made changes to its configuration.
-
Post-Deployment
-
The script will pull the necessary images and create the containers.
-
Check the status and logs of all containers to ensure they are running correctly.
-
Access the server through a web browser to begin using it.
-
Refer to the troubleshooting documentation or contact the Engineering Team for assistance with any issues.
