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