openstack/python-novaclient
Code Issues Proposed changes
Files
d37c19a13fb32424f9cf021cbef416cd2cfde53b
python-novaclient/doc/source/index.rst
Matt Riedemann 3502c8aee2 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-06-02 14:14:11 -07:00

2.9 KiB
Raw Blame History

Python bindings to the OpenStack Nova API

This is a client for OpenStack Nova API. There's a Python API <api> (the novaclient module), and a command-line script <shell> (installed as nova). Each implements the entire OpenStack Nova API.

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.

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 this library should make more sense.

__ http://docs.openstack.org/api/openstack-compute/2/content/

Contents:

shell api ref/index ref/v2/index releases

Contributing

Code is hosted at git.openstack.org. Submit bugs to the Nova project on Launchpad. Submit code to the openstack/python-novaclient project using Gerrit.

Testing

The preferred way to run the unit tests is using tox.

See Consistent Testing Interface for more details.

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.
  • The commit message on the change should include a DocImpact tag so it gets in the release notes.
  • 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.

  1. Once the change is approved, have a member of the nova-release team release a new version of python-novaclient.

  2. Example: https://review.openstack.org/#/c/185141/

    This change was made while the Nova 2015.2 Liberty release was in 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. Since there was less than six months before 2015.2 would be released, the deprecation cycle ran through the 2016.1 Nova server release.

Indices and tables

  • genindex
  • modindex
  • search
View Git Blame Copy Permalink