hook-controller

Hook Controller

Analyzed from commit: baf9c7bcc307ed9358ad59886a5536366a050012 on 2026-09-17 Source paths: pkg/controller/hook/, pkg/controller/plan/hook.go, pkg/apis/forklift/v1beta1/hook_exec.go

Package Purpose

The Hook lifecycle spans two controllers:

1. Hook controller (pkg/controller/hook/) — validates the Hook CRD and sets Ready.
2. Plan controller (pkg/controller/plan/hook.go) — executes hooks via HookRunner during migration phases PreHook and PostHook.

Hooks support two execution modes: local (Kubernetes Job with optional Ansible playbook) and AAP (remote Ansible Automation Platform job template).

---

Key Types and Structs

HookSpec (pkg/apis/forklift/v1beta1/hook.go)

type HookSpec struct {
    ServiceAccount string       // optional; local hooks only
    Image          string       // required for local hooks
    Playbook       string       // optional base64-encoded Ansible playbook
    Deadline       int64        // pod/job deadline in seconds
    AAP            *AAPConfig   // remote AAP execution (mutually exclusive with image/playbook)
}

type AAPConfig struct {
    JobTemplateID int                    // required > 0
    URL           string                 // optional per-hook AAP URL
    TokenSecret   *core.ObjectReference  // optional per-hook token Secret (key "token")
    Timeout       int64                  // optional poll timeout in seconds
}

HookRunner (pkg/controller/plan/hook.go)

type HookRunner struct {
    *plancontext.Context
    vm   *planapi.VMStatus
    hook *api.Hook
}

Validation helpers (pkg/apis/forklift/v1beta1/hook_exec.go)

• HookExecutionConfigValid(hook) — local hook needs non-empty image (playbook optional); AAP hook needs jobTemplateId > 0 and no local fields.
• HookAAPRunnable(hook, clusterURL, clusterTokenSecret) — AAP hook runnable when per-hook or cluster AAP connection is configured.

---

Interfaces and Implementations