blob: 34c9e8b48eed46e6b6cf44e13e3f4034a49bd8e9 [file] [log] [blame]
Dean Troyer38e38fb2014-01-10 12:05:51 -06001# Sample ``local.conf`` for user-configurable variables in ``stack.sh``
Dean Troyerf5633dd2012-03-28 11:21:40 -05002
Dean Troyerdc97cb72015-03-28 08:20:50 -05003# NOTE: Copy this file to the root DevStack directory for it to work properly.
Dean Troyerf5633dd2012-03-28 11:21:40 -05004
Baohua Yang82450a52015-03-05 17:14:06 +08005# ``local.conf`` is a user-maintained settings file that is sourced from ``stackrc``.
Dean Troyer5547baa2012-08-31 10:55:36 -05006# This gives it the ability to override any variables set in ``stackrc``.
Dean Troyerf5633dd2012-03-28 11:21:40 -05007# Also, most of the settings in ``stack.sh`` are written to only be set if no
Dean Troyer38e38fb2014-01-10 12:05:51 -06008# value has already been set; this lets ``local.conf`` effectively override the
Dean Troyerf5633dd2012-03-28 11:21:40 -05009# default values.
10
11# This is a collection of some of the settings we have found to be useful
12# in our DevStack development environments. Additional settings are described
Dean Troyer38e38fb2014-01-10 12:05:51 -060013# in http://devstack.org/local.conf.html
Dean Troyerf5633dd2012-03-28 11:21:40 -050014# These should be considered as samples and are unsupported DevStack code.
15
Dean Troyer38e38fb2014-01-10 12:05:51 -060016# The ``localrc`` section replaces the old ``localrc`` configuration file.
17# Note that if ``localrc`` is present it will be used in favor of this section.
18[[local|localrc]]
Dean Troyerf5633dd2012-03-28 11:21:40 -050019
20# Minimal Contents
21# ----------------
22
23# While ``stack.sh`` is happy to run without ``localrc``, devlife is better when
24# there are a few minimal variables set:
25
Georges Dubus5753eb82014-07-22 09:45:03 +000026# If the ``SERVICE_TOKEN`` and ``*_PASSWORD`` variables are not set
27# here you will be prompted to enter values for them by ``stack.sh``
28# and they will be added to ``local.conf``.
29SERVICE_TOKEN=azertytoken
Dean Troyerf5633dd2012-03-28 11:21:40 -050030ADMIN_PASSWORD=nomoresecrete
Swapnil (coolsvap) Kulkarnic988bf62015-10-08 13:10:43 +053031DATABASE_PASSWORD=stackdb
Dean Troyerf5633dd2012-03-28 11:21:40 -050032RABBIT_PASSWORD=stackqueue
33SERVICE_PASSWORD=$ADMIN_PASSWORD
34
Brian Haley180f5eb2015-06-16 13:14:31 -040035# ``HOST_IP`` and ``HOST_IPV6`` should be set manually for best results if
36# the NIC configuration of the host is unusual, i.e. ``eth1`` has the default
37# route but ``eth0`` is the public interface. They are auto-detected in
38# ``stack.sh`` but often is indeterminate on later runs due to the IP moving
39# from an Ethernet interface to a bridge on the host. Setting it here also
40# makes it available for ``openrc`` to include when setting ``OS_AUTH_URL``.
41# Neither is set by default.
Dean Troyer5547baa2012-08-31 10:55:36 -050042#HOST_IP=w.x.y.z
Brian Haley180f5eb2015-06-16 13:14:31 -040043#HOST_IPV6=2001:db8::7
Dean Troyerf5633dd2012-03-28 11:21:40 -050044
45
Dean Troyer5547baa2012-08-31 10:55:36 -050046# Logging
47# -------
Dean Troyerf5633dd2012-03-28 11:21:40 -050048
Dean Troyer5547baa2012-08-31 10:55:36 -050049# By default ``stack.sh`` output only goes to the terminal where it runs. It can
50# be configured to additionally log to a file by setting ``LOGFILE`` to the full
51# path of the destination log file. A timestamp will be appended to the given name.
52LOGFILE=$DEST/logs/stack.sh.log
53
54# Old log files are automatically removed after 7 days to keep things neat. Change
55# the number of days by setting ``LOGDAYS``.
56LOGDAYS=2
57
58# Nova logs will be colorized if ``SYSLOG`` is not set; turn this off by setting
59# ``LOG_COLOR`` false.
60#LOG_COLOR=False
Dean Troyerf5633dd2012-03-28 11:21:40 -050061
62
63# Using milestone-proposed branches
64# ---------------------------------
65
vsaienkobe3e5532015-11-23 16:07:21 +020066# Uncomment these to grab the milestone-proposed branches from the
67# repos:
Dean Troyer5547baa2012-08-31 10:55:36 -050068#CINDER_BRANCH=milestone-proposed
Dean Troyerf5633dd2012-03-28 11:21:40 -050069#GLANCE_BRANCH=milestone-proposed
70#HORIZON_BRANCH=milestone-proposed
71#KEYSTONE_BRANCH=milestone-proposed
72#KEYSTONECLIENT_BRANCH=milestone-proposed
73#NOVA_BRANCH=milestone-proposed
74#NOVACLIENT_BRANCH=milestone-proposed
Mark McClainb05c8762013-07-06 23:29:39 -040075#NEUTRON_BRANCH=milestone-proposed
Dean Troyerf5633dd2012-03-28 11:21:40 -050076#SWIFT_BRANCH=milestone-proposed
77
vsaienkobe3e5532015-11-23 16:07:21 +020078# Using git versions of clients
79# -----------------------------
80# By default clients are installed from pip. See LIBS_FROM_GIT in
81# stackrc for details on getting clients from specific branches or
82# revisions. e.g.
83# LIBS_FROM_GIT="python-ironicclient"
84# IRONICCLIENT_BRANCH=refs/changes/44/2.../1
Dean Troyerf5633dd2012-03-28 11:21:40 -050085
86# Swift
87# -----
88
89# Swift is now used as the back-end for the S3-like object store. If Nova's
90# objectstore (``n-obj`` in ``ENABLED_SERVICES``) is enabled, it will NOT
91# run if Swift is enabled. Setting the hash value is required and you will
92# be prompted for it if Swift is enabled so just set it to something already:
93SWIFT_HASH=66a3d6b56c1f479c8b4e70ab5c2000f5
94
95# For development purposes the default of 3 replicas is usually not required.
96# Set this to 1 to save some resources:
97SWIFT_REPLICAS=1
98
Florent Flamentd5644f82013-10-11 15:39:09 +020099# The data for Swift is stored by default in (``$DEST/data/swift``),
100# or (``$DATA_DIR/swift``) if ``DATA_DIR`` has been set, and can be
101# moved by setting ``SWIFT_DATA_DIR``. The directory will be created
Dean Troyerf5633dd2012-03-28 11:21:40 -0500102# if it does not exist.
103SWIFT_DATA_DIR=$DEST/data