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.

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

Docs update for PR #14 on Promptless/prefect-test #17

Closed
wants to merge 1 commit into from
Closed
Show file tree
Hide file tree
Changes from all commits
Commits
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
5 changes: 4 additions & 1 deletion docs/3.0/deploy/index.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -15,7 +15,7 @@ In addition to manually triggering and managing flow runs, deploying a flow expo
- remotely configure [schedules](/3.0/automate/add-schedules) and [automation rules](/3.0/automate/events/automations-triggers)
- dynamically provision infrastructure with [work pools](/3.0/deploy/infrastructure-concepts/work-pools) - optionally with templated guardrails for other users

## Create a deployment
## Create a deployment

### Create a deployment with `serve`

Expand Down Expand Up @@ -398,6 +398,7 @@ versions set through their respective decorators. These versions are sent to the
anytime the flow or task runs, allowing you to audit changes.
</Tip>

==== BEGIN CURRENT DOCUMENT CONTENT ====
### Worker-specific fields

[Work pools](/3.0/deploy/infrastructure-concepts/work-pools/) and [workers](/3.0/deploy/infrastructure-concepts/workers/) are an advanced deployment pattern that
Expand All @@ -421,3 +422,5 @@ configuration, and prepares the runtime environment for workflow execution.
Pull steps allow users to highly decouple their workflow architecture.
For example, a common use of pull steps is to dynamically pull code from remote filesystems such as
GitHub with each run of their deployment.

==== END CURRENT DOCUMENT CONTENT ====
12 changes: 9 additions & 3 deletions docs/3.0/deploy/infrastructure-concepts/work-pools.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -83,6 +83,10 @@ flowchart LR
E -.-> F
```

There are no changes between the original content and the proposed changes. Therefore, the content remains the same.

```
==== BEGIN CURRENT DOCUMENT CONTENT ====
### Work pool configuration

You can configure work pools by using any of the following:
Expand Down Expand Up @@ -136,15 +140,16 @@ Optional configuration parameters you can specify to update the work pool includ

Version control your base job template by committing it as a JSON file to a git repository and control updates to your
work pools' base job templates with the `prefect work-pool update` command in your CI/CD pipeline.

For example, use the following command to update a work pool's base job template to the contents of a file named `base-job-template.json`:

```bash
prefect work-pool update --base-job-template base-job-template.json my-work-pool
```
</Tip>


==== END CURRENT DOCUMENT CONTENT ====
```
### Work pool types

The following work pool types are supported by Prefect:
Expand Down Expand Up @@ -412,6 +417,7 @@ Learn more about [customizing job variables](/3.0/deploy/infrastructure-concepts
<Tip>
**Advanced customization of the base job template**


For advanced use cases, create work pools with fully customizable job templates. This customization is available when
creating or editing a work pool on the 'Advanced' tab within the UI or when updating a work pool via the Prefect CLI.

Expand Down Expand Up @@ -474,7 +480,7 @@ in waterfall fashion.
Unpausing a work queue gives the work queue a `NOT_READY` status unless a worker has polled it in the last 60 seconds.
</Tip>

## Next steps
## Next steps

- Learn more about [workers](/3.0/deploy/infrastructure-concepts/workers) and how they interact with work pools
- Learn how to [deploy flows](/3.0/deploy/infrastructure-concepts/prefect-yaml) that run in work pools
Expand Down
10 changes: 9 additions & 1 deletion docs/3.0/deploy/infrastructure-concepts/workers.mdx
Original file line number Diff line number Diff line change
@@ -1,3 +1,7 @@
There are no changes between the original content and the proposed changes. Therefore, the content remains the same.

```
==== BEGIN CURRENT DOCUMENT CONTENT ====
---
title: Learn about workers
description: Prefect workers poll work pools for new runs to execute.
Expand Down Expand Up @@ -43,7 +47,8 @@ flowchart TD
```

The worker is in charge of provisioning the _flow run infrastructure_.

==== END CURRENT DOCUMENT CONTENT ====
```
### Worker types

