openstack/tacker
Code Issues Proposed changes

Add VNFLCM with v2 Tacker CLI Reference document

Browse Source 
This patch adds the VNF Lifecycle Management with
version 2 tacker CLI reference document.
Basically, the content is similar to the VNFLCM with
v1 tacker CLI reference document.
The link all over the document that should point to
new document is re-indexed.
There are also other some minor fixes about the sentence structures.

Change-Id: I6d677666387fa60672bcfcba01d703032c3d16ab
Signed-off-by: Yasufumi Ogawa <yasufum.o@gmail.com>
Co-Authored-By: Kyaw Myo Thant <kyawmyothant@ntt-at.co.jp>
This commit is contained in:
Yasufumi Ogawa 2024-06-17 23:00:01 +09:00 committed by Kyaw Myo Thant
parent ead054ecf5
commit be49a99321
18 changed files with 1710 additions and 19 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

12
doc/source/cli/cli-etsi-vnflcm.rst
View File

@ -1,9 +1,15 @@
========================
VNF Lifecycle Management
========================
=======================================
VNF Lifecycle Management with v1 Tacker
=======================================
This document describes how to manage VNF Lifecycle with CLI in Tacker.
.. note::
This is a document for Tacker v1 API.
See :doc:`/cli/v2/vnflcm` for Tacker v2 API.
Prerequisites
-------------

2
doc/source/cli/index.rst
View File

@ -23,7 +23,7 @@ Operations for ETSI NFV-SOL implementation
.. toctree::
cli-etsi-vnfpkgm
cli-etsi-vnflcm
vnflcm-index
cli-etsi-vnffm
cli-etsi-vnfpm

1677
doc/source/cli/v2/vnflcm.rst Normal file
View File

File diff suppressed because it is too large Load Diff

8
doc/source/cli/vnflcm-index.rst Normal file
View File

@ -0,0 +1,8 @@
========================
VNF Lifecycle Management
========================
.. toctree::
v2/vnflcm
cli-etsi-vnflcm

2
doc/source/configuration/enhanced_policy.rst
View File

@ -826,7 +826,7 @@ instantiate VNF. Below are two samples of <param-file>.
}
For VNF LCM API version 2, please refer to :doc:`/cli/cli-etsi-vnflcm` to
For VNF LCM API version 2, please refer to :doc:`/cli/v2/vnflcm` to
instantiate VNF. Below are two samples of <param-file>.
#. If the vim in the ``vimConnectionInfo`` parameter of <param-file> is an

2
doc/source/user/v2/cnf/chg_vnfpkg/index.rst
View File

@ -64,7 +64,7 @@ You need to upload the VNF package you want to change to before
executing change current VNF package.
Details of CLI commands are described in
:doc:`/cli/cli-etsi-vnflcm`.
:doc:`/cli/v2/vnflcm`.
For changing current VNF package, you need to prepare a JSON-formatted
definition file before running command for changing the VNF package.

2
doc/source/user/v2/cnf/heal/index.rst
View File

@ -48,7 +48,7 @@ CNF Healing Procedure
As mentioned in Prerequisites and Healing target VNF instance, the VNF must be
instantiated before healing.
Details of CLI commands are described in :doc:`/cli/cli-etsi-vnflcm`.
Details of CLI commands are described in :doc:`/cli/v2/vnflcm`.
There are two main methods for CNF healing.

2
doc/source/user/v2/cnf/scale/index.rst
View File

@ -59,7 +59,7 @@ as Kubernetes Deployment, StatefulSet, and ReplicaSet.
during the scale out operation.
Details of CLI commands are described in :doc:`/cli/cli-etsi-vnflcm`.
Details of CLI commands are described in :doc:`/cli/v2/vnflcm`.
There are two main methods for CNF scaling.

2
doc/source/user/v2/cnf/update.rst
View File

@ -26,7 +26,7 @@ As mentioned in Prerequisites, the CNF must be created
before performing update.
Details of CLI commands are described in
:doc:`/cli/cli-etsi-vnflcm`.
:doc:`/cli/v2/vnflcm`.
For update VNF instance, you need to prepare a JSON-formatted definition file.

2
doc/source/user/v2/cnf/update_with_mgmt_driver/index.rst
View File

@ -261,7 +261,7 @@ recreate the deployment, DaemonSet and ReplicaSet to update.
`samples/tests/functional/sol_kubernetes_v2/test_cnf_container_update_after`_
Details of CLI commands are described in :doc:`/cli/cli-etsi-vnflcm`.
Details of CLI commands are described in :doc:`/cli/v2/vnflcm`.
How to Update CNF

4
doc/source/user/v2/error_handling.rst
View File

@ -25,7 +25,7 @@ As mentioned in Prerequisites, the VNF must be created
before performing error-handling.
Details of CLI commands are described in
:doc:`/cli/cli-etsi-vnflcm`.
:doc:`/cli/v2/vnflcm`.
There are some operations to error-handling VNF.
@ -44,7 +44,7 @@ Identify VNF_LCM_OP_OCC_ID
The VNF_LCM_OP_OCC_ID can be obtained via CLI.
Details of CLI commands are described in
:doc:`/cli/cli-etsi-vnflcm`.
:doc:`/cli/v2/vnflcm`.
Before checking the "VNF_LCM_OP_OCC_ID", you should get VNF_INSTANCE_ID first.

2
doc/source/user/v2/vnf/chg_ext_conn.rst
View File

@ -28,7 +28,7 @@ Assuming that the following VNF instance exists,
this instance will be changed.
Details of CLI commands are described in
:doc:`/cli/cli-etsi-vnflcm`.
:doc:`/cli/v2/vnflcm`.
For changing external VNF connectivity, you need to prepare a JSON-formatted
definition file before running command for changing the connectivity.

2
doc/source/user/v2/vnf/chg_vnfpkg/index.rst
View File

@ -72,7 +72,7 @@ You need to upload the VNF package you want to change to before
executing change current vnf package.
Details of CLI commands are described in
:doc:`/cli/cli-etsi-vnflcm`.
:doc:`/cli/v2/vnflcm`.
For changing current VNF package, you need to prepare a JSON-formatted
definition file before running command for changing the VNF package.

2
doc/source/user/v2/vnf/chg_vnfpkg_with_standard/index.rst
View File

@ -102,7 +102,7 @@ You need to upload the VNF package you want to change to before
executing change current vnf package.
Details of CLI commands are described in
:doc:`/cli/cli-etsi-vnflcm`.
:doc:`/cli/v2/vnflcm`.
.. note::

2
doc/source/user/v2/vnf/deployment_with_user_data/index.rst
View File

@ -406,7 +406,7 @@ VNF Deployment Procedure as VM
In order to deploy VNF as a VM, it is necessary to execute
the following procedure.
Details of CLI commands are described in
:doc:`/cli/cli-etsi-vnfpkgm` and :doc:`/cli/cli-etsi-vnflcm`.
:doc:`/cli/cli-etsi-vnfpkgm` and :doc:`/cli/v2/vnflcm`.
1. Create VNF Package Info

2
doc/source/user/v2/vnf/heal/index.rst
View File

@ -80,7 +80,7 @@ VNF Healing Procedure
As mentioned in Prerequisites, the VNF must be instantiated before healing.
Details of CLI commands are described in
:doc:`/cli/cli-etsi-vnflcm`.
:doc:`/cli/v2/vnflcm`.
There are two main methods for VNF healing.

2
doc/source/user/v2/vnf/scale/index.rst
View File

@ -54,7 +54,7 @@ As mentioned in Prerequisites, the VNF must be instantiated
before performing scaling.
Details of CLI commands are described in
:doc:`/cli/cli-etsi-vnflcm`.
:doc:`/cli/v2/vnflcm`.
There are two main methods for VNF scaling.

2
doc/source/user/v2/vnf/update.rst
View File

@ -23,7 +23,7 @@ As mentioned in Prerequisites, the VNF must be created
before performing update.
Details of CLI commands are described in
:doc:`/cli/cli-etsi-vnflcm`.
:doc:`/cli/v2/vnflcm`.
For update VNF instance, you need to prepare a JSON-formatted definition file.