PYTHON-WATCHERCLIENT(1)
💖 NAME 💖
So this is the manual page for python-watcherclient(1) — and yes she's serving python-watcherclient 4.11.0, no cap ✨
This is literally a client for the OpenStack Watcher API. You get two whole flavors, bestie:
- a Python API (the
watcherclientmodules, iykyk) - a command-line script (installed as literally just
watcher)
And the way that each one implements the entire OpenStack Watcher API? Obsessed. 💅
🌸 COMMAND-LINE TOOL REFERENCE 🌸
Okay so to actually use the CLI you HAVE to provide your OpenStack username, password, tenant, and auth endpoint. Use the matching config options (--os-username, --os-password, --os-tenant-id, and --os-auth-url) or just set them in environment variables, your call 🫶
export OS_USERNAME=user
export OS_PASSWORD=pass
export OS_TENANT_ID=b363706f891f48019483f8bd6503c54b
export OS_AUTH_URL=http://auth.example.com:5000/v3/Now the important bit 👀 — the command line tool will attempt to reauthenticate using the credentials you gave it for every single request. Every one. Fr fr. You can override that behavior by manually supplying an auth token using --os-watcher-url and --os-auth-token. Or you can set these environment variables instead:
export OS_WATCHER_URL=http://watcher.example.org:9322/
export OS_AUTH_TOKEN=3bcc3d3a03f44e3d8377f9247b0ad155Once your authentication parameters are configured, just run watcher help to see a complete listing of the available commands. Iconic. 🌟
🎀 watcher Command-Line Interface (CLI) 🎀
✨ SYNOPSIS ✨
watcher [options] <command> [command-options]
watcher help
watcher help <command>💜 DESCRIPTION 💜
The watcher command-line interface (CLI) interacts with the OpenStack infra-optim Service (Watcher). Main character energy, honestly.
In order to use the CLI, you must provide your OpenStack username, password, project (historically called tenant), and auth endpoint. You can use the configuration options --os-username, --os-password, --os-tenant-id (or --os-tenant-name), and --os-auth-url, or set the corresponding environment variables:
$ export OS_USERNAME=user
$ export OS_PASSWORD=password
$ export OS_TENANT_ID=b363706f891f48019483f8bd6503c54b # or OS_TENANT_NAME
$ export OS_TENANT_NAME=project # or OS_TENANT_ID
$ export OS_AUTH_URL=http://auth.example.com:5000/v3/The command-line tool will attempt to reauthenticate using the provided credentials for every request. You can override this behavior by manually supplying an auth token using --watcher-url and --os-auth-token, or by setting the corresponding environment variables:
$ export WATCHER_URL=http://watcher.example.org:9322/
$ export OS_AUTH_TOKEN=3bcc3d3a03f44e3d8377f9247b0ad155Since Keystone can return multiple regions in the Service Catalog, you can specify the one you want with --os-region-name or set the following environment variable. (It defaults to the first in the list returned — that's the vibe check it does automatically 🦋)
$ export OS_REGION_NAME=regionWatcher CLI supports bash completion 😭💖 The command-line tool can automatically fill partially typed commands. To use this feature, source the below file (available at https://opendev.org/openstack/python-watcherclient/src/branch/master/tools/watcher.bash_completion) to your terminal and then bash completion should work:
$ . watcher.bash_completionTo avoid doing this every time, add this to your .bashrc or copy the watcher.bash_completion file to the default bash completion scripts directory on your linux distribution. Set it and forget it, periodt.
🌈 OPTIONS 🌈
To get a list of available (sub)commands and options, run:
$ watcher helpTo get usage and options of a command, run:
$ watcher help <command>⭐ EXAMPLES ⭐
Get information about the audit-create command:
$ watcher help audit createGet a list of available goal:
$ watcher goal listGet a list of audits:
$ watcher audit list🧚 openstack Command-Line Interface (CLI) with Watcher plugin 🧚
✨ SYNOPSIS ✨
openstack [options] optimize <command> [command-options]
openstack help optimize
openstack help optimize <command>💜 DESCRIPTION 💜
The openstack command-line interface (CLI) can interact with the OpenStack infra-optim Service (Watcher) by using our additional plugin — and guess what, it's included right there in the python-watcherclient package. Convenience queen 👑
In order to use the CLI, you must provide your OpenStack username, password, project (historically called tenant), and auth endpoint. You can use the configuration options --os-username, --os-password, --os-tenant-id (or --os-tenant-name), and --os-auth-url, or set the corresponding environment variables:
$ export OS_USERNAME=user
$ export OS_PASSWORD=password
$ export OS_TENANT_ID=b363706f891f48019483f8bd6503c54b # or OS_TENANT_NAME
$ export OS_TENANT_NAME=project # or OS_TENANT_ID
$ export OS_AUTH_URL=http://auth.example.com:5000/v3/The command-line tool will attempt to reauthenticate using the provided credentials for every request. You can override this behavior by manually supplying an auth token using --watcher-url and --os-auth-token, or by setting the corresponding environment variables:
export WATCHER_URL=http://watcher.example.org:9322/
export OS_AUTH_TOKEN=3bcc3d3a03f44e3d8377f9247b0ad155Since Keystone can return multiple regions in the Service Catalog, you can specify the one you want with --os-region-name or set the following environment variable. (It defaults to the first in the list returned, no cap 🌸)
$ export OS_REGION_NAME=region🌈 OPTIONS 🌈
To get a list of available (sub)commands and options, run:
$ openstack help optimizeTo get usage and options of a command, run:
$ openstack help optimize <command>⭐ EXAMPLES ⭐
Get information about the audit-create command:
$ openstack help optimize audit createGet a list of available goal:
$ openstack optimize goal listGet a list of audits:
$ openstack optimize audit list👑 Infrastructure Optimization service (watcher) command-line client 👑
The watcher client is the command-line interface (CLI) for the Infrastructure Optimization service (watcher) API and its extensions. She does it all 💅
This chapter documents watcherclient version 4.9.0.
For help on a specific watcher command, enter:
$ watcher help COMMAND🦋 watcher usage 🦋
usage: watcher [--version] [-v | -q] [--log-file LOG_FILE] [-h] [--debug]
[--no-auth] [--os-identity-api-version <identity-api-version>]
[--os-auth-url <auth-url>] [--os-region-name <region-name>]
[--os-username <auth-user-name>] [--os-user-id <auth-user-id>]
[--os-password <auth-password>]
[--os-user-domain-id <auth-user-domain-id>]
[--os-user-domain-name <auth-user-domain-name>]
[--os-tenant-name <auth-tenant-name>]
[--os-tenant-id <tenant-id>]
[--os-project-id <auth-project-id>]
[--os-project-name <auth-project-name>]
[--os-project-domain-id <auth-project-domain-id>]
[--os-project-domain-name <auth-project-domain-name>]
[--os-auth-token <auth-token>]
[--os-watcher-api-version <os-watcher-api-version>]
[--os-endpoint-type OS_ENDPOINT_TYPE]
[--os-endpoint-override <endpoint-override>] [--insecure]
[--os-cacert <ca-certificate>] [--os-cert <certificate>]
[--os-key <key>] [--timeout <seconds>]💖 watcher optional arguments 💖
--version— show program's version number and exit-v,--verbose— Increase verbosity of output. Can be repeated.-q,--quiet— Suppress output except warnings and errors.--log-file LOG_FILE— Specify a file to log output. Disabled by default.-h,--help— Show help message and exit.--debug— Show tracebacks on errors.--no-auth,-N— Do not use authentication.--os-identity-api-version <identity-api-version>— Specify Identity API version to use. Defaults toenv[OS_IDENTITY_API_VERSION]or3.--os-auth-url <auth-url>,-A <auth-url>— Defaults toenv[OS_AUTH_URL].--os-region-name <region-name>,-R <region-name>— Defaults toenv[OS_REGION_NAME].--os-username <auth-user-name>,-U <auth-user-name>— Defaults toenv[OS_USERNAME].--os-user-id <auth-user-id>— Defaults toenv[OS_USER_ID].--os-password <auth-password>,-P <auth-password>— Defaults toenv[OS_PASSWORD].--os-user-domain-id <auth-user-domain-id>— Defaults toenv[OS_USER_DOMAIN_ID].--os-user-domain-name <auth-user-domain-name>— Defaults toenv[OS_USER_DOMAIN_NAME].--os-tenant-name <auth-tenant-name>,-T <auth-tenant-name>— Defaults toenv[OS_TENANT_NAME].--os-tenant-id <tenant-id>,-I <tenant-id>— Defaults toenv[OS_TENANT_ID].--os-project-id <auth-project-id>— Another way to specify tenant ID. This option is mutually exclusive with--os-tenant-id. Defaults toenv[OS_PROJECT_ID].--os-project-name <auth-project-name>— Another way to specify tenant name. This option is mutually exclusive with--os-tenant-name. Defaults toenv[OS_PROJECT_NAME].--os-project-domain-id <auth-project-domain-id>— Defaults toenv[OS_PROJECT_DOMAIN_ID].--os-project-domain-name <auth-project-domain-name>— Defaults toenv[OS_PROJECT_DOMAIN_NAME].--os-auth-token <auth-token>— Defaults toenv[OS_AUTH_TOKEN].--os-watcher-api-version <os-watcher-api-version>— Defaults toenv[OS_INFRA_OPTIM_API_VERSION].--os-endpoint-type OS_ENDPOINT_TYPE— Defaults toenv[OS_ENDPOINT_TYPE]or"publicURL"--os-endpoint-override <endpoint-override>— Use this API endpoint instead of the Service Catalog.
🍓 watcher action list 🍓
usage: watcher action list [-h] [-f {csv,html,json,table,value,yaml}]
[-c COLUMN] [--max-width <integer>] [--fit-width]
[--print-empty] [--noindent]
[--quote {all,minimal,none,nonnumeric}]
[--action-plan <action-plan>] [--audit <audit>]
[--detail] [--limit <limit>] [--sort-key <field>]
[--sort-dir <direction>] [--marker <marker>]List information on retrieved actions. She's giving catalog, she's giving index 😌
Optional arguments:
-h,--help— show this help message and exit--action-plan <action-plan>— UUID of the action plan used for filtering.--audit <audit>— UUID of the audit used for filtering.--detail— Show detailed information about actions.--limit <limit>— the max number of actions you get back per request, and0means no limit at all. Default is the maximum number that the Watcher API Service uses. 💅--sort-key <field>— the Action field that gets used for sorting. pick your fave ✨--sort-dir <direction>— sort direction:"asc"(the default) or"desc".--marker <marker>— UUID of the last action on the previous page; it displays the list of actions after"marker". pagination slay 🎀
🦋 watcher action show
usage: watcher action show [-h] [-f {html,json,shell,table,value,yaml}]
[-c COLUMN] [--max-width <integer>] [--fit-width]
[--print-empty] [--noindent] [--prefix PREFIX]
<action>Show detailed info about a given action. the full tea ☕
Positional arguments:
<action>— the UUID of the action.
Optional arguments:
-h,--help— shows this help message and exits, classic.
🌸 watcher action update
usage: watcher action update [-h] [-f {html,json,shell,table,value,yaml}]
[-c COLUMN] [--max-width <integer>] [--fit-width]
[--print-empty] [--noindent] [--prefix PREFIX]
[--state <state>] [--reason <reason>] <action>Update action command. glow-up time 💖
Positional arguments:
<action>— the UUID of the action.
Optional arguments:
-h,--help— shows this help message and exits.--state <state>— the new state for the action (e.g.,SKIPPED).--reason <reason>— the reason for the action state change. give 'em a reason bestie 🫶
🎀 watcher actionplan cancel
usage: watcher actionplan cancel [-h] [-f {html,json,shell,table,value,yaml}]
[-c COLUMN] [--max-width <integer>]
[--fit-width] [--print-empty] [--noindent]
[--prefix PREFIX]
<action-plan>Cancel action plan command. not me hitting cancel 🫣
Positional arguments:
<action-plan>— the UUID of the action_plan.
Optional arguments:
-h,--help— shows this help message and exits.
🧚 watcher actionplan create
usage: watcher actionplan create [-h] [-f {html,json,shell,table,value,yaml}]
[-c COLUMN] [--max-width <integer>]
[--fit-width] [--print-empty] [--noindent]
[--prefix PREFIX] -a <audit_template>
[-t <audit_type>]Create new audit. (yes, that's what it says — this is the actionplan create command and the description literally reads "Create new audit." fr fr, keeping it exactly as written ✨)
Optional arguments:
-h,--help— shows this help message and exits.-a <audit_template>,--audit-template <audit_template>— the audit template used for this audit (name or uuid).-t <audit_type>,--audit_type <audit_type>— the audit type. It must beONESHOTorCONTINUOUS. Default isONESHOT. no in-between, pick a lane 💅
💜 watcher actionplan delete
usage: watcher actionplan delete [-h] <action-plan> [<action-plan> ...]Delete action plan command. yeet 👋
Positional arguments:
<action-plan>— the UUID of the action plan. (you can pass more than one, it's<action-plan> [<action-plan> ...])
Optional arguments:
-h,--help— shows this help message and exits.
🌈 watcher actionplan list
usage: watcher actionplan list [-h] [-f {csv,html,json,table,value,yaml}]
[-c COLUMN] [--max-width <integer>]
[--fit-width] [--print-empty] [--noindent]
[--quote {all,minimal,none,nonnumeric}]
[--audit <audit>] [--detail] [--limit <limit>]
[--marker <actionplan>] [--sort-key <field>]
[--sort-dir <direction>]List information on retrieved action plans. the full lineup 👑
Optional arguments:
-h,--help— shows this help message and exits.--audit <audit>— the UUID of an audit, used for filtering.--detail— show detailed information about the action plans. extra detail, extra flavor 🌸--limit <limit>— the max number of action plans to return per request,0for no limit. Default is the maximum number used by the Watcher API Service.--marker <actionplan>— the last actionplan UUID of the previous page; it displays the list of actionplans after"marker".--sort-key <field>— the Action Plan field that will be used for sorting.--sort-dir <direction>— sort direction:"asc"(the default) or"desc".
⭐ watcher actionplan show
usage: watcher actionplan show [-h] [-f {html,json,shell,table,value,yaml}]
[-c COLUMN] [--max-width <integer>]
[--fit-width] [--print-empty] [--noindent]
[--prefix PREFIX]
<action-plan>Show detailed information about a given action plan. the whole story 🎀
Positional arguments:
<action-plan>— the UUID of the action plan.
Optional arguments:
-h,--help— shows this help message and exits.
🚀 watcher actionplan start
usage: watcher actionplan start [-h] [-f {html,json,shell,table,value,yaml}]
[-c COLUMN] [--max-width <integer>]
[--fit-width] [--print-empty] [--noindent]
[--prefix PREFIX]
<action-plan>Start action plan command. let's gooo 🔥
Positional arguments:
<action-plan>— the UUID of the action_plan.
Optional arguments:
-h,--help— shows this help message and exits.
🦋 watcher actionplan update
usage: watcher actionplan update [-h] [-f {html,json,shell,table,value,yaml}]
[-c COLUMN] [--max-width <integer>]
[--fit-width] [--print-empty] [--noindent]
[--prefix PREFIX]
<action-plan> <op> <path=value>
[<path=value> ...]Update action plan command. little tweak, big impact 💅
Positional arguments:
<action-plan>— the UUID of the action_plan.<op>— the operation:'add','replace', or'remove'. that's the whole menu bestie.<path=value>— the attribute to add, replace, or remove. Can be specified multiple times. For'remove', only<path>is necessary.
Optional arguments:
-h,--help— shows this help message and exits.
🌟 watcher audit create
usage: watcher audit create [-h] [-f {html,json,shell,table,value,yaml}]
[-c COLUMN] [--max-width <integer>] [--fit-width]
[--print-empty] [--noindent] [--prefix PREFIX]
[-t <audit_type>] [-p <name=value>]
[-i <interval>] [-g <goal>] [-s <strategy>]
[-a <audit_template>] [--auto-trigger]Create new audit. fresh audit, fresh vibes ✨
Optional arguments:
-h,--help— shows this help message and exits.-t <audit_type>,--audit_type <audit_type>— the audit type. It must beONESHOTorCONTINUOUS. Default isONESHOT.-p <name=value>,--parameter <name=value>— record strategy parameter/value metadata. Can be specified multiple times. stack 'em up 🎀-i <interval>,--interval <interval>— the audit interval (in seconds or cron format). A cron interval can be used like:"*/5 * * * *". Only used if the audit isCONTINUOUS.-g <goal>,--goal <goal>— the goal UUID or name associated to this audit.-s <strategy>,--strategy <strategy>— the strategy UUID or name associated to this audit.-a <audit_template>,--audit-template <audit_template>— the audit template used for this audit (name or uuid).--auto-trigger— trigger the action plan automatically once the audit is succeeded. hands-free, iconic 🫶
💀 watcher audit delete
usage: watcher audit delete [-h] <audit> [<audit> ...]Delete audit command. gone, reduced to atoms 💀
Positional arguments:
<audit>— the UUID or name of the audit. multiple allowed, see the[<audit> ...].
Optional arguments:
-h,--help— shows this help message and exits.
🍓 watcher audit list
usage: watcher audit list [-h] [-f {csv,html,json,table,value,yaml}]
[-c COLUMN] [--max-width <integer>] [--fit-width]
[--print-empty] [--noindent]
[--quote {all,minimal,none,nonnumeric}] [--detail]
[--goal <goal>] [--strategy <strategy>]
[--limit <limit>] [--sort-key <field>]
[--sort-dir <direction>]List information on retrieved audits. the audit recap, served fresh 🍓
Optional arguments:
-h,--help— shows this help message and exits.--detail— show detailed information about the audits.--goal <goal>— the UUID or name of the goal used for filtering.--strategy <strategy>— the UUID or name of the strategy used for filtering.--limit <limit>— the max number of audits to return per request,0for no limit. Default is the maximum number used by the Watcher API Service.--sort-key <field>— the Audit field that will be used for sorting.--sort-dir <direction>— sort direction:"asc"(the default) or"desc".
🧚 watcher audit show
usage: watcher audit show [-h] [-f {html,json,shell,table,value,yaml}]
[-c COLUMN] [--max-width <integer>] [--fit-width]
[--print-empty] [--noindent] [--prefix PREFIX]
<audit>Show detailed information about a given audit. all the deets 🔍
Positional arguments:
<audit>— the UUID or name of the audit.
Optional arguments:
-h,--help— shows this help message and exits.
💖 watcher audit update
usage: watcher audit update [-h] [-f {html,json,shell,table,value,yaml}]
[-c COLUMN] [--max-width <integer>] [--fit-width]
[--print-empty] [--noindent] [--prefix PREFIX]
<audit> <op> <path=value> [<path=value> ...]Update audit command. edit era 💖
Positional arguments:
<audit>— the UUID or name of the audit.<op>— the operation:'add','replace', or'remove'.<path=value>— the attribute to add, replace, or remove. Can be specified multiple times. For'remove', only<path>is necessary.
Optional arguments:
-h,--help— shows this help message and exits.
watcher audittemplate create
usage: watcher audittemplate create [-h]
[-f {html,json,shell,table,value,yaml}]
[-c COLUMN] [--max-width <integer>]
[--fit-width] [--print-empty] [--noindent]
[--prefix PREFIX] [-s <strategy>]
[-d <description>] [--scope <path>]
<name> <goal>okay so this one literally creates a new audit template ✨ bestie you're making a whole new template, it's giving main character energy.
Positional arguments:
<name>— the name you're giving this audit template 💖<goal>— the goal, either as a UUID or a name, that's associated to this audit template 🎯
Optional arguments:
-h,--help— shows this help message and dips out, classic ✌️-s <strategy>,--strategy <strategy>— the strategy (UUID or name, your pick 🫶) that's associated to this audit template-d <description>,--description <description>— the description of the audit template, like a lil vibe blurb 💅--scope <path>— the part of the cluster where the audit is gonna happen. you can hand it over as either ayamlor ajsonfile, no cap 🌸
YAML example:
---
- host_aggregates:
- id: 1
- id: 2
- id: 3
- availability_zones:
- name: AZ1
- name: AZ2
- exclude:
- instances:
- uuid: UUID1
- uuid: UUID2
- compute_nodes:
- name: compute1JSON example:
[
{'host_aggregates': [
{'id': 1},
{'id': 2},
{'id': 3}]},
{'availability_zones': [
{'name': 'AZ1'},
{'name': 'AZ2'}]},
{'exclude': [
{'instances': [
{'uuid': 'UUID1'},
{'uuid': 'UUID2'}]},
{'compute_nodes': [
{'name': 'compute1'}]}]}
]watcher audittemplate delete
usage: watcher audittemplate delete [-h]
<audit-template> [<audit-template> ...]the delete audit template command 🗑️ say bye to the template, it had a good run, iconic while it lasted 😭
Positional arguments:
<audit-template>— UUID or name of the audit template 👑
Optional arguments:
-h,--help— show this help message and exit
watcher audittemplate list
usage: watcher audittemplate list [-h] [-f {csv,html,json,table,value,yaml}]
[-c COLUMN] [--max-width <integer>]
[--fit-width] [--print-empty] [--noindent]
[--quote {all,minimal,none,nonnumeric}]
[--detail] [--goal <goal>]
[--strategy <strategy>] [--limit <limit>]
[--sort-key <field>]
[--sort-dir <direction>][--marker <marker>]lists all the info on the audit templates you pulled up 📋✨ very "let me see the receipts" of it all.
Optional arguments:
-h,--help— show this help message and exit--detail— shows the detailed info about the audit templates, the full tea ☕--goal <goal>— UUID or name of the goal, used for filtering 🔍--strategy <strategy>— UUID or name of the strategy, used for filtering 🔍--limit <limit>— max number of audit templates returned per request;0means no limit. default is whatever max the Watcher API Service uses, so like, it's their call 💅--sort-key <field>— the audit template field that gets used for sorting--sort-dir <direction>— sort direction:"asc"(the default) or"desc"⬆️⬇️--marker <marker>— the UUID of the last audittemplate on the previous page; shows you the list of audittemplates after"marker", so you can keep scrolling pookie 🦋
watcher audittemplate show
usage: watcher audittemplate show [-h] [-f {html,json,shell,table,value,yaml}]
[-c COLUMN] [--max-width <integer>]
[--fit-width] [--print-empty] [--noindent]
[--prefix PREFIX]
<audit-template>shows the detailed info about one specific audit template 🔎 the way this one is so specific, we love a focused queen.
Positional arguments:
<audit-template>— UUID or name of the audit template 👑
Optional arguments:
-h,--help— show this help message and exit
watcher audittemplate update
usage: watcher audittemplate update [-h]
[-f {html,json,shell,table,value,yaml}]
[-c COLUMN] [--max-width <integer>]
[--fit-width] [--print-empty] [--noindent]
[--prefix PREFIX]
<audit-template> <op> <path=value>
[<path=value> ...]the update audit template command 💅 glow-up time, we're editing things.
Positional arguments:
<audit-template>— UUID or name of the audit_template.<op>— the operation:'add','replace', or'remove'. pick your fighter 🥊<path=value>— the attribute to add, replace, or remove. you can drop this multiple times, go off ✨ and for'remove', only the<path>is necessary, no value needed 🎀
Optional arguments:
-h,--help— show this help message and exit
watcher goal list
usage: watcher goal list [-h] [-f {csv,html,json,table,value,yaml}]
[-c COLUMN] [--max-width <integer>] [--fit-width]
[--print-empty] [--noindent]
[--quote {all,minimal,none,nonnumeric}] [--detail]
[--limit <limit>] [--sort-key <field>]
[--sort-dir <direction>][--marker <marker>]lists info on the goals you retrieved 🎯 manifesting your goals, literally.
Optional arguments:
-h,--help— show this help message and exit--detail— shows detailed info about each goal, every single one 💖--limit <limit>— max number of goals returned per request,0for no limit. default is the maximum number used by the Watcher API Service 🧚--sort-key <field>— the goal field that gets used for sorting--sort-dir <direction>— sort direction:"asc"(the default) or"desc"--marker <marker>— UUID of the last goal on the previous page; shows the list of goals after"marker"🦋
watcher goal show
usage: watcher goal show [-h] [-f {html,json,shell,table,value,yaml}]
[-c COLUMN] [--max-width <integer>] [--fit-width]
[--print-empty] [--noindent] [--prefix PREFIX]
<goal>shows the detailed info about one given goal 🔍 slay, one goal at a time.
Positional arguments:
<goal>— UUID or name of the goal 👑
Optional arguments:
-h,--help— show this help message and exit
watcher scoringengine list
usage: watcher scoringengine list [-h] [-f {csv,html,json,table,value,yaml}]
[-c COLUMN] [--max-width <integer>]
[--fit-width] [--print-empty] [--noindent]
[--quote {all,minimal,none,nonnumeric}]
[--detail] [--limit <limit>]
[--sort-key <field>]
[--sort-dir <direction>][--marker <marker>]lists info on the scoring engines you retrieved ⚙️✨ the ranking girlies.
Optional arguments:
-h,--help— show this help message and exit--detail— shows detailed info about the scoring engines 🔎--limit <limit>— max number of actions returned per request,0for no limit. default is the maximum number used by the Watcher API Service 💅 (yes bestie, it says actions here — copying it exactly, not my business 🙈)--sort-key <field>— the action field that gets used for sorting--sort-dir <direction>— sort direction:"asc"(the default) or"desc"--marker <marker>— UUID of the last scoringengine on the previous page; shows the list of scoringengines after"marker"🦋
watcher scoringengine show
usage: watcher scoringengine show [-h] [-f {html,json,shell,table,value,yaml}]
[-c COLUMN] [--max-width <integer>]
[--fit-width] [--print-empty] [--noindent]
[--prefix PREFIX]
<scoring_engine>shows the detailed info about one given scoring engine 🔎 one engine, fully seen.
Positional arguments:
<scoring_engine>— name of the scoring engine 👑
Optional arguments:
-h,--help— show this help message and exit
watcher service list
usage: watcher service list [-h] [-f {csv,html,json,table,value,yaml}]
[-c COLUMN] [--max-width <integer>] [--fit-width]
[--print-empty] [--noindent]
[--quote {all,minimal,none,nonnumeric}] [--detail]
[--limit <limit>] [--sort-key <field>]
[--sort-dir <direction>]lists info on the services you retrieved 🛠️✨ the "who's on shift" of it all.
Optional arguments:
-h,--help— show this help message and exit--detail— shows detailed info about each service 💖--limit <limit>— max number of services returned per request,0for no limit. default is the maximum number used by the Watcher API Service 🌸--sort-key <field>— the goal field that gets used for sorting (yep, the manpage says goal field here — leaving it exactly as written, iykyk 🙈)--sort-dir <direction>— sort direction:"asc"(the default) or"desc"
watcher service show
usage: watcher service show [-h] [-f {html,json,shell,table,value,yaml}]
[-c COLUMN] [--max-width <integer>] [--fit-width]
[--print-empty] [--noindent] [--prefix PREFIX]
<service>shows the detailed info about one given service 🔎
Positional arguments:
<service>— ID or name of the service 👑
Optional arguments:
-h,--help— show this help message and exit
watcher datamodel list
usage: watcher datamodel list [-h] [-f {csv,json,table,value,yaml}]
[-c COLUMN] [--max-width <integer>]
[--fit-width] [--print-empty] [--noindent]
[--quote {all,minimal,none,nonnumeric}]
[--sort-column SORT_COLUMN] [--type <type>]
[--audit <audit>] [--detail]lists info on the retrieved data model 🗂️✨ the blueprint of the whole situation.
Optional arguments:
-h,--help— show this help message and exit--type <type>— the type of Datamodel you wanna list. supported values:compute. future support values:storage,baremetal. default type iscompute💅--audit <audit>— the audit, bestie 🔍--detail— shows detailed info 🎀--audit <audit>— UUID of the audit — it’s used to filter the data model by the scope in that audit. iykyk 🫶--detail— Show detailed information about the data model. okay slay ✨
🌸 watcher strategy list 🌸
usage: watcher strategy list [-h] [-f {csv,html,json,table,value,yaml}]
[-c COLUMN] [--max-width <integer>] [--fit-width]
[--print-empty] [--noindent]
[--quote {all,minimal,none,nonnumeric}]
[--goal <goal>] [--detail] [--limit <limit>]
[--sort-key <field>] [--sort-dir <direction>]
[--marker <marker>]List information on retrieved strategies. literally strategy info, bestie 💅
Optional arguments 🎀
-h,--help— show this help message and exit--goal <goal>— UUID or name of the goal--detail— Show detailed information about each strategy.--limit <limit>— Maximum number of strategies to return per request,0for no limit. Default is the maximum number used by the Watcher API Service.--sort-key <field>— Goal field that will be used for sorting.--sort-dir <direction>— Sort direction:"asc"(the default) or"desc".--marker <marker>— UUID of the last strategy in the previous page; displays list of strategies after"marker".
🌈 watcher strategy show 🌈
usage: watcher strategy show [-h] [-f {html,json,shell,table,value,yaml}]
[-c COLUMN] [--max-width <integer>] [--fit-width]
[--print-empty] [--noindent] [--prefix PREFIX]
<strategy>Show detailed information about a given strategy. it’s giving “tell me everything” energy 👑
Positional arguments 🦋
<strategy>— UUID or name of the strategy
Optional arguments 🌸
-h,--help— show this help message and exit
💜 watcher strategy state 💜
usage: watcher strategy state [-h] [-f {csv,html,json,table,value,yaml}]
[-c COLUMN] [--max-width <integer>]
[--fit-width] [--print-empty] [--noindent]
[--quote {all,minimal,none,nonnumeric}]
[--sort-column SORT_COLUMN]
<strategy>Retrieve information about strategy requirements. requirements check, no cap ✅
Positional arguments 🍓
<strategy>— Name of the strategy
Optional arguments ✨
-h,--help— show this help message and exit
🐍 PYTHON LIBRARY REFERENCE 🐍
Okay so if you wanna use the python api directly, first you gotta obtain an auth token and identify which endpoint you wish to speak to. Once you’ve done that, you can use the API like so. auth token first, bestie — main character prep 💅
🦋 watcherclient
watcherclient package
Subpackages
watcherclient.common package
Subpackages
watcherclient.common.apiclient package
Submodules
watcherclient.common.apiclient.base module
Base utilities to build API operation managers and objects on top of. foundation energy, honestly 🧚
class watcherclient.common.apiclient.base.BaseManager(client)
Bases: HookableMixin
Basic manager type providing common operations.
Managers interact with a particular type of API (servers, flavors, images, etc.) and provide CRUD operations for them.
resource_class = None
class watcherclient.common.apiclient.base.CrudManager(client)
Bases: BaseManager
Base manager class for manipulating entities.
Children of this class are expected to define a collection_key and key.
collection_key: Usually a plural noun by convention (e.g.entities); used to refer collections in both URL's (e.g./v3/entities) and JSON objects containing a list of member resources (e.g.{'entities': [{}, {}, {}]}).key: Usually a singular noun by convention (e.g.entity); used to refer to an individual member of the collection.build_url(base_url=None, **kwargs)— Builds a resource URL for the givenkwargs.
Given an example collection where collection_key = 'entities' and key = 'entity', the following URL's could be generated.
By default, the URL will represent a collection of entities, e.g.:
/entitiesIf kwargs contains an entity_id, then the URL will represent a specific member, e.g.:
/entities/{entity_id}- Parameters:
base_url-- if provided, the generated URL will be appended to it
collection_key = Nonecreate(**kwargs)delete(**kwargs)find(base_url=None, **kwargs)— Find a single item with attributes matching**kwargs.- Parameters:
base_url-- if provided, the generated URL will be appended to it
- Parameters:
get(**kwargs)head(**kwargs)key = Nonelist(base_url=None, **kwargs)— List the collection.- Parameters:
base_url-- if provided, the generated URL will be appended to it
- Parameters:
put(base_url=None, **kwargs)— Update an element.- Parameters:
base_url-- if provided, the generated URL will be appended to it
- Parameters:
update(**kwargs)
class watcherclient.common.apiclient.base.Extension(name, module)
Bases: HookableMixin
Extension descriptor.
SUPPORTED_HOOKS = ('__pre_parse_args__', '__post_parse_args__')manager_class = None
class watcherclient.common.apiclient.base.HookableMixin
Bases: object
Mixin so classes can register and run hooks.
classmethod add_hook(hook_type, hook_func)— Add a new hook of specified type.- Parameters:
cls-- class that registers hookshook_type-- hook type, e.g.,'__pre_parse_args__'hook_func-- hook function
- Parameters:
classmethod run_hooks(hook_type, *args, **kwargs)— Run all hooks of specified type.- Parameters:
cls-- class that registers hookshook_type-- hook type, e.g.,'__pre_parse_args__'args-- args to be passed to every hook functionkwargs-- kwargs to be passed to every hook function
- Parameters:
class watcherclient.common.apiclient.base.ManagerWithFind(client)
Bases: BaseManager
Manager with additional find()/findall() methods.
find(**kwargs)— Find a single item with attributes matching**kwargs.
This isn't very efficient: it loads the entire list then filters on the Python side.
findall(**kwargs)— Find all items with attributes matching**kwargs.
This isn't very efficient: it loads the entire list then filters on the Python side.
abstractmethod list()
class watcherclient.common.apiclient.base.Resource(manager, info, loaded=False)
Bases: object
Base class for OpenStack resources (tenant, user, etc.).
This is pretty much just a bag for attributes.
HUMAN_ID = FalseNAME_ATTR = 'name'get()— Support for lazy loading details.
Some clients, such as watcherclient have the option to lazy load the details, details which can be loaded with this function.
property human_id— Human-readable ID which can be used for bash completion.is_loaded()set_loaded(val)to_dict()
watcherclient.common.apiclient.base.getid(obj)
Return id if argument is a Resource.
Abstracts the common pattern of allowing both an object or an object's ID (UUID) as a parameter when dealing with relationships. very “either works, bestie” of it 🫶
watcherclient.common.apiclient.exceptions module
Exception definitions. the drama section, but make it useful 💀
- exception
watcherclient.common.apiclient.exceptions.AmbiguousEndpoints(endpoints=None)— Bases:EndpointException. Found more than one matching endpoint in Service Catalog. - exception
watcherclient.common.apiclient.exceptions.AuthPluginOptionsMissing(opt_names)— Bases:AuthorizationFailure. Auth plugin misses some options. - exception
watcherclient.common.apiclient.exceptions.AuthSystemNotFound(auth_system)— Bases:AuthorizationFailure. User has specified an AuthSystem that is not installed. - exception
watcherclient.common.apiclient.exceptions.AuthorizationFailure— Bases:ClientException. Cannot authorize API client. - exception
watcherclient.common.apiclient.exceptions.BadGateway(message=None, details=None, response=None, request_id=None, url=None, method=None, http_status=None)— Bases:HttpServerError. HTTP 502 - Bad Gateway.
The server was acting as a gateway or proxy and received an invalid response from the upstream server.
http_status = 502message = 'Bad Gateway'
- exception
watcherclient.common.apiclient.exceptions.BadRequest(message=None, details=None, response=None, request_id=None, url=None, method=None, http_status=None)— Bases:HTTPClientError. HTTP 400 - Bad Request.
The request cannot be fulfilled due to bad syntax.
http_status = 400message = 'Bad Request'
- exception
watcherclient.common.apiclient.exceptions.ClientException— Bases:Exception. The base exception class for all exceptions this library raises. - exception
watcherclient.common.apiclient.exceptions.CommandError— Bases:ClientException. Error in CLI tool. - exception
watcherclient.common.apiclient.exceptions.Conflict(message=None, details=None, response=None, request_id=None, url=None, method=None, http_status=None)— Bases:HTTPClientError. HTTP 409 - Conflict.
Indicates that the request could not be processed because of conflict in the request, such as an edit conflict.
http_status = 409message = 'Conflict'
- exception
watcherclient.common.apiclient.exceptions.ConnectionError— Bases:ClientException. Cannot connect to API service.
ConnectionRefused
Bases: ConnectionError
Connection refused while trying to connect to API service. Basically the API ghosted you at the socket level — nobody's home on that port, bestie. 😭
EndpointException
Bases: ClientException
Something is rotten in Service Catalog.</purl> Yeah. The vibes are off in the Service Catalog. Rotting, even. 💀
EndpointNotFound
Bases: EndpointException
Could not find requested endpoint in Service Catalog. You asked for an endpoint, the catalog said "who?" — it's giving lost in the void. 🫠
ExpectationFailed
ExpectationFailed(message=None, details=None, response=None, request_id=None, url=None, method=None, http_status=None)Bases: HTTPClientError
HTTP 417 - Expectation Failed. The server literally cannot meet the requirements of the Expect request-header field. Sorry babe, expectations were set and they were not met. ✨
http_status=417message='Expectation Failed'
Forbidden
Forbidden(message=None, details=None, response=None, request_id=None, url=None, method=None, http_status=None)Bases: HTTPClientError
HTTP 403 - Forbidden. The request was a valid request, but the server is refusing to respond to it. It's not you, it's… actually no, it's the server. You're not on the list. 🚫
http_status=403message='Forbidden'
GatewayTimeout
GatewayTimeout(message=None, details=None, response=None, request_id=None, url=None, method=None, http_status=None)Bases: HttpServerError
HTTP 504 - Gateway Timeout. The server was acting as a gateway or proxy and did not receive a timely response from the upstream server. Lowkey the middleman left you on read. 😤
http_status=504message='Gateway Timeout'
Gone
Gone(message=None, details=None, response=None, request_id=None, url=None, method=None, http_status=None)Bases: HTTPClientError
HTTP 410 - Gone. Indicates that the resource requested is no longer available and will not be available again. She's not coming back. Grieve and move on. 🥀
http_status=410message='Gone'
HTTPClientError
HTTPClientError(message=None, details=None, response=None, request_id=None, url=None, method=None, http_status=None)Bases: HttpError
Client-side HTTP error. Exception for cases in which the client seems to have erred. It's a you problem, not a server problem. 🙈
message='HTTP Client Error'
HTTPRedirection
HTTPRedirection(message=None, details=None, response=None, request_id=None, url=None, method=None, http_status=None)Bases: HttpError
HTTP Redirection. Not here, go over there. The classic "ask my friend" of HTTP. ✨
message='HTTP Redirection'
HttpError
HttpError(message=None, details=None, response=None, request_id=None, url=None, method=None, http_status=None)Bases: ClientException
The base exception class for all HTTP exceptions. The mother of all HTTP drama — everything else in this family descends from her. 👑
http_status=0message='HTTP Error'
HttpNotImplemented
HttpNotImplemented(message=None, details=None, response=None, request_id=None, url=None, method=None, http_status=None)Bases: HttpServerError
HTTP 501 - Not Implemented. The server either does not recognize the request method, or it lacks the ability to fulfill the request. Skill issue, on the server's side. 💅
http_status=501message='Not Implemented'
HttpServerError
HttpServerError(message=None, details=None, response=None, request_id=None, url=None, method=None, http_status=None)Bases: HttpError
Server-side HTTP error. Exception for cases in which the server is aware that it has erred or is incapable of performing the request. At least she's self-aware. 😭
message='HTTP Server Error'
HttpVersionNotSupported
HttpVersionNotSupported(message=None, details=None, response=None, request_id=None, url=None, method=None, http_status=None)Bases: HttpServerError
HTTP 505 - HttpVersion Not Supported. The server does not support the HTTP protocol version used in the request. You're speaking a whole different era of HTTP and it's not picking up what you're putting down. 🦋
http_status=505message='HTTP Version Not Supported'
InternalServerError
InternalServerError(message=None, details=None, response=None, request_id=None, url=None, method=None, http_status=None)Bases: HttpServerError
HTTP 500 - Internal Server Error. A generic error message, given when no more specific message is suitable. The "it's complicated" of status codes. 💀
http_status=500message='Internal Server Error'
LengthRequired
LengthRequired(message=None, details=None, response=None, request_id=None, url=None, method=None, http_status=None)Bases: HTTPClientError
HTTP 411 - Length Required. The request did not specify the length of its content, which is required by the requested resource. Bestie. How big is it. Tell the server how big it is. 📏
http_status=411message='Length Required'
MethodNotAllowed
MethodNotAllowed(message=None, details=None, response=None, request_id=None, url=None, method=None, http_status=None)Bases: HTTPClientError
HTTP 405 - Method Not Allowed. A request was made of a resource using a request method not supported by that resource. Wrong technique, right intention. 🙃
http_status=405message='Method Not Allowed'
MultipleChoices
MultipleChoices(message=None, details=None, response=None, request_id=None, url=None, method=None, http_status=None)Bases: HTTPRedirection
HTTP 300 - Multiple Choices. Indicates multiple options for the resource that the client may follow. The server is making you pick the restaurant and it's giving you zero help. 🍽️
http_status=300message='Multiple Choices'
NoUniqueMatch
Bases: ClientException
Multiple entities found instead of one. You wanted one bestie and the universe handed you a whole crowd. The search said "iconic" and returned three of them. 😵💫
NotAcceptable
NotAcceptable(message=None, details=None, response=None, request_id=None, url=None, method=None, http_status=None)Bases: HTTPClientError
HTTP 406 - Not Acceptable. The requested resource is only capable of generating content not acceptable according to the Accept headers sent in the request. Miss girl over here is picky. 🎀
http_status=406message='Not Acceptable'
NotFound
NotFound(message=None, details=None, response=None, request_id=None, url=None, method=None, http_status=None)Bases: HTTPClientError
HTTP 404 - Not Found. The requested resource could not be found but may be available again in the future. So there's hope. Barely. ✨
http_status=404message='Not Found'
PaymentRequired
PaymentRequired(message=None, details=None, response=None, request_id=None, url=None, method=None, http_status=None)Bases: HTTPClientError
HTTP 402 - Payment Required. Reserved for future use. Sitting there, lurking, waiting for its era. 🤑
http_status=402message='Payment Required'
PreconditionFailed
PreconditionFailed(message=None, details=None, response=None, request_id=None, url=None, method=None, http_status=None)Bases: HTTPClientError
HTTP 412 - Precondition Failed. The server does not meet one of the preconditions that the requester put on the request. You said "only if…" and the only-if did not hold. 💔
http_status=412message='Precondition Failed'
ProxyAuthenticationRequired
ProxyAuthenticationRequired(message=None, details=None, response=None, request_id=None, url=None, method=None, http_status=None)Bases: HTTPClientError
HTTP 407 - Proxy Authentication Required. The client must first authenticate itself with the proxy. Talk to the middleman before you talk to anyone else, babe. 🔐
http_status=407message='Proxy Authentication Required'
RequestEntityTooLarge
RequestEntityTooLarge(*args, **kwargs)Bases: HTTPClientError
HTTP 413 - Request Entity Too Large. The request is larger than the server is willing or able to process. Her eyes were bigger than her server. 😳
http_status=413message='Request Entity Too Large'
RequestTimeout
RequestTimeout(message=None, details=None, response=None, request_id=None, url=None, method=None, http_status=None)Bases: HTTPClientError
HTTP 408 - Request Timeout. The server timed out waiting for the request. The waiting was mutual and yet the server closed the chat first. ⌛
http_status=408message='Request Timeout'
RequestUriTooLong
RequestUriTooLong(message=None, details=None, response=None, request_id=None, url=None, method=None, http_status=None)Bases: HTTPClientError
HTTP 414 - Request-URI Too Long. The URI provided was too long for the server to process. You sent a whole essay in the URL sweetie. 📜
http_status=414message='Request-URI Too Long'
RequestedRangeNotSatisfiable
RequestedRangeNotSatisfiable(message=None, details=None, response=None, request_id=None, url=None, method=None, http_status=None)Bases: HTTPClientError
HTTP 416 - Requested Range Not Satisfiable. The client has asked for a portion of the file, but the server cannot supply that portion. Wrong slice, wrong cake. 🍰
http_status=416message='Requested Range Not Satisfiable'
ServiceUnavailable
ServiceUnavailable(message=None, details=None, response=None, request_id=None, url=None, method=None, http_status=None)Bases: HttpServerError
HTTP 503 - Service Unavailable. The server is currently unavailable. She's on a break, out of office, do not perceive her. 🌸
http_status=503message='Service Unavailable'
Unauthorized
Unauthorized(message=None, details=None, response=None, request_id=None, url=None, method=None, http_status=None)Bases: HTTPClientError
HTTP 401 - Unauthorized. Similar to 403 Forbidden, but specifically for use when authentication is required and has failed or has not yet been provided. The classic "who even are you?" energy. 🪪
http_status=401message='Unauthorized'
...and the exceptions just keep coming, bestie, so let's keep it rolling 💅
exception watcherclient.common.apiclient.exceptions.UnprocessableEntity(message=None, details=None, response=None, request_id=None, url=None, method=None, http_status=None)
Bases: HTTPClientError
HTTP 422 — Unprocessable Entity 🌸
So like, the request was well-formed, it looked fine, but the server couldn't actually follow it because of semantic errors. Not a syntax vibe check fail — a meaning vibe check fail.
http_status = 422
message = 'Unprocessable Entity'
exception watcherclient.common.apiclient.exceptions.UnsupportedMediaType(message=None, details=None, response=None, request_id=None, url=None, method=None, http_status=None)
Bases: HTTPClientError
HTTP 415 — Unsupported Media Type 🫠
The request entity has a media type which the server or resource does not support. It's giving "you brought the wrong snack to the party."
http_status = 415
message = 'Unsupported Media Type'
exception watcherclient.common.apiclient.exceptions.UnsupportedVersion
Bases: ClientException
User is trying to use an unsupported version of the API. Iconic of them, but no 💀
exception watcherclient.common.apiclient.exceptions.ValidationError
Bases: ClientException
Error in validation on API client side. Caught it before it even left the house, lowkey responsible of us.
watcherclient.common.apiclient.exceptions.from_response(response, method, url)
Returns an instance of HttpError or subclass based on response. Basically it reads the room and hands you back the right exception 💖
Parameters
- response — instance of
requests.Responseclass - method — HTTP method used for request
- url — URL used for request
Module contents
Okay, now we're in the actual module contents, and this is where the plumbing lives. Slay, plumbing 🎀
Submodules
watcherclient.common.api_versioning module
class watcherclient.common.api_versioning.APIVersion(version_str=None)
Bases: object
This class represents an API Version Request ✨
It provides convenience methods for manipulation and comparison of version numbers that we need to do to implement microversions. Microversions are literally the main character here, no cap.
get_string()
Version string representation.
Converts object to string representation which if used to create an APIVersion object results in the same version.
is_latest()
is_null()
matches(min_version, max_version)
Matches the version object.
Returns whether the version object represents a version greater than or equal to the minimum version and less than or equal to the maximum version.
Parameters
- min_version — Minimum acceptable version.
- max_version — Maximum acceptable version.
Returns
boolean
If min_version is null then there is no minimum limit. If max_version is null then there is no maximum limit. If self is null then raise ValueError. Drama, but make it documented 🦋
watcherclient.common.api_versioning.action_update_supported(requested_version)
Check if we should support action update functionality.
Version 1.5 of the API added support for updating action state. History lesson, periodt.
watcherclient.common.api_versioning.allow_audit_template_default_parameters(requested_version)
Check if we should support default_parameters on audit templates.
Version 1.7 of the API added default_parameters to AuditTemplate. She's new here but she's already iconic.
watcherclient.common.api_versioning.allow_start_end_audit_time(requested_version)
Check if we should support optional start/end attributes for Audit.
Version 1.1 of the API added support for start and end time of continuous audits.
watcherclient.common.api_versioning.check_major_version(api_version)
Checks major part of APIVersion obj is supported.
Raises watcherclient.exceptions.UnsupportedVersion <#watcherclient.exceptions.UnsupportedVersion> — if major part is not supported 😭
watcherclient.common.api_versioning.get_api_version(version_string)
Returns checked APIVersion object.
watcherclient.common.api_versioning.get_available_major_versions()
watcherclient.common.api_versioning.launch_audit_forced(requested_version)
Check if we should support force option for Audit.
Version 1.2 of the API added support for force option.
watcherclient.common.base module
Base utilities to build API operation managers and objects on top of. The foundations, the roots, the blueprint 💅
class watcherclient.common.base.Manager(api)
Bases: object
Provides CRUD operations with a particular API.
resource_class = None
class watcherclient.common.base.Resource(manager, info, loaded=False)
Bases: Resource <#watcherclient.common.apiclient.base.Resource>
Represents a particular instance of an object (tenant, user, etc).
This is pretty much just a bag for attributes. We love an honest data structure.
to_dict()
watcherclient.common.base.getid(obj)
Wrapper to get object's ID.
Abstracts the common pattern of allowing both an object or an object's ID (UUID) as a parameter when dealing with relationships. Very "accept me as I am" of it 🫶
watcherclient.common.command module
class watcherclient.common.command.Command(app: _app.App, app_args: Namespace | None, cmd_name: str | None = None)
Bases: Command
log = <Logger watcherclient.common.command.Command (WARNING)>
run(parsed_args)
Invoked by the application when the command is run.
Developers implementing commands should override take_action().
Developers creating new command base classes (such as Lister and ShowOne) should override this method to wrap take_action().
Return the value returned by take_action() or 0.
class watcherclient.common.command.CommandMeta(name, bases, cls_dict)
Bases: ABCMeta
class watcherclient.common.command.Lister(app: App, app_args: Namespace | None, cmd_name: str | None = None)
Bases: Command, Lister
log = <Logger watcherclient.common.command.Lister (WARNING)>
class watcherclient.common.command.ShowOne(app: App, app_args: Namespace | None, cmd_name: str | None = None)
Bases: Command, ShowOne
get_parser(prog_name, formatter_class=None)
Return an argparse.ArgumentParser.
log = <Logger watcherclient.common.command.ShowOne (WARNING)>
watcherclient.common.httpclient module
class watcherclient.common.httpclient.HTTPClient(endpoint, **kwargs)
Bases: VersionNegotiationMixin
json_request(method, url, **kwargs)
log_curl_request(method, url, kwargs)
static log_http_response(resp, body=None)
raw_request(method, url, **kwargs)
class watcherclient.common.httpclient.SessionClient(os_infra_optim_api_version, api_version_select_state, max_retries, retry_interval, endpoint, **kwargs)
Bases: VersionNegotiationMixin, LegacyJsonAdapter
HTTP client based on Keystone client session. Keystone said "I got you" and honestly? She did 💜
json_request(method, url, **kwargs)
raw_request(method, url, **kwargs)
class watcherclient.common.httpclient.VerifiedHTTPSConnection(host, port, key_file=None, cert_file=None, ca_file=None, timeout=None, insecure=False)
Bases: HTTPSConnection
httplib-compatible connection using client-side SSL authentication
:see <http://code.activestate.com/recipes/> 577548-https-httplib-client-connection-with-certificate-v/ — yes the recipe link is staying, it's part of the lore 🍓
connect()
Connect to a host on a given (SSL) port.
If ca_file is pointing somewhere, use it to check Server Certificate. Responsible queen behaviour.
static get_system_ca_file()
Return path to system default CA file.
class watcherclient.common.httpclient.VersionNegotiationMixin
Bases: object
negotiate_version(conn, resp)
Negotiate the server version 🕊️
Assumption: Called after receiving a 406 error when doing a request.
param conn: A connection object param resp: The response object from http request
watcherclient.common.httpclient.get_server(endpoint)
Extract and return the server & port that we're connecting to.
watcherclient.common.httpclient.with_retries(func)
Wrapper for _http_request adding support for retries. Try again, bestie, but like, formally 💫
watcherclient.common.utils module
class watcherclient.common.utils.HelpFormatter(prog, indent_increment=2, max_help_position=24, width=None)
Bases: HelpFormatter
start_section(heading)
watcherclient.common.utils.args_array_to_dict(kwargs, key_to_convert)
watcherclient.common.utils.args_array_to_patch(op, attributes, exclude_fields=[])
watcherclient.common.utils.common_filters(limit=None, sort_key=None, sort_dir=None, marker=None)
Generate common filters for any list request.
Parameters
- limit — maximum number of entities to return.
- sort_key — field to use for sorting.
- sort_dir — direction of sorting:
'asc'or'desc'. - marker — The last actionplan UUID of the previous page.
Returns
list of string filters.
watcherclient.common.utils.common_params_for_list(args, fields, field_labels)
Generate 'params' dict that is common for every 'list' command.
Parameters
- args — arguments from command line.
- fields — possible fields for sorting.
- field_labels — possible field labels for sorting.
Returns
a dict with params to pass to the client method.
watcherclient.common.utils.define_command(subparsers, command, callback, cmd_mapper)
Define a command in the subparsers collection.
Parameters
- subparsers — subparsers collection where the command will go
- command — command name
- callback — function that will be used to process the command
watcherclient.common.utils.define_commands_from_module(subparsers, command_module, cmd_mapper)
Add do_ methods in a module and add as commands into a subparsers. Very "if you built it, it ships" ✨
watcherclient.common.utils.import_versioned_module(version, submodule=None)
watcherclient.common.utils.is_uuid_like(val)
Returns validation of a value as a UUID.
For our purposes, a UUID is a canonical form string: aaaaaaaa-aaaa-aaaa-aaaa-aaaaaaaaaaaa — yes, it's literally just a's, that's the canonical form, don't come for me 🌈
watcherclient.common.utils.serialize_file_to_dict(filename)
watcherclient.common.utils.split_and_deserialize(string, exclude_fields=[])
Split and try to JSON deserialize a string.
okay we are deep in the utils weeds and there is still more to come, so hydrate and stay tuned 💖
Gets a string with the KEY=VALUE format, split it (using = as the separator) and try to JSON deserialize the VALUE.
Returns — a tuple of (key, value). Cute, right? ✨
🎀 Module contents (the osc one)
watcherclient.osc package
Submodules
watcherclient.osc.plugin module
watcherclient.osc.plugin.build_option_parser(parser) — the hook where you add your global options. That's literally its whole job bestie 💅
watcherclient.osc.plugin.check_api_version(check_version) — validates the version the user handed over. It returns:
Trueif the version is OK 👑Falseif the version hasn't been checked and the previous plugin check should be performed- ...or it throws an exception if the version is no good 😭 (yep, it will absolutely throw)
watcherclient.osc.plugin.make_client(instance) — hands you back an infra-optim service client. Slay.
🦋 Module contents (the v1 one)
watcherclient.v1 package
Submodules
watcherclient.v1.action module
class watcherclient.v1.action.Action(manager, info, loaded=False)
- Bases:
Resource(#watcherclient.common.base.Resource)
class watcherclient.v1.action.ActionManager(api)
- Bases:
Manager(#watcherclient.common.base.Manager)
Methods:
get(action_id)— get one.list(action_plan=None, audit=None, limit=None, sort_key=None, sort_dir=None, detail=False, marker=None)— Retrieve a list of action. Parameters, bestie:action_plan— UUID of the action planaudit— UUID of the auditlimit— okay this one has layers. It's the maximum number of results to return per request, if:limit > 0, the maximum number of actions to return.limit == 0, return the entire list of actions.- limit param is NOT specified (
None), the number of items returned respect the maximum imposed by the Watcher API (see Watcher'sapi.max_limitoption).
sort_key— Optional, field used for sorting.sort_dir— Optional, direction of sorting, either'asc'(the default) or'desc'.detail— Optional, boolean whether to return detailed information about actions.marker— Optional, UUID of the last action in the previous page.
Returns — a list of actions. 🫶
resource_class— alias ofActionupdate(action_id, patch)— update it.
watcherclient.v1.action_plan module
class watcherclient.v1.action_plan.ActionPlan(manager, info, loaded=False)
- Bases:
Resource(#watcherclient.common.base.Resource)
class watcherclient.v1.action_plan.ActionPlanManager(api)
- Bases:
Manager(#watcherclient.common.base.Manager)
Methods:
cancel(action_plan_id)— cancel it ✨delete(action_plan_id)— delete it 💀get(action_plan_id)— get itlist(audit=None, limit=None, sort_key=None, sort_dir=None, detail=False, marker=None)— Retrieve a list of action plan. Parameters:audit— Name of the auditlimit— maximum number of results to return per request, if:limit > 0, the maximum number of action plans to return.limit == 0, return the entire list of action plans.- limit param is NOT specified (
None), the number of items returned respect the maximum imposed by the Watcher API (see Watcher'sapi.max_limitoption).
sort_key— Optional, field used for sorting.sort_dir— Optional, direction of sorting, either'asc'(the default) or'desc'.detail— Optional, boolean whether to return detailed information about action plans.marker— The last actionplan UUID of the previous page; displays list of actionplans after"marker".
Returns — a list of action plans.
resource_class— alias ofActionPlanstart(action_plan_id)— start it 🔥update(action_plan_id, patch)— update it
watcherclient.v1.action_plan_shell module
class watcherclient.v1.action_plan_shell.CancelActionPlan(app: App, app_args: Namespace | None, cmd_name: str | None = None)
- Bases:
ShowOne(#watcherclient.common.command.ShowOne) - Cancel action plan command.
get_parser(prog_name)— Return anargparse.ArgumentParser.log=<Logger watcherclient.v1.action_plan_shell.CancelActionPlan (WARNING)>take_action(parsed_args)— Run command. Return a tuple containing the column names and an iterable containing the data to be listed.
class watcherclient.v1.action_plan_shell.DeleteActionPlan(app: _app.App, app_args: Namespace | None, cmd_name: str | None = None)
- Bases:
Command(#watcherclient.common.command.Command) - Delete action plan command.
get_parser(prog_name)— Return anargparse.ArgumentParser.log=<Logger watcherclient.v1.action_plan_shell.DeleteActionPlan (WARNING)>take_action(parsed_args)— Override to do something useful. The returned value will be returned by the program.
class watcherclient.v1.action_plan_shell.ListActionPlan(app: App, app_args: Namespace | None, cmd_name: str | None = None)
- Bases:
Lister(#watcherclient.common.command.Lister) - List information on retrieved action plans.
get_parser(prog_name)— Return anargparse.ArgumentParser.log=<Logger watcherclient.v1.action_plan_shell.ListActionPlan (WARNING)>take_action(parsed_args)— Run command. Return a tuple containing the column names and an iterable containing the data to be listed.
class watcherclient.v1.action_plan_shell.ShowActionPlan(app: App, app_args: Namespace | None, cmd_name: str | None = None)
- Bases:
ShowOne(#watcherclient.common.command.ShowOne) - Show detailed information about a given action plan.
get_parser(prog_name)— Return anargparse.ArgumentParser.log=<Logger watcherclient.v1.action_plan_shell.ShowActionPlan (WARNING)>take_action(parsed_args)— Run command. Return a tuple containing the column names and an iterable containing the data to be listed.
class watcherclient.v1.action_plan_shell.StartActionPlan(app: App, app_args: Namespace | None, cmd_name: str | None = None)
- Bases:
ShowOne(#watcherclient.common.command.ShowOne) - Start action plan command.
get_parser(prog_name)— Return anargparse.ArgumentParser.log=<Logger watcherclient.v1.action_plan_shell.StartActionPlan (WARNING)>take_action(parsed_args)— Run command. Return a tuple containing the column names and an iterable containing the data to be listed.
class watcherclient.v1.action_plan_shell.UpdateActionPlan(app: App, app_args: Namespace | None, cmd_name: str | None = None)
- Bases:
ShowOne(#watcherclient.common.command.ShowOne) - Update action plan command.
get_parser(prog_name)— Return anargparse.ArgumentParser.log=<Logger watcherclient.v1.action_plan_shell.UpdateActionPlan (WARNING)>take_action(parsed_args)— Run command. Return a tuple containing the column names and an iterable containing the data to be listed.
watcherclient.v1.action_plan_shell.drop_unsupported_field(app_args, fields, field_labels) 🌸
watcherclient.v1.action_plan_shell.format_global_efficacy(global_efficacy) ✨
watcherclient.v1.action_shell module
class watcherclient.v1.action_shell.ListAction(app: App, app_args: Namespace | None, cmd_name: str | None = None)
- Bases:
Lister(#watcherclient.common.command.Lister) - List information on retrieved actions.
get_parser(prog_name)— Return anargparse.ArgumentParser.log=<Logger watcherclient.v1.action_shell.ListAction (WARNING)>take_action(parsed_args)— Run command. Return a tuple containing the column names and an iterable containing the data to be listed.
class watcherclient.v1.action_shell.ShowAction(app: App, app_args: Namespace | None, cmd_name: str | None = None)
- Bases:
ShowOne(#watcherclient.common.command.ShowOne) - Show detailed information about a given action.
get_parser(prog_name)— Return anargparse.ArgumentParser.log=<Logger watcherclient.v1.action_shell.ShowAction (WARNING)>take_action(parsed_args)— Run command. Return a tuple containing the column names and an iterable containing the data to be listed.
class watcherclient.v1.action_shell.UpdateAction(app: App, app_args: Namespace | None, cmd_name: str | None = None)
- Bases:
ShowOne(#watcherclient.common.command.ShowOne) - Update action command.
get_parser(prog_name)— Return anargparse.ArgumentParser.log=<Logger watcherclient.v1.action_shell.UpdateAction (WARNING)>take_action(parsed_args)— Run command. Return a tuple containing the column names and an iterable containing the data to be listed.
watcherclient.v1.action_shell.drop_unsupported_field(app_args, fields, field_labels) 💜
watcherclient.v1.audit module
class watcherclient.v1.audit.Audit(manager, info, loaded=False)
- Bases:
Resource(#watcherclient.common.base.Resource)
class watcherclient.v1.audit.AuditManager(api)
- Bases:
Manager(#watcherclient.common.base.Manager)
Methods:
create(**kwargs)— make a new onedelete(audit)— yeet it 💀get(audit)— grab itlist(audit_template=None, limit=None, sort_key=None, sort_dir=None, detail=False, goal=None, strategy=None, marker=None)— Retrieve a list of audit. Parameters:audit_template— Name of the audit templatelimit— the maximum number of results to return per request, if:limit > 0, the maximum number of audits to return.
...and the rest of that limit bullet goes like:
limit == 0→ you get the entire list of audits, no cap, the whole buffet 🍓limitparam is NOT specified (None) → the number of items returned respects the maximum imposed by the Watcher API (peep Watcher'sapi.max_limitoption, iykyk 👀)
sort_key— optional, the field used for sorting ✨sort_dir— optional, direction of sorting, either'asc'(that's the default, bestie) or'desc'detail— optional boolean, controls whether you get detailed information about auditsmarker— optional, the UUID of the last audit in the previous page 🎀
Returns — a list of audits. slay.
resource_class — alias of Audit 💅
update(audit, patch) — the manager's update hook. zero prose in the docs for this one, just the signature, and honestly that's all we're getting 🙈
watcherclient.v1.audit_shell module
class watcherclient.v1.audit_shell.CreateAudit(app: App, app_args: Namespace | None, cmd_name: str | None = None)
Bases: ShowOne
Create new audit. that's the whole job bestie 💖
get_parser(prog_name)— Return anargparse.ArgumentParser.log=<Logger watcherclient.v1.audit_shell.CreateAudit (WARNING)>take_action(parsed_args)— Run command. Returns a tuple containing the column names and an iterable containing the data to be listed 🌸
class watcherclient.v1.audit_shell.DeleteAudit(app: _app.App, app_args: Namespace | None, cmd_name: str | None = None)
Bases: Command
Delete audit command. bye bye audit 👋
get_parser(prog_name)— Return anargparse.ArgumentParser.log=<Logger watcherclient.v1.audit_shell.DeleteAudit (WARNING)>take_action(parsed_args)— Override to do something useful. The returned value will be returned by the program.
class watcherclient.v1.audit_shell.ListAudit(app: App, app_args: Namespace | None, cmd_name: str | None = None)
Bases: Lister
List information on retrieved audits. give me the whole roster 📋
get_parser(prog_name)— Return anargparse.ArgumentParser.log=<Logger watcherclient.v1.audit_shell.ListAudit (WARNING)>take_action(parsed_args)— Run command. Returns a tuple containing the column names and an iterable containing the data to be listed.
class watcherclient.v1.audit_shell.ShowAudit(app: App, app_args: Namespace | None, cmd_name: str | None = None)
Bases: ShowOne
Show detailed information about a given audit. the full lore on one audit 🔍
get_parser(prog_name)— Return anargparse.ArgumentParser.log=<Logger watcherclient.v1.audit_shell.ShowAudit (WARNING)>take_action(parsed_args)— Run command. Returns a tuple containing the column names and an iterable containing the data to be listed.
class watcherclient.v1.audit_shell.UpdateAudit(app: App, app_args: Namespace | None, cmd_name: str | None = None)
Bases: ShowOne
Update audit command. glow-up time ✨
get_parser(prog_name)— Return anargparse.ArgumentParser.log=<Logger watcherclient.v1.audit_shell.UpdateAudit (WARNING)>take_action(parsed_args)— Run command. Returns a tuple containing the column names and an iterable containing the data to be listed.
drop_unsupported_field(app_args, fields, field_labels)
module-level helper, and the docs give us literally nothing else about it — the signature IS the documentation bestie 🫶
watcherclient.v1.audit_template module
class watcherclient.v1.audit_template.AuditTemplate(manager, info, loaded=False)
Bases: Resource
(no extra prose in the docs, it just exists and we love it for that 🎀)
class watcherclient.v1.audit_template.AuditTemplateManager(api)
Bases: Manager
create(**kwargs)— the create hook, signature only, no prose 🙈delete(audit_template_id)— the delete hook, takes the audit template idget(audit_template_id)— the get hook, takes the audit template idlist(name=None, goal=None, strategy=None, limit=None, sort_key=None, sort_dir=None, detail=False, marker=None)— Retrieve a list of audit template.
Parameters
name— Name of the audit templatelimit— The maximum number of results to return per request, if:limit > 0→ the maximum number of audit templates to return.limit == 0→ return the entire list ofaudit_templates.limitparam is NOT specified (None) → the number of items returned respects the maximum imposed by the Watcher API (see Watcher'sapi.max_limitoption).
sort_key— Optional, field used for sorting.sort_dir— Optional, direction of sorting, either'asc'(the default) or'desc'.detail— Optional, boolean whether to return detailed information aboutaudit_templates.marker— Optional, UUID of the last audit template of the previous page.
Returns — A list of audit templates. 💖
resource_class— alias ofAuditTemplate⭐update(audit_template_id, patch)— update hook, takes the audit template id and the patch
watcherclient.v1.audit_template_shell module
class watcherclient.v1.audit_template_shell.CreateAuditTemplate(app: App, app_args: Namespace | None, cmd_name: str | None = None)
Bases: ShowOne
Create new audit template. fresh template just dropped 🔥
get_parser(prog_name)— Return anargparse.ArgumentParser.log=<Logger watcherclient.v1.audit_template_shell.CreateAuditTemplate (WARNING)>take_action(parsed_args)— Run command. Returns a tuple containing the column names and an iterable containing the data to be listed.
class watcherclient.v1.audit_template_shell.DeleteAuditTemplate(app: _app.App, app_args: Namespace | None, cmd_name: str | None = None)
Bases: Command
Delete audit template command. yeet the template 💀
get_parser(prog_name)— Return anargparse.ArgumentParser.log=<Logger watcherclient.v1.audit_template_shell.DeleteAuditTemplate (WARNING)>take_action(parsed_args)— Override to do something useful. The returned value will be returned by the program.
class watcherclient.v1.audit_template_shell.ListAuditTemplate(app: App, app_args: Namespace | None, cmd_name: str | None = None)
Bases: Lister
List information on retrieved audit templates. lineup time 🎀
get_parser(prog_name)— Return anargparse.ArgumentParser.log=<Logger watcherclient.v1.audit_template_shell.ListAuditTemplate (WARNING)>take_action(parsed_args)— Run command. Returns a tuple containing the column names and an iterable containing the data to be listed.
class watcherclient.v1.audit_template_shell.ShowAuditTemplate(app: App, app_args: Namespace | None, cmd_name: str | None = None)
Bases: ShowOne
Show detailed information about a given audit template. all the deets 🔍
get_parser(prog_name)— Return anargparse.ArgumentParser.log=<Logger watcherclient.v1.audit_template_shell.ShowAuditTemplate (WARNING)>take_action(parsed_args)— Run command. Returns a tuple containing the column names and an iterable containing the data to be listed.
class watcherclient.v1.audit_template_shell.UpdateAuditTemplate(app: App, app_args: Namespace | None, cmd_name: str | None = None)
Bases: ShowOne
Update audit template command. edit that template, make it iconic ✨
get_parser(prog_name)— Return anargparse.ArgumentParser.log=<Logger watcherclient.v1.audit_template_shell.UpdateAuditTemplate (WARNING)>take_action(parsed_args)— Run command. Returns a tuple containing the column names and an iterable containing the data to be listed.
watcherclient.v1.client module
class watcherclient.v1.client.Client(endpoint=None, *args, **kwargs)
Bases: object
Client for the Watcher v1 API. the main character of this module, fr fr 👑
Parameters
endpoint(string) — A user-supplied endpoint URL for the watcher service.token(function) — Provides token for authentication. 🔑timeout(integer) — Allows customization of the timeout for client http requests. (optional)
watcherclient.v1.data_model module
class watcherclient.v1.data_model.DataModel(manager, info, loaded=False)
Bases: Resource
(again, no extra prose — it's a Resource and that's the vibe 🦋)
class watcherclient.v1.data_model.DataModelManager(api)
Bases: Manager
list(data_model_type='compute', audit=None)— Retrieve a list of data model. 📊
Parameters
data_model_type— The type of data model user wants to list. Supported values:compute. Future support values:storage,baremetal. The default value iscompute.audit— The UUID of the audit, used to filter data model by the scope in audit.
Returns — A list of data model. 💖
resource_class— alias ofDataModel⭐
watcherclient.v1.data_model_shell module
class watcherclient.v1.data_model_shell.ListDataModel(app: App, app_args: Namespace | None, cmd_name: str | None = None)
Bases: Lister
List information on retrieved data model. 👑
get_parser(prog_name)— Return anargparse.ArgumentParser.get_tuple(dic, fields)— helper that hands you back a tuple, signature's all we got 🤷log=<Logger watcherclient.v1.data_model_shell.ListDataModel (WARNING)>take_action(parsed_args)— Run command.
Return a tuple containing the column names and an iterable containing the data to be listed. ✨ (yeah that's the tail end of the take_action from up there ☝️ we're still going bestie don't scroll away)
🎯 watcherclient.v1.goal module
🌟 class watcherclient.v1.goal.Goal(manager, info, loaded=False)
Bases: Resource 💜
That's it, that's the whole class description. A Goal resource. No notes, no drama, she simply exists.
👑 class watcherclient.v1.goal.GoalManager(api)
Bases: Manager 🫶
get(goal)— grab a single goal. No extra description given, she's a woman of few words.list(limit=None, sort_key=None, sort_dir=None, detail=False, marker=None)— ok so this one pulls back a whole list of goal, and the parameters are:limit— the maximum number of results to return per request, if:limit > 0, the maximum number of audits to return.limit == 0, return the entire list of audits.limitparam is NOT specified (None), the number of items returned respects the maximum imposed by the Watcher API (see Watcher'sapi.max_limitoption).
🫠 yes it literally says audits in the goal docs. we do not make the rules, we just report them faithfully, bestie.
sort_key— optional, the field used for sorting.sort_dir— optional, direction of sorting, either'asc'(the default) or'desc'.detail— optional, boolean for whether to return detailed information about audits.marker— optional, the UUID of the last goal in the previous page.
Returns — a list of goals. ✨
resource_class— alias ofGoal.
🦋 watcherclient.v1.goal_shell module
💅 class watcherclient.v1.goal_shell.ListGoal(app: App, app_args: Namespace | None, cmd_name: str | None = None)
Bases: Lister 🌸
Lists the info on your retrieved goals. That's her whole job and she's iconic at it.
get_parser(prog_name)— returns anargparse.ArgumentParser.log = <Logger watcherclient.v1.goal_shell.ListGoal (WARNING)>take_action(parsed_args)— runs the command, and returns a tuple containing the column names plus an iterable holding the data to be listed.
⭐ class watcherclient.v1.goal_shell.ShowGoal(app: App, app_args: Namespace | None, cmd_name: str | None = None)
Bases: ShowOne 🎀
Shows detailed information about a given goal. Detail mode: activated.
get_parser(prog_name)— returns anargparse.ArgumentParser.log = <Logger watcherclient.v1.goal_shell.ShowGoal (WARNING)>take_action(parsed_args)— runs the command, and returns a tuple containing the column names plus an iterable holding the data to be listed.
🌈 watcherclient.v1.resource_fields module
No cap, there is literally nothing documented under this one. Empty. Void. A little ghost module 👻 — she's listed in the docs and that's her entire contribution.
🔥 watcherclient.v1.scoring_engine module
🧚 class watcherclient.v1.scoring_engine.ScoringEngine(manager, info, loaded=False)
Bases: Resource 💖
The ScoringEngine resource itself. Short and sweet.
🍓 class watcherclient.v1.scoring_engine.ScoringEngineManager(api)
Bases: Manager 💫
get(scoring_engine_name)— fetch one scoring engine by name. That's the whole note, she's lowkey.list(limit=None, sort_key=None, sort_dir=None, detail=False)— retrieves a list of scoring engines:limit— the maximum number of results to return per request, if:limit > 0, the maximum number of scoring engines to return.limit == 0, return the entire list of scoring engines.limitparam is NOT specified (None), the number of items returned respects the maximum imposed by the Watcher API (see Watcher'sapi.max_limitoption).
sort_key— optional, the field used for sorting.sort_dir— optional, direction of sorting, either'asc'(the default) or'desc'.detail— optional, boolean for whether to return detailed information about scoring engines.
Returns — a list of scoring engines. 🔥
👀 notice there's no marker here. different method, different vibes. we don't add what isn't there.
resource_class— alias ofScoringEngine.
🎀 watcherclient.v1.scoring_engine_shell module
🦄 class watcherclient.v1.scoring_engine_shell.ListScoringEngine(app: App, app_args: Namespace | None, cmd_name: str | None = None)
Bases: Lister 🌸
Lists the info on your retrieved scoring engines.
get_parser(prog_name)— returns anargparse.ArgumentParser.log = <Logger watcherclient.v1.scoring_engine_shell.ListScoringEngine (WARNING)>take_action(parsed_args)— runs the command, and returns a tuple containing the column names plus an iterable holding the data to be listed.
🌟 class watcherclient.v1.scoring_engine_shell.ShowScoringEngine(app: App, app_args: Namespace | None, cmd_name: str | None = None)
Bases: ShowOne 💜
Shows detailed information about a given scoring engine.
get_parser(prog_name)— returns anargparse.ArgumentParser.log = <Logger watcherclient.v1.scoring_engine_shell.ShowScoringEngine (WARNING)>take_action(parsed_args)— runs the command, and returns a tuple containing the column names plus an iterable holding the data to be listed.
🌸 watcherclient.v1.service module
🫶 class watcherclient.v1.service.Service(manager, info, loaded=False)
Bases: Resource ✨
The Service resource. Main character energy, minimal documentation.
👑 class watcherclient.v1.service.ServiceManager(api)
Bases: Manager 💫
get(service)— get one service. That's the note. Move along, nothing else to see 🫡list(limit=None, sort_key=None, sort_dir=None, detail=False)— retrieves a list of services:limit— the maximum number of results to return per request, if:limit > 0, the maximum number of services to return.limit == 0, return the entire list of services.limitparam is NOT specified (None), the number of items returned respects the maximum imposed by the Watcher API (see Watcher'sapi.max_limitoption).
sort_key— optional, the field used for sorting.sort_dir— optional, direction of sorting, either'asc'(the default) or'desc'.detail— optional, boolean for whether to return detailed information about services.
Returns — a list of services. ⭐
(again: no marker param. we stay faithful. 💅)
resource_class— alias ofService.
🦋 watcherclient.v1.service_shell module
🌈 class watcherclient.v1.service_shell.ListService(app: App, app_args: Namespace | None, cmd_name: str | None = None)
Bases: Lister 🎀
Lists the info on your retrieved services.
get_parser(prog_name)— returns anargparse.ArgumentParser.log = <Logger watcherclient.v1.service_shell.ListService (WARNING)>take_action(parsed_args)— runs the command, and returns a tuple containing the column names plus an iterable holding the data to be listed.
💖 class watcherclient.v1.service_shell.ShowService(app: App, app_args: Namespace | None, cmd_name: str | None = None)
Bases: ShowOne 🌸
Shows detailed information about a given service.
get_parser(prog_name)— returns anargparse.ArgumentParser.log = <Logger watcherclient.v1.service_shell.ShowService (WARNING)>take_action(parsed_args)— runs the command, and returns a tuple containing the column names plus an iterable holding the data to be listed.
🧚 watcherclient.v1.strategy module
💜 class watcherclient.v1.strategy.Strategy(manager, info, loaded=False)
Bases: Resource 💫
The Strategy resource. Slay, no further notes.
🔥 class watcherclient.v1.strategy.StrategyManager(api)
Bases: Manager ⭐
get(strategy)— grab one strategy. That's the entire documentation and honestly? respect.list(goal=None, limit=None, sort_key=None, sort_dir=None, detail=False, marker=None)— retrieves a list of strategy. Ok so this one's got an extra filter bestie, watch:goal— the UUID of the goal to filter by. 🎯limit— the maximum number of results to return per request, if:limit > 0, the maximum number of audits to return.limit == 0, return the entire list of audits.limitparam is NOT specified (None), the number of items returned respects the maximum imposed by the Watcher API (see Watcher'sapi.max_limitoption).
🫠 yep, "audits" again. copying the docs faithfully, not fixing them, that's the assignment.
sort_key— optional, the field used for sorting.sort_dir— optional, direction of sorting, either'asc'(the default) or'desc'.detail— optional, boolean for whether to return detailed information about audits.marker— optional, the UUID of the last strategy in the previous page.
Returns — a list of audits. 😭 (yes, audits. the docs said what they said.)
resource_class— alias ofStrategy.state(strategy)— also exists. No description attached, she's mysterious like that 🙈
🎀 watcherclient.v1.strategy_shell module
🦄 class watcherclient.v1.strategy_shell.ListStrategy(app: App, app_args: Namespace | None, cmd_name: str | None = None)
Bases: Lister 🌸
Lists the info on your retrieved strategies.
get_parser(prog_name)— returns anargparse.ArgumentParser.log = <Logger watcherclient.v1.strategy_shell.ListStrategy (WARNING)>take_action(parsed_args)— runs the command, and returns a tuple containing the column names plus an iterable holding the data to be listed.
👑 class watcherclient.v1.strategy_shell.ShowStrategy(app: App, app_args: Namespace | None, cmd_name: str | None = None)
Bases: ShowOne 💖
Shows detailed information about a given strategy.
get_parser(prog_name)— returns anargparse.ArgumentParser.
Still in ShowStrategy, bestie — just these last two bits before we bounce:
log— exact line:log = <Logger watcherclient.v1.strategy_shell.ShowStrategy (WARNING)>take_action(parsed_args)— Runs the command. Returns a tuple containing the column names and an iterable containing the data to be listed.
✨ class watcherclient.v1.strategy_shell.StateStrategy(app: App, app_args: Namespace | None, cmd_name: str | None = None)
Bases: Lister (watcherclient.common.command.Lister)
Grabs information about strategy requirements. Slay.
get_parser(prog_name)— Returns anargparse.ArgumentParser.log— exact line:log = <Logger watcherclient.v1.strategy_shell.StateStrategy (WARNING)>take_action(parsed_args)— Runs the command. Returns a tuple containing the column names and an iterable containing the data to be listed.
🧩 Module contents
Bestie, we're in manager city now. Every param, default, and alias is about to show up — keep your eyes on the backticks. 👀
🦋 class watcherclient.v1.Action(manager, info, loaded=False)
Bases: Resource (watcherclient.common.base.Resource)
No extra methods here, just the base class doing its thing. Periodt.
💅 class watcherclient.v1.ActionManager(api)
Bases: Manager (watcherclient.common.base.Manager)
get(action_id)list(action_plan=None, audit=None, limit=None, sort_key=None, sort_dir=None, detail=False, marker=None)— Retrieve a list of action.
Parameters
action_plan— UUID of the action plan.audit— UUID of the audit.limit— The maximum number of results to return per request, if:limit > 0, the maximum number of actions to return.limit == 0, return the entire list of actions.limitparam is NOT specified (None), the number of items returned respect the maximum imposed by the Watcher API (see Watcher'sapi.max_limitoption).
sort_key— Optional, field used for sorting.sort_dir— Optional, direction of sorting, either'asc'(the default) or'desc'.detail— Optional, boolean whether to return detailed information about actions.marker— Optional, UUID of the last action in the previous page.
Returns: A list of actions.
resource_class— alias ofAction(watcherclient.v1.action.Action).update(action_id, patch)
🎀 class watcherclient.v1.ActionPlan(manager, info, loaded=False)
Bases: Resource (watcherclient.common.base.Resource)
🔥 class watcherclient.v1.ActionPlanManager(api)
Bases: Manager (watcherclient.common.base.Manager)
cancel(action_plan_id)delete(action_plan_id)get(action_plan_id)list(audit=None, limit=None, sort_key=None, sort_dir=None, detail=False, marker=None)— Retrieve a list of action plan.
Parameters
audit— Name of the audit.limit— The maximum number of results to return per request, if:limit > 0, the maximum number of action plans to return.limit == 0, return the entire list of action plans.limitparam is NOT specified (None), the number of items returned respect the maximum imposed by the Watcher API (see Watcher'sapi.max_limitoption).
sort_key— Optional, field used for sorting.sort_dir— Optional, direction of sorting, either'asc'(the default) or'desc'.detail— Optional, boolean whether to return detailed information about action plans.marker— The last actionplan UUID of the previous page; displays list of actionplans after"marker".
Returns: A list of action plans.
resource_class— alias ofActionPlan(watcherclient.v1.action_plan.ActionPlan).start(action_plan_id)update(action_plan_id, patch)
🌸 class watcherclient.v1.Audit(manager, info, loaded=False)
Bases: Resource (watcherclient.common.base.Resource)
💜 class watcherclient.v1.AuditManager(api)
Bases: Manager (watcherclient.common.base.Manager)
create(**kwargs)delete(audit)get(audit)list(audit_template=None, limit=None, sort_key=None, sort_dir=None, detail=False, goal=None, strategy=None, marker=None)— Retrieve a list of audit.
Parameters
audit_template— Name of the audit template.limit— The maximum number of results to return per request, if:limit > 0, the maximum number of audits to return.limit == 0, return the entire list of audits.limitparam is NOT specified (None), the number of items returned respect the maximum imposed by the Watcher API (see Watcher'sapi.max_limitoption).
sort_key— Optional, field used for sorting.sort_dir— Optional, direction of sorting, either'asc'(the default) or'desc'.detail— Optional, boolean whether to return detailed information about audits.marker— Optional, UUID of the last audit in the previous page.
Returns: A list of audits.
resource_class— alias ofAudit(watcherclient.v1.audit.Audit).update(audit, patch)
✨ class watcherclient.v1.AuditTemplate(manager, info, loaded=False)
Bases: Resource (watcherclient.common.base.Resource)
🌈 class watcherclient.v1.AuditTemplateManager(api)
Bases: Manager (watcherclient.common.base.Manager)
create(**kwargs)delete(audit_template_id)get(audit_template_id)list(name=None, goal=None, strategy=None, limit=None, sort_key=None, sort_dir=None, detail=False, marker=None)— Retrieve a list of audit template.
Parameters
name— Name of the audit template.limit— The maximum number of results to return per request, if:limit > 0, the maximum number of audit templates to return.limit == 0, return the entire list ofaudit_templates.limitparam is NOT specified (None), the number of items returned respect the maximum imposed by the Watcher API (see Watcher'sapi.max_limitoption).
sort_key— Optional, field used for sorting.sort_dir— Optional, direction of sorting, either'asc'(the default) or'desc'.detail— Optional, boolean whether to return detailed information aboutaudit_templates.marker— Optional, UUID of the last audit template of the previous page.
Returns: A list of audit templates.
resource_class— alias ofAuditTemplate(watcherclient.v1.audit_template.AuditTemplate).update(audit_template_id, patch)
🫶 class watcherclient.v1.DataModel(manager, info, loaded=False)
Bases: Resource (watcherclient.common.base.Resource)
🧚 class watcherclient.v1.DataModelManager(api)
Bases: Manager (watcherclient.common.base.Manager)
list(data_model_type='compute', audit=None)— Retrieve a list of data model.
Parameters
data_model_type— The type of data model user wants to list. Supported values:compute. Future support values:storage,baremetal. The default value iscompute.audit— The UUID of the audit, used to filter data model by the scope in audit.
Returns: A list of data model.
resource_class— alias ofDataModel(watcherclient.v1.data_model.DataModel).
🍓 class watcherclient.v1.Goal(manager, info, loaded=False)
Bases: Resource (watcherclient.common.base.Resource)
👑 class watcherclient.v1.GoalManager(api)
Bases: Manager (watcherclient.common.base.Manager)
get(goal)list(limit=None, sort_key=None, sort_dir=None, detail=False, marker=None)— Retrieve a list of goal.
Parameters
limit— The maximum number of results to return per request, if:limit > 0, the maximum number of audits to return.limit == 0, return the entire list of audits.limitparam is NOT specified (None), the number of items returned respect the maximum imposed by the Watcher API (see Watcher'sapi.max_limitoption).
sort_key— Optional, field used for sorting.sort_dir— Optional, direction of sorting, either'asc'(the default) or'desc'.detail— Optional, boolean whether to return detailed information about audits.marker— Optional, UUID of the last goal in the previous page.
Returns: A list of goals.
resource_class— alias ofGoal(watcherclient.v1.goal.Goal).
⭐ class watcherclient.v1.ScoringEngine(manager, info, loaded=False)
Bases: Resource (watcherclient.common.base.Resource)
💖 class watcherclient.v1.ScoringEngineManager(api)
Bases: Manager (watcherclient.common.base.Manager)
get(scoring_engine_name)list(limit=None, sort_key=None, sort_dir=None, detail=False)— Retrieve a list of scoring engines.
Parameters
limit— The maximum number of results to return per request, if:
limit > 0→ the max number of scoring engines to come back at you 💅limit == 0→ give me the WHOLE list of scoring engines, no cap 🫶limitparam is NOT specified (None) → the number of items returned respect the maximum imposed by the Watcher API (see Watcher'sapi.max_limitoption) 👑
sort_key— optional, the field you wanna sort by ✨sort_dir— optional, direction of sorting, either'asc'(the default, bestie) or'desc'🌸detail— optional, boolean for whether you want the detailed info about scoring engines 🔍
Returns — a list of scoring engines 💖
resource_class — alias of ScoringEngine (that's watcherclient.v1.scoring_engine.ScoringEngine for the full address, iykyk) 🎀
class watcherclient.v1.Service(manager, info, loaded=False)
Bases: Resource (watcherclient.common.base.Resource).
That's the Service resource, periodt 🦋
class watcherclient.v1.ServiceManager(api)
Bases: Manager (watcherclient.common.base.Manager).
get(service)— that's the getter, no extra notes attached 🙈list(limit=None, sort_key=None, sort_dir=None, detail=False)— retrieve a list of services 😌
Parameters
limit— the maximum number of results to return per request, if:limit > 0→ the maximum number of services to return.limit == 0→ return the entire list of services.limitparam is NOT specified (None) → the number of items returned respect the maximum imposed by the Watcher API (see Watcher'sapi.max_limitoption).
sort_key— optional, field used for sorting ✨sort_dir— optional, direction of sorting, either'asc'(the default) or'desc'🌈detail— optional, boolean whether to return detailed information about services 👀
Returns — a list of services 💖
resource_class — alias of Service (watcherclient.v1.service.Service) 🎀
class watcherclient.v1.Strategy(manager, info, loaded=False)
Bases: Resource (watcherclient.common.base.Resource).
The Strategy resource itself 🌸
class watcherclient.v1.StrategyManager(api)
Bases: Manager (watcherclient.common.base.Manager).
get(strategy)— the getter for strategies, slay 💅list(goal=None, limit=None, sort_key=None, sort_dir=None, detail=False, marker=None)— retrieve a list of strategy 🔥
Parameters
goal— the UUID of the goal to filter by 🎯limit— the maximum number of results to return per request, if:limit > 0→ the maximum number of audits to return.limit == 0→ return the entire list of audits.limitparam is NOT specified (None) → the number of items returned respect the maximum imposed by the Watcher API (see Watcher'sapi.max_limitoption).
yes bestie, the original really does say "audits" in the strategy section — I'm not fixing it, I'm just reporting it as-is 😭💀
sort_key— optional, field used for sorting ✨sort_dir— optional, direction of sorting, either'asc'(the default) or'desc'🦋detail— optional, boolean whether to return detailed information about audits (again, as written 👑)marker— optional, UUID of the last strategy in the previous page 📑
Returns — a list of audits. (verbatim from the source, no cap 🫶)
resource_class — alias of Strategy (watcherclient.v1.strategy.Strategy) 🎀
state(strategy)— yep, it's there, that's the whole note 🧚
🌟 Submodules 🌟
watcherclient.client module
watcherclient.client.Client(version, *args, **kwargs)
Initialize client object based on given version ✨
HOW-TO: the simplest way to create a client instance is initialization with your credentials:
>>> from watcherclient import client
>>> watcher = client.Client(VERSION, USERNAME, PASSWORD,
... PROJECT_ID, AUTH_URL)Here VERSION can be a string or watcherclient.api_versions.APIVersion obj. If you prefer string value, you can use 1 or 1.X (where X is a microversion) 🌸
Alternatively, you can create a client instance using the keystoneauth session API. See "The watcherclient Python API" page at python-watcherclient's doc 📚
watcherclient.client.get_client(...) — get an authenticated client, based on the credentials 👑
Full signature, exactly as written (yes it's a whole paragraph of params, we stay faithful):
watcherclient.client.get_client(api_version, os_auth_token=None,
watcher_url=None, os_username=None, os_password=None, os_auth_url=None,
os_project_id=None, os_project_name=None, os_tenant_id=None,
os_tenant_name=None, os_region_name=None, os_user_domain_id=None,
os_user_domain_name=None, os_project_domain_id=None,
os_project_domain_name=None, os_service_type=None,
os_endpoint_type=None, insecure=None, timeout=None, os_cacert=None,
ca_file=None, os_cert=None, cert_file=None, os_key=None, key_file=None,
os_infra_optim_api_version=None, max_retries=None, retry_interval=None,
session=None, os_endpoint_override=None, **ignored_kwargs)Parameters 💖
api_version— the API version to use. Valid value:'1'.os_auth_token— pre-existing token to re-use 🔑watcher_url— watcher API endpoint 🌐os_username— name of a user 🙋os_password— user's password 🤫os_auth_url— endpoint to authenticate against 🚪os_project_id— ID of a project 📁os_project_name— name of a project 🏷️os_tenant_id— ID of a tenant (deprecated in favour ofos_project_id) ⚠️os_tenant_name— name of a tenant (deprecated in favour ofos_project_name) ⚠️os_region_name— name of a keystone region 🗺️os_user_domain_id— ID of a domain the user belongs to 🏠os_user_domain_name— name of a domain the user belongs to 🏡os_project_domain_id— ID of a domain the project belongs to 🏢os_project_domain_name— name of a domain the project belongs to 🏬os_service_type— the type of service to lookup the endpoint for 🔎os_endpoint_type— the type (exposure) of the endpoint 🚦insecure— allow insecure SSL (no cert verification) 😬timeout— allows customization of the timeout for client HTTP requests ⏱️os_cacert— path to cacert file 📜ca_file— path to cacert file, deprecated in favour ofos_cacert⚠️os_cert— path to cert file 📄cert_file— path to cert file, deprecated in favour ofos_cert⚠️os_key— path to key file 🗝️key_file— path to key file, deprecated in favour ofos_key⚠️os_infra_optim_api_version— watcher API version to use 🎀max_retries— maximum number of retries in case of conflict error 🔁retry_interval— amount of time (in seconds) between retries in case of conflict error ⏳session— Keystone session to use 🤝os_endpoint_override— watcher API endpoint 🌐ignored_kwargs— all the other params that are passed. Left for backwards compatibility. They are ignored 💀
watcherclient.exceptions module
watcherclient.exceptions.AmbigiousAuthSystem — alias of AmbiguousAuthSystem. (yes, the typo is real and it's iconic, we keep it exactly 🫶)
exception watcherclient.exceptions.AmbiguousAuthSystem
Bases: ClientException (watcherclient.common.apiclient.exceptions.ClientException).
Could not obtain token and endpoint using provided credentials. 😭
exception watcherclient.exceptions.CommandError
Bases: ClientException (watcherclient.common.apiclient.exceptions.ClientException).
Error in CLI tool.
An alias of watcherclient.common.apiclient.CommandError 💅
exception watcherclient.exceptions.InternalServerError(message=None, details=None, response=None, request_id=None, url=None, method=None, http_status=None)
Bases: HttpServerError (watcherclient.common.apiclient.exceptions.HttpServerError).
HTTP 500 — Internal Server Error. 🚨
A generic error message, given when no more specific message is suitable. An alias of watcherclient.common.apiclient.InternalServerError.
http_status = 500message = 'Internal Server Error'
exception watcherclient.exceptions.InvalidAttribute
Bases: ClientException (watcherclient.common.apiclient.exceptions.ClientException). 🙈
exception watcherclient.exceptions.Unauthorized(message=None, details=None, response=None, request_id=None, url=None, method=None, http_status=None)
Bases: HTTPClientError (watcherclient.common.apiclient.exceptions.HTTPClientError).
HTTP 401 — Unauthorized. 🔒
Similar to 403 Forbidden, but specifically for use when authentication is required and has failed or has not yet been provided. An alias of watcherclient.common.apiclient.Unauthorized.
http_status = 401message = 'Unauthorized'
exception watcherclient.exceptions.UnsupportedVersion
Bases: Exception.
Unsupported API Version.
Indicates that the user is trying to use an unsupported version of the API 🚫
exception watcherclient.exceptions.ValidationError
Bases: ClientException (watcherclient.common.apiclient.exceptions.ClientException).
Error in validation on API client side.
A generic error message, given when no more specific message is suitable. An alias of watcherclient.common.apiclient.ValidationError ✅
watcherclient.exceptions.from_response(response, message=None, traceback=None, method=None, url=None)
Return an HttpError instance based on response from httplib/requests 🌀
watcherclient.shell module
Command-line interface to the Watcher API. 💻✨
class watcherclient.shell.WatcherShell(**kwargs)
Bases: App.
Watcher command line interface 👑
okay picking right back up in the watcherclient.shell roster, bestie, no context needed 💅
build_option_parser(description, version, argparse_kwargs=None)— sets up the global arguments for the whole app. This one is inherited from the framework, so she's not doing anything new, just showing up and slaying the same way as always ✨configure_logging()— configures logging for the app. that's it. that's the whole job 🎀create_client(args)— the original gives us literally no blurb here, just the signature. iconic minimalism, honestly 🫶 (the name is the whole vibe: she makes you a client from yourargs)prepare_to_run_command(cmd)— gets everything ready to actually run the command. She checks that the minimal parameters are there, and she creates the client interface. Inherited from the framework, so you already know the drill 😌run(argv)— basically the main program for the application, no cap.- Parameters
argv(listofstr) — your input arguments and options 💖
- Parameters
watcherclient.shell.main(argv=None)
🦋 watcherclient.version module 🦋
Module contents — that's literally all the original says here, so that's all we're passing along, mwah 💋
💜 watcherclient Python API 💜
okay so this is the fun part. The watcherclient Python API is how you get at watcher, the OpenStack TODEFINE Service. (yes, "TODEFINE" is really in there, we don't make the rules 😭)
so like, to mess with audits, you interact with an watcherclient.v1.audit object (docs live at api/watcherclient.v1.audit.html#watcherclient.v1.audit.Audit). And you get access to those audits through attributes of the watcherclient.v1.client.Client object (docs at api/watcherclient.v1.client.html#watcherclient.v1.client.Client). cute, right? one object holds the keys to another 🔑
✨ Usage ✨
Get a Client object
First things first, bestie: make a watcherclient.v1.client.Client instance (docs: api/watcherclient.v1.client.html#watcherclient.v1.client.Client) by passing your credentials to watcherclient.client.get_client() (docs: api/watcherclient.client.html#watcherclient.client.get_client). By default, the Watcher system is configured so that only administrators (users with the 'admin' role) have access. so like… get the role first, queen 👑
There are two different sets of credentials you can roll with:
- watcher endpoint and auth token
- Identity Service (keystone) credentials
Using watcher endpoint and auth token
An auth token plus the watcher endpoint is enough to authenticate:
os_auth_token: authentication token (from Identity Service)watcher_url: watcher API endpoint, eghttp://watcher.example.org:9322/v1
To create the client, you can use the API like so (copying this EXACTLY, character for character, because we do not touch the code 🫶):
>>> from watcherclient import client
>>>
>>> kwargs = {'os_auth_token': '3bcc3d3a03f44e3d8377f9247b0ad155'
>>> 'watcher_url': 'http://watcher.example.org:9322/'}
>>> watcher = client.get_client(1, **kwargs)Using Identity Service (keystone) credentials
These Identity Service credentials work for auth:
os_username: name of useros_password: user's passwordos_auth_url: Identity Service endpoint for authorizationos_tenant_{name|id}: name or ID of tenant
And to create a client, you can use the API like so:
>>> from watcherclient import client
>>>
>>> kwargs = {'os_username': 'name',
>>> 'os_password': 'password',
>>> 'os_auth_url': 'http://keystone.example.org:5000/',
>>> 'os_tenant_name': 'tenant'}
>>> watcher = client.get_client(1, **kwargs)Perform watcher operations
Once you've got a watcher Client (docs: api/watcherclient.v1.client.html#watcherclient.v1.client.Client), you can get into all sorts of tasks, like:
>>> watcher.action.list() # list of actions
>>> watcher.action_plan.list() # list of action_plan
>>> watcher.audit.get(audit_uuid_or_name) # information about a particular auditAnd whenever the Client (docs: api/watcherclient.v1.client.html#watcherclient.v1.client.Client) needs to throw an exception, she'll usually raise an instance listed over in watcherclient.exceptions (docs: api/watcherclient.exceptions.html). no surprises, she tells you where the receipts are 🧾
Refer to the modules themselves for more details — that's the official word and we're respecting it 💅
watcherclient Modules
(yep, that's the whole section heading — no modules spelled out here, she's just a signpost 🪧)
🌸 INSTALLATION 🌸
if you've got virtualenvwrapper installed (docs: https://virtualenvwrapper.readthedocs.org/en/latest/install.html), here's the whole glow-up routine:
$ mkvirtualenv python-watcherclient
$ git clone https://opendev.org/openstack/python-watcherclient
$ cd python-watcherclient && python setup.py install
$ pip install -r ./requirements.txtthat's the entire ritual. go off 👑
🔥 CONTRIBUTING TO PYTHON-WATCHERCLIENT 🔥
if you're interested in contributing to the python-watcherclient project, the following will help get you started. welcome to the group chat, we're so happy you're here 🫶
🎀 Developer Certificate of Origin 🎀
In order to contribute to the python-watcherclient project, you need to adhere to the Developer Certificate of Origin (docs: https://developercertificate.org/). OpenStack utilizes the Developer Certificate of Origin (DCO) as a lightweight means to confirm that you are entitled to contribute the code you submit. This ensures that you are providing your contributions under the project's license and that you have the right to do so. it's giving ✨paperwork that protects everyone✨ and honestly it's not even that deep, just sign it 💖
See also:
🌈 LaunchPad Project 🌈
Most of the tools used for OpenStack depend on a launchpad.net ID for authentication. After signing up for a launchpad account, join the "openstack" team to have access to the mailing list and receive notifications of important events. so like, make the account, join the team, get the notifications. no cap, that's how you stay in the loop 📬
See also:
⭐ Project Hosting Details ⭐
🐛 Bug tracker
https://launchpad.net/python-watcherclient
📮 Mailing list (prefix subjects with [watcher] for faster responses)
http://lists.openstack.org/cgi-bin/mailman/listinfo/openstack-discuss
🧚 Code Hosting
https://opendev.org/openstack/python-watcherclient
👑 Code Review
https://review.opendev.org/#/q/status:open+project:openstack/python-watcherclient,n,z
✍️ Author ✍️
Author name not set — she's mysterious like that 🙈
💖 Copyright 💖
OpenStack Foundation
that's a wrap on the whole page, bestie 🎉 this gem is from the PYTHON-WATCHERCLIENT(1) manual, source/version 4.11.0, dated the truly iconic Jan 02, 1980 — yes, that date is really in the footer and we're obsessed with it. drink some water, go read the modules, and slay your deployments 💅✨🦋
📦 where this page comes from
- nixpkgs unstable: python3.13-python-watcherclient 4.11.0
- 💖 girlified by deepseek-ai/DeepSeek-V4.1-Flash-1017 on : a language model's rewrite of the original, under its terms