blob: b84d26839b8d428f2f9e9cbe475b6eb547af149f [file] [log] [blame]
Dean Troyer54b97322014-06-20 17:53:55 -05001<!DOCTYPE html>
2<html lang="en">
3 <head>
4 <meta charset="utf-8">
5 <title>DevStack - openrc</title>
6 <meta name="description" content="">
7 <meta name="author" content="">
8
9 <!-- Le HTML5 shim, for IE6-8 support of HTML elements -->
10 <!--[if lt IE 9]>
11 <script src="http://html5shim.googlecode.com/svn/trunk/html5.js"></script>
12 <![endif]-->
13
14 <!-- Le styles -->
15 <link href="assets/css/bootstrap.css" rel="stylesheet">
16 <link href="assets/css/local.css" rel="stylesheet">
17 <style type="text/css">
18 body { padding-top: 60px; }
19 dd { padding: 10px; }
20 </style>
21
22 <!-- Le javascripts -->
23 <script src="../assets/js/jquery-1.7.1.min.js" type="text/javascript" charset="utf-8"></script>
24 <script src="../assets/js/bootstrap.js" type="text/javascript" charset="utf-8"></script>
25 </head>
26
27 <body>
28
29 <div class="navbar navbar-fixed-top">
30 <div class="navbar-inner">
31 <div class="container">
32 <a class="brand" href="/">DevStack</a>
33 <ul class="nav pull-right">
34 <li><a href="overview.html">Overview</a></li>
35 <li><a href="changes.html">Changes</a></li>
36 <li><a href="faq.html">FAQ</a></li>
37 <li><a href="http://github.com/openstack-dev/devstack">GitHub</a></li>
38 <li><a href="https://review.openstack.org/#/q/status:open+project:openstack-dev/devstack,n,z">Gerrit</a></li>
39 </ul>
40 </div>
41 </div>
42 </div>
43
44 <div class="container">
45
46 <section class="span12">
47 <div class="page-header">
48 <h2>openrc <small>User authentication settings</small></h2>
49 <p><code>openrc</code> configures login credentials suitable for use
50 with the OpenStack command-line tools. <code>openrc</code> sources
51 <code>stackrc</code> at the beginning (which in turn sources
52 the <code>localrc</code> setion of <code>local.conf</code>) in
53 order to pick up <code>HOST_IP</code>
54 and/or <code>SERVICE_HOST</code> to use in the endpoints.
55 The values shown below are the default values.</p>
56 </div>
57 <dl>
58
59 <dt>OS_TENANT_NAME</dt>
60 <dd>The introduction of Keystone to the OpenStack ecosystem has standardized the
61 term <em>tenant</em> as the entity that owns resources. In some places references
62 still exist to the original Nova term <em>project</em> for this use. Also,
63 <em>tenant_name</em> is prefered to <em>tenant_id</em>.
64 <pre>OS_TENANT_NAME=demo</pre></dd>
65
66 <dt>OS_USERNAME</dt>
67 <dd>In addition to the owning entity (tenant), Nova stores the entity performing
68 the action as the <em>user</em>.
69 <pre>OS_USERNAME=demo</pre></dd>
70
71 <dt>OS_PASSWORD</dt>
72 <dd>With Keystone you pass the keystone password instead of an api key.
73 Recent versions of novaclient use OS_PASSWORD instead of NOVA_API_KEYs
74 or NOVA_PASSWORD.
75 <pre>OS_PASSWORD=secrete</pre></dd>
76
77 <dt>HOST_IP, SERVICE_HOST</dt>
78 <dd>Set API endpoint host using <code>HOST_IP</code>. <code>SERVICE_HOST</code>
79 may also be used to specify the endpoint, which is convenient for
80 some <code>localrc</code> configurations. Typically, <code>HOST_IP</code>
81 is set in the <code>localrc</code> section.
82 <pre>HOST_IP=127.0.0.1
83SERVICE_HOST=$HOST_IP</pre></dd>
84
85 <dt>OS_AUTH_URL</dt>
86 <dd>Authenticating against an OpenStack cloud using Keystone returns a <em>Token</em>
87 and <em>Service Catalog</em>. The catalog contains the endpoints for all services
88 the user/tenant has access to - including Nova, Glance, Keystone and Swift.
89 <pre>OS_AUTH_URL=http://$SERVICE_HOST:5000/v2.0</pre></dd>
90
91 <dt>GLANCE_HOST</dt>
92 <dd>Some exercises call Glance directly. On a single-node installation, Glance
93 should be listening on <code>HOST_IP</code>. If its running elsewhere
94 it can be set here.
95 <pre>GLANCE_HOST=$HOST_IP</pre></dd>
96
97 <dt>KEYSTONECLIENT_DEBUG, NOVACLIENT_DEBUG</dt>
98 <dd>Set command-line client log level to <code>DEBUG</code>. These are
99 commented out by default.
100 <pre># export KEYSTONECLIENT_DEBUG=1
101# export NOVACLIENT_DEBUG=1</pre></dd>
102
103 </dl>
104 </section
105
106 <footer>
107 <p>&copy; Openstack Foundation 2011-2013 &mdash; An
108 <a href="https://wiki.openstack.org/wiki/Programs">OpenStack program</a>
109 created by <a href="http://www.rackspace.com/cloud/private_edition/">Rackspace Cloud Builders</a></p>
110 </footer>
111
112 </div> <!-- /container -->
113
114 </body>
115</html>