PrefectHQ / prefect

Prefect is a workflow orchestration framework for building resilient data pipelines in Python.
https://prefect.io
Apache License 2.0
15.94k stars 1.56k forks source link

Do not provide worker setup instructions in deployment to healthy work-pools #15513

Open cbrown1234 opened 2 hours ago

cbrown1234 commented 2 hours ago

Describe the current behavior

Instructions for setting up a worker are always included when deploying a deployment.

Successfully created/updated all deployments!

                        Deployments
┏━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━┳━━━━━━━━━┳━━━━━━━━━┓
┃ Name                                 ┃ Status  ┃ Details ┃
┡━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━╇━━━━━━━━━╇━━━━━━━━━┩
│ example-flow/Local Dev (chris-brown) │ applied │         │
└──────────────────────────────────────┴─────────┴─────────┘

To execute flow runs from this deployment, start a worker in a separate terminal
that pulls work from the 'local-dev-docker-chris-brown' work pool:

        $ prefect worker start --pool 'local-dev-docker-chris-brown'

To schedule a run for this deployment, use the following command:

        $ prefect deployment run 'example-flow/Local Dev (chris-brown)'

You can also run your flow via the Prefect UI: https://<redacted>

Describe the proposed behavior

Do not include the details for the setup of the worker if the deployment was to a healthy work-pool with existing workers running

Successfully created/updated all deployments!

                        Deployments
┏━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━┳━━━━━━━━━┳━━━━━━━━━┓
┃ Name                                 ┃ Status  ┃ Details ┃
┡━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━╇━━━━━━━━━╇━━━━━━━━━┩
│ example-flow/Local Dev (chris-brown) │ applied │         │
└──────────────────────────────────────┴─────────┴─────────┘

To schedule a run for this deployment, use the following command:

        $ prefect deployment run 'example-flow/Local Dev (chris-brown)'

You can also run your flow via the Prefect UI: https://<redacted>

Example Use

No response

Additional context

We found that the current behaviour is quite confusing to new users coming to an existing setup with working workers.

I discussed issue with Chris (CTO) at the London PACC and it was his suggestion for the enhancement, so he might have already raised an issue for this, so apologies if this is a duplicate. Would be great to have this for the next release of the self-hosted cloud from the perspective of Genomics England

cicdw commented 2 hours ago

Thanks for opening this issue @cbrown1234! Will update here on progress, should be doable for the next release (next week).