Contents

1   SAPC VNF Lifecycle Manager Workflow Instructionfor VMware Introduction

The purpose of this document is to describe the VNF LifeCycle Manager (VNF-LCM) use cases (Workflows) for the SAPC in VMware deployments using vCloud Director.

2   SAPC VNF Lifecycle Manager Workflow Instruction for VMware Overview

Connection between vCloud Director and the VNF-LCM is mandatory for any user who wants to follow this document.

2.1   VNF-LCM

The VNF-LCM feature in ENM and OSS-RC fulfills Specific VNF LifeCycle Manager (S-VNFM) functionality of ETSI NFV MANO architecture, supporting lifecycle management operations for Ericsson VNFs. The framework interfaces with different NFV deployment architectures.

2.2   Prerequisites

Before starting this procedure, ensure that the following conditions are met:

• vCloud Director and OSS/ENM logon data and tenant are introduced in VNF-LCM before running it.
• To perform internal SAPC operations, external connectivity is configured.

3   Starting a Workflow

The VNF-LCM GUI shows the different Workflows installed.

To start a Workflow, click one and a new menu appears above them. Click Start Instance to go to the start form of the selected Workflow. To start the execution of the Workflow, click Submit.

4   vCloud Director Workflows

The following Workflows work using the VMware vCloud Director.

4.1   Onboarding

The Onboard SAPC on vCD workflow is to generate OVF files for instantiation, and upload OVF files and SW images to vCD. It performs the following steps:

1. Select VDP

2. Set SAPC.cfg data.

3. Select adapt cluster configuration file.

4. Generate VNF descriptor files.

5. Upload images and VNF descriptor files.

4.1.1   Preconditions

The following pre-conditions are needed:

• Upload an unpacked VNF Virtual Deployment Package (VDP) including images to /vnflcm-ext/ericsson/ERICsapc_lcm_wf_vcdworkflows/work/vdp.
• User credentials used by the workflow has the right privileges to upload images, create catalog and templates in vCD. User credentials are pre-configured on the VNF-LCM environment.

4.1.2   Post-conditions

After the workflow finished successfully, following outcome is expected:

• Descriptor generator files are uploaded to vCD.

4.1.3   Workflow Execution

To start Onboard SAPC on vCD workflow, do the following:

1. Click the Onboard SAPC on vCD workflow from the list in the workflows.

2. Click the Start a New Instance button.

3. Click Submit button to continue

4.1.3.1   Select VDP

After pressing Submit button from start form, the workflow requests selection of VDP and Deployment Type.

Virtual Deployment Package

One VDP Package must be chosen from the drop-down list.

4.1.3.2   Set SAPC Information

This form will write the SAPC.cfg on the previously selected VDP. These parameters will be used to run the Onboard script.

4.1.3.3   Select Adapt Cluster Configuration File

The form will show the Adapt Cluster files located under /vnflcm-ext/ericsson/ERICsapc_lcm_wf_vcdworkflows/work/vdp/<sapc_vdp>/templates. This file will be used to create the descriptor generator for SAPC.

4.1.3.4   Non-Interactive REST API Workflow Execution

The format of the NBI REST Call command is as follows: curl -X POST http://IP:8080/wfs/rest/instances -d @NBI DIR/NBI parameter file -H "Content-Type: application/json"

The NBI DIR/NBI parameter file should be in the server which runs the curl command.

The NBI parameter templates are stored in /vnflcm ext/ericsson/ERICsapc_lcm_wf_heatworkflows/work/nbi-templates on the VNF-LCM.

Table 1   

Parameter Name	Type	Presence	Description
interactive	Boolean	Mandatory	Set to false in order to use REST API.
name_vdp	String	Mandatory	Virtual Deployment Package name under the path /vnflcm-ext/ericsson/ERICsapc_lcm_wf_vcdworkflows/work/vdp
vc_version	String	Optional	Version of the vCloud Director. Default 8.
vc_url	String	Mandatory	URL of the vCloud.
vc_organization	String	Mandatory	Name of the organization.
vc_catalog	String	Mandatory	Name of the catalog to create. Must be different than the ones already created.
vc_template	String	Mandatory	Name of the template to create. Must be different than the ones already created.
adaptClusterName	String	Mandatory	Name of the adapt cluster.

