drpcli clusters¶
drpcli clusters¶
Manage clusters (machine groups for coordinated operations)
Synopsis¶
Provides CRUD and lifecycle operations for the clusters resource type.
Clusters are groups of machines managed together for coordinated provisioning workflows. They support task lists, job processing, stage/workflow assignment, and pool integration.
- Use
list/show/create/update/destroyfor standard CRUD operations - Use
startto assign and activate a workflow on the cluster - Use
run/pauseto control whether the cluster processes jobs - Use
processjobsto run the agent loop locally against the cluster - Use
tasks add/tasks delto manage the cluster task list - Use
jobssub-commands to inspect and update the current job
Examples¶
# List all clusters
drpcli clusters list
# Show a specific cluster
drpcli clusters show my-cluster-uuid
# Start a workflow on a cluster
drpcli clusters start my-cluster-uuid my-workflow
# Process all pending jobs for a cluster
drpcli clusters processjobs my-cluster-uuid
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 clusters action - Show details for a specific action on the cluster
- drpcli clusters actions - List all available actions for the cluster
- drpcli clusters add - Add a parameter to a cluster, failing if the key already exists
- drpcli clusters addprofile - Add one or more profiles to a cluster's profile list
- drpcli clusters addtask - Append a task to the end of a cluster's task list
- drpcli clusters await - Wait for a cluster's field to become a value within a number of seconds
- drpcli clusters bootenv - Set the
bootenvfor a cluster - drpcli clusters cleanup - Clean up resources associated with
cluster[id] - drpcli clusters count - Count all clusters
- drpcli clusters create - Create a new cluster with the passed-in JSON or string key
- drpcli clusters currentlog - Stream the log for the most recent job run on
cluster[id] - drpcli clusters deletejobs - Delete all jobs associated with
cluster[id] - drpcli clusters destroy - Destroy cluster by id
- drpcli clusters etag - Get the etag for a clusters by id
- drpcli clusters exists - See if a clusters exists by id
- drpcli clusters fieldinfo - Return the documentation for all the fields or the provided field
- drpcli clusters generate - Generate an object of clusters type in the content directory
- drpcli clusters get - Get a single parameter value from a cluster
- drpcli clusters group - Manage parameters and profiles on the cluster group profile
- drpcli clusters indexes - Get indexes for clusters
- drpcli clusters inserttask - Insert a task at a position relative to the currently running task on a cluster
- drpcli clusters inspect - Deep-inspect task and job execution history on DRP machines
- drpcli clusters jobs - Manage jobs for a
cluster - drpcli clusters list - List all clusters
- drpcli clusters meta - Get all metadata key/value pairs for a cluster
- drpcli clusters params - Get or set all parameters for a cluster
- drpcli clusters patch - Patch cluster by ID using the passed-in JSON Patch
- drpcli clusters pause - Mark the
clusteras NOT runnable (setsRunnabletofalse) - drpcli clusters processjobs - Process pending jobs on the
clusteruntil complete or an error occurs - drpcli clusters releaseToPool - Release the
clusterback to the pool - drpcli clusters remove - Remove a parameter from a cluster
- drpcli clusters removeprofile - Remove one or more profiles from a cluster's profile list
- drpcli clusters removetask - Remove the first occurrence of a task from a cluster's task list
- drpcli clusters render - Render
[text]using the template context ofcluster[id] - drpcli clusters run - Mark the
clusteras runnable (setsRunnabletotrue) - drpcli clusters runaction - Run a plugin action on a cluster
- drpcli clusters set - Set a parameter on a cluster, creating or replacing the value
- drpcli clusters show - Show a single clusters by id
- drpcli clusters stage - Set the
cluster'sstagefield - drpcli clusters start - Start the
cluster's workflow, resetting it even if already set - drpcli clusters tasks - Manage the task list on a
cluster - drpcli clusters update - Unsafely update cluster by id with the passed-in JSON
- drpcli clusters uploadiso - This will attempt to upload the ISO from the specified ISO URL.
- drpcli clusters wait - Wait for a cluster's field to become a value within a number of seconds
- drpcli clusters whoami - Identify the
clusterUUID that best matches the current system - drpcli clusters work_order - Manage the work order queue and work order mode for a machine
- drpcli clusters workflow - Set the
cluster'sworkflowfield