docs/userguide/designtime.rst

   1 .. This work is licensed under a Creative Commons Attribution 4.0 International License.
   2 .. http://creativecommons.org/licenses/by/4.0
   3 .. Copyright (C) 2019 IBM.
   4
   5 Design Time Tools Guide
   6 =======================
   7
   8 Below are the requirements to enable automation for a service within ONAP.
   9
  10 For instantiation, the goal is to be able to automatically resolve all the HEAT/Helm variables, called cloud parameters.
  11
  12 For post-instantiation, the goal is to configure the VNF with initial configuration.
  13
  14 Prerequisite
  15 ------------
  16
  17 * Gather the cloud parameters:
  18
  19 Instantiation:
  20 ~~~~~~~~~~~~~~
  21
  22 Have the HEAT template along with the HEAT environment file (or) Have the Helm chart along with the Values.yaml file
  23
  24 (CDS supports, but whether SO → Multicloud support for Helm/K8S is different story)
  25
  26
  27 Post-instantiation:
  28 ~~~~~~~~~~~~~~~~~~~
  29
  30 Have the configuration template to apply on the VNF.
  31
  32 * XML for NETCONF
  33 * JSON / XML for RESTCONF
  34 * not supported yet - CLI
  35 * JSON for Ansible [not supported yet]
  36 * Identify which template parameters are static and dynamic
  37 * Create and fill-in the a table for all the dynamic values
  38
  39 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.
  40
  41
  42 Services:
  43 ---------
  44
  45 .. toctree::
  46    :maxdepth: 2
  47
  48    ../CBA/index
  49    ../resourcedefinition/index
  50    resourceassignment