4.2   Instantiation

The SAPC Instantiation on vCD workflow creates a SAPC VNF. It performs the following steps:

1. Select VDP

2. Set SAPC.cfg data.

3. Instantiate SAPC.

5. Update VNF in ENM/OSS-RC topology

6. Enable SSH on SAPC.

4.2.1   Preconditions

The following pre-conditions are needed:

• An Onboard SAPC on vCD workflow must be executed previously to have the environment ready.
• User credentials used by the workflow has the right privileges to create a vAPPin vCD. User credentials are pre-configured on the VNF-LCM environment.

4.2.2   Post-conditions

After the workflow finished successfully, a SAPC application is created in the vCD per the definitions in the OVF file.

The information of the SAPC is updated in ENM/OSS-RC topology.

4.2.3   Post-configuration

After Workflow completion, follow the steps to configure the SAPC included in the VNF Deployment Instruction for VMware.

4.2.4   Workflow execution

To start SAPC Instantiation on vCD workflow, do the following:

• Click the SAPC Instantiation on vCD workflow from the list in the workflows.
• Click the Start a New Instance button.

The parameters are requested to be filled in on the start form. No more user interaction will be requested during the workflow execution.

4.2.4.1   Input Stack Name

VNF Instance Name

Fill in the VNF name of the SAPC. SAPC Node Name must contain only alphanumeric or '_-' characters, start with alpha, and be 255 characters or less.

Add Network Element in ENM/OSS-RC

If checked, workflow will request related parameter as shown in chapter 5.2.3.4 and add new VNFs to ENM or OSS-RC network resource model; If unchecked, workflow will go to end, means finished successfully.

Enable SSH Key Pair

If checked: After SAPC instantiation, the workflow will request the selection of a VDP. This will allow the VNF-LCM to find the script that will connect the SAPC with the VNF-LCM automatically. If Add Network Element has not checked, this step will ask for the VNF credentials.

4.2.4.2   Select VDP

After pressing Submit button from start form, the workflow requests selection of VDP and Deployment Type.

Virtual Deployment Package

One VDP Package must be chosen from the drop-down list.

4.2.4.3   Set SAPC Information

This form will write the SAPC.cfg on the previously selected VDP. These parameters will be used to run the Instantiation script.

4.2.4.4   Add Network Topology in ENM/OSS-RC

After stack has been created on HEAT, and the tick box “Add Network Element in ENM/OSS-RC” has been checked, the workflow requests related parameters as shown below and add new VNFs to ENM or OSS-RC network resource model.

VNF connection parameters

Management IP address: OAM service IP address of the newly instantiated SAPC

.Username: User name for login to the newly instantiated SAPC.

Password: Password for login to the newly instantiated SAPC

ENM/OSS-RC Network Element parameters

Associated Site: The site under which the VNF is to be added in OSS-RC network resource model. If no current site is used, fill in the string new. In ENM, this parameter will not be used.

Subnetworks: Subnetwork is used for logical grouping of nodes within ENM and OSS-RC. In ENM deployment Subnetworks is optional and it can contain one or more child Subnetwork. Subnetwork has to be separated by ',', such like 'SubNetwork=SubnetworkName1, SubNetwork=SubnetworkName2', e.g SubNetwork= SAPC In OSS-RC deployment Subnetworks is mandatory and only a single child Subnetwork is allowed. The input string of Subnetwork is without prefix 'SubNetwork=', such like 'SubnetworkName', e.g SAPC.

Network Element Version: The version of the Network Element. Example in OSS-RC like 16A-CP06, refer to 'supported Network Element' excel sheet in OSS-RC CPI in reference [8]. In ENM, this parameter refers to ossModelIdentity like 16A-CP02.

