41 Commits

Author SHA1 Message Date
Zuul
54ea927f70 Merge "Fix invalid vim type for ETSI's definition" 2024-09-12 18:48:23 +00:00
Yasufumi Ogawa
72a96de392 Fix invalid vim type for ETSI's definition
Correct vimType in vimConnectionInfo or vim_type in vim_connection_info
to `ETSINFV.OPENSTACK_KEYSTONE.V_2` as defined in ETSI-NFV SOL specs.

Closes-bug: #2069800
Change-Id: Ida18790772250a087c03c6e898577747aad0bff4
Signed-off-by: Yasufumi Ogawa <yasufum.o@gmail.com>
Co-Authored-By: Yoshiro Watanabe <fj3838ct@fujitsu.com>
2024-09-09 09:04:48 +00:00
Yasufumi Ogawa
5d090296bb Fix issue that scale is not in the links of v1
Fix so that scale is in the links of v1 show vnflcm of instantiated vnf.

Closes-Bug: #2069589
Change-Id: I1a140460169d0a8c2d83ffcc406aed226e706fa9
Signed-off-by: Yasufumi Ogawa <yasufum.o@gmail.com>
Co-Authored-By: Takahiro Miyajima <fj6257jz@fujitsu.com>
2024-09-09 07:32:46 +00:00
Zuul
1c9171e897 Merge "Change line length of Help command's output" 2024-09-09 00:48:43 +00:00
Zuul
c4ff86a73b Merge "Update tacker-status CLI Reference document" 2024-09-06 19:11:08 +00:00
Kyaw Myo Thant
6e679e7b94 Change line length of Help command's output
This patch enhances readability of "HELP" codeblock of "VNF Package
Management", "VNF Lifecycle Management", "VIM Management" CLI documents.

Change-Id: If0d37b931cf0e5c304a17b947f377329f6d72009
2024-09-04 19:13:49 +09:00
Zuul
7ba267aaf7 Merge "Update VNF Performance Management CLI document" 2024-09-03 08:01:58 +00:00
Zuul
3445cdee6c Merge "Update VNF Fault Management CLI Reference document" 2024-09-03 07:56:12 +00:00
Kyaw Myo Thant
9f2b6a66c4 Update tacker-status CLI Reference document
This patch updates the output of each command and "History of Upgrade
checks" in tacker-status document.
There are also other some minor fixes about the sentence structures.

Change-Id: Ib137309b44e75fd1eeee9d7126c8247bbdceedc8
2024-09-02 14:45:35 +09:00
Kyaw Myo Thant
fd8f40d288 Update VNF Performance Management CLI document
This patch updates the output of each command in VNF Performance
Management CLI Reference document.
There are also other some minor fixes about the sentence structures.

Change-Id: Idb0cf7c9b6586039ea7e5ba4cb17d506f0636ae1
2024-09-02 14:32:47 +09:00
Kyaw Myo Thant
f93341b118 Update VNF Fault Management CLI Reference document
This patch updates the output of each command in VNF Fault Management
CLI Reference document.
There are also other some minor fixes about the sentence structures.

Change-Id: I086e453eb6f734a7e44bbf87c9043e96e0ba59dd
2024-09-02 14:15:58 +09:00
Zuul
d364653e4b Merge "Update VNFLCM with v1 Tacker CLI Reference document" 2024-08-30 05:24:43 +00:00
Yasufumi Ogawa
b06845e808 Update VNFLCM with v1 Tacker CLI Reference document
This patch separates the VNF Lifecycle Management CLI
reference document into version 1 tacker only.
And The output of each command is updated.
Op cancel cli reference is added.
There are also other some minor fixes about the sentence structures.

