prefect work-pool

prefect work-pool [OPTIONS] COMMAND [ARGS]...
Manage work pools.

prefect work-pool create

prefect work-pool create [OPTIONS] NAME
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

NAME
string
required
The name of the work pool. [required]

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

prefect work-pool ls [OPTIONS]
List work pools. Examples: $ prefect work-pool ls

Options

--verbose
Show additional information about work pools.

prefect work-pool inspect

prefect work-pool inspect [OPTIONS] NAME
Inspect a work pool. Examples: $ prefect work-pool inspect “my-pool” $ prefect work-pool inspect “my-pool” —output json

Arguments

NAME
string
required
The name of the work pool to inspect. [required]

Options

--output
Specify an output format. Currently supports: json

prefect work-pool pause

prefect work-pool pause [OPTIONS] NAME
Pause a work pool. Examples: $ prefect work-pool pause “my-pool”

Arguments

NAME
string
required
The name of the work pool to pause. [required]

prefect work-pool resume

prefect work-pool resume [OPTIONS] NAME
Resume a work pool. Examples: $ prefect work-pool resume “my-pool”

Arguments

NAME
string
required
The name of the work pool to resume. [required]

prefect work-pool update

prefect work-pool update [OPTIONS] NAME
Update a work pool. Examples: $ prefect work-pool update “my-pool”

Arguments

NAME
string
required
The name of the work pool to update. [required]

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

prefect work-pool provision-infrastructure [OPTIONS] NAME
Provision infrastructure for a work pool. Examples: $ prefect work-pool provision-infrastructure “my-pool”$ prefect work-pool provision-infra “my-pool”

Arguments

NAME
string
required
The name of the work pool to provision infrastructure for. [required]

prefect work-pool provision-infra

prefect work-pool provision-infra [OPTIONS] NAME
Provision infrastructure for a work pool. Examples: $ prefect work-pool provision-infrastructure “my-pool”$ prefect work-pool provision-infra “my-pool”

Arguments

NAME
string
required
The name of the work pool to provision infrastructure for. [required]

prefect work-pool delete

prefect work-pool delete [OPTIONS] NAME
Delete a work pool. Examples: $ prefect work-pool delete “my-pool”

Arguments

NAME
string
required
The name of the work pool to delete. [required]

prefect work-pool set-concurrency-limit

prefect work-pool set-concurrency-limit [OPTIONS] NAME CONCURRENCY_LIMIT
Set the concurrency limit for a work pool. Examples: $ prefect work-pool set-concurrency-limit “my-pool” 10

Arguments

NAME
string
required
The name of the work pool to update. [required]
CONCURRENCY_LIMIT
string
required
The new concurrency limit for the work pool. [required]

prefect work-pool clear-concurrency-limit

prefect work-pool clear-concurrency-limit [OPTIONS] NAME
Clear the concurrency limit for a work pool. Examples: $ prefect work-pool clear-concurrency-limit “my-pool”

Arguments

NAME
string
required
The name of the work pool to update. [required]

prefect work-pool get-default-base-job-template

prefect work-pool get-default-base-job-template [OPTIONS]
Get the default base job template for a given work pool type. Examples: $ prefect work-pool get-default-base-job-template —type kubernetes

Options

-t
The type of work pool for which to get the default base job template.
-f
If set, write the output to a file.

prefect work-pool preview

prefect work-pool preview [OPTIONS] [NAME]
Preview the work pool’s scheduled work for all queues. Examples: $ prefect work-pool preview “my-pool” —hours 24

Arguments

NAME
string
The name or ID of the work pool to preview

Options

-h
The number of hours to look ahead; defaults to 1 hour

prefect work-pool storage

prefect work-pool storage [OPTIONS] COMMAND [ARGS]...
EXPERIMENTAL: Manage work pool storage.

prefect work-pool storage inspect

prefect work-pool storage inspect [OPTIONS] WORK_POOL_NAME
EXPERIMENTAL: Inspect the storage configuration for a work pool.

Arguments

WORK_POOL_NAME
string
required
The name of the work pool to display storage configuration for. [required]

Options

--output
Specify an output format. Currently supports: json
Example:prefectworkpoolstorageinspect"mypool"prefect work-pool storage inspect "my-pool" prefect work-pool storage inspect “my-pool” —output json

prefect work-pool storage configure

prefect work-pool storage configure [OPTIONS] COMMAND [ARGS]...
EXPERIMENTAL: Configure work pool storage.

prefect work-pool storage configure s3

prefect work-pool storage configure s3 [OPTIONS] WORK_POOL_NAME
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

WORK_POOL_NAME
string
required
The name of the work pool to configure storage for. [required]

Options

--bucket
The name of the S3 bucket to use.
--aws-credentials-block-name
The name of the AWS credentials block to use.

prefect work-pool storage configure gcs

prefect work-pool storage configure gcs [OPTIONS] WORK_POOL_NAME
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

WORK_POOL_NAME
string
required
The name of the work pool to configure storage for. [required]

Options

--bucket
The name of the Google Cloud Storage bucket to use.
--gcp-credentials-block-name
The name of the Google Cloud credentials block to use.

prefect work-pool storage configure azure-blob-storage

prefect work-pool storage configure azure-blob-storage [OPTIONS] WORK_POOL_NAME
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

Arguments

WORK_POOL_NAME
string
required
The name of the work pool to configure storage for. [required]

Options

--container
The name of the Azure Blob Storage container to use.
--azure-blob-storage-credentials-block-name
The name of the Azure Blob Storage credentials block to use.