watcher.api.controllers.v1.audit module¶

In the Watcher system, an Audit is a request for optimizing a Cluster.

The optimization is done in order to satisfy one Goal on a given Cluster.

For each Audit, the Watcher system generates an Action Plan.

To see the life-cycle and description of an Audit states, visit the Audit State machine.

service None

Bases: watcher.api.controllers.base.APIBase

API representation of an audit.

This class enforces type checking and value constraints, and converts between the internal object model and the API representation of an audit.

classmethod Audit.convert_with_links(rpc_audit, expand=True)¶

classmethod Audit.sample(expand=True)¶

service None

Bases: watcher.api.controllers.v1.collection.Collection

API representation of a collection of audits.

static AuditCollection.convert_with_links(rpc_audits, limit, url=None, expand=False, **kwargs)¶

classmethod AuditCollection.sample()¶

service None

Bases: watcher.api.controllers.v1.types.JsonPatchType

static AuditPatchType.mandatory_attrs()¶

Returns a list of mandatory attributes.

Mandatory attributes can’t be removed from the document. This method should be overwritten by derived class.

static AuditPatchType.validate(patch)¶

service None

Bases: wsme.types.Base

AuditPostType.as_audit(context)¶

service None

Bases: pecan.rest.RestController

REST controller for Audits.

AuditsController.delete(audit)[source]¶

Delete an audit.

Parameters:	audit – UUID or name of an audit.

AuditsController.detail(goal=None, marker=None, limit=None, sort_key='id', sort_dir='asc')[source]¶

Retrieve a list of audits with detail.

Parameters:	goal – goal UUID or name to filter by marker – pagination marker for large data sets. limit – maximum number of resources to return in a single result. sort_key – column to sort results by. Default: id. sort_dir – direction to sort. “asc” or “desc”. Default: asc.

AuditsController.get_all(marker=None, limit=None, sort_key='id', sort_dir='asc', goal=None, strategy=None)[source]¶

Retrieve a list of audits.

Parameters:	marker – pagination marker for large data sets. limit – maximum number of resources to return in a single result. sort_key – column to sort results by. Default: id. sort_dir – direction to sort. “asc” or “desc”. Default: asc. goal – goal UUID or name to filter by strategy – strategy UUID or name to filter by

AuditsController.get_one(audit)[source]¶

Retrieve information about the given audit.

Parameters:	audit – UUID or name of an audit.

AuditsController.patch(audit, patch)[source]¶

Update an existing audit.

Parameters:	audit – UUID or name of an audit. patch – a json PATCH document to apply to this audit.

AuditsController.post(audit_p)[source]¶

Create a new audit.

Parameters:	audit_p – an audit within the request body.