Depends-On: I6d677666387fa60672bcfcba01d703032c3d16ab
Change-Id: I0089a68e7b1f7a3bbe07754a0e7c1c6cba313880
Signed-off-by: Yasufumi Ogawa <yasufum.o@gmail.com>
Co-Authored-By: Kyaw Myo Thant <kyawmyothant@ntt-at.co.jp>
2024-08-28 15:52:05 +09:00
Zuul
359ccb61a8 Merge "Add VNFLCM with v2 Tacker CLI Reference document" 2024-08-27 07:34:51 +00:00
Zuul
176a3aca71 Merge "Update VIM Management CLI Reference document" 2024-08-27 06:44:06 +00:00
Yasufumi Ogawa
23589dbf04 Update VIM Management CLI Reference document
This patch updates the output of each command in VIM Management CLI
reference document. The process of retrieving the required data to
create the Kubernetes VIM configuration file is added. There are also
other some minor fixes about the sentence structures.

Change-Id: I8327493bd2bb543f26164cca4d6fdd2c50adeb30
Signed-off-by: Yasufumi Ogawa <yasufum.o@gmail.com>
Co-Authored-By: Kyaw Myo Thant <kyawmyothant@ntt-at.co.jp>
2024-08-26 18:43:05 +09:00
Yasufumi Ogawa
be49a99321 Add VNFLCM with v2 Tacker CLI Reference document
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>
2024-08-23 05:40:23 +00:00
Yasufumi Ogawa
5ffd1cf98d Update VNF Pkg Management CLI reference document
This patch updates the output of each command in VNF Package Management
CLI reference document.
There are also other some minor fixes about the sentence structures.

Change-Id: Ife21f6fbd80eb5ac92a5df45e6699fa46869690a
Signed-off-by: Yasufumi Ogawa <yasufum.o@gmail.com>
Co-Authored-By: Kyaw Myo Thant <kyawmyothant@ntt-at.co.jp>
2024-07-02 07:09:37 +00:00
Kaori Mitani
715fdf699f Fix output regarding PM Job/Threshold response
There are two corrections:

First, according to SOL003, "authentication" should not appear
in the PmJobModifications response.
Therefore, it has been removed from the output obtained
when running "openstack vnfpm job update".

Second, the data type of PmJob href, as defined in SOL003,
has been changed to match the format of the Uri and
Link href defined in SOL013. This adjustment ensures
that the endpoints will now be displayed correctly.

Closes-Bug: #2054420
Change-Id: Id79ed19090271de4e32742f37cf54b6853acba2e
2024-03-14 04:36:34 +00:00
Zuul
a21195575a Merge "Fixed alarmAcknowledgedTime not being updated" 2023-11-17 13:57:23 +00:00
YiFeng
8cb0b2ec2a Fixed alarmAcknowledgedTime not being updated
This patch modifies that when calling the update alarm API,
if ackState is updated to ACKNOWLEDGED, the value of
alarmAcknowledgedTime will be additionally updated.
If ackState is updated to UNACKNOWLEDGED, the value of
alarmAcknowledgedTime is deleted.

Closes-Bug: #2043062
Change-Id: I2b8a66f9d38c2104f8caf4aebc59573c2c05eef0
2023-11-16 16:06:14 +09:00
Ai Hamano
ccb8dadb55 Remove legacy documentation and tools
This patch removes documentation for the following legacy features.
- Extensions
- Virtualized Network Function Descriptors (VNFDs)
- Virtualized Network Functions (VNFs)
- Events
- VNF Forwarding Graph Descriptors (VNFFGDs)
- VNF Forwarding Graphs (VNFFGs)
- Network Forwarding Paths (NFPs)
- Service Function Chains (SFCs)
- Classifiers
- Network Service Descriptors (NSD)
- Network Services (NSs)

And also remove the following tools that are currently not in use.
- tools/vnfc/build_image.sh
- tools/check_i18n_test_case.txt
- tools/check_i18n.py
- tools/i18n_cfg.py
- tools/clean.sh
- tools/prepare_function_test.sh
- tools/test-setup.sh
- tools/install_venv_common.py
- tools/install_venv.py
- tools/with_venv.sh

