Commit Graph

120 Commits

Author SHA1 Message Date
Eyal
ceb8d85d78 add keycloak configuration doc
Change-Id: I920b6b85183720e7a5437415edb80d5f074679b2
2017-08-03 15:36:13 +03:00
Ifat Afek
b27a29fde3 Some documentation changes
- Added missing documentation of Nova notifier
- Moved osprofiler doc under contributor folder
- Marked the static-physical datasource as obsolete
- Removed a link to Aodh notifier (the document was deleted, as it was just a POC)

Depends-On: Ifcde995130486c859e6a9ce23e47a89910187732
Change-Id: Ib2b7880d65d4c6edd7cfd1f831da9da7af5e114c
2017-07-30 11:58:32 +00:00
Ifat Afek
5d40367bef Doc Migration: move the developer guide documents under the "contributor" folder
Changed files:
- index.rst
- contributor/index.rst
- installation-and-configuration - split to devstack-installation.rst and configuration.rst

Change-Id: I4683a213e2a530d2088c4f232b9c2508fc25ba68
2017-07-27 07:05:18 +00:00
Jenkins
465f5f6e6f Merge "Add document about how configure and use profiler in vitrage" 2017-07-25 14:10:57 +00:00
Yujun Zhang
9b9e53d0a6 Add document about how configure and use profiler in vitrage
Change-Id: I9e14d3846ac97412a2811f363b343d920d944b93
Implements: blueprint osprofiler-support
2017-07-25 14:55:36 +08:00
Jenkins
a54d1425b8 Merge "Create a folder for the contributor docs" 2017-07-25 01:28:05 +00:00
Ifat Afek
9d3c811176 Create a folder for the contributor docs
Change-Id: Ia16492a19db1b46921d31e960c4ffb799b456f29
2017-07-24 15:11:35 +00:00
Ifat Afek
df289c2933 Add template validations, to handle the case of actions that don't have an action_target
Two new validations are added:
1. A condition can not be only "negative". For example, instead of: "not alarm_on_instance" one should use "instance and not_alarm_on_instance"
2. There should be an entity that is common to all parts of an "or" condition.  For example, this is illegal: "alarm1_on_host or alarm2_on_instance"

Change-Id: I209155ade48ba740642670891c11aeef0868197c
Implements: blueprint support-external-actions
2017-07-24 13:28:57 +00:00
Jenkins
98806ade0d Merge "Aligning install guide with the Pike doc structure" 2017-07-05 11:33:51 +00:00
Ifat Afek
5057c96f5e Introduce the execute-mistral action. This patch includes validating the action, and converting it to a general-purpose ExecuteExternal step.
The following will be done in the *next* patches:

* Implementation of the ExternalExecute step
* Implementation of the Mistral notifier
* Documentation of the new action

Change-Id: I571861149e51bca85cb024969b8595ae85655b25
Implements: blueprint integration-with-mistral
2017-07-03 12:53:25 +00:00
csatari
c9ea8ea4a1 Aligning install guide with the Pike doc structure
In Pike OpenStack documentation is changed in a way that the project repos
contain most of the documentation material [1]. This affcects how the doc
folder shall be strucutred inside the project repo. With this change I
align the install guide to the new structure and correct the warnings
during the document generation. The overall work is tracked in [2].

[1]: http://specs.openstack.org/openstack/docs-specs/specs/pike/os-manuals-migration.html
[2]: https://etherpad.openstack.org/p/doc-migration-tracking

Change-Id: Ib5400247d2ba5f8dac80ef68a43d06868bd42f1c
Depends-On: Ia750cb049c0f53a234ea70ce1f2bbbb7a2aa9454
Signed-off-by: csatari <gergely.csatari@nokia.com>
2017-07-03 13:22:52 +02:00
Ifat Afek
cffda41a10 Describe the Vitrage HA and history vision.
I wrote it here and not as a blueprint, since it is a very wide scope and several blueprints can be created in the future for supporting this vision.

Change-Id: I9d32d7e2a45a146c5923604b0591f8a7d609f616
2017-06-14 11:45:42 +03:00
Alexey Weyl
3b1de001ec Vertex Properties refactoring
Rename vitrage properties to start with the vitrage prefix
so it will be easier work with and to recognize.

Change-Id: Ia8afaa1a13897927984a9c8d8d9b85343ef69c01
2017-06-12 09:34:38 +00:00
Jenkins
3a5045a1fd Merge "Add links to design documents" 2017-06-11 11:34:27 +00:00
Ifat Afek
a0ce352658 Add links to design documents
Change-Id: I0880c3fc49b274df99587a2a5b88b5458f4ca422
2017-06-07 14:49:22 +03:00
wingwj
6ab76a516a Fix a broken link in the installation doc
Fix a broken link for 'Vitrage-dashboard manual installation'
in the vitrage installation doc.

