1. doc/source/_static will be auto generated when build docs and usually
cause difference with the original one after doc building.
2. manila/doc/.gitignore file is unnecessary because manila/.gitignore
already ignore the doc/build directory.
3. add git ignore of doc/source/_static in manila/.gitignore
Change-Id: Ibf13e08f0b0b57718d453ee3240d30124940b521
1. remove duplicate html_last_updated_fmt in doc/source/conf.py
the second one cause the new added one not take effect.
2. update html_last_updated_fmt in api-ref/source/conf.py
use the recommended '%Y-%m-%d %H:%M' data time format.
Change-Id: Ib37b8a05c88667b34438186c55b6eb3f64b64960
Some docs links have changed.
We should update the wrong links in our codes.
Change-Id: Id45d9f96abad7c6b5163e45ed7f1b1c2608ef022
Signed-off-by: yanghuichan <yanghc@fiberhome.com>
This isn't actually used and is a leftover from a thing we did
seven years ago that survives today through copy-pasta.
Change-Id: I80972fec4c20bfaff82ebee56d84aac6aa65ac29
This causes failure when use build_sphinx to generate docs.
Fix it by replace the ini code block with console.
Change-Id: Iaf15fc99fefceb58c765fabc947f99ad8225723b
Closes-bug: #1713291
In accord with the OpenStack documentation migration spec [1],
this patch pulls over material from the centralized Configuration
Reference so that it will not be lost. As indicated in the spec,
dynamic generation of this material will be left for later work.
[1] https://specs.openstack.org/openstack/docs-specs/specs/pike/os-manuals-migration.html
Closes-Bug: #1706181
Depends-On: Ib0fca0c16e14c05307bfc31ae50c65271b7402f1
Depends-On: Ia750cb049c0f53a234ea70ce1f2bbbb7a2aa9454
Change-Id: I7f3b584ac9907da1f07dedd26324cf4703bc7e6c
"python setup.py build_sphinx -b man" was failing after the new
directory layout introduced by https://review.openstack.org/491092.
Change-Id: I7aa904c0a3b043ce4c3aa25aba25486cec07d22a
In accord with the OpenStack documentation migration spec [1],
this patch pulls over material from the centralized CLI Reference
so that it will not be lost.
[1] https://specs.openstack.org/openstack/docs-specs/specs/pike/os-manuals-migration.html
Partial-Bug: #1706181
Needed-By: I7f3b584ac9907da1f07dedd26324cf4703bc7e6c
Depends-On: I04237021943bb7501acb9cfb7252be2cbf07ac4b
Depends-On: Ia750cb049c0f53a234ea70ce1f2bbbb7a2aa9454
Change-Id: Ib0fca0c16e14c05307bfc31ae50c65271b7402f1
In accord with the OpenStack documentation migration spec [1],
this patch pulls over material from the centralized User Guide
so that it will not be lost.
[1] https://specs.openstack.org/openstack/docs-specs/specs/pike/os-manuals-migration.html
Partial-Bug: #1706181
Needed-By: Ib0fca0c16e14c05307bfc31ae50c65271b7402f1
Depends-On: Ibe3588c3f4560c037cf109058fc357234e70a846
Depends-On: Ia750cb049c0f53a234ea70ce1f2bbbb7a2aa9454
Change-Id: I04237021943bb7501acb9cfb7252be2cbf07ac4b
There is little material on manila in the centralized Install
Guide to migrate as outlined in the migration spec [1], so copy
from our local install guide. After we complete this migration,
we can remove the job that builds the local install guide and
remove it from the manila tree.
[1] https://specs.openstack.org/openstack/docs-specs/specs/pike/os-manuals-migration.html
Change-Id: Ibe3588c3f4560c037cf109058fc357234e70a846
Partial-Bug: #1706181
Needed-By: I04237021943bb7501acb9cfb7252be2cbf07ac4b
Depends-On: I7924d94b82e7c8d9716bad7a219fc38c57970773
Depends-On: Ia750cb049c0f53a234ea70ce1f2bbbb7a2aa9454
Migrate the shared file systems documents from the
centralized Admin Guide as outlined in the migration
spec [1].
[1] https://specs.openstack.org/openstack/docs-specs/specs/pike/os-manuals-migration.html
Partial-Bug: #1706181
Needed-By: Ibe3588c3f4560c037cf109058fc357234e70a846
Depends-On: Ieea33262101a1d2459492c1c8aaac5fe042279f6
Depends-On: Ia750cb049c0f53a234ea70ce1f2bbbb7a2aa9454
Change-Id: I7924d94b82e7c8d9716bad7a219fc38c57970773
This patch introduces a new directory layout
in doc/source in conformance with the OpenStack
manuals project migration spec [1], moves the
existing content in manila/doc/source into the
new directories, and adjusts index files accordingly.
This is the first step in the migration process
as outlined in the spec.
[1] https://specs.openstack.org/openstack/docs-specs/specs/pike/os-manuals-migration.html
Partial-Bug: #1706181
Needed-By: I7924d94b82e7c8d9716bad7a219fc38c57970773
Depends-On: Ifc80fc56648cef74c85464321d1850e8c68449a0
Depends-On: Ia750cb049c0f53a234ea70ce1f2bbbb7a2aa9454
Change-Id: Ieea33262101a1d2459492c1c8aaac5fe042279f6
Finish the transition to the openstackdocs theme in accord
with the OpenStack manuals project migration spec [1].
Also remove the already broken autodoc build since
it generates warnings (which we treat as errors) with
the new theme setup.
[1] https://specs.openstack.org/openstack/docs-specs/specs/pike/os-manuals-migration.html
Partial-Bug: #1706181
Needed-By: Ieea33262101a1d2459492c1c8aaac5fe042279f6
Depends-On: Ia750cb049c0f53a234ea70ce1f2bbbb7a2aa9454
Change-Id: Ifc80fc56648cef74c85464321d1850e8c68449a0
ONTAP supports assigning QoS policy groups to storage
objects and workloads. [1]
Expose this functionality through the ONTAP manila
drivers (DHSS=True/False, NFS, CIFS).
The drivers will set the capability "qos" to True if the
configured credentials have access to create qos policy
groups on the configured ONTAP backend. When 'qos'
extra-spec is set in share types, scoped extra-specs can
be used to specify QoS ceiling values in iops or bps.
The drivers support the following QoS specs:
'netapp:maxiops', 'netapp:maxiopspergib', 'netapp:maxbps',
'netapp:maxbpspergib'. Policies are created on-demand
and manipulated as and when shares are manipulated
through manila.
[1] http://docs.netapp.com/ontap-9/index.jsp?topic=%2Fcom.netapp.doc.pow-perf-mon%2FGUID-38357C43-FB36-419D-B31F-6FD75B47254D.html
Implements: blueprint netapp-cdot-qos
Change-Id: I6f82c012ea60cfb1e9f82a696e2346ee95c60df3
For quite some time, OpenStack services have wanted to be able to send
messages to API end users (by user I do not mean the operator, but the
user that is interacting with the client).
This patch implements basic user messages with the following APIs.
GET /messages
GET /messages/<message_id>
DELETE /messages/<message_id>
Implements the basic /messages resource and tempest tests
The patch is aligned with related cinder patch where possible:
I8a635a07ed6ff93ccb71df8c404c927d1ecef005
DocImpact
APIImpact
Needed-By: I5ffb840a271c518f62ee1accfd8e20a97f45594d
Needed-By: I9ce096eebda3249687268e361b7141dea4032b57
Needed-By: Ic7d25a144905a39c56ababe8bd666b01bc0d0aef
Partially-implements: blueprint user-messages
Co-Authored-By: Jan Provaznik <jprovazn@redhat.com>
Change-Id: Ia0cc524e0bfb2ca5e495e575e17e9911c746690b
When build packages from sdist tarballs, git is not available. So
allow building the documentation without git.
Change-Id: I2e65c7eb6da2f87d97b8eae9fb7411de66416739
Oslo_reports enables OpenStack projects to dump Guru Meditation
Reports with useful debugging information to files or stderr.
By default it will genarate report to stdout stream.
To configure GMR you have to add the following section
to manila.conf:
[oslo_reports]
log_dir = '/path/to/logs/dir'
Implements: blueprint guru-meditation-report
Change-Id: Ia730d56374764231e5ec88f0b71ff8e23361fa6a
Add a NFS protocol helper class that can modify exports of a Ganesha
server based on share access rule changes. This allows the manila
guests to access shares in CephFS backend using NFS protocol through
NFS-Ganesha gateways.
And while adding the driver's helper class that subclasses Ganesha
library's GaneshaNASHelper2 identified minor issues in the
Ganesha library. Fix the issues by:
* escaping special character '=' in values of Ganesha conf's string
options, except for option CLIENTS, by enclosing the values with
double quotes.
* add a new callback interface to GaneshaNASHelper class to
allow driver's to perform Ganesha FSAL specific cleanup.
Partially-implements: bp cephfs-nfs-support
Depends-On: I5234bae0595efdcd30305a32bf9c121072a3625e
Change-Id: I9709d94cdb6f8d3e92b8dfc91b2ec4e154a8ec20
The documentation for the CephFS Native Manila driver would
show the configuration stanza with the
"cephfs_snapshot_support" option set to "true". The snapshot
support in CephFS is experimental and comes with a list of
caveats, so this patch changes the value shown in the example
to be "false" as well as adds a warning after the command to
enable snapshots in the doc explaining the risks involved with
CephFS snapshots.
Change-Id: I4f2c7ebf213c85abd25da078e3dd4999c5e7333d
glusterfs is an open source community supported distributed
filesystem so remove references to *Red Hat* GlusterFS since
that phrase gives the impression that the glusterfs drivers
are scoped only to the Red Hat Gluster Storage product.
TrivialFix
Change-Id: I373cbc75700cf0d8cc252500ebb7af0b0893497b
You can dynamically update access lists of exports with Ganesha
version >= 2.4. Make ganesha library use this feature in a new helper
class, GaneshaNASHelper2, to cleanly implement share access rules
changes without undesired interruptions.
When updating a share's access rules, the new helper class differs
from the older GaneshaNASHelper class as follows:
* Looks for an existing export and edits its client access list;
creates a new export if it can't find one; and removes an export if
the access list ends up empty. Rather than awkwardly create or
remove an export per addition or removal of an access rule.
* Issues DBUS UpdateAccess command to dynamically update an export.
Implements: bp ganesha-dynamic-update-export
Co-Authored-By: Csaba Henk <chenk@redhat.com>
Change-Id: I01ec100c0afe28a84e9afa8e0660d299e4b3d160
Currently, Manila's devstack plugin clone manilaclient. Some projects
depend on Manila but would like to install packaged manilaclient.
Clone the manilaclient only if it was marked to be used from git
Change-Id: Ia8e726b9358f6901c172a31f638a59eba523e0fa
Depends-On: I94d2f143159b60c4f8693e35fe844bc1e411e580
Refactor CephFSNativeDriver as a driver class using protocol helper
classes. The helper classes would handle protocol specific driver
actions such as controlling access and fetching share's export
locations. For now, the driver uses a protocol helper to support
CephFS's native protocol. The driver can be made to support other
NAS protocols later on by adding protocol helper classes.
Since the driver would not just support the native protocol
rename the driver's file name and its driver class as
`driver` and `CephFSDriver` respectively. The driver would by
default support the native protocol, and can be referred to
by its previous class name and module name.
DocImpact
Partially-impelements: blueprint cephfs-nfs-support
Change-Id: I8a33be1df4864131435b794e791cc2d651fbe741
Our form of todo extension does not work with sphinx 1.5.2.
Remove it to unblock gate: we can add todos back in later with
more current methods. Also clean up some dangling cross-references
in the doc.
Co-Authored-By: Valeriy Ponomaryov <vponomaryov@mirantis.com>
Change-Id: If74b9e32ad2b5d8d70da60895d85588ff993797e
Make use of doc8 to verify all rst files which are not
autogenerated for errors and fail if there are any issues
found. The doc8 checks are now part of the tox 'docs'
environment and ran automatically. Checks can also be called
direcly via 'tox -e docs'.
Fix all issues found by doc8.
Closes-Bug: #1664841
Change-Id: I9215524d35646de7485504e4c5ff86fd91a1d09f
Signed-off-by: Danny Al-Gaaf <danny.al-gaaf@bisect.de>
