Commit Graph

28 Commits

Author SHA1 Message Date
Ai Hamano aa2836c072 Remove legacy documentation
This patch removes documentation for the following legacy commands.
- VNF Descriptor (VNFD) Management commands
- VNF Management commands
- Event Management commands
- VNF Forwarding Graph Descriptor (VNFFGD) Management commands
- VNF Forwarding Graph (VNFFG) Management commands
- Network Forwarding Path Management commands
- Service Function Chain (SFC) Management commands
- Flow Classifier Management commands
- Network Service Descriptor Management commands
- Network Service Management commands

Implements: blueprint deprecate-legacy-apis
Change-Id: I6aa68cd1fa14a838c3058343a7a1603790c9358b
2023-11-01 10:45:04 +09:00
Zuul 0f9b6f5c52 Merge "Add support cnf auto scale via threshold interface" 2023-02-16 10:32:17 +00:00
Yi Feng 8b45c8082b Add support cnf auto scale via threshold interface
Add the Performance Management Threshold CLI to support AutoScale.
The Performance Management Threshold API is based on ETSI NFV-SOL
002 v3.3.1 and ETSI NFV-SOL 003 v3.3.1, which is Version "2.0.0"
API of Tacker.

Implements: blueprint support-auto-lcm
Change-Id: Idd313d6abe47dfa41fc86ddc614d00f99f3fc3b2
2023-02-16 10:36:47 +09:00
Ayumu Ueha 156deea66c Add deprecation notice for Legacy APIs
This patch deprecates CLI for Legacy APIs excluding VIM feature.

Implements: blueprint deprecate-legacy-apis
Change-Id: Ib74db43b4a3de4676e61f4f9ce6d3d2095a11ddf
2023-01-27 00:38:21 +00:00
Koji Shimizu 80ee721263 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: Ide4d8c8652cdf8ac611e65376a21806488667ace
2022-09-08 19:49:24 +09:00
Hirofumi Noguchi 075a327f63 Update Python-TackerClient Documentation
Current Python-TackerClient Documentation does not reflect
the latest implementation.
This patch adds the vnflcm commands to the CLI usage,
revises the contributor guide, and makes some minor modifications.

Implements: blueprint update-tackerclient-documentation
Change-Id: Iacd871c52baa0e20c254b7c75d588b52c6086851
2022-08-30 21:15:56 +09:00
Manpreet Kaur e8280f5780 Remove broken link from Python-TackerClient guide
In Python-TackerClient guide, under "Indices and tables" section,
"Module Index" refer to a broken link [1].

The documentation build does not generate module index, thus
we can remove the link [1] from page.

[1] https://docs.openstack.org/python-tackerclient/latest/py-modindex.html

Closes-Bug: #1934581
Change-Id: I881cb5faaefab3bffb9b7253dcd65e69581488bf
2021-07-04 11:34:38 +05:30
zhangboye 68df82918a Dropping explicit unicode literal
In python 3, all strings are considered as unicode string.

This patch drops the explicit unicode literal (u'...')
or (u"..") appearances from the unicode strings.

Note: The scope of the patch is to drop unicode literal prefix
from python source code files, documentation and comment are overlook.

Co-Authored-By: Manpreet Kaur kaurmanpreet2620@gmail.com
Change-Id: I5316037871109838a03ff4561b7b38dcc56bc447
2021-02-26 10:41:44 +05:30
Manpreet Kaur 17f4bcac1a Fix old links in installation guide
The installation guide refers to old github links in order to
install python-tackerclient.

This patch replaces old links [1] with new source code links [2].
Additionally, restructure document content for readability.

[1] https://github.com/openstack/python-tackerclient
[2] https://opendev.org/openstack/python-tackerclient

Closes-Bug: #1914534
Change-Id: I4876a9a2f61d5539b724a888ee2d941a989be717
2021-02-08 17:12:32 +05:30
Andreas Jaeger c7b5925451 Switch to newer openstackdocstheme and reno versions
Switch to openstackdocstheme 2.2.1 and reno 3.1.0 versions. Using
these versions will allow especially:
* Linking from HTML to PDF document
* Allow parallel building of documents
* Fix some rendering problems

Update Sphinx version as well.

openstackdocstheme renames some variables, so follow the renames
before the next release removes them. A couple of variables are also
not needed anymore, remove them.

Change pygments_style to 'native' since old theme version always used
'native' and the theme now respects the setting and using 'sphinx' can
lead to some strange rendering.

See also
http://lists.openstack.org/pipermail/openstack-discuss/2020-May/014971.html

Change-Id: Iafe611a36e17869bf17f5b2c016ef7c22fb36eb3
2020-05-22 17:18:51 +00:00
Andreas Jaeger 30ec46337b Cleanup py27 support
Make a few cleanups:
- Remove python 2.7 stanza from setup.py
- Add requires on python >= 3.6 to setup.cfg so that pypi and pip
  know about the requirement
- Remove obsolete sections from setup.cfg:
  * Wheel is not needed for python 3 only repo
  * Some other sections are obsolete
- Update classifiers
- Update requirements, no need for python_version anymore

Change-Id: Id4de4bb72bd40cdcd9eef53fe9ea9dba855c0a5a
2020-04-04 17:15:39 +02:00
Zuul 334c8e8994 Merge "Blacklist sphinx 2.1.0 (autodoc bug)" 2019-09-20 17:04:23 +00:00
Shubham Potale edb7dad611 Add documentation for VNF Package commands
Added reference documentation for below vnf package commands.
1)vnf package create
2)vnf package list
3)vnf package show
4)vnf package upload
5)vnf package delete

