openstack/puppet-horizon
Code Issues Proposed changes

Do not hard-code REST_API_REQUIRED_SETTINGS

Browse Source 
The REST_API_REQUIRED_SETTINGS parameter defines a list of settings
available to the client side. Basically this parameter should be
defined according to the requirement by Horizon's implementation.

This change removes the current hard-code, because the default value
is now defined in Horizon itself. What is worse, the current value is
outdated and doesn't include some items, which would break Horizon's
functionality.

Closes-Bug: #1956904
Change-Id: Ie3c13d96e8219b4d80b0641f4def49b858f0513a
This commit is contained in:
Takashi Kajinami 2022-01-10 14:22:40 +09:00
parent e888297867
commit d48de6a482
2 changed files with 6 additions and 18 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

6
releasenotes/notes/bug-1956904-f4393eade5197c47.yaml Normal file
View File

@ -0,0 +1,6 @@
---
fixes:
- |
`Bug #1956904 <https://bugs.launchpad.net/puppet-horizon/+bug/1956904>`_:
The hard-coded ``REST_API_REQUIRED_SETTINGS`` parameter was removed, to use
the default value defined in Horizon itself.

18
templates/local_settings.py.erb
View File

@ -1006,24 +1006,6 @@ FILE_UPLOAD_TEMP_DIR = '<%= @file_upload_temp_dir %>'
OVERVIEW_DAYS_RANGE = <%= @overview_days_range %>
<% end %>
# AngularJS requires some settings to be made available to
# the client side. Some settings are required by in-tree / built-in horizon
# features. These settings must be added to REST_API_REQUIRED_SETTINGS in the
# form of ['SETTING_1','SETTING_2'], etc.
#
# You may remove settings from this list for security purposes, but do so at
# the risk of breaking a built-in horizon feature. These settings are required
# for horizon to function properly. Only remove them if you know what you
# are doing. These settings may in the future be moved to be defined within
# the enabled panel configuration.
# You should not add settings to this list for out of tree extensions.
# See: https://wiki.openstack.org/wiki/Horizon/RESTAPI
REST_API_REQUIRED_SETTINGS = ['OPENSTACK_HYPERVISOR_FEATURES',
'LAUNCH_INSTANCE_DEFAULTS',
'OPENSTACK_IMAGE_FORMATS',
'CREATE_IMAGE_DEFAULTS',
'OPENSTACK_KEYSTONE_BACKEND',]
# Additional settings can be made available to the client side for
# extensibility by specifying them in REST_API_ADDITIONAL_SETTINGS
# !! Please use extreme caution as the settings are transferred via HTTP/S