Adding a New Workload Type

This guide walks through every file and function that must change when adding support for a new Kubernetes workload kind (e.g. Argo Rollout, Knative Service).

Checklist

1. API types -- add to the validation enum

File: api/v1alpha1/attunepolicy_types.go

Add the new kind to the kubebuilder:validation:Enum marker on TargetRef.Kind:

// +kubebuilder:validation:Enum=Deployment;StatefulSet;DaemonSet;CronJob;Job;ReplicaSet
Kind string `json:"kind"`

Run make manifests generate to regenerate CRDs and deepcopy.

2. Workload adapter -- implement the interface

File: internal/controller/workload_adapters.go

Add three things:

A) Adapter struct implementing the WorkloadAdapter interface:

type rolloutAdapter struct{ *argov1alpha1.Rollout }

func (a *rolloutAdapter) Object() client.Object            { return a.Rollout }
func (a *rolloutAdapter) PodSelectorLabels() map[string]string { return a.Spec.Selector.MatchLabels }
func (a *rolloutAdapter) PodSpec() *corev1.PodSpec          { return &a.Spec.Template.Spec }
func (a *rolloutAdapter) IsRollingOut() bool                { /* kind-specific logic */ }
func (a *rolloutAdapter) PodNameRegexSuffix() string        { return "-[a-z0-9]+-[a-z0-9]{5}" }
func (a *rolloutAdapter) IsBatch() bool                     { return false }

B) Registry entry in the workloadKinds map (for get/list by kind string):

"Rollout": {
    newObject: func() client.Object { return &argov1alpha1.Rollout{} },
    newList:   func() client.ObjectList { return &argov1alpha1.RolloutList{} },
    extract:   func(list client.ObjectList) []client.Object { /* extract items */ },
},

C) Type-switch case in newWorkloadAdapter():

case *argov1alpha1.Rollout:
    return &rolloutAdapter{Rollout: w}

3. RBAC markers

File: internal/controller/attunepolicy_controller.go

Add a kubebuilder:rbac marker for the new resource group. For example, Argo Rollouts need:

//+kubebuilder:rbac:groups=argoproj.io,resources=rollouts,verbs=get;list;watch

Then run make manifests to regenerate config/rbac/role.yaml.

4. Helm chart RBAC

File: charts/attune/templates/clusterrole.yaml

Add a new rule block:

- apiGroups:
    - argoproj.io
  resources:
    - rollouts
  verbs:
    - get
    - list
    - watch

5. Helm chart RBAC test

File: charts/attune/tests/rbac_test.yaml

Add a new test case:

- it: should include rollout read permissions
  asserts:
    - contains:
        path: rules
        content:
          apiGroups:
            - argoproj.io
          resources:
            - rollouts
          verbs:
            - get
            - list
            - watch

6. Regenerate manifests

make manifests generate

Verify the CRD schema includes the new kind in the enum, and the RBAC ClusterRole includes the new API group.

7. E2E test

Create a Chainsaw test under test/e2e/ or a Go E2E test under test/e2e/go/ that:

1. Creates a workload of the new kind
2. Creates an AttunePolicy targeting it
3. Verifies the operator discovers the workload
4. Verifies recommendations are computed (if Prometheus is available)

8. Documentation

Update these files to mention the new kind:

• docs/reference/api.md -- TargetRef.Kind enum
• docs/getting-started/quickstart.md -- if adding a common kind
• README.md -- supported workloads list
• AGENTS.md -- if the kind requires special handling

9. Verify

make verify-quick    # lint, test, CRD freshness, helm
make helm-unittest   # verify the new RBAC test passes

Reference: current supported kinds

Kind	API Group	Batch?	Adapter file
Deployment	apps	No	workload_adapters.go
StatefulSet	apps	No	workload_adapters.go
DaemonSet	apps	No	workload_adapters.go
CronJob	batch	Yes	workload_adapters.go
Job	batch	Yes	workload_adapters.go
ReplicaSet	apps	No	workload_adapters.go