Tom Barron 90060722a9 doc migration: new directory layout

This patch introduces a new directory layout
in doc/source in conformance with the OpenStack
manuals project migration spec [1], moves the
existing content in manila/doc/source into the
new directories, and adjusts index files accordingly.

This is the first step in the migration process
as outlined in the spec.

[1] https://specs.openstack.org/openstack/docs-specs/specs/pike/os-manuals-migration.html

Partial-Bug: #1706181
Needed-By: I7924d94b82e7c8d9716bad7a219fc38c57970773
Depends-On: Ifc80fc56648cef74c85464321d1850e8c68449a0
Depends-On: Ia750cb049c0f53a234ea70ce1f2bbbb7a2aa9454
Change-Id: Ieea33262101a1d2459492c1c8aaac5fe042279f6

2017-08-24 09:16:25 -04:00

2.8 KiB

Raw Blame History

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 or Fedora. These instructions assume you are already familiar with git. Refer to Getting the code for additional information.

Following these instructions will allow you to have a fully functional manila environment using the devstack project (a shell script to build complete OpenStack development environments).

Configuring devstack with manila

Manila

Manila can be enabled in devstack by using the plug-in based interface it offers.

Start by cloning the devstack repository:

git clone https://github.com/openstack-dev/devstack

Change to devstack directory:

cd devstack/

Copy the local.conf sample file to the upper level directory:

cp samples/local.conf .

Enable the manila plugin adding the following line to the end of the local.conf file:

enable_plugin manila https://github.com/openstack/manila

If you would like to install python-manilaclient from git, add to local.conf:

LIBS_FROM_GIT="python-manilaclient"

Manila UI

In order to use the manila UI you will need to enable the UI plugin separately.

This is done in a similar fashion than enabling manila for devstack.

Make sure you have horizon enabled (enabled by default in current devstack).

Then, enable the manila UI plugin adding the following line to the end of the local.conf file, just after manila plugin enablement:

enable_plugin manila-ui https://github.com/openstack/manila-ui

Running devstack

Run the stack.sh script:

./stack.sh

After it completes, you should have manila services running. You can check if they are running by attaching to the screen:

screen -r stack

And navigating to the manila service tabs (use ctrl+a n, ctrl+a p, ctrl+a " <screen number> to navigate, ctrl+a esc to enter scrollback mode and ctrl+a d to detach from the screen).

If you enabled manila UI as well, you should be able to access manila UI from the dashboard.

2.8 KiB Raw Blame History