Make platformdoc docker container

[dcaegen2.git] / platformdoc / docs / glossary.md

diff --git a/platformdoc/docs/glossary.md b/platformdoc/docs/glossary.md
new file mode 100644 (file)
index 0000000..a9f2321
--- /dev/null
+++ b/platformdoc/docs/glossary.md
@@ -0,0 +1,19 @@
+# Glossary
+
+## ASDC
+
+The ECOMP resource catalog. We assume the existince and usage of ASDC, though for near term testing purposes, we use a mock version of the catalog. 
+We assume all DCAE artifacts: components like collectors, CDAP applications, data formats (see below), etc, are onboarded and searchable in the catalog. 
+Further, we assume that every catalog artifact has a ``UUID", a globally unique identifier that identifies that artifact. 
+
+## Component
+
+Refers to a DCAE service component which is a single micro-service that is written to be run by the DCAE platform and to be composeable to form a DCAE service.
+
+## Data format
+
+Artifact that describes a data structure and schema.
+
+## Onboarding catalog
+
+The onboarding catalog is the intermediary store for project details, component specifications and data formats.  This is to be used by component developers through the `dcae-cli` to browse and to launch existing components and push their own component artifacts in preparation to move their component to the ASDC resource catalog.