diff options
Diffstat (limited to 'docs/guides/onap-user/design/service-design')
| -rw-r--r-- | docs/guides/onap-user/design/service-design/index.rst | 249 | ||||
| -rw-r--r-- | docs/guides/onap-user/design/service-design/media/sdc-home.png | bin | 0 -> 78421 bytes | |||
| -rw-r--r-- | docs/guides/onap-user/design/service-design/media/sdc-service-composition.png | bin | 0 -> 35989 bytes | |||
| -rw-r--r-- | docs/guides/onap-user/design/service-design/media/sdc-service-general.png | bin | 0 -> 22523 bytes | |||
| -rw-r--r-- | docs/guides/onap-user/design/service-design/media/sdc-service-properties-input.png | bin | 0 -> 28861 bytes | |||
| -rw-r--r-- | docs/guides/onap-user/design/service-design/media/sdc-service-properties.png | bin | 0 -> 28388 bytes | |||
| -rw-r--r-- | docs/guides/onap-user/design/service-design/media/sdc-service-workflow-design.png | bin | 0 -> 29508 bytes | |||
| -rw-r--r-- | docs/guides/onap-user/design/service-design/media/sdc-service-workflow.png | bin | 0 -> 56875 bytes |
8 files changed, 132 insertions, 117 deletions
diff --git a/docs/guides/onap-user/design/service-design/index.rst b/docs/guides/onap-user/design/service-design/index.rst index 4a68a9c6c..fc290cb27 100644 --- a/docs/guides/onap-user/design/service-design/index.rst +++ b/docs/guides/onap-user/design/service-design/index.rst @@ -12,7 +12,7 @@ instantiate, and manage services. Validate and certify the services. **Tool:** SDC -**SDC user roles:** Designer, Tester +**SDC user roles:** Designer |image1| @@ -20,34 +20,37 @@ instantiate, and manage services. Validate and certify the services. **Steps** - #. `Create a Service`_ - #. `Create a Workflow [optional]`_ + #. `Create Service`_ + #. `Create a Management Workflow [optional]`_ #. `Create a Network Callflow [optional]`_ - #. `Select VID Inputs [optional]`_ - #. `Update a Service [optional]`_ - #. `Submit a Service for Testing`_ - #. `Test a Service`_ - #. `Assign an IP Address Plan`_ + #. `Add Service Inputs [optional]`_ + #. `Update Service [optional]`_ + #. `Certify Service`_ -Create a Service ----------------- +.. _doc_guide_user_des_ser-cre_serv: -**Prerequisites:** Create VFs required for this service (see :ref:`doc_guide_user_des_vf-cre`). +Create Service +-------------- + +**Prerequisites:** Create VF/PNFs required for this service (see :ref:`doc_guide_user_des_vf-cre`). + +#. From the SDC HOME page, hover over Add and select *ADD SERVICE*. + + |image0| -#. From the SDC HOME page, hover over Add and select Add Service. #. In the General section, complete all fields. - Note: Use the letters "Svc" in the name to indicate that the - component is a service. + |image5| #. Click Create. - A message displays when VF creation is complete. + A message displays when Service creation is complete. #. Click Composition. - For a description of the Composition section (see \ `Composition - (Service design) <https://wiki.onap.org/x/lIwP>`__ ). + |image6| + + For a description of the Composition section (see SDC User Guide ). #. Drag one or more elements from the Elements palette to the canvas. #. To connect elements: @@ -62,7 +65,7 @@ Create a Service #. To add artifacts at the service level: - #. Click an empty area in the canvas and click Deployment Artifacts + #. Click an empty area in the canvas and click *Deployment Artifacts* (right pane). #. Click \ |image3|. #. Select the type. @@ -72,41 +75,50 @@ Create a Service Use this function to add YANG artifacts for distribution to SDNC. -#. Click Check In to save changes. +#. [Optional] At any time before checking in the Service, click + these options to update Service information: + + .. note:: These tasks can be done only before certifying the Service. + + - **General->Icon** change the icon associated with the Service + - **TOSCA Artifacts** view and edit artifacts, such as the .csar file + and TOSCA template + - **Composition** view or edit the graphical representation of the + service-level TOSCA model + - **Activity Log** view activity related to the Service + (displays the action, date, user, status, and any comments related to each + action) + - **Management Workflow** model service lifecycle workflows for execution + in SO (see `Create a Management Workflow [optional]`_) + - **Network Call Flow** model interactions among VFs (see `Create a + Network Callflow [optional]`_) + - **Deployment** view HEAT modules in VSPs + - **Properties Assignment** define or update properties, + policies and input parameters used during Service instantiation + (see `Add Service Inputs [optional]`_). + - **Monitoring** ... + +#. Click *Check In* to save changes. A box displays for confirming the changes. #. Enter a comment and click OK. - A message displays when the VF is checked in. + A message displays when the Service is checked in and the + Home page is displayed. -#. [Optional] At any time before submitting the service for testing, - click these options to update service information: - - - Icon — change the icon associated with the service - - TOSCA Artifacts — view and edit artifacts, such as the .csar file - and TOSCA template - - Composition — view or edit the graphical representation of the - service-level TOSCA model - - Activity Log — view activity related to the service - - Workflow — model service lifecycle workflows for execution in SO - (see `Create a Workflow [optional]`_) - - Network Call Flow — model interactions among VFs (see `Create a - Network Callflow [optional]`_) - - Deployment — view HEAT modules in VSPs - - Inputs — select parameters as input fields during VID - instantiation (see `Select VID Inputs [optional]`_). +#. After creating a service and configuring optional fields, certify it + (see `Certify Service`_). -#. After creating a service and configuring optional fields, submit it - for testing (see `Submit a Service for Testing`_). - -Note: Create Service can now be invoked via External SDC API also. +Note: Create Service can also be invoked via External SDC API. Refer SDC REST API reference for details of the API. Currently, only a 'Partner Domain Service' category is supported which cannot be created manually from SDC portal. -Create a Workflow [optional] ----------------------------- +.. _doc_guide_user_des_ser-cre_wf: + +Create a Management Workflow [optional] +--------------------------------------- Create a workflow to model the SO recipes of the service life cycle such as instantiation, upgrade, termination, or suspension of a service or @@ -120,11 +132,16 @@ format and included in distributed service model. **Prerequisites:** All the required ActivitySpec as supported by SO are registered in SDC. -#. From the SDC HOME page, click WORKFLOW. -#. Click Add Workflow. -#. The Create New Workflow box displays. +#. From the SDC HOME page, click CATALOG and search for a service. +#. Click the service and click *Check Out*. +#. Select the panel *Management Workflow*. +#. Click *Add Workflow*. +#. The *Create New Workflow* box displays. #. Complete all fields. #. Click Create. + + |image7| + #. Specify Inputs & Outputs of Workflow #. Define the Composition of Workflow. @@ -138,6 +155,8 @@ format and included in distributed service model. #. Click Save. #. Certify the Workflow. +.. _doc_guide_user_des_ser-cre_nfw: + Create a Network Callflow [optional] ------------------------------------ @@ -148,10 +167,10 @@ being consumed. In the model, lifelines represent VFs. Note: The information collected in this section is not distributed with the service model. -**Prerequisites:** `Create a service`_ +**Prerequisites:** `Create service`_ -#. From the SDC HOME page, click CATALOG and search for a service. -#. Click the service and click Check Out. +#. From the SDC HOME page, click CATALOG and search for the service. +#. Click the service and click *Check Out*. #. Click Network Call Flow. #. Click Add Workflow. The Create New Workflow box displays. @@ -182,35 +201,44 @@ the service model. #. [Optional] Change the order of steps by clicking a step and dragging it to the preferred position. -#. Click Save. -#. Click Check In to save changes. +#. Click *Save*. +#. Click *Check In* to save changes. + +.. _doc_guide_user_des_ser-para_in: -Select VID Inputs [optional] ----------------------------- +Add Service Inputs [optional] +----------------------------- -Select parameters as input fields during -`VID <https://wiki.onap.org/display/DW/Glossary#Glossary-VID>`__ -instantiation. +Select parameters as input fields during Service instantiation. -Note: For questions about how to use this section, contact the Service -Design and Creation team (see \ `Mailing -Lists <https://wiki.onap.org/display/DW/Mailing+Lists>`__). -**Prerequisites:** `Create a service`_ +**Prerequisites:** `Create service`_ #. From the SDC HOME page, click CATALOG and search for a service. -#. Click the service and click Check Out. -#. Click Inputs. -#. From the Resource instance inputs pane, expand the name of a - resource. -#. Select inputs by clicking the check box in each row as required. +#. Click the service and click *Check Out*. +#. Click *Properties Assignment*. + + |image8| + +#. From the *Composition* pane, select the *SELF* object + representing the service. +#. In the *Properties* the existing Service properites are shown +#. With *+Add Property* you can add a new property +#. To set a property as *Input* parameter, select the parameter + by clicking the check box in each row as required. Note: Do not select inputs that are already in the ENV file (this overwrites values specified in the ENV). -#. Click \ |image4| to move selected inputs to the Service inputs pane. -#. Click Check In to save changes. -Update a Service [optional] ---------------------------- + |image9| + +#. Click *Declare Input* to add the selected parameter to the + Service *Input* pane. +#. Click *Check In* to save changes. + +.. _doc_guide_user_des_ser-upd_serv: + +Update Service [optional] +------------------------- Update service information and artifacts. @@ -220,85 +248,72 @@ updated (see step 4). **Prerequisites:** - Create a service. -- If a VF included in the service was updated: see "Update a VF - [optional]" and "Test a VF". +- If a VF included in the service was updated: + see :ref:`doc_guide_user_des_vf-cre_vf-upd` -#. From the SDC HOME page, click CATALOG and search for a service. -#. Click the service and click Check Out. +#. From the SDC HOME page, click CATALOG and search for the service. +#. Click the service and click *Check Out*. #. Click Composition. #. To update the version of a VF referenced in the service: #. Click Composition. #. Click the VF in the canvas. - #. On the General Info tab (right pane), select the VF version. + #. On the *General Info* tab (right pane), select the VF version. #. To update artifacts at the service level: - #. Click an empty area in the canvas and click Deployment Artifacts + #. Click an empty area in the canvas and click *Deployment Artifacts* (right pane). #. View, add, delete, or download artifacts as required. #. [Optional] Add, edit, or remove VFs that comprise the service - reference architecture (see steps 4 to 6 in \ `Create a Service`_). -#. [Optional] Click Operations to edit Service Operations. + reference architecture (see steps 4 to 6 in \ `Create Service`_). +#. [Optional] Click *Operations* to edit Service Operations. #. Create/Edit Operations #. Assign Workflow #. Click Save -#. [Optional] Click Management Callflow to edit, upload, or delete - associated deployment artifacts (see "Create a Management Workflow [optional]"). -#. [Optional] Click Network Callflow to edit the interactions among VFs +#. [Optional] Click *Management Workflow* to edit, upload, or delete + associated deployment artifacts + (see `Create a Management Workflow [optional]`_). +#. [Optional] Click *Network Callflow* to edit the interactions among VFs that comprise the service (see `Create a Network Callflow [optional]`_). -#. [Optional] Click Inputs to select parameters as input fields during - VID instantiation (see `Select VID Inputs [optional]`_). -#. Click Check In to save changes. -#. After updating a service and configuring optional fields, submit it - for testing (see `Submit a Service for Testing`_). +#. [Optional] Click *Properties Assignement* to select parameters as + input fields during Service instantiation + (see `Add Service Inputs [optional]`_). +#. Click *Check In* to save changes. +#. After updating a service and configuring optional fields, certify it + (see `Certify Service`_). -Submit a Service for Testing ----------------------------- +.. _doc_guide_user_des_ser-cfy_serv: + +Certify Service +--------------- Note: A service cannot be submitted for testing if the reference architecture contains uncertified resources. -**Prerequisites:** `Create a Service`_ - -#. When a service is ready for testing, click CATALOG and search for the - service. -#. Click the service and click Submit for Testing. - A box displays for sending a message to the testers. -#. Enter a message for the testers asking that they begin service - certification and click OK. - - The default mail client launches with a draft email containing the - message from step 2. - -#. Add the email addresses of the people on the Certification Group with - the Tester role and send the email. +**Prerequisites:** `Create Service`_ -Test a Service --------------- - -Test the design and associated artifacts of a service. +**Steps** -**Prerequisites:** `Submit a Service for Testing`_. +#. When a Service is ready for certification, + click *CATALOG* and search for the checked-in Service. +#. Click the Service and click *Certify*. -#. Sign in to SDC as a Tester. -#. From the HOME page, select Ready For Testing under Active Projects. -#. In the right pane, click the service to test. -#. Click Start Testing. -#. Test the service. -#. When testing is complete, click Accept. +#. Enter a comment and click *OK*. -Assign an IP Address Plan -------------------------- +#. A Message appears, that the Service is certified. -Assigning an IP address plan is specific to each OpenECOMP installation. -The object: to assign a Service's key to a "plan" for allocating IP -addresses. -.. |image1| image:: media/design_service_workflow.png +.. |image0| image:: media/sdc-home.png +.. |image1| image:: media/sdc-service-workflow.png .. |image2| image:: media/design_asdccanvas_connect_elements.png .. |image3| image:: media/design_service_adddeploymentartifact.png .. |image4| image:: media/design_service_inputs_move.png +.. |image5| image:: media/sdc-service-general.png +.. |image6| image:: media/sdc-service-composition.png +.. |image7| image:: media/sdc-service-workflow.png +.. |image8| image:: media/sdc-service-properties.png +.. |image9| image:: media/sdc-service-properties-input.png
\ No newline at end of file diff --git a/docs/guides/onap-user/design/service-design/media/sdc-home.png b/docs/guides/onap-user/design/service-design/media/sdc-home.png Binary files differnew file mode 100644 index 000000000..3b14c99e0 --- /dev/null +++ b/docs/guides/onap-user/design/service-design/media/sdc-home.png diff --git a/docs/guides/onap-user/design/service-design/media/sdc-service-composition.png b/docs/guides/onap-user/design/service-design/media/sdc-service-composition.png Binary files differnew file mode 100644 index 000000000..4ac0d490c --- /dev/null +++ b/docs/guides/onap-user/design/service-design/media/sdc-service-composition.png diff --git a/docs/guides/onap-user/design/service-design/media/sdc-service-general.png b/docs/guides/onap-user/design/service-design/media/sdc-service-general.png Binary files differnew file mode 100644 index 000000000..4bb65d71e --- /dev/null +++ b/docs/guides/onap-user/design/service-design/media/sdc-service-general.png diff --git a/docs/guides/onap-user/design/service-design/media/sdc-service-properties-input.png b/docs/guides/onap-user/design/service-design/media/sdc-service-properties-input.png Binary files differnew file mode 100644 index 000000000..2296fd350 --- /dev/null +++ b/docs/guides/onap-user/design/service-design/media/sdc-service-properties-input.png diff --git a/docs/guides/onap-user/design/service-design/media/sdc-service-properties.png b/docs/guides/onap-user/design/service-design/media/sdc-service-properties.png Binary files differnew file mode 100644 index 000000000..0dc111eac --- /dev/null +++ b/docs/guides/onap-user/design/service-design/media/sdc-service-properties.png diff --git a/docs/guides/onap-user/design/service-design/media/sdc-service-workflow-design.png b/docs/guides/onap-user/design/service-design/media/sdc-service-workflow-design.png Binary files differnew file mode 100644 index 000000000..03867f954 --- /dev/null +++ b/docs/guides/onap-user/design/service-design/media/sdc-service-workflow-design.png diff --git a/docs/guides/onap-user/design/service-design/media/sdc-service-workflow.png b/docs/guides/onap-user/design/service-design/media/sdc-service-workflow.png Binary files differnew file mode 100644 index 000000000..7caf98122 --- /dev/null +++ b/docs/guides/onap-user/design/service-design/media/sdc-service-workflow.png |
