openstack/vitrage
Code Issues Proposed changes

Fix example errors in documentation

Browse Source 
In the documentation, there are some error messages in the template 2 syntax example.
In the definition of the alarm entity, name is required. It seems that the name is written as type.

Change-Id: I4f680719ecbe3496343384d39f8bcd23f690bb23
Closes-Bug: #1874625
This commit is contained in:
Q.hongtao 2020-04-24 14:58:23 +08:00
parent c901aef1d4
commit 496f2c91fe
2 changed files with 7 additions and 7 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

6
doc/source/contributor/not_operator_support.rst
View File

@ -81,7 +81,7 @@ There exists an instance on Host but there is no Alarm on the instance.
entities:
- entity:
category: ALARM
type: instance_mem_performance_problem
name: instance_mem_performance_problem
template_id: instance_alarm # some string
- entity:
category: RESOURCE
@ -135,7 +135,7 @@ There exists a host with no alarm.
entities:
- entity:
category: ALARM
type: host_high_mem_load
name: host_high_mem_load
template_id: host_alarm # some string
- entity:
category: RESOURCE
@ -291,7 +291,7 @@ In the subgraphs above, we had only one vertex which was not connected to the ma
template_id: stack
- entity:
category: ALARM
type: stack_high_mem_load
name: stack_high_mem_load
template_id: stack_alarm
relationships:
- relationship:

8
doc/source/contributor/vitrage-template-format-v2.rst
View File

@ -175,11 +175,11 @@ The following template demonstrates
entities:
- entity:
category: ALARM
type: host_high_mem_load
name: host_high_mem_load
template_id: host_alarm # some string
- entity:
category: ALARM
type: instance_mem_performance_problem
name: instance_mem_performance_problem
template_id: instance_alarm
- entity:
category: RESOURCE
@ -317,11 +317,11 @@ an alarm on the hosting zone or an alarm on the hosting host.
entities:
- entity:
category: ALARM
type: zone_connectivity_problem
name: zone_connectivity_problem
template_id: zone_alarm
- entity:
category: ALARM
type: host_connectivity_problem
name: host_connectivity_problem
template_id: host_alarm
- entity:
category: RESOURCE