Run Your Workflow on a Flyte Backend¶
Installing Flyte Locally¶
This guide will walk you through a quick installation of Flyte on your laptop and then how to register and execute your workflows against this deployment. (The tabs below have an option to install Flyte on a cloud provider as well)
Estimated time to complete: 1 minutes.
To check if your flyte-sandbox container is running you can run
docker ps and it should show image ``ghcr.io/flyteorg/flyte-sandbox `` running
If you prefer using k3d, Minikube, docker for mac, or a hosted Kubernetes cluster like AWS-EKS, GCP-GKE, Azure Kubernetes refer to How do I try out/install Flyte?. It is recommended that you use a simple Docker based approach when you are first getting started with Flyte.
Running your Flyte Workflows¶
Registration is the process of shipping your code to Flyte backend. This creates an immutable, versioned record of your code with FlyteAdmin service.
Register your workflows¶
From within root directory of
flyteexamples you created previously
feel free to make any changes and then register
FLYTE_AWS_ENDPOINT=http://localhost:30084/ FLYTE_AWS_ACCESS_KEY_ID=minio \ FLYTE_AWS_SECRET_ACCESS_KEY=miniostorage make fast_register
Flyte sandbox uses minio as a substitue for S3/GCS etc, in the first command we port-forwarded it to 30084. If you use s3/gcs or a different port-forward you can drop or change
Boom! It’s that simple.
Run your workflows¶
Visit the page housing workflows registered for your project (method if you used k3d):
else if you used docker-desktop or something else, then copy paste this URL into the browser and fill in the
Select your workflow, click the bright purple “Launch Workflow” button in the upper right, update the “name” input argument as you please, proceed to launch and you’ll have triggered an execution!
- After registration Flyte Workflows exist in the FlyteAdmin service and can be triggered using the
directly invoking the REST API
on a schedule
Optionally you can create a new project¶
Refer to How do I create/register a new project?.