For the following tools used in FT, move them under
`tacker/tests/functional/tools`.
- tools/test-setup-default-vim.sh
- tools/test-setup-k8s-vim.sh
- tools/test-setup-mgmt.sh
- tools/test-setup-fake-prometheus-server.sh

Implements: blueprint deprecate-legacy-apis
Change-Id: Iea89c32f69ccbe47badcfddcf77430abda98362b
2023-10-19 23:24:59 +00:00
Ai Hamano
0cea1780ee Update documents for change in change-vnfpkg
This patch updates Use Case Guide and API Documentation related to
Change Current VNF Package for Bobcat.
These updates include changes in the following patches.
* Fix missing modificationsTriggeredByVnfPkgChange [1]
* Add timeout setting to VNF LCM Coordination IF [2]

The main fixes in this patch are as follows.
* Add "vnflcm update" Use Case Guide for CNF
* Add how to update metadata/extensions/vnfConfigurableProperties
* Add note about extManagedVirtualLinks of ChangeCurrentVnfPkgRequest
* Add modificationTriggeredByVnfPkgChange to VnfLcmOpOcc
* Add timeout to additionalParams for ChangeCurrentVnfPkgRequest
* Add OAUTH2_CLIENT_CERT to authType
* Change vdu_params to required parameter

[1] https://review.opendev.org/c/openstack/tacker/+/880129
[2] https://review.opendev.org/c/openstack/tacker/+/887256

Closes-Bug: #2015941
Implements: blueprint add-sample-coordinate-script
Change-Id: I5a50ed88621ec7d2f82eb1f6d844d0ad5adae544
2023-09-08 14:04:50 +09:00
YiFeng
c004eb25d9 Add docs for auto scale via PM Threshold API
This patch makes the following updates to the API and CLI docs.

* Add support CNF auto scale via PM Threshold interface

Implements: blueprint support-auto-lcm
Change-Id: Ic699dd973f5a9fc14196d5f0c80e9f6ab2a9ab88
2023-03-03 10:56:07 +09:00
Zuul
f88b95e3e0 Merge "Update docs of User guide and API reference" 2023-02-28 05:07:00 +00:00
Yuta Kazato
bb16f78280 Update docs of User guide and API reference
This patch provides the following User guide and
API documentation updates (fixes) in Tacker Antelope.

User doc:
* Update current support v2 API
  operation status in the cli doc.
* Fix the settings of "vimConnectionInfo".
* Add vimType "ETSINFV.KUBERNETES.V_1"
  to the samples of "vimConnectionInfo".

API doc:
* Fix the misdescription of VNF LCM Interface v2.
* Fix the misdescription of VNF FM Interface v1.
* Fix the misdescription of VNF PM Interface v2.
* Fix the format of request parameters
  in Prometheus Plugin Interface
  and Fault Notification Interface.

Implements: blueprint enhance-change-package
Implements: blueprint support-auto-lcm
Co-Author: Taiki Kimura <taiki.kimura@ntt-at.co.jp>
Change-Id: I50c130d5de812efac631ed8ad1432a98a9d00e6c
2023-02-28 10:55:25 +09:00
Ayumu Ueha
e3e3fc5163 Deprecate Legacy APIs excluding VIM feature
This patch deprecates the Legacy APIs excluding VIM feature.

* Emit a warning log when a Deprecated API is executed.
* Add warning block to api-refs and docs related with deprecated
  Legacy feature.

Implements: blueprint deprecate-legacy-apis
Change-Id: Ie378d1000089401e3a0854b209654182da09e272
2023-01-27 13:09:44 +00:00
Koji Shimizu
85b57883c1 Add docs for cnf auto heal and scale
This patch makes the following updates to the API and CLI docs.

* Add support cnf auto heal and scale

