drpcli pipelines¶
drpcli pipelines¶
Manage pipelines (declarative phase-workflow configurations applied to machines)
Synopsis¶
Provides CRUD operations for the pipelines resource type.
Pipelines are declarative content that carry phase-workflow params and support parent inheritance via the Pipelines[] field. At most one Pipeline is active per Machine; the param aggregator resolves Pipeline params just above the trailing Profiles bucket.
- Use
listto enumerate all defined pipelines on the endpoint - Use
show [id]to retrieve the full definition of a specific pipeline - Use
create [json]to define a new pipeline from a JSON or YAML document - Use
update [id] [json]to modify an existing pipeline - Use
destroy [id]to remove a pipeline
Examples¶
# List all pipelines
drpcli pipelines list
# Show a specific pipeline by name
drpcli pipelines show default
# Create a pipeline from a JSON file
drpcli pipelines create - < pipeline.json
# Update a pipeline using a JSON patch
drpcli pipelines update default '{"Description":"updated"}'
# Destroy a pipeline
drpcli pipelines destroy my-pipeline
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 pipelines add - Add a parameter to a pipeline, failing if the key already exists
- drpcli pipelines addprofile - Add one or more profiles to a pipeline's profile list
- drpcli pipelines await - Wait for a pipeline's field to become a value within a number of seconds
- drpcli pipelines count - Count all pipelines
- drpcli pipelines create - Create a new pipeline with the passed-in JSON or string key
- drpcli pipelines destroy - Destroy pipeline by id
- drpcli pipelines etag - Get the etag for a pipelines by id
- drpcli pipelines exists - See if a pipelines exists by id
- drpcli pipelines fieldinfo - Return the documentation for all the fields or the provided field
- drpcli pipelines generate - Generate an object of pipelines type in the content directory
- drpcli pipelines get - Get a single parameter value from a pipeline
- drpcli pipelines indexes - Get indexes for pipelines
- drpcli pipelines list - List all pipelines
- drpcli pipelines meta - Get all metadata key/value pairs for a pipeline
- drpcli pipelines params - Get or set all parameters for a pipeline
- drpcli pipelines patch - Patch pipeline by ID using the passed-in JSON Patch
- drpcli pipelines remove - Remove a parameter from a pipeline
- drpcli pipelines removeprofile - Remove one or more profiles from a pipeline's profile list
- drpcli pipelines set - Set a parameter on a pipeline, creating or replacing the value
- drpcli pipelines show - Show a single pipelines by id
- drpcli pipelines update - Unsafely update pipeline by id with the passed-in JSON
- drpcli pipelines uploadiso - This will attempt to upload the ISO from the specified ISO URL.
- drpcli pipelines wait - Wait for a pipeline's field to become a value within a number of seconds