Service Design

Goal: Add models and other artifacts required to create, configure, instantiate, and manage services. Validate and certify the services.

Tool: SDC

SDC user roles: Designer

image1

Figure: Workflow for Service design

Steps

Create Service

Prerequisites: Create VF/PNFs required for this service (see VF/PNF Creation and Testing).

  1. From the SDC HOME page, hover over Add and select ADD SERVICE.

    image0

  2. In the General section, complete all fields.

    image5

  3. Click Create.

    A message displays when Service creation is complete.

  4. Click Composition.

    image6

    For a description of the Composition section (see SDC User Guide ).

  5. Drag one or more elements from the Elements palette to the canvas.

  6. To connect elements:

    1. Hover over an element and then hover over image2.

      Other elements that can connect to this element are highlighted.

    2. Drag to a highlighted element on the canvas.

    3. Select options for Requirements and Capabilities.

    4. Click Connect.

  7. To add artifacts at the service level:

    1. Click an empty area in the canvas and click Deployment Artifacts (right pane).
    2. Click image3.
    3. Select the type.
    4. Click Browse, locate a file to upload, and click Open.
    5. Complete all other fields.
    6. Click Done.

    Use this function to add YANG artifacts for distribution to SDNC.

  8. [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
  9. Click Check In to save changes.

    A box displays for confirming the changes.

  10. Enter a comment and click OK.

    A message displays when the Service is checked in and the Home page is displayed.

  11. After creating a service and configuring optional fields, certify it (see Certify Service).

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 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 VNF. In the workflow each of the Activity, represent API calls to various ONAP components (such as OOF, SDN-C, App-C, etc) that perform a business function needed.

Note: The information collected in this section is represented in BPMN format and included in distributed service model.

Prerequisites: All the required ActivitySpec as supported by SO
are registered in SDC.
  1. From the SDC HOME page, click CATALOG and search for a service.

  2. Click the service and click Check Out.

  3. Select the panel Management Workflow.

  4. Click Add Workflow.

  5. The Create New Workflow box displays.

  6. Complete all fields.

  7. Click Create.

    image7

  8. Specify Inputs & Outputs of Workflow

  9. Define the Composition of Workflow.

    1. All the Tasks in the composition are expected to be ServiceTask for using Activities defined in SO.
    2. Select the Implementation in the Task “general” tab to Activity.
    3. Select the required ActivitySpec.
  10. Mark the workflow as executable by selecting the Executable flag in the workflow “general” tab.

  11. Click Save.

  12. Certify the Workflow.

Create a Network Callflow [optional]

Create a network callflow to model the interactions among VFs within a service, such how VFs interact to deliver a service while the service is being consumed. In the model, lifelines represent VFs.

Note: The information collected in this section is not distributed with the service model.

Prerequisites: Create service

  1. From the SDC HOME page, click CATALOG and search for the service.

  2. Click the service and click Check Out.

  3. Click Network Call Flow.

  4. Click Add Workflow. The Create New Workflow box displays.

  5. Complete all fields.

  6. Click Save.

  7. In the new workflow pane, click the Lifelines icon.

    The LIFELINES/STEPS view displays.

  8. To add a lifeline (component), do the following:

    1. Click LIFELINES to expand the pane.
    2. Click Add Lifeline.
    3. In the [Unnamed Lifeline field], enter a name for the lifeline.
    4. To add other lifelines to the workflow, repeat the actions above.
  9. After creating all required lifelines, do the following to add a step (showing an action between two lifelines):

    1. Under STEPS (left pane), click Add Message. An unnamed step is added under STEPS.
    2. In the [Unnamed Message] field, enter a name or message for the step.
    3. From the component and arrow dropdown lists, select the two components that communicate in this step, and the arrow to show in which direction the communication flows.
    4. To add another step, repeat the actions above.
  10. [Optional] Change the order of steps by clicking a step and dragging it to the preferred position.

  11. Click Save.

  12. Click Check In to save changes.

Add Service Inputs [optional]

Select parameters as input fields during Service instantiation.

Prerequisites: Create service

  1. From the SDC HOME page, click CATALOG and search for a service.

  2. Click the service and click Check Out.

  3. Click Properties Assignment.

    image8

  4. From the Composition pane, select the SELF object representing the service.

  5. In the Properties the existing Service properites are shown

  6. With +Add Property you can add a new property

  7. 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).

    image9

  8. Click Declare Input to add the selected parameter to the Service Input pane.

  9. Click Check In to save changes.

Update Service [optional]

Update service information and artifacts.

Update the version of a VF referenced in the service whenever the VF is updated (see step 4).

Prerequisites:

  1. From the SDC HOME page, click CATALOG and search for the service.
  2. Click the service and click Check Out.
  3. Click Composition.
  4. To update the version of a VF referenced in the service:
    1. Click Composition.
    2. Click the VF in the canvas.
    3. On the General Info tab (right pane), select the VF version.
  5. To update artifacts at the service level:
    1. Click an empty area in the canvas and click Deployment Artifacts (right pane).
    2. View, add, delete, or download artifacts as required.
  6. [Optional] Add, edit, or remove VFs that comprise the service reference architecture (see steps 4 to 6 in Create Service).
  7. [Optional] Click Operations to edit Service Operations.
    1. Create/Edit Operations
    2. Assign Workflow
    3. Click Save
  8. [Optional] Click Management Workflow to edit, upload, or delete associated deployment artifacts (see Create a Management Workflow [optional]).
  9. [Optional] Click Network Callflow to edit the interactions among VFs that comprise the service (see Create a Network Callflow [optional]).
  10. [Optional] Click Properties Assignement to select parameters as input fields during Service instantiation (see Add Service Inputs [optional]).
  11. Click Check In to save changes.
  12. After updating a service and configuring optional fields, certify it (see Certify Service).

Certify Service

Note: A service cannot be submitted for testing if the reference architecture contains uncertified resources.

Prerequisites: Create Service

Steps

  1. When a Service is ready for certification, click CATALOG and search for the checked-in Service.
  2. Click the Service and click Certify.
  3. Enter a comment and click OK.
  4. A Message appears, that the Service is certified.