openstack/python-openstackclient
Code Issues Proposed changes
python-openstackclient/doc/source/index.rst
Steve Martinelli f815b3fe27 Add a doc that dictates backwards incompatible changes 
start tracking any changes in a standard format, so users may
have a heads up about any impacts.

Change-Id: Ibc06926a53592e927d11440362cd3598e0d4b2bf
Closes-Bug: 1406470
2015-04-23 23:25:09 -04:00

2.1 KiB
Raw Blame History

OpenStackClient

OpenStackClient (aka OSC) is a command-line client for OpenStack that brings the command set for Compute, Identity, Image, Object Store and Volume APIs together in a single shell with a uniform command structure.

Contents:

command-list commands configuration plugins authentication interactive humaninterfaceguide backwards-incompatible releases man/openstack

Getting Started

Project Goals

  • Use the OpenStack Python API libraries, extending or replacing them as required
  • Use a consistent naming and structure for commands and arguments
  • Provide consistent output formats with optional machine parseable formats
  • Use a single-binary approach that also contains an embedded shell that can execute multiple commands on a single authentication (see libvirt's virsh for an example)
  • Independence from the OpenStack project names; only API names are referenced (to the extent possible)

Contributing

OpenStackClient utilizes all of the usual OpenStack processes and requirements for contributions. The code is hosted on OpenStack's Git server. Bug reports and blueprints may be submitted to the python-openstackclient project on Launchpad. Code may be submitted to the openstack/python-openstackclient project using Gerrit.

Indices and Tables

  • genindex
  • modindex
  • search