summaryrefslogtreecommitdiffstats
path: root/docs/Chapter8
diff options
context:
space:
mode:
authorLovett, Trevor <trevor.lovett@att.com>2018-10-23 13:05:15 -0500
committerHagop Bozawglanian <hagop.bozawglanian@att.com>2018-10-23 18:31:52 +0000
commit037512ad79639516f0bcd772b6080fe8ba28ff5e (patch)
tree1cc8082d846e67107fc20e25e2db236e4ce48f72 /docs/Chapter8
parent3558e4ae816958ead70d2032426ec09ae66b5fd0 (diff)
VNFRQTS - Fix incorrect metadata usage
Change-Id: Ic1cd85ae2afc5f3443f78365789228660fc8c3a2 Issue-ID: VNFRQTS-477 Signed-off-by: Lovett, Trevor <trevor.lovett@att.com>
Diffstat (limited to 'docs/Chapter8')
-rw-r--r--docs/Chapter8/Ansible-JSON-Key-Value-Description.rst6
-rw-r--r--docs/Chapter8/Ansible-Playbook-Examples.rst10
-rw-r--r--docs/Chapter8/Chef-JSON-Key-Value-Description.rst44
3 files changed, 30 insertions, 30 deletions
diff --git a/docs/Chapter8/Ansible-JSON-Key-Value-Description.rst b/docs/Chapter8/Ansible-JSON-Key-Value-Description.rst
index 4913823..5179518 100644
--- a/docs/Chapter8/Ansible-JSON-Key-Value-Description.rst
+++ b/docs/Chapter8/Ansible-JSON-Key-Value-Description.rst
@@ -44,11 +44,11 @@ Table B1. Ansible JSON File key value description
| | value pairs to be | |Attribute names (variable |
| | passed to the Ansible| |names) passed to Ansible |
| | playbook. These | |shall follow Ansible valid |
-| | values would | |variable names: “Variable |
+| | values would | |variable names: "Variable |
| | correspond to | |names should be letters, |
| | instance specific | |numbers, and underscores. |
| | parameters that a | |Variables should always |
-| | playbook may need to | |start with a letter.” |
+| | playbook may need to | |start with a letter." |
| | execute an action. | | |
+---------------+----------------------+---------+----------------------------+
| NodeList |Ansible inventory | Optional|If not provided, pre-loaded |
@@ -110,7 +110,7 @@ Ansible JSON file example:
In the above example, the Ansible Server will:
-a. Process the “FileParameters” dictionary and generate a file named
+a. Process the "FileParameters" dictionary and generate a file named
‘config.txt’ with contents set to the value of the ‘config.txt’ key.
b. Execute the playbook named ‘<VNFCode>/<Version>/ansible/configure/site.yml’
diff --git a/docs/Chapter8/Ansible-Playbook-Examples.rst b/docs/Chapter8/Ansible-Playbook-Examples.rst
index 9875963..5c3d5cd 100644
--- a/docs/Chapter8/Ansible-Playbook-Examples.rst
+++ b/docs/Chapter8/Ansible-Playbook-Examples.rst
@@ -447,7 +447,7 @@ Optional:
<VNF type>/<Version>/ansible/inventory/group_vars/<VNF instance name>
NOTE: Default groups will be created based on VNFC type, 3 characters,
-on VNFC name. Example: “oam”, “rdb”, “dbs”, “man”, “iox”, “app”,…
+on VNFC name. Example: "oam", "rdb", "dbs", "man", "iox", "app",…
Ansible Directories for other artifacts – VNF (special) other files –
Optional – Example – License file:
@@ -520,7 +520,7 @@ Ansible Server.
a. Includes VNF type using VNF function code 4 characters under
/storage.
- b. Includes VNF “Version” directory as part of the path to store
+ b. Includes VNF "Version" directory as part of the path to store
playbooks for this VNF version.
c. Include generic ansible root directory. Creating full directory
@@ -603,10 +603,10 @@ example:
vm\_config\_rdb4\_hostname: vfdb9904vm006
vm\_config\_rdb4\_provider\_ip\_address: 1xx.2yy.zzz.yyy
-NOTE: Please note names in this file shall use underscore “\_” not dots
-“.” or dashes “-“.
+NOTE: Please note names in this file shall use underscore "\_" not dots
+"." or dashes "-".
-7. Perform some basic playbook validation running with “--check” option,
+7. Perform some basic playbook validation running with "--check" option,
running dummy playbooks or other.
NOTE: Each Ansible Server or cluster of Ansible Server will have its own
diff --git a/docs/Chapter8/Chef-JSON-Key-Value-Description.rst b/docs/Chapter8/Chef-JSON-Key-Value-Description.rst
index ae8972f..4beeefe 100644
--- a/docs/Chapter8/Chef-JSON-Key-Value-Description.rst
+++ b/docs/Chapter8/Chef-JSON-Key-Value-Description.rst
@@ -63,7 +63,7 @@ Table A1. Chef JSON File key value description
| | as part of the desired | | |
| | VNF action. | | |
+----------------+--------------------------+---------+----------------------+
-| PushJobFlag | This field indicates |Mandatory| If set to “True”, |
+| PushJobFlag | This field indicates |Mandatory| If set to "True", |
| | whether the VNF action | | ONAP will request a |
| | requires a push Job. Push| | push job. Ignored |
| | job object will be | | otherwise. |
@@ -73,7 +73,7 @@ Table A1. Chef JSON File key value description
| CallbackCapable| This field indicates if | Optional| If Chef cookbook is |
| | the chef-client run | | callback capable, VNF|
| | invoked by push job | | owner is required to |
-| | corresponding to the VNF | | set it to “True”. |
+| | corresponding to the VNF | | set it to "True". |
| | action is capable of | | Ignored otherwise. |
| | posting results on a | | |
| | callback URL. | | |
@@ -83,7 +83,7 @@ Table A1. Chef JSON File key value description
| | retrieve output generated| | NodeObject attributes|
| | in a chef-client run from| | [‘PushJobOutput’] for|
| | Node object attribute | | all nodes in NodeList|
-| | node[‘PushJobOutput’] for| | if set to “True”. |
+| | node[‘PushJobOutput’] for| | if set to "True". |
| | this VNF action (e.g., in| | Ignored otherwise. |
| | Audit). | | |
+----------------+--------------------------+---------+----------------------+
@@ -92,39 +92,39 @@ Chef Template example:
.. code-block:: erb
- “Environment”:{
+ "Environment":{
"name": "HAR",
"description": "VNF Chef environment for HAR",
"json\_class": "Chef::Environment",
"chef\_type": "environment",
"default\_attributes": { },
"override\_attributes": {
- “Retry\_Time”:”50”,
- “MemCache”: “1024”,
- “Database\_IP”:”10.10.1.5”
+ "Retry\_Time":"50",
+ "MemCache": "1024",
+ "Database\_IP":"10.10.1.5"
},
}
}
- “Node”: {
- “name” : “signal.network.com “
+ "Node": {
+ "name" : "signal.network.com "
"chef\_type": "node",
"json\_class": "Chef::Node",
"attributes": {
- “IPAddress1”: “192.168.1.2”,
- “IPAddress2”:”135.16.162.5”,
- “MyRole”:”BE”
+ "IPAddress1": "192.168.1.2",
+ "IPAddress2":"135.16.162.5",
+ "MyRole":"BE"
},
"override": {},
"default": {},
- “normal”:{},
- “automatic”:{},
- “chef\_environment” : “\_default”
+ "normal":{},
+ "automatic":{},
+ "chef\_environment" : "\_default"
"run\_list": [ "configure\_signal" ]
},
- “NodeList”:[“node1.vnf\_a.onap.com”, “node2.vnf\_a.onap.com”],
- “PushJobFlag”: “True”
- “CallbackCapable”:True
- “GetOutputFlag” : “False”
+ "NodeList":["node1.vnf\_a.onap.com", "node2.vnf\_a.onap.com"],
+ "PushJobFlag": "True"
+ "CallbackCapable":True
+ "GetOutputFlag" : "False"
}
The example JSON file provided by the VNF provider for each VNF action will be
@@ -136,8 +136,8 @@ Some points worth noting regarding the JSON fields:
a. The JSON file must be created for each action for each VNF.
b. If a VNF action involves multiple endpoints (VMs) of a VNF, ONAP will
- replicate the “Node” JSON dictionary in the template and post it to
- each FQDN (i.e., endpoint) in the NodeList after setting the “name”
+ replicate the "Node" JSON dictionary in the template and post it to
+ each FQDN (i.e., endpoint) in the NodeList after setting the "name"
field in the Node object to be the respective FQDN [#8.1.1]_. Hence, it
is required that all end points (VMs) of a VNF involved in a VNF
action support the same set of Node Object attributes.
@@ -185,5 +185,5 @@ Table A2. JSON Dictionary to Post in Callback
+--------------+----------------------------+---------+-----------------------+
.. [#8.1.1]
- The “name” field is a mandatory field in a valid Chef Node Object
+ The "name" field is a mandatory field in a valid Chef Node Object
JSON dictionary.