diff options
| author | Dean Troyer <dtroyer@gmail.com> | 2012-04-27 11:49:01 -0500 |
|---|---|---|
| committer | Dean Troyer <dtroyer@gmail.com> | 2012-04-27 11:49:15 -0500 |
| commit | 2f2191b9edc324f7a064a2229e2037bb0d6f4dcb (patch) | |
| tree | f1be94ea8173c353d67a460c1126cb7ee69ab52b /README.rst | |
| parent | 60ed9aaa8aa72ecff420d303765d29f24a78bbc2 (diff) | |
| download | python-openstackclient-2f2191b9edc324f7a064a2229e2037bb0d6f4dcb.tar.gz | |
Add token auth to shell and README
Diffstat (limited to 'README.rst')
| -rw-r--r-- | README.rst | 40 |
1 files changed, 28 insertions, 12 deletions
@@ -2,29 +2,31 @@ OpenStack Client ================ -This is an unified command-line client for the OpenStack APIs. It is +python-openstackclient is a unified command-line client for the OpenStack APIs. It is a thin wrapper to the stock python-*client modules that implement the -actual API clients. +actual REST API client actions. This is an implementation of the design goals shown in http://wiki.openstack.org/UnifiedCLI. The primary goal is to provide a unified shell command structure and a common language to describe operations in OpenStack. +python-openstackclient is designed to add support for API extensions via a +plugin mechanism + + Configuration ============= -The cli is entirely configured with environment variables and command-line -options. It looks for the standard variables listed in -http://wiki.openstack.org/UnifiedCLI/Authentication for -the 'password flow' variation. +The cli is configured via environment variables and command-line +options as listed in http://wiki.openstack.org/UnifiedCLI/Authentication. -:: +The 'password flow' variation is most commonly used:: - export OS_AUTH_URL=url-to-openstack-identity - export OS_TENANT_NAME=tenant - export OS_USERNAME=user - export OS_PASSWORD=password # yes, it isn't secure, we'll address it in the future + export OS_AUTH_URL=<url-to-openstack-identity> + export OS_TENANT_NAME=<tenant-name> + export OS_USERNAME=<user-name> + export OS_PASSWORD=<password> # yes, it isn't secure, we'll address it in the future The corresponding command-line options look very similar:: @@ -33,9 +35,23 @@ The corresponding command-line options look very similar:: --os-username <user-name> --os-password <password> +The token flow variation for authentication uses an already-aquired 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> + Additional command-line options and their associated environment variables are listed here:: --debug # turns on some debugging of the API conversation (via httplib2) - + --verbose | -v # Increase verbosity of output. Can be repeated. + --quiet | -q # suppress output except warnings and errors + --help | -h # show a help message and exit
\ No newline at end of file |