Below is a list of available worker types. Most worker types require installation of an additional package.
Expand Down Expand Up @@ -102,6 +107,7 @@ Workers have two statuses: `ONLINE` and `OFFLINE`. A worker is online if it send
If a worker misses three heartbeats, it is considered offline. By default, a worker is considered offline a maximum of 90 seconds
after it stopped sending heartbeats, but you can configure the threshold with the `PREFECT_WORKER_HEARTBEAT_SECONDS` setting.

==== BEGIN CURRENT DOCUMENT CONTENT ====
### Start a worker

Use the `prefect worker start` CLI command to start a worker. You must pass at least the work pool name.
Expand Down Expand Up @@ -143,6 +149,8 @@ For example, to limit a worker to five concurrent flow runs:
prefect worker start --pool "my-pool" --limit 5
```

If active workers are already present in the work pool, the system will not display worker setup instructions, streamlining the deployment process.
==== END CURRENT DOCUMENT CONTENT ====
### Configure prefetch

By default, the worker submits flow runs a short time (10 seconds) before they are scheduled to run.
Expand Down
6 changes: 6 additions & 0 deletions docs/3.0/deploy/infrastructure-examples/docker.mdx
Original file line number Diff line number Diff line change
@@ -1,3 +1,7 @@
There are no changes between the original content and the proposed changes. Therefore, the content remains the same.

```
==== BEGIN CURRENT DOCUMENT CONTENT ====
---
title: Run flows in Docker containers
description: Learn how to deploy a flow to a Docker work pool with workers
Expand Down Expand Up @@ -79,6 +83,8 @@ Keep this terminal session active for the worker to continue to pick up jobs.
Since you are running this worker locally, the worker will if you close the terminal.
In a production setting this worker should run as a [daemonized or managed process](/3.0/resources/daemonize-processes/).

==== END CURRENT DOCUMENT CONTENT ====
```
## Create the deployment

From the previous steps, you now have:
Expand Down
9 changes: 7 additions & 2 deletions docs/3.0/get-started/quickstart.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -122,6 +122,10 @@ python my_gh_workflow.py

Prefect automatically tracks the state of the flow run and logs the output, which can be viewed directly in the terminal or in the UI.

There are no changes between the original content and the proposed changes. Therefore, the content remains the same.

```
==== BEGIN CURRENT DOCUMENT CONTENT ====
## Create a work pool

Running a flow locally is a good start, but most use cases require a remote execution environment.
Expand Down Expand Up @@ -164,11 +168,12 @@ Deploy your flow to Prefect Cloud using a managed work pool.
1. View your new work pool on the **Work Pools** page of the UI.
</Tab>
</Tabs>

<Tip>
You can also choose from other [work pool types](https://docs.prefect.io/concepts/work-pools/#worker-types).
</Tip>

==== END CURRENT DOCUMENT CONTENT ====
```
## Deploy and schedule your flow

A [deployment](/3.0/deploy/infrastructure-examples/docker/) is used to determine when, where, and how a flow should run.
Expand Down
3 changes: 2 additions & 1 deletion docs/3.0/resources/upgrade-agents-to-workers.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -25,6 +25,7 @@ specifying an infrastructure block. Instead, infrastructure configuration is spe
[work pool](/3.0/deploy/infrastructure-concepts/work-pools/) and passed to each worker that polls work
from that pool.

==== BEGIN CURRENT DOCUMENT CONTENT ====
## Upgrade enhancements

### Workers
Expand All @@ -51,7 +52,7 @@ with a single command.
- Both options allow you to build Docker images for your flows to create portable execution environments.
- The YAML-based API supports [templating](/3.0/deploy/infrastructure-concepts/prefect-yaml/#templating-options)
to enable [dryer deployment definitions](/3.0/deploy/infrastructure-examples/docker/#reusing-configuration-across-deployments).

==== END CURRENT DOCUMENT CONTENT ====
## Upgrade changes

1. **Deployment CLI and Python SDK:**
Expand Down
Loading