drpcli pools¶
drpcli pools¶
Manage DRP machine pools for workload allocation
Synopsis¶
Pools are named groups of machines in DigitalRebar Provision that can be allocated and released for workload execution. They provide a reservation and lifecycle management layer on top of the base machine inventory.
Machines in a pool progress through states: - Free - available to be allocated (unallocated machines) - InUse - currently allocated to a workload
Pool operations:
- add - move Free machines from another pool into this pool
- remove - move Free machines from this pool back to the default pool
- allocate - reserve Free machines in a pool, marking them InUse
- release - return InUse machines to Free status
Pools support flexible machine selection via count, a specific machine list, or filter expressions. Workflows, profiles, and parameters can be applied to machines as part of allocation and release operations.
Examples¶
# List all pools
drpcli pools list
# Show a specific pool
drpcli pools show my-pool
# Show the current status (free/in-use counts) of a pool
drpcli pools status my-pool
# List pools that have active machine allocations
drpcli pools active
# Allocate 3 machines from a pool
drpcli pools manage allocate my-pool --count 3
# Release all machines in a pool
drpcli pools manage release my-pool --all-machines
# Allocate machines and apply a workflow
drpcli pools manage allocate my-pool --count 1 --new-workflow deploy-k8s-node
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 pools action - Show details for a specific action on the pool
- drpcli pools actions - List all available actions for the pool
- drpcli pools active - List pools that currently have machines in an active (InUse) state
- drpcli pools await - Wait for a pool's field to become a value within a number of seconds
- drpcli pools count - Count all pools
- drpcli pools create - Create a new pool with the passed-in JSON or string key
- drpcli pools destroy - Destroy pool by id
- drpcli pools etag - Get the etag for a pools by id
- drpcli pools exists - See if a pools exists by id
- drpcli pools fieldinfo - Return the documentation for all the fields or the provided field
- drpcli pools generate - Generate an object of pools type in the content directory
- drpcli pools indexes - Get indexes for pools
- drpcli pools list - List all pools
- drpcli pools manage - Manage machines within pools (add, remove, allocate, release)
- drpcli pools meta - Get all metadata key/value pairs for a pool
- drpcli pools patch - Patch pool by ID using the passed-in JSON Patch
- drpcli pools runaction - Run a plugin action on a pool
- drpcli pools show - Show a single pools by id
- drpcli pools status - Get the current status of a pool (free and in-use machine counts)
- drpcli pools update - Unsafely update pool by id with the passed-in JSON
- drpcli pools wait - Wait for a pool's field to become a value within a number of seconds