openstack/manila
Code Issues Proposed changes
cb15c82293
manila/doc/source/devref/index.rst

130 lines
2.5 KiB
ReStructuredText
Raw Normal View History

Initialize from cinder
2013-08-08 10:34:06 -04:00
..
Copyright 2010-2011 United States Government as represented by the
Administrator of the National Aeronautics and Space Administration.
All Rights Reserved.
Licensed under the Apache License, Version 2.0 (the "License"); you may
not use this file except in compliance with the License. You may obtain
a copy of the License at
http://www.apache.org/licenses/LICENSE-2.0
Unless required by applicable law or agreed to in writing, software
distributed under the License is distributed on an "AS IS" BASIS, WITHOUT
WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the
License for the specific language governing permissions and limitations
under the License.
Developer Guide
===============
Unify usage of project name in doc to 'manila' Change project name in doc according to style rules in http://docs.openstack.org/contributor-guide/writing-style/openstack-components.html Closes-Bug: #1537808 Change-Id: I849b0ec34a1bfc01263f35a9ef0128100945867e Signed-off-by: Danny Al-Gaaf <danny.al-gaaf@bisect.de>
2016-01-25 17:12:35 +01:00
In this section you will find information on manila's lower level programming APIs.
Initialize from cinder
2013-08-08 10:34:06 -04:00
Programming HowTos and Tutorials
--------------------------------
.. toctree::
:maxdepth: 3
development.environment
unit_tests
[Tempest] Add valuable tags to tests To be able to run tests based on following criteria: - Only API is required and tested. - API and share back-end required, API is tested. - API and share back-end required, back-end is tested Also, add doc with detailed description of running subset of tests. Change-Id: I9ae105eaa527621c85d5038bba15edf4b065eaa3 Closes-Bug: #1587874
2016-06-01 18:30:12 +03:00
tempest_tests
Initialize from cinder
2013-08-08 10:34:06 -04:00
addmethod.openstackapi
Document instructions for documentation A lot of things have been changing with OpenStack's documentation. As a community, we could do a better job at catching up with these changes and documenting our project well enough for the benefit of all stakeholders. Add instructions on where to document what and provide tips to manila developers on documentation. Change-Id: I660bfd5ac3d61c253e1e7b4b02c51424a03fa0a0 Partially-implements: bp improve-manila-developer-docs
2016-05-25 22:38:48 -04:00
documenting_your_work
Add release notes usage and documentation Clarify guidelines for Manila developers to use reno appropriately. Change-Id: I2cbb93dd3e331e4f6f6b80e0acb165b2041592a4
2016-04-01 16:41:12 -04:00
adding_release_notes
Added docs for commit message tags Added some documentation for how and when to use commit message tags in git commit messages. Also added a link to the new article in the index for the dev ref. Change-Id: I5aa4c128cd0e25fb12316de21eed262cca810e08
2016-04-25 11:04:52 -05:00
commit_message_tags
Initialize from cinder
2013-08-08 10:34:06 -04:00
Unify usage of project name in doc to 'manila' Change project name in doc according to style rules in http://docs.openstack.org/contributor-guide/writing-style/openstack-components.html Closes-Bug: #1537808 Change-Id: I849b0ec34a1bfc01263f35a9ef0128100945867e Signed-off-by: Danny Al-Gaaf <danny.al-gaaf@bisect.de>
2016-01-25 17:12:35 +01:00
Background Concepts for manila
Update manila's docs After manila's fork from cinder, its docs were not updated well. This info is used by doc-builder, see doc/README.rst Partially implements: blueprint manila-documentation Change-Id: Ic97584db291b60505d5d310a517c2866fc6fcf5f
2014-06-06 19:30:04 +03:00
------------------------------
Initialize from cinder
2013-08-08 10:34:06 -04:00
.. toctree::
:maxdepth: 3
architecture
threading
Rename from il8n.rst to i18n.rst Internationalization's abbreviation is i18n. This patch renames l to one for il8n.rst. Change-Id: Ibd588fee48565f78cdc953973012a8ec613ed058 Closes-Bug: #1477985
2015-07-24 22:02:44 +09:00
i18n
Initialize from cinder
2013-08-08 10:34:06 -04:00
rpc
Added driver minimum requirements and features doc This document consists of a list and explanation of minimum features a driver must implement to be accepted into Manila code base. Change-Id: I12d5bf60abad4a7146d5d596f03d96bf2605cbdc
2015-10-16 10:26:35 -03:00
driver_requirements
Add doc for Dynamic Storage Pools for Manila scheduler Add doc for Dynamic Storage Pools for Manila scheduler dealing with the need and impact of Pools with respect to Manila. Change-Id: I1db2b56a6377775ef2f834179e603cd4f755d2f5
2014-12-14 21:42:54 -05:00
pool-aware-manila-scheduler
Initialize from cinder
2013-08-08 10:34:06 -04:00
Other Resources
---------------
.. toctree::
:maxdepth: 3
launchpad
gerrit
jenkins
API Reference
-------------
.. toctree::
:maxdepth: 3
Update manila's docs After manila's fork from cinder, its docs were not updated well. This info is used by doc-builder, see doc/README.rst Partially implements: blueprint manila-documentation Change-Id: Ic97584db291b60505d5d310a517c2866fc6fcf5f
2014-06-06 19:30:04 +03:00
api
Implement Manila REST API microversions The OpenStack API working group recommends all projects adopt Nova-style microversions for versioning their REST APIs. This commit ports the Nova microversion code and docs to Manila. With this patch, the API version is bumped to 1.1, and the versions API (which has always returned horribly outdated values) is the first API that is versioned. The 1.1 version of the versions API includes the minimum and current API version values. Implements bp: manila-rest-api-microversions Change-Id: Ifa8e394335a4eb3ad21f53a873530aee241c00e8
2015-05-16 11:59:37 -04:00
api_microversion_dev
api_microversion_history
Manila experimental REST APIs Manila uses API microversions to allow natural evolution of its REST APIs over time. But microversions alone cannot solve the question of how to ship APIs that are experimental in nature, are expected to change at any time, and could even be removed entirely without a typical deprecation period. Working in conjunction with microversions, this commit adds a facility for marking individual REST APIs as experimental. Implements bp: manila-experimental-rest-apis Change-Id: I263a0b5579a7eb2fe98ca810ad3dec6719d66e6f
2015-08-16 01:23:04 -04:00
experimental_apis
Initialize from cinder
2013-08-08 10:34:06 -04:00
Module Reference
----------------
.. toctree::
:maxdepth: 3
Add doc for an Introduction to Manila Add doc for an Introduction to Manila dealing with the fundamentals and basic terminology used with respect to Manila. Change-Id: I07b7442ed91f7fec7b87087499e5047aecc6389f
2014-09-22 00:05:35 -04:00
intro
Initialize from cinder
2013-08-08 10:34:06 -04:00
services
database
modified docs
2013-09-17 12:21:17 +03:00
share
Add doc for share driver hooks Add doc with general description of 'share driver hooks' feature. Change-Id: I735be8ef4c41ad0bcb0810b61d5239cdc03ca80f
2015-07-15 16:20:48 +03:00
share_hooks
Initialize from cinder
2013-08-08 10:34:06 -04:00
auth
api
scheduler
fakes
docs
2013-09-17 10:57:47 +03:00
manila
ganesha: Add doc Add doc for ganesha library specifying requirements, configuration instructions, and limitations. Change-Id: Ibcb1b047e9e64b0c11dab00a41eb8357c3f0a5a0
2015-05-13 10:48:39 +02:00
ganesha
Add doc for Share Replication - Document extra_spec and capabilities involved - Document driver interfaces properly to please Sphinx - Document scheduler behavior - Document replica and snapshot workflows - Fix trailing white spaces in the descriptions of capabilities Change-Id: I054aebda9618968ab8bd3881ccdd8164e1283682 Closes-Bug: #1544812
2016-03-27 22:01:08 -04:00
share_replication
Initialize from cinder
2013-08-08 10:34:06 -04:00
Common capabilities documentation Documentation for capabilities and extra-specs. This needs to describe the agreed upon common capabilities. Vendor-specifics go in driver docs. Change-Id: I2c5bdf5ef9bfd6c8e7e06dac1fde08ad56cc6af1
2015-08-05 23:41:01 -07:00
Capabilities and Extra-Specs
----------------------------
.. toctree::
:maxdepth: 3
capabilities_and_extra_specs
Add doc for export location metadata Change-Id: Ide7ff91103341bcc34972fa09c56b4a55610f90a
2016-02-18 16:52:24 -05:00
export_location_metadata
Common capabilities documentation Documentation for capabilities and extra-specs. This needs to describe the agreed upon common capabilities. Vendor-specifics go in driver docs. Change-Id: I2c5bdf5ef9bfd6c8e7e06dac1fde08ad56cc6af1
2015-08-05 23:41:01 -07:00
Add doc share features mapping Add doc where we provide mapping of supported share features by each specific share driver. In this commit up-to-date information is provided only for Generic driver. All other are expected to be updated afterwards. Change-Id: I9645857b59563084b76a94308f4523e37b860201
2015-07-28 14:31:57 +03:00
Share backends feature support mapping
--------------------------------------
.. toctree::
:maxdepth: 3
share_back_ends_feature_support_mapping
Add doc for generic driver Add doc for generic driver with description of its possibilities and requirements. Change-Id: I406b38d5c7a9bc9a4467424d5f4f17754f73d182
2014-09-19 11:29:24 +03:00
Share backends
--------------
.. toctree::
:maxdepth: 3
Container driver This driver exploits a Docker container as a share server instead of a virtual machine. The container acts as a CIFS server and shares logical volume attached to it. The volume gets created simultaneously to the container on a host in a volume group specified by the user. DocImpact Change-Id: I711813a2022d765ab7a70ed670e34f68f9cf1399 Implements: blueprint manila-container-driver
2016-04-21 14:02:12 +03:00
container_driver
Add ZFSonLinux share driver Add support for ZFS (on Linux) filesystem. Following features are supported: - Create/delete share - Create/delete snapshot - Create share from snapshot - Extend/shrink share - Update NFS IP-based access rules using new interface. (SMB support planned for future). - create/delete/update/promote share replica ZFS-related notes: - Any amount of ZFS zpools can be used by share driver. - Allowed to configure default options for ZFS datasets that are used for share creation. - Any amount of nested datasets is allowed to be used. - All share replicas are read-only. - All share replicas are synched periodically, not continuously. So, status 'in_sync' means latest sync was successful. Time range between syncs equals to value of config global opt 'replica_state_update_interval'. Driver-related notes: - Able to use remote ZFSonLinux storage as well as local. Other made changes: - updated driver private data DB methods removing filtering by host as redundant operation. Replication requires some common metadata storage and filtering by host breaks it. It is safe to do so, because if driver gets some ID of entity then it is allowed to read its info too. Implements bp zfsonlinux-driver DocImpact Change-Id: I3ddd3767184e4843037de0ac75ff18dce709b6dc
2016-02-03 18:24:41 +02:00
zfs_on_linux_driver
Manila NetApp cDOT driver refactoring The Manila cDOT driver is a single file exceeding 1200 lines. It contains multiple things (driver code, protocol helpers, ZAPI invocation code, options) that should be split apart to allow for easier maintenance and readability and add the potential for code sharing when we reintroduce a 7-mode driver, add a single-SVM cDOT driver, etc. We recently refactored NetApp's DOT Cinder drivers into a 4-layer structure (interface, library, client, API) that separates concerns and achieves the goals set forth above. This commit satisfies a plan to do the same thing in Manila. The implementation steps are: 1. Update directory structure to match that of the Cinder NetApp drivers 2. Create driver interface shim 3. Move driver code to library (with base & C-mode classes, to allow for 7-mode code sharing later) 4. Move protocol helpers to separate files (already organized by base & C-mode classes) 5. Split out ZAPI code to client layer (with base & C-mode classes, to allow for 7-mode code sharing later) 6. Implement NetApp driver factory as in Cinder 7. Implement common NetApp options file as in Cinder 8. Implement cDOT API call optimizations 9. Update all unit tests as needed Note that this patch appears to treble the total number of code lines. This is due to the addition of many more unit tests plus a large amount of fake controller API data to feed the API client tests. Implements: blueprint netapp-manila-cdot-driver-refactoring Closes-Bug: #1410317 Partial-Bug: #1396953 Closes-Bug: #1370965 Closes-Bug: #1418690 Closes-Bug: #1418696 Change-Id: I3fc0d09adf84a3708f110a89a7c8c760f4ce3588
2015-01-08 18:01:08 -05:00
netapp_cluster_mode_driver
EMC Isilon Manila Driver Docs Change-Id: I2f15b7f26fe2e4ce0efb0e1b4304d2fc473bfe5d implements: blueprint emc-isilon-manila-driver
2015-03-04 14:44:55 -08:00
emc_isilon_driver
Add doc for EMC VNX driver Add doc for EMC VNX driver with descriptions on its requirements, limitations, and configuration instructions. Change-Id: I5a8e9d62d0708b56aadfe85a83faaf5dc1557f6b
2014-09-24 18:40:40 -04:00
emc_vnx_driver
Add EMC Unity Driver for Manila EMC Unity arrays are capable of support manila. Add a new Unity plugin in manila which allows user to create NFS/CIFS share with a Unity backend. The plugin should support following APIs: * connect: Connect to the Unity Storage. * check_for_setup_error: No implementation. * create_share: Create a share and export it based on the protocol used (NFS or CIFS). * create_share_from_snapshot: Create a share from a snapshot - clone a snapshot. * delete_share: Delete a share. * extend_share: Extend the maximum size of a share. * create_snapshot: Create a snapshot for the specified share. * delete_snapshot: Delete the snapshot of the share. * allow_access: Allow access of a user/host to a share. * deny_access: Remove the access of a user/host to the share. * ensure_share: Check whether share exists or not. * update_share_stats: Retrieve share related statistics from Unity. * get_network_allocatins_number: Returns number of network allocations for creating VIFs. * setup_server: Set up and configures share server with given network parameters. * teardown_server: Tear down the share server. DocImpact Co-Authored-By: Cedric Zhuang <cedric.zhuang@emc.com> Change-Id: Ic520539341fa19ec5c6c6b85c3c1dcecf70e5141 Implements: blueprint emc-unity-manila-support
2016-04-15 18:08:45 +08:00
emc_unity_driver
Add doc for generic driver Add doc for generic driver with description of its possibilities and requirements. Change-Id: I406b38d5c7a9bc9a4467424d5f4f17754f73d182
2014-09-19 11:29:24 +03:00
generic_driver
glusterfs: Add doc Add doc for glusterfs driver specifying requirements, configuration instructions, and limitations. Change-Id: I5cea3aedcf6da312eb46e4fe47ba26b303d0c676
2015-02-05 16:32:48 +05:30
glusterfs_driver
doc: Add glusterfs_native driver developer doc This adds the glusterfs_native driver developer doc, specifying requirements, configuration instructions, and limitations. Change-Id: Ie42a43e2cdd88907914d5f7ddab26f417f1a3e99
2015-02-26 17:03:06 +05:30
glusterfs_native_driver
Add Ceph Native driver This driver enables use of the Ceph filesystem for Manila shares. Clients require a native CephFS client to access the share. The interface to Ceph is CephFSVolumeClient, included in the 'Jewel' Ceph release and later. APIImpact The API microversion is bumped to 2.13 to add a new access type, cephx, supported by the driver. Co-Authored-By: Ramana Raja <rraja@redhat.com> Implements: blueprint cephfs-driver Change-Id: I33801215f64eacb9dade4d92f11f659173abb7f5
2015-11-18 13:15:32 +00:00
cephfs_native_driver
Add IBM GPFS Manila driver Adding GPFS driver back as the third party CI system for GPFS driver is up and running. This is a revert of commit 720ec904456594b453cfd220b002bdc8c0d50e08 Change-Id: I86f9b7da21716346f96bae3ce30446589e4c4c37
2015-10-06 04:35:16 -04:00
gpfs_driver
Add doc for Huawei driver Add doc for Huawei driver with descriptions on its requirements, limitations, and configuration instructions. Change-Id: I212ddf9f0b4b50d62970043405ea3cb59b83f03b
2015-01-11 23:41:21 -08:00
huawei_nas_driver
Add doc for hdfs_native driver Add the hdfs_native driver developer doc with requirements, supported operations, configurations, and limitations. Change-Id: Ifbe785f25e779be6871ebc8474f9fbb1d38af82b
2015-03-02 09:55:10 +08:00
hdfs_native_driver
Updated Hitachi NAS Platform Driver documentation This patch updates the documentation for the Hitachi NAS Platform File Services Driver for OpenStack. Closes-bug: #1536812 Closes-bug: #1614833 Closes-bug: #1616618 Closes-bug: #1623105 Change-Id: I0291efcadf244b7911969cfb367387a5998f1a23
2016-08-25 14:43:53 -03:00
hitachi_hnas_driver
Refactor HP 3PAR share driver to now be HPE This patch refactors the HP share driver to now be the HPE share driver. This is being done because the company responsible for this driver is now Hewlett Packard Enterprise (HPE). The driver is now located in the manila/share/drivers/hpe folder. DocImpact Implements: blueprint rebrand-hp-3par-share-driver Change-Id: I36efc04fa6da088ccb06070d8cd4fe29269cd7ca
2015-10-29 17:19:48 -07:00
hpe_3par_driver
Add share driver for Tegile IntelliFlash Arrays The Tegile driver will support the NAS shares and it will include the minimum set of features. [Supported Protocols] - CIFS, NFS The driver supports Manila driver mode (driver_handles_share_servers = False). Tegile has setup a CI. It will report as "Tegile Storage CI". DocImpact Implements: blueprint tegile-share-driver Change-Id: I2e9154454e2a34f9a0653a173846ce554026f33b
2016-02-09 14:58:07 -08:00
tegile_driver
Initialize from cinder
2013-08-08 10:34:06 -04:00
Indices and tables
------------------
* :ref:`genindex`
* :ref:`search`
Copy Permalink