drpcli tenants¶
drpcli tenants¶
Manage DRP tenants for namespace isolation in multi-tenant deployments
Synopsis¶
Tenants provide namespace isolation in multi-tenant DigitalRebar Provision deployments.
Each tenant defines a separate administrative boundary, allowing multiple teams or customers to share a single DRP endpoint while keeping their resources isolated from one another. Objects within a tenant are scoped to that tenant and are not visible to other tenants.
Tenants work in conjunction with the DRP role and user system to enforce access control boundaries. Users assigned to a tenant can only see and manage resources within that tenant's scope.
Common operations:
drpcli tenants list- list all defined tenantsdrpcli tenants show <name>- display a specific tenantdrpcli tenants create <json>- create a new tenantdrpcli tenants update <name> <json>- update an existing tenantdrpcli tenants destroy <name>- remove a tenant
Examples¶
# List all tenants
drpcli tenants list
# Show a specific tenant by name
drpcli tenants show acme-corp
# Create a new tenant from JSON
drpcli tenants create '{"Name":"acme-corp","Description":"ACME Corporation tenant"}'
# Create a tenant from a JSON file
drpcli tenants create - < tenant.json
# Update a tenant's description
drpcli tenants update acme-corp '{"Description":"Updated description"}'
# Destroy a tenant
drpcli tenants destroy acme-corp
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 tenants action - Show details for a specific action on the tenant
- drpcli tenants actions - List all available actions for the tenant
- drpcli tenants await - Wait for a tenant's field to become a value within a number of seconds
- drpcli tenants count - Count all tenants
- drpcli tenants create - Create a new tenant with the passed-in JSON or string key
- drpcli tenants destroy - Destroy tenant by id
- drpcli tenants etag - Get the etag for a tenants by id
- drpcli tenants exists - See if a tenants exists by id
- drpcli tenants fieldinfo - Return the documentation for all the fields or the provided field
- drpcli tenants generate - Generate an object of tenants type in the content directory
- drpcli tenants indexes - Get indexes for tenants
- drpcli tenants list - List all tenants
- drpcli tenants meta - Get all metadata key/value pairs for a tenant
- drpcli tenants patch - Patch tenant by ID using the passed-in JSON Patch
- drpcli tenants runaction - Run a plugin action on a tenant
- drpcli tenants show - Show a single tenants by id
- drpcli tenants update - Unsafely update tenant by id with the passed-in JSON
- drpcli tenants wait - Wait for a tenant's field to become a value within a number of seconds