7b110511d2
The developer documentation has been updated to include an optional command specs process. This process may be used to work out the specifications for new commands, objects and actions before their implementation. This new process could assist in the implementation of additional neutron support in OSC. Change-Id: I62f7472435a9caacee0d1b4c8d35417c123b5a44
2.5 KiB
OpenStackClient
OpenStackClient (aka OSC) is a command-line client for OpenStack that brings the command set for Compute, Identity, Image, Object Storage and Volume APIs together in a single shell with a uniform command structure.
User Documentation
command-list commands configuration plugins plugin-commands authentication interactive humaninterfaceguide backwards-incompatible man/openstack
Getting Started
- Try
some commands <command-list> - Read the source on OpenStack's Git server
- Install OpenStackClient from PyPi or a tarball
Release Notes
releases history
Developer Documentation
developing command-options command-wrappers 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
genindexmodindexsearch