36b1715e86
To set up some first party backends such as ZFSOnLinux, CephFS via NFS gateway, Container (where the NAS server is containerized) and LVM, manila's devstack plugin creates a NAS server on the devstack host. On test machines, access to this NAS server is firewalled from networks outside of the host's internal network namespace (including from private project networks that are in different network namespaces, on the same devstack host). We currently use a legacy devstack-gate script to disable firewall on NFS ports; however, anyone that installs devstack with LVM, Container, ZFSOnLinux, CephFS-NFS drivers will need these firewall ports to be opened to be able to mount shares exported off their devstack host machines. Move these firewall commands to the devstack plugin. These commands can be invoked by setting the localrc variable MANILA_ALLOW_NAS_SERVER_PORTS_ON_HOST to True. The value of this variable is False by default, to preserve existing behavior. Change-Id: Ic9cad47662f1edf2e5c710dbe64d580bc5f01d44
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
dotlanguage 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