Cade Summers
08/05/2024, 6:22 PMMarvin
08/05/2024, 6:22 PMprefect.yaml
file and some steps to help you configure it!
### Initializing a Deployment Configuration
You can initialize your deployment configuration by running:
prefect init
This command creates a prefect.yaml
file in your project directory. You can use the --recipe
flag to specify a specific setup, or Prefect will guess based on your directory structure.
### Example prefect.yaml
Below is an example structure for the prefect.yaml
file:
# generic metadata
prefect-version: 2.0.0
name: my-project
# preparation steps
build: null
push: null
# runtime steps
pull: null
# deployment configurations
deployments:
- # base metadata
name: my-deployment
version: 1.0
tags: []
description: My deployment description
# flow-specific fields
entrypoint: path/to/flow.py:my_flow
parameters: {}
# infra-specific fields
work_pool: default-agent-pool
### Using Your prefect.yaml
By default, prefect deploy
will use the prefect.yaml
file in the project's root directory. If your file is located elsewhere or has a different name, use the --prefect-file
flag:
prefect deploy --prefect-file path/to/custom_prefect.yaml
More details and initialization recipes can be found in the official documentation on Prefect deploy.
If you're interested in the official Python code example associated with deployments, you can view it here.
Would you like further assistance with deployment issues?