Arnike/watcher
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

Update Watcher documentation

Browse Source 
We introduced a new watcher plugin for OpenStack CLI. This patchset
updates accordingly the watcher documentation and schemas.

Partially Implements: blueprint openstackclient-plugin

Change-Id: Ib00469c8645fff21f5ba95951379827dbd359c69
This commit is contained in:
David TARDIVEL
2016-05-24 16:35:24 +02:00
parent 4e3caaa157
commit b9231f65cc
8 changed files with 86 additions and 24 deletions
Download Patch File Download Diff File Expand all files Collapse all files

14
doc/source/image_src/plantuml/README.rst Normal file
View File

@@ -0,0 +1,14 @@
plantuml
========
To build an image from a source file, you have to upload the plantuml JAR file
available on http://plantuml.com/download.html.
After, just run this command to build your image:
.. code-block:: shell
$ cd doc/source/images
$ java -jar /path/to/plantuml.jar doc/source/image_src/plantuml/my_image.txt
$ ls doc/source/images/
my_image.png

4
doc/source/image_src/plantuml/sequence_create_and_launch_audit.txt
View File

@@ -3,7 +3,7 @@
actor Administrator
Administrator -> "Watcher CLI" : watcher audit-create -a <audit_template_uuid>
Administrator -> "Watcher CLI" : watcher audit create -a <audit_template>
"Watcher CLI" -> "Watcher API" : POST audit(parameters)
"Watcher API" -> "Watcher Database" : create new audit in database (status=PENDING)
@@ -14,7 +14,7 @@ Administrator -> "Watcher CLI" : watcher audit-create -a <audit_template_uuid>
Administrator <-- "Watcher CLI" : new audit uuid
"Watcher API" -> "AMQP Bus" : trigger_audit(new_audit.uuid)
"AMQP Bus" -> "Watcher Decision Engine" : trigger_audit(new_audit.uuid)
"AMQP Bus" -> "Watcher Decision Engine" : trigger_audit(new_audit.uuid) (status=ONGOING)
ref over "Watcher Decision Engine"
Trigger audit in the

2
doc/source/image_src/plantuml/sequence_create_audit_template.txt
View File

@@ -2,7 +2,7 @@
actor Administrator
Administrator -> "Watcher CLI" : watcher audit-template-create <name> <goal> \
Administrator -> "Watcher CLI" : watcher audittemplate create <name> <goal> \
[--strategy-uuid <strategy>]
"Watcher CLI" -> "Watcher API" : POST audit_template(parameters)

2
doc/source/image_src/plantuml/sequence_launch_action_plan.txt
View File

@@ -2,7 +2,7 @@
actor Administrator
Administrator -> "Watcher CLI" : watcher action-plan-start <action_plan_uuid>
Administrator -> "Watcher CLI" : watcher actionplan start <action_plan_uuid>
"Watcher CLI" -> "Watcher API" : PATCH action_plan(state=PENDING)
"Watcher API" -> "Watcher Database" : action_plan.state=PENDING