Skip to content

Work API Overview

A common Work API to distribute workloads across multiple clusters.



  • Work Hub is a Kubernetes cluster where the Work API resource resides.
  • Managed Cluster or Spoke Cluster is a Kubernetes cluster managed by the Work Hub. The workload resources defined in the Work API are applied on the managed cluster.
  • Work Controller is a controller that reconciles the Work API resource on Work Hub, and applies resources defined in the Work to the Managed Cluster.


A Work is a custom resource that represents a list of API resources to be deployed on a cluster. The Work is created on the Work Hub, and resides in the namespace that the Work Controller is authorized to access. Creation of a Work on the Work Hub indicates that resources defined in the Work will be applied on a certain Managed Cluster. Update of a Work will trigger the resource update on the Managed Cluster, and deletion of a Work will garbage collect the resources on the Managed Cluster.


kind: Work
 name: work-sample
 namespace: cluster1
   - apiVersion: v1
     kind: ConfigMap
       name: cm
       namespace: default
     data: |

User creates a Work in the cluster1 namespace on the Work Hub that the Work Controller is authorized to access. The Work Controller then accesses the Managed Cluster and applies the resources defined in the Work in its reconcile loop. The Work controller also tracks the status of applied resources by updating the Work status.


This Work API project solely focuses on the API and the common behaviour, leaving room for various implementations. There is a reference implementation available in the GitHub repo.

For more advanced Work API implementations: