forked from PrefectHQ/prefect
-
Notifications
You must be signed in to change notification settings - Fork 0
/
mkdocs.yml
414 lines (412 loc) · 20.8 KB
/
mkdocs.yml
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
site_name: Prefect Docs
site_url: https://docs.prefect.io/
repo_url: https://github.com/PrefectHQ/prefect
edit_uri: edit/main/docs
extra_css:
- stylesheets/theme.css
- stylesheets/admonitions.css
- stylesheets/api_ref.css
- stylesheets/rest_ref.css
- stylesheets/syntax_highlights.css
- stylesheets/termynal.css
- stylesheets/extra.css
extra_javascript:
- js/custom.js
- js/termynal.js
markdown_extensions:
- admonition
- attr_list
- codehilite
- md_in_html
- meta
- pymdownx.highlight:
use_pygments: true
- pymdownx.superfences:
custom_fences:
- name: mermaid
class: mermaid
format: !!python/name:pymdownx.superfences.fence_code_format
- pymdownx.details
- pymdownx.tabbed:
alternate_style: true
- toc:
permalink: true
- pymdownx.snippets
- pymdownx.emoji:
emoji_index: !!python/name:material.extensions.emoji.twemoji
emoji_generator: !!python/name:material.extensions.emoji.to_svg
theme:
name: material
custom_dir: docs/overrides
favicon: img/favicon.png
features:
- announce.dismiss
- content.action.edit
- content.code.copy
- navigation.tabs.sticky
- search.suggest
- search.highlight
- navigation.path
- navigation.indexes
- content.tabs.link
font:
text: Inter
code: Source Code Pro
icon:
repo: fontawesome/brands/github
edit: material/pencil
logo: img/logos/prefect-logo-white.svg
palette:
- media: "(prefers-color-scheme: light)"
accent: "#0225AC"
primary: "#0225AC"
scheme: default
toggle:
icon: material/weather-sunny
name: Switch to dark mode
- media: "(prefers-color-scheme: dark)"
accent: "#0225AC"
primary: "#0225AC"
scheme: slate
toggle:
icon: material/weather-night
name: Switch to light mode
validation:
absolute_links: ignore
unrecognized_links: ignore
plugins:
mike:
canonical_version: latest
version_selector: true
alias_type: copy
autorefs: {}
mkdocstrings:
handlers:
python:
options:
show_root_heading: True
show_object_full_path: False
show_category_heading: False
show_bases: True
show_submodules: False
show_if_no_docstring: False
show_signature: False
heading_level: 1
filters: ["!^_"]
render_swagger: {}
search: {}
gen-files:
scripts:
- docs/integrations/generate_catalog.py
- docs/integrations/generate_catalog.py
- docs/recipes/generate_catalog.py
watch:
- mkdocs.yml
- mkdocs.insiders.yml
- src/prefect/
extra:
generator: false
version:
provider: mike
analytics:
provider: custom
property: G-3M31G9B0QJ
amplitude_key: !ENV [AMPLITUDE_API_KEY, ""]
amplitude_url:
!ENV [AMPLITUDE_URL, "https://api2.amplitude.com/2/httpapi"]
feedback:
title: Was this page helpful?
ratings:
- icon: material/emoticon-happy-outline
name: This page was helpful
data: 1
note: >-
Thank you for your feedback!
- icon: material/emoticon-sad-outline
name: This page could be improved
data: 0
note: >-
Thank you for your feedback! Feel free to
<a href="https://github.com/PrefectHQ/prefect/issues/new?assignees=&labels=docs%2Cstatus%3Atriage&projects=&template=4_docs_change.yaml"
target="_blank"> open an issue </a> with more detail.
# social:
# - icon: fontawesome/brands/slack
# link: https://www.prefect.io/slack/
# - icon: fontawesome/brands/discourse
# link: https://discourse.prefect.io/
# - icon: fontawesome/brands/youtube
# link: https://www.youtube.com/c/PrefectIO/videos
# - icon: fontawesome/regular/newspaper
# link: https://prefect.io/guide/
# - icon: fontawesome/brands/twitter
# link: https://twitter.com/PrefectIO
# - icon: fontawesome/brands/linkedin
# link: https://www.linkedin.com/company/prefect/
# - icon: fontawesome/brands/github
# link: https://github.com/PrefectHQ/prefect
# - icon: fontawesome/brands/docker
# link: https://hub.docker.com/r/prefecthq/prefect/
# - icon: fontawesome/brands/python
# link: https://pypi.org/project/prefect/
nav:
- Getting Started:
- index.md
- Installation: getting-started/installation.md
- Quickstart: getting-started/quickstart.md
- Tutorial:
- tutorial/index.md
- Flows: tutorial/flows.md
- Tasks: tutorial/tasks.md
- Deployments: tutorial/deployments.md
- Work Pools: tutorial/work-pools.md
- Workers: tutorial/workers.md
- How-to Guides:
- guides/index.md
- Development:
- Hosting: guides/host.md
- Profiles & Settings: guides/settings.md
- Testing: guides/testing.md
- Global Concurrency Limits: guides/global-concurrency-limits.md
- Runtime Context: guides/runtime-context.md
- Variables: guides/variables.md
- Prefect Client: guides/using-the-client.md
- Interactive Workflows: guides/creating-interactive-workflows.md
- Automations: guides/automations.md
- Webhooks: guides/webhooks.md
- Terraform Provider: https://registry.terraform.io/providers/PrefectHQ/prefect/latest/docs/guides/getting-started
- CI/CD: guides/ci-cd.md
- Specifying Upstream Dependencies: guides/specifying-upstream-dependencies.md
- Recipes: recipes/recipes.md
- Execution:
- Docker: guides/docker.md
- State Change Hooks: guides/state-change-hooks.md
- Dask & Ray: guides/dask-ray-task-runners.md
- Read and Write Data: guides/moving-data.md
- Big Data: guides/big-data.md
- Logging: guides/logs.md
- Troubleshooting: guides/troubleshooting.md
- Managed Execution: guides/managed-execution.md
- Shell Commands: guides/cli-shell.md
- Work Pools:
- Deploying Flows to Work pools and Workers: guides/prefect-deploy.md
- Upgrade from Agents to Workers: guides/upgrade-guide-agents-to-workers.md
- Flow Code Storage: guides/deployment/storage-guide.md
- Kubernetes: guides/deployment/kubernetes.md
- Serverless Push Work Pools: guides/deployment/push-work-pools.md
- Serverless Work Pools with Workers: guides/deployment/serverless-workers.md
- Daemonize Processes: guides/deployment/daemonize.md
- Custom Workers: guides/deployment/developing-a-new-worker-type.md
- Job Variable Overrides: guides/deployment/overriding-job-variables.md
- Concepts:
- concepts/index.md
- Flows: concepts/flows.md
- Tasks: concepts/tasks.md
- Deployments: concepts/deployments.md
- Work Pools & Workers: concepts/work-pools.md
- Schedules: concepts/schedules.md
- Results: concepts/results.md
- Artifacts: concepts/artifacts.md
- States: concepts/states.md
- Blocks: concepts/blocks.md
- Task Runners: concepts/task-runners.md
- Automations: concepts/automations.md
- Block and Agent-Based Deployments:
- Deployments: concepts/deployments-block-based.md
- Infrastructure: concepts/infrastructure.md
- Storage: concepts/storage.md
- Agents: concepts/agents.md
- Cloud:
- cloud/index.md
- Workspaces: cloud/workspaces.md
- Users:
- cloud/users/index.md
- Roles (RBAC): cloud/users/roles.md
- API Keys: cloud/users/api-keys.md
- Service Accounts: cloud/users/service-accounts.md
- Single Sign-On (SSO): cloud/users/sso.md
- Audit Log: cloud/users/audit-log.md
- Object-Level Access Control Lists: cloud/users/object-access-control-lists.md
- Teams: cloud/users/teams.md
- API Rate Limits: cloud/rate-limits.md
- Connecting & Troubleshooting: cloud/connecting.md
- Events: cloud/events.md
- Incidents: cloud/incidents.md
- Integrations:
- integrations/index.md
- Using Integrations: integrations/usage.md
- Contributing Integrations: integrations/contribute.md
- API Reference:
- api-ref/index.md
- Python SDK:
- api-ref/python/index.md
- "prefect.agent": api-ref/prefect/agent.md
- "prefect.artifacts": api-ref/prefect/artifacts.md
- "prefect.blocks":
- "core": api-ref/prefect/blocks/core.md
- "fields": api-ref/prefect/blocks/fields.md
- "kubernetes": api-ref/prefect/blocks/kubernetes.md
- "notifications": api-ref/prefect/blocks/notifications.md
- "system": api-ref/prefect/blocks/system.md
- "webhook": api-ref/prefect/blocks/webhook.md
- "prefect.client":
- "base": api-ref/prefect/client/base.md
- "cloud": api-ref/prefect/client/cloud.md
- "orchestration": api-ref/prefect/client/orchestration.md
- "schemas": api-ref/prefect/client/schemas.md
- "utilities": api-ref/prefect/client/utilities.md
- "prefect.cli":
- "agent": api-ref/prefect/cli/agent.md
- "artifact": api-ref/prefect/cli/artifact.md
- "block": api-ref/prefect/cli/block.md
- "cloud": api-ref/prefect/cli/cloud.md
- "cloud": api-ref/prefect/cli/cloud.webhook.md
- "concurrency_limit": api-ref/prefect/cli/concurrency_limit.md
- "config": api-ref/prefect/cli/config.md
- "deploy": api-ref/prefect/cli/deploy.md
- "deployment": api-ref/prefect/cli/deployment.md
- "dev": api-ref/prefect/cli/dev.md
- "flow": api-ref/prefect/cli/flow.md
- "flow_run": api-ref/prefect/cli/flow_run.md
- "kubernetes": api-ref/prefect/cli/kubernetes.md
- "profile": api-ref/prefect/cli/profile.md
- "project": api-ref/prefect/cli/project.md
- "root": api-ref/prefect/cli/root.md
- "server": api-ref/prefect/cli/server.md
- "shell": api-ref/prefect/cli/shell.md
- "variable": api-ref/prefect/cli/variable.md
- "work_pool": api-ref/prefect/cli/work_pool.md
- "work_queue": api-ref/prefect/cli/work_queue.md
- "worker": api-ref/prefect/cli/worker.md
- "prefect.context": api-ref/prefect/context.md
- "prefect.concurrency":
- "asyncio": api-ref/prefect/concurrency/asyncio.md
- "common": api-ref/prefect/concurrency/common.md
- "events": api-ref/prefect/concurrency/events.md
- "services": api-ref/prefect/concurrency/services.md
- "sync": api-ref/prefect/concurrency/sync.md
- "prefect.deployments":
- "deployments": api-ref/prefect/deployments/deployments.md
- "base": api-ref/prefect/deployments/base.md
- "runner": api-ref/prefect/deployments/runner.md
- "schedules": api-ref/prefect/deployments/schedules.md
- "steps.core": api-ref/prefect/deployments/steps/core.md
- "steps.pull": api-ref/prefect/deployments/steps/pull.md
- "steps.utility": api-ref/prefect/deployments/steps/utility.md
- "prefect.engine": api-ref/prefect/engine.md
- "prefect.exceptions": api-ref/prefect/exceptions.md
- "prefect.events": api-ref/prefect/events.md
- "prefect.filesystems": api-ref/prefect/filesystems.md
- "prefect.flows": api-ref/prefect/flows.md
- "prefect.flow_runs": api-ref/prefect/flow_runs.md
- "prefect.futures": api-ref/prefect/futures.md
- "prefect.infrastructure": api-ref/prefect/infrastructure.md
- "prefect.input":
- "actions": api-ref/prefect/input/actions.md
- "run_input": api-ref/prefect/input/run_input.md
- "prefect.logging":
- "configuration": api-ref/prefect/logging/configuration.md
- "formatters": api-ref/prefect/logging/formatters.md
- "handlers": api-ref/prefect/logging/handlers.md
- "highlighters": api-ref/prefect/logging/highlighters.md
- "loggers": api-ref/prefect/logging/loggers.md
- "prefect.manifests": api-ref/prefect/manifests.md
- "prefect.runner":
- "runner": api-ref/prefect/runner/runner.md
- "server": api-ref/prefect/runner/server.md
- "storage": api-ref/prefect/runner/storage.md
- "utils": api-ref/prefect/runner/utils.md
- "prefect.runtime":
- "flow_run": api-ref/prefect/runtime/flow_run.md
- "deployment": api-ref/prefect/runtime/deployment.md
- "task_run": api-ref/prefect/runtime/task_run.md
- "prefect.serializers": api-ref/prefect/serializers.md
- "prefect.settings": api-ref/prefect/settings.md
- "prefect.software": api-ref/prefect/software.md
- "prefect.states": api-ref/prefect/states.md
- "prefect.task_runners": api-ref/prefect/task-runners.md
- "prefect.tasks": api-ref/prefect/tasks.md
- "prefect.testing": api-ref/prefect/testing.md
- "prefect.utilities":
- "annotations": api-ref/prefect/utilities/annotations.md
- "asyncutils": api-ref/prefect/utilities/asyncutils.md
- "callables": api-ref/prefect/utilities/callables.md
- "collections": api-ref/prefect/utilities/collections.md
- "compat": api-ref/prefect/utilities/compat.md
- "context": api-ref/prefect/utilities/context.md
- "dispatch": api-ref/prefect/utilities/dispatch.md
- "dockerutils": api-ref/prefect/utilities/dockerutils.md
- "filesystem": api-ref/prefect/utilities/filesystem.md
- "hashing": api-ref/prefect/utilities/hashing.md
- "importtools": api-ref/prefect/utilities/importtools.md
- "math": api-ref/prefect/utilities/math.md
- "names": api-ref/prefect/utilities/names.md
- "processutils": api-ref/prefect/utilities/processutils.md
- "pydantic": api-ref/prefect/utilities/pydantic.md
- "render_swagger": api-ref/prefect/utilities/render_swagger.md
- "services": api-ref/prefect/utilities/services.md
- "slugify": api-ref/prefect/utilities/slugify.md
- "templating": api-ref/prefect/utilities/templating.md
- "text": api-ref/prefect/utilities/text.md
- "visualization": api-ref/prefect/utilities/visualization.md
- "prefect.variables": api-ref/prefect/variables.md
- "prefect.workers":
- "base": api-ref/prefect/workers/base.md
- "block": api-ref/prefect/workers/block.md
- "process": api-ref/prefect/workers/process.md
- "server": api-ref/prefect/workers/server.md
- "utilities": api-ref/prefect/workers/utilities.md
- REST API:
- api-ref/rest-api/index.md
- Prefect Cloud REST API Reference: https://app.prefect.cloud/api/docs
- Prefect Server REST API Reference: api-ref/rest-api-reference.md
- Server API:
- api-ref/server/index.md
- "API":
- "server.api.admin": api-ref/server/api/admin.md
- "server.api.csrf_token": api-ref/server/api/csrf_token.md
- "server.api.dependencies": api-ref/server/api/dependencies.md
- "server.api.deployments": api-ref/server/api/deployments.md
- "server.api.flows": api-ref/server/api/flows.md
- "server.api.flow_runs": api-ref/server/api/flow_runs.md
- "server.api.flow_run_states": api-ref/server/api/flow_run_states.md
- "server.api.middleware": api-ref/server/api/middleware.md
- "server.api.run_history": api-ref/server/api/run_history.md
- "server.api.saved_searches": api-ref/server/api/saved_searches.md
- "server.api.server": api-ref/server/api/server.md
- "server.api.task_runs": api-ref/server/api/task_runs.md
- "server.api.task_run_states": api-ref/server/api/task_run_states.md
- "Models":
- "server.models.csrf_token": api-ref/server/models/csrf_token.md
- "server.models.flows": api-ref/server/models/flows.md
- "server.models.flow_runs": api-ref/server/models/flow_runs.md
- "server.models.flow_run_states": api-ref/server/models/flow_run_states.md
- "server.models.task_runs": api-ref/server/models/task_runs.md
- "server.models.task_run_states": api-ref/server/models/task_run_states.md
- "server.models.deployments": api-ref/server/models/deployments.md
- "server.models.saved_searches": api-ref/server/models/saved_searches.md
- "Orchestration":
- "server.orchestration.rules": api-ref/server/orchestration/rules.md
- "server.orchestration.policies": api-ref/server/orchestration/policies.md
- "server.orchestration.core_policy": api-ref/server/orchestration/core_policy.md
- "server.orchestration.global_policy": api-ref/server/orchestration/global_policy.md
- "Schemas":
- "server.schemas.actions": api-ref/server/schemas/actions.md
- "server.schemas.core": api-ref/server/schemas/core.md
- "server.schemas.filters": api-ref/server/schemas/filters.md
- "server.schemas.responses": api-ref/server/schemas/responses.md
- "server.schemas.schedules": api-ref/server/schemas/schedules.md
- "server.schemas.sorting": api-ref/server/schemas/sorting.md
- "server.schemas.states": api-ref/server/schemas/states.md
- "Services":
- "server.services.late_runs": api-ref/server/services/late_runs.md
- "server.services.loop_service": api-ref/server/services/loop_service.md
- "server.services.scheduler": api-ref/server/services/scheduler.md
- "Utilities":
- "server.utilities.database": api-ref/server/utilities/database.md
- "server.utilities.schemas": api-ref/server/utilities/schemas.md
- "server.utilities.server": api-ref/server/utilities/server.md
- Community:
- community/index.md
- Contributing: contributing/overview.md
- Style: contributing/style.md
- Versioning: contributing/versioning.md