openstack/deb-manila
Code Issues Proposed changes

Add Glossary with basic Manila terms

Browse Source 
Glossary should be used to describe common terms used in Manila's
documentation. Starting using it for "manila-share", "manila-api" and
"manila-scheduler".

Change-Id: I288332f5b599c9c78d45f0102e4d2a20753af3a6
This commit is contained in:
Thomas Bechtold 2015-04-08 11:56:20 +02:00
parent 1029277388
commit ef6de3f584
9 changed files with 57 additions and 28 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

2
doc/source/adminref/intro.rst
View File

@ -14,7 +14,7 @@
Introduction to Manila Shared Filesystem Management Service
===========================================================
Manila is the File Share service project for OpenStack. To administer the
:term:`Manila` is the File Share service project for OpenStack. To administer the
OpenStack File Share service, it is helpful to understand a number of concepts
like share networks, shares, multi-tenancy and back ends that can be configured
with Manila. When configuring the File Share service, it is required to declare

32
doc/source/devref/architecture.rst
View File

@ -30,28 +30,28 @@ Below you will a brief explanation of the different components.
::
/- ( LDAP )
[ Auth Manager ] ---
| \- ( DB )
|
|
/- ( LDAP )
[ Auth Manager ] ---
| \- ( DB )
|
|
|
[ Web Dashboard ]- manilaclient -[ api ] -- < AMQP > -- [ scheduler ] -- [ share ] -- ( shared filesystem )
|
|
|
|
|
< REST >
|
[ Web Dashboard ]- manilaclient -[ manila-api ] -- < AMQP > -- [ manila-scheduler ] -- [ manila-share ] -- ( shared filesystem )
|
|
|
|
|
< REST >
* DB: sql database for data storage. Used by all components (LINKS NOT SHOWN)
* Web Dashboard: external component that talks to the api. Beta extended Horizon available here: https://github.com/NetApp/horizon/tree/manila
* api: component that receives http requests, converts commands and communicates with other components via the queue or http
* :term:`manila-api`
* Auth Manager: component responsible for users/projects/and roles. Can backend to DB or LDAP. This is not a separate binary, but rather a python class that is used by most components in the system.
* scheduler: decides which host will handle create share request.
* share: manages shared filesystems.
* :term:`manila-scheduler`
* :term:`manila-share`
Further Challenges
------------------

2
doc/source/devref/emc_isilon_driver.rst
View File

@ -63,7 +63,7 @@ for the Isilon driver:
emc_nas_password = <password>
isilon_share_root_dir = <directory on Isilon where shares will be created>
Restart of manila-share service is needed for the configuration changes to take
Restart of :term:`manila-share` service is needed for the configuration changes to take
effect.
Restrictions

2
doc/source/devref/emc_vnx_driver.rst
View File

@ -199,7 +199,7 @@ for the VNX driver:
- `emc_nas_pool_name` is the pool name user wants to create volume from. The
pools can be created using Unisphere for VNX.
Restart of manila-share service is needed for the configuration changes to take
Restart of :term:`manila-share` service is needed for the configuration changes to take
effect.
Restrictions

2
doc/source/devref/gpfs_driver.rst
View File

@ -79,7 +79,7 @@ The following configuration parameters are optional:
- `knfs_export_options` = <options to use when creating a share using kernel
NFS server>
Restart of manila-share service is needed for the configuration changes to take
Restart of :term:`manila-share` service is needed for the configuration changes to take
effect.
Known Restrictions

2
doc/source/devref/hp_3par_driver.rst
View File

@ -99,7 +99,7 @@ FPG's VFS. This IP address is used in export locations for shares that are
created. Networking must be configured to allow connectivity from clients to
shares.
Restart of manila-share service is needed for the configuration changes to take
Restart of :term:`manila-share` service is needed for the configuration changes to take
effect.
Network Approach

11
doc/source/devref/intro.rst
View File

@ -33,12 +33,9 @@ net-id and subnet-id before even trying to create a share.
The current low-level services available in Manila are:
- manila-api: The manila-api service is a service that authenticates and
routes requests throughout the Shared Filesystem service.
- :term:`manila-api`
- manila-scheduler: The manila-scheduler is responsible for
scheduling/routing requests to the appropriate share service. It does that
by picking one back-end while filtering all except one back-end.
- :term:`manila-scheduler`
- :term:`manila-share`
- manila-share: The manila-share service is responsible for managing Shared
File Service devices, specifically the back-end devices.

24
doc/source/glossary.rst Normal file
View File

@ -0,0 +1,24 @@
========
Glossary
========
.. glossary::
Manila
OpenStack project to provide "Shared Filesystems as a service".
manila-api
Service that provides a stable RESTful API.
The service authenticates and routes requests throughout the Shared Filesystem service.
There is :term:`python-manilaclient` to interact with the API.
python-manilaclient
Command line interface to interact with :term:`Manila` via :term:`manila-api` and also a
Python module to interact programmatically with :term:`Manila`.
manila-scheduler
Responsible for scheduling/routing requests to the appropriate :term:`manila-share` service.
It does that by picking one back-end while filtering all except one back-end.
manila-share
Responsible for managing Shared File Service devices, specifically the back-end devices.

8
doc/source/index.rst
View File

@ -58,6 +58,14 @@ API Extensions
Go to http://api.openstack.org for information about Manila API extensions.
Information
===========
.. toctree::
:maxdepth: 1
glossary
Outstanding Documentation Tasks
===============================