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.
12 Besides the manual creation of a Service Model, an existing model can
13 be imported via a CSAR file
17 **SDC user roles:** Designer
21 **Figure: Workflow for Service design**
26 #. `Create a Management Workflow [optional]`_
27 #. `Create a Network Callflow [optional]`_
28 #. `Manage Service Properties [optional]`_
29 #. `Update Service [optional]`_
31 #. `Import Service CSAR [optional]`_
33 .. _doc_guide_user_des_ser-cre_serv:
38 **Prerequisites:** Create VF/PNFs required for this service (see :ref:`doc_guide_user_des_vf-cre`).
40 #. From the SDC HOME page, hover over Add and select *ADD SERVICE*.
44 #. In the General section, complete all fields.
50 A message displays when Service creation is complete.
56 For a description of the Composition section (see SDC User Guide ).
58 #. Drag one or more elements from the Elements palette to the canvas.
59 #. To connect elements:
61 #. Hover over an element and then hover over \ |image2|.
63 Other elements that can connect to this element are highlighted.
65 #. Drag to a highlighted element on the canvas.
66 #. Select options for Requirements and Capabilities.
69 #. To add artifacts at the service level:
71 #. Click an empty area in the canvas and click *Deployment Artifacts*
75 #. Click Browse, locate a file to upload, and click Open.
76 #. Complete all other fields.
79 Use this function to add YANG artifacts for distribution to SDNC.
81 #. [Optional] At any time before checking in the Service, click
82 these options to update Service information:
84 .. note:: These tasks can be done only before certifying the Service.
86 - **General->Icon** change the icon associated with the Service
87 - **TOSCA Artifacts** view and edit artifacts, such as the .csar file
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 (displays the action, date, user, status, and any comments related to each
94 - **Management Workflow** model service lifecycle workflows for execution
95 in SO (see `Create a Management Workflow [optional]`_)
96 - **Network Call Flow** model interactions among VFs (see `Create a
97 Network Callflow [optional]`_)
98 - **Deployment** view HEAT modules in VSPs
99 - **Properties Assignment** define or update properties,
100 policies and input parameters used during Service instantiation
101 (see `Add Service Inputs [optional]`_).
104 #. Click *Check In* to save changes.
106 A box displays for confirming the changes.
108 #. Enter a comment and click OK.
110 A message displays when the Service is checked in and the
111 Home page is displayed.
113 #. After creating a service and configuring optional fields, certify it
114 (see `Certify Service`_).
116 Note: Create Service can also be invoked via External SDC API.
117 Refer SDC REST API reference for details of the API.
118 Currently, only a 'Partner Domain Service' category is supported
119 which cannot be created manually from SDC portal.
121 .. _doc_guide_user_des_ser-cre_wf:
123 Create a Management Workflow [optional]
124 ---------------------------------------
126 Create a workflow to model the SO recipes of the service life cycle such
127 as instantiation, upgrade, termination, or suspension of a service or
128 VNF. In the workflow each of the Activity, represent API calls to
129 various ONAP components (such as OOF, SDN-C, App-C, etc) that perform a
130 business function needed.
132 Note: The information collected in this section is represented in BPMN
133 format and included in distributed service model.
135 **Prerequisites:** All the required ActivitySpec as supported by SO
136 are registered in SDC.
138 #. From the SDC HOME page, click CATALOG and search for a service.
139 #. Click the service and click *Check Out*.
140 #. Select the panel *Management Workflow*.
141 #. Click *Add Workflow*.
142 #. The *Create New Workflow* box displays.
143 #. Complete all fields.
148 #. Specify Inputs & Outputs of Workflow
149 #. Define the Composition of Workflow.
151 #. All the Tasks in the composition are expected to be ServiceTask
152 for using Activities defined in SO.
153 #. Select the Implementation in the Task "general" tab to Activity.
154 #. Select the required ActivitySpec.
156 #. Mark the workflow as executable by selecting the Executable flag in
157 the workflow "general" tab.
159 #. Certify the Workflow.
161 .. _doc_guide_user_des_ser-cre_nfw:
163 Create a Network Callflow [optional]
164 ------------------------------------
166 Create a network callflow to model the interactions among VFs within a
167 service, such how VFs interact to deliver a service while the service is
168 being consumed. In the model, lifelines represent VFs.
170 Note: The information collected in this section is not distributed with
173 **Prerequisites:** `Create service`_
175 #. From the SDC HOME page, click CATALOG and search for the service.
176 #. Click the service and click *Check Out*.
177 #. Click Network Call Flow.
178 #. Click Add Workflow.
179 The Create New Workflow box displays.
180 #. Complete all fields.
182 #. In the new workflow pane, click the Lifelines icon.
184 The LIFELINES/STEPS view displays.
186 #. To add a lifeline (component), do the following:
188 #. Click LIFELINES to expand the pane.
189 #. Click Add Lifeline.
190 #. In the [Unnamed Lifeline field], enter a name for the lifeline.
191 #. To add other lifelines to the workflow, repeat the actions above.
193 #. After creating all required lifelines, do the following to add a step
194 (showing an action between two lifelines):
196 #. Under STEPS (left pane), click Add Message.
197 An unnamed step is added under STEPS.
198 #. In the [Unnamed Message] field, enter a name or message for the
200 #. From the component and arrow dropdown lists, select the two
201 components that communicate in this step, and the arrow to show in
202 which direction the communication flows.
203 #. To add another step, repeat the actions above.
205 #. [Optional] Change the order of steps by clicking a step and dragging
206 it to the preferred position.
208 #. Click *Check In* to save changes.
210 .. _doc_guide_user_des_ser-para_in:
212 Manage Service Properties [optional]
213 ------------------------------------
215 Add new Service parameters and define as input fields
216 during Service instantiation.
219 **Prerequisites:** `Create service`_
221 #. From the SDC HOME page, click CATALOG and search for a service.
222 #. Click the service and click *Check Out*.
223 #. Click *Properties Assignment*.
227 #. From the *Composition* pane, select the *SELF* object
228 representing the service.
229 #. In the *Properties* the existing Service properites are shown
230 #. With *+Add Property* you can add a new property
231 #. To set a property as *Input* parameter, select the parameter
232 by clicking the check box in each row as required.
233 Note: Do not select inputs that are already in the ENV file (this
234 overwrites values specified in the ENV).
238 #. Click *Declare Input* to add the selected parameter to the
239 Service *Input* pane.
240 #. Click *Check In* to save changes.
242 .. _doc_guide_user_des_ser-upd_serv:
244 Update Service [optional]
245 -------------------------
247 Update service information and artifacts.
249 Update the version of a VF referenced in the service whenever the VF is
250 updated (see step 4).
255 - If a VF included in the service was updated:
256 see :ref:`doc_guide_user_des_vf-cre_vf-upd`
258 #. From the SDC HOME page, click CATALOG and search for the service.
259 #. Click the service and click *Check Out*.
260 #. Click Composition.
261 #. To update the version of a VF referenced in the service:
263 #. Click Composition.
264 #. Click the VF in the canvas.
265 #. On the *General Info* tab (right pane), select the VF version.
267 #. To update artifacts at the service level:
269 #. Click an empty area in the canvas and click *Deployment Artifacts*
271 #. View, add, delete, or download artifacts as required.
273 #. [Optional] Add, edit, or remove VFs that comprise the service
274 reference architecture (see steps 4 to 6 in \ `Create Service`_).
275 #. [Optional] Click *Operations* to edit Service Operations.
277 #. Create/Edit Operations
281 #. [Optional] Click *Management Workflow* to edit, upload, or delete
282 associated deployment artifacts
283 (see `Create a Management Workflow [optional]`_).
284 #. [Optional] Click *Network Callflow* to edit the interactions among VFs
285 that comprise the service (see `Create a Network Callflow [optional]`_).
286 #. [Optional] Click *Properties Assignement* to select parameters as
287 input fields during Service instantiation
288 (see `Add Service Inputs [optional]`_).
289 #. Click *Check In* to save changes.
290 #. After updating a service and configuring optional fields, certify it
291 (see `Certify Service`_).
293 .. _doc_guide_user_des_ser-cfy_serv:
298 Note: A service cannot be submitted for testing if the reference
299 architecture contains uncertified resources.
301 **Prerequisites:** `Create Service`_
305 #. When a Service is ready for certification,
306 click *CATALOG* and search for the checked-in Service.
307 #. Click the Service and click *Certify*.
309 #. Enter a comment and click *OK*.
311 #. A Message appears, that the Service is certified.
314 Import Service CSAR [optional]
315 ------------------------------
317 Note: This step can be used, when a Service Model already exists
321 #. From the SDC HOME page, hover over IMPORT and select *IMPORT SERVICE CSAR*.
325 #. In the File Upload Dialog, select the csar file and press *Open*.
329 #. In the General section, complete all fields.
335 A message displays when Service creation is complete.
337 #. Continue with Service Design steps mentioned above
339 .. |image0| image:: media/sdc-home.png
340 .. |image1| image:: media/sdc-service-workflow.png
341 .. |image2| image:: media/design_asdccanvas_connect_elements.png
342 .. |image3| image:: media/design_service_adddeploymentartifact.png
343 .. |image4| image:: media/design_service_inputs_move.png
344 .. |image5| image:: media/sdc-service-general.png
345 .. |image6| image:: media/sdc-service-composition.png
346 .. |image7| image:: media/sdc-service-workflow.png
347 .. |image8| image:: media/sdc-service-properties.png
348 .. |image9| image:: media/sdc-service-properties-input.png
349 .. |image10| image:: media/sdc-service-import.png
350 .. |image11| image:: media/sdc-service-general-import.png