Implements: blueprint support-auto-lcm
Change-Id: I776637f1361aa5861d42fb98e71ebabd3825ca4c
2022-09-16 16:37:22 +09:00
Hiroo Kitamura
c995228d7d Update API doc and CLI doc
This patch makes the following updates to the API and CLI docs.

API doc:
* Fix "vnfState" which is Response Parameters of List/Show VNF instance
  is incorrectly set to option
* Add "maxScaleLevels" and "scaleStatus" which are Response Parameters
  of List/Show VNF instance

CLI doc:
* Add subscription commands such as Create, Delete, List and Show
* Fix typo about "Change External VNF Connectivity"
* Minor fixes such as indentation correction and typo correction

Co-Author: Ai Hamano <ai.hamano@ntt-at.co.jp>
Change-Id: I4c643c542deed6b459da4f53bfe4ce90eca96d74
2022-08-30 14:36:28 +09:00
Yi Feng
f7e241eca2 Add doc of Change Current VNF Package
This patch provides Tacker documents for change current vnf package
in V2-API. The specification about new API is added to API Reference.
Also, change current vnf package operation is added to
Tacker Use Cases Guide and CLI Reference.

This patch also adds change current vnf package restrictions to
error_handling user guide.

Implements: blueprint upgrade-vnf-package
Change-Id: I3f18bbab17c67e717dc0a9d36e92f812a40862e5
2022-06-07 10:01:29 +09:00
Renu
dbbe083448 “change_ext_conn” wrongly mentioned in document
The name of “change_ext_conn” is wrongly mentioned
in document.
It correct values as per the operation run flow
is “change-ext-conn”

Closes-Bug: 1967049
Change-Id: If7a8f46777d24cd0648fd4fbe734568c44ec1eff
2022-04-18 08:43:46 +00:00
Tetsuro Kaneko
cabb474908 Add documents for enhance operations in V2
This patch provides Tacker documents for enhance operations(heal,
scale, update, changeextconn) in V2-API. The specification about new
API is added to API Reference. Also, update operation is added to
Tacker Use Cases Guide and CLI Reference.

This patch also includes changes to the user data script.

Implements: blueprint support-nfv-solv3-change-external-connectivity
Implements: blueprint support-nfv-solv3-heal-vnf
Implements: blueprint support-nfv-solv3-modify-vnf
Implements: blueprint support-nfv-solv3-scale-vnf
Change-Id: I6adefc59903a4c8305a66c224c086af4b86812df
2022-03-11 15:31:15 +09:00
Pooja Singla
7d659b1870 Help usage message of heal cli modified
Updated cli doc for help cli usage message.

Closes-Bug: #1954744
Change-Id: Ifce4d8ceb40e9d00eb1b8715b26aac8a5546bd9b
2022-02-21 17:44:32 +05:30
Shun Higuchi
a69f2f3fb5 Add documents for error handling operations in V2
This patch provides Tacker documents for error handling operations
(retry, fail, rollback) in V2-API. The specification about new API is
added to API Reference. Also, these descriptions are added to an error
handling page of Tacker Use Cases Guide.

This patch includes some improvements of these documents. For example,
modifying spelling inconsistencies, unifying uppercase and lowercase
letters and so on.

This patch does not include documents for other operations
(Modify, Scale, Heal, Changeextconn) in V2-API. Those documents
will be provided with another patch by the release of Yoga.

Implements: blueprint support-nfv-solv3-error-handling
Change-Id: Id045469db965b0e0ef12e271d9259002ef7e60af
2022-01-18 04:28:32 +00:00
Hirofumi Noguchi
f24afcf705 Add documents for multi-version API support
This patch provides Tacker documents for multi-version API support.
VNF LCM API Version 2 is added to API Reference and the page hierarchy
is changed for readability.
Also, the Show VNF LCM Versions command is added to Command-Line
Interface Reference.
Furthermore, a manual of the Userdata script is added to Tacker User
Guide.

