aboutsummaryrefslogtreecommitdiffstats
path: root/docs/models.rst
diff options
context:
space:
mode:
authorMichaelMorris <michael.morris@est.tech>2021-09-10 20:23:19 +0100
committerVasyl Razinkov <vasyl.razinkov@est.tech>2021-09-16 14:18:42 +0000
commite3935f01aa5b412bbbe98d95678f4d9ac1b658ea (patch)
treea419763cbaf2bfa191271a179c408e20bf2710a0 /docs/models.rst
parent22d62a85bd9be6315d9f26271b5ac976255356a3 (diff)
Update docs for multi model support
Signed-off-by: MichaelMorris <michael.morris@est.tech> Issue-ID: SDC-3726 Change-Id: I4ba36318fc8c7de60ccb9c3d01d5aadedc94bded
Diffstat (limited to 'docs/models.rst')
-rw-r--r--docs/models.rst19
1 files changed, 19 insertions, 0 deletions
diff --git a/docs/models.rst b/docs/models.rst
new file mode 100644
index 0000000000..9e41f5be2a
--- /dev/null
+++ b/docs/models.rst
@@ -0,0 +1,19 @@
+.. This work is licensed under a Creative Commons Attribution 4.0 International License.
+.. http://creativecommons.org/licenses/by/4.0
+
+========================
+Models
+========================
+
+SDC supports the onboarding and design of resources and services that adhere to one of a number of models. The following models are included in the default deployment:
+
+**SDC AID**
+
+The `ONAP SDC data model <https://wiki.onap.org/display/DW/SDC+Data+model>`_ supported widely by ONAP components.
+
+**ETSI SOL001 v2.5.1**
+
+The data model for NFV descriptors standardised by ETSI, `version 2.5.1 <https://docbox.etsi.org/ISG/NFV/Open/Publications_pdf/Specs-Reports/NFV-SOL%20001v2.5.1%20-%20GS%20-%20TOSCA-based%20NFV%20descriptors%20spec.pdf>`_. Limited support exists in ONAP components, but some support is provided in SO SOL003 and SOL005 adapters and ETSI Catalog Manager.
+
+Further models can be added through the :ref:`Supported APIs <offeredapis>` at deployment or runtime.
+Model inheritance is supported though it is expected that the names of the types be unique across the inheritance tree. Resources that are imported or designed to adhere to a particular model can only be used in a service that adheres to the same model.