architecture

A set of rules explaining Forklift’s backend structure. Forklift is a Go application that manages virtual-machine migrations in OpenShift, a Kubernetes-based platform, using separate controller and API programs.

In plain words
What is it for?
Use it when changing controllers, API services, admission webhooks, deployments, or shared backend code.
Why use it?
It gives developers a map of the system’s entry points, deployment roles, shared packages, and request-handling boundaries.

Cursor rule for Cursor

Install

Getting it into your agent

One page per mod, every tool's command on it. A separate URL per tool would split the same page into five that compete with each other.

agentmods
npx agentmods add rules/kubev2v/forklift-console-plugin/architecture
Clone the repo
git clone --depth 1 https://github.com/kubev2v/forklift-console-plugin

Made for: Cursor.

Per session 14 Only the description is in the session, so the agent can decide to use it. The body loads when it is invoked.
When invoked 3,485 The whole file, excluding the scripts and references it only reads on demand.
Security scan A 0 findings. Scan, not verified.
Origin original No closer match found in the catalogue.
Token cost

What it costs to keep this loaded

Counted locally with the o200k_base tokenizer, which is exact for GPT models; Claude uses its own tokenizer and its counts differ. Treat this as one consistent yardstick across the catalogue rather than a bill. Prices are per million input tokens.

ModelPer sessionOnce invoked
Fable 5 $0.00014 $0.03485
Opus 5 $0.00007 $0.01742
Sonnet 5 $0.00003 $0.00697
Haiku 4.5 $0.00001 $0.00348

Measured 2d ago against content hash 26c5448f6647, method: parsed. Prices are Anthropic first-party input rates as of 2026-08-30, from the pricing page.

Security

Grade A, and why

architecture scanned grade A with 0 findings against 26 rules in 11 categories — prompt injection, anti-refusal, data exfiltration, privilege escalation, supply chain, agent snooping, system-prompt leakage, SSRF and excessive agency — measured 2d ago.

A static scan of the body, not an audit. Every finding is printed with the line that produced it so you can judge whether it matters here. A mod is markdown that instructs an agent; that is exactly why what it instructs is worth reading.

Nothing flagged

None of the 26 patterns this scan looks for appear in this file: no shell pipes, no recursive deletes, no credential paths, no hidden text, no instruction-override or anti-refusal phrasing, no agent-config snooping. That is not a guarantee, it is the absence of the things that are checkable.

.cursor/rules/backend/architecture.mdc · 286 lines

How it starts

The opening of the file, as written. The whole thing — 286 lines — stays where its author put it; the contents beside it link to each section on GitHub.

Backend Architecture

Analyzed from commit: a976d24b6 on 2026-05-04 Source paths: cmd/forklift-controller/, cmd/forklift-api/, pkg/controller/controller.go, pkg/controller/base/, pkg/settings/

Package Purpose

The Forklift backend is a Go application built on controller-runtime (the sigs.k8s.io operator framework). It consists of two binaries that run as separate Deployments inside OpenShift:

Binary Entry Point What It Does
forklift-controller cmd/forklift-controller/main.go Runs all CRD reconciliation controllers (split by role). Registers K8s API schemes, sets up the controller-runtime Manager, and starts a Prometheus metrics endpoint on :2112.
forklift-api cmd/forklift-api/forklift-api.go Runs admission webhooks (:8443) and a REST service API (:8444). Operates independently of controller-runtime Manager — uses plain net/http servers with TLS.

Both binaries share the pkg/ library packages but have completely separate lifecycles.

Key Types and Structs

settings.ControllerSettings (pkg/settings/settings.go)

Global singleton at settings.Settings. Loaded from environment variables in init() before main() runs. Composes:

Field Type Purpose
Role settings.Role Which controller sets to start (main, inventory, or both)
Metrics settings.Metrics HTTPS metrics endpoint port (default 8080, env METRICS_PORT). Separate from the plain HTTP :2112 endpoint in main()
Inventory settings.Inventory Inventory API host/port/TLS/CORS/auth/namespace
Migration settings.Migration VM concurrency, retry limits, virt-v2v images, container resource defaults
PolicyAgent settings.PolicyAgent Validation policy agent URL and TLS
Logging settings.Logging Log level and development mode
Profiler settings.Profiler CPU/memory profiling output
Features settings.Features Feature gates (warm migration, copy offload, live migration, etc.)
Providers settings.Providers OVA/HyperV server images and resource limits
OpenShift bool Whether running on OpenShift (adds Route API scheme)
Development bool Development mode flag

Read the full file on GitHub · 286 lines

Changes

What this file has done since we first saw it

Hashed on every crawl. A supply-chain change to an agent config is a question of when, not whether, so the history is kept rather than the latest state alone.

  1. 2d ago First seen · 286 lines · 14 tokens per session scan A 26c5448f6647

Subscribe to this mod's changes

architecture is a cursor rule published in the GitHub repository kubev2v/forklift-console-plugin (11 stars, last pushed 3d ago), licensed Apache-2.0. It adds 14 tokens to every session and 3,485 once invoked, about $0.0001 per session on Opus 5. A static security scan graded it A with 0 findings. No closer match exists in the catalogue, so it is treated as the original; first seen 2026-08-30.