freezer/install-guide/source/devstack_plugin.rst
Saad Zaher a8ca5cb86b Move install-guide to freezer repo
* Added install-guide to freezer repo
   * Remove install-guide from freezer-api

Change-Id: I122f2801e6853a2b3c3bc65408b3cec8fe1b555d
2017-04-26 17:41:47 +00:00

49 lines
1.1 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]
where
.. code-block:: none
<GITURL> is the URL of a freezer-api 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
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 use
.. code-block:: bash
export FREEZER_API_PORT=19090
For more information, see `openstack_devstack_plugins_install <http://docs.openstack.org/developer/devstack/plugins.html>`_