openstack/tacker
Code Issues Proposed changes
ff2e8da445
tacker/doc/source/cli/cli-legacy-nfp.rst
Yoshito Ito 49372c7551 Add CLI docs for ETSI-based and Legacy Tacker 
* ETSI-based implementation
  - VNF Lifecycle Management, VNF Package Management

* Legacy implementation
  - Event, Flow Classifier, Network Forwarding Path,
    NSD, Service Function Chain, VIM, VNF, VNFD,
    VNFFGD, VNFFG

The VNFFG doc needs to be updated after fixing:
* https://bugs.launchpad.net/python-tackerclient/+bug/1892152

The CLI doc for NS is not included because of:
* https://bugs.launchpad.net/tacker/+bug/1892144

Change-Id: Ie66d774fb87f481c11846afd229700f5f7b165c4
2020-09-16 23:10:55 +09:00

4.9 KiB
Raw Blame History

Network Forwarding Path Management

Network Forwarding Path (NFP) is composed of a Service Function Chain (SFC) and a Flow Classifier (FC) in VNF Forwarding Graph (VNFFG).

This document describes how to manage NFP with CLI in Tacker.

Prerequisites

The following packages should be installed:

  • tacker
  • python-tackerclient

A default VIM should be registered according to ./cli-legacy-vim.

The following VNFDs are created with the name VNFD1 and VNFD2 according to ./cli-legacy-vnfd.

$ openstack vnf descriptor create --vnfd-file tosca-vnffg-vnfd1.yaml VNFD1
$ openstack vnf descriptor create --vnfd-file tosca-vnffg-vnfd2.yaml VNFD2

The VNFs from the created VNFDs are deployed with the name VNF1 and VNF2 according to ./cli-legacy-vnf.

$ openstack vnf create --vnfd-name VNFD1 VNF1
$ openstack vnf create --vnfd-name VNFD2 VNF2

A VNFFG should be deployed according to ./cli-legacy-vnffg. Before deploying the VNFFG, a VNFFGD may need to be created according to ./cli-legacy-vnffgd.

CLI reference for NFP Management

1. List Network Forwarding Path

$ openstack vnf network forwarding path list

Result:

+--------------------------------------+------------------+--------+--------------------------------------+---------+
| ID                                   | Name             | Status | VNFFG ID                             | Path ID |
+--------------------------------------+------------------+--------+--------------------------------------+---------+
| ed450e71-345d-4dc8-8f32-69e3a697ad56 | Forwarding_path1 | ACTIVE | 3b1be255-4b3b-4ff2-b985-19f043f3f40c | 51      |
+--------------------------------------+------------------+--------+--------------------------------------+---------+

Help:

$ openstack vnf network forwarding path list --help
usage: openstack vnf network forwarding path list [-h]
                                                  [-f {csv,json,table,value,yaml}]
                                                  [-c COLUMN]
                                                  [--quote {all,minimal,none,nonnumeric}]
                                                  [--noindent]
                                                  [--max-width <integer>]
                                                  [--fit-width]
                                                  [--print-empty]
                                                  [--sort-column SORT_COLUMN]
                                                  [--vnffg-id VNFFG_ID]

List NFP(s) that belong to a given tenant.

optional arguments:
  -h, --help            show this help message and exit
  --vnffg-id VNFFG_ID   List NFP(s) with specific VNFFG ID

2. Show Network Forwarding Path

$ openstack vnf network forwarding path show <NFP>

Result:

+-------------+--------------------------------------+
| Field       | Value                                |
+-------------+--------------------------------------+
| chain_id    | 89f99c03-a152-413b-bb39-c7618a54b23a |
| id          | ed450e71-345d-4dc8-8f32-69e3a697ad56 |
| name        | Forwarding_path1                     |
| path_id     | 51                                   |
| project_id  | e77397d2a02c4af1b7d79cef2a406396     |
| status      | ACTIVE                               |
| symmetrical | False                                |
| vnffg_id    | 3b1be255-4b3b-4ff2-b985-19f043f3f40c |
+-------------+--------------------------------------+

Help:

$ openstack vnf network forwarding path show --help
usage: openstack vnf network forwarding path show [-h]
                                                  [-f {json,shell,table,value,yaml}]
                                                  [-c COLUMN] [--noindent]
                                                  [--prefix PREFIX]
                                                  [--max-width <integer>]
                                                  [--fit-width]
                                                  [--print-empty]
                                                  <NFP>

Display NFP details

positional arguments:
  <NFP>                 NFP to display (name or ID)

optional arguments:
  -h, --help            show this help message and exit