<@ULVA73B9P> What is a good name of a deployment t...
# ask-marvin
a
@Marvin What is a good name of a deployment that is schedules? Should scheduled deployments be prefixed auto?
m
thought for 29.0 seconds
There's no official requirement or convention to prefix scheduled deployments with "auto" or any other specific prefix. The key is to choose clear, descriptive names that help you and your team understand the deployment's purpose. Here are some recommended practices for naming deployments: 1. Use descriptive names that indicate: - The purpose of the flow - The schedule frequency (if relevant) - The environment or context (if you have multiple) 2. Examples of good deployment names: -
daily-customer-data-sync
-
hourly-metrics-aggregation
-
weekly-cleanup-process
-
monthly-billing-report
3. Keep names: - Lowercase (to avoid case-sensitivity issues) - Use hyphens or underscores consistently - Brief but meaningful - Easy to type in CLI commands While you could use a prefix like
auto-
or
scheduled-
, it's not necessary since you can always query and filter deployments by their schedule status through the Prefect UI or API. The most important thing is that the name clearly communicates the deployment's purpose to anyone who might need to work with it. Remember that deployment names need to be unique within your workspace for a given flow, so you might want to include distinguishing characteristics if you have multiple similar deployments.
a
@Marvin Reason for calling it
auto-
was to be able to distinguish with standalone deployments and ones that run several deployments in itself. For example, an auto-deployment that initiates first ingest deployment and then dbt transformation deployment
m
thought for 100.3 seconds
Your intuition about using a prefix to distinguish orchestrator deployments is actually quite sensible! Given your specific use case of having deployments that coordinate other deployments, here's a recommended naming structure: 1. Orchestrator/Controller Deployments: - Prefix:
auto-
or
orch-
or
ctrl-
- Example:
auto-ingest-and-transform
- Example:
orch-daily-pipeline
2. Individual Task Deployments: - No special prefix, just descriptive names - Example:
raw-data-ingest
- Example:
dbt-transform
This pattern has several benefits: - Clear visual distinction between orchestrator and worker deployments - Easy filtering in UI and CLI - Immediately communicates the deployment's role in the overall system - Makes it easier to manage permissions and monitoring So for your specific example, you might have:
Copy code
auto-daily-pipeline          # The orchestrator deployment
├── raw-data-ingest         # First child deployment
└── dbt-daily-transform     # Second child deployment
This naming convention becomes especially valuable when using Prefect's deployment triggers and automations, as it makes it immediately clear which deployments are entry points versus individual workflow components. Remember that while this naming convention is helpful, you should also leverage Prefect's built-in features like work pools and deployment triggers to manage the actual orchestration logic between these deployments.