drpcli workflows¶
drpcli workflows¶
Manage DRP workflows (ordered sequences of stages for machine provisioning)
Synopsis¶
Workflows define the full provisioning process for a machine as an ordered sequence of stages.
Each workflow lists one or more stage names in execution order. When a machine is assigned a workflow, DRP advances the machine through each stage in sequence, running the tasks defined in each stage until the workflow completes or the machine is halted.
Workflows are the top-level coordination object in the DRP provisioning pipeline:
- Workflow - ordered list of stages
- Stage - a named step with a bootenv and a list of tasks
- Task - an atomic script or template executed on the machine
Assigning a workflow to a machine (via machines update or machines workflow)
starts the provisioning process immediately.
Common operations:
drpcli workflows list- list all defined workflowsdrpcli workflows show <name>- display a specific workflow and its stage listdrpcli workflows create <json>- create a new workflowdrpcli workflows update <name> <json>- modify an existing workflowdrpcli workflows destroy <name>- remove a workflow
Examples¶
# List all workflows
drpcli workflows list
# Show a specific workflow by name
drpcli workflows show ubuntu-install
# Create a workflow with an ordered list of stages
drpcli workflows create '{"Name":"ubuntu-install","Stages":["discover","install-ubuntu","finish"]}'
# Create a workflow from a JSON file
drpcli workflows create - < workflow.json
# Update a workflow's stage list
drpcli workflows update ubuntu-install '{"Stages":["discover","install-ubuntu","configure","finish"]}'
# Assign a workflow to a machine to start provisioning
drpcli machines update <machine-uuid> '{"Workflow":"ubuntu-install"}'
# Destroy a workflow
drpcli workflows destroy ubuntu-install
Options¶
Options inherited from parent commands¶
--ca-cert string CA certificate used to verify the server certs (with the system set)
-c, --catalog string The catalog file to use to get product information (default "https://repo.rackn.io")
--catalog-path string The path to where the catalog file exists on the drp server. By default and historically this has been /files/rebar-catalog. For example, if no catalog urls are provided, the complete path will be https://drp-ip:8090/files/rebar-catalog (default "/files/rebar-catalog")
-S, --catalog-source string A location from which catalog items can be downloaded. For example, in airgapped mode it would be the local catalog
--client-cert string Client certificate to use for communicating to the server - replaces RS_KEY, RS_TOKEN, RS_USERNAME, RS_PASSWORD
--client-key string Client key to use for communicating to the server - replaces RS_KEY, RS_TOKEN, RS_USERNAME, RS_PASSWORD
-C, --colors string The colors for JSON and Table/Text colorization. 8 values in the for 0=val,val;1=val,val2... (default "0=32;1=33;2=36;3=90;4=34,1;5=35;6=95;7=32;8=92")
-d, --debug Whether the CLI should run in debug mode
-D, --download-proxy string HTTP Proxy to use for downloading catalog and content
-E, --endpoint string The Digital Rebar Provision API endpoint to talk to (default "https://127.0.0.1:8092")
-X, --exit-early Cause drpcli to exit if a command results in an object that has errors
--fetch-catalogs all Determines which catalog urls to use to fetch the catalog. If set to all, all the catalog urls defined with catalog_url and catalog_urls as well as the default catalog will be used. If set to server, only the catalog urls defined on the server will be used. If set to cli, then the specific url specified with the -c flag will be used. It defaults to `all`. Allowed values `all, `server`, `cli`. (default "all")
-f, --force When needed, attempt to force the operation - used on some update/patch calls
--force-new-session Should the client always create a new session
-F, --format string The serialization we expect for output. Can be "json" or "yaml" or "text" or "table" (default "json")
--http-request-retry-count int Specifies the number of retries for downloads in case of failure
--http-request-retry-delay-max int Specifies the maximum delay (in seconds) between HTTP/HTTPS retry attempts (default 60)
--ignore-unix-proxy Should the client ignore unix proxies
-N, --no-color Whether the CLI should output colorized strings
-H, --no-header Should header be shown in "text" or "table" mode
-x, --no-token Do not use token auth or token cache
-P, --password string password of the Digital Rebar Provision user (default "r0cketsk8ts")
-p, --platform string Platform to filter details by. Defaults to current system. Format: arch/os
-J, --print-fields string The fields of the object to display in "text" or "table" mode. Comma separated
-r, --ref string A reference object for update commands that can be a file name, yaml, or json blob
--server-verify Should the client verify the server cert
-G, --show-global-help-flags Show global flags in help message
-T, --token string token of the Digital Rebar Provision access
-t, --trace string The log level API requests should be logged at on the server side
-Z, --trace-token string A token that individual traced requests should report in the server logs
-j, --truncate-length int Truncate columns at this length (default 40)
-u, --url-proxy string URL Proxy for passing actions through another DRP
-U, --username string Name of the Digital Rebar Provision user to talk to (default "rocketskates")
SEE ALSO¶
- drpcli - A CLI application for interacting with the DigitalRebar Provision API
- drpcli workflows action - Show details for a specific action on the workflow
- drpcli workflows actions - List all available actions for the workflow
- drpcli workflows await - Wait for a workflow's field to become a value within a number of seconds
- drpcli workflows count - Count all workflows
- drpcli workflows create - Create a new workflow with the passed-in JSON or string key
- drpcli workflows destroy - Destroy workflow by id
- drpcli workflows etag - Get the etag for a workflows by id
- drpcli workflows exists - See if a workflows exists by id
- drpcli workflows fieldinfo - Return the documentation for all the fields or the provided field
- drpcli workflows generate - Generate an object of workflows type in the content directory
- drpcli workflows indexes - Get indexes for workflows
- drpcli workflows list - List all workflows
- drpcli workflows meta - Get all metadata key/value pairs for a workflow
- drpcli workflows patch - Patch workflow by ID using the passed-in JSON Patch
- drpcli workflows runaction - Run a plugin action on a workflow
- drpcli workflows show - Show a single workflows by id
- drpcli workflows update - Unsafely update workflow by id with the passed-in JSON
- drpcli workflows wait - Wait for a workflow's field to become a value within a number of seconds