Union Flyte Plugin
Proprietary extensions and features for Flyte, providing Union-specific functionality.
Installation
uv pip install flyteplugins-union
For development:
uv pip install -e .
Flyte compatibility
flyteplugins-union builds on flyte SDK internals that can change between flyte
minor releases, so each release pins flyte to a single minor line. Install a
flyteplugins-union release built for your flyte minor:
| flyteplugins-union | Requires flyte |
|---|---|
| 0.12.0+ | >=2.10.0,<2.11.0 |
| 0.11.x | >=2.6.7,<2.9.0 |
| 0.8.2 – 0.10.9 | >=2.6.7,<2.7.0 |
| 0.8.0 – 0.8.1 | >=2.6.3,<2.7.0 |
| 0.7.2 | >=2.5.20,<2.7.0 |
| 0.5.0 – 0.7.1 | >=2.5.7,<2.6.0 |
| 0.4.3 | >=2.5.0,<2.6.0 |
| 0.4.0 – 0.4.2 | >=2.3.0,<2.5.0 |
| 0.3.0 | >=2.1.0,<2.5.0 |
See COMPATIBILITY.md
for the rationale and how the pin tracks new flyte releases.
Features
API Key Management
Create and manage API keys for headless authentication with Union.
Create an API Key
flyte create api-key admin --name my-api-key
This will create OAuth application credentials and output an API key that can be used for headless authentication.
Example output:
Client ID: serverless-1-myorg-my-api-key
The following API key will only be shown once. Be sure to keep it safe!
Configure your headless CLI by setting the following environment variable:
export FLYTE_API_KEY="<base64-encoded-credentials>"
Using the API Key
Set the generated API key as an environment variable:
export FLYTE_API_KEY="<your-api-key>"
Then use the Flyte CLI as normal - it will authenticate using the API key instead of prompting for interactive login.
Architecture
The Union SDK is structured as follows:
flyteplugins/union/internal/- Proprietary protobuf definitions and generated codeflyteplugins/union/cli/- CLI command plugins that extend the Flyte CLIflyteplugins/union/utils/- Shared utility functionsflyteplugins/union/remote/- Union-specific remote objects
Plugin System
The SDK registers CLI plugins via entry points in pyproject.toml:
[project.entry-points."flyte.plugins.cli.commands"]
"create.api-key" = "flyteplugins.union.cli.api_key:create_api_key"
"delete.api-key" = "flyteplugins.union.cli.api_key:delete_api_key"
"get.api-key" = "flyteplugins.union.cli.api_key:get_api_key"
This makes Union commands available seamlessly through the Flyte CLI.
Dependencies
- flyte - The Flyte SDK v2 (pinned to a single minor; see Flyte compatibility)
- rich-click>=1.8.0 - For CLI formatting
Development
To add a new CLI plugin:
- Create a new file in
src/flyteplugins/union/cli/ - Define your click commands
- Register the entry point in
pyproject.toml - Shared resources (protobufs, utilities) are available in
flyteplugins.union.internal.*andflyteplugins.union.utils.*
Iterating
Commands to rebuild and reinstall this plugin (into the flyte-sdk venv presumably). From this folder:
python -m build --wheel
From your flyte-sdk venv:
uv pip install --prerelease=allow --force-reinstall --no-deps --no-index --find-links /Users/ytong/go/src/github.com/unionai/flyteplugins-union/dist flyteplugins-union
2 maintainers
Metadata
2 maintainers
Release files for flyteplugins-union 0.15.5
For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.
Built distribution (wheel)
| File | Interpreter | ABI | Platform | Reset |
|---|---|---|---|---|
| flyteplugins_union-0.15.5-py3-none-manylinux2014_x86_64.whl | Python 3 | none | Linux glibc 2.17+ x86-64 | Details |
Release files / flyteplugins_union-0.15.5-py3-none-manylinux2014_x86_64.whl
| Download URL | flyteplugins_union-0.15.5-py3-none-manylinux2014_x86_64.whl |
|---|---|
| Size | 22.4 MB |
| Tags | Linux glibc 2.17+ x86-64 Python 3 |
|
SHA-256 checksum How to use checksums |
815b7588e8d4824a91ec6d95b86d6e686b151d19e4883a6ded4b805433e2b354
|
|
BLAKE2b-256 checksum How to use checksums |
fa860ab9877eb77a09a9cee738812207537b1ac7e92e43503493a95dae20dfe6
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
Yes |
| Uploaded via |
twine/7.0.0 CPython/3.13.14
|
