From f4b5ef39f6f84e66af532583040c9be7556e9b69 Mon Sep 17 00:00:00 2001 From: Dean Troyer Date: Wed, 18 Apr 2012 13:16:39 -0500 Subject: First commit --- README.rst | 41 +++++++++++++++++++++++++++++++++++++++++ 1 file changed, 41 insertions(+) create mode 100644 README.rst (limited to 'README.rst') diff --git a/README.rst b/README.rst new file mode 100644 index 00000000..6e629fe5 --- /dev/null +++ b/README.rst @@ -0,0 +1,41 @@ +================ +OpenStack Client +================ + +This is an 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. + +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. + +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. + +:: + + 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 + +The corresponding command-line options look very similar:: + + --os-auth-url + --os-tenant-name + --os-username + --os-password + +Additional command-line options and their associated environment variables +are listed here:: + + --debug # turns on some debugging of the API conversation + (via httplib2) + -- cgit v1.2.1