Change-Id: I5aa224db7c0e2adae51708fcac464ea82942a4c7
Closes-Bug: #1696055
2017-06-06 14:57:21 +08:00
Yujun Zhang
2cb1fafe2b Add support for building equivalent scenario
TemplateData is refactored to make it possible

- split SubGraph and ScenarioData from TemplateData
- build entity index and relationship index in TemplateData
- delay variable extraction to subgraph build
- simplify the process of adding scenario to repository

Implement: blueprint entity-equivalence
Change-Id: I7192e3a82880dc3c3995000c029af4e0aabd8d6c
2017-06-04 18:11:24 +08:00
Yujun Zhang
86691304c8 Add document about implementation details of template loading
- add strict tests in template data verification to help understand
- add traceback in scenario evaluator design document
- rename example templates with a more meaningful name

Change-Id: Ie5a9c34fcd6fdac3bf9d4552a0c92fb569c075fc
2017-05-17 15:57:45 +08:00
Jenkins
61720c68e9 Merge "Minor fixes in the static datasource documentation" 2017-05-15 06:39:41 +00:00
Ifat Afek
3be6a0187b Updated the Vitrage architecture diagram
Change-Id: Ib03a69805b14388c9acf03856ca96d5dd2be2b7e
2017-04-25 15:21:56 +00:00
dongwenjuan
a7c7be7936 add the resource related APIs' description
Change-Id: If279db45e6cf929bffadc43fbdc907c631effc01
Signed-off-by: dongwenjuan <dong.wenjuan@zte.com.cn>
2017-04-25 09:55:03 +08:00
Ifat Afek
b242baccc3 Minor fixes in the static datasource documentation
Change-Id: Id27759fc74ae9287368ae677c7761d8aa006a319
2017-04-13 12:53:12 +00:00
Jenkins
cf2620d1ae Merge "make a supplementary of API document" 2017-03-29 08:34:12 +00:00
Jenkins
697067e425 Merge "snmp notifier support" 2017-03-29 07:35:00 +00:00
Yujun Zhang
f967bd6513 Add documentation for static datasource
Change-Id: I04a6d84b53ad58d72ca761e22d073ca941bd9689
2017-03-24 14:56:59 +08:00
Alexey Weyl
8f327e3662 support for not operator in templates condition
Change-Id: I434b1967ee0cb91b54ab93e680a2a11bab3f8c3e
2017-03-22 15:33:47 +00:00
Anna Reznikov
961fc9d52c snmp notifier support
Change-Id: I7717f9815b1791ca61f0c91d873f2f5a30bb11f8
2017-03-22 08:48:15 +00:00
dongwenjuan
6ec312f1ad make a supplementary of API document
Change-Id: I50736771bc05c0655d3ba197568eb0c515f907f8
Signed-off-by: dongwenjuan <dong.wenjuan@zte.com.cn>
2017-03-21 14:38:38 +08:00
Alexey Weyl
e025a0acf7 fix for running nosetests locally on devstack
Change-Id: Icf6fa3352826fc6c3f826dfbdbacf10d60637037
2017-03-14 13:16:01 +00:00
Jenkins
e7d4e53613 Merge "Typo fix: Remove redundant quote mark" 2017-02-28 21:48:07 +00:00
Ifat Afek
0e0621bc5c Added manual installation documentation
Change-Id: I18e1b706dfa95614bafca8c2ed13d279befe46f9
2017-02-16 08:52:58 +00:00
Anh Tran
b8cd6311e6 Typo fix: Remove redundant quote mark
Change-Id: I82059975368007733de3087ea29903c5febb1881
2017-02-08 16:17:56 +07:00
Ifat Afek
180d557eb1 Updated Vitrage documentation and architecture diagram
Change-Id: If710046523d42cf904bf09254bfab9cb41fe03bf
Implements: blueprint support-inspector-sb-api
2017-01-17 09:06:23 +00:00
Alexey Weyl
aac14c51a2 rename internal vitrage properties
1. vitrage_sync_mode to vitrage_action_type
2. vitrage_sync_type to vitrage_entity_type

Change-Id: Icd60d8f6f6c5658449028bcec9688f61b8da7c62
2016-11-27 15:33:15 +02:00
Tovin Seven
e2b21d516d Beautify, correct URLs in documentation files
- Beautify, re-indent, format code in a lot of doc files
- Use relative URLs instead of absolute github URLs
- Some absolute github urls are not corrected yet:
    + URL for enabling vitrage in devstack
    + URL for enabling vitrage in horizon
