openstack/python-novaclient
Code Issues Proposed changes
b98a033d16
python-novaclient/doc/source/index.rst

100 lines
3.1 KiB
ReStructuredText
Raw Normal View History

Renamed all CloudServers to OpenStack and python-cloudservers to python-novatools
2011-02-08 09:27:22 -04:00
Python bindings to the OpenStack Nova API
Propose 'tox' as tests launcher Since ``tox`` is used as launcher in gates, it should be mentioned in docs instead of ``python setup.py test``. Change-Id: Ie5fcd9da755e1146b2b042fa5906aa28748980a6
2014-10-13 17:26:40 +03:00
=========================================
Initial commit from fork
2011-01-25 14:01:22 -06:00
Renamed all CloudServers to OpenStack and python-cloudservers to python-novatools
2011-02-08 09:27:22 -04:00
This is a client for OpenStack Nova API. There's :doc:`a Python API
renamed to novaclient and fixed flavor tests
2011-02-26 05:04:40 -04:00
<api>` (the :mod:`novaclient` module), and a :doc:`command-line script
renamed cmdline tool from novatools to nova. Changed version to 2.1. Changed license to Apache. Added copyright notices. Cleaner exception reporting in non-debug scnario.
2011-02-24 13:54:10 -04:00
<shell>` (installed as :program:`nova`). Each implements the entire
Renamed all CloudServers to OpenStack and python-cloudservers to python-novatools
2011-02-08 09:27:22 -04:00
OpenStack Nova API.
Initial commit from fork
2011-01-25 14:01:22 -06:00
Small doc cleanup round. - Changes theme to default instead of nature. - Explains in terms of Compute API instead of Rackspace - Remove outdated reference to nova-manage command - Remove unnecessary whitespace Change-Id: I43d16cd053af0b4be48450fd638f9d17f9e5c4e7
2012-06-25 18:53:09 -05:00
You'll need credentials for an OpenStack cloud that implements the
Compute API, such as TryStack, HP, or Rackspace, in order to use the nova client.
Initial commit from fork
2011-01-25 14:01:22 -06:00
.. seealso::
Small doc cleanup round. - Changes theme to default instead of nature. - Explains in terms of Compute API instead of Rackspace - Remove outdated reference to nova-manage command - Remove unnecessary whitespace Change-Id: I43d16cd053af0b4be48450fd638f9d17f9e5c4e7
2012-06-25 18:53:09 -05:00
You may want to read the `OpenStack Compute Developer Guide`__ -- the overview, at
least -- to get an idea of the concepts. By understanding the concepts
Initial commit from fork
2011-01-25 14:01:22 -06:00
this library should make more sense.
Small doc cleanup round. - Changes theme to default instead of nature. - Explains in terms of Compute API instead of Rackspace - Remove outdated reference to nova-manage command - Remove unnecessary whitespace Change-Id: I43d16cd053af0b4be48450fd638f9d17f9e5c4e7
2012-06-25 18:53:09 -05:00
__ http://docs.openstack.org/api/openstack-compute/2/content/
Initial commit from fork
2011-01-25 14:01:22 -06:00
Contents:
.. toctree::
:maxdepth: 2
whitespace cleanups
2011-08-08 13:20:44 -07:00
Initial commit from fork
2011-01-25 14:01:22 -06:00
shell
api
ref/index
Rename v1_1 to v2 Module novaclient.v1_1 is used as implementation of V1.1, V2 and V3. Since future development(microversioning) will be done across V2, implementation should be done in appropriate module(to prevent misleading). Despite the fact that implementation for all versions are equal, discover method for contrib path worked only for v1.1. This patch fixes this bug and modifies shell tests to check all versions. Change-Id: Ib6798f4dfe177586302141f522dc593560ce6a5b
2015-02-03 02:32:58 +02:00
ref/v2/index
Initial commit from fork
2011-01-25 14:01:22 -06:00
Contributing
============
Clean up a little cruft OpenStack runs a git service now, so instead of linking to github URLs, link to git.openstack.org. Versions for pbr in setup.py actually wind up being an error (and a very odd one) Remove them. The setup hook in setup.cfg is no longer needed. Change-Id: I8f48ac194e6c01e9bb06fa5df6f2b2bf28c01636
2013-09-18 08:00:08 -05:00
Code is hosted at `git.openstack.org`_. Submit bugs to the Nova project on
Update Contributing blurb in the docs. Contributing blurb previously mentioned using Github pull requests. Contributions should go to Gerrit instead. Change-Id: Id7b7f968fa5a3785c19704b4c1c2408f48b335ca
2012-06-22 10:16:49 -07:00
`Launchpad`_. Submit code to the openstack/python-novaclient project using
`Gerrit`_.
Initial commit from fork
2011-01-25 14:01:22 -06:00
Clean up a little cruft OpenStack runs a git service now, so instead of linking to github URLs, link to git.openstack.org. Versions for pbr in setup.py actually wind up being an error (and a very odd one) Remove them. The setup hook in setup.cfg is no longer needed. Change-Id: I8f48ac194e6c01e9bb06fa5df6f2b2bf28c01636
2013-09-18 08:00:08 -05:00
.. _git.openstack.org: https://git.openstack.org/cgit/openstack/python-novaclient
Update Contributing blurb in the docs. Contributing blurb previously mentioned using Github pull requests. Contributions should go to Gerrit instead. Change-Id: Id7b7f968fa5a3785c19704b4c1c2408f48b335ca
2012-06-22 10:16:49 -07:00
.. _Launchpad: https://launchpad.net/nova
Workflow documentation is now in infra-manual Replace URLs for workflow documentation to appropriate parts of the OpenStack Project Infrastructure Manual. Change-Id: I75618aaf9e07324985a83ca74d35bcab59e186c1
2014-12-05 03:30:40 +00:00
.. _Gerrit: http://docs.openstack.org/infra/manual/developers.html#development-workflow
Initial commit from fork
2011-01-25 14:01:22 -06:00
Propose 'tox' as tests launcher Since ``tox`` is used as launcher in gates, it should be mentioned in docs instead of ``python setup.py test``. Change-Id: Ie5fcd9da755e1146b2b042fa5906aa28748980a6
2014-10-13 17:26:40 +03:00
Testing
-------
The preferred way to run the unit tests is using ``tox``.
See `Consistent Testing Interface`_ for more details.
.. _Consistent Testing Interface: http://git.openstack.org/cgit/openstack/governance/tree/reference/project-testing-interface.rst
Initial commit from fork
2011-01-25 14:01:22 -06:00
Add documentation on command deprecation process Since we haven't removed deprecated commands before, add some documentation to the devref on the process for this type of change. Change-Id: Iff6f5df372bec524757b84747c7a95bbf6412c35
2015-05-23 19:22:04 -07:00
Deprecating commands
====================
There are times when commands need to be deprecated due to rename or removal.
The process for command deprecation is:
1. Push up a change for review which deprecates the command(s).
- The change should print a deprecation warning to stderr each time a
deprecated command is used.
- That warning message should include a rough timeline for when the command
will be removed and what should be used instead, if anything.
Update docs for instructions on deprecating commands The instructions for deprecating commands predated reno so this change updates them a bit to be current with our processes now. Also adds a reminder to update the help text/description of a command to mark it deprecated. Change-Id: I530399ba9cf6c50bd0dbb06f231aee61466eebd6
2016-10-12 18:24:01 -04:00
- The description in the help text for the deprecated command should mark
that it is deprecated.
- The change should include a release note with the ``deprecations`` section
filled out.
Add documentation on command deprecation process Since we haven't removed deprecated commands before, add some documentation to the devref on the process for this type of change. Change-Id: Iff6f5df372bec524757b84747c7a95bbf6412c35
2015-05-23 19:22:04 -07:00
- The deprecation cycle is typically the first client release *after* the
next *full* Nova server release so that there is at least six months of
deprecation.
2. Once the change is approved, have a member of the `nova-release`_ team
release a new version of python-novaclient.
.. _nova-release: https://review.openstack.org/#/admin/groups/147,members
3. Example: `<https://review.openstack.org/#/c/185141/>`_
Change future nova version number references based on new values The nova server liberty version is changing from 2015.2 to 12.0.0 and the 2016.1 'M' release will be 13.0.0 so update the deprecation warnings in the docs and code using those versions. Depends on nova change 192406. Change-Id: I6a35fa0dda798fad93b804d00a46af80f08d475c
2015-06-17 14:19:19 -07:00
This change was made while the Nova 12.0.0 Liberty release was in
Add documentation on command deprecation process Since we haven't removed deprecated commands before, add some documentation to the devref on the process for this type of change. Change-Id: Iff6f5df372bec524757b84747c7a95bbf6412c35
2015-05-23 19:22:04 -07:00
development. The current version of python-novaclient at the time was
2.25.0. Once the change was merged, python-novaclient 2.26.0 was released.
Change future nova version number references based on new values The nova server liberty version is changing from 2015.2 to 12.0.0 and the 2016.1 'M' release will be 13.0.0 so update the deprecation warnings in the docs and code using those versions. Depends on nova change 192406. Change-Id: I6a35fa0dda798fad93b804d00a46af80f08d475c
2015-06-17 14:19:19 -07:00
Since there was less than six months before 12.0.0 would be released, the
deprecation cycle ran through the 13.0.0 Nova server release.
Add documentation on command deprecation process Since we haven't removed deprecated commands before, add some documentation to the devref on the process for this type of change. Change-Id: Iff6f5df372bec524757b84747c7a95bbf6412c35
2015-05-23 19:22:04 -07:00
Fix all doc warnings and gate on warnings * Remove releases (File removed in e334096aa3a4badb2930c766cb4b42bbcc9ac107) * Add link to man page * Fix some docstring formatting Change-Id: Iec67a6d32f0365e514394c1e3eb7d8e4ae6aff65
2015-06-04 17:00:12 +09:00
Man Page
========
.. toctree::
:maxdepth: 1
man/nova
Initial commit from fork
2011-01-25 14:01:22 -06:00
Indices and tables
==================
* :ref:`genindex`
* :ref:`modindex`
* :ref:`search`
Copy Permalink