... | ... |
@@ -22,7 +22,7 @@ simplify this process and meet the following goals: |
22 | 22 |
- allow settings in arbitrary configuration files to be changed |
23 | 23 |
|
24 | 24 |
local.conf |
25 |
-~~~~~~~~~~ |
|
25 |
+========== |
|
26 | 26 |
|
27 | 27 |
The new configuration file is ``local.conf`` and resides in the root |
28 | 28 |
DevStack directory like the old ``localrc`` file. It is a modified INI |
... | ... |
@@ -96,7 +96,7 @@ fragment amd MUST conform to the shell requirements, specifically no |
96 | 96 |
whitespace around ``=`` (equals). |
97 | 97 |
|
98 | 98 |
Minimal Configuration |
99 |
-~~~~~~~~~~~~~~~~~~~~~ |
|
99 |
+===================== |
|
100 | 100 |
|
101 | 101 |
While ``stack.sh`` is happy to run without a ``localrc`` section in |
102 | 102 |
``local.conf``, devlife is better when there are a few minimal variables |
... | ... |
@@ -136,9 +136,11 @@ available for ``openrc`` to set ``OS_AUTH_URL``. ``HOST_IP`` is not set |
136 | 136 |
by default. |
137 | 137 |
|
138 | 138 |
Common Configuration Variables |
139 |
-~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ |
|
139 |
+============================== |
|
140 |
+ |
|
141 |
+Installation Directory |
|
142 |
+---------------------- |
|
140 | 143 |
|
141 |
-Set DevStack install directory |
|
142 | 144 |
| *Default: ``DEST=/opt/stack``* |
143 | 145 |
| The DevStack install directory is set by the ``DEST`` variable. |
144 | 146 |
| By setting it early in the ``localrc`` section you can reference it |
... | ... |
@@ -150,7 +152,27 @@ Set DevStack install directory |
150 | 150 |
|
151 | 151 |
DEST=/opt/stack |
152 | 152 |
|
153 |
-stack.sh logging |
|
153 |
+Libraries from Git |
|
154 |
+------------------ |
|
155 |
+ |
|
156 |
+ | *Default: ``LIBS_FROM_GIT=""``* |
|
157 |
+ |
|
158 |
+ | By default devstack installs OpenStack server components from |
|
159 |
+ git, however it installs client libraries from released versions |
|
160 |
+ on pypi. This is appropriate if you are working on server |
|
161 |
+ development, but if you want to see how an unreleased version of |
|
162 |
+ the client affects the system you can have devstack install it |
|
163 |
+ from upstream, or from local git trees. |
|
164 |
+ | Multiple libraries can be specified as a comma separated list. |
|
165 |
+ | |
|
166 |
+ |
|
167 |
+ :: |
|
168 |
+ |
|
169 |
+ LIBS_FROM_GIT=python-keystoneclient,oslo.config |
|
170 |
+ |
|
171 |
+Enable Logging |
|
172 |
+-------------- |
|
173 |
+ |
|
154 | 174 |
| *Defaults: ``LOGFILE="" LOGDAYS=7 LOG_COLOR=True``* |
155 | 175 |
| By default ``stack.sh`` output is only written to the console |
156 | 176 |
where is runs. It can be sent to a file in addition to the console |
... | ... |
@@ -178,7 +200,9 @@ stack.sh logging |
178 | 178 |
|
179 | 179 |
LOG_COLOR=False |
180 | 180 |
|
181 |
-Screen logging |
|
181 |
+Logging the Screen Output |
|
182 |
+------------------------- |
|
183 |
+ |
|
182 | 184 |
| *Default: ``SCREEN_LOGDIR=""``* |
183 | 185 |
| By default DevStack runs the OpenStack services using ``screen`` |
184 | 186 |
which is useful for watching log and debug output. However, in |
... | ... |
@@ -196,7 +220,9 @@ Screen logging |
196 | 196 |
*Note the use of ``DEST`` to locate the main install directory; this |
197 | 197 |
is why we suggest setting it in ``local.conf``.* |
198 | 198 |
|
199 |
-One syslog to bind them all |
|
199 |
+Enabling Syslog |
|
200 |
+--------------- |
|
201 |
+ |
|
200 | 202 |
| *Default: ``SYSLOG=False SYSLOG_HOST=$HOST_IP SYSLOG_PORT=516``* |
201 | 203 |
| Logging all services to a single syslog can be convenient. Enable |
202 | 204 |
syslogging by setting ``SYSLOG`` to ``True``. If the destination log |
... | ... |
@@ -211,6 +237,8 @@ One syslog to bind them all |
211 | 211 |
SYSLOG_PORT=516 |
212 | 212 |
|
213 | 213 |
A clean install every time |
214 |
+-------------------------- |
|
215 |
+ |
|
214 | 216 |
| *Default: ``RECLONE=""``* |
215 | 217 |
| By default ``stack.sh`` only clones the project repos if they do |
216 | 218 |
not exist in ``$DEST``. ``stack.sh`` will freshen each repo on each |
... | ... |
@@ -222,10 +250,18 @@ A clean install every time |
222 | 222 |
|
223 | 223 |
RECLONE=yes |
224 | 224 |
|
225 |
- Swift |
|
226 |
- Default: SWIFT_HASH="" SWIFT_REPLICAS=1 SWIFT_DATA_DIR=$DEST/data/swift |
|
227 |
- Swift is now used as the back-end for the S3-like object store. When enabled Nova's objectstore (n-obj in ENABLED_SERVICES) is automatically disabled. Enable Swift by adding it services to ENABLED_SERVICES: |
|
228 |
- enable_service s-proxy s-object s-container s-account |
|
225 |
+Swift |
|
226 |
+----- |
|
227 |
+ |
|
228 |
+ | Default: SWIFT_HASH="" |
|
229 |
+ | SWIFT_REPLICAS=1 |
|
230 |
+ | SWIFT_DATA_DIR=$DEST/data/swift |
|
231 |
+ |
|
232 |
+ | Swift is now used as the back-end for the S3-like object store. |
|
233 |
+ When enabled Nova's objectstore (n-obj in ENABLED_SERVICES) is |
|
234 |
+ automatically disabled. Enable Swift by adding it services to |
|
235 |
+ ENABLED_SERVICES: enable_service s-proxy s-object s-container |
|
236 |
+ s-account |
|
229 | 237 |
|
230 | 238 |
Setting Swift's hash value is required and you will be prompted for |
231 | 239 |
it if Swift is enabled so just set it to something already: |
... | ... |
@@ -259,6 +295,8 @@ A clean install every time |
259 | 259 |
work correctly.* |
260 | 260 |
|
261 | 261 |
Service Catalog Backend |
262 |
+----------------------- |
|
263 |
+ |
|
262 | 264 |
| *Default: ``KEYSTONE_CATALOG_BACKEND=sql``* |
263 | 265 |
| DevStack uses Keystone's ``sql`` service catalog backend. An |
264 | 266 |
alternate ``template`` backend is also available. However, it does |
... | ... |
@@ -274,6 +312,8 @@ Service Catalog Backend |
274 | 274 |
``files/keystone_data.sh`` |
275 | 275 |
|
276 | 276 |
Cinder |
277 |
+------ |
|
278 |
+ |
|
277 | 279 |
| Default: |
278 | 280 |
| VOLUME_GROUP="stack-volumes" VOLUME_NAME_PREFIX="volume-" VOLUME_BACKING_FILE_SIZE=10250M |
279 | 281 |
| The logical volume group used to hold the Cinder-managed volumes |
... | ... |
@@ -289,6 +329,8 @@ Cinder |
289 | 289 |
VOLUME_BACKING_FILE_SIZE=10250M |
290 | 290 |
|
291 | 291 |
Multi-host DevStack |
292 |
+------------------- |
|
293 |
+ |
|
292 | 294 |
| *Default: ``MULTI_HOST=False``* |
293 | 295 |
| Running DevStack with multiple hosts requires a custom |
294 | 296 |
``local.conf`` section for each host. The master is the same as a |
... | ... |
@@ -311,6 +353,8 @@ Multi-host DevStack |
311 | 311 |
ENABLED_SERVICES=n-vol,n-cpu,n-net,n-api |
312 | 312 |
|
313 | 313 |
API rate limits |
314 |
+--------------- |
|
315 |
+ |
|
314 | 316 |
| Default: ``API_RATE_LIMIT=True`` |
315 | 317 |
| Integration tests such as Tempest will likely run afoul of the |
316 | 318 |
default rate limits configured for Nova. Turn off rate limiting |
... | ... |
@@ -322,7 +366,7 @@ API rate limits |
322 | 322 |
API_RATE_LIMIT=False |
323 | 323 |
|
324 | 324 |
Examples |
325 |
-~~~~~~~~ |
|
325 |
+======== |
|
326 | 326 |
|
327 | 327 |
- Eliminate a Cinder pass-through (``CINDER_PERIODIC_INTERVAL``): |
328 | 328 |
|
... | ... |
@@ -134,6 +134,19 @@ REQUIREMENTS_MODE=${REQUIREMENTS_MODE:-strict} |
134 | 134 |
# Another option is https://git.openstack.org |
135 | 135 |
GIT_BASE=${GIT_BASE:-git://git.openstack.org} |
136 | 136 |
|
137 |
+# Which libraries should we install from git instead of using released |
|
138 |
+# versions on pypi? |
|
139 |
+# |
|
140 |
+# By default devstack is now installing libraries from pypi instead of |
|
141 |
+# from git repositories by default. This works great if you are |
|
142 |
+# developing server components, but if you want to develop libraries |
|
143 |
+# and see them live in devstack you need to tell devstack it should |
|
144 |
+# install them from git. |
|
145 |
+# |
|
146 |
+# ex: LIBS_FROM_GIT=python-keystoneclient,oslo.config |
|
147 |
+# |
|
148 |
+# Will install those 2 libraries from git, the rest from pypi. |
|
149 |
+ |
|
137 | 150 |
############## |
138 | 151 |
# |
139 | 152 |
# OpenStack Server Components |