CLI Reference
prefect work-pool
Manage work pools.
prefect work-pool create
Create a new work pool or update an existing one.
Examples:
Create a Kubernetes work pool in a paused state:
$ prefect work-pool create “my-pool” —type kubernetes —paused
Create a Docker work pool with a custom base job template:
$ prefect work-pool create “my-pool” —type docker —base-job-template ./base-job-template.json
Update an existing work pool:
$ prefect work-pool create “existing-pool” —base-job-template ./base-job-template.json —overwrite
Arguments
Arguments
The name of the work pool. [required]
Options
Options
--base-job-template
The path to a JSON file containing the base job template to use. If unspecified, Prefect will use the default base job template for the given worker type.
--paused
Whether or not to create the work pool in a paused state.
-t
The type of work pool to create.
--set-as-default
Whether or not to use the created work pool as the local default for deployment.
--provision-infrastructure
Whether or not to provision infrastructure for the work pool if supported for the given work pool type.
--overwrite
Whether or not to overwrite an existing work pool with the same name.
prefect work-pool ls
List work pools.
Examples:
$ prefect work-pool ls
Options
Options
--verbose
Show additional information about work pools.
prefect work-pool inspect
Inspect a work pool.
Examples:
$ prefect work-pool inspect “my-pool”
$ prefect work-pool inspect “my-pool” —output json
Arguments
Arguments
The name of the work pool to inspect. [required]
Options
Options
--output
Specify an output format. Currently supports: json
prefect work-pool pause
Pause a work pool.
Examples:
$ prefect work-pool pause “my-pool”
Arguments
Arguments
The name of the work pool to pause. [required]
prefect work-pool resume
Resume a work pool.
Examples:
$ prefect work-pool resume “my-pool”
Arguments
Arguments
The name of the work pool to resume. [required]
prefect work-pool update
Update a work pool.
Examples:
$ prefect work-pool update “my-pool”
Arguments
Arguments
The name of the work pool to update. [required]
Options
Options
--base-job-template
The path to a JSON file containing the base job template to use. If unspecified, Prefect will use the default base job template for the given worker type. If None, the base job template will not be modified.
--concurrency-limit
The concurrency limit for the work pool. If None, the concurrency limit will not be modified.
--description
The description for the work pool. If None, the description will not be modified.
prefect work-pool provision-infrastructure
Provision infrastructure for a work pool.
Examples:
$ prefect work-pool provision-infrastructure “my-pool”$ prefect work-pool provision-infra “my-pool”
Arguments
Arguments
The name of the work pool to provision infrastructure for. [required]
prefect work-pool provision-infra
Provision infrastructure for a work pool.
Examples:
$ prefect work-pool provision-infrastructure “my-pool”$ prefect work-pool provision-infra “my-pool”
Arguments
Arguments
The name of the work pool to provision infrastructure for. [required]
prefect work-pool delete
Delete a work pool.
Examples:
$ prefect work-pool delete “my-pool”
Arguments
Arguments
The name of the work pool to delete. [required]
prefect work-pool set-concurrency-limit
Set the concurrency limit for a work pool.
Examples:
$ prefect work-pool set-concurrency-limit “my-pool” 10
prefect work-pool clear-concurrency-limit
Clear the concurrency limit for a work pool.
Examples:
$ prefect work-pool clear-concurrency-limit “my-pool”
Arguments
Arguments
The name of the work pool to update. [required]
prefect work-pool get-default-base-job-template
Get the default base job template for a given work pool type.
Examples:
$ prefect work-pool get-default-base-job-template —type kubernetes
prefect work-pool preview
Preview the work pool’s scheduled work for all queues.
Examples:
$ prefect work-pool preview “my-pool” —hours 24
Arguments
Arguments
The name or ID of the work pool to preview
Options
Options
-h
The number of hours to look ahead; defaults to 1 hour
prefect work-pool storage
EXPERIMENTAL: Manage work pool storage.
prefect work-pool storage inspect
EXPERIMENTAL: Inspect the storage configuration for a work pool.
Arguments
Arguments
The name of the work pool to display storage configuration for. [required]
Options
Options
--output
Specify an output format. Currently supports: json
Example: prefect work-pool storage inspect “my-pool” —output json
prefect work-pool storage configure
EXPERIMENTAL: Configure work pool storage.
prefect work-pool storage configure s3
EXPERIMENTAL: Configure AWS S3 storage for a work pool.
Examples:
$ prefect work-pool storage configure s3 “my-pool” —bucket my-bucket —aws-credentials-block-name my-credentials
Arguments
Arguments
The name of the work pool to configure storage for. [required]
prefect work-pool storage configure gcs
EXPERIMENTAL: Configure Google Cloud storage for a work pool.
Examples:
$ prefect work-pool storage configure gcs “my-pool” —bucket my-bucket —gcp-credentials-block-name my-credentials
Arguments
Arguments
The name of the work pool to configure storage for. [required]
prefect work-pool storage configure azure-blob-storage
EXPERIMENTAL: Configure Azure Blob Storage for a work pool.
Examples:
$ prefect work-pool storage configure azure-blob-storage “my-pool” —container my-container —azure-blob-storage-credentials-block-name my-credentials