As per the community goal of migrating the policy file
the format from JSON to YAML[1], we need to do two things:
1. Change the default value of '[oslo_policy] policy_file''
config option from 'policy.json' to 'policy.yaml' with
upgrade checks.
2. Deprecate the JSON formatted policy file on the project side
via warning in doc and releasenotes.
Also convert manila/tests/policy.json to manila/tests/policy.yaml
using oslopolicy-convert-json-to-yaml tool and replace
policy.json to policy.yaml ref from doc and tests.
[1]https://governance.openstack.org/tc/goals/selected/wallaby/migrate-policy-format-from-json-to-yaml.html
Change-Id: I3748313912b2527c43c9b16a6ba3e3ccd4cf5221
to make user devstack deployment a bit easier.
Since snapshot_support is now on by default for Ceph
backends, enable it in the default share type extra
specs.
Also specify the SHARE_DRIVER so the manila devstack
plugin doesn't think we're running the generic driver
and try to install kernel NFS and samba servers.
Change-Id: I636a047cacba7c5960df15a99fc79a35a818f45d
Added paragraph to the NFS-Ganesha docs with a brief
explanation of the role of ``dbus`` messaging when doing
dynamic updates of exports. Key point is that ``dbus-send``
and NFS-Ganesha must be in the same namespace even if NFS-ganesha
runs in a container.
Close-bug: #1883961
Change-Id: I57b916b16d07a8373143f396b42ea34bf80330a6
This patch adds the admin and user documentation for share revert to
the latest available snapshot.
Change-Id: Id35b99fdb47bb9de38f42034818fb4a29370bf36
Closes-Bug: #1657322
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>
This patch improves the access rules API documentation
to include IPv6 information that was missing.
It includes a note on user guide and changes an access list
example to IPv6.
Change-Id: I5a9ff4e3c8a70cb0b14caa39f5f17740b17b719a
Closes-Bug: #1705045
Signed-off-by: Douglas Viroel <viroel@gmail.com>
This is the basic user guide for manila:
- Update examples and outputs
- Add limits and metadata examples
- Add descriptions about common concepts
including share type extra specifications
- Add contents for easy navigation
Change-Id: Idf374866a63e0da2c4af3157ac5f471af6173d5e
Closes-Bug: #1652375
Signed-off-by: Goutham Pacha Ravi <gouthampravi@gmail.com>
Some content in the admin docs was incomplete,
and irrelevant to administrators.
Also add notes on a couple of missing common
capabilities:
- mount_snapshot_support
- availability_zones
Partial-Bug: #1816486
Change-Id: Ie55fd5bf80ca2ebacdb652c701aa9c213f758963
Signed-off-by: Goutham Pacha Ravi <gouthampravi@gmail.com>
This patch adds the behavior described in the bug #1713060
as known restriction in the generic driver.
Change-Id: Ic70fcd9f6cf159a960e0d75b4081c88af3d8973e
Closes-Bug: #1713060
This patch add some notes regarding the use of scheduler when
creating share from snapshot in another pool or backend.
Change-Id: I8d904cb3aab4d653178948284571f471bd59ac1b
Closes-Bug: #1878244
Updates user guide documentation to provide metadata info
to an access rules. Also add two new operations for access
rule metadata: 'access-metadata set' and 'access-metadata unset'
Change-Id: Ib6008c9dd4284b8c3434ffce61fb74f1db6c3d35
Closes-Bug: #1782859
Extend docs on running manila API with a web server (Apache, NGINX)
Add samples for mod_wsgi
Partially-implements: blueprint wsgi-web-servers-support
Change-Id: Ic756466e65ffd8b5fc6b8e8fb3eef4b8535b46d6
Added some samples on uWSGI config and some docs
on how to run manila with uWSGI for contributors.
Partially-implements: blueprint wsgi-web-servers-support
Change-Id: I8e68619b00255197b3d3cf6796c60d1a3a04ff36
This was missing for manila, and is required
for us to apply for the assertion that the
service supports accessible upgrades.
Change-Id: Ib3f4c917bdd22209e6b76e2175e3b4b28f05bdba
Signed-off-by: Goutham Pacha Ravi <gouthampravi@gmail.com>
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>
The manila discussed cephfs futures
during the Victoria cycle PTG [1]. To support newer
features in ceph, we'll need to start using the
ceph-mgr interface that debuted in Nautilus.
When we start adopting ceph-mgr, we can no longer
support Mimic, Luminous and older releases of Ceph
without maintaining code workarounds and a continuous
integration system to ensure they're not broken.
This takes considerable effort from community members.
We've supported the Luminous release since OpenStack
Queens, and there have been at least
three other major releases of Ceph in the meantime,
let's add a release note and adjust the ceph driver
documentation calling out our support/testing stance.
[1] http://lists.openstack.org/pipermail/openstack-discuss/2020-June/015494.html
Partially-implements: bp update-cephfs-drivers
Change-Id: Id847b1b5e6623172f2600afd69e51182067444cb
Signed-off-by: Goutham Pacha Ravi <gouthampravi@gmail.com>
The mock third party library was needed for mock support in py2
runtimes. Since we now only support py36 and later, we can use the
standard lib unittest.mock module instead.
Change-Id: Iac98e1abac61757ff143e33f0094babe42cc2e60
This patch updates the admin guide to make it up to date with the
introduced changes for share networks in Train release.
Change-Id: I6ae48e2f174e0197fdeeaca5fd5a96a23c8bb182
Partial-Bug: #1843953
This patch adds documentation in the user guide module to make it
fit into the introduced share network with multiple subnets change.
Change-Id: I829f2e915ba2e20f15af639cccff99b6bba33a24
Partial-Bug: #1843953
Update documentation to fit into the new manila quota keys:
- `share_replicas`
- `replica_gigabytes`
Closes-Bug: #1881921
Change-Id: I91fa2222743da06557ceb52fcbae0f8928d0752c
Switch to openstackdocstheme 2.2.1 and reno 3.1.0 versions. Using
these versions will allow especially:
* Linking from HTML to PDF document
* Allow parallel building of documents
* Fix some rendering problems
Update Sphinx version as well.
Set openstackdocs_pdf_link to link to PDF file. Note that
the link to the published document only works on docs.openstack.org
where the PDF file is placed in the top-level html directory. The
site-preview places the PDF in a pdf directory.
Change pygments_style to 'native' since old theme version always used
'native' and the theme now respects the setting and using 'sphinx' can
lead to some strange rendering.
Remove docs requirements from lower-constraints, they are not needed
during install or test but only for docs building.
openstackdocstheme renames some variables, so follow the renames
before the next release removes them. A couple of variables are also
not needed anymore, remove them.
See also
http://lists.openstack.org/pipermail/openstack-discuss/2020-May/014971.html
Change-Id: I6635fbab5d4cf60be6bc317061cdac2118cebc25
Implements the default filter function for Unity driver, if the
share size is smaller than 3GB, will not schedule the share
creation to Unity backend.
Change-Id: Iebb5063d4e1c4c2f5ddce0d5000b7d51dcb0605b
Closes-bug: #1652379
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
The doc currently refers to an in-tree directory
that we used to have in the distant past.
Also link to config.py and the share backend feature
support matrix where appropriate.
Change-Id: Ic22eba0cedb7c6c7c89ef129a8c6a007d97c7e3b
Signed-off-by: Goutham Pacha Ravi <gouthampravi@gmail.com>
These documents borrow from the cinder, nova and
ironic guides put together painstakingly by
numerous developers.
Change-Id: Ida3480fd1b9cab8eeb9ad002cce7200d89e01cb6
Story: #2007236
Task: #38535
Signed-off-by: Goutham Pacha Ravi <gouthampravi@gmail.com>
Fixed an issue in the contributor reference. The share replicas
documentation has two references to the same driver interface and
it caused a problem while generating docs, since none of them was
tagged with ``:noindex:``.
Change-Id: I9db0f2c07a8178895490fbcab9bfd9dcd2ccf823
Closes-Bug: #1872479
1. Try parse share_backend_id from export path in case
it is managed share.
2. Try to take snapshot id from 'provider_location' in case
this is managed snapshot
3. Try to get share server name from property 'identifier'
first in case this is managed share server
4. Add property 'provider_location' when creating snapshot
Implements: blueprint emc-unity-manage-unmange
Change-Id: I676475d0500ecce31a1a863926accec8585ac83a
Signed-off-by: Goutham Pacha Ravi <gouthampravi@gmail.com>
OpenStack is dropping the py2.7 support in ussuri cycle.
Make a few cleanups:
- Remove python 2.7 stanza from setup.py
- Add requires on python >= 3.6 to setup.cfg so that pypi and pip
know about the requirement
- Remove section from setup.cfg: Wheel is not needed for python
3 only repo
- Update requirements
Change-Id: Ibca03f9ebaeaca595e027be9cb5900c368c8de6d
* Remove doc/source/install/conf.py, it's not used
* Update openstackdocstheme version and remove settings that are now the
default.
* Use docs dependencies for api-ref building.
Change-Id: If37ed5bdbf6a1ef3107e66073eca9917704edee2