Change-Id: Iad2536e81a6f419e25a4b6fd98b7b74ef0d965cd
Implements: bp tosca-csar-mgmt-driver
2019-09-13 10:34:41 +00:00
pengyuesheng d9f7ea1a5f Blacklist sphinx 2.1.0 (autodoc bug)
See https://github.com/sphinx-doc/sphinx/issues/6440 for upstream details

Change-Id: I75c4e678992dbded8653a00b6a7b38730d0b13c8
2019-08-02 11:13:54 +08:00
jacky06 47996394b3 Replace git.openstack.org URLs with opendev.org URLs
1. Replace git.openstack.org URLs with opendev.org URLs
2. Update some urls

Change-Id: Icf9a7857be01056c0967fed0c777f2f46a993b6c
2019-06-19 15:48:59 +08:00
dharmendra 08b8922c49 update sphinx requirement
syncs sphinx dependency with global requirements.
It caps python 2 since sphinx 2.0 no longer supports Python 2.7.

Change-Id: Ic909ffca550329c8ba23e4ffe9f18f601d674a3b
2019-05-16 07:25:42 +00:00
Nguyen Hai 71e0b047c8 Remove tacker command guide in docs
Tacker command is deprecated after Rocky release.

Change-Id: Ia71041edb4a3971483200fa3091fc58ea4dd0190
2018-09-04 21:39:52 +09:00
Nguyen Hai 9ff673557e Update homepage link in setup.cfg
This patch also adds a note about deprecation of 'tacker' command line.

This patch also remove redundant section in setup.cfg related to
building docs.
See: http://lists.openstack.org/pipermail/openstack-dev/2018-March/128594.html

Change-Id: Ic8206eeef5c2cdb75834011eede48fa8b998481a
2018-06-19 17:57:14 +09:00
ShangXiao 42dcd919b7 Fix the old doc links
Fix the old doc links in CONTRIBUTING.rst
and doc/source/index.rst.

Change-Id: I272742d6c344ea9eb6cb8ab18521049cc7e4a9da
2018-03-26 00:44:22 -07:00
OpenStack Proposal Bot 99abf33642 Updated from global requirements
Change-Id: I5b03636632009c55b8d2f6047c4d29a5b20d10f1
2018-03-15 08:05:06 +00:00
OpenStack Proposal Bot d5a8170a35 Updated from global requirements
Change-Id: Ia2503828f106a44e80706beeaa32e39356d385fb
2018-03-13 07:29:43 +00:00
Nguyen Hai e3b3d7e50c Add documentation for python-tackerclient
This patch also fix "InterpreterNotFound: pypy" error in tox.ini

This patch also follow the new PTI for document build [1][2]

[1] https://governance.openstack.org/tc/reference/project-testing-interface.html
[2] http://lists.openstack.org/pipermail/openstack-dev/2017-December/125710.html

Change-Id: I9fb6637cb95603532b46f89dc4beab185278c833
Closes-bug: #1754556
Closes-bug: #1754926
2018-03-13 12:13:51 +09:00
yong sheng gong 09bf59d764 Add doc migration framework
Change-Id: Ia175bbe7d83fdc356aa5ecf474d30ba640ab7da4
Partial-Bug: 1706161
2017-12-21 13:42:00 +08:00
dharmendra 95ddcbe966 Switch from oslosphinx to openstackdocstheme
As part of the docs migration work[0] for Pike we
need to switch to use the openstackdocstheme.

[0]https://review.openstack.org/#/c/472275/

Change-Id: Ia48ca6860012850071f8c236d404d56a480b747c
2017-07-07 01:04:42 +00:00
Anusree b5a394112b Removes unused utf-8 encoding declaration
Following files contain #-*- coding: utf-8 -*- declaration
but don't contain any unicode character

doc/source/conf.py

Change-Id: I021ad39ca71a86c88f8e2591485bcde416d3028f
2017-01-20 05:10:55 +05:30
xu-haiwei 67c034b8a1 Change bind_port to 9890
Since the bind_port of tacker server is changed to 9890, fix the
document and test case to meet this change.

Change-Id: I5baff302517c8bd8b7cc14b10e771beb9079762b
2016-06-10 17:02:53 +09:00
Martin Oemke 80220f372b Clean up references to neutron
Remove references to neutron project in tackerclient
doc and conf files.

Change-Id: I66a7479a5c12c49f82af0cbff197d6b9976a87c6
Closes-Bug: #1553715
2016-03-09 09:24:58 +00:00
Isaku Yamahata 872ab5e336 import python-neutronclient of 1bce6e437e2dd1fa5de6fc2ccdd0ee8ac3f44d18
Imports python-neutornclient whose changeset is as follows

> commit 1bce6e437e2dd1fa5de6fc2ccdd0ee8ac3f44d18
> Merge: 9c77675 cbdd56d
> Author: Jenkins <jenkins@review.openstack.org>
> Date:   Sat Jun 14 04:46:39 2014 +0000
>
>     Merge "Add OverQuotaClient as exception to neutronclient"

Change-Id: I596915c60d349eb5afbc3de245f580f2dd37e270
2014-07-04 19:10:19 +09:00