SNMP Community: Community string for SNMP. If not provided, default "public" would be taken for OSS-RC and in ENM, default "enm-public" would be taken.

4.2.4.5   Enable SSH

If the option has been selected. Enable SSH will display a form showing the available VDPs. After selecting one, the workflow will connect between the instantiated SAPC and the VNF-LCM storing the SSH Keys to connect automatically for further actions as Scale In.

4.2.4.6   Non-Interactive REST API Workflow Execution

The format of the NBI REST Call command is as follows: curl -X POST http://IP:8080/wfs/rest/instances -d @NBI DIR/NBI parameter file -H "Content-Type: application/json"

The NBI DIR/NBI parameter file should be in the server which runs the curl command.

The NBI parameter templates are stored in /vnflcm ext/ericsson/ERICsapc_lcm_wf_heatworkflows/work/nbi-templates on the VNF-LCM.

Table 2   

Parameter Name	Type	Presence	Description
interactive	Boolean	Mandatory	Set to false in order to use REST API.
vnfInstanceName	String	Mandatory	Name of the workflow instance.
continueUpdateTop	Boolean	Mandatory	Update topology in OSS/ENM.
enableSSH	Boolean	Mandatory	Set to true in order to insert a sshKey in the SAPC. The key is under the vdp Path
name_vdp	String	Mandatory	Virtual Deployment Package name under the path /vnflcm-ext/ericsson/ERICsapc_lcm_wf_vcdworkflows/work/vdp
vc_version	String	Optional	Version of the vCloud Director. Default value is 8.
vc_url	String	Mandatory	URL of the vCloud.
vc_organization	String	Mandatory	Name of the organization on vCloud.
vc_catalog	String	Mandatory	Name of the catalog to use.
vc_template	String	Mandatory	Name of the template to use.
vc_vapp	String	Mandatory	Name of the virtual application.
enableRollback	Boolean	Mandatory	The value indicates whether heat must do roll back if the instantiate workflow fails during the stack creation.

If Enable SSH is true, these parameters are needed for the execution:

Table 3   

vnfIpAddress	String	Mandatory	The OAM service IP address of the instantiated SAPC.
vnfUsername	String	Mandatory	The username for logon SAPC.
vnfPassword	String	Mandatory	The password for logon SAPC.

4.3   Scale

The functionality of SAPC Scale workflow is to create or remove VMs in an existing SAPC application.

4.3.1   Preconditions

The following pre-conditions are needed:

• The SAPC application is launched by the Instantiation workflow.
• To Scale In, the SAPC must be Scaled Out before.
• Only for Scale In, the SAPC has to be instantiated with the SSH Enable option.

4.3.2   Post-conditions

After the Scale workflow successfully finishes, a new PL is added or removed.

4.3.3   Workflow Execution

Start the Scale SAPC on vCD workflow:

• Select the Scale SAPC on vCD workflow from the list in the workflows.
• Select the Scale type, the options are In (remove a VM) or Out (create a new VM)
• Click the Start a New Instance button.
• Click submit button.

4.3.3.1   Select Scale Type

After the Stack is selected to Scale, a new form will show a drop-down list with two options.

• In: Removes the latest PL scaled out. If Scale Out has not been executed before, the workflow will fail because the SAPC has the minimum deployment. To execute Scale In, a SAPC VDP has to be selected.
• Out: Creates a new PL on the deployed SAPC.

4.3.3.2   Select VDP

After pressing Submit button from start form, the workflow requests selection of VDP and Deployment Type.

Virtual Deployment Package

One VDP Package must be chosen from the drop-down list.

4.3.3.3   Set SAPC Information

This form will write the SAPC.cfg on the previously selected VDP. These parameters will be used to run the Scale script.

4.3.3.4   Non-Interactive REST API Workflow Execution

The format of the NBI REST Call command is as follows: curl -X POST http://IP:8080/wfs/rest/instances -d @NBI DIR/NBI parameter file -H "Content-Type: application/json"

The NBI DIR/NBI parameter file should be in the server which runs the curl command.

