Getting Started with v1 Tacker¶
Summary¶
This lecture enables you to:
create & delete a sample VNF on the OpenStack with Tacker v1 API
Note
This is a document for Tacker v1 API. See Getting Started with v2 Tacker for Tacker v2 API.
Following two types of VNF deployment supported by Tacker are introduced in this lecture.
“VNF Deployment with LCM Operation User Data” is optional. The part will be clarified with the notation [This is UserData specific part].
The following figure shows a sample VNF used in this lecture.
Note
VIM config, a VNF package, and instantiation parameters used in this tutorial are placed at the repository.
Note
You can see logs of Tacker with this command:
$ sudo journalctl -u devstack@tacker.service
$ sudo journalctl -u devstack@tacker-conductor.service
Prerequisites¶
The following packages should be installed:
tacker
python-tackerclient
Configuration¶
Load credentials for client operations¶
Before any Tacker commands can be run, your credentials need to be sourced.
Note
See Create OpenStack client environment scripts for details. In this document, the settings are as follows:
OS_REGION_NAME=RegionOne
OS_PROJECT_DOMAIN_ID=default
OS_CACERT=
OS_AUTH_URL=http://192.168.56.10/identity
OS_TENANT_NAME=admin
OS_USER_DOMAIN_ID=default
OS_USERNAME=admin
OS_VOLUME_API_VERSION=3
OS_AUTH_TYPE=password
OS_PROJECT_NAME=admin
OS_PASSWORD=devstack
OS_IDENTITY_API_VERSION=3
You can confirm that Tacker is available by checking this command works without error:
$ openstack vim list
Note
See Command-Line Interface Reference to find all the available commands.
Register VIM¶
Prepare VIM configuration file:
You can use a setup script for generating VIM configuration or edit it from scratch as described in Configuration File for Registering VIM. This script finds parameters for the configuration, such as user name or password, from your environment variables. Here is an example of generating OpenStack VIM configuration as
vim_config.yaml. In this document,TACKER_ROOTis the root of tacker’s repository on your server.$ bash TACKER_ROOT/tools/gen_vim_config.sh Config for OpenStack VIM 'vim_config.yaml' generated.
There are several options for configuring parameters from command line supported. Refer help with
-hfor details.You can also use a sample configuration file vim_config.yaml instead of using the script.
$ cp TACKER_ROOT/samples/etsi_getting_started/tosca/vim/vim_config.yaml ./ $ vi vim_config.yaml
auth_url: 'http://127.0.0.1/identity' username: 'admin' password: 'devstack' project_name: 'admin' domain_name: "default" project_domain_name: 'default' user_domain_name: 'default' cert_verify: 'True'
Register Default VIM:
Once you setup VIM configuration file, you register default VIM via
openstackcommand with--is-defaultoption.$ openstack vim register --config-file ./vim_config.yaml \ --is-default --fit-width openstack-admin-vim +----------------+-----------------------------------------------------+ | Field | Value | +----------------+-----------------------------------------------------+ | auth_cred | { | | | "username": "admin", | | | "user_domain_name": "default", | | | "cert_verify": "True", | | | "project_id": null, | | | "project_name": "admin", | | | "project_domain_name": "default", | | | "auth_url": "http://192.168.56.10/identity/v3", | | | "key_type": "barbican_key", | | | "secret_uuid": "***", | | | "password": "***" | | | } | | auth_url | http://192.168.56.10/identity/v3 | | created_at | 2023-12-21 07:39:09.617234 | | description | | | extra | | | id | 662e5f4f-3b16-4ca6-b560-28b62dd0e13b | | is_default | True | | name | openstack-admin-vim | | placement_attr | { | | | "regions": [ | | | "RegionOne" | | | ] | | | } | | project_id | 1994d69783d64c00aadab564038c2fd7 | | status | ACTIVE | | type | openstack | | updated_at | None | | vim_project | { | | | "name": "admin", | | | "project_domain_name": "default" | | | } | +----------------+-----------------------------------------------------+
Confirm that the status of registered VIM is
ACTIVEas ready to use:$ openstack vim list +--------------------------------------+---------------------+----------------------------------+-----------+------------+--------+ | ID | Name | Tenant_id | Type | Is Default | Status | +--------------------------------------+---------------------+----------------------------------+-----------+------------+--------+ | 662e5f4f-3b16-4ca6-b560-28b62dd0e13b | openstack-admin-vim | 1994d69783d64c00aadab564038c2fd7 | openstack | True | ACTIVE | +--------------------------------------+---------------------+----------------------------------+-----------+------------+--------+
Create and Upload VNF Package¶
Prepare VNF Package¶
Create VNF Package CSAR directories:
$ mkdir -p ./sample_vnf_package_csar/TOSCA-Metadata \ ./sample_vnf_package_csar/Definitions \ ./sample_vnf_package_csar/Files/images
[This is UserData specific part] When using UserData, create the following directories in addition.
$ mkdir -p ./sample_vnf_package_csar/BaseHOT/simple \ ./sample_vnf_package_csar/UserData
Create a
TOSCA.metafile:$ vi ./sample_vnf_package_csar/TOSCA-Metadata/TOSCA.meta
TOSCA-Meta-File-Version: 1.0 Created-by: Dummy User CSAR-Version: 1.1 Entry-Definitions: Definitions/sample_vnfd_top.yaml
Download image file:
$ cd ./sample_vnf_package_csar/Files/images $ wget https://download.cirros-cloud.net/0.5.2/cirros-0.5.2-x86_64-disk.img
Download ETSI definition files:
You should set
${TOSCA_VERSION}to one of the appropriate TOSCA service template versions (SOL001), e.g.,export TOSCA_VERSION=v2.6.1.Important
You should also check if the version of TOSCA service template is supported by tacker. See VNF Descriptor (VNFD) based on ETSI NFV-SOL001 for supported version.
$ cd - $ cd ./sample_vnf_package_csar/Definitions $ wget https://forge.etsi.org/rep/nfv/SOL001/raw/${TOSCA_VERSION}/etsi_nfv_sol001_common_types.yaml $ wget https://forge.etsi.org/rep/nfv/SOL001/raw/${TOSCA_VERSION}/etsi_nfv_sol001_vnfd_types.yaml
Create VNFD files:
Create
sample_vnfd_top.yaml$ vi ./sample_vnfd_top.yaml
tosca_definitions_version: tosca_simple_yaml_1_2 description: Sample VNF imports: - etsi_nfv_sol001_common_types.yaml - etsi_nfv_sol001_vnfd_types.yaml - sample_vnfd_types.yaml - sample_vnfd_df_simple.yaml topology_template: inputs: selected_flavour: type: string description: VNF deployment flavour selected by the consumer. It is provided in the API node_templates: VNF: type: company.provider.VNF properties: flavour_id: { get_input: selected_flavour } descriptor_id: b1bb0ce7-ebca-4fa7-95ed-4840d70a1177 provider: Company product_name: Sample VNF software_version: '1.0' descriptor_version: '1.0' vnfm_info: - Tacker requirements: #- virtual_link_external # mapped in lower-level templates #- virtual_link_internal # mapped in lower-level templates
Create
sample_vnfd_types.yaml$ vi ./sample_vnfd_types.yaml
tosca_definitions_version: tosca_simple_yaml_1_2 description: VNF type definition imports: - etsi_nfv_sol001_common_types.yaml - etsi_nfv_sol001_vnfd_types.yaml node_types: company.provider.VNF: derived_from: tosca.nodes.nfv.VNF properties: id: type: string description: ID of this VNF default: vnf_id vendor: type: string description: name of the vendor who generate this VNF default: vendor version: type: version description: version of the software for this VNF default: 1.0 descriptor_id: type: string constraints: [ valid_values: [ b1bb0ce7-ebca-4fa7-95ed-4840d70a1177 ] ] default: b1bb0ce7-ebca-4fa7-95ed-4840d70a1177 descriptor_version: type: string constraints: [ valid_values: [ '1.0' ] ] default: '1.0' provider: type: string constraints: [ valid_values: [ 'Company' ] ] default: 'Company' product_name: type: string constraints: [ valid_values: [ 'Sample VNF' ] ] default: 'Sample VNF' software_version: type: string constraints: [ valid_values: [ '1.0' ] ] default: '1.0' vnfm_info: type: list entry_schema: type: string constraints: [ valid_values: [ Tacker ] ] default: [ Tacker ] flavour_id: type: string constraints: [ valid_values: [ simple ] ] default: simple flavour_description: type: string default: This is the default flavour description requirements: - virtual_link_internal: capability: tosca.capabilities.nfv.VirtualLinkable interfaces: Vnflcm: type: tosca.interfaces.nfv.Vnflcm
Note
description_idshall be globally unique, i.e., you cannot create multiple VNFDs with the samedescription_id.Create
sample_vnfd_df_simple.yaml$ vi ./sample_vnfd_df_simple.yaml
tosca_definitions_version: tosca_simple_yaml_1_2 description: Simple deployment flavour for Sample VNF imports: - etsi_nfv_sol001_common_types.yaml - etsi_nfv_sol001_vnfd_types.yaml - sample_vnfd_types.yaml topology_template: inputs: id: type: string vendor: type: string version: type: version descriptor_id: type: string descriptor_version: type: string provider: type: string product_name: type: string software_version: type: string vnfm_info: type: list entry_schema: type: string flavour_id: type: string flavour_description: type: string substitution_mappings: node_type: company.provider.VNF properties: flavour_id: simple requirements: virtual_link_external: [] node_templates: VNF: type: company.provider.VNF properties: flavour_description: A simple flavour interfaces: Vnflcm: instantiate: [] instantiate_start: [] instantiate_end: [] terminate: [] terminate_start: [] terminate_end: [] modify_information: [] modify_information_start: [] modify_information_end: [] VDU1: type: tosca.nodes.nfv.Vdu.Compute properties: name: VDU1 description: VDU1 compute node vdu_profile: min_number_of_instances: 1 max_number_of_instances: 1 sw_image_data: name: Software of VDU1 version: '0.5.2' checksum: algorithm: sha-512 hash: 6b813aa46bb90b4da216a4d19376593fa3f4fc7e617f03a92b7fe11e9a3981cbe8f0959dbebe36225e5f53dc4492341a4863cac4ed1ee0909f3fc78ef9c3e869 container_format: bare disk_format: qcow2 min_disk: 1 GB size: 1 GB artifacts: sw_image: type: tosca.artifacts.nfv.SwImage file: ../Files/images/cirros-0.5.2-x86_64-disk.img capabilities: virtual_compute: properties: virtual_memory: virtual_mem_size: 512 MB virtual_cpu: num_virtual_cpu: 1 virtual_local_storage: - size_of_storage: 1 GB CP1: type: tosca.nodes.nfv.VduCp properties: layer_protocols: [ ipv4 ] requirements: - virtual_binding: VDU1 - virtual_link: internalVL1 internalVL1: type: tosca.nodes.nfv.VnfVirtualLink properties: connectivity_type: layer_protocols: [ ipv4 ] description: Internal Virtual link in the VNF vl_profile: max_bitrate_requirements: root: 1048576 leaf: 1048576 min_bitrate_requirements: root: 1048576 leaf: 1048576 virtual_link_protocol_data: - associated_layer_protocol: ipv4 l3_protocol_data: ip_version: ipv4 cidr: 10.0.0.0/24
Note
The
flavour_descriptionshould be updated by the property in “VNF” but Tacker cannot handle it. After the instantiation, the default value insample_vnfd_types.yamlis always used.
[This is UserData specific part] Create BaseHOT files:
$ cd - $ vi ./sample_vnf_package_csar/BaseHOT/simple/sample_lcm_with_user_data_hot.yaml
heat_template_version: 2013-05-23 description: 'Template for test _generate_hot_from_tosca().' parameters: nfv: type: json resources: VDU1: type: OS::Nova::Server properties: flavor: get_resource: VDU1_flavor name: VDU1 image: { get_param: [ nfv, VDU, VDU1, image ] } networks: - port: get_resource: CP1 CP1: type: OS::Neutron::Port properties: network: { get_param: [ nfv, CP, CP1, network ] } VDU1_flavor: type: OS::Nova::Flavor properties: ram: { get_param: [ nfv, VDU, VDU1, flavor, ram ] } vcpus: { get_param: [ nfv, VDU, VDU1, flavor, vcpus ] } disk: { get_param: [ nfv, VDU, VDU1, flavor, disk ] } outputs: {}
[This is UserData specific part] Create UserData files:
$ cd ./sample_vnf_package_csar/UserData/ $ touch ./__init__.py $ vi ./lcm_user_data.py
# # Licensed under the Apache License, Version 2.0 (the "License"); you may # not use this file except in compliance with the License. You may obtain # a copy of the License at # # http://www.apache.org/licenses/LICENSE-2.0 # # Unless required by applicable law or agreed to in writing, software # distributed under the License is distributed on an "AS IS" BASIS, WITHOUT # WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the # License for the specific language governing permissions and limitations # under the License. import tacker.vnfm.lcm_user_data.utils as UserDataUtil from tacker.vnfm.lcm_user_data.abstract_user_data import AbstractUserData class SampleUserData(AbstractUserData): @staticmethod def instantiate(base_hot_dict=None, vnfd_dict=None, inst_req_info=None, grant_info=None): # Create HOT input parameter using util functions. initial_param_dict = UserDataUtil.create_initial_param_dict( base_hot_dict) vdu_flavor_dict = UserDataUtil.create_vdu_flavor_dict(vnfd_dict) vdu_image_dict = UserDataUtil.create_sw_image_dict(vnfd_dict) cpd_vl_dict = UserDataUtil.create_network_dict( inst_req_info, initial_param_dict) final_param_dict = UserDataUtil.create_final_param_dict( initial_param_dict, vdu_flavor_dict, vdu_image_dict, cpd_vl_dict) return final_param_dict
Compress the VNF Package CSAR to zip:
$ cd - $ cd ./sample_vnf_package_csar $ zip sample_vnf_package_csar.zip -r Definitions/ Files/ TOSCA-Metadata/
The contents of the zip file should look something like this.
$ unzip -Z -1 sample_vnf_package_csar.zip Definitions/ Definitions/etsi_nfv_sol001_vnfd_types.yaml Definitions/sample_vnfd_top.yaml Definitions/etsi_nfv_sol001_common_types.yaml Definitions/sample_vnfd_types.yaml Definitions/sample_vnfd_df_simple.yaml Files/ Files/images/ Files/images/cirros-0.5.2-x86_64-disk.img TOSCA-Metadata/ TOSCA-Metadata/TOSCA.meta
[This is UserData specific part] When using UserData, add
BaseHOTandUserDatadirectories.$ zip sample_vnf_package_csar.zip -r BaseHOT/ UserData/
The contents of the zip file should look something like this.
$ unzip -Z -1 sample_vnf_package_csar.zip BaseHOT/ BaseHOT/simple/ BaseHOT/simple/sample_lcm_with_user_data_hot.yaml Definitions/ Definitions/etsi_nfv_sol001_vnfd_types.yaml Definitions/sample_vnfd_top.yaml Definitions/etsi_nfv_sol001_common_types.yaml Definitions/sample_vnfd_types.yaml Definitions/sample_vnfd_df_simple.yaml Files/ Files/images/ Files/images/cirros-0.5.2-x86_64-disk.img TOSCA-Metadata/ TOSCA-Metadata/TOSCA.meta UserData/ UserData/lcm_user_data.py UserData/__init__.py
Here, you can find the structure of the sample VNF Package CSAR as a zip file.
Create VNF Package¶
Execute vnfpkgm create:
Take a note of “VNF Package ID” as it will be used in the next step.
$ cd -
$ openstack vnf package create +-------------------+-------------------------------------------------------------------------------------------------+ | Field | Value | +-------------------+-------------------------------------------------------------------------------------------------+ | ID | 156f1c4f-bfe2-492b-a079-a1bad32c0c3d | | Links | { | | | "self": { | | | "href": "/vnfpkgm/v1/vnf_packages/156f1c4f-bfe2-492b-a079-a1bad32c0c3d" | | | }, | | | "packageContent": { | | | "href": "/vnfpkgm/v1/vnf_packages/156f1c4f-bfe2-492b-a079-a1bad32c0c3d/package_content" | | | } | | | } | | Onboarding State | CREATED | | Operational State | DISABLED | | Usage State | NOT_IN_USE | | User Defined Data | {} | +-------------------+-------------------------------------------------------------------------------------------------+
Upload VNF Package¶
Execute vnfpkgm upload:
The “VNF Package ID”
156f1c4f-bfe2-492b-a079-a1bad32c0c3dneeds to be replaced with the appropriate one that was obtained from Create VNF Package.$ openstack vnf package upload \ --path ./sample_vnf_package_csar/sample_vnf_package_csar.zip \ 156f1c4f-bfe2-492b-a079-a1bad32c0c3d Upload request for VNF package 156f1c4f-bfe2-492b-a079-a1bad32c0c3d has been accepted.
Check the created VNF Package¶
Confirm the “Onboarding State” to be
ONBOARDED(it may take more than 30 seconds):$ openstack vnf package list +--------------------------------------+------------------+------------------+-------------+-------------------+-------------------------------------------------------------------------------------------------+ | Id | Vnf Product Name | Onboarding State | Usage State | Operational State | Links | +--------------------------------------+------------------+------------------+-------------+-------------------+-------------------------------------------------------------------------------------------------+ | 156f1c4f-bfe2-492b-a079-a1bad32c0c3d | | PROCESSING | NOT_IN_USE | DISABLED | { | | | | | | | "self": { | | | | | | | "href": "/vnfpkgm/v1/vnf_packages/156f1c4f-bfe2-492b-a079-a1bad32c0c3d" | | | | | | | }, | | | | | | | "packageContent": { | | | | | | | "href": "/vnfpkgm/v1/vnf_packages/156f1c4f-bfe2-492b-a079-a1bad32c0c3d/package_content" | | | | | | | } | | | | | | | } | +--------------------------------------+------------------+------------------+-------------+-------------------+-------------------------------------------------------------------------------------------------+ $ openstack vnf package list +--------------------------------------+------------------+------------------+-------------+-------------------+-------------------------------------------------------------------------------------------------+ | Id | Vnf Product Name | Onboarding State | Usage State | Operational State | Links | +--------------------------------------+------------------+------------------+-------------+-------------------+-------------------------------------------------------------------------------------------------+ | 156f1c4f-bfe2-492b-a079-a1bad32c0c3d | Sample VNF | ONBOARDED | NOT_IN_USE | ENABLED | { | | | | | | | "self": { | | | | | | | "href": "/vnfpkgm/v1/vnf_packages/156f1c4f-bfe2-492b-a079-a1bad32c0c3d" | | | | | | | }, | | | | | | | "packageContent": { | | | | | | | "href": "/vnfpkgm/v1/vnf_packages/156f1c4f-bfe2-492b-a079-a1bad32c0c3d/package_content" | | | | | | | } | | | | | | | } | +--------------------------------------+------------------+------------------+-------------+-------------------+-------------------------------------------------------------------------------------------------+
Create & Instantiate VNF¶
Create VNF¶
Find “VNFD ID” to create VNF:
The “VNFD-ID” can be found to be
b1bb0ce7-ebca-4fa7-95ed-4840d70a1177in the example.$ openstack vnf package show \ 156f1c4f-bfe2-492b-a079-a1bad32c0c3d -c 'VNFD ID' +---------+--------------------------------------+ | Field | Value | +---------+--------------------------------------+ | VNFD ID | b1bb0ce7-ebca-4fa7-95ed-4840d70a1177 | +---------+--------------------------------------+
Create VNF:
The “VNFD ID”
b1bb0ce7-ebca-4fa7-95ed-4840d70a1177needs to be replaced with the appropriate one.$ openstack vnflcm create b1bb0ce7-ebca-4fa7-95ed-4840d70a1177 +-----------------------------+------------------------------------------------------------------------------------------------------------------+ | Field | Value | +-----------------------------+------------------------------------------------------------------------------------------------------------------+ | ID | 810d8c9b-e467-4b06-9265-ac9dce015fce | | Instantiation State | NOT_INSTANTIATED | | Links | { | | | "self": { | | | "href": "http://localhost:9890/vnflcm/v1/vnf_instances/810d8c9b-e467-4b06-9265-ac9dce015fce" | | | }, | | | "instantiate": { | | | "href": "http://localhost:9890/vnflcm/v1/vnf_instances/810d8c9b-e467-4b06-9265-ac9dce015fce/instantiate" | | | } | | | } | | VNF Configurable Properties | | | VNF Instance Description | | | VNF Instance Name | vnf-810d8c9b-e467-4b06-9265-ac9dce015fce | | VNF Product Name | Sample VNF | | VNF Provider | Company | | VNF Software Version | 1.0 | | VNFD ID | b1bb0ce7-ebca-4fa7-95ed-4840d70a1177 | | VNFD Version | 1.0 | | vnfPkgId | | +-----------------------------+------------------------------------------------------------------------------------------------------------------+
Instantiate VNF¶
Create
<param-file>:Required parameter:
flavourID
Optional parametes:
instantiationLevelId
extVirtualLinks
extManagedVirtualLinks
vimConnectionInfo
Note
You can skip
vimConnectionInfoonly when you have the default VIM.A sample
<param-file>named assample_param_file.jsonwith minimal parametes:$ vi ./sample_param_file.json
When using TOSCA, use the following parameters.
{ "flavourId": "simple", "vimConnectionInfo": [ { "id": "e24f9796-a8e9-4cb0-85ce-5920dcddafa1", "vimId": "${vim_uuid}", "vimType": "ETSINFV.OPENSTACK_KEYSTONE.v_2" } ] }
[This is UserData specific part] When using UserData, use the following parameters instead.
{ "flavourId": "simple", "extVirtualLinks": [ { "id": "net0", "resourceId": "${network_uuid}", "extCps": [ { "cpdId": "CP1", "cpConfig": [ { "cpProtocolData": [ { "layerProtocol": "IP_OVER_ETHERNET", "ipOverEthernet": { "ipAddresses": [ { "type": "IPV4", "numDynamicAddresses": 1, "subnetId": "${subnet_uuid}" } ] } } ] } ] } ] } ], "vimConnectionInfo": [ { "id": "e24f9796-a8e9-4cb0-85ce-5920dcddafa1", "vimId": "${vim_uuid}", "vimType": "ETSINFV.OPENSTACK_KEYSTONE.v_2" } ], "additionalParams": { "lcm-operation-user-data": "./UserData/lcm_user_data.py", "lcm-operation-user-data-class": "SampleUserData" } }
${network_uuid},${subnet_uuid}and${vim_uuid}should be replaced with the uuid of the network to use, the uuid of the subnet to use and the uuid of the VIM to use, respectively.Hint
You can find uuids of the network and the corresponding subnet with network command:
$ openstack network list
Instantiate VNF:
The “ID of vnf instance” and “path to <param-file>” are needed to instantiate vnf.
$ openstack vnflcm instantiate \ 810d8c9b-e467-4b06-9265-ac9dce015fce ./sample_param_file.json Instantiate request for VNF Instance 810d8c9b-e467-4b06-9265-ac9dce015fce has been accepted.
Check the details of the instantiated vnf.
$ openstack vnflcm list +--------------------------------------+------------------------------------------+---------------------+--------------+----------------------+------------------+--------------------------------------+ | ID | VNF Instance Name | Instantiation State | VNF Provider | VNF Software Version | VNF Product Name | VNFD ID | +--------------------------------------+------------------------------------------+---------------------+--------------+----------------------+------------------+--------------------------------------+ | 810d8c9b-e467-4b06-9265-ac9dce015fce | vnf-810d8c9b-e467-4b06-9265-ac9dce015fce | INSTANTIATED | Company | 1.0 | Sample VNF | b1bb0ce7-ebca-4fa7-95ed-4840d70a1177 | +--------------------------------------+------------------------------------------+---------------------+--------------+----------------------+------------------+--------------------------------------+ $ openstack vnflcm show 810d8c9b-e467-4b06-9265-ac9dce015fce +-----------------------------+----------------------------------------------------------------------------------------------------------------------+ | Field | Value | +-----------------------------+----------------------------------------------------------------------------------------------------------------------+ | ID | 810d8c9b-e467-4b06-9265-ac9dce015fce | | Instantiated Vnf Info | { | | | "flavourId": "simple", | | | "vnfState": "STARTED", | | | "extCpInfo": [], | | | "vnfcResourceInfo": [ | | | { | | | "id": "6894448f-4a88-45ec-801f-4ef455e8a613", | | | "vduId": "VDU1", | | | "computeResource": { | | | "vimConnectionId": "662e5f4f-3b16-4ca6-b560-28b62dd0e13b", | | | "resourceId": "cfb5d6de-90a1-433a-9af4-1159ca279e27", | | | "vimLevelResourceType": "OS::Nova::Server" | | | }, | | | "storageResourceIds": [], | | | "vnfcCpInfo": [ | | | { | | | "id": "b6dffe31-2e4b-44e6-8ddd-b94608a9210b", | | | "cpdId": "CP1", | | | "vnfExtCpId": null, | | | "vnfLinkPortId": "5040ae0d-ef8b-4d12-b96b-d9d05a0ba7fe" | | | } | | | ] | | | } | | | ], | | | "vnfVirtualLinkResourceInfo": [ | | | { | | | "id": "4b67e6f9-8133-4f7d-b384-abd64f9bcbac", | | | "vnfVirtualLinkDescId": "internalVL1", | | | "networkResource": { | | | "vimConnectionId": "662e5f4f-3b16-4ca6-b560-28b62dd0e13b", | | | "resourceId": "d04beb5f-b29a-4f7e-b32b-7ea669afa3eb", | | | "vimLevelResourceType": "OS::Neutron::Net" | | | }, | | | "vnfLinkPorts": [ | | | { | | | "id": "5040ae0d-ef8b-4d12-b96b-d9d05a0ba7fe", | | | "resourceHandle": { | | | "vimConnectionId": "662e5f4f-3b16-4ca6-b560-28b62dd0e13b", | | | "resourceId": "84edd7c7-a02f-4f25-be2a-a0ee5b1c8dc7", | | | "vimLevelResourceType": "OS::Neutron::Port" | | | }, | | | "cpInstanceId": "b6dffe31-2e4b-44e6-8ddd-b94608a9210b" | | | } | | | ] | | | } | | | ], | | | "vnfcInfo": [ | | | { | | | "id": "6c0ba2a3-3f26-4ba0-9b4f-db609b2e843c", | | | "vduId": "VDU1", | | | "vnfcState": "STARTED" | | | } | | | ], | | | "additionalParams": {} | | | } | | Instantiation State | INSTANTIATED | | Links | { | | | "self": { | | | "href": "http://localhost:9890/vnflcm/v1/vnf_instances/810d8c9b-e467-4b06-9265-ac9dce015fce" | | | }, | | | "terminate": { | | | "href": "http://localhost:9890/vnflcm/v1/vnf_instances/810d8c9b-e467-4b06-9265-ac9dce015fce/terminate" | | | }, | | | "heal": { | | | "href": "http://localhost:9890/vnflcm/v1/vnf_instances/810d8c9b-e467-4b06-9265-ac9dce015fce/heal" | | | }, | | | "changeExtConn": { | | | "href": "http://localhost:9890/vnflcm/v1/vnf_instances/810d8c9b-e467-4b06-9265-ac9dce015fce/change_ext_conn" | | | } | | | } | | VIM Connection Info | [ | | | { | | | "id": "e24f9796-a8e9-4cb0-85ce-5920dcddafa1", | | | "vimId": "662e5f4f-3b16-4ca6-b560-28b62dd0e13b", | | | "vimType": "ETSINFV.OPENSTACK_KEYSTONE.v_2", | | | "interfaceInfo": {}, | | | "accessInfo": {}, | | | "extra": {} | | | }, | | | { | | | "id": "67820f17-a82a-4e3a-b200-8ef119646749", | | | "vimId": "662e5f4f-3b16-4ca6-b560-28b62dd0e13b", | | | "vimType": "openstack", | | | "interfaceInfo": {}, | | | "accessInfo": {}, | | | "extra": {} | | | } | | | ] | | VNF Configurable Properties | | | VNF Instance Description | | | VNF Instance Name | vnf-810d8c9b-e467-4b06-9265-ac9dce015fce | | VNF Product Name | Sample VNF | | VNF Provider | Company | | VNF Software Version | 1.0 | | VNFD ID | b1bb0ce7-ebca-4fa7-95ed-4840d70a1177 | | VNFD Version | 1.0 | | metadata | tenant=admin | | vnfPkgId | | +-----------------------------+----------------------------------------------------------------------------------------------------------------------+
Terminate & Delete VNF¶
Terminate VNF¶
Check the VNF Instance ID to terminate:
$ openstack vnflcm list +--------------------------------------+------------------------------------------+---------------------+--------------+----------------------+------------------+--------------------------------------+ | ID | VNF Instance Name | Instantiation State | VNF Provider | VNF Software Version | VNF Product Name | VNFD ID | +--------------------------------------+------------------------------------------+---------------------+--------------+----------------------+------------------+--------------------------------------+ | 810d8c9b-e467-4b06-9265-ac9dce015fce | vnf-810d8c9b-e467-4b06-9265-ac9dce015fce | INSTANTIATED | Company | 1.0 | Sample VNF | b1bb0ce7-ebca-4fa7-95ed-4840d70a1177 | +--------------------------------------+------------------------------------------+---------------------+--------------+----------------------+------------------+--------------------------------------+
Terminate VNF Instance:
Execute terminate command:
$ openstack vnflcm terminate 810d8c9b-e467-4b06-9265-ac9dce015fce Terminate request for VNF Instance '810d8c9b-e467-4b06-9265-ac9dce015fce' has been accepted.
Check the status of VNF Instance:
$ openstack vnflcm list +--------------------------------------+------------------------------------------+---------------------+--------------+----------------------+------------------+--------------------------------------+ | ID | VNF Instance Name | Instantiation State | VNF Provider | VNF Software Version | VNF Product Name | VNFD ID | +--------------------------------------+------------------------------------------+---------------------+--------------+----------------------+------------------+--------------------------------------+ | 810d8c9b-e467-4b06-9265-ac9dce015fce | vnf-810d8c9b-e467-4b06-9265-ac9dce015fce | NOT_INSTANTIATED | Company | 1.0 | Sample VNF | b1bb0ce7-ebca-4fa7-95ed-4840d70a1177 | +--------------------------------------+------------------------------------------+---------------------+--------------+----------------------+------------------+--------------------------------------+
Delete VNF¶
Delete VNF Instance:
$ openstack vnflcm delete 810d8c9b-e467-4b06-9265-ac9dce015fce Vnf instance '810d8c9b-e467-4b06-9265-ac9dce015fce' is deleted successfully
Delete VNF Package¶
Delete VNF Package:
Check the VNF Package ID to delete:
$ openstack vnf package list +--------------------------------------+------------------+------------------+-------------+-------------------+-------------------------------------------------------------------------------------------------+ | Id | Vnf Product Name | Onboarding State | Usage State | Operational State | Links | +--------------------------------------+------------------+------------------+-------------+-------------------+-------------------------------------------------------------------------------------------------+ | 156f1c4f-bfe2-492b-a079-a1bad32c0c3d | Sample VNF | ONBOARDED | NOT_IN_USE | ENABLED | { | | | | | | | "self": { | | | | | | | "href": "/vnfpkgm/v1/vnf_packages/156f1c4f-bfe2-492b-a079-a1bad32c0c3d" | | | | | | | }, | | | | | | | "packageContent": { | | | | | | | "href": "/vnfpkgm/v1/vnf_packages/156f1c4f-bfe2-492b-a079-a1bad32c0c3d/package_content" | | | | | | | } | | | | | | | } | +--------------------------------------+------------------+------------------+-------------+-------------------+-------------------------------------------------------------------------------------------------+
Update the Operational State to
DISABLED:$ openstack vnf package update --operational-state 'DISABLED' \ 156f1c4f-bfe2-492b-a079-a1bad32c0c3d +-------------------+----------+ | Field | Value | +-------------------+----------+ | Operational State | DISABLED | +-------------------+----------+
Check the Operational State to be changed:
$ openstack vnf package list +--------------------------------------+------------------+------------------+-------------+-------------------+-------------------------------------------------------------------------------------------------+ | Id | Vnf Product Name | Onboarding State | Usage State | Operational State | Links | +--------------------------------------+------------------+------------------+-------------+-------------------+-------------------------------------------------------------------------------------------------+ | 156f1c4f-bfe2-492b-a079-a1bad32c0c3d | Sample VNF | ONBOARDED | NOT_IN_USE | DISABLED | { | | | | | | | "self": { | | | | | | | "href": "/vnfpkgm/v1/vnf_packages/156f1c4f-bfe2-492b-a079-a1bad32c0c3d" | | | | | | | }, | | | | | | | "packageContent": { | | | | | | | "href": "/vnfpkgm/v1/vnf_packages/156f1c4f-bfe2-492b-a079-a1bad32c0c3d/package_content" | | | | | | | } | | | | | | | } | +--------------------------------------+------------------+------------------+-------------+-------------------+-------------------------------------------------------------------------------------------------+
Delete the VNF Package:
$ openstack vnf package delete 156f1c4f-bfe2-492b-a079-a1bad32c0c3d All specified vnf-package(s) deleted successfully
Trouble Shooting¶
Neutron QoSPlugin error
Vnf instantiation failed for vnf 810d8c9b-e467-4b06-9265-ac9dce015fce, error: ERROR: HEAT-E99001 Service neutron is not available for resource type OS::Neutron::QoSPolicy, reason: Required extension qos in neutron service is not available.Edit
/etc/neutron/neutron.conf:$ sudo vi /etc/neutron/neutron.conf
- service_plugins = ovn-router,networking_sfc.services.flowclassifier.plugin.FlowClassifierPlugin,networking_sfc.services.sfc.plugin.SfcPlugin + service_plugins = ovn-router,networking_sfc.services.flowclassifier.plugin.FlowClassifierPlugin,networking_sfc.services.sfc.plugin.SfcPlugin,neutron.services.qos.qos_plugin.QoSPlugin,qos
Edit
/etc/neutron/plugins/ml2/ml2_conf.ini:$ sudo vi /etc/neutron/plugins/ml2/ml2_conf.ini
- extension_drivers = port_security + extension_drivers = port_security,qos
Restart neutron services:
$ sudo systemctl restart devstack@q-*
Error in networking-sfc
Disable networking-sfc by editting
/etc/neutron/neutron.conf:$ sudo vi /etc/neutron/neutron.conf
- service_plugins = ovn-router,networking_sfc.services.flowclassifier.plugin.FlowClassifierPlugin,networking_sfc.services.sfc.plugin.SfcPlugin,neutron.services.qos.qos_plugin.QoSPlugin,qos + service_plugins = ovn-router,neutron.services.qos.qos_plugin.QoSPlugin - [sfc] - drivers = ovs - [flowclassifier] - drivers = ovs
Edit
/etc/neutron/plugins/ml2/ml2_conf.ini:$ sudo vi /etc/neutron/plugins/ml2/ml2_conf.ini
- [agent] - extensions = sfc
Restart neutron services:
$ sudo systemctl restart devstack@q-*
