openstack-manuals/doc/common/section_cli_openrc.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

61 lines
3.2 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="cli_openrc">
<title>Download and source the OpenStack RC file</title>
<para>To set the required environment variables for the OpenStack
command-line clients, you must download and source an
environment file, <filename>openrc.sh</filename>. It is
project-specific and contains the credentials used by
OpenStack Compute, Image, and Identity services.</para>
<para>When you source the file and enter the password, environment
variables are set for that shell. They allow the commands to
communicate to the OpenStack services that run in the
cloud.</para>
<para>You can download the file from the OpenStack dashboard as an
administrative user or any other user.</para>
<procedure>
<!-- <title>To download the OpenStack RC file</title> -->
<step>
<para>Log in to the OpenStack dashboard, choose the
project for which you want to download the OpenStack
RC file, and click <emphasis role="bold">Access &amp;
Security</emphasis>.</para></step><step><para>Click
<guibutton>Download OpenStack RC File</guibutton>
and save the file.</para>
</step>
<step>
<para>Copy the <filename>openrc.sh</filename> file to the
machine from where you want to run OpenStack commands.</para>
<para>For example, copy the file to the machine from where
you want to upload an image with a glance client
command.</para>
</step>
<step>
<para>On any shell from where you want to run OpenStack
commands, source the <filename>openrc.sh</filename>
file for the respective project.</para>
<para>In this example, we source the
<filename>demo-openrc.sh</filename> file for the
demo project:</para>
<screen><prompt>$</prompt> <userinput>source demo-openrc.sh</userinput></screen>
</step>
<step>
<para>When you are prompted for an OpenStack password,
enter the OpenStack password for the user who
downloaded the <filename>openrc.sh</filename>
file.</para> </step> <step><para>When you run OpenStack client commands, you can override some
environment variable settings by using the options
that are listed at the end of the <command>nova
help</command> output. For example, you can
override the <literal>OS_PASSWORD</literal> setting in
the <filename>openrc.sh</filename> file by specifying
a password on a nova command, as follows:</para>
<screen><prompt>$</prompt> <userinput>nova --password &lt;password> image-list</userinput></screen>
<para>Where <parameter>password</parameter> is
your password.</para>
</step>
</procedure>
</section>