Skip to content

Transformation Function SDK

Southbound execution inside the Service Resource Manager.

TF-SDK is a Python library loaded by the Service Resource Manager (SRM). SRM selects the target and control path; the corresponding adapter translates that resolved request into backend operations and returns a normalized result or typed error. SRM owns placement, lifecycle decisions and the authoritative inventory. A separate discovery interface reads the operator's declared topology. The unified bootstrap supplies both discovery and the runtime adapter registry, with one adapter instance per control path and explicitly configured backend connections.

TF-SDK architecture: SRM, execution and discovery interfaces, capability surface and backends

The backend names in the diagram illustrate the architecture; check the Release 2 support matrix for executable adapters and tested backend combinations.

What it does

  • Deploy, update, inspect and remove Kubernetes workloads, for container images and Helm charts.
  • Execute network capability operations through the selected adapter.
  • Discover declared zones, domains, capabilities and control-path bindings from the bootstrap file, without probing backends.
  • Derive each binding's supported actions and runtime kinds from the adapter's capability surface.
  • Return backend resource identifiers, state, workload endpoints and typed failures for SRM to record and handle.

Read in the specs

Question Specification section
What does TF-SDK own, and what stays in SRM? Overview & Architecture › Scope and ownership, Overview & Architecture › Boundaries
How are adapters selected and constructed? Implementation & Delivery › The factory
What requests, results and errors cross the execution boundary? Requirements & Design › Execution shapes, Requirements & Design › Interface Design
How does discovery expose topology and executable capabilities? Requirements & Design › Discovery Design, ADR-0059
How do I add and test an adapter? Implementation & Delivery › Writing an execution adapter, Implementation & Delivery › Testing Strategy

Code and deployment

Topic Where to go
Package and source TF-SDK 2.0.0, imported as openop_tfsdk
Runtime Installed as an SRM dependency; the platform deploys no standalone TF-SDK service or Pod
Bootstrap Configure srm.topology in the platform chart. See Define zones and the SDK's one-file bootstrap
Connections and credentials Kubernetes control-path connections and the SRM chart. Deployment tooling mounts credentials; the SDK consumes the configured files
Adapter and field coverage Release 2 support matrix, including unsupported paths and verification limits
Development and checks SDK contribution guide, contract tests, and platform E2E guide