trigger_providers providers¶
drpcli trigger_providers¶
Manage DRP trigger_providers (plugins that watch for external events)
Synopsis¶
Trigger providers are plugin-supplied components that watch for external events and inject them into the DRP event system to fire triggers.
A trigger provider defines an external event source - for example, a webhook listener, a message queue consumer, or a scheduled timer. When the provider detects an event, it publishes it to DRP so that matching triggers can fire and run their associated workflows or actions.
Trigger providers are registered by DRP plugin providers and appear here once the relevant plugin is installed and active.
Common operations:
drpcli trigger_providers list- list all registered trigger providersdrpcli trigger_providers show <name>- display a specific trigger providerdrpcli trigger_providers create <json>- register a new trigger providerdrpcli trigger_providers update <name> <json>- update a trigger providerdrpcli trigger_providers destroy <name>- remove a trigger provider
Examples¶
# List all trigger providers
drpcli trigger_providers list
# Show a specific trigger provider by name
drpcli trigger_providers show my-webhook-provider
# Create a trigger provider from a JSON file
drpcli trigger_providers create - < provider.json
# Update a trigger provider's configuration
drpcli trigger_providers update my-webhook-provider '{"Description":"Updated"}'
# Destroy a trigger provider
drpcli trigger_providers destroy my-webhook-provider
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 trigger_providers action - Show details for a specific action on the trigger_provider
- drpcli trigger_providers actions - List all available actions for the trigger_provider
- drpcli trigger_providers add - Add a parameter to a trigger_provider, failing if the key already exists
- drpcli trigger_providers addprofile - Add one or more profiles to a trigger_provider's profile list
- drpcli trigger_providers await - Wait for a trigger_provider's field to become a value within a number of seconds
- drpcli trigger_providers count - Count all trigger_providers
- drpcli trigger_providers create - Create a new trigger_provider with the passed-in JSON or string key
- drpcli trigger_providers destroy - Destroy trigger_provider by id
- drpcli trigger_providers etag - Get the etag for a trigger_providers by id
- drpcli trigger_providers exists - See if a trigger_providers exists by id
- drpcli trigger_providers fieldinfo - Return the documentation for all the fields or the provided field
- drpcli trigger_providers generate - Generate an object of trigger_providers type in the content directory
- drpcli trigger_providers get - Get a single parameter value from a trigger_provider
- drpcli trigger_providers indexes - Get indexes for trigger_providers
- drpcli trigger_providers list - List all trigger_providers
- drpcli trigger_providers meta - Get all metadata key/value pairs for a trigger_provider
- drpcli trigger_providers params - Get or set all parameters for a trigger_provider
- drpcli trigger_providers patch - Patch trigger_provider by ID using the passed-in JSON Patch
- drpcli trigger_providers remove - Remove a parameter from a trigger_provider
- drpcli trigger_providers removeprofile - Remove one or more profiles from a trigger_provider's profile list
- drpcli trigger_providers runaction - Run a plugin action on a trigger_provider
- drpcli trigger_providers set - Set a parameter on a trigger_provider, creating or replacing the value
- drpcli trigger_providers show - Show a single trigger_providers by id
- drpcli trigger_providers update - Unsafely update trigger_provider by id with the passed-in JSON
- drpcli trigger_providers uploadiso - This will attempt to upload the ISO from the specified ISO URL.
- drpcli trigger_providers wait - Wait for a trigger_provider's field to become a value within a number of seconds