3ba7738323
To better facilitate the building and publishing of sphinx documentation by Jenkins we are moving all openstack projects with sphinx documentation to a common doc tree structure. Documentation goes in project/doc/source and build results go in project/doc/build. Change-Id: I205e8bb1ddf6dae1d7392b32975319c6a6d98673
1.7 KiB
The keystone shell utility
keystone
The keystone
shell utility interacts with OpenStack Keystone API from the command
line. It supports the entirety of the OpenStack Keystone API.
First, you'll need an OpenStack Keystone account. You get this by using the keystone-manage command in OpenStack Keystone.
You'll need to provide keystone with your OpenStack username and
password. You can do this with the --os_username, --os_password. You can optionally specify a --os_tenant_id or --os_tenant_name, to scope
your token to a specific tenant. If you don't specify a tenant, you will
be scoped to your default tenant if you have one. Instead of using
options, it is easier to just set them as environment variables:
OS_USERNAME
Your Keystone username.
OS_PASSWORD
Your Keystone password.
OS_TENANT_NAME
Name of Keystone Tenant.
OS_TENANT_ID
ID of Keystone Tenant.
OS_AUTH_URL
The OpenStack API server URL.
OS_IDENTITY_API_VERSION
The OpenStack Identity API version.
For example, in Bash you'd use:
export OS_USERNAME=yourname
export OS_PASSWORD=yadayadayada
export OS_TENANT_NAME=myproject
export OS_AUTH_URL=http://example.com:5000/v2.0/
export OS_IDENTITY_API_VERSION=2.0From there, all shell commands take the form:
keystone <command> [arguments...]Run keystone help to get a full list of all possible
commands, and run keystone help <command> to get detailed help
for that command.