openstack/vitrage
Code Issues Proposed changes

Static physical configuration documentation

Browse Source 
Change-Id: I570dcd74fe8bb17009900a604c3133f376b47561
This commit is contained in:
Alexey Weyl 2016-02-24 09:28:00 +02:00
parent 0e2b012d69
commit 1cd715754d
1 changed files with 69 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

69
doc/source/static-physical-config.rst Normal file
View File

@ -0,0 +1,69 @@
====================================
Static Physical Plugin Configuration
====================================
Configure Access to Static Physical
-----------------------------------
The following should be set in **/etc/vitrage/vitrage.conf**, under synchronizer_plugins section:
+----------------------+------------------------------------+--------------------------------+
| Name | Description | Default Value |
+======================+====================================+================================+
| static_plugins_dir | Directory path from where to load | /etc/vitrage/static_plugins/ |
| | the configurations | |
+----------------------+------------------------------------+--------------------------------+
Configure Static Physical Mapping
---------------------------------
Physical configuration is made for configuring statically physical entities, and their relationships to other entities in the topology.
Some physical entities, such as switches, can not be retrieved from OpenStack, so for now we will configure them statically.
There may be more than one configuration file. All files will be read from ...
**Format**
::
entities:
- name: <Physical entity name as appears in configuration>
id: <Physical entity id as appears in configuration>
type: <Physical entity type - must be from constants.EntityType>
state: <resource state>
relationships:
- type: <Physical entity type it is connected to - must be from constants.EntityType>
name: <Physical entity name connected to as appears in configuration>
id: <Physical entity id connected to as appears in configuration>
relation_type: <Relation name>
- type: <Physical entity type it is connected to - must be from constants.EntityType>
name: <Physical entity name connected to as appears in configuration>
id: <Physical entity id connected to as appears in configuration>
relation_type: <Relation name>
...
**Example**
The following will define a switch that is attached to host-1 and is a backup of switch-2
::
entities:
- type: switch
name: switch-1
id: 11111
state: available
relationships:
- type: nova.host
name: host-1
id: 22222
relation_type: attached
- type: switch
name: switch-2
id: 33333
relation_type: backup