8895ea2254
Add support for share type extra-specs that can be used to influence share creation options that are specific to 3PAR. These extra-specs are scoped (use 'hp_3par:' prefix). CIFS extra-specs include 'smb_abe' (access based enumeration), 'smb_cache' and 'smb_ca' (continuous availability). 'smb_ca' is ignored until hp3parclient > 3.2.1. The NFS extra-spec is 'nfs_options'. This value is a comma-separated string as needed for the 3PAR createfshare -options value in the CLI. The following values are not allowed because the driver uses specific settings (for now): (no_)root_squash, (in)secure. The following values are not allowed per HP 3PAR CLI support requirements: no_subtree_check, fsid. 'rw' and 'ro' are not allowed because read-only access should be controlled by Manila and not by extra-specs. Additional value validation is left to the 3PAR CLI to handle. Implements Blueprint: hp3par-extra-specs Change-Id: Ia311cae718bf3998346b068aebb08a64924195de |
||
|---|---|---|
| .. | ||
| ext | ||
| source | ||
| .gitignore | ||
| find_autodoc_modules.sh | ||
| generate_autodoc_index.sh | ||
| Makefile | ||
| README.rst | ||
Building the docs
Dependencies
- Sphinx
-
You'll need sphinx (the python one) and if you are using the virtualenv you'll need to install it in the virtualenv specifically so that it can load the manila modules.
pip install Sphinx - Graphviz
-
Some of the diagrams are generated using the
dotlanguage from Graphviz.sudo apt-get install graphviz
Use make
Just type make:
% makeLook in the Makefile for more targets.
Manually
Generate the code.rst file so that Sphinx will pull in our docstrings:
% ./generate_autodoc_index.sh > source/code.rstRun `sphinx_build`:
% sphinx-build -b html source build/html
The docs have been built
Check out the build directory to find them. Yay!