python-openstackclient/doc/source/index.rst
Steve Martinelli aef9dacc7f minor tweaks to mapping table
- no need to prefix it with OSC
- since it's a page with a lot of content, make
  it show sub headings

Change-Id: I1aab4f71def53f1a11a8a0e0f6b7748233ff02c7
2017-02-22 14:19:38 -06:00

2.7 KiB

OpenStackClient

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

User Documentation

Manual Page <man/openstack> command-list commands configuration plugins plugin-commands authentication interactive humaninterfaceguide backwards-incompatible

decoder

Getting Started

Release Notes

Developer Documentation

developing command-beta command-options command-wrappers command-errors command-logs specs/commands

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