Union plugin

Directory

Classes

Class	Description
`flyteplugins.union.factory.Factory`	A set of builds.
`flyteplugins.union.factory.TimeRange`	A trailing window, relative to the consumer’s own time value, ending at that value.
`flyteplugins.union.io.ActionRef`	Provenance: the action (one task execution within a run) that produced a particular `Volume` version, plus the output slot it was returned as.
`flyteplugins.union.io.BlockVolume`	A writable Volume whose content is one ext4 filesystem image.
`flyteplugins.union.io.ROBlockVolume`	An immutable version of a `BlockVolume` – what its `commit` and `finalize` return, and what a downstream task receives.
`flyteplugins.union.io.ROVolume`	Immutable, versioned volume — PRD §Core Concepts.
`flyteplugins.union.io.RWVolume`	Mutable working copy — PRD §Core Concepts.
`flyteplugins.union.io.Volume`	A persistent volume identified by its metadata index.
`flyteplugins.union.remote.ApiKey`	Represents a Union API Key (OAuth Application).
`flyteplugins.union.remote.Assignment`	Represents role/policy assignments for an identity.
`flyteplugins.union.remote.Cluster`	Represents a Union cluster.
`flyteplugins.union.remote.ClusterConfig`	The tracked ConfigMaps of a single cluster.
`flyteplugins.union.remote.ClusterPool`	Represents a Union cluster pool — the configuration shared by its member clusters.
`flyteplugins.union.remote.Environment`	One environment version with its full spec, scaling and per-cluster status snapshots.
`flyteplugins.union.remote.EnvironmentVersion`	One environment version as returned by the list call: its summary and per-cluster summaries.
`flyteplugins.union.remote.Member`	Represents a Union organization member (user or application).
`flyteplugins.union.remote.MetricResult`	The result of querying one metric.
`flyteplugins.union.remote.MetricSeries`	One time series of a metric result, e.g. one container or one GPU device.
`flyteplugins.union.remote.Metrics`	Pod metrics of a task’s action attempt or of an app, as shown in the Union UI.
`flyteplugins.union.remote.NodeGroup`	One declared node group of a cluster: a pool of nodes and the shape each node has.
`flyteplugins.union.remote.NodeGroups`	A cluster’s declared node groups, as stored, with the generation they were read at.
`flyteplugins.union.remote.Policy`	Represents a Union RBAC Policy.
`flyteplugins.union.remote.Queue`	Represents a Union scheduling queue.
`flyteplugins.union.remote.Role`	Represents a Union RBAC Role.
`flyteplugins.union.remote.SSHDebug`	Resolved SSH-into-task connect info for a running debug action.
`flyteplugins.union.remote.SystemLogs`	Logs of the Union system components running on a cluster’s dataplane.
`flyteplugins.union.remote.User`	Represents a Union user.
`flyteplugins.union.remote.VolumeExplore`	A resolved `Volume` plus the IO to inspect and walk its lineage.
`flyteplugins.union.remote.VolumeResolveError`	No (or ambiguous) Volume-typed value could be resolved on an action.

Functions

Function	Description
`flyteplugins.union.debug()`	Launch a task, or relaunch an existing run, with ssh-into-task debug enabled.
`flyteplugins.union.fork()`	Fork run run_name, replaying it with new code and/or inputs.
`flyteplugins.union.with_debugcontext()`	Like `flyte.with_runcontext`, but preconfigured for ssh-into-task debug.
`flyteplugins.union.with_forkcontext()`	Like `flyte.with_runcontext`, but the returned runner can also `fork(run_name, ...)`.
`flyteplugins.union.factory.build()`	Name the artifact (or artifacts) one task call makes.
`flyteplugins.union.factory.materialize()`	Start a run of `<factory>.materialize` and return the `flyte.remote.Run`.
`flyteplugins.union.factory.on()`	Materialize when a source gets a new version, or on a schedule.
`flyteplugins.union.factory.partition()`	Pass the instance’s value of `dim` to a task parameter.
`flyteplugins.union.factory.serve()`	Name the app a factory ends in.
`flyteplugins.union.factory.source()`	An artifact made outside this factory.
`flyteplugins.union.io.allow_volumes()`	Enable `Volume` mounts in a task pod with zero privileges.
`flyteplugins.union.io.with_local_flyteplugins()`	Package the locally checked-out flyteplugins-union (built to a wheel) and an optional local `juicefs` binary into `base` — for iterating on an unreleased plugin build against a real cluster.
`flyteplugins.union.utils.with_local_flyteplugins_union()`	Layer the locally-built `flyteplugins-union` wheel onto `img`.

Packages

Package	Description
`flyteplugins.union`	Union SDK - Proprietary extensions for Flyte.
`flyteplugins.union.factory`	Factories: a declared graph of partitioned artifacts the platform can materialize on demand.
`flyteplugins.union.io`	Persistent, mountable `Volume` type for the Flyte SDK v2.
`flyteplugins.union.remote`	Union remote control plane objects.
`flyteplugins.union.utils`	Public utilities for `flyteplugins.union`.