openstack
/
horizon
Code Issues Proposed changes

Relnote: default values are moved to openstack_dashboard/defaults.py 

In Train release, we move most settings from local_settings.py.example
to openstack_dashboard/defaults.py. It is worth covered in the Train
release notes so that operators who depend on local_settings.py.example
can be aware of the change.

Also drops settings related to the operation log feature in
local_settings.py.example are as they are defined in
horizon/defaults.py (which is loaded by
openstack_dashboard/defaults.py).

Change-Id: Ib06925aef305ffa1545d10529acd42d04177f5e1
(cherry picked from commit d8d44de5d3)
This commit is contained in:
Akihiro Motoki 2019-10-02 23:48:07 +09:00
parent 5c284f228a
commit 35dc4814e4
2 changed files with 26 additions and 18 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

30
openstack_dashboard/local/local_settings.py.example
View File

@ -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]"),
#}

14
releasenotes/notes/default-settings-moved-1e6a60408c47e2e2.yaml Normal file
View File

@ -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.