Skip to content

Commit 62c22b1

Browse files
Readme description (#163)
* Add links and description * redirect links * add a little more detail to Helm Readme * add formatting * Update README.md * Update README.md * Update README.md * Update README.md --------- Co-authored-by: Jamie Zieziula <jamie.m.dick@gmail.com>
1 parent 09a65b0 commit 62c22b1

File tree

1 file changed

+29
-0
lines changed

1 file changed

+29
-0
lines changed

README.md

+29
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,36 @@
11
# Prefect Helm Charts
22

3+
## Description
4+
5+
This repository contains the official Prefect Helm chart for installing and configuring Prefect on Kubernetes. This chart supports multiple use cases of Prefect on Kubernetes depending on the values provided and chart selected including:
6+
7+
### [Prefect Worker](charts/prefect-worker/)
8+
9+
:rotating_light: Workers are a beta feature and are subject to change in future releases. :rotating_light:
10+
11+
[Workers](https://docs.prefect.io/latest/concepts/work-pools/#worker-overview) are lightweight polling services that retrieve scheduled runs from a work pool and execute them.
12+
13+
Workers are similar to agents, but offer greater control over infrastructure configuration and the ability to route work to specific types of execution environments.
14+
15+
Workers each have a type corresponding to the execution environment to which they will submit flow runs. Workers are only able to join work pools that match their type. As a result, when deployments are assigned to a work pool, you know in which execution environment scheduled flow runs for that deployment will run.
16+
17+
### [Prefect Agent](charts/prefect-agent/)
18+
19+
[Agent](https://docs.prefect.io/latest/concepts/work-pools/#agent-overview) processes are lightweight polling services that get scheduled work from a work pool and deploy the corresponding flow runs.
20+
21+
Agents poll for work every 15 seconds by default. This interval is configurable in your profile settings with the `PREFECT_AGENT_QUERY_INTERVAL` setting.
22+
23+
It is possible for multiple agent processes to be started for a single work pool. Each agent process sends a unique ID to the server to help disambiguate themselves and let users know how many agents are active.
24+
25+
### [Prefect Server](charts/prefect-server/)
26+
27+
[Prefect Server](https://docs.prefect.io/latest/host/#hosting-prefect-server) is an open source backend that makes it easy to observe and orchestrate your Prefect flows.
28+
329
## Usage
430

31+
[Helm](https://helm.sh) must be installed to use the charts.
32+
Please refer to Helm's [documentation](https://helm.sh/docs/) to get started.
33+
534
### TL;DR
635

736
```shell-session

0 commit comments

Comments
 (0)