Updated overview about the Design process and added links 06/91606/2
authorandreasgeissler <andreas-geissler@telekom.de>
Wed, 17 Jul 2019 14:51:47 +0000 (16:51 +0200)
committerandreasgeissler <andreas-geissler@telekom.de>
Wed, 17 Jul 2019 17:11:55 +0000 (19:11 +0200)
Added the missing picture

Issue-ID: DOC-476

Signed-off-by: andreasgeissler <andreas-geissler@telekom.de>
Change-Id: I59bfbd503d34c495845deb2e5c276e791ec2bb6d

docs/guides/onap-user/design/index.rst
docs/guides/onap-user/design/media/Design-Overview.png [new file with mode: 0644]

index 28a808b..6155358 100644 (file)
@@ -2,6 +2,8 @@
 .. International License. http://creativecommons.org/licenses/by/4.0
 .. Copyright 2017 AT&T Intellectual Property.  All rights reserved.
 
+.. _doc_guide_user_des:
+
 Design
 ======
 
@@ -18,7 +20,81 @@ Design progresses logically through a series of phases. Each phase:
   generates artifacts that are used in other phases of design or when
   instantiating or monitoring virtual functions.
 
-Design includes the following topics:
+The following figure show the different phases and tools involved in
+Onboarding, Design and Distribution process.
+
+|image1|
+
+**The "Core" Design Process includes the following steps:**
+
+* Pre-Onboarding
+    A VNF/PNF Provider delivers VNF descriptor, model and
+    artefacts (e.g. HEAT template), which will be validated
+    and packaged for onboarding to ONAP
+
+* (Resource)-Onboarding
+    In the SDC a License Model is created, the VNF/PNF package imported
+    and a Vendor Software Product (VSP) is created
+
+* VF Creation and Testing
+    A V(N)F, PNF or CR Model is created (a) import of a VSP or VFC
+    (b) manual creation and import of artefacts created via external
+    tools like the Controller Design Studio (CDS), responsible for the
+    Controller Blueprint Design
+    The created VF will pass a testing workflow to be used
+    in a Service Model
+
+* Service Design
+    A Service Model is created as a composition of resources 
+    (e.g. V(N)Fs, PNFs,...), Policies, Workflows,...
+    The created Service Model will pass a testing workflow and
+    handed over to a Governance Approval and Distribution process
+
+* Governance Approval and Distribution
+    The Service Provider will have a specific set of policies and
+    procedures for approving Services and deploying them in the
+    Runtime Service Catalog
+
+**The optional/additional Design steps are:**
+
+* Controller Blueprint Design
+    The Controller Blueprint is the overall service design, fully model-driven,
+    intent based package needed for self service provisioning and configuration
+    management automation. The framework to automate the resolution of resources
+    for instantiation and any config provisioning operation,
+    such as day0, day1 or day2 configuration.
+    It provides a tool called Controller Design Studio
+
+* Policy Design
+    The Policy Creation component deals with policies.
+    These are rules, conditions, requirements, constraints, attributes,
+    or needs that must be provided, maintained, and/or enforced.
+    At a lower level, Policy involves machine-readable rules enabling
+    actions to be taken based on triggers or requests.
+
+* APPC Controller Design
+    APPC Controller Design Tool (CDT) is used for self-service onboarding of
+    VNF’s. VNF owners can create templates and other artifacts for APPC
+    Configure command (used to apply a post-instantiation configuration)
+    as well as other life cycle commands.
+
+* Workflow Design
+    The purpose of the Workflow Designer is to enable designers to define or
+    modify workflows to support Service/Resource change management scenarios
+    executed by the Service Orchestrator.
+
+* Control Loop Design
+    This phase includes the Design of a closed loop template and associate it
+    to a Service. The template represents the theoretical flow of the CL.
+    It generates a deployment artifact that can be ingested by the DCAE in
+    order to create the needed DCAE microservices in runtime.
+    The design is done in the SDC DCAE-DS (Design Studio).
+    The DCAE Design Studio enables to define and configure
+    the monitoring flows of DCAE.
+    The configuration and deployment of a Control Loop will be done with 
+    Control Loop Automation Management (CLAMP) tool.
+
+The follwing sections will focus on the different Design steps:
 
 .. toctree::
    :maxdepth: 1
@@ -34,8 +110,21 @@ Design includes the following topics:
 
    Governance Approval and Service Distribution <./service-distribution/index.rst>
 
-   Control Loop Design <./control-loop/index.rst>
+   Controller Blueprint Design <../../../submodules/ccsdk/cds.git/docs/index.rst>
+
+   Policy Design <../../../submodules/policy/parent.git/docs/design/design.rst>
+
+   APPC Controller Design <../../../submodules/appc.git/docs/APPC CDT Guide/APPC CDT Guide.rst>
+
+   Workflow Design <../../../submodules/sdc.git/docs/workflow.rst>
+
+   Control Loop Design <../../../submodules/sdc.git/docs/dcaedesigner.rst>
+
+   Control Loop Automation Management <../../../submodules/clamp.git/docs/index.rst>
+
+
+
+.. |image1| image:: media/Design-Overview.png
+
 
-* `Policy Design <https://wiki.onap.org/x/SYAP>`_
 
-* `SDC Artifacts List <https://wiki.onap.org/x/LYAP>`_
diff --git a/docs/guides/onap-user/design/media/Design-Overview.png b/docs/guides/onap-user/design/media/Design-Overview.png
new file mode 100644 (file)
index 0000000..f94724e
Binary files /dev/null and b/docs/guides/onap-user/design/media/Design-Overview.png differ