Merge "Add documentation for components spec property - tls info"

3 files changed, 177 insertions, 131 deletions

diff --git a/docs/sections/design-components/component-specification/component-json-schema.rst b/docs/sections/design-components/component-specification/component-json-schema.rst
index 18139598..d1d4ef49 100644
--- a/docs/sections/design-components/component-specification/component-json-schema.rst
+++ b/docs/sections/design-components/component-specification/component-json-schema.rst
@@ -52,9 +52,9 @@ The same is provided below for documentation reference.
           "uniqueItems": true,
           "items": {
             "oneOf": [
-                { "$ref": "#/definitions/publisher_http" },
-                { "$ref": "#/definitions/publisher_message_router" },
-                { "$ref": "#/definitions/publisher_data_router" }
+              { "$ref": "#/definitions/publisher_http" },
+              { "$ref": "#/definitions/publisher_message_router" },
+              { "$ref": "#/definitions/publisher_data_router" }
             ]
           }
         },
@@ -63,9 +63,9 @@ The same is provided below for documentation reference.
           "uniqueItems": true,
           "items": {
             "oneOf": [
-                { "$ref": "#/definitions/subscriber_http" },
-                { "$ref": "#/definitions/subscriber_message_router" },
-                { "$ref": "#/definitions/subscriber_data_router" }
+              { "$ref": "#/definitions/subscriber_http" },
+              { "$ref": "#/definitions/subscriber_message_router" },
+              { "$ref": "#/definitions/subscriber_data_router" }
             ]
           }
         }
@@ -98,7 +98,7 @@ The same is provided below for documentation reference.
         "provides"
       ]
     },
