From ef6de3f5846aee507d2a66d9bf24ac78b9e5e3a1 Mon Sep 17 00:00:00 2001 From: Thomas Bechtold Date: Wed, 8 Apr 2015 11:56:20 +0200 Subject: [PATCH] Add Glossary with basic Manila terms 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 --- doc/source/adminref/intro.rst | 2 +- doc/source/devref/architecture.rst | 32 ++++++++++++------------- doc/source/devref/emc_isilon_driver.rst | 2 +- doc/source/devref/emc_vnx_driver.rst | 2 +- doc/source/devref/gpfs_driver.rst | 2 +- doc/source/devref/hp_3par_driver.rst | 2 +- doc/source/devref/intro.rst | 11 ++++----- doc/source/glossary.rst | 24 +++++++++++++++++++ doc/source/index.rst | 8 +++++++ 9 files changed, 57 insertions(+), 28 deletions(-) create mode 100644 doc/source/glossary.rst diff --git a/doc/source/adminref/intro.rst b/doc/source/adminref/intro.rst index 01c1ad92..dde52116 100644 --- a/doc/source/adminref/intro.rst +++ b/doc/source/adminref/intro.rst @@ -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 diff --git a/doc/source/devref/architecture.rst b/doc/source/devref/architecture.rst index f455dc0b..bccba98d 100644 --- a/doc/source/devref/architecture.rst +++ b/doc/source/devref/architecture.rst @@ -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 ------------------ diff --git a/doc/source/devref/emc_isilon_driver.rst b/doc/source/devref/emc_isilon_driver.rst index f6e27bc5..83be4f7b 100644 --- a/doc/source/devref/emc_isilon_driver.rst +++ b/doc/source/devref/emc_isilon_driver.rst @@ -63,7 +63,7 @@ for the Isilon driver: emc_nas_password = isilon_share_root_dir = -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 diff --git a/doc/source/devref/emc_vnx_driver.rst b/doc/source/devref/emc_vnx_driver.rst index 3e397098..1a3b8643 100644 --- a/doc/source/devref/emc_vnx_driver.rst +++ b/doc/source/devref/emc_vnx_driver.rst @@ -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 diff --git a/doc/source/devref/gpfs_driver.rst b/doc/source/devref/gpfs_driver.rst index f2beea8f..7c7946ff 100644 --- a/doc/source/devref/gpfs_driver.rst +++ b/doc/source/devref/gpfs_driver.rst @@ -79,7 +79,7 @@ The following configuration parameters are optional: - `knfs_export_options` = -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 diff --git a/doc/source/devref/hp_3par_driver.rst b/doc/source/devref/hp_3par_driver.rst index 45403b49..d9dc73bf 100644 --- a/doc/source/devref/hp_3par_driver.rst +++ b/doc/source/devref/hp_3par_driver.rst @@ -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 diff --git a/doc/source/devref/intro.rst b/doc/source/devref/intro.rst index 5537bb9d..e7b3a96c 100644 --- a/doc/source/devref/intro.rst +++ b/doc/source/devref/intro.rst @@ -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. diff --git a/doc/source/glossary.rst b/doc/source/glossary.rst new file mode 100644 index 00000000..a6538f07 --- /dev/null +++ b/doc/source/glossary.rst @@ -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. diff --git a/doc/source/index.rst b/doc/source/index.rst index 2bc50b05..724d9fb1 100644 --- a/doc/source/index.rst +++ b/doc/source/index.rst @@ -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 ===============================