Add documentation for configuring availability calendar
This adds documentation explaining how to enable, configure the calendar attribute, and what permissions are needed to use the calendar. Change-Id: I80026407ab537b7967ccbd2965d66f40018c4c0e
This commit is contained in:
parent
d6398f5e7a
commit
96b3921d77
|
@ -0,0 +1,30 @@
|
||||||
|
==============================
|
||||||
|
Resource Availability Calendar
|
||||||
|
==============================
|
||||||
|
|
||||||
|
Blazar Dashboard features a resource availability calendar that displays a
|
||||||
|
timeline of resources, showing when each resource is reserved.
|
||||||
|
|
||||||
|
Currently, physical hosts are the only supported resource type.
|
||||||
|
|
||||||
|
Configuration
|
||||||
|
=============
|
||||||
|
In the Horizon settings, the option ``OPENSTACK_BLAZAR_HOST_RESERVATION`` can
|
||||||
|
be configured.
|
||||||
|
|
||||||
|
.. sourcecode::
|
||||||
|
|
||||||
|
OPENSTACK_BLAZAR_HOST_RESERVATION = {
|
||||||
|
'enabled': True,
|
||||||
|
'calendar_attribute': 'hypervisor_hostname',
|
||||||
|
}
|
||||||
|
|
||||||
|
..
|
||||||
|
|
||||||
|
If ``enabled`` is ``True``, the host calendar will be enabled. The option
|
||||||
|
``calendar_attribute`` is used to label each row of the calendar. By default,
|
||||||
|
it uses the ``hypervisor_hostname`` attribute of a host. If the host has
|
||||||
|
resource properties set, they could also be used.
|
||||||
|
|
||||||
|
In order to be able to view the calendar, a user needs permission for
|
||||||
|
``blazar:oshosts:get`` and ``blazar:oshosts:get_allocations``.
|
|
@ -29,6 +29,13 @@ The following features are currently supported:
|
||||||
* Update a host
|
* Update a host
|
||||||
* Delete host(s)
|
* Delete host(s)
|
||||||
|
|
||||||
|
|
||||||
|
.. toctree::
|
||||||
|
:maxdepth: 2
|
||||||
|
|
||||||
|
calendar
|
||||||
|
|
||||||
|
|
||||||
Installation Guide
|
Installation Guide
|
||||||
==================
|
==================
|
||||||
|
|
||||||
|
|
Loading…
Reference in New Issue