Table of contents

• Deployment of the Applications
• Pre-Requisites
• 1. Login and Set Active Subscription
  • Steps:
• 2. Publish the Applications
  • 2.1. Publish ILAP Analytics API
  • 2.2. Publish ILAP Analytics BackgroundJobs
  • 2.3. Publish ILAP Analytics UI
• 3. Create Release for UI with Public Configuration
  • 3.1. Prepare Public Configuration
  • 3.2. Upload Public Configuration
  • 3.3. Create Release Pipeline
• 4. Retrieve the Deployable .Zip File

Deployment of the Applications

This guide outlines the steps to deploy the ILAP Analytics applications using Azure CLI and PowerShell. Follow the instructions below to publish the API, BackgroundJobs, and UI components.

Pre-Requisites

Ensure the following are installed and configured on your system:

• PowerShell (version 7 or higher): Download PowerShell

• Azure CLI Tools for PowerShell: Install Azure CLI

1. Login and Set Active Subscription

Steps:

1. Open PowerShell and log in to Azure:

   az login

   This will redirect you to a web browser for authentication.

2. Set your active Azure subscription:

   $SUBSCRIPTION = "your_subscription"
   az account set --subscription $SUBSCRIPTION

2. Publish the Applications

Before starting, we recommend using the az webapp deploy command with the zipdeploy option for deploying your applications. For more information on how this works, refer to the Microsoft Learn article.

2.1. Publish ILAP Analytics API

1. Download the latest version of Ilap.Analytics.Api as a .zip file.

2. Navigate to the folder where the artifact is downloaded:

   cd path\to\downloaded\artifact

3. Run the following command to deploy the API:

   $RESOURCE_GROUP = 'your_resource_group'
   $WEBAPP_NAME = 'app_name_for_api'
   az webapp deploy --type zip --resource-group $RESOURCE_GROUP --name $WEBAPP_NAME --src-path (Get-Item .\app-ilapanalytics-api-generic-prod.zip).FullName

2.2. Publish ILAP Analytics BackgroundJobs

1. Download the latest version of Ilap.Analytics.BackgroundJobs as a .zip file.

2. Navigate to the folder where the artifact is downloaded:
   

   cd path\to\downloaded\artifact

3. Run the following command to deploy BackgroundJobs:

   $RESOURCE_GROUP = 'your_resource_group'
   $WEBAPP_NAME = 'app_name_for_backgroundjobs'
   az webapp deploy --type zip --resource-group $RESOURCE_GROUP --name $WEBAPP_NAME --src-path (Get-Item .\app-ilapanalytics-backgroundjobs-generic-prod.zip).FullName

2.3. Publish ILAP Analytics UI

1. Download the latest version of Ilap.Analytics.UI as a .zip file.

2. Navigate to the folder where the artifact is downloaded:

   cd path\to\downloaded\artifact

3. Run the following command to deploy the UI:

   $RESOURCE_GROUP = 'your_resource_group'
   $WEBAPP_NAME = 'app_name_for_ui'
   az webapp deploy --type zip --resource-group $RESOURCE_GROUP --name $WEBAPP_NAME --src-path (Get-Item .\app-ilapanalytics-ui-generic-prod.zip).FullName

   
   

3. Create Release for UI with Public Configuration

3.1. Prepare Public Configuration

Create the PublicConfiguration.js file for the UI with the following structure:

// Do not modify any keys, modify only values.
const publicConfigurations = {
  analyticsApiUrl: "your-ilapanalytics-api-base-url/api",
  authenticationAuthority: "https://login.microsoftonline.com/your_tenant_id/",
  authenticationClientId: "application client id of UI app registration",
  authenticationScopes: "comma separated scopes from your API app registration",
  authenticationRedirectUri: "your-ilapanalytics-ui-base-url",
};

// Do not modify this line.
window["publicConfigurations"] = publicConfigurations;

3.2. Upload Public Configuration

1. Upload the PublicConfiguration.js file to the pipeline secure file in Azure DevOps. This will ensure secure access during deployment.

3.3. Create Release Pipeline

1. Set up a release pipeline in Azure DevOps for the UI.

2. Link it to the build pipeline (e.g., prod-generic-analytics-ui).

3. If the release does not run automatically upon creation, trigger it manually.

4. Retrieve the Deployable .Zip File

1. Once the release pipeline runs successfully, locate the generated .zip file in the ILAP Analytics container.

2. Use this .zip file for subsequent deployments or updates.

This streamlined guide ensures each step is clear and actionable, minimizing confusion while providing necessary details for successful deployment. Let me know if further refinements are needed!