Data plane setup on Azure

Union.ai’s modular architecture allows for great flexibility and control. The customer can decide how many clusters to have, their shape, and who has access to what. All communication is encrypted. The Union architecture is described on the Architecture page.

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 a Kubernetes cluster, running one of the most recent three minor K8s versions. Learn more.
  • You have configured a storage bucket.
  • You have configured your AKS cluster as indicated in the Cluster Recommendations section.

Prerequisites

Deploy the Union.ai operator

  1. Add the Union.ai Helm repo:

    helm repo add unionai https://unionai.github.io/helm-charts/
    helm repo update
  2. Use the uctl selfserve provision-dataplane-resources command 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 specific to the provider that you specify, in this case azure:
      -------------- ------------------------------------ ---------------------------- ------------------------------------------------- ------------------------------------------------------------------ ----------
    | ORGANIZATION | HOST                               | CLUSTER                    | CLUSTERAUTHCLIENTID                             | CLUSTERAUTHCLIENTSECRET                                          | PROVIDER |
     -------------- ------------------------------------ ---------------------------- ------------------------------------------------- ------------------------------------------------------------------ ----------
    | xxxxxxxxxxx  | xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx | xxxxxxxxxxxxxxxxxxxxxxxxxx | xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx | xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx | xxxxx    |
     -------------- ------------------------------------ ---------------------------- ------------------------------------------------- ------------------------------------------------------------------ ----------
    1 rows
    
    ✅ Generated <ORGNAME>-values.yaml
    ======================================================================
    Installation Instructions
    ======================================================================
    
    Step 1: Setup the infrastucture on Azure. Our team can share terrform scripts to help with this.
    
    Step 2: Clone and navigate to helm-charts repository
      git clone https://github.com/unionai/helm-charts && cd helm-charts
    
    Step 3: Configure Azure Blob (stow) & Workload Identity client IDs in values
    
    
    Step 4: Install the data plane CRDs
      helm upgrade --install unionai-dataplane-crds charts/dataplane-crds
    
    Step 5: Install the data plane
      helm upgrade --install unionai-dataplane charts/dataplane \
        --namespace union \
        --values <ORGNAME>-values.yaml
    
    Step 6: Verify installation
      kubectl get pods -n union
    
    Step 7: Once you have your dataplane up and running, create API keys for your organization. If you have already just call the same command again to propogate the keys to new cluster:
      uctl create apikey --keyName EAGER_API_KEY --org <your-org-name>
    
    Step 8: You can now trigger v2 executions on this dataplane.
    • Save the secret that is displayed. Union does not store the credentials, rerunning the same command can be used to show same secret later which stream through the OAuth Apps provider.
    • Create the EAGER_API_KEY as instructed in Step 7 of the command output. This step is required for every dataplane you plan to use for V2 executions.
  3. Update the values file correctly: For example, <UNION_FLYTE_ROLE_ARN> is the ARN of the new IAM role created in the AWS Cluster Recommendations

  4. Optionally configure the resource limits and requests for the different services. By default, these will be set minimally, will vary depending on usage, and follow the Kubernetes ResourceRequirements specification.

    • clusterresourcesync.resources
    • flytepropeller.resources
    • flytepropellerwebhook.resources
    • operator.resources
    • proxy.resources
  5. 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
  6. You can then register and run some example workflows through your cluster to ensure that it is working correctly.

    uctl register examples --project=union-health-monitoring --domain=development
    uctl validate snacks --project=union-health-monitoring --domain=development
     ---------------------- ----------------------------------- ---------- -------------------------------- -------------- ----------- ---------------
    | NAME                 | LAUNCH PLAN NAME                  | VERSION  | STARTED AT                     | ELAPSED TIME | RESULT    | ERROR MESSAGE |
     ---------------------- ----------------------------------- ---------- -------------------------------- -------------- ----------- ---------------
    | alskkhcd6wx5m6cqjlwm | basics.hello_world.hello_world_wf | v0.3.341 | 2025-05-09T18:30:02.968183352Z | 4.452440953s | SUCCEEDED |               |
     ---------------------- ----------------------------------- ---------- -------------------------------- -------------- ----------- ---------------
    1 rows