-   "parameters" : {
+    "parameters" : {
       "anyOf" : [
         {"$ref": "#/definitions/docker-parameters"},
         {"$ref": "#/definitions/cdap-parameters"}
@@ -120,25 +120,25 @@ The same is provided below for documentation reference.
     "policy_info": {
       "type": "object",
       "properties": {
-        "policy": 
+        "policy":
         {
           "type": "array",
-          "items": 
+          "items":
           {
             "type": "object",
-            "properties": 
+            "properties":
             {
-              "node_label": 
+              "node_label":
               {
                 "type": "string"
               },
-              "policy_id": 
+              "policy_id":
               {
-              "type": "string"
+                "type": "string"
               },
-              "policy_model_id": 
+              "policy_model_id":
               {
-              "type": "string"
+                "type": "string"
               }
             },
             "required": ["node_label", "policy_model_id"]
@@ -173,18 +173,18 @@ The same is provided below for documentation reference.
         "app_preferences" : {
           "description" : "Parameters Passed down to the CDAP preference API",
           "type": "array",
-            "uniqueItems": true,
-            "items": {
-              "$ref": "#/definitions/parameter"
-            }
+          "uniqueItems": true,
+          "items": {
+            "$ref": "#/definitions/parameter"
+          }
         },
         "app_config" : {
           "description" : "Parameters Passed down to the CDAP App Config",
           "type": "array",
-            "uniqueItems": true,
-            "items": {
-              "$ref": "#/definitions/parameter"
-            }
+          "uniqueItems": true,
+          "items": {
+            "$ref": "#/definitions/parameter"
+          }
         }
       }
     },
@@ -199,11 +199,11 @@ The same is provided below for documentation reference.
         },
         "program_pref":{
           "description" : "Parameters that the CDAP developer wants pushed to this program's preferences API. Optional",
-            "type": "array",
-            "uniqueItems": true,
-            "items": {
-              "$ref": "#/definitions/parameter"
-            }
+          "type": "array",
+          "uniqueItems": true,
+          "items": {
+            "$ref": "#/definitions/parameter"
+          }
         }
       },
       "required": ["program_type", "program_id", "program_pref"]
@@ -221,8 +221,8 @@ The same is provided below for documentation reference.
     },
     "parameter": {
       "oneOf": [
-         {"$ref": "#/definitions/parameter-list"},
-         {"$ref": "#/definitions/parameter-other"}
+        {"$ref": "#/definitions/parameter-list"},
+        {"$ref": "#/definitions/parameter-other"}
       ]
     },
     "parameter-list": {
@@ -255,10 +255,10 @@ The same is provided below for documentation reference.
           }
         },
         "entry_schema": {
-            "description": "The optional property used to declare the name of the Datatype definition for entries of certain types. entry_schema must be defined when the type is list.  This is the only type it is currently supported for.",
-                "type": "object",
-                "uniqueItems": true,
-                "items": {"$ref": "#/definitions/list-parameter"}
+          "description": "The optional property used to declare the name of the Datatype definition for entries of certain types. entry_schema must be defined when the type is list.  This is the only type it is currently supported for.",
+          "type": "object",
+          "uniqueItems": true,
+          "items": {"$ref": "#/definitions/list-parameter"}
         },
         "designer_editable": {
           "description": "A required property that declares a parameter as editable by designer in SDC Tool (true) or not (false).",
@@ -376,44 +376,44 @@ The same is provided below for documentation reference.
       "additionalProperties": false
     },
     "policy_schema_parameter": {
-        "type": "object",
-        "properties": {
-            "name": {
-                "type": "string"
-            },
-            "value": {
-                "description": "Default value for the parameter"
-            },
-            "description": {
-                "description": "Description for the parameter.",
-                "type": "string"
-            },
-            "type": {
-                "description": "The required data type for the parameter.",
-                "type": "string",
-                "enum": [ "string", "number", "boolean", "datetime", "list", "map" ]
-            },
-            "required": {
-                "description": "An optional key that declares a parameter as required (true) or not (false). Default is true.",
-                "type": "boolean",
-                "default": true
-            },
-            "constraints": {
-                "description": "The optional list of sequenced constraint clauses for the parameter.",
-                "type": "array",
-                "items": {
-                    "$ref": "#/definitions/parameter-constraints"
-                }
-            },
-            "entry_schema": {
-                "description": "The optional key that is used to declare the name of the Datatype definition for entries of certain types. entry_schema must be defined when the type is either list or map. If the type is list and the entry type is a simple type (string, number, boolean, datetime), follow with a simple string to describe the entry type. If the type is list and the entry type is a map, follow with an array to describe the keys for the entry map. If the type is list and the entry type is also list, this is not currently supported here. If the type is map, then follow with an array to describe the keys for this map. ",
-                "type": "array", "uniqueItems": true, "items": {"$ref": "#/definitions/policy_schema_parameter"}
-            }
-       },
-        "required": [
-            "name",
-            "type"
-            ],
+      "type": "object",
+      "properties": {
+        "name": {
+          "type": "string"
+        },
+        "value": {
+          "description": "Default value for the parameter"
+        },
+        "description": {
+          "description": "Description for the parameter.",
+          "type": "string"
+        },
+        "type": {
+          "description": "The required data type for the parameter.",
+          "type": "string",
+          "enum": [ "string", "number", "boolean", "datetime", "list", "map" ]
+        },
+        "required": {
+          "description": "An optional key that declares a parameter as required (true) or not (false). Default is true.",
+          "type": "boolean",
+          "default": true
+        },
+        "constraints": {
+          "description": "The optional list of sequenced constraint clauses for the parameter.",
+          "type": "array",
+          "items": {
+            "$ref": "#/definitions/parameter-constraints"
+          }
+        },
+        "entry_schema": {
+          "description": "The optional key that is used to declare the name of the Datatype definition for entries of certain types. entry_schema must be defined when the type is either list or map. If the type is list and the entry type is a simple type (string, number, boolean, datetime), follow with a simple string to describe the entry type. If the type is list and the entry type is a map, follow with an array to describe the keys for the entry map. If the type is list and the entry type is also list, this is not currently supported here. If the type is map, then follow with an array to describe the keys for this map. ",
+          "type": "array", "uniqueItems": true, "items": {"$ref": "#/definitions/policy_schema_parameter"}
+        }
+      },
+      "required": [
+        "name",
+        "type"
+      ],
       "additionalProperties": false
     },
     "parameter-constraints": {
@@ -614,21 +614,21 @@ The same is provided below for documentation reference.
     "cdap-provider" : {
       "type": "object",
       "properties" : {
-         "request": {
-           "$ref": "#/definitions/formatPair"
-         },
-         "response": {
-           "$ref": "#/definitions/formatPair"
-         },
-         "service_name" : {
-           "type" : "string"
-         },
-         "service_endpoint" : {
-           "type" : "string"
-         },
-         "verb" : {
-           "type": "string",
-           "enum": ["GET", "PUT", "POST", "DELETE"]
+        "request": {
+          "$ref": "#/definitions/formatPair"
+        },
+        "response": {
+          "$ref": "#/definitions/formatPair"
+        },
+        "service_name" : {
+          "type" : "string"
+        },
+        "service_endpoint" : {
+          "type" : "string"
+        },
+        "verb" : {
+          "type": "string",
+          "enum": ["GET", "PUT", "POST", "DELETE"]
         }
       },
       "required" : [
@@ -637,7 +637,7 @@ The same is provided below for documentation reference.
         "service_name",
         "service_endpoint",
         "verb"
-        ]
+      ]
     },
     "docker-provider": {
       "type": "object",
@@ -810,11 +810,15 @@ The same is provided below for documentation reference.
             "use_tls": {
               "description": "Boolean flag to determine if the application is using tls certificates",
               "type": "boolean"
+            },
+            "use_external_tls": {
+              "description": "Boolean flag to determine if the application is using tls certificates for external communication",
+              "type": "boolean"
             }
           },
           "required": [
-              "cert_directory","use_tls"
-             ],
+            "cert_directory","use_tls"
+          ],
           "additionalProperties": false
         },
         "databases": {
@@ -828,34 +832,34 @@ The same is provided below for documentation reference.
           }
         },
         "policy": {
-           "properties": {
-             "trigger_type": {
-                "description": "Only value of docker is supported at this time.",
-                "type": "string",
-                "enum": ["docker"]
-             },
-             "script_path": {
-                "description": "Script command that will be executed for policy reconfiguration",
-                "type": "string"
-             }
+          "properties": {
+            "trigger_type": {
+              "description": "Only value of docker is supported at this time.",
+              "type": "string",
+              "enum": ["docker"]
             },
-            "required": [
-              "trigger_type","script_path"
-             ],
-            "additionalProperties": false
+            "script_path": {
+              "description": "Script command that will be executed for policy reconfiguration",
+              "type": "string"
+            }
+          },
+          "required": [
+            "trigger_type","script_path"
+          ],
+          "additionalProperties": false
         },
         "volumes": {
           "description": "Volume mapping to be used for Docker containers. Each entry is of the format below",
           "type": "array",
           "items": {
-          "type": "object",
+            "type": "object",
             "properties": {
               "host":{
-              "type":"object",
+                "type":"object",
                 "path": {"type": "string"}
               },
               "container":{
-              "type":"object",
+                "type":"object",
                 "bind": { "type": "string"},
                 "mode": { "type": "string"}
               }
@@ -896,7 +900,7 @@ The same is provided below for documentation reference.
       "required": [
         "type",
         "endpoint"
-        ]
+      ]
     },
     "docker_healthcheck_script": {
       "properties": {
@@ -926,8 +930,7 @@ The same is provided below for documentation reference.
       "required": [
         "type",
         "script"
-        ]
+      ]
     }
   }
  }
