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 | dc97cb7 | 2015-03-28 08:20:50 -0500 | [diff] [blame] | 3 | # NOTE: Copy this file to the root DevStack directory for it to work properly. |
Dean Troyer | f5633dd | 2012-03-28 11:21:40 -0500 | [diff] [blame] | 4 | |
Baohua Yang | 82450a5 | 2015-03-05 17:14:06 +0800 | [diff] [blame] | 5 | # ``local.conf`` is a user-maintained settings file that is sourced from ``stackrc``. |
Dean Troyer | 5547baa | 2012-08-31 10:55:36 -0500 | [diff] [blame] | 6 | # This gives it the ability to override any variables set in ``stackrc``. |
Dean Troyer | f5633dd | 2012-03-28 11:21:40 -0500 | [diff] [blame] | 7 | # 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] | 8 | # value has already been set; this lets ``local.conf`` effectively override the |
Dean Troyer | f5633dd | 2012-03-28 11:21:40 -0500 | [diff] [blame] | 9 | # 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 |
venkatamahesh | d55513a | 2016-07-19 17:34:20 +0530 | [diff] [blame] | 13 | # in http://docs.openstack.org/developer/devstack/configuration.html#local-conf |
Dean Troyer | f5633dd | 2012-03-28 11:21:40 -0500 | [diff] [blame] | 14 | # These should be considered as samples and are unsupported DevStack code. |
| 15 | |
Dean Troyer | 38e38fb | 2014-01-10 12:05:51 -0600 | [diff] [blame] | 16 | # 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 Troyer | f5633dd | 2012-03-28 11:21:40 -0500 | [diff] [blame] | 19 | |
| 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 Martinelli | 923be5f | 2015-12-20 00:24:19 -0500 | [diff] [blame] | 26 | # 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``. |
Balagopal | 7ed812c | 2016-03-01 04:43:31 +0000 | [diff] [blame] | 28 | ADMIN_PASSWORD=nomoresecret |
Swapnil (coolsvap) Kulkarni | c988bf6 | 2015-10-08 13:10:43 +0530 | [diff] [blame] | 29 | DATABASE_PASSWORD=stackdb |
Dean Troyer | f5633dd | 2012-03-28 11:21:40 -0500 | [diff] [blame] | 30 | RABBIT_PASSWORD=stackqueue |
| 31 | SERVICE_PASSWORD=$ADMIN_PASSWORD |
| 32 | |
Brian Haley | 180f5eb | 2015-06-16 13:14:31 -0400 | [diff] [blame] | 33 | # ``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 Troyer | 5547baa | 2012-08-31 10:55:36 -0500 | [diff] [blame] | 40 | #HOST_IP=w.x.y.z |
Brian Haley | 180f5eb | 2015-06-16 13:14:31 -0400 | [diff] [blame] | 41 | #HOST_IPV6=2001:db8::7 |
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 | |
vsaienko | be3e553 | 2015-11-23 16:07:21 +0200 | [diff] [blame] | 64 | # Uncomment these to grab the milestone-proposed branches from the |
| 65 | # repos: |
Dean Troyer | 5547baa | 2012-08-31 10:55:36 -0500 | [diff] [blame] | 66 | #CINDER_BRANCH=milestone-proposed |
Dean Troyer | f5633dd | 2012-03-28 11:21:40 -0500 | [diff] [blame] | 67 | #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 McClain | b05c876 | 2013-07-06 23:29:39 -0400 | [diff] [blame] | 73 | #NEUTRON_BRANCH=milestone-proposed |
Dean Troyer | f5633dd | 2012-03-28 11:21:40 -0500 | [diff] [blame] | 74 | #SWIFT_BRANCH=milestone-proposed |
| 75 | |
vsaienko | be3e553 | 2015-11-23 16:07:21 +0200 | [diff] [blame] | 76 | # 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 Troyer | f5633dd | 2012-03-28 11:21:40 -0500 | [diff] [blame] | 83 | |
| 84 | # Swift |
| 85 | # ----- |
| 86 | |
Davanum Srinivas | 4a974e6 | 2016-01-11 22:10:43 -0500 | [diff] [blame] | 87 | # 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 Troyer | f5633dd | 2012-03-28 11:21:40 -0500 | [diff] [blame] | 90 | SWIFT_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: |
| 94 | SWIFT_REPLICAS=1 |
| 95 | |
Florent Flament | d5644f8 | 2013-10-11 15:39:09 +0200 | [diff] [blame] | 96 | # 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 Troyer | f5633dd | 2012-03-28 11:21:40 -0500 | [diff] [blame] | 99 | # if it does not exist. |
| 100 | SWIFT_DATA_DIR=$DEST/data |