From 25506de0e477afc3bd499847530f76bb3f9e7635 Mon Sep 17 00:00:00 2001 From: zhangbailin Date: Fri, 19 Jul 2019 15:07:16 +0800 Subject: [PATCH] Add manila-ui config instructions 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 --- devstack/README.rst | 10 ++++++ .../development-environment-devstack.rst | 36 ++++++++++++------- 2 files changed, 33 insertions(+), 13 deletions(-) diff --git a/devstack/README.rst b/devstack/README.rst index be0d6a4936..34b755d13d 100644 --- a/devstack/README.rst +++ b/devstack/README.rst @@ -2,12 +2,22 @@ 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 2. Add this repo as an external repository:: > cat local.conf [[local|localrc]] + # Enable 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`` + +.. _development-environment-devstack: https://docs.openstack.org/manila/latest/contributor/development-environment-devstack.html diff --git a/doc/source/contributor/development-environment-devstack.rst b/doc/source/contributor/development-environment-devstack.rst index 9220f08c3f..d669f71d40 100644 --- a/doc/source/contributor/development-environment-devstack.rst +++ b/doc/source/contributor/development-environment-devstack.rst @@ -16,21 +16,28 @@ Setting up a development environment with devstack ================================================== This page describes how to setup a working development -environment that can be used in deploying manila on latest releases -of Ubuntu, Fedora or CentOS. These instructions assume you are already familiar -with git. +environment that can be used in deploying ``manila`` and ``manila-ui`` on +latest releases of Ubuntu, Fedora or CentOS. These instructions assume you +are already familiar with git. -We recommend using devstack to develop and test code changes to -manila or to simply evaluate the manila project. Devstack is a shell script -to build complete OpenStack development environments on a virtual machine. -If you are not familar with devstack, these pages can give you context: +We recommend using devstack to develop and test code changes to ``manila`` +and/or ``manila-ui``, in order to simply evaluate the manila and/or project. +Devstack is a shell script to build complete OpenStack development +environments on a virtual machine. If you are not familar with devstack, +these pages can give you context: * `Testing Changes with DevStack `_ * `Devstack project documentation `_ -Be aware that manila is not enabled in devstack by default; you will need to -add a few lines to the devstack ``local.conf`` file to let devstack deploy and -configure manila on your virtual machine. +Be aware that ``manila`` and ``manila-ui`` are not enabled in devstack by +default; you will need to add a few lines to the devstack ``local.conf`` +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 ---------------- @@ -89,8 +96,8 @@ machine, baremetal, containers) that is able to reach the share network you indicated. Typically, new contributors take a while to understand OpenStack networking, -and we recommend that you familiarize yourself with the DHSS=False mode -setup before attempting DHSS=True. +and we recommend that you familiarize yourself with the ``DHSS=False`` mode +setup before attempting ``DHSS=True``. * :download:`Generic driver ` * :download:`Container driver ` @@ -104,7 +111,7 @@ Building your devstack * 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 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 could take a while:: @@ -137,6 +144,9 @@ Building your devstack ``/var/log/httpd/manila_api.log`` (Red Hat) or 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: