Connecting & Troubleshooting Prefect Cloud ¶
To create flow runs in a local or remote execution environment and use either Prefect Cloud or a Prefect server as the backend API server, you need to
- Configure the execution environment with the location of the API.
- Authenticate with the API, either by logging in or providing a valid API key (Prefect Cloud only).
Log into Prefect Cloud from a terminal¶
Configure a local execution environment to use Prefect Cloud as the API server for flow runs. In other words, "log in" to Prefect Cloud from a local environment where you want to run a flow.
- Open a new terminal session.
- Install Prefect in the environment in which you want to execute flow runs.
$ pip install -U prefect
- Use the
prefect cloud loginPrefect CLI command to log into Prefect Cloud from your environment.
$ prefect cloud login
prefect cloud login command, used on its own, provides an interactive login experience. Using this command, you can log in with either an API key or through a browser.
$ prefect cloud login ? How would you like to authenticate? [Use arrows to move; enter to select] > Log in with a web browser Paste an API key Paste your authentication key: ? Which workspace would you like to use? [Use arrows to move; enter to select] > prefect/terry-prefect-workspace g-gadflow/g-workspace Authenticated with Prefect Cloud! Using workspace 'prefect/terry-prefect-workspace'.
You can also log in by providing a Prefect Cloud API key that you create.
If you need to change which workspace you're syncing with, use the
prefect cloud workspace set Prefect CLI command while logged in, passing the account handle and workspace name.
$ prefect cloud workspace set --workspace "prefect/my-workspace"
If no workspace is provided, you will be prompted to select one.
Workspace Settings also shows you the
prefect cloud workspace set Prefect CLI command you can use to sync a local execution environment with a given workspace.
You may also use the
prefect cloud login command with the
-w option to set the current workspace.
$ prefect cloud login --workspace "prefect/my-workspace"
Manually configure Prefect API settings¶
You can also manually configure the
PREFECT_API_URL setting to specify the Prefect Cloud API.
For Prefect Cloud, you can configure the
PREFECT_API_KEY settings to authenticate with Prefect Cloud by using an account ID, workspace ID, and API key.
$ prefect config set PREFECT_API_URL="https://api.prefect.cloud/api/accounts/[ACCOUNT-ID]/workspaces/[WORKSPACE-ID]" $ prefect config set PREFECT_API_KEY="[API-KEY]"
When you're in a Prefect Cloud workspace, you can copy the
PREFECT_API_URL value directly from the page URL.
In this example, we configured
PREFECT_API_KEY in the default profile. You can use
prefect profile CLI commands to create settings profiles for different configurations. For example, you could have a "cloud" profile configured to use the Prefect Cloud API URL and API key, and another "local" profile for local development using a local Prefect API server started with
prefect server start. See Settings for details.
You can also set
PREFECT_API_KEY as you would any other environment variable. See Overriding defaults with environment variables for more information.
See the Flow orchestration with Prefect tutorial for examples.
Install requirements in execution environments¶
In local and remote execution environments — such as VMs and containers — you must make sure any flow requirements or dependencies have been installed before creating a flow run.
Troubleshooting Prefect Cloud¶
This section provides tips that may be helpful if you run into problems using Prefect Cloud.
Prefect Cloud and proxies¶
Proxies intermediate network requests between a server and a client.
To communicate with Prefect Cloud, the Prefect client library makes HTTPS requests. These requests are made using the
httpx Python library.
httpx respects accepted proxy environment variables, so the Prefect client is able to communicate through proxies.
To enable communication via proxies, simply set the
SSL_CERT_FILE environment variables as appropriate in your execution environment and things should “just work.”
See the Using Prefect Cloud with proxies topic in Prefect Discourse for examples of proxy configuration.
URLs that should be whitelisted for outbound-communication in a secure environment include the UI, the API, Authentication, and the current OCSP server:
Prefect Cloud access via API¶
If the Prefect Cloud API key, environment variable settings, or account login for your execution environment are not configured correctly, you may experience errors or unexpected flow run results when using Prefect CLI commands, running flows, or observing flow run results in Prefect Cloud.
prefect config view CLI command to make sure your execution environment is correctly configured to access Prefect Cloud.
$ prefect config view PREFECT_PROFILE='cloud' PREFECT_API_KEY='pnu_xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx' (from profile) PREFECT_API_URL='https://api.prefect.cloud/api/accounts/...' (from profile)
PREFECT_API_URL is configured to use
PREFECT_API_KEY is configured to use a valid API key.
You can use the
prefect cloud workspace ls CLI command to view or set the active workspace.
$ prefect cloud workspace ls ┏━━━━━━━━━━━━━━━━━━━━━━━━━┓ ┃ Available Workspaces: ┃ ┡━━━━━━━━━━━━━━━━━━━━━━━━━┩ │ g-gadflow/g-workspace │ │ * prefect/workinonit │ └─────────────────────────┘ * active workspace
You can also check that the account and workspace IDs specified in the URL for
PREFECT_API_URL match those shown in the URL bar for your Prefect Cloud workspace.
Prefect Cloud login errors¶
If you're having difficulty logging in to Prefect Cloud, the following troubleshooting steps may resolve the issue, or will provide more information when sharing your case to the support channel.
- Are you logging into Prefect Cloud 2? Prefect Cloud 1 and Prefect Cloud 2 use separate accounts. Make sure to use the right Prefect Cloud 2 URL: https://app.prefect.cloud/
- Do you already have a Prefect Cloud account? If you’re having difficulty accepting an invitation, try creating an account first using the email associated with the invitation, then accept the invitation.
- Are you using a single sign-on (SSO) provider, social authentication (Google, Microsoft, or GitHub) or just using an emailed link?
Other tips to help with login difficulties:
- Hard refresh your browser with Cmd+Shift+R.
- Try in a different browser. We actively test against the following browsers:
- Clear recent browser history/cookies
None of this worked?
Email us at email@example.com and provide answers to the questions above in your email to make it faster to troubleshoot and unblock you. Make sure you add the email address with which you were trying to log in, your Prefect Cloud account name, and, if applicable, the organization to which it belongs.