-
diff --git a/docs/sections/design-components/component-specification/component-type-docker.rst b/docs/sections/design-components/component-specification/component-type-docker.rst
index 7a0f8f0e..a2b0c2a3 100755
--- a/docs/sections/design-components/component-specification/component-type-docker.rst
+++ b/docs/sections/design-components/component-specification/component-type-docker.rst
@@ -1455,7 +1455,7 @@ Schema portion:
 
 .. code:: json
 
-   "auxilary_docker": {
+    "auxilary_docker": {
       "title": "Docker component specification schema",
       "type": "object",
       "properties": {
@@ -1500,11 +1500,15 @@ Schema portion:
             "use_tls": {
               "description": "Boolean flag to determine if the application is using tls certificates",
               "type": "boolean"
+            },
+            "use_external_tls": {
+              "description": "Boolean flag to determine if the application is using tls certificates for external communication",
+              "type": "boolean"
             }
           },
           "required": [
-              "cert_directory","use_tls"
-             ],
+            "cert_directory","use_tls"
+          ],
           "additionalProperties": false
         },
         "databases": {
@@ -1518,34 +1522,34 @@ Schema portion:
           }
         },
         "policy": {
-           "properties": {
-             "trigger_type": {
-                "description": "Only value of docker is supported at this time.",
-                "type": "string",
-                "enum": ["docker"]
-             },
-             "script_path": {
-                "description": "Script command that will be executed for policy reconfiguration",
-                "type": "string"
-             }
+          "properties": {
+            "trigger_type": {
+              "description": "Only value of docker is supported at this time.",
+              "type": "string",
+              "enum": ["docker"]
             },
-            "required": [
-              "trigger_type","script_path"
-             ],
-            "additionalProperties": false
+            "script_path": {
+              "description": "Script command that will be executed for policy reconfiguration",
+              "type": "string"
+            }
+          },
+          "required": [
+            "trigger_type","script_path"
+          ],
+          "additionalProperties": false
         },
         "volumes": {
           "description": "Volume mapping to be used for Docker containers. Each entry is of the format below",
           "type": "array",
           "items": {
-          "type": "object",
+            "type": "object",
             "properties": {
               "host":{
-              "type":"object",
+                "type":"object",
                 "path": {"type": "string"}
               },
               "container":{
-              "type":"object",
+                "type":"object",
                 "bind": { "type": "string"},
                 "mode": { "type": "string"}
               }
@@ -1558,4 +1562,3 @@ Schema portion:
       ],
       "additionalProperties": false
     }
-
diff --git a/docs/sections/design-components/component-specification/docker-specification.rst b/docs/sections/design-components/component-specification/docker-specification.rst
index 6dd4f927..20ce340d 100755
--- a/docs/sections/design-components/component-specification/docker-specification.rst
+++ b/docs/sections/design-components/component-specification/docker-specification.rst
@@ -45,6 +45,10 @@ mapping, volume mapping and policy reconfiguration script details.
 |                                | array   | reconfiguration script    |

 |                                |         | details                   |

 +--------------------------------+---------+---------------------------+

+| tls_info                       | JSON    | *Optional*. Information   |

+|                                | object  | about usage of tls certif\|

+|                                |         | icates                    |

++--------------------------------+---------+---------------------------+

 

 Health Check Definition

 ~~~~~~~~~~~~~~~~~~~~~~~

@@ -275,6 +279,42 @@ $reconfigure_type {“updated policies”: , “application config”: }
 |                     |              | to call ``config-binding-service``.    |

 +---------------------+--------------+----------------------------------------+

 

+TLS Info

+~~~~~~~~~~~~~~~~~

+

+TLS Info is used to trigger addition of init containers that can provide main application containers with certificates

+for internal and external communication.

+

++--------------------------------+---------+---------------------------------------------------------------------------+

+| Property Name                  | Type    | Description                                                               |

++================================+=========+===========================================================================+

+| cert_directory                 | string  | *Required*. Directory where certificates should be created.               |

+|                                |         | i.e. ``/opt/app/dcae-certificate``                                        |

++--------------------------------+---------+---------------------------------------------------------------------------+

+| use_tls                        | boolean | *Required*. A boolean that indicates whether server certificates for int\ |

+|                                |         | ernal communication should be added to the main container                 |

+|                                |         | i.e ``true``                                                              |

++--------------------------------+---------+---------------------------------------------------------------------------+

+| use_external_tls               | boolean | *Optional*. A boolean that indicates whether the component uses AAF Cert\ |

+|                                |         | Service to acquire operator certificate to protect external (between xNFs |

+|                                |         | and ONAP) traffic. For a time being only operator certificate from CMPv2  |

+|                                |         | server is supported.                                                      |

+|                                |         | i.e ``true``                                                              |

++--------------------------------+---------+---------------------------------------------------------------------------+

+

+

+Example:

+

+.. code:: json

+

+	"auxilary": {

+		"tls_info": {

+			"cert_directory": "/opt/app/dcae-certificate",

+			"use_tls": true

+			"use_external_tls": true,

+		}

+	},

+

 Docker Component Spec - Complete Example

 ----------------------------------------