Kubernetes operator to executes Flyte graphs natively on kubernetes
Propeller is a K8s native operator that executes Flyte workflows. Workflow Spec is written in Protobuf for cross-compatibility.
A Mutating Webhook that can be optionally deployed to extend Flyte Propeller's functionality. It currently supports enables injecting secrets into pods launched directly or indirectly through Flyte backend plugins.
A Kubectl-plugin to interact with Flyte Workflow CRDs. It enables retrieving and rendering Flyte Workflows in CLI as well as safely aborting running workflows.
kubectl-flyte is an command line tool that can be used as an extension to kubectl. It is a separate binary that is built from the propeller repo.
This command will install kubectl-flyte and flytepropeller to
$ make compile
You can also use Krew to install the kubectl-flyte CLI:
$ kubectl krew install flyte
Two ways to execute the command, either standalone kubectl-flyte or as a subcommand of kubectl
$ kubectl-flyte --help OR $ kubectl flyte --help Flyte is a serverless workflow processing platform built for native execution on K8s. It is extensible and flexible to allow adding new operators and comes with many operators built in Usage: kubectl-flyte [flags] kubectl-flyte [command] Available Commands: compile Compile a workflow from core proto-buffer files and output a closure. config Runs various config commands, look at the help of this command to get a list of available commands.. create Creates a new workflow from proto-buffer files. delete delete a workflow get Gets a single workflow or lists all workflows currently in execution help Help about any command visualize Get GraphViz dot-formatted output.
Observing running workflows
To retrieve all workflows in a namespace use the --namespace option, --namespace = "" implies all namespaces.
$ kubectl-flyte get --namespace flytekit-development workflows ├── flytekit-development/flytekit-development-f01c74085110840b8827 [ExecId: ... ] (2m34s Succeeded) - Time SinceCreation(30h1m39.683602s) ... Found 19 workflows Success: 19, Failed: 0, Running: 0, Waiting: 0
To retrieve a specific workflow, namespace can either be provided in the format namespace/name or using the --namespace argument
$ kubectl-flyte get flytekit-development/flytekit-development-ff806e973581f4508bf1 Workflow └── flytekit-development/flytekit-development-ff806e973581f4508bf1 [ExecId: project:"flytekit" domain:"development" name:"ff806e973581f4508bf1" ] (2m32s Succeeded ) ├── start-node start 0s Succeeded ├── c task 0s Succeeded ├── b task 0s Succeeded ├── a task 0s Succeeded └── end-node end 0s Succeeded
To delete a specific workflow
$ kubectl-flyte delete --namespace flytekit-development flytekit-development-ff806e973581f4508bf1
To delete all completed workflows - they have to be either success/failed with a special isCompleted label set on them. The Label is set here
$ kubectl-flyte delete --namespace flytekit-development --all-completed
Running propeller locally
use the config.yaml in root found here. Cd into this folder and then run
Following dependencies need to be met
- Blob store (you can forward minio port to localhost)
- Admin Service endpoint (can be forwarded) OR Disable events to admin and launchplans
- access to kubeconfig and kubeapi
API Server requires the webhook to serve traffic over SSL. To issue self-signed certs to be used for serving traffic, use:
$ flytepropeller webhook init-certs
This will create a ca.crt, tls.crt and key.crt and store them to flyte-pod-webhook secret. If a secret of the same name already exist, it'll not override it.
Starting the webhook can be done by running:
$ flytepropeller webhook
The secret should be mounted and accessible to this command. It'll then create a MutatingWebhookConfiguration object with the details of the webhook and that registers the webhook with ApiServer.
Making changes to CRD
Remember changes to CRD should be carefully done, they should be backwards compatible or else you should use proper operator versioning system. Once you do the changes, you have to follow the following steps.
- Ensure the propeller code is checked out in
- Uncomment https://github.com/flyteorg/flytepropeller/blob/master/hack/tools.go#L5
$ go mod vendor
- Now generate the code
$ make op_code_generate
Why do we have to do this?
Flytepropeller uses old way of writing Custom controllers for K8s. The k8s.io/code-generator only works in the GOPATH
relative code path (sadly). So you have checkout the code in the right place. Also,
go mod vendor is needed to get
code-generator in a discoverable path.
- We may be able to avoid needing the old style go-path
- Migrate to using controller runtime
Package cmd contains commands for FlytePropeller controller.
|Package cmd contains commands for FlytePropeller controller.|
Commands for FlytePropeller manager.
|Commands for FlytePropeller manager.|
This package imports things required by build scripts, to force `go mod` to see them as dependencies
|This package imports things required by build scripts, to force `go mod` to see them as dependencies|
Package manager introduces a FlytePropeller Manager implementation that enables horizontal scaling of FlytePropeller by sharding FlyteWorkflows.
|Package manager introduces a FlytePropeller Manager implementation that enables horizontal scaling of FlytePropeller by sharding FlyteWorkflows.|
Package config details configuration data structures for the FlytePropeller Manager implementation.
|Package config details configuration data structures for the FlytePropeller Manager implementation.|
Package shardstrategy defines a variety of sharding stratgies to distribute FlyteWorkflows over managed FlytePropeller instances.
|Package shardstrategy defines a variety of sharding stratgies to distribute FlyteWorkflows over managed FlytePropeller instances.|
Package v1alpha1 is the v1alpha1 version of the API.
|Package v1alpha1 is the v1alpha1 version of the API.|
This package has the automatically generated clientset.
|This package has the automatically generated clientset.|
This package has the automatically generated fake clientset.
|This package has the automatically generated fake clientset.|
This package contains the scheme of the automatically generated clientset.
|This package contains the scheme of the automatically generated clientset.|
This package has the automatically generated typed clients.
|This package has the automatically generated typed clients.|
Package fake has the automatically generated clients.
|Package fake has the automatically generated clients.|
Package compiler provides compiler services for flyte workflows.
|Package compiler provides compiler services for flyte workflows.|
This package defines the intermediate layer that the compiler builds and transformers accept.
|This package defines the intermediate layer that the compiler builds and transformers accept.|
This package is a central repository of all compile errors that can be reported.
|This package is a central repository of all compile errors that can be reported.|
This package converts the output of the compiler into a K8s resource for propeller to execute.
|This package converts the output of the compiler into a K8s resource for propeller to execute.|
This package contains validators for all elements of the workflow spec (node, task, branch, interface, bindings...
|This package contains validators for all elements of the workflow spec (node, task, branch, interface, bindings...|
Package controller contains the K8s controller logic.
|Package controller contains the K8s controller logic.|
Package config contains the core configuration for FlytePropeller.
|Package config contains the core configuration for FlytePropeller.|
Package nodes contains the Core Nodes Executor implementation and a subpackage for every node kind This module implements the core Nodes executor.
|Package nodes contains the Core Nodes Executor implementation and a subpackage for every node kind This module implements the core Nodes executor.|
The PodMutator is a controller-runtime webhook that intercepts Pod Creation events and mutates them.
|The PodMutator is a controller-runtime webhook that intercepts Pod Creation events and mutates them.|
Package plugins facilitates all the plugins that should be loaded by FlytePropeller
|Package plugins facilitates all the plugins that should be loaded by FlytePropeller|