Skip to main content

Flytekit SDK Internal Architecture

The diagram illustrates the internal component architecture of the Flytekit SDK Ecosystem Context (flyte), highlighting how user code and CLI commands flow through core authoring abstractions, the Type Engine, runtime execution controllers, image building utilities, plugins, and the remote client.

Key Components:​

  • CLI (flyte.cli): Entry point for command-line operations (run, build, deploy, serve, get, devbox), orchestrating task resolution, image builds, and remote dispatch.
  • Core SDK (flyte): The authoring and definition layer providing decorators and configuration entities (@task, @run, @serve, Environment, Resources, Secret, Checkpoint, Trigger).
  • Runtime & Execution (flyte._internal.runtime & flyte._internal.controllers): Handles local workflow and task execution, context management (ctx), serialization/deserialization of task metadata, and dispatch to local or remote backends.
  • Type Engine (flyte.types._type_engine): Translates Python native types, Pydantic models, dataclasses, and Flyte IO types into Flyte IDL literals and type signatures with serialization codecs (JSON, Msgpack).
  • Storage & IO Layer (flyte.storage & flyte.io): Manages lazy uploads, artifact downloads, checkpoints, and offloaded literal representations with underlying cloud/local storage backends.
  • Image Builder (flyte._internal.imagebuild): Resolves dependencies, generates Dockerfiles, bundles user code via _code_bundle, and interfaces with local Docker or remote image building services.
  • Plugin System (flyteplugins): Extensible integrations for distributed computing (Spark, Ray, Dask, PyTorch), data processing & validation (Polars, Pandera), ML lifecycle (MLflow, WandB), and LLM/agent frameworks (Anthropic, Gemini, OpenAI, Codegen).
  • Remote Client (flyte.remote): gRPC/ConnectRPC client communicating with the Flyte Control Plane for deployment, run orchestration, secret sync, and execution tracking with authentication (PKCE/API key).

Key Architectural Findings:

  • The SDK is organized cleanly into an authoring layer (flyte), execution runtime (flyte._internal.runtime / controllers), remote backend communication (flyte.remote), type translation (flyte.types._type_engine), image construction (flyte._internal.imagebuild), and a rich CLI (flyte.cli).
  • flyteplugins integrates seamlessly by registering custom TypeTransformer instances with TypeEngine (e.g., Pandera, Polars, OmegaConf) and extending task execution decorators (e.g., PyTorch, Ray, Spark, Papermill).
  • The Type Engine uses Mashumaro and Pydantic under the hood for dataclass and model serialization, converting complex nested structures and lazy Flyte IO types (File, Dir, DataFrame) into Flyte IDL literals.
  • Remote execution interacts via flyte.remote._client using ConnectRPC protocols with PKCE, API keys, and cluster-aware dataproxy for efficient data transfers.
  • Image building (flyte._internal.imagebuild) is decoupled from core task authoring, supporting local Docker builders and remote builders alongside code bundling mechanisms (_code_bundle).
Loading diagram...