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

Options

prefect work-pool ls

prefect work-pool ls [OPTIONS]

List work pools.

 Examples: $ prefect work-pool ls

Options

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

Options

prefect work-pool pause

prefect work-pool pause [OPTIONS] NAME

Pause a work pool.

 Examples: $ prefect work-pool pause “my-pool”

Arguments

prefect work-pool resume

prefect work-pool resume [OPTIONS] NAME

Resume a work pool.

 Examples: $ prefect work-pool resume “my-pool”

Arguments

prefect work-pool update

prefect work-pool update [OPTIONS] NAME

Update a work pool.

 Examples: $ prefect work-pool update “my-pool”

Arguments

Options

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

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

prefect work-pool delete

prefect work-pool delete [OPTIONS] NAME

Delete a work pool.

 Examples: $ prefect work-pool delete “my-pool”

Arguments

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

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

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

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

Options

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

Options

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

Options

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

Options

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

Options