- Update year number in doc/source/config.py from 2013 to 2016

My thought: We should have a blueprint
    to create more concise and easy to access like other project
    (nova: http://docs.openstack.org/developer/nova/).
    Currently, that site for vitrage has not existed yet.

Notes: Change github URLs to relative URLs
    (or absolute URLs in docs.openstack.org/developers)
    will not work correctly
    if we do not have official documentation site.
    Hence, other people cannot follow the link to html page
    if they read vitrage documentation in github mirror.

Change-Id: Ifff8355c7e5291f68a7592d1617644053d790d5e
2016-11-18 04:34:55 +00:00
Yujun Zhang
1cfa87f19d Fix warnings in PyCharm
Change-Id: I7e009ba19c5fc045f9bf61d6328a50c535b312f0
L52: Title length must match the title line
2016-11-14 15:47:55 +08:00
Jenkins
0f9d08adcf Merge "fix the parameter type of input and output" 2016-11-13 10:06:56 +00:00
Tovin Seven
985cc1838f Add notice to nagios devstack installation
Install devstack with vitrage before install nagios via omd
to avoid apache2 pid issue.

Reason:
    - omd manages apache2 by itself
    - horizon and keystone are sites of apache2
    - stop apache2 via service will fail beacause of omd

When using devstack, remember to stop omd apache2's sites

Change-Id: If8c1dd9dfcb5ff7819db10c1cfa3d67c021a2feb
Closes-Bug: #1629811
2016-11-08 08:34:03 +00:00
dongwenjuan
eab6a2ec8c fix the parameter type of input and output
Change-Id: Ie6dda854d808abddc7380610f5f1e157c520166e
Signed-off-by: dongwenjuan <dong.wenjuan@zte.com.cn>
2016-11-07 13:08:54 +08:00
Alexey Weyl
4f06e3a515 Multi tenancy for topology, alarms and rca apis.
Change-Id: I2ce82e755d22784df1ddefabef738a27b7c2316f
2016-10-27 13:09:38 +03:00
Ifat Afek
07dcbc343c Fixed some diagrams
Change-Id: If921a275d156dde01fe5bc132125c4baf9f00a8b
2016-10-27 00:21:59 +00:00
Tovin Seven
7667274833 Add details to config nagios GUI, re-indent lines
TrivialFix

Change-Id: Idde311968da72db909ca5a91b1d847b63bbb949a
2016-10-20 10:25:56 +07:00
Tovin Seven
184d885eed Clarify zabbix with vitrage installation guide
- Add notice about docker image
- Add notice to install oslo.messaging, oslo.config
- Hint about default devstack rabbitmq username and password
- Correct the order of zabbix configure action
- Add url to create triggers in zabbix
- Add vitrage configuration section for zabbix
    + Data sources in vitrage.conf
    + Zabbix section in vitrage.conf
    + Mapping resource name and resource type in zabbix_conf.yaml

Change-Id: I1d1ffcdf1f8cbdd9c57e0f92eb08c866533e1517
2016-10-20 02:53:18 +00:00
dongwenjuan
d38d7ee159 fix the error URL in nagios-devstack-installation.rst
Signed-off-by: dongwenjuan <dong.wenjuan@zte.com.cn>

Change-Id: I73da711568f7450c418b46b1786951dad98e8551
2016-10-13 16:23:07 +08:00
Jenkins
6eae7d0221 Merge "Correct installation file name stack -> stack.sh" 2016-10-05 06:30:43 +00:00
Tovin Seven
104c06f94c Correct installation file name stack -> stack.sh
TrivialFix

Change-Id: I60b920b3ef3812ae2e19909ebc37e9332e832072
2016-09-30 14:21:31 +07:00
Ifat Afek
5e05d161fb Documentation updates
Change-Id: I6729b73ab5fdcc07ebe37732ddaf0ed2d619af35
2016-09-29 09:21:27 +00:00
dongwenjuan
5142636240 fix some syntax error
Change-Id: Ic6902b9706786ad5f7137d9ba8652186b917f56a
Signed-off-by: dongwenjuan <dong.wenjuan@zte.com.cn>
2016-09-07 16:23:48 +08:00
Alexey Weyl
f5da3a5cd3 add new datasource documentation
Change-Id: I993032d87e86622d9185274468bbaf64408043a7
2016-09-06 13:20:24 +03:00
Yujun Zhang
70c4f3307e Fix template validation status code reference.
Keep consistency with code

Change-Id: I006dd9f009dc0f1d609bc08ac2c55b3efcabf086
2016-09-01 14:03:16 +08:00