Skip to content

Instantly share code, notes, and snippets.

@discdiver
Created August 27, 2022 16:29
Show Gist options
  • Save discdiver/8211fe30c8ef7b0bdffc85b4402a9d85 to your computer and use it in GitHub Desktop.
Save discdiver/8211fe30c8ef7b0bdffc85b4402a9d85 to your computer and use it in GitHub Desktop.
Usage: prefect deployment build [OPTIONS] PATH                                             
                                                                                           
Generate a deployment YAML from /path/to/file.py:flow_function                             
                                                                                           
╭─ Arguments ──────────────────────────────────────────────────────────────────────────────╮
│ *    path      TEXT  The path to a flow entrypoint, in the form of                       │
│                      `./path/to/file.py:flow_func_name`                                  │
│                      [default: None]                                                     │
│                      [required]                                                          │
╰──────────────────────────────────────────────────────────────────────────────────────────╯
╭─ Options ────────────────────────────────────────────────────────────────────────────────╮
│ --name           -n       TEXT                           The name to give the            │
│                                                          deployment.                     │
│                                                          [default: None]                 │
│ --version        -v       TEXT                           A version to give the           │
│                                                          deployment.                     │
│                                                          [default: None]                 │
│ --tag            -t       TEXT                           One or more optional tags to    │
│                                                          apply to the deployment. Note:  │
│                                                          tags are used only for          │
│                                                          organizational purposes. For    │
│                                                          delegating work to agents, use  │
│                                                          the --work-queue flag.          │
│                                                          [default: None]                 │
│ --work-queue     -q       TEXT                           The work queue that will handle │
│                                                          this deployment's runs. It will │
│                                                          be created if it doesn't        │
│                                                          already exist. Defaults to      │
│                                                          `None`. Note that if a work     │
│                                                          queue is not set, work will not │
│                                                          be scheduled.                   │
│                                                          [default: None]                 │
│ --infra          -i       [kubernetes-job|process|docke  The infrastructure type to use, │
│                           r-container]                   prepopulated with defaults.     │
│                                                          [default: None]                 │
│ --infra-block    -ib      TEXT                           The slug of the infrastructure  │
│                                                          block to use as a template.     │
│                                                          [default: None]                 │
│ --override                TEXT                           One or more optional            │
│                                                          infrastructure overrides        │
│                                                          provided as a dot delimited     │
│                                                          path, e.g.,                     │
│                                                          `env.env_key=env_value`         │
│                                                          [default: None]                 │
│ --storage-block  -sb      TEXT                           The slug of a remote storage    │
│                                                          block. Use the syntax:          │
│                                                          'block_type/block_name', where  │
│                                                          block_type must be one of       │
│                                                          'remote-file-system', 's3',     │
│                                                          'gcs', 'azure', 'smb'           │
│                                                          [default: None]                 │
│ --cron                    TEXT                           A cron string that will be used │
│                                                          to set a CronSchedule on the    │
│                                                          deployment.                     │
│                                                          [default: None]                 │
│ --interval                INTEGER                        An integer specifying an        │
│                                                          interval (in seconds) that will │
│                                                          be used to set an               │
│                                                          IntervalSchedule on the         │
│                                                          deployment.                     │
│                                                          [default: None]                 │
│ --rrule                   TEXT                           An RRule that will be used to   │
│                                                          set an RRuleSchedule on the     │
│                                                          deployment.                     │
│                                                          [default: None]                 │
│ --output         -o       TEXT                           An optional filename to write   │
│                                                          the deployment file to.         │
│                                                          [default: None]                 │
│ --help                                                   Show this message and exit.     │
╰──────────────────────────────────────────────────────────────────────────────────────────╯
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment