Install OctaiPipe in Azure Portal#

The following steps help you install OctaiPipe into your Azure Directory using the Azure Portal.

1. Create a Service Principal#

Navigate to App Registrations in the Azure portal. Click on New registration. Name the Service Principal (e.g., OctaiPipe-Admin). For Supported account types, if unsure we recommend selecting Single Tenant. You can skip setting a Redirect URI.

Click Register and note down the Service Principal application ID and object ID.

App Registration Setup

2. Generate Client Secret#

Go to the newly created Service Principal. Select Certificates & secrets. Create a new client secret. Note down the client secret value for later.

Create App Secret

3. Assign Cloud Application Administrator Role#

this requires privileged access; i.e. contact Administrator to do this

Visit Microsoft Entra Id > Roles and Administrators. Select the Cloud Application Administrator role. Click on Add assignment to add the Service Principal.

Cloud Admin Role

4. Create a User Group#

Navigate back to Microsoft Entra Id > Groups. Create a new group with assigned membership type and Group Type as Security. Set the Service Principal as the owner. Add the desired members to the group and note down the Group Id.

OctaiPipe User Group

5. Create a Resource Group#

Create a new resource group in Azure Portal and note down the resource group name. This is the resource group into which the application will be installed.

Resource Group Setup

6. Install Using ARM Templates#

Retrieve the ARM tempaltes necessary to install by contacting your OctaiPipe Technical Success Manager.

Update the following values in the parameters.json file.

  • customerName: The name of your organisation/installation in lowercase. This will determine the deployment URL of the OctaiPipe Portal, as https://app.customerName.octaipipe.ai

  • servicePrincipalAppId: The App ID of the Service Principal you created. This will be used during setup to create the necessary resources.

  • servicePrincipalObjectList: Array with Service Principal object ID such as: ["service-principal-object-id"]

  • clientSecret: The client secret generated earlier. This is required to authenticate the Service Principal.

  • groupId: The Id of the user group created earlier. This will be used to manage access to the application.

  • octaipipeVersion: The version of OctaiPipe to install. Latest stable version is 3.0.2.

Log into Azure as a user with the owner role using az login. Set the subscription you wish to install into with az account set --subscription <MY-SUBSCRIPTION-ID>

Apply the ARM templates to the resource group you created before:

az deployment group create --resource-group <MY-RESOURCE-GROUP> --template-file OctaiPipeTemplate/mainTemplate.json --parameters OctaiPipeTemplate/parameters.json