Skip to content

Commit

Permalink
Merge branch 'main' into enh-codespell
Browse files Browse the repository at this point in the history
  • Loading branch information
serinamarie authored Nov 13, 2023
2 parents 265b342 + e782a7b commit 62e55f3
Show file tree
Hide file tree
Showing 48 changed files with 764 additions and 295 deletions.
18 changes: 13 additions & 5 deletions .github/workflows/python-tests.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -20,6 +20,14 @@ on:
push:
branches:
- main
paths:
- .github/workflows/python-tests.yaml
- "**/*.py"
- requirements.txt
- requirements-client.txt
- requirements-dev.txt
- setup.cfg
- Dockerfile

permissions:
contents: read
Expand Down Expand Up @@ -223,10 +231,10 @@ jobs:
|| echo "Ignoring bad exit code"
# Run a smaller subset of tests with pydantic v2 installed, the
# Run a smaller subset of tests with pydantic v1 installed, the
# Python versions we support, and only on sqlite + postgres 14
run-tests-pydantic-v2:
name: pydantic v2, python:${{ matrix.python-version }}, ${{ matrix.database }}, ${{ matrix.pytest-options }}
run-tests-pydantic-v1:
name: pydantic v1, python:${{ matrix.python-version }}, ${{ matrix.database }}, ${{ matrix.pytest-options }}
strategy:
matrix:
database:
Expand Down Expand Up @@ -299,7 +307,7 @@ jobs:
- name: Force install pydantic in docker images
if: ${{ matrix.build-docker-images }}
run: |
sed -i 's/RUN prefect version/RUN pip install "pydantic>2"\nRUN prefect version/' Dockerfile
sed -i 's/RUN prefect version/RUN pip install "pydantic<2"\nRUN prefect version/' Dockerfile
- name: Build test image
if: ${{ matrix.build-docker-images }}
Expand Down Expand Up @@ -353,7 +361,7 @@ jobs:
pip install ${{ ! matrix.lower-bound-requirements && '--upgrade --upgrade-strategy eager' || ''}} -e .[dev]
- name: Force install pydantic for unit tests
run: pip install "pydantic>2"
run: pip install "pydantic<2"

- name: Start database container
if: ${{ startsWith(matrix.database, 'postgres') }}
Expand Down
4 changes: 2 additions & 2 deletions docs/cloud/cloud-quickstart.md
Original file line number Diff line number Diff line change
Expand Up @@ -37,7 +37,7 @@ Prefer to follow this tutorial in a video? We've got exactly what you need. Happ

