manila/doc
Goutham Pacha Ravi 22d6fe98a3 Fix capacity calculations in the CephFS driver
The driver inflated total and available capacity
due to an incorrect calculation. The driver was
also ignoring the configuration option
"reserved_share_percentage" that allows
deployers to set aside space from scheduling
to prevent oversubscription.

While this bugfix may have an upgrade impact,
some things must be clarified:
- Inflating the total, free space will allow
  manila to schedule workloads that may run
  out of space - this may cause end user
  downtime and frustration, because shares are
  created (empty subvolumes on ceph occupy no
  space) easily, but they could get throttled
  as they start to fill up.
- CephFS shares are always thinly provisioned
  but, the driver does not support oversubscription
  via manila. So, real free space is what
  determines capacity based scheduler decisions.
  Users however expect share sizes to be honored,
  and manila will allow provisioning as long
  as there is free space on the cluster. This
  means that Ceph cluster administrators
  must manage oversubscription outside of manila
  to prevent misbehavior.

Depends-On: Ic96b65d2caab788afca8bfc45575f3c05dc88008
Change-Id: I6ab157d6d099fe910ec1d90193783b55053ce8f6
Closes-Bug: #1890833
Signed-off-by: Goutham Pacha Ravi <gouthampravi@gmail.com>
2020-09-17 19:27:04 +00:00
..
ext doc migration: openstackdocstheme completion 2017-08-24 09:15:18 -04:00
source Fix capacity calculations in the CephFS driver 2020-09-17 19:27:04 +00: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

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