Prefect Docs

# Orchestration Layer

Looking for the latest Prefect 2 release? Prefect 2 and Prefect Cloud 2 have been released for General Availability. See https://docs.prefect.io/ for details.

The Prefect orchestration layer lets you move from running single flows as scripts to running, monitoring, and scheduling many flows through a single web UI.

Prefect Cloud and the Prefect Server provide ready-to-use backend for maintaining task and flow state and inspecting their progress regardless of where your task and flow code runs.

# Prefect Cloud and Server

If you want an orchestration layer, you have two options: Prefect Cloud or Prefect Server. You can see an overview and comparison on the welcome page.

We encourage users to try Prefect Cloud first, unless your environment has restricted access to the Internet, or you prefer a self-hosted server for which you want to build your own authentication and scaling mechanism.

This guide focusses on setting up Prefect Cloud. More information on Prefect Server is available in the Prefect Server documentation.

# Create (or log into) your Prefect Cloud account

To use Prefect Cloud, log in to or set up a free-tier account for Prefect Cloud at https://cloud.prefect.io.

If your team needs support for additional users, automations, multi-tenant permissions, SSO, and other features, you can easily scale up to a bigger Prefect Cloud license.

# Set the Prefect Cloud backend

Once you have a Prefect Cloud account set up, configure Prefect to use the Prefect Cloud backend by running the following command:

$ prefect backend cloud

Note that you can change backends between Prefect Cloud and Prefect Core server at any time by running the prefect backend cloud or prefect backend server command.

# Authenticate with Prefect Cloud

Next you'll need to authenticate with the backend before you can proceed further.

# Create an API key and log in

To authenticate, you'll need to create an API Key and save it.

  • Navigate to the API keys page. In the User menu in the top right corner go to Account Settings -> API Keys -> Create An API Key.
  • Copy the created key
  • Log in with the Prefect CLI by running the following command:
$ prefect auth login --key <YOUR-KEY>

To learn more about API keys including how to save them, how to set them through environment variables, and how to use API keys connected to a service account, check out the API key documentation.

Once you're authenticated with Prefect Cloud, you can Deploy a flow, which includes creating or selecting a project, registering your flow, and starting an Agent.

← Deploy a Flow →