From f8c5f58ce8b2b076d5874508873829a33cc545b0 Mon Sep 17 00:00:00 2001 From: Sarah Abouzainah Date: Tue, 12 Jan 2021 14:47:21 +0200 Subject: [PATCH] Add new rst guide files Issue-ID: CCSDK-3070 Issue-ID: CCSDK-3081 Signed-off-by: Sarah Abouzainah Change-Id: I25c2488ac1ad12966a357f11ecca6e630f440ec0 --- docs/api-reference/api-doc-template.rst | 3 +- docs/api-reference/bp-processor.rst | 8 +- docs/index.rst | 3 +- docs/modelingconcepts/data-dictionary.rst | 48 +-- docs/modelingconcepts/data-type.rst | 80 ++-- docs/modelingconcepts/dynamic-payload.rst | 66 ++-- docs/modelingconcepts/node-type.rst | 1 - docs/modelingconcepts/workflow.rst | 5 +- docs/resourcedefinition/resourcesource.rst | 58 +-- docs/ui/{designer.rst => designer-guide.rst} | 344 ++++++++--------- docs/ui/hello-world-resource-resolution-cba.rst | 357 ++++++++++++++++++ docs/ui/hello-world-script-executor-cba.rst | 407 +++++++++++++++++++++ docs/usecases/pnf-simulator.rst | 2 +- docs/userguides/developer-guide/index.rst | 16 +- .../developer-guide/running-cds-ui-locally.rst | 168 +++++++++ docs/userguides/installation.rst | 3 + 16 files changed, 1232 insertions(+), 337 deletions(-) rename docs/ui/{designer.rst => designer-guide.rst} (53%) create mode 100644 docs/ui/hello-world-resource-resolution-cba.rst create mode 100644 docs/ui/hello-world-script-executor-cba.rst create mode 100644 docs/userguides/developer-guide/running-cds-ui-locally.rst diff --git a/docs/api-reference/api-doc-template.rst b/docs/api-reference/api-doc-template.rst index 689180ef6..a0dc0cec5 100644 --- a/docs/api-reference/api-doc-template.rst +++ b/docs/api-reference/api-doc-template.rst @@ -2,7 +2,6 @@ .. International License. http://creativecommons.org/licenses/by/4.0 .. Copyright (C) 2020 Deutsche Telekom AG. - .. This is a template to document new APIs for CDS blueprint processor .. make use of tabs whenever it fits @@ -27,7 +26,7 @@ Method 1 Endpoint 1 description Request ........... -.. code-block:: curl +.. code-block:: bash :caption: **(sample) request** request command diff --git a/docs/api-reference/bp-processor.rst b/docs/api-reference/bp-processor.rst index 00dd7cce6..eb29b093c 100644 --- a/docs/api-reference/bp-processor.rst +++ b/docs/api-reference/bp-processor.rst @@ -9,9 +9,9 @@ Introduction -------------- This section shows all resources and endpoints which CDS BP processor currently provides through a swagger file -which is automatically created during CDS build process by Swagger Maven Plugin. A corresponding Postman collection is +which is automatically created during CDS build process by Swagger Maven Plugin. A corresponding Postman collection is also included. Endpoints can also be described using this template -:download:`api-doc-template.rst ` but this is not the prefered way to describe the CDS API. +:download:`api-doc-template.rst ` but this is not the preferred way to describe the CDS API. You can find a sample workflow tutorial :ref:`below ` which will show how to use the endpoints in the right order. This will give you a better understanding of the CDS Blueprint Processor API. @@ -19,7 +19,7 @@ in the right order. This will give you a better understanding of the CDS Bluepri Getting Started ----------------- -If you cant access a running CDS Blueprint Processor yet, you can choose one of the below options to run it. +If you cant access a running CDS Blueprint Processor yet, you can choose one of the below options to run it. Afterwards you can start trying out the API. * CDS in Microk8s: https://wiki.onap.org/display/DW/Running+CDS+on+Microk8s (RDT link to be added) @@ -62,7 +62,7 @@ GET ``http://{{host}}:{{port}}/actuator/mappings`` Lists all endpoints from blueprints processor. -.. code-block:: curl +.. code-block:: bash :caption: **request** curl --location --request GET 'http://localhost:8081/actuator/mappings' \ diff --git a/docs/index.rst b/docs/index.rst index ef2d94f91..62e749342 100644 --- a/docs/index.rst +++ b/docs/index.rst @@ -116,7 +116,6 @@ User Guides userguides/developer-guide/index userguides/installation userguides/design-time-guide/designtime - userguides/resourceassignment Use Cases --------- @@ -132,7 +131,7 @@ CDS Designer UI .. toctree:: :maxdepth: 2 - ui/designer + ui/designer-guide Offered APIs diff --git a/docs/modelingconcepts/data-dictionary.rst b/docs/modelingconcepts/data-dictionary.rst index bfc86d0c9..9f9699a05 100644 --- a/docs/modelingconcepts/data-dictionary.rst +++ b/docs/modelingconcepts/data-dictionary.rst @@ -84,28 +84,28 @@ Here is how input-key-mapping, output-key-mapping and key-dependencies can be us * - vf-module-label data dictionary * - .. code-block:: json - { - "name" : "vf-module-label", - "tags" : "vf-module-label", - "updated-by" : "adetalhouet", - "property" : { - "description" : "vf-module-label", - "type" : "string" - }, - "sources" : { - "primary-db" : { - "type" : "source-primary-db", - "properties" : { - "type" : "SQL", - "query" : "select sdnctl.VF_MODULE_MODEL.vf_module_label as vf_module_label from sdnctl.VF_MODULE_MODEL where sdnctl.VF_MODULE_MODEL.customization_uuid=:customizationid", - "input-key-mapping" : { - "customizationid" : "vf-module-model-customization-uuid" - }, - "output-key-mapping" : { - "vf-module-label" : "vf_module_label" - }, - "key-dependencies" : [ "vf-module-model-customization-uuid" ] + { + "name" : "vf-module-label", + "tags" : "vf-module-label", + "updated-by" : "adetalhouet", + "property" : { + "description" : "vf-module-label", + "type" : "string" + }, + "sources" : { + "primary-db" : { + "type" : "source-primary-db", + "properties" : { + "type" : "SQL", + "query" : "select sdnctl.VF_MODULE_MODEL.vf_module_label as vf_module_label from sdnctl.VF_MODULE_MODEL where sdnctl.VF_MODULE_MODEL.customization_uuid=:customizationid", + "input-key-mapping" : { + "customizationid" : "vf-module-model-customization-uuid" + }, + "output-key-mapping" : { + "vf-module-label" : "vf_module_label" + }, + "key-dependencies" : [ "vf-module-model-customization-uuid" ] + } + } } - } - } - } \ No newline at end of file + } \ No newline at end of file diff --git a/docs/modelingconcepts/data-type.rst b/docs/modelingconcepts/data-type.rst index 29143de80..ee5908002 100644 --- a/docs/modelingconcepts/data-type.rst +++ b/docs/modelingconcepts/data-type.rst @@ -41,7 +41,7 @@ Users can **create** as many **data type** as needed. To create a custom data-type you can use a POST call to CDS endpoint: ":/api/v1/model-type" - .. code-block:: python + .. code-block:: json :caption: **Payload:** { @@ -51,7 +51,7 @@ Users can **create** as many **data type** as needed. "definition": { "description": "", "version": "", - "properties": {}, + "properties": "code-block::{}", "derived_from": "tosca.datatypes.Root" }, "description": " Component) of use, some attribute might be retrievable. diff --git a/docs/resourcedefinition/resourcesource.rst b/docs/resourcedefinition/resourcesource.rst index f05f09c84..942422814 100644 --- a/docs/resourcedefinition/resourcesource.rst +++ b/docs/resourcedefinition/resourcesource.rst @@ -390,32 +390,32 @@ To tell the resolution framework what is of interest in the response, the output .. code-block:: json - { - "tags" : "oam-local-ipv4-address", - "name" : "create_netbox_ip", - "property" : { - "description" : "netbox ip", - "type" : "dt-netbox-ip" - }, - "updated-by" : "adetalhouet", - "sources" : { - "config-data" : { - "type" : "source-rest", - "properties" : { - "type" : "JSON", - "verb" : "POST", - "endpoint-selector" : "ipam-1", - "url-path" : "/api/ipam/prefixes/$prefixId/available-ips/", - "path" : "", - "input-key-mapping" : { - "prefixId" : "prefix-id" - }, - "output-key-mapping" : { - "address" : "address", - "id" : "id" - }, - "key-dependencies" : [ "prefix-id" ] - } - } - } - } \ No newline at end of file + { + "tags" : "oam-local-ipv4-address", + "name" : "create_netbox_ip", + "property" : { + "description" : "netbox ip", + "type" : "dt-netbox-ip" + }, + "updated-by" : "adetalhouet", + "sources" : { + "config-data" : { + "type" : "source-rest", + "properties" : { + "type" : "JSON", + "verb" : "POST", + "endpoint-selector" : "ipam-1", + "url-path" : "/api/ipam/prefixes/$prefixId/available-ips/", + "path" : "", + "input-key-mapping" : { + "prefixId" : "prefix-id" + }, + "output-key-mapping" : { + "address" : "address", + "id" : "id" + }, + "key-dependencies" : [ "prefix-id" ] + } + } + } + } \ No newline at end of file diff --git a/docs/ui/designer.rst b/docs/ui/designer-guide.rst similarity index 53% rename from docs/ui/designer.rst rename to docs/ui/designer-guide.rst index 3f78c1fe9..bd1960726 100644 --- a/docs/ui/designer.rst +++ b/docs/ui/designer-guide.rst @@ -1,26 +1,29 @@ + .. This work is licensed under a Creative Commons Attribution 4.0 International License. .. http://creativecommons.org/licenses/by/4.0 .. Copyright (C) 2019 IBM. -CDS Designer UI -=============== +.. _designer_guide: +Designer Guide +============== .. toctree:: - :caption: Table of Contents :maxdepth: 4 +.. note:: + **How to Get Started with CDS Designer UI** -Getting Started ---------------- + If you’re new to CDS Designer UI and need to get set up, the following guides may be helpful: -This is your CDS Designer UI guide. No matter how experienced you are or -what you want to achieve, it should cover everything you need to know — -from navigating the interface to making the most of different features. + - :ref:`running_cds_ui_locally` +Getting Started +--------------- +This is your CDS Designer UI guide. No matter how experienced you are or what you want to achieve, +it should cover everything you need to know — from navigating the interface to making the most of different features. What is CDS Designer UI? ------------------------ - +----------------------------------------------+--------------+ | CDS Designer UI is a framework to automate | | | the **resolution of resources** for | |image1| | @@ -28,15 +31,15 @@ What is CDS Designer UI? | provisioning operation, such as day0, day1, | | | or day2 configuration. | | | | | +| | | | CDS has both **design-time** and | | | **run-time** activities; during design time, | | | **Designer** can **define** what **actions** | | | are required for a given service, along with | | | anything comprising the action. The design | | -| produces a `CBA | | -| Package `__. | | +| produces a :ref:`CBA Package ` | | +| | | +| | | | Its **content** is driven from a **catalog** | | | of **reusable data dictionary** and | | | **component**, delivering a reusable and | | @@ -46,10 +49,8 @@ What is CDS Designer UI? | standard**, using JSON as a representation. | | +----------------------------------------------+--------------+ - What's new? ----------- - +----------------------+----------------------+----------------------+ | |image2| | |image3| | |image4| | | | | | @@ -69,76 +70,43 @@ What's new? | | management) | | +----------------------+----------------------+----------------------+ - Overview of CDS Interface ------------------------- - -Full CDS UI screens are available in -`InVision `__ +Full CDS UI screens are available in `InVision `__ |image8| -1. **CDS main menu:** Access all CDS module list including Packages, - Data Dictionary, Controller Catalog, etc. - +1. **CDS main menu:** Access all CDS module list including Packages, Data Dictionary, Controller Catalog, etc. 2. **Profile:** Access user profile information - -3. **Module Title:** See the current module name and the total number of - items in the module list - -4. **Module list:** View all active items in module and tools for search - and filtering - +3. **Module Title:** See the current module name and the total number of items in the module list +4. **Module list:** View all active items in module and tools for search and filtering CBA Packages ------------ Package List ~~~~~~~~~~~~ - It gives you quick access to all and most recent created/edit packages |image9| -1. **Module Tabs:** Access All, Deployed, Under Construction, or - Archived packages - +1. **Module Tabs:** Access All, Deployed, Under Construction, or Archived packages 2. **Search:** Search for a package by title - 3. **Filter:** Filter packages by package tags - -4. **Package Sort:** Sort packages by recent or alphanumeric (name) or - version - +4. **Package Sort:** Sort packages by recent or alphanumeric (name) or version 5. **List Pagination:** navigate between package list pages - 6. **Create Package:** Create a new CBA package - -7. **Import Package:** Import other packages that are created - previously on CDS Editor or Designer or created by other/current - user - -8. **Package box:** It shows a brief detail of the package and gives - access to some actions of the package - -9. **Package name and version** - -10. **More menu:** Access a list of actions including Clone, Archive, - Download, and Delete - -11. **Last modified:** Shows user name and date and time of last - modifications made in the package - -12. **Package Description** - -13. **Collaborators:** See who's collaborating to edit in the package - -14. **Configuration button:** Go directly to package configuration - -15. **Designer Mode:** It indicates package mode (Designer, Scripting, - and Generic scripting) and by clicking on it, it will load to mode - screen - +7. **Import Package:** Import other packages that are created previously on CDS Editor or Designer or created by other/current user +8. **Package box:** It shows a brief detail of the package and gives access to some actions of the package +9. **Deployed package indicator** +10. **Package name and version** +11. **More menu:** Access a list of actions including Clone, Archive, Download, and Delete +12. **Last modified:** Shows user name and date and time of last modifications made in the package +13. **Package Description** +14. **Package Tags** +15. **Collaborators:** See who's collaborating to edit in the package +16. **Configuration button:** Go directly to package configuration +17. **Designer Mode:** It indicates package mode (Designer, Scripting, and Generic scripting) and by clicking on it, it will load to mode screen Create a New CBA Package ------------------------ @@ -148,93 +116,72 @@ User Flow |image10| - Create a New Package ~~~~~~~~~~~~~~~~~~~~ +You can create a new CBA Package by creating a new custom package or by import a package file that is already created before. -You can create a new CBA Package by creating a new custom package or by -import package file that is already created before. - -**Create/Import Package** - -You can’t create/import a CBA package that has the same name and version -of an existing package. Packages can be in the same name but in -different version number (ex., Package one v1.0.0 & Package one v1.0.1). +.. note:: + **Create/Import Package** + You can’t create/import a CBA package that has the same name and version + of an existing package. Packages can be in the same name but in + different version numbers (ex., Package one v1.0.0 & Package one v1.0.1). **Create a New Custom CBA Package** - -From the Packages page, click on the **Create Package** button to -navigate to **Package** **Configuration** +From the Packages page, click on the **Create Package** button to navigate to **Package** **Configuration** |image11| - -`MetaData `__ -~~~~~~~~~ +:ref:`MetaData ` +~~~~~~~~~~~~~~~~~~~~~~~~~~~~ In **MetaData Tab,** select Package Mode, enter package Name, Version, Description and other configurations |image12| -Once you fill all required inputs, you can save this package by click -**Save** button in the Actions menu +Once you fill in all required inputs, you can save this package by clicking the **Save** button in the Actions menu |image13| -**Package Info Box:** It is in top of configurations tabs and it appears -after you save a package for the first time +**Package Info Box:** It is in top of configurations tabs and it appears after you save a package for the first time |image14| -You can continue adding package configuration or go directly to -**Designer Mode** screen from Package infobox +You can continue adding package configuration or go directly to the **Designer Mode** screen from Package info box -All changes will be saved when you click on **Save** button +All changes will be saved when you click on the **Save** button -To close the package configuration and go back to the Package list, -navigate to the top left in breadcrumb and click the **CBA Packages** -link or click on **Packages** link in the Main menu. +To close the package configuration and go back to the Package list, navigate to the top left in breadcrumb and click the **CBA Packages** +link or click on the **Packages** link in the Main menu. - -`Template & Mapping `__ -~~~~~~~~~~~~~~~~~~~ +:ref:`Template & Mapping