diff options
| -rw-r--r-- | devstack/README.rst | 4 | ||||
| -rw-r--r-- | devstack/local.conf.sample | 120 |
2 files changed, 123 insertions, 1 deletions
diff --git a/devstack/README.rst b/devstack/README.rst index 91e8abfe..aaa18a7f 100644 --- a/devstack/README.rst +++ b/devstack/README.rst @@ -18,7 +18,9 @@ OPNFV Doctor in DevStack. enable_plugin osprofiler https://git.openstack.org/openstack/osprofiler enable_plugin doctor https://git.opnfv.org/doctor -to the ``[[local|localrc]]`` section. +to the ``[[local|localrc]]`` section. Or, you can copy the local.conf.sample:: + + cp /<path-to-doctor>/devstack/local.conf.sample ${DEVSTACK_DIR}/local.conf .. note:: The order of enabling plugins matters. diff --git a/devstack/local.conf.sample b/devstack/local.conf.sample new file mode 100644 index 00000000..2967714a --- /dev/null +++ b/devstack/local.conf.sample @@ -0,0 +1,120 @@ +# Sample ``local.conf`` for user-configurable variables in ``stack.sh`` + +# NOTE: Copy this file to the root DevStack directory for it to work properly. + +# ``local.conf`` is a user-maintained settings file that is sourced from ``stackrc``. +# This gives it the ability to override any variables set in ``stackrc``. +# Also, most of the settings in ``stack.sh`` are written to only be set if no +# value has already been set; this lets ``local.conf`` effectively override the +# default values. + +# This is a collection of some of the settings we have found to be useful +# in our DevStack development environments. Additional settings are described +# in https://docs.openstack.org/devstack/latest/configuration.html#local-conf +# These should be considered as samples and are unsupported DevStack code. + +# The ``localrc`` section replaces the old ``localrc`` configuration file. +# Note that if ``localrc`` is present it will be used in favor of this section. +[[local|localrc]] + +# Minimal Contents +# ---------------- + +# While ``stack.sh`` is happy to run without ``localrc``, devlife is better when +# there are a few minimal variables set: + +# If the ``*_PASSWORD`` variables are not set here you will be prompted to enter +# values for them by ``stack.sh``and they will be added to ``local.conf``. +ADMIN_PASSWORD=devstack +DATABASE_PASSWORD=$ADMIN_PASSWORD +RABBIT_PASSWORD=$ADMIN_PASSWORD +SERVICE_PASSWORD=$ADMIN_PASSWORD + +# ``HOST_IP`` and ``HOST_IPV6`` should be set manually for best results if +# the NIC configuration of the host is unusual, i.e. ``eth1`` has the default +# route but ``eth0`` is the public interface. They are auto-detected in +# ``stack.sh`` but often is indeterminate on later runs due to the IP moving +# from an Ethernet interface to a bridge on the host. Setting it here also +# makes it available for ``openrc`` to include when setting ``OS_AUTH_URL``. +# Neither is set by default. +HOST_IP=127.0.0.1 +#HOST_IPV6=2001:db8::7 + + +# Logging +# ------- + +# By default ``stack.sh`` output only goes to the terminal where it runs. It can +# be configured to additionally log to a file by setting ``LOGFILE`` to the full +# path of the destination log file. A timestamp will be appended to the given name. +LOGFILE=$DEST/logs/stack.sh.log + +# Old log files are automatically removed after 7 days to keep things neat. Change +# the number of days by setting ``LOGDAYS``. +LOGDAYS=2 + +# Nova logs will be colorized if ``SYSLOG`` is not set; turn this off by setting +# ``LOG_COLOR`` false. +#LOG_COLOR=False + + +# Using milestone-proposed branches +# --------------------------------- + +# Uncomment these to grab the milestone-proposed branches from the +# repos: +#CINDER_BRANCH=milestone-proposed +#GLANCE_BRANCH=milestone-proposed +#HORIZON_BRANCH=milestone-proposed +#KEYSTONE_BRANCH=milestone-proposed +#KEYSTONECLIENT_BRANCH=milestone-proposed +#NOVA_BRANCH=milestone-proposed +#NOVACLIENT_BRANCH=milestone-proposed +#NEUTRON_BRANCH=milestone-proposed +#SWIFT_BRANCH=milestone-proposed + +# Using git versions of clients +# ----------------------------- +# By default clients are installed from pip. See LIBS_FROM_GIT in +# stackrc for details on getting clients from specific branches or +# revisions. e.g. +# LIBS_FROM_GIT="python-ironicclient" +# IRONICCLIENT_BRANCH=refs/changes/44/2.../1 + +# Swift +# ----- + +# Swift is now used as the back-end for the S3-like object store. Setting the +# hash value is required and you will be prompted for it if Swift is enabled +# so just set it to something already: +SWIFT_HASH=66a3d6b56c1f479c8b4e70ab5c2000f5 + +# For development purposes the default of 3 replicas is usually not required. +# Set this to 1 to save some resources: +SWIFT_REPLICAS=1 + +# The data for Swift is stored by default in (``$DEST/data/swift``), +# or (``$DATA_DIR/swift``) if ``DATA_DIR`` has been set, and can be +# moved by setting ``SWIFT_DATA_DIR``. The directory will be created +# if it does not exist. +SWIFT_DATA_DIR=$DEST/data + +# OPNFV Doctor +# ------------ + +# Enable the required plugins +# The order of enabling plugins matters +enable_plugin aodh http://git.openstack.org/openstack/aodh +enable_plugin panko https://git.openstack.org/openstack/panko +enable_plugin ceilometer https://git.openstack.org/openstack/ceilometer +enable_plugin osprofiler https://git.openstack.org/openstack/osprofiler +enable_plugin doctor https://git.opnfv.org/doctor + +# To enable Python 3 +# USE_PYTHON3=True + +# To enable Congress as Doctor Inspector +# enable_plugin congress https://git.openstack.org/openstack/congress + +# To enable Neutron port data plane status +# Q_ML2_PLUGIN_EXT_DRIVERS=data_plane_status |