diff options
author | Ezhilarasi <ezhrajam@in.ibm.com> | 2019-04-23 20:43:47 +0530 |
---|---|---|
committer | Ezhilarasi <ezhrajam@in.ibm.com> | 2019-04-23 20:43:53 +0530 |
commit | 4b46bb158aed182dca8c088c47e6450d2df155b4 (patch) | |
tree | 22ef0cc29c15ff4480391ef5ff8e2efb6632d9e4 /docs | |
parent | f332e6ecd2c0a9f26451f977c941f03ed8ab84dc (diff) |
Added design time specifications in doc
Change-Id: Idb6a627b1c270a503d61287dd9078e93b48ceaf0
Issue-ID: CCSDK-1221
Signed-off-by: Ezhilarasi <ezhrajam@in.ibm.com>
Diffstat (limited to 'docs')
-rw-r--r-- | docs/designtime.rst | 56 |
1 files changed, 56 insertions, 0 deletions
diff --git a/docs/designtime.rst b/docs/designtime.rst new file mode 100644 index 000000000..304a98e2b --- /dev/null +++ b/docs/designtime.rst @@ -0,0 +1,56 @@ +.. This work is licensed under a Creative Commons Attribution 4.0 International License. +.. http://creativecommons.org/licenses/by/4.0 +.. Copyright (C) 2019 IBM. + +Design Time User Guide +====================== + +Bellow are the requirements to enable automation for a service within ONAP. + +For instantiation, the goal is to be able to automatically resolve all the HEAT/Helm variables, called cloud parameters. + +For post-instantiation, the goal is to configure the VNF with initial configuration. + +Prerequisite +============ + +* Gather the cloud parameters: + +instantiation: + +Have the HEAT template along with the HEAT environment file. + +or + +Have the Helm chart along with the Values.yaml file + +(CDS supports, but whether SO → Multicloud support for Helm/K8S is different story) + + +Post-instantiation: + +Have the configuration template to apply on the VNF. + +* XML for NETCONF +* JSON / XML for RESTCONF +* not supported yet - CLI +* JSON for Ansible [not supported yet] + +*Identify which template parameters are static and dynamic +*Create and fill-in the a table for all the dynamic values + +While doing so, identify the resources using the same process to be resolved; for instance, if two IPs has to be resolved through the same IPAM, the process the resolve the IP is the same. + + +Services: +============= + +.. toctree:: + :maxdepth: 1 + + CBA/index + datadictionary/index + resourceassignment + component + template + resquirement |