blob: dc12f76b843336c7afb095c5ba02b44b07cd7736 [file] [log] [blame]
Dean Troyer0986a7b2014-10-29 22:08:13 -05001=====================================
2openrc - User Authentication Settings
3=====================================
Sean M. Collins09e550c2014-10-21 11:40:08 -04004
5``openrc`` configures login credentials suitable for use with the
6OpenStack command-line tools. ``openrc`` sources ``stackrc`` at the
7beginning (which in turn sources the ``localrc`` setion of
8``local.conf``) in order to pick up ``HOST_IP`` and/or ``SERVICE_HOST``
9to use in the endpoints. The values shown below are the default values.
10
11OS\_TENANT\_NAME
12 The introduction of Keystone to the OpenStack ecosystem has
13 standardized the term *tenant* as the entity that owns resources. In
14 some places references still exist to the original Nova term
15 *project* for this use. Also, *tenant\_name* is preferred to
16 *tenant\_id*.
17
18 ::
19
20 OS_TENANT_NAME=demo
21
22OS\_USERNAME
23 In addition to the owning entity (tenant), Nova stores the entity
24 performing the action as the *user*.
25
26 ::
27
28 OS_USERNAME=demo
29
30OS\_PASSWORD
31 With Keystone you pass the keystone password instead of an api key.
32 Recent versions of novaclient use OS\_PASSWORD instead of
33 NOVA\_API\_KEYs or NOVA\_PASSWORD.
34
35 ::
36
37 OS_PASSWORD=secrete
38
39HOST\_IP, SERVICE\_HOST
40 Set API endpoint host using ``HOST_IP``. ``SERVICE_HOST`` may also
41 be used to specify the endpoint, which is convenient for some
42 ``localrc`` configurations. Typically, ``HOST_IP`` is set in the
43 ``localrc`` section.
44
45 ::
46
47 HOST_IP=127.0.0.1
48 SERVICE_HOST=$HOST_IP
49
50OS\_AUTH\_URL
51 Authenticating against an OpenStack cloud using Keystone returns a
52 *Token* and *Service Catalog*. The catalog contains the endpoints
53 for all services the user/tenant has access to - including Nova,
54 Glance, Keystone and Swift.
55
56 ::
57
58 OS_AUTH_URL=http://$SERVICE_HOST:5000/v2.0
59
60GLANCE\_HOST
61 Some exercises call Glance directly. On a single-node installation,
62 Glance should be listening on ``HOST_IP``. If its running elsewhere
63 it can be set here.
64
65 ::
66
67 GLANCE_HOST=$HOST_IP
68
69KEYSTONECLIENT\_DEBUG, NOVACLIENT\_DEBUG
70 Set command-line client log level to ``DEBUG``. These are commented
71 out by default.
72
73 ::
74
75 # export KEYSTONECLIENT_DEBUG=1
76 # export NOVACLIENT_DEBUG=1