openstack/manila
Code Issues Proposed changes

Add manila-ui config instructions

Browse Source 
In Devstack, even though horizon and manila plugins are enabled, if the
manila ui plugin is not explicitly enabled it won't show up.

This change adds config instructions in the readme and in the manila
contributor docs to enable Manila UI when deploying with Devstack.

Change-Id: I421db5b8ed56fecc90ac7e6d32078d443a3eaa2e
This commit is contained in:
zhangbailin 2019-07-19 15:07:16 +08:00
parent 8d03a2a46e
commit 25506de0e4
2 changed files with 33 additions and 13 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

10
devstack/README.rst
View File

@ -2,12 +2,22 @@
Enabling in Devstack Enabling in Devstack
====================== ======================
We can enable the manila service in DevStack. For details, please refer to
`development-environment-devstack`_, the following steps can be used as a
quickstart reference:
1. Download DevStack 1. Download DevStack
2. Add this repo as an external repository:: 2. Add this repo as an external repository::
> cat local.conf > cat local.conf
[[local|localrc]] [[local|localrc]]
# Enable manila
enable_plugin manila https://git.openstack.org/openstack/manila enable_plugin manila https://git.openstack.org/openstack/manila
# Enable manila ui in the dashboard
enable_plugin manila-ui https://git.openstack.org/openstack/manila-ui
3. run ``stack.sh`` 3. run ``stack.sh``
.. _development-environment-devstack: https://docs.openstack.org/manila/latest/contributor/development-environment-devstack.html

36
doc/source/contributor/development-environment-devstack.rst
View File

@ -16,21 +16,28 @@ Setting up a development environment with devstack
================================================== ==================================================
This page describes how to setup a working development This page describes how to setup a working development
environment that can be used in deploying manila on latest releases environment that can be used in deploying ``manila`` and ``manila-ui`` on
of Ubuntu, Fedora or CentOS. These instructions assume you are already familiar latest releases of Ubuntu, Fedora or CentOS. These instructions assume you
with git. are already familiar with git.
We recommend using devstack to develop and test code changes to We recommend using devstack to develop and test code changes to ``manila``
manila or to simply evaluate the manila project. Devstack is a shell script and/or ``manila-ui``, in order to simply evaluate the manila and/or project.
to build complete OpenStack development environments on a virtual machine. Devstack is a shell script to build complete OpenStack development
If you are not familar with devstack, these pages can give you context: environments on a virtual machine. If you are not familar with devstack,
these pages can give you context:
* `Testing Changes with DevStack <https://docs.openstack.org/contributors/code-and-documentation/devstack.html>`_ * `Testing Changes with DevStack <https://docs.openstack.org/contributors/code-and-documentation/devstack.html>`_
* `Devstack project documentation <https://docs.openstack.org/devstack/latest>`_ * `Devstack project documentation <https://docs.openstack.org/devstack/latest>`_
Be aware that manila is not enabled in devstack by default; you will need to Be aware that ``manila`` and ``manila-ui`` are not enabled in devstack by
add a few lines to the devstack ``local.conf`` file to let devstack deploy and default; you will need to add a few lines to the devstack ``local.conf``
configure manila on your virtual machine. file to let devstack deploy and configure ``manila`` and ``manila-ui`` on
your virtual machine.
.. note::
If you do not intend to deploy with the OpenStack Dashboard (horizon)
service, you can ignore instructions about enabling ``manila-ui``.
Getting devstack Getting devstack
---------------- ----------------
@ -89,8 +96,8 @@ machine, baremetal, containers) that is able to reach the share network you
indicated. indicated.
Typically, new contributors take a while to understand OpenStack networking, Typically, new contributors take a while to understand OpenStack networking,
and we recommend that you familiarize yourself with the DHSS=False mode and we recommend that you familiarize yourself with the ``DHSS=False`` mode
setup before attempting DHSS=True. setup before attempting ``DHSS=True``.
* :download:`Generic driver <samples/generic_local.conf>` * :download:`Generic driver <samples/generic_local.conf>`
* :download:`Container driver <samples/container_local.conf>` * :download:`Container driver <samples/container_local.conf>`
@ -104,7 +111,7 @@ Building your devstack
* Make sure to read inline comments and customize values where necessary * Make sure to read inline comments and customize values where necessary
* If you would like to run minimal services in your stack, or allow devstack * If you would like to run minimal services in your stack, or allow devstack
to bootstrap tempest testing framework for you, see :ref:`more-customization` to bootstrap tempest testing framework for you, see :ref:`more-customization`
* Finally, run the stack.sh script from within the devstack directory. We * Finally, run the ``stack.sh`` script from within the devstack directory. We
recommend that your run this inside a screen or tmux session because it recommend that your run this inside a screen or tmux session because it
could take a while:: could take a while::
@ -137,6 +144,9 @@ Building your devstack
``/var/log/httpd/manila_api.log`` (Red Hat) or ``/var/log/httpd/manila_api.log`` (Red Hat) or
in ``/var/log/apache2/manila_api.log`` (Debian). in ``/var/log/apache2/manila_api.log`` (Debian).
* Manila UI will now be available through OpenStack Horizon; look for the
Shares tab under Project > Share.
.. _more-customization: .. _more-customization: