1 Introduction
This document describes the system administration tasks performed in the EO (Ericsson Orchestrator - Cloud Manager). The EO provides a workflow execution environment and a web-based application for managing VNF life cycle procedures.
VNF life cycle procedure can be performed in two types:
- Small stack: VNF life cycle procedure without EO. For detailed information, refer to IPWorks VNF Life Cycle Management (Workflow) - Small Stack.
- Full stack:
The following use cases are supported for IPWorks:
|
Function |
Trigger from EO |
Trigger from ENM |
|---|---|---|
|
Instantiation |
Supported |
Not supported |
|
Scale-out |
Not supported |
Supported |
|
Scale in |
Not supported |
Supported |
|
Termination |
Supported |
Supported |
2 Prerequisites
This section describes the prerequisites that must be fulfilled to manage the IPWorks VNF life cycle by EO.
2.1 Hardware and Software
The following hardware (virtual and physical) and software are required:
- The software delivery package including IPWorks workflows and the VNF-LCM scripts is available.
- CEE as Virtual Infrastructure Managers (VIMs) is used.
- VNF-LCM (with version 18.16 IP1, media version 4.9.22 or above) is available using either Operations Support System for Radio and Core (OSS-RC), or Ericsson Network Manager (ENM).
- EO (version 18.0.0.1)
- Integration of EO/LCM/CEE is complete.
2.2 User Access
During the execution of the procedures described in this guide, the following user roles should be pre-created:
- EO admin user and tenant credentials user
For detailed information about system administration users and roles at in VNF-LCM, refer to VNF-Lifecycle Manager System Administration Guide, Reference [2], in the OSS-RC documentation.
3 Onboarding
This section describes how to prepare for VNF operations triggered by EO.
3.1 Setup Environment in VNF-LCM
- Install IPWorks workflows package.
- Log on to VNF-LCM services VM as cloud-user and switch
to root user.
$ssh cloud-user@<VNF-LCM services VM>
[cloud-user@vnflaf-services ~]$ su -
- Uninstall the existing workflow. (Optional)
[root@vnflaf-services ~]# wfmgr bundle uninstall --name=<Name> --version=<Version>
Use command "wfmgr bundle list" to view the package name and version.
- Note:
- Before the uninstallation, make sure the configuration files under /vnflcm-ext/current/vnf_package_repo/ have been backed up.
- Install package.
[root@vnflaf-services ~]# wfmgr bundle install --package=<The path of the workflow package name>
- Verify that the installation is successful.
[root@vnflaf-services ~]# wfmgr bundle list
For example:
Name | Version | Package ---------+---------+------------------------------------------- vIPWorks | 3.1.2 | ERICvIPWorks_CXP9040851-3.1.2-1.noarch.rpm
- Log on to VNF-LCM services VM as cloud-user and switch
to root user.
- Check SSH key pair.
- Check if the key pair id_rsa and id_rsa.pub exist.
[root@vnflaf-services ~]# ls /home/jboss_user/.ssh/
If it exists, skip step b.
- Generate SSH key pair.
[root@vnflaf-services ~]# su jboss_user
[jboss_user@vnflaf-services root]$ ssh-keygen -t rsa
# Generating public/private rsa key pair. # Enter file in which to save the key (/home/jboss_user/.ssh/id_rsa): [Press enter] # Enter passphrase (empty for no passphrase): [Press enter] # Enter same passphrase again: [Press enter] Your identification has been saved in /home/jboss_user/.ssh/id_rsa. Your public key has been saved in /home/jboss_user/.ssh/id_rsa.pub.
[jboss_user@vnflaf-services root]$ exit
- Note:
- Encrypted private keys are not supported, that is, keep passphrase empty.
- Check if the key pair id_rsa and id_rsa.pub exist.
- Edit the template nfvoconfig.json in /ericsson/vnflcm/data, fulfill
all the parameters according to the environment settings, and make sure the values of the following parameters are set as below:
"isGrantSupported":"true", "isNotificationSupported":"true", "nfvoInUse":"Y"
- Configure nfvo.
- Check the existing nfvo configuration.
[root@vnflaf-services ~]# vnflcm nfvo list
- If the nfvo configuration doesn’t
exist, create it and add configuration file.
[root@vnflaf-services ~]#vnflcm nfvo add --file <nfvoconfig file>
For example:
[root@vnflaf-services ~]#vnflcm nfvo add --file template_nfvoconfig.json
- Check the existing nfvo configuration.
- Set the environment variables.
If you don’t want to add IPWorks to ENM, skip this step.
Add ossUserName and ossPassword in environment.
[root@vnflaf-services ~]#/ericsson/pib-scripts/etc/config.py update --app_server_address localhost:8080 --name=<variable_name> --value=<variable_value>
For example:
[root@vnflaf-services ~]#/ericsson/pib-scripts/etc/config.py update --app_server_address localhost:8080 --name=ossUserName --value=ipwuser
[root@vnflaf-services ~]#/ericsson/pib-scripts/etc/config.py update --app_server_address localhost:8080 --name=ossPassword --value=aXBXdXNlclBhc3N3MHJk
- Note:
- Password must be encoded by Base64.
3.2 Register New VIM Zone in EO
- Log on to EO as admin user.
- Choose Infrastructure > Register VIM Zone.
- Fill all the attributes on Enter Attributes page, including General Information and VIM Zone Credential. Then click Next.
- Default Project Name: use admin.
- Administrator Name: the name of Atlas admin user.
- Administrator Password: the password of the Atlas admin user.
- On the Enter Capacity & Characteristics page, define the capacity of the zone, and click Next.
- On the Register Availability Zone page, fill the name of the Availability zone and Availability Zone Capacity. Then click Next.
- On the Set Connectivity page, fill in
all the required fields.
- Choose a Security Type. "https" is recommended.
- Fill End Point Configuration information, adding Cinder, Glance, Nova, Ceilometer, Neutron and Heatstack, which can be found in Atlas:
- Note:
- Use "heat" in Atlas to find the information of Heatstack.
# ssh <atlas admin user>@<atlas server>
# openstack endpoint list
# openstack endpoint show <Service Name/endpoint name>
For example:
atlasadm@atlas:~ # openstack endpoint list +----------------------------------+-----------+----------------+----------------+ | ID | Region | Service Name | Service Type | +----------------------------------+-----------+----------------+----------------+ | 9f1683f958824f659ecbadf79948885a | RegionOne | heat | orchestration | | 4f1b7d0183974359b56e0ebc4a862b91 | RegionOne | ceilometer | metering | | 5e0c59479a554d948a7e571870f26115 | RegionOne | nova | compute | | 1f5253cf8b61407b9a413f9fd059f0d0 | RegionOne | cinder | volume | | 8000c08564b64cab915002199939b145 | RegionOne | glare | artifact | | 54d6238e840f4006853cf413bb5a0c1e | RegionOne | glance | image | | 08ec83cc777f4b75af0d2a431f7c9c02 | RegionOne | keystone | identity | | 361f5b72213346ef984dd0fe8c639602 | RegionOne | neutron | network | +----------------------------------+-----------+----------------+----------------+ atlasadm@atlas:~$ openstack endpoint show keystone +--------------+--------------------------------------------------+ | Field | Value | +--------------+--------------------------------------------------+ | adminurl | https://ctrlpodu.seli.gic.ericsson.se:35357/v2.0 | | enabled | True | | id | 4b01ddc866dd4968a8ce9ddb7372ee72 | | internalurl | http://192.168.2.72:5000/v2.0 | | publicurl | https://ctrlpodu.seli.gic.ericsson.se:5000/v2.0 | | region | RegionOne | | service_id | 4f11ecd654ff496a8deb7a11d2d8dd81 | | service_name | keystone | | service_type | identity | +--------------+--------------------------------------------------+
Fill in the fields according to the output information. For example:
Endpoint Name
IP Address
Port
Version
Test URL
KeystoneAdmin
ctrlpodu.seli.gic.ericsson.se
35357
2.0
/v2.0
Keystone
ctrlpodu.seli.gic.ericsson.se
5000
2.0
/v2.0
- Click Register to finish VIM Zone register.
3.3 Generate Tenant Credentials User in EO
Tenant user is created for operating CEE projects which belong to the specific tenant.
- Log on to EO as admin user. Choose Administration > Tenants, and click Create.
- On the Create Tenant page, fill in the
fields under Tenant Information, Quota Assignment, and User Information. Tenant Log URL canl be generated according to Tenant Name.
- Note:
- Click Save button to finish creating Tenant.
3.4 Create Project
- Log on to EO as admin user. Choose Infrastructure > Projects, and click Create.
- Fill all the parameters on Project Information.
- Go to VIM Zone Connections, and click Connect VIM Zone.
- Select the VIM zone from the list to connect, and click Connect.
3.5 Create Virtual Data Center (VDC) in EO
- Log on to EO as tenant user. Choose Assets > Virtual Data Centers.
- On the Virtual Data Centers page, click Create.
- On the Search for Offers page, choose an Asset Type, and click Next.
- On the Choose Offer page, choose a VDC Offer, and click Next.
- On the Choose VIM Zone page, select the VIM zone that is registered. For detailed information, see Section 3.2 Register New VIM Zone in EO.
- On the Enter Attributes page, modify the Virtual Data Center Name, input the description, then click Submit Order to finish VDC creation.
3.6 Create Image
Make sure the image name is same as it is in ipwvnf.conf, which is prepared in Section Configuring IPWorks VNF Parameters in IPWorks Deployment Guide.
There are 2 ways to create the image:
3.6.1 Creating Image from File
- Log on to Atlas server.
$ ssh atlasadm@<Atlas_addr>
$ cd /home/atlasadm/ipworks/images
- Copy the following image files to a directory that can
be accessed from EO.
- ipw-sc-22.qcow2
- pxeboot.qcow2
- Start creating the image.
Refer to section Create Image from File in Cloud Manager User Guide.
3.6.2 Creating Image from VIM Zone
- Log on to Atlas server.
$ ssh atlasadm@<Atlas_addr>
- Create SC and PL images on VIM.
$ glance image-create --name <SC_IMAGE_NAME> --disk-format qcow2 --container-format bare --file <SC_IMAGE_FILE>
$ glance image-create --name <PL_IMAGE_NAME> --disk-format qcow2 --container-format bare --file <PL_IMAGE_FILE>
For example:
$ glance image-create --name IPW_SC_IMAGE --disk-format qcow2 --container-format bare --file /home/atlasadm/ipworks/images/ipw-sc-22.qcow2
$ glance image-create -–name IPW_PL_IMAGE --disk-format qcow2 --container-format bare --file /home/atlasadm/ipworks/images/pxeboot.qcow2
- Check the result and get VIM Image Object ID.
$ glance image-list
- Start creating the image from VIM.
Refer to section Create an Image from a VIM Zone in Cloud Manager User Guide.
3.7 Create Flavor
Make sure the flavor name is same as it is in ipwvnf.conf, which is prepared in Section Configuring IPWorks VNF Parameters in IPWorks Deployment Guide, Reference [3].
- Log on to EO as admin user.
- Select Resources > Server Resource Templates.
- Select Create on Server Resource
Templates, and fill the fields of Name, Virtual Memory (MB), Disk Size, and Extra Specifications. Then click Create.
- The required fields information can be found in configuration file.
- Extra Specifications must be added
as below:
Key
Value
hw:cpu_threads
1
hw:cpu_cores
1
hw:cpu_sockets
2
hw:cpu_policy
dedicated
hw:mem_page_size
1048576
- Select the SC flavor that you want to transfer to VIM. Then click Transfer to VIM.
- Select the VIM Zone which was registered according to IPWorks VNF Life Cycle Management (Workflow) - Full Stack, and click Transfer.
- Select the PL flavor that you want to transfer to VIM. Then click Transfer to VIM.
- Select the VIM Zone which was registered in IPWorks VNF Life Cycle Management (Workflow) - Full Stack, and click Transfer.
- Note:
- After the transfer, EO will add a prefix "CM-" to the names
of the flavors that are on CEE. For example:
"SC_FLAVOR_NAME":"CM-ipw05_SC_new_0929", "PL_FLAVOR_NAME":"CM-ipw05_PL_new_0929",
3.8 Generate VNF Package
VNF package is used in EO procedure. This package contains all the VNF configuration information which will be upload onto EO for VNF deployment.
- Generate the wrapper file VNFD_Wrapper_vIPWorks.json.
- Copy the HOT files (env.yaml, main.yaml, and ipw_scaling_group.yaml) and id_rsa.pub to the folders that under /vnflcm-ext/current/vnf_package_repo/vIPWorks__<Version>.
HOT files are generated in Atlas, refer to section Deploying IPWorks By EO in IPWorks Deployment Guide.
# cp <path to store the HOT Files>/env.yaml /vnflcm-ext/current/vnf_package_repo/vIPWorks__<Version>/configurations/<Instance configuration folder>
# cp <path to store the HOT Files>/main.yaml /vnflcm-ext/current/vnf_package_repo/vIPWorks__<Version>/
# cp <path to store the HOT Files>/ipw_scaling_group.yaml /vnflcm-ext/current/vnf_package_repo/vIPWorks__<Version>/Resources/HotFiles/
# cp /home/jboss_user/.ssh/id_rsa.pub /vnflcm-ext/current/vnf_package_repo/vIPWorks__<Version>/configurations/<Instance configuration folder>
# cp /home/jboss_user/.ssh/id_rsa.pub /vnflcm-ext/current/vnf_package_repo/vIPWorks__<Version>/Resources/UserConfigurationFiles
- Log on to LCM, and go to /vnflcm-ext/current/vnf_package_repo/vIPWorks__<Version>/Resources/LcmScripts.
- Run the script yaml2json.py.
> python yaml2json.py -i ../../configurations/instance1_config/env.yaml -o ../VnfdWrapperFiles/VNFD_Wrapper_vIPWorks.json
VNFD_Wrapper_vIPWorks.json will be generated in /vnflcm-ext/current/vnf_package_repo/vIPWorks__<Version>/Resources/VnfdWrapperFiles/.
- Copy the HOT files (env.yaml, main.yaml, and ipw_scaling_group.yaml) and id_rsa.pub to the folders that under /vnflcm-ext/current/vnf_package_repo/vIPWorks__<Version>.
- Verify the
structure of the vnflcm-ext/current/vnf_package_repo/vIPWorks_<Version> directory is as follow:
<vnfId> †‡‡ configurations € ƒ‡‡ instance1_config € ƒ‡‡ env.yaml € ƒ‡‡ id_rsa.pub ƒ‡‡ Resources †‡‡ EnvironmentFiles € ƒ‡‡ config.yaml †‡‡ HotFiles € ƒ‡‡ ipw_scaling_group.yaml †‡‡ LcmScripts € †‡‡ post_instantiation.py € †‡‡ pre_instantiation.py € †‡‡ pre_termination.py € †‡‡ ipwcommon.py € †‡‡ pre_scale.py € †‡‡ post_scale.py € ƒ‡‡ yaml2json.py †‡‡ UserConfigurationFiles € ƒ‡‡ id_rsa.pub †‡‡ VnfdWrapperFiles/ € ƒ‡‡ VNFD_Wrapper_vIPWorks.json †‡‡ main.yaml - Modify the file VNFD_Wrapper_vIPWorks.json, add the prefix "CM-" in front of SC_FLAVOR_NAME and PL_FLAVOR_NAME.
- Log on to LCM, go to /vnflcm-ext/current/vnf_package_repo/, and create a zip file with all the files in vIPWorks__<Version>.
# zip -r vIPWorks__<Version>.zip vIPWorks__<Version>
Then a vIPWorks__<Version>.zip file is created.
- Copy this zip file vIPWorks__<Version>.zip and the wrapper file VNFD_Wrapper_vIPWorks.json to any storage where user can upload them to EO.
4 Procedures - Triggered from EO
These sections describe how to perform full stack triggered from EO.
4.1 Deploy Network Stack
Network stack contains the network functions that are used for IPWorks. It can be detached from IPWorks stack and deployed/terminated independently.
- Log on to Atlas server.
$ ssh atlasadm@<Atlas_addr>
- Put the following files to a directory that can be accessed
from EO.
- /home/atlasadm/ipworks/cee_deployment/tmp/<VNF_Name>/<VNF_Name>-network-env.yaml
- /home/atlasadm/ipworks/temp/mode22/ipw-network.yaml (for HDS environment)
- /home/atlasadm/ipworks/temp/mode22/ipw-network-eo.yaml (for BSP environment)
- Log on to EO with tenant credentials, and select Resources > Packages.
- On the Packages page, select Upload > HOT Package.
- On the Upload HOT Package, select the template hot file. For example: ipw-network.yaml. Then click Start.
- Back to the Packages page, select the template hot file, and click Deploy to start installing Network VNF.
- On the Create Virtual Application page, make sure the information is correct, and click Next.
- Confirm the HOT Package name, and click Next.
- Leave Set VIM Criteria blank, click Next.
- Choose a VIM Zone, and click Next.
- On the Attributes page, fill in the required fields.
- Click Submit Order, result is as follows.
- Click Orders. Check the Status of the submitted order. Completed means the deployment
succeeded.
Status
Description
Completed
Succeeded.
In Progress
Not yet finish.
Warning
Finished with defects.
Failed
Instantiation failed.
- If HDS platform with SDN is used, configure the L2 gateway connections. Refer to section SDN Network Configuration for IPWorks VNF in IPWorks Deployment Guide, Reference [3].
4.2 Instantiate VNF
- Log on to EO with tenant credentials, and select Resources > Packages.
- On the Packages page, select Upload > Unclassified.
- On the Upload VNF Unclassified Package page, fill in all the required fields.
- Select vIPWorks__<Version>.zip that was created in Section 3.8 Generate VNF Package as New Package File. The package name must be the same as the folder where the main.yaml is located. That is, the folder where all workflow files are stored. For example: vIPWorks__<Version>.
- Select the corresponding wrapper file in vIPWorks__<Version>/Resources/VnfdWrapperFiles/ as New Configuration File.
- Fill in Package Version and Software
Version. This parameter must be the same as the parameter vnfdId of the VNFD_Wrapper_vIPWorks.json. For example:
"dataVNFDSpecific": { "vnfdId": "vIPWorks__<Version>", "vnfdVersion": "<Version>", "vnfProvider": "Ericsson", "vnfProductName": "vIPWorks", "vnfSoftwareVersion": "<Version>", "flavourId": ["default"], }Take the value of vnfdVersion as Package Version; take the value of vnfSoftwareVersion as Software Version.
- Rename the package in New Package Name. The package name cannot be same as other existing ones.
- Click Assign Managers, select the corresponding manager, add it to Managers for this Package, then click Assign.
- On the Upload VNF Unclassified Package page, click Start. Wait until package uploading succeeded.
- Select Resources > Packages. Check the available package, and click Deploy. Or click the hyperlink of the package, go to the package information page, and click Deploy.
- Following pages show the configuration parameters. Click Next to process.
- On the Enter Attributes page, rename Virtual Application Name to avoid conflict with other application
name. Select VNF manager if it is empty. Click Submit Order to start instantiation.
If you want to connect vIPWorks to ENM, click the tag Configuration, and add the following parameters in the end of configuration.
"workflow_OSS_NETWORK_ELEMENT_TYPE": "vIPWorks", "workflow_OSS_NETWORK_ELEMENT_USER_NAME": "root", "workflow_OSS_NETWORK_ELEMENT_PASSWORD": "rootroot","workflow_OSS_ADDVNFTOOSS": "true"
For example:
Parameter
Type
Description
workflow_OSS_NETWORK_ELEMENT_TYPE
string
The Network element type.
workflow_OSS_NETWORK_ELEMENT_USER_NAME
string
Username to access the VNF.
workflow_OSS_NETWORK_ELEMENT_PASSWORD
string
Password of the username to access the VNF.
workflow_OSS_ADDVNFTOOSS
bool
- Verify the instantiation.
- Log on to workflow. The instantiation triggered from EO will also be displayed in workflow.
- Log on to EO, click Orders. Check the Status of the submitted order. Completed means the instantiation
succeeded.
Status
Description
Completed
Succeeded.
In Progress
Not yet finish.
Warning
Finished with defects.
Failed
Instantiation failed.
- Change the
password for the <EMERGENCY_USER> user.
$ssh <EMERGENCY_USER>@<SC-1_IP_Address>
This <EMERGENCY_USER> user is used for graceful termination and scale operations. The default value of <EMERGENCY_USER> is emergency. The default password is emergency.
After logging on the system for the first time, there is a prompt to have the user change the password.
For more information about the parameter <EMERGENCY_USER>, refer to the table "IPWorks VNF Deployment Parameter for HEAT Stack" in IPWorks Deployment Guide, Reference [3].
4.3 Scale VNF
This section describes how to scale-in and scale-out a VNF using EO.
Scale is NOT supported in this LCM version (18.16 IP1, media version 4.9.22).
4.4 Terminate VNF
This section describes how to terminate a VNF using EO.
- Log on to EO with tenant credentials and select Assets > Virtual Applications.
- Check the
VAPP you want to delete, and click Delete to implement
termination operation.
The following options are available as termination types:
Graceful
The VMs in the cluster are gracefully locked: the VAPP instance gradually stops processing traffic, but there still might be a minor traffic loss. The VAPP is terminated after the expiration of the graceful termination period.
Forceful
The VAPP is terminated immediately, all ongoing traffic is lost. This option must be confirmed on the next screen, as it stops all traffic.
Graceful termination timeout (sec)
The graceful termination timeout value defines the time length from applying graceful termination to the termination of the VAPP. Ongoing traffic still happens during this period. 120 seconds is the recommended value.
- Verify the termination.
- Log on to workflow. The instantiation triggered from EO is also displayed in the workflow.
- Log on to EO, click Orders. Check the Status of the submitted order. Completed means the termination succeeded.
Status
Description
Completed
Succeeded.
In Progress
Not yet finish.
Warning
Finished with defects.
Failed
Termination failed.
- Terminate the corresponding network stack.
5 Procedures - Trigger from LCM with EO Involved
These sections describe how to perform full stack triggered from LCM but with EO involved.
5.1 Instantiate VNF
Instantiation is NOT supported in this LCM version (18.16 IP1, media version 4.9.22).
5.2 Scale VNF
This section describes how to scale-in and scale-out a VNF using EO.
Continue with this procedure only when the VNF is already instantiated by EO.
For how to do scale, refer to section Scale VNF in IPWorks VNF Life Cycle Management (Workflow) - Small Stack.
5.3 Terminate VNF
This section describes how to terminate a VNF using VNF-LCM with EO involved.
Continue with this procedure only when VNF is already instantiated by EO.
- On the VNF-LCM Workflows page, select Terminate VNF, and click Start a New Instance.
- On the Start a Workflow page, fill out the Instance Name field, and click Submit.
- Select the newly created workflow from the Instance Activity panel.
- On the Workflow Instance page, select the VNF
that is to be terminated, select termination type, and click Submit.
- Note:
- It will take a few minutes to complete. You can click Refresh to check the status of the task.
The following options are available as termination types:
|
Graceful |
The VMs in the cluster are gracefully locked: the VNF instance gradually stops processing traffic, but there still might be a minor traffic loss. The VNF is terminated after the expiration of the graceful termination period. |
|
Forceful |
The VNF is terminated immediately, all ongoing traffic is lost. This option must be confirmed on the next screen, as it stops all traffic. |
|
Graceful termination timeout (sec) |
The graceful termination timeout value defines the time length from applying graceful termination to the termination of the VNF. Ongoing traffic still happens during this period. The default value is -1, which means the VNF is terminated only after all VMs stopped processing traffic. |
6 Troubleshooting
If the workflow execution is unsuccessful, refer to the section IPWorks Workflows Problems in IPWorks Troubleshooting Guideline to investigate and resolve the possible issues.
The log from VNF-LCM is located in VNF-LCM: /ericsson/3pp/jboss/standalone/log/server.log.

Contents




















































