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
This commit is contained in:
parent
bfc0c8fdeb
commit
075a327f63
|
@ -11,14 +11,6 @@
|
||||||
License for the specific language governing permissions and limitations
|
License for the specific language governing permissions and limitations
|
||||||
under the License.
|
under the License.
|
||||||
|
|
||||||
Convention for heading levels in Neutron devref:
|
|
||||||
======= Heading 0 (reserved for the title in a document)
|
|
||||||
------- Heading 1
|
|
||||||
~~~~~~~ Heading 2
|
|
||||||
+++++++ Heading 3
|
|
||||||
''''''' Heading 4
|
|
||||||
(Avoid deeper levels because they do not render well.)
|
|
||||||
|
|
||||||
=============
|
=============
|
||||||
Command List
|
Command List
|
||||||
=============
|
=============
|
||||||
|
@ -76,10 +68,32 @@ of individual command can be referred by **openstack help <command-name>**.
|
||||||
openstack nfv event show Show event given the event id.
|
openstack nfv event show Show event given the event id.
|
||||||
openstack nfv event list List events of resources.
|
openstack nfv event list List events of resources.
|
||||||
openstack vnf package create Create a new individual VNF package resource.
|
openstack vnf package create Create a new individual VNF package resource.
|
||||||
|
openstack vnf package delete Delete given VNF package(s).
|
||||||
openstack vnf package list List all VNF packages.
|
openstack vnf package list List all VNF packages.
|
||||||
openstack vnf package show Show package details.
|
openstack vnf package show Show package details.
|
||||||
openstack vnf package upload Upload a VNF package by providing the address information
|
openstack vnf package upload Upload a VNF package.
|
||||||
of the VNF package.
|
openstack vnf package download Download a VNF package.
|
||||||
openstack vnf package delete Delete given VNF package(s).
|
openstack vnf package artifact download Download a VNF package artifact.
|
||||||
|
openstack vnf package update Update a state of a VNF package.
|
||||||
|
openstack vnflcm create Create a new VNF instance resource.
|
||||||
|
openstack vnflcm instantiate Instantiate a VNF instance.
|
||||||
|
openstack vnflcm list List VNF instance.
|
||||||
|
openstack vnflcm show Show VNF instance.
|
||||||
|
openstack vnflcm terminate Terminate a VNF instance.
|
||||||
|
openstack vnflcm delete Delete a VNF instance resource.
|
||||||
|
openstack vnflcm heal Heal a VNF instance.
|
||||||
|
openstack vnflcm update Update information of a VNF instance.
|
||||||
|
openstack vnflcm scale Scale a VNF instance.
|
||||||
|
openstack vnflcm change-ext-conn Change external VNF connectivity.
|
||||||
|
openstack vnflcm change-vnfpkg Change current VNF package.
|
||||||
|
openstack vnflcm op rollback Rollback a VNF LCM operation occurrence.
|
||||||
|
openstack vnflcm op retry Retry a VNF LCM operation occurrence.
|
||||||
|
openstack vnflcm op fail Fail a VNF LCM operation occurrence.
|
||||||
|
openstack vnflcm op list List VNF LCM operation occurrence.
|
||||||
|
openstack vnflcm op show Show VNF LCM operation occurrence.
|
||||||
|
openstack vnflcm op cancel Cancel a VNF LCM operation occurrence.
|
||||||
|
openstack vnflcm versions Show VNF LCM API versions.
|
||||||
|
openstack vnflcm subsc create Create new subscription.
|
||||||
|
openstack vnflcm subsc delete Delete subscription.
|
||||||
|
openstack vnflcm subsc list List subscription.
|
||||||
|
openstack vnflcm subsc show Show subscription.
|
||||||
|
|
|
@ -1,9 +1,48 @@
|
||||||
============
|
..
|
||||||
|
Licensed under the Apache License, Version 2.0 (the "License"); you may
|
||||||
|
not use this file except in compliance with the License. You may obtain
|
||||||
|
a copy of the License at
|
||||||
|
|
||||||
|
http://www.apache.org/licenses/LICENSE-2.0
|
||||||
|
|
||||||
|
Unless required by applicable law or agreed to in writing, software
|
||||||
|
distributed under the License is distributed on an "AS IS" BASIS, WITHOUT
|
||||||
|
WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the
|
||||||
|
License for the specific language governing permissions and limitations
|
||||||
|
under the License.
|
||||||
|
|
||||||
|
=========
|
||||||
CLI Usage
|
CLI Usage
|
||||||
============
|
=========
|
||||||
|
|
||||||
|
Command List
|
||||||
|
------------
|
||||||
|
|
||||||
.. toctree::
|
.. toctree::
|
||||||
:glob:
|
|
||||||
:maxdepth: 3
|
|
||||||
|
|
||||||
*
|
commands
|
||||||
|
|
||||||
|
Operations for ETSI NFV-SOL implementation
|
||||||
|
------------------------------------------
|
||||||
|
|
||||||
|
.. toctree::
|
||||||
|
|
||||||
|
vnf_package_commands
|
||||||
|
vnflcm_commands
|
||||||
|
|
||||||
|
Operations for Legacy implementation
|
||||||
|
------------------------------------
|
||||||
|
|
||||||
|
.. toctree::
|
||||||
|
|
||||||
|
vnf_commands
|
||||||
|
vnf_descriptor_commands
|
||||||
|
vim_commands
|
||||||
|
ns_commands
|
||||||
|
ns_descriptor_commands
|
||||||
|
vnf_graph_commands
|
||||||
|
vnf_graph_descriptor_commands
|
||||||
|
vnf_chain_commands
|
||||||
|
vnf_classifier_commands
|
||||||
|
vnf_network_forwarding_path_commands
|
||||||
|
nfv_event_commands
|
||||||
|
|
|
@ -0,0 +1,19 @@
|
||||||
|
..
|
||||||
|
Licensed under the Apache License, Version 2.0 (the "License"); you may
|
||||||
|
not use this file except in compliance with the License. You may obtain
|
||||||
|
a copy of the License at
|
||||||
|
|
||||||
|
http://www.apache.org/licenses/LICENSE-2.0
|
||||||
|
|
||||||
|
Unless required by applicable law or agreed to in writing, software
|
||||||
|
distributed under the License is distributed on an "AS IS" BASIS, WITHOUT
|
||||||
|
WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the
|
||||||
|
License for the specific language governing permissions and limitations
|
||||||
|
under the License.
|
||||||
|
|
||||||
|
=========================
|
||||||
|
Event Management commands
|
||||||
|
=========================
|
||||||
|
|
||||||
|
.. autoprogram-cliff:: openstack.tackerclient.v1
|
||||||
|
:command: nfv event *
|
|
@ -0,0 +1,19 @@
|
||||||
|
..
|
||||||
|
Licensed under the Apache License, Version 2.0 (the "License"); you may
|
||||||
|
not use this file except in compliance with the License. You may obtain
|
||||||
|
a copy of the License at
|
||||||
|
|
||||||
|
http://www.apache.org/licenses/LICENSE-2.0
|
||||||
|
|
||||||
|
Unless required by applicable law or agreed to in writing, software
|
||||||
|
distributed under the License is distributed on an "AS IS" BASIS, WITHOUT
|
||||||
|
WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the
|
||||||
|
License for the specific language governing permissions and limitations
|
||||||
|
under the License.
|
||||||
|
|
||||||
|
==============================================
|
||||||
|
Network Service Descriptor Management commands
|
||||||
|
==============================================
|
||||||
|
|
||||||
|
.. autoprogram-cliff:: openstack.tackerclient.v1
|
||||||
|
:command: ns *
|
|
@ -0,0 +1,19 @@
|
||||||
|
..
|
||||||
|
Licensed under the Apache License, Version 2.0 (the "License"); you may
|
||||||
|
not use this file except in compliance with the License. You may obtain
|
||||||
|
a copy of the License at
|
||||||
|
|
||||||
|
http://www.apache.org/licenses/LICENSE-2.0
|
||||||
|
|
||||||
|
Unless required by applicable law or agreed to in writing, software
|
||||||
|
distributed under the License is distributed on an "AS IS" BASIS, WITHOUT
|
||||||
|
WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the
|
||||||
|
License for the specific language governing permissions and limitations
|
||||||
|
under the License.
|
||||||
|
|
||||||
|
==============================================
|
||||||
|
Network Service Descriptor Management commands
|
||||||
|
==============================================
|
||||||
|
|
||||||
|
.. autoprogram-cliff:: openstack.tackerclient.v1
|
||||||
|
:command: ns descriptor *
|
|
@ -0,0 +1,19 @@
|
||||||
|
..
|
||||||
|
Licensed under the Apache License, Version 2.0 (the "License"); you may
|
||||||
|
not use this file except in compliance with the License. You may obtain
|
||||||
|
a copy of the License at
|
||||||
|
|
||||||
|
http://www.apache.org/licenses/LICENSE-2.0
|
||||||
|
|
||||||
|
Unless required by applicable law or agreed to in writing, software
|
||||||
|
distributed under the License is distributed on an "AS IS" BASIS, WITHOUT
|
||||||
|
WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the
|
||||||
|
License for the specific language governing permissions and limitations
|
||||||
|
under the License.
|
||||||
|
|
||||||
|
=======================
|
||||||
|
VIM Management commands
|
||||||
|
=======================
|
||||||
|
|
||||||
|
.. autoprogram-cliff:: openstack.tackerclient.v1
|
||||||
|
:command: vim *
|
|
@ -0,0 +1,19 @@
|
||||||
|
..
|
||||||
|
Licensed under the Apache License, Version 2.0 (the "License"); you may
|
||||||
|
not use this file except in compliance with the License. You may obtain
|
||||||
|
a copy of the License at
|
||||||
|
|
||||||
|
http://www.apache.org/licenses/LICENSE-2.0
|
||||||
|
|
||||||
|
Unless required by applicable law or agreed to in writing, software
|
||||||
|
distributed under the License is distributed on an "AS IS" BASIS, WITHOUT
|
||||||
|
WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the
|
||||||
|
License for the specific language governing permissions and limitations
|
||||||
|
under the License.
|
||||||
|
|
||||||
|
================================================
|
||||||
|
Service Function Chain (SFC) Management commands
|
||||||
|
================================================
|
||||||
|
|
||||||
|
.. autoprogram-cliff:: openstack.tackerclient.v1
|
||||||
|
:command: vnf chain *
|
|
@ -0,0 +1,19 @@
|
||||||
|
..
|
||||||
|
Licensed under the Apache License, Version 2.0 (the "License"); you may
|
||||||
|
not use this file except in compliance with the License. You may obtain
|
||||||
|
a copy of the License at
|
||||||
|
|
||||||
|
http://www.apache.org/licenses/LICENSE-2.0
|
||||||
|
|
||||||
|
Unless required by applicable law or agreed to in writing, software
|
||||||
|
distributed under the License is distributed on an "AS IS" BASIS, WITHOUT
|
||||||
|
WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the
|
||||||
|
License for the specific language governing permissions and limitations
|
||||||
|
under the License.
|
||||||
|
|
||||||
|
===================================
|
||||||
|
Flow Classifier Management commands
|
||||||
|
===================================
|
||||||
|
|
||||||
|
.. autoprogram-cliff:: openstack.tackerclient.v1
|
||||||
|
:command: vnf classifier *
|
|
@ -0,0 +1,19 @@
|
||||||
|
..
|
||||||
|
Licensed under the Apache License, Version 2.0 (the "License"); you may
|
||||||
|
not use this file except in compliance with the License. You may obtain
|
||||||
|
a copy of the License at
|
||||||
|
|
||||||
|
http://www.apache.org/licenses/LICENSE-2.0
|
||||||
|
|
||||||
|
Unless required by applicable law or agreed to in writing, software
|
||||||
|
distributed under the License is distributed on an "AS IS" BASIS, WITHOUT
|
||||||
|
WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the
|
||||||
|
License for the specific language governing permissions and limitations
|
||||||
|
under the License.
|
||||||
|
|
||||||
|
=======================
|
||||||
|
VNF Management commands
|
||||||
|
=======================
|
||||||
|
|
||||||
|
.. autoprogram-cliff:: openstack.tackerclient.v1
|
||||||
|
:command: vnf *
|
|
@ -0,0 +1,19 @@
|
||||||
|
..
|
||||||
|
Licensed under the Apache License, Version 2.0 (the "License"); you may
|
||||||
|
not use this file except in compliance with the License. You may obtain
|
||||||
|
a copy of the License at
|
||||||
|
|
||||||
|
http://www.apache.org/licenses/LICENSE-2.0
|
||||||
|
|
||||||
|
Unless required by applicable law or agreed to in writing, software
|
||||||
|
distributed under the License is distributed on an "AS IS" BASIS, WITHOUT
|
||||||
|
WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the
|
||||||
|
License for the specific language governing permissions and limitations
|
||||||
|
under the License.
|
||||||
|
|
||||||
|
=========================================
|
||||||
|
VNF Descriptor (VNFD) Management commands
|
||||||
|
=========================================
|
||||||
|
|
||||||
|
.. autoprogram-cliff:: openstack.tackerclient.v1
|
||||||
|
:command: vnf descriptor *
|
|
@ -0,0 +1,19 @@
|
||||||
|
..
|
||||||
|
Licensed under the Apache License, Version 2.0 (the "License"); you may
|
||||||
|
not use this file except in compliance with the License. You may obtain
|
||||||
|
a copy of the License at
|
||||||
|
|
||||||
|
http://www.apache.org/licenses/LICENSE-2.0
|
||||||
|
|
||||||
|
Unless required by applicable law or agreed to in writing, software
|
||||||
|
distributed under the License is distributed on an "AS IS" BASIS, WITHOUT
|
||||||
|
WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the
|
||||||
|
License for the specific language governing permissions and limitations
|
||||||
|
under the License.
|
||||||
|
|
||||||
|
================================================
|
||||||
|
VNF Forwarding Graph (VNFFG) Management commands
|
||||||
|
================================================
|
||||||
|
|
||||||
|
.. autoprogram-cliff:: openstack.tackerclient.v1
|
||||||
|
:command: vnf graph *
|
|
@ -0,0 +1,19 @@
|
||||||
|
..
|
||||||
|
Licensed under the Apache License, Version 2.0 (the "License"); you may
|
||||||
|
not use this file except in compliance with the License. You may obtain
|
||||||
|
a copy of the License at
|
||||||
|
|
||||||
|
http://www.apache.org/licenses/LICENSE-2.0
|
||||||
|
|
||||||
|
Unless required by applicable law or agreed to in writing, software
|
||||||
|
distributed under the License is distributed on an "AS IS" BASIS, WITHOUT
|
||||||
|
WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the
|
||||||
|
License for the specific language governing permissions and limitations
|
||||||
|
under the License.
|
||||||
|
|
||||||
|
============================================================
|
||||||
|
VNF Forwarding Graph Descriptor (VNFFGD) Management commands
|
||||||
|
============================================================
|
||||||
|
|
||||||
|
.. autoprogram-cliff:: openstack.tackerclient.v1
|
||||||
|
:command: vnf graph descriptor *
|
|
@ -0,0 +1,19 @@
|
||||||
|
..
|
||||||
|
Licensed under the Apache License, Version 2.0 (the "License"); you may
|
||||||
|
not use this file except in compliance with the License. You may obtain
|
||||||
|
a copy of the License at
|
||||||
|
|
||||||
|
http://www.apache.org/licenses/LICENSE-2.0
|
||||||
|
|
||||||
|
Unless required by applicable law or agreed to in writing, software
|
||||||
|
distributed under the License is distributed on an "AS IS" BASIS, WITHOUT
|
||||||
|
WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the
|
||||||
|
License for the specific language governing permissions and limitations
|
||||||
|
under the License.
|
||||||
|
|
||||||
|
===========================================
|
||||||
|
Network Forwarding Path Management commands
|
||||||
|
===========================================
|
||||||
|
|
||||||
|
.. autoprogram-cliff:: openstack.tackerclient.v1
|
||||||
|
:command: vnf network forwarding path *
|
|
@ -1,3 +1,16 @@
|
||||||
|
..
|
||||||
|
Licensed under the Apache License, Version 2.0 (the "License"); you may
|
||||||
|
not use this file except in compliance with the License. You may obtain
|
||||||
|
a copy of the License at
|
||||||
|
|
||||||
|
http://www.apache.org/licenses/LICENSE-2.0
|
||||||
|
|
||||||
|
Unless required by applicable law or agreed to in writing, software
|
||||||
|
distributed under the License is distributed on an "AS IS" BASIS, WITHOUT
|
||||||
|
WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the
|
||||||
|
License for the specific language governing permissions and limitations
|
||||||
|
under the License.
|
||||||
|
|
||||||
====================
|
====================
|
||||||
VNF Package commands
|
VNF Package commands
|
||||||
====================
|
====================
|
||||||
|
|
|
@ -0,0 +1,34 @@
|
||||||
|
..
|
||||||
|
Licensed under the Apache License, Version 2.0 (the "License"); you may
|
||||||
|
not use this file except in compliance with the License. You may obtain
|
||||||
|
a copy of the License at
|
||||||
|
|
||||||
|
http://www.apache.org/licenses/LICENSE-2.0
|
||||||
|
|
||||||
|
Unless required by applicable law or agreed to in writing, software
|
||||||
|
distributed under the License is distributed on an "AS IS" BASIS, WITHOUT
|
||||||
|
WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the
|
||||||
|
License for the specific language governing permissions and limitations
|
||||||
|
under the License.
|
||||||
|
|
||||||
|
================
|
||||||
|
VNF Lcm commands
|
||||||
|
================
|
||||||
|
|
||||||
|
VNF LCM commands are CLI interface of VNF Lifecycle Management Interface in
|
||||||
|
`ETSI NFV-SOL 002 <https://www.etsi.org/deliver/etsi_gs/NFV-SOL/001_099/002/03.03.01_60/gs_NFV-SOL002v030301p.pdf>`_
|
||||||
|
and `ETSI NFV-SOL 003 <https://www.etsi.org/deliver/etsi_gs/NFV-SOL/001_099/003/03.03.01_60/gs_nfv-sol003v030301p.pdf>`_.
|
||||||
|
|
||||||
|
.. note::
|
||||||
|
Commands call version 1 vnflcm APIs by default.
|
||||||
|
You can call the specific version of vnflcm APIs
|
||||||
|
by using the option **\-\-os-tacker-api-version**.
|
||||||
|
Commands with **\-\-os-tacker-api-version 2** call version 2 vnflcm APIs.
|
||||||
|
**vnflcm op cancel** is included in only version 1 vnflcm APIs
|
||||||
|
and **change-vnfpkg** is included in only version 2 vnflcm APIs.
|
||||||
|
|
||||||
|
.. autoprogram-cliff:: openstack.tackerclient.v1
|
||||||
|
:command: vnflcm *
|
||||||
|
|
||||||
|
.. autoprogram-cliff:: openstack.tackerclient.v2
|
||||||
|
:command: vnflcm change-vnfpkg
|
|
@ -11,14 +11,6 @@
|
||||||
License for the specific language governing permissions and limitations
|
License for the specific language governing permissions and limitations
|
||||||
under the License.
|
under the License.
|
||||||
|
|
||||||
Convention for heading levels in Neutron devref:
|
|
||||||
======= Heading 0 (reserved for the title in a document)
|
|
||||||
------- Heading 1
|
|
||||||
~~~~~~~ Heading 2
|
|
||||||
+++++++ Heading 3
|
|
||||||
''''''' Heading 4
|
|
||||||
(Avoid deeper levels because they do not render well.)
|
|
||||||
|
|
||||||
============
|
============
|
||||||
Contributing
|
Contributing
|
||||||
============
|
============
|
||||||
|
|
|
@ -11,14 +11,6 @@
|
||||||
License for the specific language governing permissions and limitations
|
License for the specific language governing permissions and limitations
|
||||||
under the License.
|
under the License.
|
||||||
|
|
||||||
Convention for heading levels in Neutron devref:
|
|
||||||
======= Heading 0 (reserved for the title in a document)
|
|
||||||
------- Heading 1
|
|
||||||
~~~~~~~ Heading 2
|
|
||||||
+++++++ Heading 3
|
|
||||||
''''''' Heading 4
|
|
||||||
(Avoid deeper levels because they do not render well.)
|
|
||||||
|
|
||||||
===================================
|
===================================
|
||||||
Developing with Python-TackerClient
|
Developing with Python-TackerClient
|
||||||
===================================
|
===================================
|
||||||
|
@ -42,154 +34,6 @@ For details please refer to the `OpenStack IRC meetings`_ page.
|
||||||
Testing
|
Testing
|
||||||
=======
|
=======
|
||||||
|
|
||||||
Install the prerequisites for Tox:
|
For details please refer to the `Developing with OpenStackClient`_ page.
|
||||||
|
|
||||||
* On Ubuntu or Debian:
|
|
||||||
|
|
||||||
.. code-block:: bash
|
|
||||||
|
|
||||||
$ apt-get install gcc gettext python-dev libxml2-dev libxslt1-dev \
|
|
||||||
zlib1g-dev
|
|
||||||
|
|
||||||
You may need to use pip install for some packages.
|
|
||||||
|
|
||||||
|
|
||||||
* On RHEL or CentOS including Fedora:
|
|
||||||
|
|
||||||
.. code-block:: bash
|
|
||||||
|
|
||||||
$ yum install gcc python-devel libxml2-devel libxslt-devel
|
|
||||||
|
|
||||||
* On openSUSE or SUSE linux Enterprise:
|
|
||||||
|
|
||||||
.. code-block:: bash
|
|
||||||
|
|
||||||
$ zypper install gcc python-devel libxml2-devel libxslt-devel
|
|
||||||
|
|
||||||
Install python-tox:
|
|
||||||
|
|
||||||
.. code-block:: bash
|
|
||||||
|
|
||||||
$ pip install tox
|
|
||||||
|
|
||||||
To run the full suite of tests maintained within TackerClient.
|
|
||||||
|
|
||||||
.. code-block:: bash
|
|
||||||
|
|
||||||
$ tox
|
|
||||||
|
|
||||||
.. NOTE::
|
|
||||||
|
|
||||||
The first time you run ``tox``, it will take additional time to build
|
|
||||||
virtualenvs. You can later use the ``-r`` option with ``tox`` to rebuild
|
|
||||||
your virtualenv in a similar manner.
|
|
||||||
|
|
||||||
|
|
||||||
To run tests for one or more specific test environments(for example, the
|
|
||||||
most common configuration of Python 2.7, Python 3.5 and PEP-8), list the
|
|
||||||
environments with the ``-e`` option, separated by spaces:
|
|
||||||
|
|
||||||
.. code-block:: bash
|
|
||||||
|
|
||||||
$ tox -e py27,py35,pep8
|
|
||||||
|
|
||||||
See ``tox.ini`` for the full list of available test environments.
|
|
||||||
|
|
||||||
Building the Documentation
|
|
||||||
==========================
|
|
||||||
|
|
||||||
The documentation is generated with Sphinx using the ``tox`` command. To
|
|
||||||
create HTML docs, run the commands:
|
|
||||||
|
|
||||||
.. code-block:: bash
|
|
||||||
|
|
||||||
$ tox -e docs
|
|
||||||
|
|
||||||
The resultant HTML will be in the ``doc/build/html`` directory.
|
|
||||||
|
|
||||||
Release Notes
|
|
||||||
=============
|
|
||||||
|
|
||||||
The release notes for a patch should be included in the patch. See the
|
|
||||||
`Project Team Guide`_ for more information on using reno in OpenStack.
|
|
||||||
|
|
||||||
.. _`Project Team Guide`: http://docs.openstack.org/project-team-guide/release-management.html#managing-release-notes
|
|
||||||
|
|
||||||
If any of the following applies to the patch, a release note is required:
|
|
||||||
|
|
||||||
* The deployer needs to take an action when upgrading
|
|
||||||
* The plugin interface changes
|
|
||||||
* A new feature is implemented
|
|
||||||
* A command or option is removed
|
|
||||||
* Current behavior is changed
|
|
||||||
* A security bug is fixed
|
|
||||||
|
|
||||||
Reno is used to generate release notes. Use the commands:
|
|
||||||
|
|
||||||
.. code-block:: bash
|
|
||||||
|
|
||||||
$ tox -e venv -- reno new <bug-,bp-,whatever>
|
|
||||||
|
|
||||||
Then edit the sample file that was created and push it with your change.
|
|
||||||
|
|
||||||
To run the commands and see results:
|
|
||||||
|
|
||||||
.. code-block:: bash
|
|
||||||
|
|
||||||
$ git commit # Commit the change because reno scans git log.
|
|
||||||
|
|
||||||
$ tox -e releasenotes
|
|
||||||
|
|
||||||
At last, look at the generated release notes
|
|
||||||
files in ``releasenotes/build/html`` in your browser.
|
|
||||||
|
|
||||||
Testing new code
|
|
||||||
================
|
|
||||||
|
|
||||||
If a developer wants to test new code (feature, command or option) that
|
|
||||||
they have written, Python-TackerClient may be installed from source by running
|
|
||||||
the following commands in the base directory of the project:
|
|
||||||
|
|
||||||
.. code-block:: bash
|
|
||||||
|
|
||||||
$ python setup.py install
|
|
||||||
|
|
||||||
or
|
|
||||||
|
|
||||||
.. code-block:: bash
|
|
||||||
|
|
||||||
$ pip install -e .
|
|
||||||
|
|
||||||
Standardize Import Format
|
|
||||||
=========================
|
|
||||||
|
|
||||||
.. _`Import Order Guide`: https://docs.openstack.org/hacking/latest/user/hacking.html#imports
|
|
||||||
|
|
||||||
The import order shows below:
|
|
||||||
|
|
||||||
* {{stdlib imports in human alphabetical order}}
|
|
||||||
* \n
|
|
||||||
* {{third-party lib imports in human alphabetical order}}
|
|
||||||
* \n
|
|
||||||
* {{project imports in human alphabetical order}}
|
|
||||||
* \n
|
|
||||||
* \n
|
|
||||||
* {{begin your code}}
|
|
||||||
|
|
||||||
Example
|
|
||||||
~~~~~~~
|
|
||||||
|
|
||||||
.. code-block:: python
|
|
||||||
|
|
||||||
import copy
|
|
||||||
import fixtures
|
|
||||||
import mock
|
|
||||||
import os
|
|
||||||
|
|
||||||
from osc_lib.api import auth
|
|
||||||
from osc_lib import utils
|
|
||||||
import six
|
|
||||||
|
|
||||||
from openstackclient import shell
|
|
||||||
from openstackclient.tests import utils
|
|
||||||
|
|
||||||
|
.. _`Developing with OpenStackClient`: https://docs.openstack.org/python-openstackclient/latest/contributor/developing.html
|
|
@ -11,14 +11,6 @@
|
||||||
License for the specific language governing permissions and limitations
|
License for the specific language governing permissions and limitations
|
||||||
under the License.
|
under the License.
|
||||||
|
|
||||||
Convention for heading levels in Neutron devref:
|
|
||||||
======= Heading 0 (reserved for the title in a document)
|
|
||||||
------- Heading 1
|
|
||||||
~~~~~~~ Heading 2
|
|
||||||
+++++++ Heading 3
|
|
||||||
''''''' Heading 4
|
|
||||||
(Avoid deeper levels because they do not render well.)
|
|
||||||
|
|
||||||
=================
|
=================
|
||||||
Contributor Guide
|
Contributor Guide
|
||||||
=================
|
=================
|
||||||
|
|
|
@ -11,19 +11,12 @@
|
||||||
License for the specific language governing permissions and limitations
|
License for the specific language governing permissions and limitations
|
||||||
under the License.
|
under the License.
|
||||||
|
|
||||||
Convention for heading levels in Neutron devref:
|
|
||||||
======= Heading 0 (reserved for the title in a document)
|
|
||||||
------- Heading 1
|
|
||||||
~~~~~~~ Heading 2
|
|
||||||
+++++++ Heading 3
|
|
||||||
''''''' Heading 4
|
|
||||||
(Avoid deeper levels because they do not render well.)
|
|
||||||
|
|
||||||
=================================
|
=================================
|
||||||
Python-TackerClient Documentation
|
Python-TackerClient Documentation
|
||||||
=================================
|
=================================
|
||||||
|
|
||||||
This is a client for OpenStack NFV MANO (Tacker) API. It provides
|
Python-TackerClient is a client for OpenStack NFV MANO (Tacker) API.
|
||||||
|
It provides
|
||||||
:doc:`Python API bindings <reference/index>` (the tackerclient module) and
|
:doc:`Python API bindings <reference/index>` (the tackerclient module) and
|
||||||
:doc:`command-line interface (CLI) <cli/index>`.
|
:doc:`command-line interface (CLI) <cli/index>`.
|
||||||
|
|
||||||
|
|
|
@ -11,16 +11,9 @@
|
||||||
License for the specific language governing permissions and limitations
|
License for the specific language governing permissions and limitations
|
||||||
under the License.
|
under the License.
|
||||||
|
|
||||||
Convention for heading levels in Neutron devref:
|
|
||||||
======= Heading 0 (reserved for the title in a document)
|
|
||||||
------- Heading 1
|
|
||||||
~~~~~~~ Heading 2
|
|
||||||
+++++++ Heading 3
|
|
||||||
''''''' Heading 4
|
|
||||||
(Avoid deeper levels because they do not render well.)
|
|
||||||
|
|
||||||
=========
|
=========
|
||||||
Reference
|
Reference
|
||||||
=========
|
=========
|
||||||
|
|
||||||
(To be updated)
|
- `Tacker API reference <https://docs.openstack.org/api-ref/nfv-orchestration/>`_
|
||||||
|
- `Tacker CLI reference <https://docs.openstack.org/tacker/latest/cli/>`_
|
Loading…
Reference in New Issue