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