SAPC VNF Lifecycle Manager Workflow Instruction for CEE

Ericsson Service-Aware Policy Controller

1	Introduction
2	Overview
2.1	VNF-LCM
2.2	Prerequisites
3	Starting a Workflow
4	HEAT Workflows
4.1	Onboarding
4.2	Instantiation
4.3	Scale
4.4	Terminate

1 Introduction

The purpose of this document is to describe the VNF LifeCycle Manager (VNF-LCM) use cases (Workflows) for the SAPC in the Cloud Execution Environment (CEE).

2 Overview

Connection between a cloud orchestrator 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:

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

Figure 1 VNF-LCM GUI

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.

Figure 2 VNF-LCM GUI after selecting a Workflow

Figure 3 Start form of a Workflow

4 HEAT Workflows

The following Workflows work using the cloud orchestrator Heat.

4.1 Onboarding

The Onboard SAPC on OpenStack workflow is to generate HOT file for instantiation, upload SW images to OpenStack, and for Compact Deployment, create Flavors and Availability Zones in OpenStack. It performs the following steps:

1. Authenticate on OpenStack

2. Select VDP

3. Select deployment type

For Standalone Deployment:

4. Select HOT

5. Upload images

6. Store in VNF-LCM

For Compact Deployment

4. Select Compact Deployment configuration

5. Enter VNS specific data

6. Generate HOT template

7. Upload images

8. Create flavors and availability zones

9. Store in VNF-LCM

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_heatworkflows/work/vdp, For example: /vnflcm ext/ericsson/ERICsapc_lcm_wf_heatworkflows/work/vdp/vdp_sapc_qcow2_cxp9032849_7r1b43/sapc_sc-1_cxp9032849_7r1b43.qcow2.
Generate HOT file with SAPC hot_gen tool and store it on the SAPC vdp folder (Only for Stand-alone deployment).
User credentials used by the workflow has the right privileges to upload images, create flavors and create availability zones in OpenStack. User credentials are pre-configured on the VNF-LCM environment.

4.1.2 Post-conditions

After the workflow finished successfully, following outcome is expected:

Images in the VDP is uploaded to OpenStack if they have not been uploaded before.
HOT file generated, and stored in a local database /vnflcm ext/ericsson/ERICsapc_lcm_wf_heatworkflows/work/catalog/templates/.
For Compact Deployment, flavors and availability zones are created in OpenStack.

4.1.3 Workflow Execution

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

1. Click the Onboard SAPC on OpenStack 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 and Deployment Type

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.

Deployment Type

Either VNF Standalone Deployment or VNS Compact Deployment should be selected.

Figure 4 Select template name and description

4.1.3.2 Input Template Information

To identify the template in catalog database, a template name and template description is required to enter.

Figure 5 Select VDP and deployment type form

4.1.3.3 Select Compact Deployment configuration file

When deployment type is selected as “VNS Compact Deployment”, workflow will request a configuration file to generate the HOT file. These configuration files are located under /vnflcm-ext/ericsson/ERICsapc_lcm_wf_heatworkflows/work/catalog/configurations/.

4.1.3.4 Configure Template

When deployment type is selected as “VNS Compact Deployment”, workflow will request some configuration parameters to generate the HOT file.

Figure 6 Configure deployment form

VNS Parameters

VNS instance name

This is the prefix of availability zone name

Node management compute hosts

The node management compute hosts are used to launch vRP. A comma-separated list of compute host names should be given, and each computer host is used to launch one vRP VM. Only two hosts should be filled out here. They are respectively corresponding to availability zone name.

Control plane compute hosts

The control plane computer hosts are used to launch vSRVC which serve for control plane of SAPC, and each computer host is used to launch one vSRVC VM. At least 3 hosts should be filled out here. The format should be "host1, host2,host3&mldr;" i.e. host has to be separated by ",". They are respectively corresponding to availability zone name: vns_name_cp1, vns_name_cp2, vns_name_cp3&mldr;

