Deploy the dataplane
If you have not yet set up the required Azure resources (AKS cluster, Storage Account, Managed Identities, Workload Identity), see Prepare infrastructure first.
Assumptions
- You have a Union.ai organization, and you know the control plane URL for your organization.
- You have a cluster name provided by or coordinated with Union.
- You have an AKS cluster with OIDC issuer and Workload Identity enabled, running one of the most recent three minor K8s versions. Learn more.
- You have configured a Storage Account, Managed Identities, and Workload Identity as described in Prepare infrastructure.
Prerequisites
Deploy the Union.ai operator
-
Add the Union.ai Helm repo:
helm repo add unionai https://unionai.github.io/helm-charts/ helm repo update -
Use the
uctl selfserve provision-dataplane-resourcescommand to generate a new client and client secret for communicating with your Union control plane, provision authorization permissions for the app to operate on the Union cluster name you have selected, generate values file to install dataplane in your Kubernetes cluster and provide follow-up instructions:uctl config init --host=<YOUR_UNION_CONTROL_PLANE_URL> uctl selfserve provision-dataplane-resources --clusterName <YOUR_SELECTED_CLUSTERNAME> --provider azure-
The command will output the ID, name, and a secret that will be used by the Union services to communicate with your control plane. It will also generate a YAML file
<org>-values.yamlspecific to the provider that you specify, in this caseazure. -
Save the secret that is displayed. Union does not store the credentials; rerunning the same command can be used to retrieve the secret later.
-
-
Update the generated values file with your infrastructure details:
Using the environment variables from the prepare infrastructure step:
- Set
global.BACKEND_IAM_ROLE_ARNto${BACKEND_CLIENT_ID}(the backend managed identity client ID). - Set
global.WORKER_IAM_ROLE_ARNto${WORKER_CLIENT_ID}(the worker managed identity client ID). - Set
global.METADATA_BUCKETto${METADATA_CONTAINER}. - Set
storage.custom.stow.config.accountto${STORAGE_ACCOUNT}. - Set
storage.regionto${LOCATION}. - Set
commonServiceAccount.annotations."azure.workload.identity/client-id"to${BACKEND_CLIENT_ID}.
If using Azure Key Vault (optional):
- Set
AZURE_KEY_VAULT_URItohttps://${KEY_VAULT_NAME}.vault.azure.net/.
- Set
-
Install the data plane Helm chart:
helm upgrade --install union unionai/dataplane \ -f <GENERATED_VALUES_FILE> \ --namespace union \ --create-namespace \ --force-conflicts -
Create an API key for your organization. This is required for v2 workflow executions on the data plane. If you have already created one, rerun the same command to propagate the key to the new cluster:
uctl create apikey --keyName EAGER_API_KEY --org <YOUR_ORG_NAME> -
Once deployed you can check to see if the cluster has been successfully registered to the control plane:
uctl get cluster ----------- ------- --------------- ----------- | NAME | ORG | STATE | HEALTH | ----------- ------- --------------- ----------- | <cluster> | <org> | STATE_ENABLED | HEALTHY | ----------- ------- --------------- ----------- 1 rows -
Follow the Quickstart to run your first workflow and verify your cluster is working correctly.