docs/guides/onap-user/design/service-design/index.rst

   1 .. This work is licensed under a Creative Commons Attribution 4.0
   2 .. International License. http://creativecommons.org/licenses/by/4.0
   3 .. Copyright 2019 ONAP Contributors. All rights reserved.
   4
   5 .. _doc_guide_user_des_ser-des:
   6
   7 Service Design
   8 ==============
   9
  10 **Goal:** Add models and other artifacts required to create, configure,
  11 instantiate, and manage services. Validate and certify the services.
  12
  13 **Tool:** SDC
  14
  15 **SDC user roles:** Designer, Tester
  16
  17 |image1|
  18
  19 **Figure: Workflow for Service design**
  20
  21 **Steps**
  22
  23    #. `Create a Service`_
  24    #. `Create a Workflow [optional]`_
  25    #. `Create a Network Callflow [optional]`_
  26    #. `Select VID Inputs [optional]`_
  27    #. `Update a Service [optional]`_
  28    #. `Submit a Service for Testing`_
  29    #. `Test a Service`_
  30    #. `Assign an IP Address Plan`_
  31
  32 Create a Service
  33 ----------------
  34
  35 **Prerequisites:** Create VFs required for this service (see :ref:`doc_guide_user_des_vf-cre`).
  36
  37 #. From the SDC HOME page, hover over Add and select Add Service.
  38 #. In the General section, complete all fields.
  39
  40    Note: Use the letters "Svc" in the name to indicate that the
  41    component is a service.
  42
  43 #. Click Create.
  44
  45    A message displays when VF creation is complete.
  46
  47 #. Click Composition.
  48
  49    For a description of the Composition section (see \ `Composition
  50    (Service design) <https://wiki.onap.org/x/lIwP>`__ ).
  51
  52 #. Drag one or more elements from the Elements palette to the canvas.
  53 #. To connect elements:
  54
  55    #. Hover over an element and then hover over \ |image2|.
  56
  57       Other elements that can connect to this element are highlighted.
  58
  59    #. Drag to a highlighted element on the canvas.
  60    #. Select options for Requirements and Capabilities.
  61    #. Click Connect.
  62
  63 #. To add artifacts at the service level:
  64
  65    #. Click an empty area in the canvas and click Deployment Artifacts
  66       (right pane).
  67    #. Click \ |image3|.
  68    #. Select the type.
  69    #. Click Browse, locate a file to upload, and click Open.
  70    #. Complete all other fields.
  71    #. Click Done.
  72
  73    Use this function to add YANG artifacts for distribution to SDNC.
  74
  75 #. Click Check In to save changes.
  76
  77    A box displays for confirming the changes.
  78
  79 #. Enter a comment and click OK.
  80
  81    A message displays when the VF is checked in.
  82
  83 #. [Optional] At any time before submitting the service for testing,
  84    click these options to update service information:
  85
  86    -  Icon — change the icon associated with the service
  87    -  TOSCA Artifacts — view and edit artifacts, such as the .csar file
  88       and TOSCA template
  89    -  Composition — view or edit the graphical representation of the
  90       service-level TOSCA model
  91    -  Activity Log — view activity related to the service
  92    -  Workflow — model service lifecycle workflows for execution in SO
  93       (see `Create a Workflow [optional]`_)
  94    -  Network Call Flow — model interactions among VFs (see `Create a
  95       Network Callflow [optional]`_)
  96    -  Deployment — view HEAT modules in VSPs
  97    -  Inputs — select parameters as input fields during VID
  98       instantiation (see `Select VID Inputs [optional]`_).
  99
 100 #. After creating a service and configuring optional fields, submit it
 101    for testing (see `Submit a Service for Testing`_).
 102
 103
 104 Create a Workflow [optional]
 105 ----------------------------
 106
 107 Create a workflow to model the SO recipes of the service life cycle such
 108 as instantiation, upgrade, termination, or suspension of a service or
 109 VNF. In the workflow each of the Activity, represent API calls to
 110 various ONAP components (such as OOF, SDN-C, App-C, etc) that perform a
 111 business function needed.
 112
 113 Note: The information collected in this section is represented in BPMN
 114 format and included in distributed service model.
 115
 116 **Prerequisites:** All the required ActivitySpec as supported by SO
 117  are registered in SDC.
 118
 119 #. From the SDC HOME page, click WORKFLOW.
 120 #. Click Add Workflow.
 121 #. The Create New Workflow box displays.
 122 #. Complete all fields.
 123 #. Click Create.
 124 #. Specify Inputs & Outputs of Workflow
 125 #. Define the Composition of Workflow.
 126
 127    #. All the Tasks in the composition are expected to be ServiceTask
 128       for using Activities defined in SO.
 129    #. Select the Implementation in the Task "general" tab to Activity.
 130    #. Select the required ActivitySpec.
 131
 132 #. Mark the workflow as executable by selecting the Executable flag in
 133    the workflow "general" tab.
 134 #. Click Save.
 135 #. Certify the Workflow.
 136
 137 Create a Network Callflow [optional]
 138 ------------------------------------
 139
 140 Create a network callflow to model the interactions among VFs within a
 141 service, such how VFs interact to deliver a service while the service is
 142 being consumed. In the model, lifelines represent VFs.
 143
 144 Note: The information collected in this section is not distributed with
 145 the service model.
 146
 147 **Prerequisites:** `Create a service`_
 148
 149 #. From the SDC HOME page, click CATALOG and search for a service.
 150 #. Click the service and click Check Out.
 151 #. Click Network Call Flow.
 152 #. Click Add Workflow.
 153    The Create New Workflow box displays.
 154 #. Complete all fields.
 155 #. Click Save.
 156 #. In the new workflow pane, click the Lifelines icon.
 157
 158    The LIFELINES/STEPS view displays.
 159
 160 #. To add a lifeline (component), do the following:
 161
 162    #. Click LIFELINES to expand the pane.
 163    #. Click Add Lifeline.
 164    #. In the [Unnamed Lifeline field], enter a name for the lifeline.
 165    #. To add other lifelines to the workflow, repeat the actions above.
 166
 167 #. After creating all required lifelines, do the following to add a step
 168    (showing an action between two lifelines):
 169
 170    #. Under STEPS (left pane), click Add Message.
 171       An unnamed step is added under STEPS.
 172    #. In the [Unnamed Message] field, enter a name or message for the
 173       step.
 174    #. From the component and arrow dropdown lists, select the two
 175       components that communicate in this step, and the arrow to show in
 176       which direction the communication flows.
 177    #. To add another step, repeat the actions above.
 178
 179 #. [Optional] Change the order of steps by clicking a step and dragging
 180    it to the preferred position.
 181 #. Click Save.
 182 #. Click Check In to save changes.
 183
 184 Select VID Inputs [optional]
 185 ----------------------------
 186
 187 Select parameters as input fields during
 188 `VID <https://wiki.onap.org/display/DW/Glossary#Glossary-VID>`__
 189 instantiation.
 190
 191 Note: For questions about how to use this section, contact the Service
 192 Design and Creation team (see \ `Mailing
 193 Lists <https://wiki.onap.org/display/DW/Mailing+Lists>`__).
 194
 195 **Prerequisites:** `Create a service`_
 196
 197 #. From the SDC HOME page, click CATALOG and search for a service.
 198 #. Click the service and click Check Out.
 199 #. Click Inputs.
 200 #. From the Resource instance inputs pane, expand the name of a
 201    resource.
 202 #. Select inputs by clicking the check box in each row as required.
 203    Note: Do not select inputs that are already in the ENV file (this
 204    overwrites values specified in the ENV).
 205 #. Click \ |image4| to move selected inputs to the Service inputs pane.
 206 #. Click Check In to save changes.
 207
 208 Update a Service [optional]
 209 ---------------------------
 210
 211 Update service information and artifacts.
 212
 213 Update the version of a VF referenced in the service whenever the VF is
 214 updated (see step 4).
 215
 216 **Prerequisites:**
 217
 218 -  Create a service.
 219 -  If a VF included in the service was updated: see "Update a VF
 220    [optional]" and "Test a VF".
 221
 222 #. From the SDC HOME page, click CATALOG and search for a service.
 223 #. Click the service and click Check Out.
 224 #. Click Composition.
 225 #. To update the version of a VF referenced in the service:
 226
 227    #. Click Composition.
 228    #. Click the VF in the canvas.
 229    #. On the General Info tab (right pane), select the VF version.
 230
 231 #. To update artifacts at the service level:
 232
 233    #. Click an empty area in the canvas and click Deployment Artifacts
 234       (right pane).
 235    #. View, add, delete, or download artifacts as required.
 236
 237 #. [Optional] Add, edit, or remove VFs that comprise the service
 238    reference architecture (see steps 4 to 6 in \ `Create a Service`_).
 239 #. [Optional] Click Operations to edit Service Operations.
 240
 241    #. Create/Edit Operations
 242    #. Assign Workflow
 243    #. Click Save
 244
 245 #. [Optional] Click Management Callflow to edit, upload, or delete
 246    associated deployment artifacts (see "Create a Management Workflow [optional]").
 247 #. [Optional] Click Network Callflow to edit the interactions among VFs
 248    that comprise the service (see `Create a Network Callflow [optional]`_).
 249 #. [Optional] Click Inputs to select parameters as input fields during
 250    VID instantiation (see `Select VID Inputs [optional]`_).
 251 #. Click Check In to save changes.
 252 #. After updating a service and configuring optional fields, submit it
 253    for testing (see `Submit a Service for Testing`_).
 254
 255 Submit a Service for Testing
 256 ----------------------------
 257
 258 Note: A service cannot be submitted for testing if the reference
 259 architecture contains uncertified resources.
 260
 261 **Prerequisites:** `Create a Service`_
 262
 263 #. When a service is ready for testing, click CATALOG and search for the
 264    service.
 265 #. Click the service and click Submit for Testing.
 266    A box displays for sending a message to the testers.
 267 #. Enter a message for the testers asking that they begin service
 268    certification and click OK.
 269
 270    The default mail client launches with a draft email containing the
 271    message from step 2.
 272
 273 #. Add the email addresses of the people on the Certification Group with
 274    the Tester role and send the email.
 275
 276 Test a Service
 277 --------------
 278
 279 Test the design and associated artifacts of a service.
 280
 281 **Prerequisites:** `Submit a Service for Testing`_.
 282
 283 #. Sign in to SDC as a Tester.
 284 #. From the HOME page, select Ready For Testing under Active Projects.
 285 #. In the right pane, click the service to test.
 286 #. Click Start Testing.
 287 #. Test the service.
 288 #. When testing is complete, click Accept.
 289
 290 Assign an IP Address Plan
 291 -------------------------
 292
 293 Assigning an IP address plan is specific to each OpenECOMP installation.
 294 The object: to assign a Service's key to a "plan" for allocating IP
 295 addresses.
 296
 297 .. |image1| image:: media/design_service_workflow.png
 298 .. |image2| image:: media/design_asdccanvas_connect_elements.png
 299 .. |image3| image:: media/design_service_adddeploymentartifact.png
 300 .. |image4| image:: media/design_service_inputs_move.png