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.
5 .. _doc_guide_user_des_ser-des:
10 **Goal:** Add models and other artifacts required to create, configure,
11 instantiate, and manage services. Validate and certify the services.
15 **SDC user roles:** Designer
19 **Figure: Workflow for Service design**
24 #. `Create a Management Workflow [optional]`_
25 #. `Create a Network Callflow [optional]`_
26 #. `Add Service Inputs [optional]`_
27 #. `Update Service [optional]`_
30 .. _doc_guide_user_des_ser-cre_serv:
35 **Prerequisites:** Create VF/PNFs required for this service (see :ref:`doc_guide_user_des_vf-cre`).
37 #. From the SDC HOME page, hover over Add and select *ADD SERVICE*.
41 #. In the General section, complete all fields.
47 A message displays when Service creation is complete.
53 For a description of the Composition section (see SDC User Guide ).
55 #. Drag one or more elements from the Elements palette to the canvas.
56 #. To connect elements:
58 #. Hover over an element and then hover over \ |image2|.
60 Other elements that can connect to this element are highlighted.
62 #. Drag to a highlighted element on the canvas.
63 #. Select options for Requirements and Capabilities.
66 #. To add artifacts at the service level:
68 #. Click an empty area in the canvas and click *Deployment Artifacts*
72 #. Click Browse, locate a file to upload, and click Open.
73 #. Complete all other fields.
76 Use this function to add YANG artifacts for distribution to SDNC.
78 #. [Optional] At any time before checking in the Service, click
79 these options to update Service information:
81 .. note:: These tasks can be done only before certifying the Service.
83 - **General->Icon** change the icon associated with the Service
84 - **TOSCA Artifacts** view and edit artifacts, such as the .csar file
86 - **Composition** view or edit the graphical representation of the
87 service-level TOSCA model
88 - **Activity Log** view activity related to the Service
89 (displays the action, date, user, status, and any comments related to each
91 - **Management Workflow** model service lifecycle workflows for execution
92 in SO (see `Create a Management Workflow [optional]`_)
93 - **Network Call Flow** model interactions among VFs (see `Create a
94 Network Callflow [optional]`_)
95 - **Deployment** view HEAT modules in VSPs
96 - **Properties Assignment** define or update properties,
97 policies and input parameters used during Service instantiation
98 (see `Add Service Inputs [optional]`_).
101 #. Click *Check In* to save changes.
103 A box displays for confirming the changes.
105 #. Enter a comment and click OK.
107 A message displays when the Service is checked in and the
108 Home page is displayed.
110 #. After creating a service and configuring optional fields, certify it
111 (see `Certify Service`_).
113 Note: Create Service can also be invoked via External SDC API.
114 Refer SDC REST API reference for details of the API.
115 Currently, only a 'Partner Domain Service' category is supported
116 which cannot be created manually from SDC portal.
118 .. _doc_guide_user_des_ser-cre_wf:
120 Create a Management Workflow [optional]
121 ---------------------------------------
123 Create a workflow to model the SO recipes of the service life cycle such
124 as instantiation, upgrade, termination, or suspension of a service or
125 VNF. In the workflow each of the Activity, represent API calls to
126 various ONAP components (such as OOF, SDN-C, App-C, etc) that perform a
127 business function needed.
129 Note: The information collected in this section is represented in BPMN
130 format and included in distributed service model.
132 **Prerequisites:** All the required ActivitySpec as supported by SO
133 are registered in SDC.
135 #. From the SDC HOME page, click CATALOG and search for a service.
136 #. Click the service and click *Check Out*.
137 #. Select the panel *Management Workflow*.
138 #. Click *Add Workflow*.
139 #. The *Create New Workflow* box displays.
140 #. Complete all fields.
145 #. Specify Inputs & Outputs of Workflow
146 #. Define the Composition of Workflow.
148 #. All the Tasks in the composition are expected to be ServiceTask
149 for using Activities defined in SO.
150 #. Select the Implementation in the Task "general" tab to Activity.
151 #. Select the required ActivitySpec.
153 #. Mark the workflow as executable by selecting the Executable flag in
154 the workflow "general" tab.
156 #. Certify the Workflow.
158 .. _doc_guide_user_des_ser-cre_nfw:
160 Create a Network Callflow [optional]
161 ------------------------------------
163 Create a network callflow to model the interactions among VFs within a
164 service, such how VFs interact to deliver a service while the service is
165 being consumed. In the model, lifelines represent VFs.
167 Note: The information collected in this section is not distributed with
170 **Prerequisites:** `Create service`_
172 #. From the SDC HOME page, click CATALOG and search for the service.
173 #. Click the service and click *Check Out*.
174 #. Click Network Call Flow.
175 #. Click Add Workflow.
176 The Create New Workflow box displays.
177 #. Complete all fields.
179 #. In the new workflow pane, click the Lifelines icon.
181 The LIFELINES/STEPS view displays.
183 #. To add a lifeline (component), do the following:
185 #. Click LIFELINES to expand the pane.
186 #. Click Add Lifeline.
187 #. In the [Unnamed Lifeline field], enter a name for the lifeline.
188 #. To add other lifelines to the workflow, repeat the actions above.
190 #. After creating all required lifelines, do the following to add a step
191 (showing an action between two lifelines):
193 #. Under STEPS (left pane), click Add Message.
194 An unnamed step is added under STEPS.
195 #. In the [Unnamed Message] field, enter a name or message for the
197 #. From the component and arrow dropdown lists, select the two
198 components that communicate in this step, and the arrow to show in
199 which direction the communication flows.
200 #. To add another step, repeat the actions above.
202 #. [Optional] Change the order of steps by clicking a step and dragging
203 it to the preferred position.
205 #. Click *Check In* to save changes.
207 .. _doc_guide_user_des_ser-para_in:
209 Add Service Inputs [optional]
210 -----------------------------
212 Select parameters as input fields during Service instantiation.
215 **Prerequisites:** `Create service`_
217 #. From the SDC HOME page, click CATALOG and search for a service.
218 #. Click the service and click *Check Out*.
219 #. Click *Properties Assignment*.
223 #. From the *Composition* pane, select the *SELF* object
224 representing the service.
225 #. In the *Properties* the existing Service properites are shown
226 #. With *+Add Property* you can add a new property
227 #. To set a property as *Input* parameter, select the parameter
228 by clicking the check box in each row as required.
229 Note: Do not select inputs that are already in the ENV file (this
230 overwrites values specified in the ENV).
234 #. Click *Declare Input* to add the selected parameter to the
235 Service *Input* pane.
236 #. Click *Check In* to save changes.
238 .. _doc_guide_user_des_ser-upd_serv:
240 Update Service [optional]
241 -------------------------
243 Update service information and artifacts.
245 Update the version of a VF referenced in the service whenever the VF is
246 updated (see step 4).
251 - If a VF included in the service was updated:
252 see :ref:`doc_guide_user_des_vf-cre_vf-upd`
254 #. From the SDC HOME page, click CATALOG and search for the service.
255 #. Click the service and click *Check Out*.
256 #. Click Composition.
257 #. To update the version of a VF referenced in the service:
259 #. Click Composition.
260 #. Click the VF in the canvas.
261 #. On the *General Info* tab (right pane), select the VF version.
263 #. To update artifacts at the service level:
265 #. Click an empty area in the canvas and click *Deployment Artifacts*
267 #. View, add, delete, or download artifacts as required.
269 #. [Optional] Add, edit, or remove VFs that comprise the service
270 reference architecture (see steps 4 to 6 in \ `Create Service`_).
271 #. [Optional] Click *Operations* to edit Service Operations.
273 #. Create/Edit Operations
277 #. [Optional] Click *Management Workflow* to edit, upload, or delete
278 associated deployment artifacts
279 (see `Create a Management Workflow [optional]`_).
280 #. [Optional] Click *Network Callflow* to edit the interactions among VFs
281 that comprise the service (see `Create a Network Callflow [optional]`_).
282 #. [Optional] Click *Properties Assignement* to select parameters as
283 input fields during Service instantiation
284 (see `Add Service Inputs [optional]`_).
285 #. Click *Check In* to save changes.
286 #. After updating a service and configuring optional fields, certify it
287 (see `Certify Service`_).
289 .. _doc_guide_user_des_ser-cfy_serv:
294 Note: A service cannot be submitted for testing if the reference
295 architecture contains uncertified resources.
297 **Prerequisites:** `Create Service`_
301 #. When a Service is ready for certification,
302 click *CATALOG* and search for the checked-in Service.
303 #. Click the Service and click *Certify*.
305 #. Enter a comment and click *OK*.
307 #. A Message appears, that the Service is certified.
310 .. |image0| image:: media/sdc-home.png
311 .. |image1| image:: media/sdc-service-workflow.png
312 .. |image2| image:: media/design_asdccanvas_connect_elements.png
313 .. |image3| image:: media/design_service_adddeploymentartifact.png
314 .. |image4| image:: media/design_service_inputs_move.png
315 .. |image5| image:: media/sdc-service-general.png
316 .. |image6| image:: media/sdc-service-composition.png
317 .. |image7| image:: media/sdc-service-workflow.png
318 .. |image8| image:: media/sdc-service-properties.png
319 .. |image9| image:: media/sdc-service-properties-input.png