summaryrefslogtreecommitdiffstats
path: root/docs
diff options
context:
space:
mode:
Diffstat (limited to 'docs')
-rwxr-xr-xdocs/Chapter7/VNF-On-boarding-and-package-management.rst12
-rw-r--r--docs/Chapter8/Ansible-Playbook-Examples.rst8
-rw-r--r--docs/Chapter8/VES_Registration_3_2.rst2
-rw-r--r--docs/conf.py21
-rw-r--r--docs/index.rst1
5 files changed, 37 insertions, 7 deletions
diff --git a/docs/Chapter7/VNF-On-boarding-and-package-management.rst b/docs/Chapter7/VNF-On-boarding-and-package-management.rst
index 2c57a1e..f9be04a 100755
--- a/docs/Chapter7/VNF-On-boarding-and-package-management.rst
+++ b/docs/Chapter7/VNF-On-boarding-and-package-management.rst
@@ -166,15 +166,15 @@ Resource Description
:target: VNF or PNF PROVIDER
:keyword: MUST
:introduced: dublin
+ :updated: frankfurt
:impacts: DCAE,Documentation,Integration,SDC
:validation_mode: static
- The VNF or PNF PROVIDER *MUST* provide the Service Provider with
- PM Meta Data (PM Dictionary) to support the analysis of PM events delivered
- to DCAE. The PM Dictionary is to be provided as a separate YAML artifact at
- onboarding and must follow the VES Event Listener Specification and VES
- Event Registration Specification which contain the format and content
- required.
+ THe VNF or PNF PROVIDER **MUST** provide PM Meta Data (:ref:`PM_Dictionary`)
+ to support the analysis of PM data delivered to DCAE.
+ The PM Dictionary is to be provided as a separate YAML artifact at
+ onboarding and must follow the VES Event Registration Specification
+ which contain the format and content required.
Resource Configuration
^^^^^^^^^^^^^^^^^^^^^^^
diff --git a/docs/Chapter8/Ansible-Playbook-Examples.rst b/docs/Chapter8/Ansible-Playbook-Examples.rst
index 9e4604c..ce57fd1 100644
--- a/docs/Chapter8/Ansible-Playbook-Examples.rst
+++ b/docs/Chapter8/Ansible-Playbook-Examples.rst
@@ -117,12 +117,13 @@ addresses were scrubbed):
[wp0ny:children]
oam
rdb
+ oamvip
Virtual IP addresses that can be used by multiple VMs, usually, used by the
active VM of an active-standby pair, are placed under a group named after the
VNFC (VM) type, plus "vip" string, example of such a group name "oamvip". An
inventory hosts file site also contains a (group) with all groups as children
-(see last three lines in above example), to load site specific variables like
+(see last four lines in above example), to load site specific variables like
NTP, DNS IP addresses, and other site specific variables, making them global
variables to be used by playbooks, namely, configure playbook.
@@ -728,6 +729,7 @@ With no names, only IP addresses, template "InventoryNames": "None" (Default)
[wp0ny:children]
oam
rdb
+ oamvip
With VM names and IP addresses, template inventory names setting
"InventoryNames": "VM"
@@ -752,6 +754,7 @@ With VM names and IP addresses, template inventory names setting
[wp0ny:children]
oam
rdb
+ oamvip
With VNFC names and IP addresses, template inventory names setting
"InventoryNames": "VNFC"
@@ -776,6 +779,7 @@ With VNFC names and IP addresses, template inventory names setting
[wp0ny:children]
oam
rdb
+ oamvip
@@ -862,6 +866,8 @@ Ansible Server.
[wp0ny:children]
oam
rdb
+ oamvip
+
Virtual IP addresses that can be used by multiple VMs, usually, used by the
active VM of an active-standby pair, are placed under a group named after the
diff --git a/docs/Chapter8/VES_Registration_3_2.rst b/docs/Chapter8/VES_Registration_3_2.rst
index 370a5ee..91899ce 100644
--- a/docs/Chapter8/VES_Registration_3_2.rst
+++ b/docs/Chapter8/VES_Registration_3_2.rst
@@ -915,6 +915,8 @@ This means that the trigger fires if condition B occurs 3 (or more)
times in 5 minutes, OR, if condition D occurs 2 (or more) times in 10
minutes AND condition C is in effect.
+.. _PM_Dictionary:
+
PM Dictionary
~~~~~~~~~~~~~~
diff --git a/docs/conf.py b/docs/conf.py
index 8f40e8b..314670a 100644
--- a/docs/conf.py
+++ b/docs/conf.py
@@ -13,3 +13,24 @@ html_last_updated_fmt = '%d-%b-%y %H:%M'
def setup(app):
app.add_stylesheet("css/ribbon_onap.css")
+
+
+from docutils.parsers.rst import directives
+
+needs_extra_options = {
+ "target": directives.unchanged,
+ "keyword": directives.unchanged,
+ "introduced": directives.unchanged,
+ "updated": directives.unchanged,
+ "impacts": directives.unchanged,
+ "validation_mode": directives.unchanged,
+ "validated_by": directives.unchanged,
+ "test": directives.unchanged,
+ "test_case": directives.unchanged,
+ "test_file": directives.unchanged,
+ "notes": directives.unchanged,
+}
+
+needs_id_regex = "^[A-Z0-9]+-[A-Z0-9]+"
+needs_id_required = True
+needs_title_optional = True
diff --git a/docs/index.rst b/docs/index.rst
index 86c82e9..630cf0b 100644
--- a/docs/index.rst
+++ b/docs/index.rst
@@ -1,4 +1,5 @@
.. Modifications Copyright © 2017-2018 AT&T Intellectual Property.
+.. _master_index:
.. Licensed under the Creative Commons License, Attribution 4.0 Intl.
(the "License"); you may not use this documentation except in compliance