aboutsummaryrefslogtreecommitdiffstats
path: root/catalog-be/src/main/resources/import/tosca/models/init/README.md
diff options
context:
space:
mode:
authorandre.schmid <andre.schmid@est.tech>2021-05-28 19:10:30 +0100
committerChristophe Closset <christophe.closset@intl.att.com>2021-06-14 08:19:21 +0000
commitddf9aaefc753b492fb72144d597a27df8080a4ab (patch)
tree8d998a1287b903f6669df8568bdb6d2edda60eac /catalog-be/src/main/resources/import/tosca/models/init/README.md
parentc82aebcde26e34c4151531b4d7a8f6e7689734ba (diff)
Init ONAP model imports using the model API
Creates a client for the model endpoint in the catalog init scripts. Introduces the directory structure to provide the models along its imports, separated by init/upgrade phase. Each model structure will be zipped and uploaded to the endpoint, based on the model directory name. Change-Id: I0392c1e6d3a29b30567b11016041a8e9cccbc745 Issue-ID: SDC-3615 Signed-off-by: André Schmid <andre.schmid@est.tech>
Diffstat (limited to 'catalog-be/src/main/resources/import/tosca/models/init/README.md')
-rw-r--r--catalog-be/src/main/resources/import/tosca/models/init/README.md26
1 files changed, 26 insertions, 0 deletions
diff --git a/catalog-be/src/main/resources/import/tosca/models/init/README.md b/catalog-be/src/main/resources/import/tosca/models/init/README.md
new file mode 100644
index 0000000000..d4d1a368f9
--- /dev/null
+++ b/catalog-be/src/main/resources/import/tosca/models/init/README.md
@@ -0,0 +1,26 @@
+This folder purpose is to contain any models that needs to be created during the first
+initialization of the system (install).
+
+```bash
+├── init
+│ ├── <model_1_to_create>
+│ │ ├── payload.json
+│ │ ├── imports
+│ │ │ ├── **/*.yaml
+[...]
+│ ├── <model_n_to_create>
+│ │ ├── payload.json
+│ │ ├── imports
+│ │ │ ├── **/*.yaml
+```
+
+The model folder name is irrelevant to indicate which model should be created. This information must
+be provided in the payload.json contained within the model folder.
+
+The content of the payload.json for the model with name "ETSI SOL001 v2.5.1" is expected to be:
+```json
+{
+ "name": "ETSI SOL001 v2.5.1"
+}
+```
+