The NBI parameter templates are stored in /vnflcm ext/ericsson/ERICsapc_lcm_wf_heatworkflows/work/nbi-templates on the VNF-LCM.

Table 4   

Parameter Name	Type	Presence	Description
interactive	Boolean	Mandatory	Set to false in order to use REST API.
vnfInstanceName	String	Mandatory	Name of the workflow instance.
scale	String	Mandatory	The scale type. Two possible values: out or in.
name_vdp	String	Mandatory	Virtual Deployment Package name under the path /vnflcm-ext/ericsson/ERICsapc_lcm_wf_vcdworkflows/work/vdp
vc_version	String	Optional	Version of the vCloud Director. Default value is 8.
vc_url	String	Mandatory	URL of the vCloud.
vc_organization	String	Mandatory	Name of the organization on vCloud.
vc_catalog	String	Mandatory	Name of the catalog to use.
vc_template	String	Mandatory	Name of the template to use.
vc_vapp	String	Mandatory	Name of the virtual application.

4.3.4   Auto-Scale Out

Scale workflow with Out option can be triggered automatically if the SAPC is instantiated and if the network element is added to OSS/ENM.

This workflow is triggered by the SAPC alarms GxSessionInitsTooBusyReached and RxSessionInitsTooBusyReached.

The sapc_lcm_wf_vcd-autostart-rules.xml file is delivered in the directory /opt/ericsson/ERICsapc_lcm_wf_vcdworkflows/autostart-rules, and user needs to manually copy it to /vnflcm-ext/current/workflows/auto-start-rules/ to activate it.

4.4   Terminate

This Workflow deletes the SAPC from the given Stack.

4.4.1   Preconditions

The virtual SAPC application (a stack) is launched by the Instantiation workflow.

4.4.2   Post-conditions

After the workflow is finished, the SAPC application (the stack) is terminated. Corresponding information of this SAPC is deleted in VNFLAF database, and deleted from ENM/OSS-RC topology as well.

4.4.3   Workflow Execution

To start the Terminate SAPC on vCD workflow, do the following steps:

1. Select the Terminate SAPC on vCD workflow from the list in the workflows.
2. Click the Start a New Instance button.

4.4.3.1   Start form

Delete Network Element in ENM/OSS-RC

If checked, delete topology will take effect after stack deleted from vCD; If unchecked, workflow will finish after stack deleted from vCD. If “Add Network Element in ENM/OSS-RC” in instantiate SAPC on vCD is performed successfully, please check this checkbox, otherwise please uncheck it.

4.4.3.2   Select VDP

After pressing Submit button from start form, the workflow requests selection of VDP and Deployment Type.

Virtual Deployment Package

One VDP Package must be chosen from the drop-down list.

4.4.3.3   Set SAPC Information

This form will write the SAPC.cfg on the previously selected VDP. These parameters will be used to run the Termination script.

4.4.3.4   Non-Interactive REST API Workflow Execution

The format of the NBI REST Call command is as follows: curl -X POST http://IP:8080/wfs/rest/instances -d @NBI DIR/NBI parameter file -H "Content-Type: application/json"

The NBI DIR/NBI parameter file should be in the server which runs the curl command.

The NBI parameter templates are stored in /vnflcm ext/ericsson/ERICsapc_lcm_wf_heatworkflows/work/nbi-templates on the VNF-LCM.

Table 5   

Parameter Name	Type	Presence	Description
interactive	Boolean	Mandatory	Set to false in order to use REST API.
vnfInstanceName	String	Mandatory	Name of the workflow instance.
deleteTopology	Boolean	Mandatory	Update topology in OSS.
name_vdp	String	Mandatory	Virtual Deployment Package name under the path /vnflcm-ext/ericsson/ERICsapc_lcm_wf_vcdworkflows/work/vdp
vc_version	String	Optional	Version of the vCloud Director. Default value is 8.
vc_url	String	Mandatory	URL of the vCloud.
vc_organization	String	Mandatory	Name of the organization on vCloud.