python-openstackclient/doc/source/index.rst
Steve Martinelli 98aee9e39a Create 1.0.2 release notes
Also move the release notes to the bottom of the ToC, no need for
it to be at the top, that's prime real estate.

Change-Id: Ib3094a390a7214b320d02f77229f368aa4432c4e
2015-01-19 10:42:29 -06:00

2.1 KiB

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 plugins authentication interactive humaninterfaceguide 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