openstack/python-openstackclient
Code Issues Proposed changes
35dc2bed9e
python-openstackclient/doc/source/index.rst
Jens Rosenboom bf99218292 Add a reference to the IRC channels 
As the name of the associated IRC channel for this project is not
completely obvious, add a reference to the doc index page so that
it may be found easier.

Change-Id: I6cb6e2571bff73db6d983cd96fe6d03319d6577c
2015-06-03 02:53:50 +02:00

2.3 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. Developers may also be found in the IRC channel #openstack-sdks.

Indices and Tables

  • genindex
  • modindex
  • search