openstack/horizon
Code Issues Proposed changes

Add "new in" tags to docs for new Icehouse settings

Browse Source 
Also re-alphabetize settings list

Change-Id: Ieb47e9f2a0be4906a744970a9d17dd5177e59fc0
Partial-Bug: #1300710
This commit is contained in:
Gary W. Smith 2014-05-07 15:52:53 -07:00
parent 92b2a3edd7
commit 83daca331a
1 changed files with 62 additions and 18 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

80
doc/source/topics/settings.rst
View File

@ -217,6 +217,26 @@ This example sorts flavors by vcpus in descending order::
'reverse': True,
}
``FLAVOR_EXTRA_KEYS``
---------------------
.. versionadded:: 2014.1(Icehouse)
Default::
{
'flavor_keys': [
('quota:read_bytes_sec', _('Quota: Read bytes')),
('quota:write_bytes_sec', _('Quota: Write bytes')),
('quota:cpu_quota', _('Quota: CPU')),
('quota:cpu_period', _('Quota: CPU period')),
('quota:inbound_average', _('Quota: Inbound average')),
('quota:outbound_average', _('Quota: Outbound average'))
]
}
Used to customize flavor extra specs keys
``IMAGES_LIST_FILTER_TENANTS``
------------------------------
@ -235,6 +255,8 @@ Example: ``[{'text': 'Official', 'tenant': '27d0058849da47c896d205e2fc25a5e8', '
``OPENSTACK_ENABLE_PASSWORD_RETRIEVE``
--------------------------------------
.. versionadded:: 2014.1(Icehouse)
Default: ``"False"``
When set, enables the instance action "Retrieve password" allowing password retrieval
@ -394,24 +416,6 @@ Default: ``"1800"``
Specifies the timespan in seconds inactivity, until a user is considered as
logged out.
``FLAVOR_EXTRA_KEYS``
---------------------
Default::
{
'flavor_keys': [
('quota:read_bytes_sec', _('Quota: Read bytes')),
('quota:write_bytes_sec', _('Quota: Write bytes')),
('quota:cpu_quota', _('Quota: CPU')),
('quota:cpu_period', _('Quota: CPU period')),
('quota:inbound_average', _('Quota: Inbound average')),
('quota:outbound_average', _('Quota: Outbound average'))
]
}
Used to customize flavor extra specs keys
Django Settings (Partial)
=========================
@ -472,6 +476,8 @@ are generally safe to use.
Pluggable Settings for Dashboards
=================================
.. versionadded:: 2014.1(Icehouse)
Many dashboards may require their own modifications to the settings, and their
installation would therefore require modifying the settings file. This is not
optimal, so the dashboards can provide the settings that they require in a
@ -493,27 +499,37 @@ The files contain following keys:
``DASHBOARD``
-------------
.. versionadded:: 2014.1(Icehouse)
The name of the dashboard to be added to ``HORIZON['dashboards']``. Required.
``DEFAULT``
-----------
.. versionadded:: 2014.1(Icehouse)
If set to ``True``, this dashboard will be set as the default dashboard.
``ADD_EXCEPTIONS``
------------------
.. versionadded:: 2014.1(Icehouse)
A dictionary of exception classes to be added to ``HORIZON['exceptions']``.
``ADD_INSTALLED_APPS``
----------------------
.. versionadded:: 2014.1(Icehouse)
A list of applications to be prepended to ``INSTALLED_APPS``.
This is needed to expose static files from a plugin.
``DISABLED``
------------
.. versionadded:: 2014.1(Icehouse)
If set to ``True``, this dashboard will not be added to the settings.
Examples
@ -544,6 +560,8 @@ create a file ``openstack_dashboard/local/enabled/_50_tuskar.py`` with::
Pluggable Settings for Panels
=============================
.. versionadded:: 2014.1(Icehouse)
Panels customization can be made by providing a custom python module that
contains python code to add or remove panel to/from the dashboard. This
requires altering the settings file. For panels provided by third-party,
@ -566,32 +584,44 @@ The files contain following keys:
``PANEL``
---------
.. versionadded:: 2014.1(Icehouse)
The name of the panel to be added to ``HORIZON_CONFIG``. Required.
``PANEL_DASHBOARD``
-------------------
.. versionadded:: 2014.1(Icehouse)
The name of the dashboard the ``PANEL`` associated with. Required.
``PANEL_GROUP``
---------------
.. versionadded:: 2014.1(Icehouse)
The name of the panel group the ``PANEL`` is associated with.
``DEFAULT_PANEL``
-----------------
.. versionadded:: 2014.1(Icehouse)
If set, it will update the default panel of the ``PANEL_DASHBOARD``.
``ADD_PANEL``
-------------
.. versionadded:: 2014.1(Icehouse)
Python panel class of the ``PANEL`` to be added.
``REMOVE_PANEL``
----------------
.. versionadded:: 2014.1(Icehouse)
If set to ``True``, the PANEL will be removed from PANEL_DASHBOARD/PANEL_GROUP.
``ADD_INSTALLED_APPS``
@ -603,6 +633,8 @@ This is needed to expose static files from a plugin.
``DISABLED``
------------
.. versionadded:: 2014.1(Icehouse)
If set to ``True``, this panel configuration will be skipped.
Examples
@ -638,6 +670,8 @@ following content::
Pluggable Settings for Panel Groups
===================================
.. versionadded:: 2014.1(Icehouse)
To organize the panels created from the pluggable settings, there is also
a way to create panel group though configuration file. This creates an empty
panel group to act as placeholder for the panels that can be created later.
@ -663,26 +697,36 @@ The files contain following keys:
``PANEL_GROUP``
---------------
.. versionadded:: 2014.1(Icehouse)
The name of the panel group to be added to ``HORIZON_CONFIG``. Required.
``PANEL_GROUP_NAME``
--------------------
.. versionadded:: 2014.1(Icehouse)
The display name of the PANEL_GROUP. Required.
``PANEL_GROUP_DASHBOARD``
-------------------------
.. versionadded:: 2014.1(Icehouse)
The name of the dashboard the ``PANEL_GROUP`` associated with. Required.
``DISABLED``
------------
.. versionadded:: 2014.1(Icehouse)
If set to ``True``, this panel configuration will be skipped.
``UPDATE_HORIZON_CONFIG``
-------------------------
.. versionadded:: 2014.1(Icehouse)
A dictionary of values that will replace the values in ``HORIZON_CONFIG``. The
order in which this setting is applied is the same as for the other pluggable
settings, and is described at the beginning of this section.