Skip to content

Commit

Permalink
Merge "Change '_' to '-' in options"
Browse files Browse the repository at this point in the history
  • Loading branch information
@openstack-gerrit
Jenkins authored and openstack-gerrit committed Aug 30, 2012
2 parents 08aa965 + d7b09bd commit a153f10
Show file tree
Hide file tree
Showing 4 changed files with 179 additions and 104 deletions.
54 changes: 24 additions & 30 deletions README.rst
View file
Expand Up @@ -40,14 +40,14 @@ Installing this package gets you a shell command, ``cinder``, that you
can use to interact with any Rackspace compatible API (including OpenStack).

You'll need to provide your OpenStack username and password. You can do this
with the ``--os_username``, ``--os_password`` and ``--os_tenant_name``
with the ``--os-username``, ``--os-password`` and ``--os-tenant-name``
params, but it's easier to just set them as environment variables::

export OS_USERNAME=openstack
export OS_PASSWORD=yadayada
export OS_TENANT_NAME=myproject

You will also need to define the authentication url with ``--os_auth_url``
You will also need to define the authentication url with ``--os-auth-url``
and the version of the API with ``--version``. Or set them as an environment
variables as well::

Expand All @@ -60,20 +60,21 @@ endpoint::
export OS_AUTH_URL=http://example.com:5000/v2.0/

Since Keystone can return multiple regions in the Service Catalog, you
can specify the one you want with ``--os_region_name`` (or
can specify the one you want with ``--os-region-name`` (or
``export OS_REGION_NAME``). It defaults to the first in the list returned.

You'll find complete documentation on the shell by running
``cinder help``::

usage: cinder [--debug] [--os_username OS_USERNAME] [--os_password OS_PASSWORD]
[--os_tenant_name OS_TENANT_NAME] [--os_auth_url OS_AUTH_URL]
[--os_region_name OS_REGION_NAME] [--service_type SERVICE_TYPE]
[--service_name SERVICE_NAME] [--endpoint_type ENDPOINT_TYPE]
[--version VERSION] [--username USERNAME]
[--region_name REGION_NAME] [--apikey APIKEY]
[--projectid PROJECTID] [--url URL]
<subcommand> ...
usage: cinder [--debug] [--os-username <auth-user-name>]
[--os-password <auth-password>]
[--os-tenant-name <auth-tenant-name>] [--os-auth-url <auth-url>]
[--os-region-name <region-name>] [--service-type <service-type>]
[--service-name <service-name>]
[--volume-service-name <volume-service-name>]
[--endpoint-type <endpoint-type>]
[--os-volume-api-version <compute-api-ver>]
<subcommand> ...

Command-line interface to the OpenStack Nova API.

Expand All @@ -100,33 +101,26 @@ You'll find complete documentation on the shell by running

Optional arguments:
--debug Print debugging output
--os_username OS_USERNAME
--os-username <auth-user-name>
Defaults to env[OS_USERNAME].
--os_password OS_PASSWORD
--os-password <auth-password>
Defaults to env[OS_PASSWORD].
--os_tenant_name OS_TENANT_NAME
--os-tenant-name <auth-tenant-name>
Defaults to env[OS_TENANT_NAME].
--os_auth_url OS_AUTH_URL
--os-auth-url <auth-url>
Defaults to env[OS_AUTH_URL].
--os_region_name OS_REGION_NAME
--os-region-name <region-name>
Defaults to env[OS_REGION_NAME].
--service_type SERVICE_TYPE
--service-type <service-type>
Defaults to compute for most actions
--service_name SERVICE_NAME
--service-name <service-name>
Defaults to env[CINDER_SERVICE_NAME]
--endpoint_type ENDPOINT_TYPE
--volume-service-name <volume-service-name>
Defaults to env[CINDER_VOLUME_SERVICE_NAME]
--endpoint-type <endpoint-type>
Defaults to env[CINDER_ENDPOINT_TYPE] or publicURL.
--os_compute_api_version VERSION
Accepts 1.1, defaults to env[OS_COMPUTE_API_VERSION].
--username USERNAME Deprecated
--region_name REGION_NAME
Deprecated
--apikey APIKEY, --password APIKEY
Deprecated
--projectid PROJECTID, --tenant_name PROJECTID
Deprecated
--url URL, --auth_url URL
Deprecated
--os-volume-api-version <compute-api-ver>
Accepts 1, defaults to env[OS_VOLUME_API_VERSION].

See "cinder help COMMAND" for help on a specific command.

Expand Down
84 changes: 57 additions & 27 deletions cinderclient/shell.py
View file
Expand Up @@ -85,53 +85,83 @@ def get_base_parser(self):
action='store_true',
help="Print debugging output")

parser.add_argument('--os_username',
parser.add_argument('--os-username',
metavar='<auth-user-name>',
default=utils.env('OS_USERNAME',
'CINDER_USERNAME'),
help='Defaults to env[OS_USERNAME].')
parser.add_argument('--os_username',
help=argparse.SUPPRESS)

parser.add_argument('--os_password',
parser.add_argument('--os-password',
metavar='<auth-password>',
default=utils.env('OS_PASSWORD',
'CINDER_PASSWORD'),
help='Defaults to env[OS_PASSWORD].')
parser.add_argument('--os_password',
help=argparse.SUPPRESS)

parser.add_argument('--os_tenant_name',
parser.add_argument('--os-tenant-name',
metavar='<auth-tenant-name>',
default=utils.env('OS_TENANT_NAME',
'CINDER_PROJECT_ID'),
help='Defaults to env[OS_TENANT_NAME].')
parser.add_argument('--os_tenant_name',
help=argparse.SUPPRESS)

parser.add_argument('--os_auth_url',
parser.add_argument('--os-auth-url',
metavar='<auth-url>',
default=utils.env('OS_AUTH_URL',
'CINDER_URL'),
help='Defaults to env[OS_AUTH_URL].')
parser.add_argument('--os_auth_url',
help=argparse.SUPPRESS)

parser.add_argument('--os_region_name',
parser.add_argument('--os-region-name',
metavar='<region-name>',
default=utils.env('OS_REGION_NAME',
'CINDER_REGION_NAME'),
help='Defaults to env[OS_REGION_NAME].')
parser.add_argument('--os_region_name',
help=argparse.SUPPRESS)

parser.add_argument('--service_type',
parser.add_argument('--service-type',
metavar='<service-type>',
help='Defaults to compute for most actions')
parser.add_argument('--service_type',
help=argparse.SUPPRESS)

parser.add_argument('--service_name',
parser.add_argument('--service-name',
metavar='<service-name>',
default=utils.env('CINDER_SERVICE_NAME'),
help='Defaults to env[CINDER_SERVICE_NAME]')
parser.add_argument('--service_name',
help=argparse.SUPPRESS)

parser.add_argument('--volume_service_name',
parser.add_argument('--volume-service-name',
metavar='<volume-service-name>',
default=utils.env('CINDER_VOLUME_SERVICE_NAME'),
help='Defaults to env[CINDER_VOLUME_SERVICE_NAME]')
parser.add_argument('--volume_service_name',
help=argparse.SUPPRESS)

parser.add_argument('--endpoint_type',
parser.add_argument('--endpoint-type',
metavar='<endpoint-type>',
default=utils.env('CINDER_ENDPOINT_TYPE',
default=DEFAULT_CINDER_ENDPOINT_TYPE),
help='Defaults to env[CINDER_ENDPOINT_TYPE] or '
+ DEFAULT_CINDER_ENDPOINT_TYPE + '.')
parser.add_argument('--endpoint_type',
help=argparse.SUPPRESS)

parser.add_argument('--os_volume_api_version',
parser.add_argument('--os-volume-api-version',
metavar='<compute-api-ver>',
default=utils.env('OS_VOLUME_API_VERSION',
default=DEFAULT_OS_VOLUME_API_VERSION),
help='Accepts 1,defaults '
'to env[OS_VOLUME_API_VERSION].')
parser.add_argument('--os_volume_api_version',
help=argparse.SUPPRESS)

parser.add_argument('--insecure',
default=utils.env('CINDERCLIENT_INSECURE',
Expand All @@ -142,28 +172,28 @@ def get_base_parser(self):
# FIXME(dtroyer): The args below are here for diablo compatibility,
# remove them in folsum cycle

# alias for --os_username, left in for backwards compatibility
# alias for --os-username, left in for backwards compatibility
parser.add_argument('--username',
help='Deprecated')
help=argparse.SUPPRESS)

# alias for --os_region_name, left in for backwards compatibility
# alias for --os-region_name, left in for backwards compatibility
parser.add_argument('--region_name',
help='Deprecated')
help=argparse.SUPPRESS)

# alias for --os_password, left in for backwards compatibility
# alias for --os-password, left in for backwards compatibility
parser.add_argument('--apikey', '--password', dest='apikey',
default=utils.env('CINDER_API_KEY'),
help='Deprecated')
help=argparse.SUPPRESS)

# alias for --os_tenant_name, left in for backward compatibility
# alias for --os-tenant-name, left in for backward compatibility
parser.add_argument('--projectid', '--tenant_name', dest='projectid',
default=utils.env('CINDER_PROJECT_ID'),
help='Deprecated')
help=argparse.SUPPRESS)

# alias for --os_auth_url, left in for backward compatibility
# alias for --os-auth-url, left in for backward compatibility
parser.add_argument('--url', '--auth_url', dest='url',
default=utils.env('CINDER_URL'),
help='Deprecated')
help=argparse.SUPPRESS)

return parser

Expand Down Expand Up @@ -274,7 +304,7 @@ def setup_debugging(self, debug):
httplib2.debuglevel = 1

def main(self, argv):
# Parse args once to find version
# Parse args once to find version and debug settings
parser = self.get_base_parser()
(options, args) = parser.parse_known_args(argv)
self.setup_debugging(options.debug)
Expand Down Expand Up @@ -330,22 +360,22 @@ def main(self, argv):
if not username:
raise exc.CommandError(
"You must provide a username "
"via either --os_username or env[OS_USERNAME]")
"via either --os-username or env[OS_USERNAME]")
else:
os_username = username

if not os_password:
if not apikey:
raise exc.CommandError("You must provide a password "
"via either --os_password or via "
"via either --os-password or via "
"env[OS_PASSWORD]")
else:
os_password = apikey

if not os_tenant_name:
if not projectid:
raise exc.CommandError("You must provide a tenant name "
"via either --os_tenant_name or "
"via either --os-tenant-name or "
"env[OS_TENANT_NAME]")
else:
os_tenant_name = projectid
Expand All @@ -354,7 +384,7 @@ def main(self, argv):
if not url:
raise exc.CommandError(
"You must provide an auth url "
"via either --os_auth_url or env[OS_AUTH_URL]")
"via either --os-auth-url or env[OS_AUTH_URL]")
else:
os_auth_url = url

Expand All @@ -364,12 +394,12 @@ def main(self, argv):
if not os_tenant_name:
raise exc.CommandError(
"You must provide a tenant name "
"via either --os_tenant_name or env[OS_TENANT_NAME]")
"via either --os-tenant-name or env[OS_TENANT_NAME]")

if not os_auth_url:
raise exc.CommandError(
"You must provide an auth url "
"via either --os_auth_url or env[OS_AUTH_URL]")
"via either --os-auth-url or env[OS_AUTH_URL]")

self.cs = client.Client(options.os_volume_api_version, os_username,
os_password, os_tenant_name, os_auth_url,
Expand Down

0 comments on commit a153f10

Please sign in to comment.