Dean Troyer | 38e38fb | 2014-01-10 12:05:51 -0600 | [diff] [blame^] | 1 | # Sample ``local.conf`` for user-configurable variables in ``stack.sh`` |
Dean Troyer | f5633dd | 2012-03-28 11:21:40 -0500 | [diff] [blame] | 2 | |
Dean Troyer | 5547baa | 2012-08-31 10:55:36 -0500 | [diff] [blame] | 3 | # NOTE: Copy this file to the root ``devstack`` directory for it to |
| 4 | # work properly. |
Dean Troyer | f5633dd | 2012-03-28 11:21:40 -0500 | [diff] [blame] | 5 | |
Dean Troyer | 38e38fb | 2014-01-10 12:05:51 -0600 | [diff] [blame^] | 6 | # ``local.conf`` is a user-maintained setings file that is sourced from ``stackrc``. |
Dean Troyer | 5547baa | 2012-08-31 10:55:36 -0500 | [diff] [blame] | 7 | # This gives it the ability to override any variables set in ``stackrc``. |
Dean Troyer | f5633dd | 2012-03-28 11:21:40 -0500 | [diff] [blame] | 8 | # Also, most of the settings in ``stack.sh`` are written to only be set if no |
Dean Troyer | 38e38fb | 2014-01-10 12:05:51 -0600 | [diff] [blame^] | 9 | # value has already been set; this lets ``local.conf`` effectively override the |
Dean Troyer | f5633dd | 2012-03-28 11:21:40 -0500 | [diff] [blame] | 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 |
Dean Troyer | 38e38fb | 2014-01-10 12:05:51 -0600 | [diff] [blame^] | 14 | # in http://devstack.org/local.conf.html |
Dean Troyer | f5633dd | 2012-03-28 11:21:40 -0500 | [diff] [blame] | 15 | # These should be considered as samples and are unsupported DevStack code. |
| 16 | |
Dean Troyer | 38e38fb | 2014-01-10 12:05:51 -0600 | [diff] [blame^] | 17 | # The ``localrc`` section replaces the old ``localrc`` configuration file. |
| 18 | # Note that if ``localrc`` is present it will be used in favor of this section. |
| 19 | [[local|localrc]] |
Dean Troyer | f5633dd | 2012-03-28 11:21:40 -0500 | [diff] [blame] | 20 | |
| 21 | # Minimal Contents |
| 22 | # ---------------- |
| 23 | |
| 24 | # While ``stack.sh`` is happy to run without ``localrc``, devlife is better when |
| 25 | # there are a few minimal variables set: |
| 26 | |
| 27 | # If the ``*_PASSWORD`` variables are not set here you will be prompted to enter |
Dean Troyer | 38e38fb | 2014-01-10 12:05:51 -0600 | [diff] [blame^] | 28 | # values for them by ``stack.sh`` and they will be added to ``local.conf``. |
Dean Troyer | f5633dd | 2012-03-28 11:21:40 -0500 | [diff] [blame] | 29 | ADMIN_PASSWORD=nomoresecrete |
| 30 | MYSQL_PASSWORD=stackdb |
| 31 | RABBIT_PASSWORD=stackqueue |
| 32 | SERVICE_PASSWORD=$ADMIN_PASSWORD |
| 33 | |
Dean Troyer | 5547baa | 2012-08-31 10:55:36 -0500 | [diff] [blame] | 34 | # ``HOST_IP`` should be set manually for best results if the NIC configuration |
| 35 | # of the host is unusual, i.e. ``eth1`` has the default route but ``eth0`` is the |
| 36 | # public interface. It is auto-detected in ``stack.sh`` but often is indeterminate |
| 37 | # on later runs due to the IP moving from an Ethernet interface to a bridge on |
| 38 | # the host. Setting it here also makes it available for ``openrc`` to include |
| 39 | # when setting ``OS_AUTH_URL``. |
Dean Troyer | f5633dd | 2012-03-28 11:21:40 -0500 | [diff] [blame] | 40 | # ``HOST_IP`` is not set by default. |
Dean Troyer | 5547baa | 2012-08-31 10:55:36 -0500 | [diff] [blame] | 41 | #HOST_IP=w.x.y.z |
Dean Troyer | f5633dd | 2012-03-28 11:21:40 -0500 | [diff] [blame] | 42 | |
| 43 | |
Dean Troyer | 5547baa | 2012-08-31 10:55:36 -0500 | [diff] [blame] | 44 | # Logging |
| 45 | # ------- |
Dean Troyer | f5633dd | 2012-03-28 11:21:40 -0500 | [diff] [blame] | 46 | |
Dean Troyer | 5547baa | 2012-08-31 10:55:36 -0500 | [diff] [blame] | 47 | # 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. |
| 50 | LOGFILE=$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``. |
| 54 | LOGDAYS=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 Troyer | f5633dd | 2012-03-28 11:21:40 -0500 | [diff] [blame] | 59 | |
| 60 | |
| 61 | # Using milestone-proposed branches |
| 62 | # --------------------------------- |
| 63 | |
| 64 | # Uncomment these to grab the milestone-proposed branches from the repos: |
Dean Troyer | 5547baa | 2012-08-31 10:55:36 -0500 | [diff] [blame] | 65 | #CINDER_BRANCH=milestone-proposed |
Dean Troyer | f5633dd | 2012-03-28 11:21:40 -0500 | [diff] [blame] | 66 | #GLANCE_BRANCH=milestone-proposed |
| 67 | #HORIZON_BRANCH=milestone-proposed |
| 68 | #KEYSTONE_BRANCH=milestone-proposed |
| 69 | #KEYSTONECLIENT_BRANCH=milestone-proposed |
| 70 | #NOVA_BRANCH=milestone-proposed |
| 71 | #NOVACLIENT_BRANCH=milestone-proposed |
Mark McClain | b05c876 | 2013-07-06 23:29:39 -0400 | [diff] [blame] | 72 | #NEUTRON_BRANCH=milestone-proposed |
Dean Troyer | f5633dd | 2012-03-28 11:21:40 -0500 | [diff] [blame] | 73 | #SWIFT_BRANCH=milestone-proposed |
| 74 | |
| 75 | |
| 76 | # Swift |
| 77 | # ----- |
| 78 | |
| 79 | # Swift is now used as the back-end for the S3-like object store. If Nova's |
| 80 | # objectstore (``n-obj`` in ``ENABLED_SERVICES``) is enabled, it will NOT |
| 81 | # run if Swift is enabled. Setting the hash value is required and you will |
| 82 | # be prompted for it if Swift is enabled so just set it to something already: |
| 83 | SWIFT_HASH=66a3d6b56c1f479c8b4e70ab5c2000f5 |
| 84 | |
| 85 | # For development purposes the default of 3 replicas is usually not required. |
| 86 | # Set this to 1 to save some resources: |
| 87 | SWIFT_REPLICAS=1 |
| 88 | |
Florent Flament | d5644f8 | 2013-10-11 15:39:09 +0200 | [diff] [blame] | 89 | # The data for Swift is stored by default in (``$DEST/data/swift``), |
| 90 | # or (``$DATA_DIR/swift``) if ``DATA_DIR`` has been set, and can be |
| 91 | # moved by setting ``SWIFT_DATA_DIR``. The directory will be created |
Dean Troyer | f5633dd | 2012-03-28 11:21:40 -0500 | [diff] [blame] | 92 | # if it does not exist. |
| 93 | SWIFT_DATA_DIR=$DEST/data |