Files
tacker/doc/source/user/etsi_getting_started.rst

56 KiB

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 /user/v2/getting_started/index for Tacker v2 API.

Following two types of VNF deployment supported by Tacker are introduced in this lecture.

  • /user/etsi_vnf_deployment_as_vm_with_tosca
  • /user/etsi_vnf_deployment_as_vm_with_user_data

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

/_images/etsi-getting-started-sample-vnf.png

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 /cli/index to find all the available commands.

Register VIM

  1. Prepare VIM configuration file:

    You can use a setup script for generating VIM configuration or edit it from scratch as described in /reference/vim_config. 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_ROOT is 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 -h for 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

    ../../../samples/etsi_getting_started/tosca/vim/vim_config.yaml

  2. Register Default VIM:

    Once you setup VIM configuration file, you register default VIM via openstack command with --is-default option.

    $ 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"                |
    |                | }                                                   |
    +----------------+-----------------------------------------------------+
  3. Confirm that the status of registered VIM is ACTIVE as 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

  1. 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
  2. Create a TOSCA.meta file:

    $ vi ./sample_vnf_package_csar/TOSCA-Metadata/TOSCA.meta

    ../../../samples/etsi_getting_started/tosca/sample_vnf_package_csar/TOSCA-Metadata/TOSCA.meta

  3. 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
  4. 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 /user/vnfd-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
  5. Create VNFD files:

    • Create sample_vnfd_top.yaml

      $ vi ./sample_vnfd_top.yaml

      ../../../samples/etsi_getting_started/tosca/sample_vnf_package_csar/Definitions/sample_vnfd_top.yaml

    • Create sample_vnfd_types.yaml

      $ vi ./sample_vnfd_types.yaml

      ../../../samples/etsi_getting_started/tosca/sample_vnf_package_csar/Definitions/sample_vnfd_types.yaml

      Note

      description_id shall be globally unique, i.e., you cannot create multiple VNFDs with the same description_id.

    • Create sample_vnfd_df_simple.yaml

      $ vi ./sample_vnfd_df_simple.yaml

      ../../../samples/etsi_getting_started/tosca/sample_vnf_package_csar/Definitions/sample_vnfd_df_simple.yaml

      Note

      The flavour_description should be updated by the property in "VNF" but Tacker cannot handle it. After the instantiation, the default value in sample_vnfd_types.yaml is always used.

  6. [This is UserData specific part] Create BaseHOT files:

    $ cd -
    $ vi ./sample_vnf_package_csar/BaseHOT/simple/sample_lcm_with_user_data_hot.yaml

    ../../../samples/etsi_getting_started/userdata/sample_vnf_package_csar/BaseHOT/simple/sample_lcm_with_user_data_hot.yaml

  7. [This is UserData specific part] Create UserData files:

    $ cd ./sample_vnf_package_csar/UserData/
    $ touch ./__init__.py
    $ vi ./lcm_user_data.py

    ../../../samples/etsi_getting_started/userdata/sample_vnf_package_csar/UserData/lcm_user_data.py

  8. 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 BaseHOT and UserData directories.

      $ 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

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

  1. Execute vnfpkgm upload:

    The "VNF Package ID" 156f1c4f-bfe2-492b-a079-a1bad32c0c3d needs 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

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

  1. Find "VNFD ID" to create VNF:

    The "VNFD-ID" can be found to be b1bb0ce7-ebca-4fa7-95ed-4840d70a1177 in the example.

    $ openstack vnf package show \
      156f1c4f-bfe2-492b-a079-a1bad32c0c3d -c 'VNFD ID'
    +---------+--------------------------------------+
    | Field   | Value                                |
    +---------+--------------------------------------+
    | VNFD ID | b1bb0ce7-ebca-4fa7-95ed-4840d70a1177 |
    +---------+--------------------------------------+
  2. Create VNF:

    The "VNFD ID" b1bb0ce7-ebca-4fa7-95ed-4840d70a1177 needs 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

  1. Create <param-file>:

    Required parameter:

    • flavourID

    Optional parametes:

    • instantiationLevelId
    • extVirtualLinks
    • extManagedVirtualLinks
    • vimConnectionInfo

    Note

    You can skip vimConnectionInfo only when you have the default VIM.

    A sample <param-file> named as sample_param_file.json with minimal parametes:

    $ vi ./sample_param_file.json
    • When using TOSCA, use the following parameters.

      ../../../samples/etsi_getting_started/tosca/lcm_instantiate_request/sample_param_file.json

    • [This is UserData specific part] When using UserData, use the following parameters instead.

      ../../../samples/etsi_getting_started/userdata/lcm_instantiate_request/sample_param_file.json

    ${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
  2. 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"       |
    |                             |     },                                                                                                               |
    |                             |     "scale": {                                                                                                       |
    |                             |         "href": "http://localhost:9890/vnflcm/v1/vnf_instances/810d8c9b-e467-4b06-9265-ac9dce015fce/scale"           |
    |                             |     },                                                                                                               |
    |                             |     "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

  1. 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 |
    +--------------------------------------+------------------------------------------+---------------------+--------------+----------------------+------------------+--------------------------------------+
  2. 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

  1. Delete VNF Instance:

    $ openstack vnflcm delete 810d8c9b-e467-4b06-9265-ac9dce015fce
    Vnf instance '810d8c9b-e467-4b06-9265-ac9dce015fce' is deleted successfully

Delete VNF Package

  1. 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.
    1. 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
    2. 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
    3. Restart neutron services:

      $ sudo systemctl restart devstack@q-*
  • Error in networking-sfc

    1. 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
    2. Edit /etc/neutron/plugins/ml2/ml2_conf.ini:

      $ sudo vi /etc/neutron/plugins/ml2/ml2_conf.ini
      - [agent]
      - extensions = sfc
    3. Restart neutron services:

      $ sudo systemctl restart devstack@q-*