blob: bcaa788a8b34a77a5ca16653961e6ac59440b184 [file] [log] [blame]
Dean Troyerf5633dd2012-03-28 11:21:40 -05001# Sample ``localrc`` for user-configurable variables in ``stack.sh``
2
Dean Troyer5547baa2012-08-31 10:55:36 -05003# NOTE: Copy this file to the root ``devstack`` directory for it to
4# work properly.
Dean Troyerf5633dd2012-03-28 11:21:40 -05005
Dean Troyer5547baa2012-08-31 10:55:36 -05006# ``localrc`` is a user-maintained setings file that is sourced from ``stackrc``.
7# This gives it the ability to override any variables set in ``stackrc``.
Dean Troyerf5633dd2012-03-28 11:21:40 -05008# Also, most of the settings in ``stack.sh`` are written to only be set if no
9# value has already been set; this lets ``localrc`` effectively override the
10# default values.
11
12# This is a collection of some of the settings we have found to be useful
13# in our DevStack development environments. Additional settings are described
14# in http://devstack.org/localrc.html
15# These should be considered as samples and are unsupported DevStack code.
16
17
18# Minimal Contents
19# ----------------
20
21# While ``stack.sh`` is happy to run without ``localrc``, devlife is better when
22# there are a few minimal variables set:
23
24# If the ``*_PASSWORD`` variables are not set here you will be prompted to enter
Dean Troyer5547baa2012-08-31 10:55:36 -050025# values for them by ``stack.sh`` and they will be added to ``localrc``.
Dean Troyerf5633dd2012-03-28 11:21:40 -050026ADMIN_PASSWORD=nomoresecrete
27MYSQL_PASSWORD=stackdb
28RABBIT_PASSWORD=stackqueue
29SERVICE_PASSWORD=$ADMIN_PASSWORD
30
Dean Troyer5547baa2012-08-31 10:55:36 -050031# ``HOST_IP`` should be set manually for best results if the NIC configuration
32# of the host is unusual, i.e. ``eth1`` has the default route but ``eth0`` is the
33# public interface. It is auto-detected in ``stack.sh`` but often is indeterminate
34# on later runs due to the IP moving from an Ethernet interface to a bridge on
35# the host. Setting it here also makes it available for ``openrc`` to include
36# when setting ``OS_AUTH_URL``.
Dean Troyerf5633dd2012-03-28 11:21:40 -050037# ``HOST_IP`` is not set by default.
Dean Troyer5547baa2012-08-31 10:55:36 -050038#HOST_IP=w.x.y.z
Dean Troyerf5633dd2012-03-28 11:21:40 -050039
40
Dean Troyer5547baa2012-08-31 10:55:36 -050041# Logging
42# -------
Dean Troyerf5633dd2012-03-28 11:21:40 -050043
Dean Troyer5547baa2012-08-31 10:55:36 -050044# By default ``stack.sh`` output only goes to the terminal where it runs. It can
45# be configured to additionally log to a file by setting ``LOGFILE`` to the full
46# path of the destination log file. A timestamp will be appended to the given name.
47LOGFILE=$DEST/logs/stack.sh.log
48
49# Old log files are automatically removed after 7 days to keep things neat. Change
50# the number of days by setting ``LOGDAYS``.
51LOGDAYS=2
52
53# Nova logs will be colorized if ``SYSLOG`` is not set; turn this off by setting
54# ``LOG_COLOR`` false.
55#LOG_COLOR=False
Dean Troyerf5633dd2012-03-28 11:21:40 -050056
57
58# Using milestone-proposed branches
59# ---------------------------------
60
61# Uncomment these to grab the milestone-proposed branches from the repos:
Dean Troyer5547baa2012-08-31 10:55:36 -050062#CINDER_BRANCH=milestone-proposed
Dean Troyerf5633dd2012-03-28 11:21:40 -050063#GLANCE_BRANCH=milestone-proposed
64#HORIZON_BRANCH=milestone-proposed
65#KEYSTONE_BRANCH=milestone-proposed
66#KEYSTONECLIENT_BRANCH=milestone-proposed
67#NOVA_BRANCH=milestone-proposed
68#NOVACLIENT_BRANCH=milestone-proposed
Dean Troyer5547baa2012-08-31 10:55:36 -050069#QUANTUM_BRANCH=milestone-proposed
Dean Troyerf5633dd2012-03-28 11:21:40 -050070#SWIFT_BRANCH=milestone-proposed
71
72
73# Swift
74# -----
75
76# Swift is now used as the back-end for the S3-like object store. If Nova's
77# objectstore (``n-obj`` in ``ENABLED_SERVICES``) is enabled, it will NOT
78# run if Swift is enabled. Setting the hash value is required and you will
79# be prompted for it if Swift is enabled so just set it to something already:
80SWIFT_HASH=66a3d6b56c1f479c8b4e70ab5c2000f5
81
82# For development purposes the default of 3 replicas is usually not required.
83# Set this to 1 to save some resources:
84SWIFT_REPLICAS=1
85
86# The data for Swift is stored in the source tree by default (``$DEST/swift/data``)
87# and can be moved by setting ``SWIFT_DATA_DIR``. The directory will be created
88# if it does not exist.
89SWIFT_DATA_DIR=$DEST/data