docs/modelingconcepts/tosca-meta.rst

   1 .. This work is a derivative of https://wiki.onap.org/display/DW/Modeling+Concepts
   2 .. This work is licensed under a Creative Commons Attribution 4.0
   3 .. International License. http://creativecommons.org/licenses/by/4.0
   4 .. Copyright (C) 2020 Deutsche Telekom AG.
   5
   6 Tosca Meta
   7 ----------
   8
   9 Tosca meta file captures the model entities that compose the cba package name, version, type and searchable tags.
  10
  11 .. list-table::
  12    :widths: 20 15 15 50
  13    :header-rows: 1
  14
  15    * - Attribute
  16      - R/C/O
  17      - Data Type
  18      - Description
  19    * - TOSCA-Meta-File-Version
  20      - Required
  21      - String
  22      - The attribute that holds TOSCA-Meta-File-Version. Set to 1.0.0
  23    * - CSAR-Version
  24      - Required
  25      - String
  26      - The attribute that holds CSAR-version. Set to 1.0
  27    * - Created-By
  28      - Required
  29      - String
  30      - The user/s that created the CBA
  31    * - Entry-Definitions
  32      - Required
  33      - String
  34      - The attribute that holds the entry points file PATH to the main cba tosca definition file
  35        or non tosca script file.
  36    * - Template-Name
  37      - Required
  38      - String
  39      - The attribute that holds the blueprint name
  40    * - Template-Version
  41      - Required
  42      - String
  43      - | The attribute that holds the blueprint version
  44        | **X.Y.Z**
  45        | X=Major version
  46        | Y=Minor Version
  47        | Z=Revision Version
  48        | X=Ex. 1.0.0
  49    * - Template-Type
  50      - Required
  51      - String
  52      - | The attribute that holds the blueprint package types.
  53        | Valid Options:
  54        * "DEFAULT" – .JSON file consistent of tosca based cba package that describes the package intent.
  55        * "KOTLIN_DSL" – .KT file consistent of tosca based cba package that describes the package intent
  56          composed using Domain Specific Language (DSL).
  57        * "GENERIC_SCRIPT" – Script file consistent of NONE tosca based cba package that describes the package intent
  58          using DSL Language.
  59        | If not specified in the tosca.meta file the default is "DEFAULT"
  60    * - Template-Tags
  61      - Required
  62      - String
  63      - The attribute that holds the blueprint package comma delimited list of Searchable attributes.
  64
  65 **Template Type Reference**
  66
  67 **Default Template Type**
  68
  69 https://git.onap.org/ccsdk/cds/tree/components/model-catalog/blueprint-model/test-blueprint/capability_cli/TOSCA-Metadata/TOSCA.meta
  70
  71 **KOTLIN_DSL Template Type**
  72
  73 https://git.onap.org/ccsdk/cds/tree/components/model-catalog/blueprint-model/test-blueprint/resource-audit/TOSCA-Metadata/TOSCA.meta
  74
  75 **GENERIC_SCRIPT Template Type**
  76
  77 https://git.onap.org/ccsdk/cds/tree/components/model-catalog/blueprint-model/test-blueprint/capability_python/TOSCA-Metadata/TOSCA.meta