summaryrefslogtreecommitdiffstats
path: root/docs/modelingconcepts/tosca-meta.rst
diff options
context:
space:
mode:
authorJakobKrieg <jakob.krieg@bcmsolutions.de>2020-08-04 20:46:50 +0200
committerJakobKrieg <jakob.krieg@bcmsolutions.de>2020-08-04 20:46:59 +0200
commit7c3f39504a14c056d860e09ece970ccde349053f (patch)
tree47817becf6b1a3e481dfd6230c4f15d4f719bd2a /docs/modelingconcepts/tosca-meta.rst
parent4a01363c4634a62946d6f2befe00cbf2d9872d90 (diff)
Adding Modeling Concepts documentation from COnfluence to RDT
Issue-ID: CCSDK-2615 Change-Id: Ib5dfaecc96e8fac1dda07aa6c13aba5ded81efee Signed-off-by: JakobKrieg <jakob.krieg@bcmsolutions.de>
Diffstat (limited to 'docs/modelingconcepts/tosca-meta.rst')
-rw-r--r--docs/modelingconcepts/tosca-meta.rst80
1 files changed, 80 insertions, 0 deletions
diff --git a/docs/modelingconcepts/tosca-meta.rst b/docs/modelingconcepts/tosca-meta.rst
new file mode 100644
index 000000000..f4fed1479
--- /dev/null
+++ b/docs/modelingconcepts/tosca-meta.rst
@@ -0,0 +1,80 @@
+.. This work is a derivative of https://wiki.onap.org/display/DW/Modeling+Concepts by IBM
+.. used under Creative Commons Attribution 4.0 International License.
+.. http://creativecommons.org/licenses/by/4.0
+.. Copyright (C) 2020 Deutsche Telekom AG.
+
+Tosca Meta
+------------
+
+Tosca meta file captures the model entities that compose the cba package name, version, type and searchable tags.
+
+.. list-table::
+ :widths: 20 15 15 50
+ :header-rows: 1
+
+ * - Attribute
+ - R/C/O
+ - Data Type
+ - Description
+ * - TOSCA-Meta-File-Version
+ - Required
+ - String
+ - The attribute that holds TOSCA-Meta-File-Version. Set to 1.0.0
+ * - CSAR-Version
+ - Required
+ - String
+ - The attribute that holds CSAR-version. Set to 1.0
+ * - Created-By
+ - Required
+ - String
+ - The attribute that holds the entry points
+ * - Entry-Definitions
+ - Required
+ - String
+ - The attribute that holds the entry points file PATH to the main cba tosca definition file
+ or non tosca script file.
+ * - Template-Name
+ - Required
+ - String
+ - The attribute that holds the blueprint name
+ * - Template-Version
+ - Required
+ - String
+ - | The attribute that holds the blueprint version
+ |
+ | X.Y.Z
+ |
+ | X=Major version
+ | Y=Minor Version
+ | Z=Revision Version
+ |
+ | X=Ex. 1.0.0
+ * - Template-Type
+ - Required
+ - String
+ - | The attribute that holds the blueprint package types.
+ | Valid Options:
+ * "DEFAULT" – .JSON file consistent of tosca based cba package that describes the package intent.
+ * "KOTLIN_DSL" – .KT file consistent of tosca based cba package that describes the package intent
+ composed using Domain Specific Language (DSL).
+ * "GENERIC_SCRIPT" – Script file consistent of NONE tosca based cba package that describes the package intent
+ using DSL Language.
+ | If not specified in the tosca.meta file the default is "DEFAULT"
+ * - Template-Tags
+ - Required
+ - String
+ - The attribute that holds the blueprint package comma delimited list of Searchable attributes.
+
+**Template Type Reference**
+
+**Default Template Type**
+
+https://gerrit.onap.org/r/gitweb?p=ccsdk/cds.git;a=blob;f=components/model-catalog/blueprint-model/test-blueprint/capability_cli/TOSCA-Metadata/TOSCA.meta;hb=refs/heads/master
+
+**KOTLIN_DSL Template Type**
+
+https://gerrit.onap.org/r/gitweb?p=ccsdk/cds.git;a=blob;f=components/model-catalog/blueprint-model/test-blueprint/resource-audit/TOSCA-Metadata/TOSCA.meta;hb=refs/heads/master
+
+**GENERIC_SCRIPT Template Type**
+
+https://gerrit.onap.org/r/gitweb?p=ccsdk/cds.git;a=tree;f=ms/py-executor/test/resources/sample-cba/1.0.0;hb=refs/heads/master \ No newline at end of file