openstack/python-openstackclient
Code Issues Proposed changes
ba6951222a
python-openstackclient/doc/source/index.rst
Tang Chen 0ac6b4fa46 Add doc for logger usage 
This patch adds a doc to record rules of usage of
loggers in OSC.

Change-Id: I27a09f9abb523393031560e2310bfdd1af0b8922
Implements: blueprint log-usage
2016-06-16 16:17:37 +08:00

2.7 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 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

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