summaryrefslogtreecommitdiffstats
path: root/docs/sections/DCAE-MOD/Glossary.rst
diff options
context:
space:
mode:
authorPANCHAL <dp023n@att.com>2020-03-27 19:28:03 -0400
committerDeven Panchal <dp023n@att.com>2020-04-27 23:53:52 +0000
commit0424f6f58b83ced065a0f49fdafa3e50bff18f1e (patch)
tree488f105547702c529273287d77a829fc36d3ff19 /docs/sections/DCAE-MOD/Glossary.rst
parent1d9549e5adf1feab7a5b269e3748b5027fec3746 (diff)
Add updated DCAE MOD documentation
Issue-ID: DCAEGEN2-1865 Signed-off-by: PANCHAL <dp023n@att.com> Change-Id: Iaec5bd3fedc4329ffc21f32c4ea3f65bf41ffb06 Signed-off-by: PANCHAL <dp023n@att.com>
Diffstat (limited to 'docs/sections/DCAE-MOD/Glossary.rst')
-rw-r--r--docs/sections/DCAE-MOD/Glossary.rst184
1 files changed, 184 insertions, 0 deletions
diff --git a/docs/sections/DCAE-MOD/Glossary.rst b/docs/sections/DCAE-MOD/Glossary.rst
new file mode 100644
index 00000000..b4c2beb2
--- /dev/null
+++ b/docs/sections/DCAE-MOD/Glossary.rst
@@ -0,0 +1,184 @@
+========
+Glossary
+========
+
+
+A&AI - Active and Available Inventory
+-------------------------------------
+Inventory DB for all network components
+
+
+CLAMP
+-----
+Non DCAE Platform Component - Controls the input and processing for
+Closed Loop services.
+
+
+Closed Loop
+-----------
+Services designed to monitor and report back to a controlling function
+that automatically deals with the event reported without human
+interaction.
+
+
+
+Cloudify
+--------
+Open Source application and network orchestration framework, based on
+TOSCA used in DCAE to deploy platform and service components from
+Cloudify Blueprints. Refer to `Architecture </architecture/pieces>`__
+for more information.
+
+
+Cloudify Blueprints
+-------------------
+YAML formatted file used by Cloudify to deploy platform and service
+components. Contains all the information needed for installation.
+
+
+Consul
+------
+Opensource Platform Component that supports Service Discovery,
+Configuration, and Healthcheck. Refer to
+`Architecture </architecture/pieces>`__ for more information.
+
+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. That composition occurs in the SDC.
+
+
+Config Binding Service
+----------------------
+DCAE Platform Component - Service Components use Config Binding Service
+to access Consul and retrieve configuration variables.
+
+
+Component Specification
+-----------------------
+JSON formatted file that fully describes a component and its interfaces
+
+
+Data Format / Data Format Specification
+---------------------------------------
+JSON formatted file that fully describes a components input or output
+
+
+Deployment Handler
+------------------
+DCAE Platform Component - Receives Input from DTI Handler, and talks to
+Cloudify to deploy components.
+
+
+Design-Time
+-----------
+Refers to when the System Designer uses the SDC Tool to compose services
+from components in the SDC catalog. The Designer can provide input to
+assign/override defaults for configuration for any parameter with the
+property 'designer\_editable' set to 'true'.
+
+
+Deploy-Time
+-----------
+Refers to when a service is being deployed. This can be done
+automatically via the SDC Tool, or manually via the DCAE Dashboard or
+CLAMP UI. When manually deployed, DevOps can provide input to
+assign/override defaults for configuration for any parameter with the
+property 'sourced\_at\_deployment' set to 'true'.
+
+
+Docker
+------
+Opensource Platform for development of containerized applications in the
+cloud. Many DCAE service components and all DCAE collectors are written
+utilizing Docker.
+
+
+Dmaap
+-----
+AT&T data transportation service platform that supports message-based
+topics and file-based feeds. Runs locally at the Edge and Centrally.
+
+
+Inventory
+---------
+DCAE Platform Component - Postgres DB containing Cloudify Blueprints for
+platform and service components.
+
+
+Policy
+------
+Refers to the setting of configuration parameters for a component, by
+Operations via the Policy UI.
+
+
+Policy Handler
+--------------
+DCAE Platform Component that received Policy updates from Policy UI
+
+
+Policy UI
+---------
+Non DCAE Component - Policy User Interace where Operations assigns
+values to configuraton specified for this.
+
+
+Run-Time
+--------
+Refers to the when a service is running on the platform. Often used in
+conjunction with DTI events which occur at Run-time.
+
+
+SCH - Service Change Handler
+----------------------------
+DCAE Platform Component - Receives updates from SDC and updates
+Inventory
+
+
+SDC - Service Design and Creation
+---------------------------------
+Tool used by Service Designers to compose services from SDC catalog
+artifacts. Once services are created, Cloudify Blueprints can be
+generated to deployment and installation.
+
+
+SDC Catalog
+-----------
+Catalog of composable Components and Data Formats to be used in the SDC
+Tool to create services. Currently, there is no access to the SDC
+Catalog from the dcae\_cli tool. Artifacts are manually placed there
+after testing. Every catalog artifact has a ``UUID``, a globally unique
+identifier that identifies that artifact.
+
+Self-Service
+------------
+Refers to services that are supported by SDC, and that are automatically
+installed as a result of a Service Designer's composition and submission
+of a service. Only a handful of services are 'self-service' currently.
+Most require manual effort to generate the Tosca Model files and
+Cloudify Blueprints.
+
+
+Service Component
+-----------------
+Microservice that provides network monitoring or analytic function on
+the DCAE platform.
+
+
+Service
+-------
+Generally composed of multiple service components, which is deployed to
+the DCAE platform.
+
+
+Tosca Model
+-----------
+Model generated from validated component specification, (stored in SDC
+catalog for Self-Service components), and used as input to generate
+Cloudify Blueprints
+
+
+VNF - Virtualized Network Function
+----------------------------------
+A network function that runs on one or more virtualized machines.