freezer/install-guide/source/devstack_plugin.rst
2017-07-20 13:30:21 +00:00

53 lines
1.4 KiB
ReStructuredText

.. _devstack_plugin:
Devstack Plugin
===============
Edit local.conf
---------------
To configure the Freezer API with DevStack, you will need to enable the
freezer-api plugin by adding one line to the [[local|localrc]] section
of your local.conf file:
.. code-block:: ini
enable_plugin freezer-api <GITURL> [GITREF]
enable_plugin freezer <GITURL> [GITREF]
enable_plugin freezer-web-ui <GITURL> [GITREF]
where
.. code-block:: none
<GITURL> is the URL of a freezer-api, freezer, freezer-web-ui repository
[GITREF] is an optional git ref (branch/ref/tag). The default is master.
For example
.. code-block:: ini
enable_plugin freezer-api https://git.openstack.org/openstack/freezer-api.git master
enable_plugin freezer https://git.openstack.org/openstack/freezer.git master
enable_plugin freezer-web-ui https://git.openstack.org/openstack/freezer-web-ui.git master
Plugin Options
--------------
The plugin makes use of apache2 by default.
To use the *uwsgi* server set the following environment variable
.. code-block:: bash
export FREEZER_API_SERVER_TYPE=uwsgi
The default port is *9090*. To configure the api to listen on a different port
set the variable `FREEZER_API_PORT`.
For example to make use of port 19090 instead of 9090 use
.. code-block:: bash
export FREEZER_API_PORT=19090
For more information, see `openstack_devstack_plugins_install <https://docs.openstack.org/devstack/latest/plugins.html>`_