api-types

API Types (CRD Definitions)

Analyzed from commit: a976d24b6 on 2026-05-04 Source paths: pkg/apis/forklift/v1beta1/, pkg/lib/condition/

Package Purpose

Package v1beta1 (forklift.konveyor.io/v1beta1) defines all Forklift CRDs. The SchemeGroupVersion is forklift.konveyor.io/v1beta1. All CRD types embed meta.TypeMeta + meta.ObjectMeta and follow the standard Spec/Status pattern. Every Status struct embeds libcnd.Conditions for the shared condition framework.

---

Key Types and Structs

Provider (provider.go)

Represents a source or target infrastructure connection.

ProviderSpec {
  Type           *ProviderType            // required, see ProviderType enum below
  URL            string                   // empty for "host" (local) OpenShift provider
  Secret         core.ObjectReference     // credentials secret
  Settings       map[string]string        // VDDK, SDK endpoint, vCenter, ESXi, target-az, etc.
}
ProviderStatus {
  Phase                 string             // free-form string (Ready, Staging, ValidationFailed, ConnectionFailed)
  Conditions            libcnd.Conditions  // embedded
  ObservedGeneration    int64
  Fingerprint           string
  Service               *core.ObjectReference
  SecretResourceVersion string
}

ProviderType enum: openshift, vsphere, ovirt, openstack, ova, ec2, hyperv, "" (Undefined)

Key methods on Provider:

• Type() ProviderType — returns the provider type (or Undefined)
• IsHost() bool — OpenShift provider with empty URL (local cluster)
• IsRestrictedHost() bool — host provider outside the main Forklift namespace
• RequiresConversion() bool — true for vsphere, ova, hyperv, ec2
• SupportsPreserveStaticIps() bool — true for vsphere, hyperv
• HasReconciled() bool — generation == observedGeneration
• UseVddkAioOptimization() bool — reads settings["useVddkAioOptimization"]

Provider settings constants: VDDK, SDK (sdkEndpoint), VCenter, ESXI, UseVddkAioOptimization, VddkConfig, ESXiCloneMethod ("vib"|"ssh"), TargetAZ (target-az), TargetRegion (target-region)