Implements: blueprint multi-version-api
Implements: blueprint support-nfv-solv3-start-and-terminate-vnf
Implements: blueprint support-nfv-solv3-query-vnf-instances
Implements: blueprint support-nfv-solv3-query-operation-occurrences
Implements: blueprint support-nfv-solv3-subscriptions
Change-Id: I603e32090303af080b17e549a0caf7e862aa7e1e
2021-09-16 20:00:56 +09:00
Yasufumi Ogawa
ddf28104a3 Update version of cirros image to 0.5.2
We've been using old cirros-0.4.0 for long time, and don't need to fix
the version of cirros to 0.4.0. This patch is update to the latest
0.5.2.

Most of the changes in this patch is replacing `image`, `hash` and
`version` in TOSCA definition files. The rest of them are:

* Replace images. First one is only an actual image, and rest of them
  are empty text files which is a trick for reducing total size in
  tacker repo. So, text files are not replaced, but renamed simply.
  * tacker/tests/etc/samples/etsi/nfv/common/Files/images/cirros-0.5.2-x86_64-disk.img
  * samples/vnf_packages/Files/images/cirros-0.5.2-x86_64-disk.img
  * tacker/tests/etc/samples/etsi/nfv/test_csar_utils_data/sample_vnfpkg_no_meta_single_vnfd/Files/images/cirros-0.5.2-x86_64-disk.img
  * tacker/tests/etc/samples/sample_vnf_package_csar_in_meta_and_manifest/Files/images/cirros-0.5.2-x86_64-disk.img

* Update functional tests verifying images. A refactor of defining
  package size is included.

* Update devstack script, and helper scripts under `contrib` dir.

* Update API references and documents describing usage of the image.

Signed-off-by: Yasufumi Ogawa <yasufum.o@gmail.com>

Implements: blueprint update-cirros-052
Change-Id: I081b791dc986ab10f4845784b3e19dbb626e3cac
2021-08-30 21:31:12 +09:00
Koichi Edagawa
02d98aa292 Add doc of CLIs developed in Wallaby
CLI commands developed in Wallaby are added in CLI doc.

This patch adds the following CLI commands:
* Retry
* Fail
* Change External VNF Connectivity
* List LCM Operation Occurrences
* Show LCM Operation Occurrence

Change-Id: If374a9cdce2e30b5f9883e21b1f7ffe500982551
2021-03-25 12:03:20 +00:00
Hiroo Kitamura
3a5e600764 Add doc of CLIs developed in Victoria and minor fixes
CLI commands developed in Victoria
are added in CLI doc.

This patch adds the following CLI commands:
* Heal VNF
* Scale VNF
* Rollback VNF lifecycle management operation

In addition, this patch makes the following minor fixes:
* Fix the item numbers
* Use capital letters with underscores for parameters

For the second point, I referred to the following reference.
https://docs.openstack.org/doc-contrib-guide/writing-style/code-conventions.html

Change-Id: I5383d0cf54793dfba1c496ca738acdea3c28864e
2021-02-05 13:37:59 +09:00
LiangLu
531803dbd8 Add docs of Instantiate CNF and Artifacts
Usage guides for how to deploy ETSI NFV-SOL containerized VNF
is added in user docs. Command-Line Help for Fetch VNF Package
Artifacts is added in cli docs.

Change-Id: I2543fa0610bc421341ba46d166cf510e34e7971a
2020-11-11 14:00:30 +09:00
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
akhiljain23
fb06b7c96c Add framework for tacker-status upgrade check
This commit adds the functionality of tacker-status CLI for performing
upgrade checks as part of the Stein cycle upgrade-checkers goal.
It only includes a sample check which must be replaced by real checks in
future.

Change-Id: I7bb127fa10dd168ab24dd8c42013576f84eadfbb
Story: 2003657
Task: 26158
2018-10-26 09:07:04 +00:00