To sign in with an existing account or register an account, go to [https://app.prefect.cloud/](https://app.prefect.cloud/).

You can create an account with:
You can create an account with any of the following:

- Google account
- Microsoft account
Expand All @@ -54,7 +54,7 @@ When you register a new account, you'll be prompted to provide a name and descri

![Creating a new workspace in the Cloud UI.](/img/ui/cloud-workspace-details.png)

Note that the **Owner** setting applies only to users who are members of Prefect Cloud organizations and have permission to create workspaces within the organization.
Note that the **Owner** setting applies only to users who are members of Prefect Cloud accounts and have permission to create workspaces within account.

Select **Create** to create the workspace.
If you change your mind, select **Edit** from the options menu to modify the workspace details or to delete it.
Expand Down
21 changes: 0 additions & 21 deletions docs/cloud/connecting.md
Original file line number Diff line number Diff line change
Expand Up @@ -169,7 +169,6 @@ If you're having difficulty logging in to Prefect Cloud, the following troublesh
- 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 (Google or Microsoft) or just using a username and password login?
- Did you utilize the “having trouble/forgot password” link on the login page? If so, did you receive the password reset email? Occasionally the password reset email can get filtered into your spam folder.

Other tips to help with login difficulties:

Expand All @@ -181,26 +180,6 @@ Other tips to help with login difficulties:
- Safari
- Clear recent browser history/cookies

In some cases, logging in to Prefect Cloud results in a "404 Page Not Found" page or fails with the error: "Failed to load module script: Expected a JavaScript module script but the server responded with a MIME type of “text/html”. Strict MIME type checking is enforced for module scripts per HTML spec."

This error may be caused by a bad service worker.

To resolve the problem, we recommend unregistering service workers.

In your browser, start by opening the developer console.

- In Chrome: **View > Developer > Developer Tools**
- In Firefox: **Tools > Browser Tools > Web Developer Tools**

Once the developer console is open:

1. Go to the **Application** tab in the developer console.
1. Select **Storage**.
1. Make sure **Unregister service workers** is selected.
1. Select **Clear site data**, then hard refresh the page with CMD+Shift+R (CTRL+Shift+R on Windows).

See the [Login to Prefect Cloud fails...](https://discourse.prefect.io/t/login-to-prefect-cloud-fails-with-an-error-failed-to-load-module-script-expected-a-javascript-module-script-but-the-server-responded-with-a-mime-type-of-text-html-strict-mime-type-checking-is-enforced-for-module-scripts-per-html-spec/1722/1) topic in Prefect Discourse for a video demonstrating these steps.

None of this worked?

Email us at <help@prefect.io> 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.
88 changes: 43 additions & 45 deletions docs/cloud/index.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
---
description: Observe and orchestrate your workflows with the hosted Prefect Cloud platform.
description: Observe and orchestrate your workflow applications with the hosted Prefect Cloud platform.
tags:
- UI
- dashboard
Expand All @@ -16,9 +16,9 @@ search:

# Welcome to Prefect Cloud <span class="badge cloud"></span>

Prefect Cloud is a workflow orchestration platform that provides all the capabilities of Prefect server plus additional features, such as:
Prefect Cloud is a hosted workflow application framework that provides all the capabilities of Prefect server plus additional features, such as:

- automations, events, and webhooks so you can create for event-driven workflows
- automations, events, and webhooks so you can create event-driven workflows
- workspaces, RBAC, SSO, audit logs and related user management tools for collaboration
- push work pools for running flows on serverless infrastructure without a worker
- error summaries powered by Marvin AI to help you resolve errors faster
Expand All @@ -35,30 +35,40 @@ Prefect Cloud includes all the features in the open-source Prefect server plus t
- [Workspaces](/cloud/workspaces/) &mdash; isolated environments to organize your flows, deployments, and flow runs.
- [Automations](/cloud/automations/) &mdash; configure triggers, actions, and notifications in response to real-time monitoring events.
- [Email notifications](/cloud/automations/) &mdash; send email alerts from Prefect's server based on automation triggers.
- [Organizations](/cloud/organizations/) &mdash; user and workspace management features that enable collaboration for larger teams.
- [Service accounts](/cloud/users/service-accounts/) &mdash; configure API access for running workers or executing flow runs on remote infrastructure.
- [Custom role-based access controls (RBAC)](/cloud/users/roles/) &mdash; assign users granular permissions to perform certain activities within an organization or a workspace.
- [Custom role-based access controls (RBAC)](/cloud/users/roles/) &mdash; assign users granular permissions to perform certain activities within an account or a workspace.
- [Single Sign-on (SSO)](/cloud/users/sso/) &mdash; authentication using your identity provider.
- [Audit Log](/cloud/users/audit-log/) &mdash; a record of user activities to monitor security and compliance.
- Collaborators &mdash; invite others to work in your [workspace](/cloud/workspaces/#workspace-collaborators) or [organization](/cloud/organizations/#organization-members).
- Collaboration &mdash; invite other people to your account.
- Error summaries &mdash; (enabled by Marvin AI) distill the error logs of `Failed` and `Crashed` flow runs into actionable information.
- [Push work pool](/guides/deployment/push-work-pools/) &mdash; run flows on your serverless infrastructure without running a worker.
- [Push work pools](/guides/deployment/push-work-pools/) &mdash; run flows on your serverless infrastructure without running a worker.

## User accounts

When you sign up for Prefect Cloud, a personal account is automatically provisioned for you.
A personal account gives you access to profile settings where you can view and administer your:
When you sign up for Prefect Cloud, an account and a user profile are automatically provisioned for you.

Your profile is the place where you'll manage settings related to yourself as a user, including:

- Profile, including profile handle and image
- API keys
- Preferences, including timezone and color mode

As an account Admin, you will also have access to account settings from the Account Settings page, such as:

- Members
- Workspaces
- Roles

As a personal account owner, you can create a [workspace](#workspaces) and invite collaborators to your workspace.
As an account Admin you can create a [workspace](#workspaces) and invite other individuals to your workspace.

[Organizations](#organizations) in Prefect Cloud enable you to invite users to collaborate in your workspaces with the ability to set [role-based access controls (RBAC)](#roles-and-custom-permissions) for organization members.
Organizations may also configure [service accounts](#service-accounts) with API keys for non-user access to the Prefect Cloud API.
Upgrading from a Prefect Cloud Free tier plan to a Pro or Enterprise tier plan enables additional functionality for adding workspaces, managing teams, and running higher volume workloads.

Workspace Admins have the ability to use [single sign-on (SSO)](#single-sign-on-(sso)), set [role-based access controls (RBAC)](#roles-and-custom-permissions), view [Audit Logs](#audit-log), and configure [service accounts](#service-accounts).

Enterprise add [custom roles](/cloud/users/roles/), [object-level access control lists](/cloud/users/object-access-control-lists/), [teams](/cloud/users/teams/), and [Directory Sync/SCIM provisioning](/cloud/users/sso/#scim-provisioning) for SSO.

!!! cloud-ad "Prefect Cloud plans for teams of every size"
See the [Prefect Cloud plans](https://www.prefect.io/pricing/) for details on options for individual users and teams.
See the [Prefect Cloud plans](https://www.prefect.io/pricing/) for details on Pro and Enterprise account tiers.

## Workspaces

Expand All @@ -67,7 +77,7 @@ See the [Workspaces](/cloud/workspaces/) documentation for more information abou

Each workspace keeps track of its own:

- [Flow runs](/concepts/flows/) and task runs executed in an environment that is [syncing with the workspace](/cloud/#workspaces)
- [Flow runs](/concepts/flows/) and task runs executed in an environment that is [syncing with the workspace](/cloud/workspaces/)
- [Flows](/concepts/flows/) associated with flow runs and deployments observed by the Prefect Cloud API
- [Deployments](/concepts/deployments/)
- [Work pools](/concepts/work-pools/)
Expand All @@ -78,57 +88,45 @@ Each workspace keeps track of its own:

## Events

Prefect Cloud allows you to see your [events](/cloud/events/).
Prefect Cloud allows you to see your [events](/cloud/events/). Events provide information about the state of your workflows, and can be used to trigger [automations](/cloud/automations/).

![Prefect UI](/img/ui/event-feed.png)

## Automations

Prefect Cloud [automations](/cloud/automations/) provide additional notification capabilities as the open-source Prefect server.
Automations enable you to configure triggers and actions that can kick off flow runs, pause deployments, or send custom notifications in response to real-time monitoring events.
Prefect Cloud [automations](/cloud/automations/) provide additional notification capabilities beyond those in a self-hosted open-source Prefect server.
Automations also enable you to create event-driven workflows.

## Error summaries

Prefect Cloud error summaries, enabled by Marvin AI, distill the error logs of `Failed` and `Crashed` flow runs into actionable information.
To enable this feature and others powered by Marvin AI, visit the settings page for your account.
To enable this feature and others powered by Marvin AI, visit the **Settings** page for your account.

## Organizations <span class="badge orgs"></span>
## Service accounts <span class="badge pro"></span> <span class="badge enterprise"></span>

A Prefect Cloud [organization](/cloud/organizations/) account type enables more fine-grained control over workspace collaboration.
With an organization account you can:

- Invite members to join the organization.
- Create organization workspaces.
- Configure members roles and permissions within the organization and for individual workspaces.
- Create service accounts with credentials for non-user API access.

See the [Organizations](/cloud/organizations/) documentation for more information about managing users, service accounts, and workspaces in a Prefect Cloud organization.

## Service accounts <span class="badge orgs"></span>

Service accounts enable you to create a Prefect Cloud API key that is not associated with a user account.
Service accounts enable you to create Prefect Cloud API keys that are not associated with a user account.
Service accounts are typically used to configure API access for running workers or executing flow runs on remote infrastructure.
See the [service accounts](/cloud/users/service-accounts/) documentation for more information about creating and managing service accounts.

See the [service accounts](/cloud/users/service-accounts/) documentation for more information about creating and managing service accounts in a Prefect Cloud organization.

## Roles and custom permissions <span class="badge orgs"></span>

Role-based access control (RBAC) functionality in Prefect Cloud enables you to assign users granular permissions to perform certain activities within an organization or a workspace.
## Roles and custom permissions <span class="badge pro"> </span><span class="badge enterprise"></span>

See the [role-based access controls (RBAC)](../cloud/users/roles/) documentation for more information about managing user roles in a Prefect Cloud organization.
Role-based access controls (RBAC) enable you to assign users a role with permissions to perform certain activities within an account or a workspace.
See the [role-based access controls (RBAC)](../cloud/users/roles/) documentation for more information about managing user roles in a Prefect Cloud account.

## Single Sign-on (SSO) <span class="badge orgs"></span> <span class="badge enterprise"></span>
## Single Sign-on (SSO) <span class="badge pro"></span> <span class="badge enterprise"></span>

Prefect Cloud's [Organization and Enterprise plans](https://www.prefect.io/pricing) offer [single sign-on (SSO)](/cloud/users/sso/) authentication integration with your team’s identity provider. SSO integration can bet set up with identity providers that support OIDC and SAML.
SCIM provisioning is also available with Enterprise plans.
Prefect Cloud's [Pro and Enterprise plans](https://www.prefect.io/pricing) offer [single sign-on (SSO)](/cloud/users/sso/) authentication integration with your team’s identity provider.
SSO integration can bet set up with identity providers that support OIDC and SAML.
Directory Sync and SCIM provisioning is also available with Enterprise plans.

## Audit log <span class="badge orgs"></span> <span class="badge enterprise"></span>
## Audit log <span class="badge pro"></span> <span class="badge enterprise"></span>

Prefect Cloud's [Organization and Enterprise plans](https://www.prefect.io/pricing) offer [Audit Log](/cloud/users/audit-log/) compliance and transparency tools.
Audit logs provide a chronological record of activities performed by users in your organization, allowing you to monitor detailed actions for security and compliance purposes.
Prefect Cloud's [Pro and Enterprise plans](https://www.prefect.io/pricing) offer [Audit Logs](/cloud/users/audit-log/) for compliance and security.
Audit logs provide a chronological record of activities performed by users in an account.

## Prefect Cloud REST API

The [Prefect REST API](/api-ref/rest-api/) is used for communicating data from Prefect clients to Prefect Cloud or a local Prefect server so that orchestration can be performed.
The [Prefect REST API](/api-ref/rest-api/) is used for communicating data from Prefect clients to Prefect Cloud or a local Prefect server for orchestration and monitoring.
This API is mainly consumed by Prefect clients like the Prefect Python Client or the Prefect UI.

!!! note "Prefect Cloud REST API interactive documentation"
Expand Down
Loading

0 comments on commit 62e55f3

Please sign in to comment.