Steps

• xlrelease.Task: – Getting started: This workflow will help you set up a Release runner by way of the Digital.ai Platform Cloud Connector.

  Use this option if you don’t have access to an existing Kubernetes cluster.

  The Cloud Connector provides an embedded Kubernetes runtime environment that will host the Release runner and the container-based tasks coming from Release.

  ### Prerequisites

  For a successful runner installation with Digital.ai Platform you will need

  – Admin permissions in Digital.ai Release for this user running the workflow
  – Network access to Digital.ai Platform service on the internet
  – Username and password of the admin user of your customer account on Digital.ai Platform
  – A target machine for the installation running Linux or macOS
  – A Docker runtime on the target machine

• xlrelease.ScriptTask: – Check Digital.ai Platform connection: Checking if an existing connection to Digital.ai Platform exists.

• xlrelease.UserInputTask: – Provide Digital.ai Platform connection details: Please enter the credentials of the admin user for your customer account on Digital.ai Platform.

  If you don’t have this information, please contact your Digital.ai representative.

• daiplatform.CreateConnection: – Create Digital.ai Platform connection: Creating connecting to Digital.ai Platform

  ?? If this step fails because of incorrect credentials, please go to the previous step called **Provide Digital.ai Platform connection details** to change them and restart the workflow from there.

• xlrelease.ScriptTask: – Register Digital.ai Platform connection: Registering Digital.ai Platform connection for use in subsequent tasks.

• xlrelease.UserInputTask: – Select Digital.ai Platform connection: Please select the Digital.ai Platform connection that will be used for installing the Cloud Connector.

• xlrelease.ScriptTask: – Set Digital.ai Release placeholders: Setting `$releaseUrl` and `$releaseName` variables placeholder for further input.

• xlrelease.UserInputTask: – Set Digital.ai Release identifier: Please enter a unique identifier for this Digital.ai Release server.

  Choose a name without whitespaces, using only letters, numbers, dots or hyphens.

• daiplatform.GetCloudConnectors: – Check Cloud Connector registration: Retrieving registered Cloud Connectors from Digital.ai Platform

• xlrelease.ScriptTask: – Check Cloud Connector registration: Checking if there is already an existing Cloud Connector definition for `${releaseName}`

• daiplatform.CreateCloudConnector: – Create new Cloud Connector Definition: Creating a new Cloud Connector definition on the Digital.ai Platform.

• xlrelease.ScriptTask: – Set Cloud Connector ID:

• daiplatform.GetAgentRuntimes: – Get available Release runner versions (1/2): Fetching available agent runtimes from Digital.ai Platform

• xlrelease.ScriptTask: – Get available Release runner versions (2/2): Preparing form

• xlrelease.UserInputTask: – Select Release runner version: Please confirm the version of the Release runner that will be installed

• xlrelease.ScriptTask: – Set Release runner ID: Setting agent runtime ID for creating a new Release runner on Digital.ai Platform.

• daiplatform.GetToken: – Get installation token: Fetching access token from the Digital.ai Platform server. The token is required for installing the Cloud Connector in the nest step.

  Restart from here if the token expired and caused the installation to fail

• xlrelease.Task: – Install the Cloud Connector: Digital.ai Platform has provided a customized installer with a unique token.

  ## Download and start Cloud Connector installer script
  Copy the following command and paste it into your target machine’s terminal.

  “`
  curl -X GET ‘https://api.staging.digital.ai/workload/v1/cloud_connectors/${cloudConnectorId}/installer/?target_os=linux’ -H ‘accept: application/x-sh’ -H ‘authorization: Bearer ${platformAccessToken}’ –output dcc-installer.sh && bash dcc-installer.sh && bash cloud-connector-setup.sh
  “`

  If the token has expired, restart from the previous step **Get installation token**

• xlrelease.UserInputTask: – Prepare Digital.ai Release URL: Enter URL of your Digital.ai Release instance that is **accessible from the Kubernetes cluster**.

• xlrelease.UserInputTask: – Set Release runner name: Please enter the identifying name of the Release runner

  This is the name of all Digital.ai Release runner related services in Kubernetes cluster.

  Choose a name without whitespaces, using only letters, numbers, or hyphens.
  The name must start and end with an alphanumeric character to ensure compatibility across Kubernetes cluster.

• xlrelease.ScriptTask: – Create runner token: Creates Runner token for authentication on Digital.ai Release

• daiplatform.CreateAgentInstance: – Create runner Instance: Creating a new agent instance in Digital.ai Platform for selected Release runner version

• xlrelease.ScriptTask: – Check if Release runner is installed: Checking if runner installation was successful.

  This may take a couple of minutes.

• xlrelease.UserInputTask: – Troubleshooting: Runner is not registered on Digital.ai Release.
  Check logs of the Runner service in the Kubernetes cluster.
  Below are some common issues. If some of them is matching your problem, consider selecting the corresponding troubleshoot action.

  ### Runner logs constantly show 401 Unauthorized
  – Check that Digital.ai Release runner user has permissions for Runner registration. If the runner is registered after setting permission, select **No action needed** and proceed.
  – Runner registration token might be wrong or expired. In that case, select **Change Runner token**

  ### Runner logs show dial tcp: lookup ${releaseUrl}: no such host
  – Check that provided Digital.ai Release server URL is accessible from the Kubernetes cluster.
  – If wrong URL is provided, or port is missing, select **Change Release URL**

• xlrelease.UserInputTask: – Prepare Digital.ai Release URL: Enter URL of your Digital.ai Release instance that is **accessible from the Kubernetes cluster**.

• daiplatform.PatchAgentInstance: – Change Release URL: Updating Agent Instance RELEASE_URL variable.

• daiplatform.PatchAgentInstance: – Update Agent Instance: Updating Agent Instance values

• xlrelease.ScriptTask: – Check if runner is installed after troubleshoot: Checking if Runner installation is successful after troubleshoot.
  This may take up to 1 minute.
  If the task fails, return to Troubleshooting.