blob: 6d5351f904f3bb6ecbc6a3dc14973a0fcfd4adfa [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
venkatamaheshd55513a2016-07-19 17:34:20 +053013# in http://docs.openstack.org/developer/devstack/configuration.html#local-conf
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
Steve Martinelli923be5f2015-12-20 00:24:19 -050026# If the ``*_PASSWORD`` variables are not set here you will be prompted to enter
27# values for them by ``stack.sh``and they will be added to ``local.conf``.
Balagopal7ed812c2016-03-01 04:43:31 +000028ADMIN_PASSWORD=nomoresecret
Swapnil (coolsvap) Kulkarnic988bf62015-10-08 13:10:43 +053029DATABASE_PASSWORD=stackdb
Dean Troyerf5633dd2012-03-28 11:21:40 -050030RABBIT_PASSWORD=stackqueue
31SERVICE_PASSWORD=$ADMIN_PASSWORD
32
Brian Haley180f5eb2015-06-16 13:14:31 -040033# ``HOST_IP`` and ``HOST_IPV6`` should be set manually for best results if
34# the NIC configuration of the host is unusual, i.e. ``eth1`` has the default
35# route but ``eth0`` is the public interface. They are auto-detected in
36# ``stack.sh`` but often is indeterminate on later runs due to the IP moving
37# from an Ethernet interface to a bridge on the host. Setting it here also
38# makes it available for ``openrc`` to include when setting ``OS_AUTH_URL``.
39# Neither is set by default.
Dean Troyer5547baa2012-08-31 10:55:36 -050040#HOST_IP=w.x.y.z
Brian Haley180f5eb2015-06-16 13:14:31 -040041#HOST_IPV6=2001:db8::7
Dean Troyerf5633dd2012-03-28 11:21:40 -050042
43
Dean Troyer5547baa2012-08-31 10:55:36 -050044# Logging
45# -------
Dean Troyerf5633dd2012-03-28 11:21:40 -050046
Dean Troyer5547baa2012-08-31 10:55:36 -050047# By default ``stack.sh`` output only goes to the terminal where it runs. It can
48# be configured to additionally log to a file by setting ``LOGFILE`` to the full
49# path of the destination log file. A timestamp will be appended to the given name.
50LOGFILE=$DEST/logs/stack.sh.log
51
52# Old log files are automatically removed after 7 days to keep things neat. Change
53# the number of days by setting ``LOGDAYS``.
54LOGDAYS=2
55
56# Nova logs will be colorized if ``SYSLOG`` is not set; turn this off by setting
57# ``LOG_COLOR`` false.
58#LOG_COLOR=False
Dean Troyerf5633dd2012-03-28 11:21:40 -050059
60
61# Using milestone-proposed branches
62# ---------------------------------
63
vsaienkobe3e5532015-11-23 16:07:21 +020064# Uncomment these to grab the milestone-proposed branches from the
65# repos:
Dean Troyer5547baa2012-08-31 10:55:36 -050066#CINDER_BRANCH=milestone-proposed
Dean Troyerf5633dd2012-03-28 11:21:40 -050067#GLANCE_BRANCH=milestone-proposed
68#HORIZON_BRANCH=milestone-proposed
69#KEYSTONE_BRANCH=milestone-proposed
70#KEYSTONECLIENT_BRANCH=milestone-proposed
71#NOVA_BRANCH=milestone-proposed
72#NOVACLIENT_BRANCH=milestone-proposed
Mark McClainb05c8762013-07-06 23:29:39 -040073#NEUTRON_BRANCH=milestone-proposed
Dean Troyerf5633dd2012-03-28 11:21:40 -050074#SWIFT_BRANCH=milestone-proposed
75
vsaienkobe3e5532015-11-23 16:07:21 +020076# Using git versions of clients
77# -----------------------------
78# By default clients are installed from pip. See LIBS_FROM_GIT in
79# stackrc for details on getting clients from specific branches or
80# revisions. e.g.
81# LIBS_FROM_GIT="python-ironicclient"
82# IRONICCLIENT_BRANCH=refs/changes/44/2.../1
Dean Troyerf5633dd2012-03-28 11:21:40 -050083
84# Swift
85# -----
86
Davanum Srinivas4a974e62016-01-11 22:10:43 -050087# Swift is now used as the back-end for the S3-like object store. Setting the
88# hash value is required and you will be prompted for it if Swift is enabled
89# so just set it to something already:
Dean Troyerf5633dd2012-03-28 11:21:40 -050090SWIFT_HASH=66a3d6b56c1f479c8b4e70ab5c2000f5
91
92# For development purposes the default of 3 replicas is usually not required.
93# Set this to 1 to save some resources:
94SWIFT_REPLICAS=1
95
Florent Flamentd5644f82013-10-11 15:39:09 +020096# The data for Swift is stored by default in (``$DEST/data/swift``),
97# or (``$DATA_DIR/swift``) if ``DATA_DIR`` has been set, and can be
98# moved by setting ``SWIFT_DATA_DIR``. The directory will be created
Dean Troyerf5633dd2012-03-28 11:21:40 -050099# if it does not exist.
100SWIFT_DATA_DIR=$DEST/data