Go to file

Kyrylo Romanenko 89182c4825 Functional tests for openstackclient help messages

Add tests for list and description for Server commands:
 - Check server commands in main help message.
 - Check list of server-related commands only.
Commands:
  server add security group,
  server add volume,
  server create,
  server delete,
  server dump create,
  server image create,
  server list,
  server lock,
  server migrate,
  server pause,
  server reboot,
  server rebuild,
  server remove security group,
  server remove volume,
  server rescue,
  server resize,
  server resume,
  server set,
  server shelve,
  server show,
  server ssh,
  server start,
  server stop,
  server suspend,
  server unlock,
  server unpause,
  server unrescue,
  server unset,
  server unshelve.

Change-Id: Ib4bf9ab0264fb482d36cf5688c0f939bcd2cb6d8

2016-03-18 18:28:24 +02:00

doc

Merge "Sort commands in docs"

2016-03-14 22:27:53 +00:00

examples

Switch to ksa Session

2015-12-02 01:55:14 +00:00

functional

Functional tests for openstackclient help messages

2016-03-18 18:28:24 +02:00

openstackclient

Merge "Support "--long" option in ListService"

2016-03-14 20:17:04 +00:00

releasenotes

Merge "Add "os subnet create" command using SDK"

2016-03-14 16:09:56 +00:00

.coveragerc

Change ignore-errors to ignore_errors

2015-09-21 14:54:21 +00:00

.gitignore

gitignore .idea

2016-02-20 16:25:56 +08:00

.gitreview

Add openstack-common and test infrastructure.

2012-04-28 22:27:34 +00:00

.mailmap

Clean up test environment and remove unused imports.

2013-01-22 11:44:18 -06:00

.testr.conf

Use format options for functional tests

2015-05-17 12:33:39 +00:00

babel.cfg

Add translation markers for user v2 actions

2014-10-09 14:47:19 -04:00

HACKING.rst

Remove non-existing hacking deviations from doc

2015-08-09 13:22:48 -07:00

LICENSE

Remove LICENSE APPENDIX

2015-11-18 13:25:56 +09:00

post_test_hook.sh

unwedge the gate

2015-10-08 03:09:43 -04:00

README.rst

Use Block Storage instead of Volume

2015-11-27 17:56:10 +08:00

requirements.txt

Updated from global requirements

2016-03-04 19:42:17 +00:00

setup.cfg

Merge "Add "os subnet create" command using SDK"

2016-03-14 16:09:56 +00:00

setup.py

Updated from global requirements

2015-09-18 16:42:31 +00:00

test-requirements.txt

Updated from global requirements

2016-03-02 19:23:53 +00:00

tox.ini

Merge "Defaults are ignored with flake8"

2016-02-26 01:59:47 +00:00

README.rst

OpenStackClient

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

The primary goal is to provide a unified shell command structure and a common language to describe operations in OpenStack.

PyPi - package installation
Online Documentation
Launchpad project - release management
Blueprints - feature specifications
Bugs - issue tracking
Source
Developer - getting started as a developer
Contributing - contributing code
IRC: #openstack-sdks on Freenode (irc.freenode.net)
License: Apache 2.0

Getting Started

OpenStack Client can be installed from PyPI using pip:

pip install python-openstackclient

There are a few variants on getting help. A list of global options and supported commands is shown with --help:

openstack --help

There is also a help command that can be used to get help text for a specific command:

openstack help
openstack help server create

Configuration

The CLI is configured via environment variables and command-line options as listed in http://docs.openstack.org/developer/python-openstackclient/authentication.html.

Authentication using username/password is most commonly used:

export OS_AUTH_URL=<url-to-openstack-identity>
export OS_PROJECT_NAME=<project-name>
export OS_USERNAME=<username>
export OS_PASSWORD=<password>  # (optional)

The corresponding command-line options look very similar:

--os-auth-url <url>
--os-project-name <project-name>
--os-username <username>
[--os-password <password>]

If a password is not provided above (in plaintext), you will be interactively prompted to provide one securely.

Authentication may also be performed using an already-acquired token and a URL pointing directly to the service API that presumably was acquired from the Service Catalog:

export OS_TOKEN=<token>
export OS_URL=<url-to-openstack-service>

The corresponding command-line options look very similar:

--os-token <token>
--os-url <url-to-openstack-service>