openstack-manuals/doc/common/section_keystone_cli_credentials.xml
Diane Fleming 64b6c9261e Folder rename, file rename, flattening of directories
Current folder name	New folder name	        Book title
----------------------------------------------------------
basic-install 	        DELETE
cli-guide	        DELETE
common	                common
NEW	                admin-guide-cloud	Cloud Administrators Guide
docbkx-example	        DELETE
openstack-block-storage-admin 	DELETE
openstack-compute-admin 	DELETE
openstack-config 	config-reference	OpenStack Configuration Reference
openstack-ha 	        high-availability-guide	OpenStack High Availabilty Guide
openstack-image	        image-guide	OpenStack Virtual Machine Image Guide
openstack-install 	install-guide	OpenStack Installation Guide
openstack-network-connectivity-admin 	admin-guide-network 	OpenStack Networking Administration Guide
openstack-object-storage-admin 	DELETE
openstack-security 	security-guide	OpenStack Security Guide
openstack-training 	training-guide	OpenStack Training Guide
openstack-user 	        user-guide	OpenStack End User Guide
openstack-user-admin 	user-guide-admin	OpenStack Admin User Guide
glossary	        NEW        	OpenStack Glossary

bug: #1220407

Change-Id: Id5ffc774b966ba7b9a591743a877aa10ab3094c7
author: diane fleming
2013-09-08 15:15:50 -07:00

120 lines
5.7 KiB
XML

<?xml version="1.0" encoding="UTF-8"?>
<section xmlns="http://docbook.org/ns/docbook"
xmlns:xi="http://www.w3.org/2001/XInclude"
xmlns:xlink="http://www.w3.org/1999/xlink" version="5.0"
xml:id="configure_keystone_client">
<title>Set up credentials for the keystone client</title>
<para>You can configure the
<filename>python-keystoneclient</filename> with admin
credentials with either an authentication token or a user name
and password.</para>
<procedure>
<title>To configure the keystone client with an authentication
token</title>
<step>
<para>Export your keystone endpoint to the
<varname>OS_SERVICE_ENDPOINT</varname> environment
variable:</para>
<screen><prompt>$</prompt> <userinput>export OS_SERVICE_ENDPOINT="&lt;keystoneEndpoint&gt;"</userinput></screen>
</step>
<step>
<para>Export the administrator service token to the
<varname>OS_SERVICE_TOKEN</varname> environment
variable:</para>
<screen><prompt>$</prompt> <userinput>export OS_SERVICE_TOKEN="&lt;serviceToken&gt;"</userinput></screen>
<note>
<para>Alternatively, you can specify these parameters
on any keystone client command:</para>
<itemizedlist>
<listitem>
<para>
<parameter>--os-endpoint
<replaceable>SERVICE_ENDPOINT</replaceable></parameter>.
An endpoint to use instead of the one in
the service catalog. Defaults to
<code>env[OS_SERVICE_ENDPOINT]</code>.
</para>
</listitem>
<listitem>
<para>
<parameter>--os-token
<replaceable>SERVICE_TOKEN</replaceable></parameter>.
An existing token to use instead of the
one generated by authentication. Defaults
to
<code>env[OS_SERVICE_TOKEN]</code>.</para>
</listitem>
</itemizedlist>
</note>
</step>
</procedure>
<procedure xml:id="password-auth-method">
<title>To configure the keystone client with a user name and
password</title>
<step>
<para>Export the administrator user name to the
<varname>OS_USERNAME</varname> environment
variable:</para>
<screen><prompt>$</prompt> <userinput>export OS_USERNAME="&lt;adminUserName&gt;"</userinput></screen>
</step>
<step>
<para>Export the administrator password to the
<varname>OS_PASSWORD</varname> environment
variable:</para>
<screen><prompt>$</prompt> <userinput>export OS_PASSWORD="&lt;adminPassword&gt;"</userinput></screen>
</step>
<step>
<para>Export the tenant name to the
<varname>OS_TENANT_NAME</varname> environment
variable:</para>
<screen><prompt>$</prompt> <userinput>export OS_TENANT_NAME="&lt;tenantName&gt;"</userinput></screen>
</step>
<step>
<para>Export the URL of the keystone auth server, for
example <link xlink:href="http://localhost:5000/v2.0'"
>http://localhost:5000/v2.0'</link>, to the
<varname>OS_AUTH_URL</varname> environment
variable:</para>
<screen><prompt>$</prompt> <userinput>export OS_AUTH_URL="&lt;authServerURL&gt;"</userinput></screen>
<note>
<para>Alternatively, you can specify these parameters
on any keystone client command:</para>
<itemizedlist>
<listitem>
<para>
<literal>--os-username
<replaceable>OS_USERNAME</replaceable></literal>.
Name used for authentication with the
Identity Service. Defaults to
<code>env[OS_USERNAME]</code>.</para>
</listitem>
<listitem>
<para>
<literal>--os-password
<replaceable>OS_PASSWORD</replaceable></literal>.
Password used for authentication with the
Identity Service. Defaults to
<code>env[OS_PASSWORD]</code>.</para>
</listitem>
<listitem>
<para>
<literal>--os-tenant_name
<replaceable>OS_TENANT_NAME</replaceable></literal>.
Tenant for which to request
authentication. Defaults to
<code>env[OS_TENANT_NAME]</code>.</para>
</listitem>
<listitem>
<para>
<literal>--os-auth_url
<replaceable>OS_AUTH_URL</replaceable></literal>.
The Identity Service endpoint to use for
authentication. Defaults to
<code>env[OS_AUTH_URL]</code>.</para>
</listitem>
</itemizedlist>
</note>
</step>
</procedure>
</section>