Add local.conf.sample for devstack deployment of Doctor
[doctor.git] / devstack / local.conf.sample
1 # Sample ``local.conf`` for user-configurable variables in ``stack.sh``
2
3 # NOTE: Copy this file to the root DevStack directory for it to work properly.
4
5 # ``local.conf`` is a user-maintained settings file that is sourced from ``stackrc``.
6 # This gives it the ability to override any variables set in ``stackrc``.
7 # Also, most of the settings in ``stack.sh`` are written to only be set if no
8 # value has already been set; this lets ``local.conf`` effectively override the
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
13 # in https://docs.openstack.org/devstack/latest/configuration.html#local-conf
14 # These should be considered as samples and are unsupported DevStack code.
15
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]]
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
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``.
28 ADMIN_PASSWORD=devstack
29 DATABASE_PASSWORD=$ADMIN_PASSWORD
30 RABBIT_PASSWORD=$ADMIN_PASSWORD
31 SERVICE_PASSWORD=$ADMIN_PASSWORD
32
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.
40 HOST_IP=127.0.0.1
41 #HOST_IPV6=2001:db8::7
42
43
44 # Logging
45 # -------
46
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
59
60
61 # Using milestone-proposed branches
62 # ---------------------------------
63
64 # Uncomment these to grab the milestone-proposed branches from the
65 # repos:
66 #CINDER_BRANCH=milestone-proposed
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
73 #NEUTRON_BRANCH=milestone-proposed
74 #SWIFT_BRANCH=milestone-proposed
75
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
83
84 # Swift
85 # -----
86
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:
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
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
99 # if it does not exist.
100 SWIFT_DATA_DIR=$DEST/data
101
102 # OPNFV Doctor
103 # ------------
104
105 # Enable the required plugins
106 # The order of enabling plugins matters
107 enable_plugin aodh http://git.openstack.org/openstack/aodh
108 enable_plugin panko https://git.openstack.org/openstack/panko
109 enable_plugin ceilometer https://git.openstack.org/openstack/ceilometer
110 enable_plugin osprofiler https://git.openstack.org/openstack/osprofiler
111 enable_plugin doctor https://git.opnfv.org/doctor
112
113 # To enable Python 3
114 # USE_PYTHON3=True
115
116 # To enable Congress as Doctor Inspector
117 # enable_plugin congress https://git.openstack.org/openstack/congress
118
119 # To enable Neutron port data plane status
120 # Q_ML2_PLUGIN_EXT_DRIVERS=data_plane_status