Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Configure docs to enable versioning at a future time #8204

Merged
merged 8 commits into from
Jan 26, 2023
Merged

Configure docs to enable versioning at a future time #8204

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
8 commits
Select commit Hold shift + click to select a range
e1438e6
revise img urls
tpdorsey Jan 19, 2023
cba5018
enable versions with mike
tpdorsey Jan 19, 2023
37d0f58
config typo
tpdorsey Jan 19, 2023
02b66d8
add mike requirement
tpdorsey Jan 19, 2023
9601b2a
Apply suggestions from code review
Jan 19, 2023
0c07fcf
merge updates from main
tpdorsey Jan 26, 2023
a58d41d
Merge branch 'versions-img-urls' of https://github.com/PrefectHQ/pref…
tpdorsey Jan 26, 2023
c1c384e
update image url
tpdorsey Jan 26, 2023
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 2 additions & 2 deletions docs/concepts/deployments.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -300,7 +300,7 @@ To edit parameters in the Prefect UI, go the the details page for a deployment,

To create an ad-hoc flow run with different parameter values, go the the details page for a deployment, select **Run**, then select **Custom**. You will be able to provide custom values for any editable deployment fields. Under **Parameters**, select **Custom**. Provide the new values, then select **Save**. Select **Run** to begin the flow run with custom values.

![Configuring custom parameter values for an ad-hoc flow run](/img/concepts/custom-parameters.png)
![Configuring custom parameter values for an ad-hoc flow run](../img/concepts/custom-parameters.png)

### Create a deployment

Expand Down Expand Up @@ -339,7 +339,7 @@ $ prefect deployment ls
```
</div>

![Viewing deployments in the Prefect UI](/img/concepts/deployments.png)
![Viewing deployments in the Prefect UI](../img/concepts/deployments.png)

When you run a deployed flow with Prefect Orion, the following happens:

Expand Down
4 changes: 2 additions & 2 deletions docs/concepts/flows.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -47,7 +47,7 @@ However you run the flow, the Prefect API monitors the flow run, capturing flow

When you run a flow that contains tasks or additional flows, Prefect will track the relationship of each child run to the parent flow run.

![Prefect UI](/img/ui/orion-dashboard.png)
![Prefect UI](../img/ui/orion-dashboard.png)

## Writing flows

Expand Down Expand Up @@ -752,4 +752,4 @@ $ prefect flow-run cancel 'a55a4804-9e3c-4042-8b59-b3b6b7618736'

From the UI you can cancel a flow run by navigating to the flow run's detail page and clicking the `Cancel` button in the upper right corner.

![Prefect UI](/img/ui/flow-run-cancellation-ui.png)
![Prefect UI](../img/ui/flow-run-cancellation-ui.png)
2 changes: 1 addition & 1 deletion docs/concepts/logs.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -47,7 +47,7 @@ Completed('All states completed.')

You can see logs for the flow run in the Prefect UI by navigating to the [**Flow Runs**](/ui/flow-runs/#inspect-a-flow-run) page and selecting a specific flow run to inspect.

![Viewing logs for a flow run in the Prefect UI](/img/ui/orion-flow-run-details.png)
![Viewing logs for a flow run in the Prefect UI](../img/ui/orion-flow-run-details.png)

These log messages reflect the logging configuration for log levels and message formatters. You may customize the log levels captured and the default message format through configuration, and you can capture custom logging events by explicitly emitting log messages during flow and task runs.

Expand Down
4 changes: 2 additions & 2 deletions docs/concepts/storage.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -68,11 +68,11 @@ You can [create, edit, and manage storage blocks](/ui/blocks/) in the Prefect UI

To create a new block, select the **+** button. Prefect displays a library of block types you can configure to create blocks to be used by your flows.

![Viewing the new block library in the Prefect UI](/img/ui/orion-block-library.png)
![Viewing the new block library in the Prefect UI](../img/ui/orion-block-library.png)

Select **Add +** to configure a new storage block based on a specific block type. Prefect displays a **Create** page that enables specifying storage settings.

![Configurating an S3 storage block in the Prefect UI](/img/tutorials/s3-block-configuration.png)
![Configuring an S3 storage block in the Prefect UI](../img/tutorials/s3-block-configuration.png)

You can also create blocks using the Prefect Python API:

Expand Down
4 changes: 2 additions & 2 deletions docs/concepts/work-queues.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -139,7 +139,7 @@ You can configure work queues by using:
- Prefect CLI commands
- Prefect Python API

![Creating a new work queue in the Orion UI](/img/ui/work-queue-create.png)
![Creating a new work queue in the Orion UI](../img/ui/work-queue-create.png)


To configure a work queue via the Prefect CLI, use the `prefect work-queue create` command:
Expand Down Expand Up @@ -183,7 +183,7 @@ On success, the command returns the details of the newly created work queue, whi

At any time, users can see and edit configured work queues in the Prefect UI.

![The UI displays a list of configured work queues](/img/ui/work-queue-list.png)
![The UI displays a list of configured work queues](../img/ui/work-queue-list.png)

To view work queues with the Prefect CLI, you can:

Expand Down
18 changes: 9 additions & 9 deletions docs/tutorials/deployments.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -531,30 +531,30 @@ Note that we referenced the deployment by name in the format "flow_name/deployme

You can also see your flow in the [Prefect UI](/ui/overview/). Open the Prefect UI at [http://127.0.0.1:4200/](http://127.0.0.1:4200/). You'll see your deployment's flow run in the UI.

![Deployment flow run on the Flow Runs page of the Prefect UI](/img/tutorials/my-first-deployment.png)
![Deployment flow run on the Flow Runs page of the Prefect UI](../img/tutorials/my-first-deployment.png)

## Run a deployment from the UI

With a work queue and agent in place, you can also create a flow run for `log_simple` directly from the UI.

In the Prefect UI, select the **Deployments** page. You'll see a list of all deployments that have been created in this Prefect Orion instance.

![The Deployments page displays a list of deployments created in Prefect](/img/tutorials/orion-deployments.png)
![The Deployments page displays a list of deployments created in Prefect](../img/tutorials/orion-deployments.png)

Now select **log-flow/log-simple** to see details for the deployment you just created.

![Viewing details of a single deployment](/img/tutorials/deployment-details.png)
![Viewing details of a single deployment](../img/tutorials/deployment-details.png)

Select **Parameters** to see the default parameters you specified in the deployment definition.

![Viewing deployment parameters](/img/tutorials/deployment-parameters.png)
![Viewing deployment parameters](../img/tutorials/deployment-parameters.png)

You can start a flow run for this deployment from the UI by selecting the **Run** button, which gives you options to:

- Create a flow run with the default settings
- Create a flow run with custom settings

![Deployment run options in the UI](/img/tutorials/deployment-run-options.png)
![Deployment run options in the UI](../img/tutorials/deployment-run-options.png)

If you choose a **Custom** flow run, you can configure details including:

Expand All @@ -564,13 +564,13 @@ If you choose a **Custom** flow run, you can configure details including:
- Scheduled start time
- Custom parameters

![Configuring custom flow run settings](/img/tutorials/custom-flow-run.png)
![Configuring custom flow run settings](../img/tutorials/custom-flow-run.png)

Let's change the `name` parameter for the next flow run. Under **Parameters**, select **Custom**.

Change the value for the `name` parameter to some other value. We used "Trillian".

![Configuring custom flow run settings](/img/tutorials/custom-parameter.png)
![Configuring custom flow run settings](../img/tutorials/custom-parameter.png)

Select **Save** to save any changed values, then select **Run** to create the custom flow run.

Expand Down Expand Up @@ -606,11 +606,11 @@ As before, the flow run will be picked up by the agent, and you should be able t

Go back the **Flow Runs** page in the UI and you'll see the flow run you just initiatied ran and was observed by the API.

![The deployment flow run is shown in the UI run history](/img/tutorials/deployment-run.png)
![The deployment flow run is shown in the UI run history](../img/tutorials/deployment-run.png)

Select the flow run to see details. In the flow run logs, you can see that the flow run logged a "Hello Trillian!" message as expected.

![The flow run logs show the expected Hello Trillian! log message](/img/tutorials/dep-flow-logs.png)
![The flow run logs show the expected Hello Trillian! log message](../img/tutorials/dep-flow-logs.png)

## Run deployments with Prefect Cloud

Expand Down
16 changes: 8 additions & 8 deletions docs/tutorials/docker.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -43,13 +43,13 @@ Most users will find it easiest to configure new infrastructure blocks through t

You can see any previously configured storage blocks by opening the Prefect UI and navigating to the **Blocks** page. To create a new infrastructure block, select the **+** button on this page. Prefect displays a page of available block types. Select **run-infrastructure** from the **Capability** list to filter just the infrastructure blocks.

![Viewing a list of infrastructure block types in the Prefect UI](/img/tutorials/infrastructure-blocks.png)
![Viewing a list of infrastructure block types in the Prefect UI](../img/tutorials/infrastructure-blocks.png)

Use these base blocks to create your own infrastructure blocks containing the settings needed to run flows in your environment.

For this tutorial, find the **Docker Container** block, then select **Add +** to see the options for a Docker infrastructure block.

![Viewing a list of infrastructure block types in the Prefect UI](/img/tutorials/docker-infrastructure.png)
![Viewing a list of infrastructure block types in the Prefect UI](../img/tutorials/docker-infrastructure.png)

To configure this Docker Container block to run the `log_flow.py` deployment, we just need to add two pieces of information.

Expand All @@ -70,7 +70,7 @@ In the **Env (Optional)** box, enter the following to specify that the `s3fs` pa
```
If you defined a different type of storage block, such as Azure or GCS, you'll need to specify the relevant storage library. See the [Prerequisites section of the Storage tutorial](/tutorials/storage/#prerequisites) for details.

![Configuring a new Docker Container infrastructure block in the Prefect UI](/img/tutorials/docker-tutorial-block.png)
![Configuring a new Docker Container infrastructure block in the Prefect UI](../img/tutorials/docker-tutorial-block.png)

## Using infrastructure blocks with deployments

Expand Down Expand Up @@ -127,21 +127,21 @@ $ prefect agent start -q 'test'

Open the Prefect UI at [http://127.0.0.1:4200/](http://127.0.0.1:4200/) and select the **Deployments** page. You'll see a list of all deployments that have been created in this Prefect Orion instance, including the new `log-flow/log-flow-docker` deployment.

![Viewing the new Docker deployment in the Prefect UI](/img/tutorials/docker-deployment.png)
![Viewing the new Docker deployment in the Prefect UI](../img/tutorials/docker-deployment.png)

## Edit the deployment in the UI

`log_flow` expects a runtime parameter for its greeting, and we didn't provide one as part of this deployment yet. We could edit `log-flow-docker-deployment.yaml` to add a parameter and apply the edited YAML to update the deployment on the API.

Instead, let's edit the deployment through the Prefect UI. Select **log-flow/log-flow-docker** to see the deployment's details.

![Viewing the Docker deployment details in the Prefect UI](/img/tutorials/docker-deployment-details.png)
![Viewing the Docker deployment details in the Prefect UI](../img/tutorials/docker-deployment-details.png)

Select the menu next to **Run**, then select **Edit** to edit the deployment.

Scroll down to the **Parameters** section and provide a value for the `name` parameter. We used "Ford Prefect" here.

![Editing the Docker deployment details in the Prefect UI](/img/tutorials/edit-docker-deployment.png)
![Editing the Docker deployment details in the Prefect UI](../img/tutorials/edit-docker-deployment.png)

Select **Save** to save these changes to the deployment.

Expand Down Expand Up @@ -181,7 +181,7 @@ Let's create a flow run for this deployment. The flow run will execute in a Dock

On the deployment details page, select **Run**, then select **Now with defaults**. This creates a new flow run using the default parameters and other settings.

![Running the Docker deployment from the Prefect UI](/img/tutorials/run-docker-deployment.png)
![Running the Docker deployment from the Prefect UI](../img/tutorials/run-docker-deployment.png)

Go to the terminal session running the Prefect agent. You should see logged output showing:

Expand Down Expand Up @@ -214,7 +214,7 @@ Collecting s3fs

In the Prefect Orion UI, go to the **Flow Runs** page and select the flow run. You should see the "Hello Ford Prefect!" log message created by the flow running in the Docker container!

![Log messages from the deployment flow run.](/img/tutorials/docker-flow-log.png)
![Log messages from the deployment flow run.](../img/tutorials/docker-flow-log.png)

## Cleaning up

Expand Down
2 changes: 1 addition & 1 deletion docs/tutorials/first-steps.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -230,7 +230,7 @@ $ prefect orion start

Open the URL for the Orion UI ([http://127.0.0.1:4200](http://127.0.0.1:4200) by default) in a browser. You should see all of the runs that we have run throughout this tutorial, including one for `common_flow`:

![Viewing the orchestrated flow runs in the Orion UI.](/img/tutorials/first-steps-ui.png)
![Viewing the orchestrated flow runs in the Orion UI.](../img/tutorials/first-steps-ui.png)

The Prefect UI and Prefect Cloud provide an overview of all of your flows, flow runs, and task runs, plus a lot more. For details on using the Prefect UI, see the [Prefect UI & Prefect Cloud](/ui/overview/) documentation.

Expand Down
8 changes: 4 additions & 4 deletions docs/tutorials/kubernetes-flow-runner.md.old
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -244,11 +244,11 @@ Created flow run 'poetic-scorpion' (adb711df-e005-41c7-a822-9cb3ae2704f4)

You can also run the flow from the Prefect Orion UI. Open a browser tab and navigate to [http://127.0.0.1:4200](http://127.0.0.1:4200). You should see the flow run deployment “my-kubernetes-flow” and a successful flow run.

![Screenshot showing the "my-kubernetes-flow" flow](/img/tutorials/k8s-test-flow.png)
![Screenshot showing the "my-kubernetes-flow" flow](../img/tutorials/k8s-test-flow.png)

Click **Deployments** to see the entry for this deployment, `k8s-example`. You can run the flow interactively using the **Quick Run** button.

![Screenshot showing deployed “k8s-example” deployment](/img/tutorials/k8s-test-deploy.png)
![Screenshot showing deployed “k8s-example” deployment](../img/tutorials/k8s-test-deploy.png)

Go ahead and kick off an ad-hoc flow run: click **Quick Run** to run the deployment a second time.

Expand All @@ -258,11 +258,11 @@ Let's take a closer look at the `my-kubernetes-flow` flow runs we created from t

Click **Flow Runs** to see that we did, in fact, create two flow runs that executed as Kubernetes Jobs.

![Screenshot showing flow runs for “k8s-example”](/img/tutorials/k8s-flow-runs.png)
![Screenshot showing flow runs for “k8s-example”](../img/tutorials/k8s-flow-runs.png)

Now select one of the flow runs by clicking on the flow run name &mdash; in this case I clicked "poetic-scorpion". Your flow names will be different.

![Screenshot showing details for the "poetic-scorpion" flow run](/img/tutorials/k8s-flow-run-logs.png)
![Screenshot showing details for the "poetic-scorpion" flow run](../img/tutorials/k8s-flow-run-logs.png)

Go to the **Logs** tab of your flow run. You should see the "Hello from Kubernetes!" log message created by the flow running in Kubernetes!

Expand Down
2 changes: 1 addition & 1 deletion docs/tutorials/orion.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -166,7 +166,7 @@ See the [Database](/concepts/database/) documentation for further details on cho

The [Prefect UI](/ui/overview/) comes prepackaged with the Prefect Orion API when you serve it. By default it can be found at `http://127.0.0.1:4200/`:

![Prefect Orion UI dashboard.](/img/ui/orion-dashboard.png)
![Prefect Orion UI dashboard.](../img/ui/orion-dashboard.png)

The UI enables you to track and manage your flows, runs, and deployments and additionally allows you to filter by names, tags, and other metadata to quickly find the information you are looking for.

Expand Down
12 changes: 6 additions & 6 deletions docs/tutorials/storage.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -69,17 +69,17 @@ Most users will find it easiest to configure new storage blocks through the Pref

You can see any previously configured storage blocks by opening the Prefect UI and navigating to the **Blocks** page.

![Viewing a list of previously configured storage blocks in the Prefect UI](/img/tutorials/storage-blocks.png)
![Viewing a list of previously configured storage blocks in the Prefect UI](../img/tutorials/storage-blocks.png)

To create a new block, select the **+** button on this page, or if you haven't previously created any blocks, **New Block**. Prefect displays a page of available block types.

![Viewing a list of block types in the Prefect UI](/img/tutorials/choose-blocks.png)
![Viewing a list of block types in the Prefect UI](../img/tutorials/choose-blocks.png)

For this tutorial example, we'll use the AWS S3 block as an example. If you use a different cloud storage service or solution, feel free to use the appropriate block type. The process is similar for all blocks, though the configuration options are slightly different, reflecting the authentication requirements of different cloud services.

Scroll down the list of blocks and find the **S3** block, then select **Add +** to configure a new storage block based on this block type. Prefect displays a **Create** page that enables specifying storage settings.

![Configurating an S3 storage block in the Prefect UI](/img/tutorials/s3-block-configuration.png)
![Configuring an S3 storage block in the Prefect UI](../img/tutorials/s3-block-configuration.png)

Enter the configuration for your storage.

Expand All @@ -100,7 +100,7 @@ In this example we've specified a storage location that could be used by the flo

Select **Create** to create the new storage block. Prefect displays the details of the new block, including a code example for using the block within your flow code.

![Viewing details of a new S3 storage block in the Prefect UI](/img/tutorials/new-storage-block.png)
![Viewing details of a new S3 storage block in the Prefect UI](../img/tutorials/new-storage-block.png)

!!! tip "Blocks and deployments are specific to a server or Prefect Cloud workspace"
Note that, if you ran through this tutorial on a local Prefect Orion server instance, the storage and infrastructure blocks you created would not also be configured on Prefect Cloud. You must configure new storage and infrastructure blocks for any Prefect Cloud workspace.
Expand Down Expand Up @@ -168,13 +168,13 @@ Most users will find it easiest to configure new infrastructure blocks through t

You can see any previously configured storage blocks by opening the Prefect UI and navigating to the **Blocks** page. To create a new infrastructure block, select the **+** button on this page. Prefect displays a page of available block types. Select **run-infrastructure** from the **Capability** list to filter to just the infrastructure blocks.

![Viewing a list of infrastructure block types in the Prefect UI](/img/tutorials/infrastructure-blocks.png)
![Viewing a list of infrastructure block types in the Prefect UI](../img/tutorials/infrastructure-blocks.png)

Use these base blocks to create your own infrastructure blocks containing the settings needed to run flows in your environment.

For example, find the **Docker Container** block, then select **Add +** to see the options for a Docker infrastructure block.

![Viewing a list of infrastructure block types in the Prefect UI](/img/tutorials/docker-infrastructure.png)
![Viewing a list of infrastructure block types in the Prefect UI](../img/tutorials/docker-infrastructure.png)

We're not going to create a custom infrastructure block until a later tutorial, so select **Cancel** to close the form.

Expand Down
2 changes: 1 addition & 1 deletion docs/ui/audit-log.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -35,7 +35,7 @@ See the [Prefect Cloud plans](https://www.prefect.io/pricing) to learn more abou

Within your organization, select the **Audit Log** page to view audit logs.

![Viewing audit logs for an organization in the Prefect Cloud UI.](/img/ui/audit-log.png)
![Viewing audit logs for an organization in the Prefect Cloud UI.](../img/ui/audit-log.png)

Organization admins can view audit logs for:

Expand Down
Loading