User plane compute hosts

At least two compute hosts should be filled in here. They are respectively corresponding to availability zone name: VNS instance name_up1, VNS instance name_up2&mldr; .

VNF Parameters

Create BGW ports: If choose yes, it means that the external network will have connectivity outside the CEE POD.

Disable port security: If choose yes, it means that allowed_address_pair info will be added to each neutron port. This parameter should be set to 'No' when CEE 16A is used and 'yes' when CEE R6 or newer is used.

OAM VLAN ID: The VLAN number for OAM.

Traffic VLAN IDs: The VLAN number for Traffic.

4.1.4 Non-Interactive REST API Workflow Execution

The format of the NBI REST Call command: 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 run the curl command.

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

4.2 Instantiation

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

1. Authenticate on OpenStack

2. Select template file

3. If template requires injection file, select injection file

4. Instantiate a SAPC

5. Update VNF in ENM/OSS-RC topology

4.2.1 Preconditions

The following pre-conditions are needed:

An Onboard SAPC on OpenStack workflow must be executed previously to have the environment ready with the HOT templates created.
The parameters ossUserName, ossPassword and ossHostName must be preconfigured in the VNF-LCM services machine.

4.2.2 Post-conditions

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

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

4.2.3 Workflow execution

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

Click the SAPC Instantiation on OpenStack 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.3.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.

Figure 7 Input stack form

Rollback on Heat create failure?

If checked: If the Instantiate SAPC workflow fails during the stack creation, the Heat orchestration will trigger rollback and delete all resources created in the instantiation process. If the Instantiate SAPC workflow fails after the stack created, the resources created in the instantiation workflow, and the failure logs are kept until the user deletes them manually. The failure reasons are recorded in Workflow Log. If unchecked: If the Instantiate SAPC workflow fails, no rollback is performed. The resources created in the instantiation, and the failure logs are kept until the user deletes them manually.

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.

4.2.3.2 Select Template File

When the Template File Name is invalid, the workflow requests selection for template file, as show in below figure. The template file defines the SAPC application. The template file should be uploaded to the VNFLAF-Services VM directory (automatically done by Onboarding workflow). Select the files from drop down list, then click the Submit button to continue the workflow.

Figure 8 Select template form

4.2.3.3 Select Injection File

When the template requires an injection file (Compact deployment), the workflow requests the selection for injection file. This injection file must be located at /vnflcm-ext/ericsson/ERICsapc_lcm_wf_heatworkflows/work/vnf-configurations.

Select a file from the drop down list, then click the Submit button to continue the workflow.

Figure 9 Select inject file form

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

Figure 10 Form to add network element

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.3.5 Non-Interactive REST API Workflow Execution

The format of the NBI REST Call command: 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 run the curl command.

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

4.3 Scale

The functionality of SAPC Scale workflow is to create additional 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.
The related flavors are not changed from SAPC Instantiation.

4.3.2 Post-conditions

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

4.3.3 Workflow Execution

Start the Scale SAPC on OpenStack workflow:

Select the Scale SAPC on OpenStack workflow from the list in the workflows.
Click the Start a New Instance button.
Click submit button.

4.3.3.1 Select stack

Select a stack (SAPC) form the drop-down list. Continue the workflow by clicking the “Submit” button.

Figure 11 Select stack form

4.3.3.2 Non-Interactive REST API Workflow Execution

The format of the NBI REST Call command: 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 run the curl command.

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

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 OpenStack workflow, do the following steps:

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

4.4.3.1 Start form

Figure 12 Start form of SAPC termination workflow

Delete Network Element in ENM/OSS-RC

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

4.4.3.2 Select stack

Select a Stack (SAPC) to terminate from the drop-down list, then, click the Submit button to continue the workflow.

Figure 13 Select stack form

4.4.3.3 Non-Interactive REST API Workflow Execution

The format of the NBI REST Call command: 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 run the curl command.

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