diff --git a/openstack_dashboard/local/local_settings.py.example b/openstack_dashboard/local/local_settings.py.example index 5f1ab10cc9..3d1061ceca 100644 --- a/openstack_dashboard/local/local_settings.py.example +++ b/openstack_dashboard/local/local_settings.py.example @@ -1,5 +1,17 @@ # -*- coding: utf-8 -*- +# ---------------------------------------------------------------------- +# NOTE: The default values of the settings are defined in +# openstack_dashboard/defaults.py. Prevously most available settings +# were listed in this example file, but it is no longer true. +# For available settings, see openstack_dashboard/defaults.py and +# the horizon setting reference found at +# https://docs.openstack.org/horizon/latest/configuration/settings.html. +# +# Django related settings and HORIZON_CONFIG still exist here. +# Keep in my mind that they will be revisit in upcoming releases. +# ---------------------------------------------------------------------- + import os from django.utils.translation import ugettext_lazy as _ @@ -388,21 +400,3 @@ SECURITY_GROUP_RULES = { # Help URL can be made available for the client. To provide a help URL, edit the # following attribute to the URL of your choice. #HORIZON_CONFIG["help_url"] = "http://openstack.mycompany.org" - -# Settings for OperationLogMiddleware -# OPERATION_LOG_ENABLED is flag to use the function to log an operation on -# Horizon. -# mask_targets is arrangement for appointing a target to mask. -# method_targets is arrangement of HTTP method to output log. -# format is the log contents. -#OPERATION_LOG_ENABLED = False -#OPERATION_LOG_OPTIONS = { -# 'mask_fields': ['password'], -# 'target_methods': ['POST'], -# 'ignored_urls': ['/js/', '/static/', '^/api/'], -# 'format': ("[%(client_ip)s] [%(domain_name)s]" -# " [%(domain_id)s] [%(project_name)s]" -# " [%(project_id)s] [%(user_name)s] [%(user_id)s] [%(request_scheme)s]" -# " [%(referer_url)s] [%(request_url)s] [%(message)s] [%(method)s]" -# " [%(http_status)s] [%(param)s]"), -#} diff --git a/releasenotes/notes/default-settings-moved-1e6a60408c47e2e2.yaml b/releasenotes/notes/default-settings-moved-1e6a60408c47e2e2.yaml new file mode 100644 index 0000000000..6b5323cbda --- /dev/null +++ b/releasenotes/notes/default-settings-moved-1e6a60408c47e2e2.yaml @@ -0,0 +1,14 @@ +--- +other: + - | + The default values of the settings listed in ``local_settings.py.example`` + in past releases have been moved to ``openstack_dashboard/defaults.py``. + By doing this, horizon can now provide the definitions of the default + settings more explicitly. + For the available settings, see ``openstack_dashboard/defaults.py`` and + the horizon setting reference found at + https://docs.openstack.org/horizon/latest/configuration/settings.html. + + Note that Django related settings and HORIZON_CONFIG still exist in + ``local_settings.py.example`` in this release and they will be revisited + in upcoming releases.