cinder/doc
Gorka Eguileor 59d08ca2a9 Add quota utils to cinder-manage
We have many issues with quota:

- Wrong values caused by race conditions
- Duplicated quota usage entries caused by race conditions
- Code that doesn't clean quota usage

Our current code has mechanisms to automatically refresh these values,
but there could be admins that don't want to enable it all the time, and
others that will be affected by bug #1697906 and cannot enable it.

There are a couple of scripts available online, but they all have their
issues: Not taking into account config option no_snapshot_gb_quota, not
fixing backups and groups, being racy, etc.  Moreover, they are external
tools to the OpenStack community.

We will eventually fix quotas, but in the meantime we should provide a
tool to help administrators manage the situation.

This patch adds a new 'quota' category to cinder-manage and two actions
'check' and 'sync' to allow administrators to check and fix on demand
the status of quotas (for a single or all projects).

Related-Bug: #1869749
Related-Bug: #1847791
Related-Bug: #1733179
Related-Bug: #1877164
Related-Bug: #1484343
Change-Id: Ic9323f8cfd75c0fbc425ddc9c9b35959fbe7d482
(cherry picked from commit b50a571374)
2021-04-01 12:08:13 +02:00
..
ext Make docs build parallel 2020-10-22 10:28:01 -05:00
source Add quota utils to cinder-manage 2021-04-01 12:08:13 +02:00
.gitignore Make doc/source directory compliant with design in spec 2017-07-19 15:59:02 -05:00
README.rst Update and replace http with https for doc links in Cinder 2017-07-27 09:58:23 +00:00
requirements.txt Use os-brick 4.3.0 2021-03-25 13:15:43 -04:00

README.rst

Cinder Development Docs

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

Developer documentation is built to: https://docs.openstack.org/cinder/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