manila/doc
Goutham Pacha Ravi 2d7c464453 Enable cephfs snapshots
The CephFS driver optionally advertised snapshot
support to manila, based on a configuration
option "cephfs_enable_snapshots". Manila does not
provide snapshots by default to users, unless an
administrator chooses to set the "snapshot_support"
extra-spec in the share type they're using. So this
configuration option is really an unnecessary safeguard
at this point.

Moreover, CephFS snapshots are fully supported from
Ceph Nautilus, and with Id847b1b5e6623172f2600afd69e51182067444cb,
manila added a support statement for the Victoria
release that indicates that Nautilus is the minimum
version of ceph supported. So let's default this
option to True, and deprecate this option at the same
time to eliminate this duplicate safeguard.

Partially-implements: bp update-cephfs-drivers
Depends-On: I885ff78586540d01590f98cca2a00d55161dbe04
Change-Id: I1ef42b414f8af0b8f9a912655757ec200a75c309
Signed-off-by: Goutham Pacha Ravi <gouthampravi@gmail.com>
2020-07-07 22:13:08 -07:00
..
ext doc migration: openstackdocstheme completion 2017-08-24 09:15:18 -04:00
source Enable cephfs snapshots 2020-07-07 22:13:08 -07:00
README.rst Update the documentation link for doc migration 2017-07-14 07:27:16 +00:00
requirements.txt Use unittest.mock instead of mock 2020-06-09 01:21:20 +02:00

README.rst

Manila Development Docs

Files under this directory tree are used for generating the documentation for the manila source code.

Developer documentation is built to: https://docs.openstack.org/manila/latest/

Tools

Sphinx

The Python Sphinx package is used to generate the documentation output. Information on Sphinx, including formatting information for RST source files, can be found in the Sphinx online documentation.

Graphviz

Some of the diagrams are generated using the dot language from Graphviz. See the Graphviz documentation for Graphviz and dot language usage information.

Building Documentation

Doc builds are performed using tox with the docs target:

% cd ..
% tox -e docs