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, Tester

image1

Figure: Workflow for Service design

Steps

Create a Service

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

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

  2. In the General section, complete all fields.

    Note: Use the letters “Svc” in the name to indicate that the component is a service.

  3. Click Create.

    A message displays when VF creation is complete.

  4. Click Composition.

    For a description of the Composition section (see Composition (Service design) ).

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

    A box displays for confirming the changes.

  9. Enter a comment and click OK.

    A message displays when the VF is checked in.

  10. [Optional] At any time before submitting the service for testing, click these options to update service information:

    • 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
    • Workflow — model service lifecycle workflows for execution in SO (see Create a Workflow [optional])
    • Network Call Flow — model interactions among VFs (see Create a Network Callflow [optional])
    • Deployment — view HEAT modules in VSPs
    • Inputs — select parameters as input fields during VID instantiation (see Select VID Inputs [optional]).
  11. After creating a service and configuring optional fields, submit it for testing (see Submit a Service for Testing).

Create a 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 WORKFLOW.
  2. Click Add Workflow.
  3. The Create New Workflow box displays.
  4. Complete all fields.
  5. Click Create.
  6. Specify Inputs & Outputs of Workflow
  7. 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.
  8. Mark the workflow as executable by selecting the Executable flag in the workflow “general” tab.
  9. Click Save.
  10. 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 a service

  1. From the SDC HOME page, click CATALOG and search for a 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.

Select VID Inputs [optional]

Select parameters as input fields during VID instantiation.

Note: For questions about how to use this section, contact the Service Design and Creation team (see Mailing Lists).

Prerequisites: Create a service

  1. From the SDC HOME page, click CATALOG and search for a service.
  2. Click the service and click Check Out.
  3. Click Inputs.
  4. From the Resource instance inputs pane, expand the name of a resource.
  5. Select inputs 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).
  6. Click image4 to move selected inputs to the Service inputs pane.
  7. Click Check In to save changes.

Update a 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:

  • Create a service.
  • If a VF included in the service was updated: see “Update a VF [optional]” and “Test a VF”.
  1. From the SDC HOME page, click CATALOG and search for a 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 a Service).
  7. [Optional] Click Operations to edit Service Operations.
    1. Create/Edit Operations
    2. Assign Workflow
    3. Click Save
  8. [Optional] Click Management Callflow 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 Inputs to select parameters as input fields during VID instantiation (see Select VID Inputs [optional]).
  11. Click Check In to save changes.
  12. After updating a service and configuring optional fields, submit it for testing (see Submit a Service for Testing).

Submit a Service for Testing

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

Prerequisites: Create a Service

  1. When a service is ready for testing, click CATALOG and search for the service.

  2. Click the service and click Submit for Testing. A box displays for sending a message to the testers.

  3. Enter a message for the testers asking that they begin service certification and click OK.

    The default mail client launches with a draft email containing the message from step 2.

  4. Add the email addresses of the people on the Certification Group with the Tester role and send the email.

Test a Service

Test the design and associated artifacts of a service.

Prerequisites: Submit a Service for Testing.

  1. Sign in to SDC as a Tester.
  2. From the HOME page, select Ready For Testing under Active Projects.
  3. In the right pane, click the service to test.
  4. Click Start Testing.
  5. Test the service.
  6. When testing is complete, click Accept.

Assign an IP Address Plan

Assigning an IP address plan is specific to each OpenECOMP installation. The object: to assign a Service’s key to a “plan” for allocating IP addresses.