35 Commits

Author SHA1 Message Date
Sean McGinnis
40e84d7435 Remove FalconStor volume drivers
These drivers were marked as deprecated and unsupported in the Pike
release due to lack of CI. This situation has not changed, so per our
CI policy they are now being removed.

Change-Id: I7440c5feba238acb1c7f0435f107bc958aaee448
2017-09-13 22:39:18 +00:00
Sean McGinnis
8e6a32a440 Remove Blockbridge volume driver
This driver was marked as deprecated and unsupported in Pike due to
lack of CI. There has been no change in CI status, therefore per our
CI policy it is now being removed.

Change-Id: I31f8ecafe23c5144b11240b8bba0cd94e001bbe4
2017-09-07 23:24:17 +00:00
Sean McGinnis
bfdd54d780 Remove Coho volume driver
The Coho driver was marked as unsupported in Pike. CI has not been
restored for this driver, and isn't likely to be [1].

Per CI policy, removing driver from in-tree.

[1] https://www.theregister.co.uk/2017/08/31/coho_data_shuts_up_shop/

Change-Id: Ic99d7c598c7a111d856ae4f10ad7de0e45f03d3c
2017-09-07 16:44:03 -05:00
yanghuichan
8a490fb6df Fix wrong links in Cinder
Some docs links have changed.
We should update the wrong links in our codes.

Change-Id: I5046be23703192ed6fad805355c8c50b9b4a71c8
2017-09-07 11:55:44 +08:00
Jenkins
4ee1bc921f Merge "Update HPE 3PAR Storage Driver docs for Pike release" 2017-09-04 18:15:31 +00:00
Sumit Shatwara
58c144e425 Update HPE 3PAR Storage Driver docs for Pike release
Change-Id: Ia2ea869f67d705fca2487f7a99ebb5e9e899d398
2017-09-04 09:39:39 +00:00
Jenkins
78b7804599 Merge "Update HPE Lefthand/StoreVirtual Storage Driver doc for Pike release" 2017-08-31 14:37:35 +00:00
Jenkins
c298e65e93 Merge "VMAX driver - Pike documentation amendments" 2017-08-30 16:07:06 +00:00
Helen Walsh
e7e2d3f624 VMAX driver - Pike documentation amendments
VMAX driver documentation amendments.

Change-Id: I477c351ce65e9ff5754998683bf22525530b6421
Closes-Bug: #1708481
2017-08-30 11:56:15 +01:00
Jay S. Bryant
bd22a5d61e [DOC BLD FIX] Fix remote-code-block warnings
There were a number of configuration sample files
(i.e. rootwrap.conf, policy.json and api-paste.ini)
that were trying to be included with the remote-code-block
directive which is no longer supported.

I have copied over the latest sample files for Pike and
made them .inc files.  In the future these should be dynamically
created, but at this point we just need to get something out there
to fix the Sphinx build warnings.  The work to make things
dynamically generated requires more invasive changes like
policy-in-code.

I also discovered that the link from the landing page for the
configuration page had a broken link to the sample cinder.conf
file.  I fix that problem in this patch as well.

Change-Id: I2b587abbdeaee1cfe32b100c98d99131759c2171
2017-08-29 10:53:48 -05:00
sumit7990
6a52d2c4ce Update HPE Lefthand/StoreVirtual Storage Driver doc for Pike release
Change-Id: Ifc50aa927286ccca06cd35a59b4113d3cdbad7f8
2017-08-23 21:50:12 -07:00
Jenkins
b5f1073bef Merge "IBM Storage: add QoS documentation" 2017-08-18 07:54:41 +00:00
Isaac Beckman
9ee61f9fda IBM Storage: add QoS documentation
Add best practice for using QoS feature with IBM Storage
Cinder driver
Also, handle some general text cleanup and formatting

Change-Id: I848f6feaefbdbddb1f77b699012a96b235f7d7eb
Closes-Bug: 1698433
2017-08-17 22:50:53 +03:00
Jenkins
3bf312a64b Merge "[Docs] Storwize:Update document for Pike release" 2017-08-17 01:25:41 +00:00
Yu Zhang
ebbb81dd11 [Docs] Storwize:Update document for Pike release
1. Fix bugs in document.
2. Update for supporting stretch cluster volume/mirror volume.
3. Update for supporting GMCV.
4. Add capability pool_name to specify a specific pool.

Change-Id: I478e1b2ecf685486e65e8a2297109765210e8497
Closes-Bug:#1705607
2017-08-16 06:45:19 +00:00
Jenkins
6dd6c74b38 Merge "[Docs] Add documentation contribution docs" 2017-08-16 02:33:50 +00:00
Patrick East
f82d2bf6f1 Change pure drivers default replication interval
With newer versions of Purity the previous default
value would not be allowed, the minimum is 60 minutes
(3600 seconds).

While this does change a default config value, it
goes from a non-working-crash-the-driver-at-startup
value to a working one.

Along with this I'm bumping the driver version
numbers and fixing typo in the docs about the purity
version (this bug was found with REST API 1.5).

Change-Id: I21148f0d56cb7ce376107253aa67fc808fa40f9f
Closes-Bug: #1709720
2017-08-14 10:57:36 -07:00
Jay S. Bryant
79245a6283 [Docs] Add documentation contribution docs
Now that we are in charge of managing our documentation I thought
we should have a section in the Contributor Guide on
how to contribute documentation.  This patch adds that.

It also resolves build WARNINGS due to the README files I added
not being included in any toctrees and adds the missing README
file to the install directory.

Change-Id: I8e12628b439a400ebd1ee6d691673a16e2c2f9d2
2017-08-10 15:52:46 -05:00
Jay S. Bryant
85f97d86d4 [DOC FIX] Create missing index pages
There was a mistake in the documentation migration.  The
landing pages in the admin and configuration sections should
have been moved to index.html.  That step didn't happen which
is causing it to appear that that content is missing from
the main OpenStack docs website.

This patch updates our main index page and moves the existing
landing pages to index.rst.

Change-Id: Idb96a09f748d3bbebf6eb768dfd2b758da545096
2017-08-10 12:04:13 -05:00
Jenkins
2fa0fad495 Merge "INFINIDAT: add documentation for volume compression" 2017-08-08 22:44:28 +00:00
Arnon Yaari
f348ebd421 INFINIDAT: add documentation for volume compression
When volume compression was introduced in the InfiniBox volume
driver, the driver configuration documentation was not a part of
the Cinder project yet so that feature was not added to the
documentation. This commit adds the documentation of this feature.

Change-Id: I710773c3e5e103a95899fe88b1a0dd9dc5d2b937
2017-08-08 16:39:54 +03:00
Jenkins
51979c59a0 Merge "[DOC BLD FIX] Fix missing references in documentation" 2017-08-08 02:17:48 +00:00
Jay S. Bryant
de219b7134 [DOC BLD FIX] Fix missing references in documentation
The configuration, admin and install guides had pointers to
content that didn't get brought over from openstack-manuals.
This patch addresses that missing content.

The install guides ad a number of places where it referenced the
OpenStack Overview content which seemed reasonable to make available
in our documentation for reference.  I brought along associated figures
that support that documentation.

The windows-iscsi-volume-driver documentation had pointers to
content in the compute/hypervisor documentation that haven't and
may not be migrated.  I pulled the two sections being referenced into
the rst file in Cinder.

The reference in blockstorage-manage-volumes to networking was changed
to use a link to the Neutron documentation.

This eliminates all the Sphinx warnings generated around missing
links to documentation.

Change-Id: I85ad0207ae480d499a34d273895b6a88fb41fda7
2017-08-07 17:16:20 -05:00
Jay S. Bryant
b156d24b6e Make Cinder's Landing Page look like Keystone's
The index.rst page for Cinder was not well suited
to the new openstackdocstheme that was created.  This
resulted in the page just looking like a disorganized
set of links with no visually defined topics or
explanation.

With this patch I emulate the look of the Keystone page
by properly indicating the different topics in the page
and add some text to describe each of the sections.  I also
update some of the old 'Block Storage' pages to use a 'Cinder'
heading for consistency.

Change-Id: I341e8340b960946a86f4ff8fbee3624531b375af
2017-08-07 14:11:53 -05:00
Jay S. Bryant
986a6a015f [DOC BLD FIX] Name files for inclusion properly
The Sphinx build was issuing hundreds of warning for
duplicate labels.  The reason for this was because
all of the tables we had were named as .rst files.
This would cause Sphinx to process them twice and it would
think there were duplicated sections.

There were two ways this could be handled:  1) Exclude the tables
directory from the docs build. 2) Name the files as they should
have always been so they weren't build twice.  Given that
option 1 just masked the problem, I am implementing this
patch using option 2.

So, all the tables we are including in our documentation
have been named from .rst to .inc and the .. include::
directives that use them have also been updated to use
the new file name.

Change-Id: If395eb652f7e3b789bcbd5e6d6d05954c23d8d8a
2017-08-04 15:33:52 -05:00
Jenkins
8d43f6ec58 Merge "VMAX driver - Pike documentation" 2017-08-03 15:26:17 +00:00
Jenkins
36cad38fe1 Merge "[DOC] VMware: Add doc for vmware:adapter_type" 2017-08-02 21:13:40 +00:00
Vipin Balachandran
c42278c5cf [DOC] VMware: Add doc for vmware:adapter_type
Adding documentation for the new extra-spec option
'vmware:adapter_type'.

Change-Id: I6ce48037a988d1f96806c1a918c896a8018b5d43
Closes-bug: #1708001
2017-08-01 19:42:23 -07:00
Vipin Balachandran
e2920901d3 [DOC] VMware: Update config table
Updating VMDK driver config table with the new option
'vmware_adapter_type'.

Change-Id: I77af54cc92188cbdb9043a76fe7f1c8107665cc2
Closes-bug: #1708000
2017-08-01 18:47:49 -07:00
Helen Walsh
6acf8fd888 VMAX driver - Pike documentation
VMAX driver documentation for Pike to reflect new REST architecture.

Change-Id: Icdea641fa45de1751e9f4632630c9a6685d83ce8
Closes-Bug: #1705512
2017-08-01 17:24:15 +01:00
Jay S. Bryant
553e86baa2 [DOC BLD FIX] Add missing files under configuration
I found a file that should have come over with the
migration of the configuration documents.  This patch adds
the missing table.  It also updates an old link to the
cinder.conf.sample file that used to be checked into
the tree to use the dynamically generated file.

Change-Id: I510432fb27a1a32f3c554912e2f578efdd95cfd8
2017-07-28 10:06:36 -05:00
Jenkins
ff7ee2f973 Merge "ScaleIO Driver: Updating config reference" 2017-07-26 18:49:58 +00:00
Jay S. Bryant
1423480fb6 Make doc/source directory compliant with design in spec
The following spec defines what each project's doc/source
directory is supposed to look like:

https://specs.openstack.org/openstack/docs-specs/specs/pike/os-manuals-migration.html

I had not yet moved existing content to follow this design.
This patch does that, moving the devref to the
'contributor' directory.  It also moves the CLI
related documentation into the 'cli' directory.  I have
updated the autodoc generation to now create the api
documentation in 'doc/source/contributor/api'.

This patch also creates a template for future documentation
contribution.  I have created all of the directories
recommended by the spec and have included documentation
as to what should go in each directory.

The index file is updated to point at the new locations for
existing content.

'doc/.gitignore' is updated so that it won't complain about the
automatically generated 'doc/contributor/api' directory.

Change-Id: I55c50fa0b7c1d06c91e40dbcfd11b1c8e8378aa6
2017-07-19 15:59:02 -05:00
Eric Young
0202f6ff45 ScaleIO Driver: Updating config reference
Pike introduced a simpler means of configuring the ScaleIo driver.
Update the config reference with the necessary information.
Updating the config options tables as the process to auto
generate them is not working properly.

Change-Id: I0bb1649d58e0fcf7fa8fdc8230a032a71e3b2ceb
2017-07-18 23:45:26 -04:00
Jay S. Bryant
0395353c4b Move config-reference to configuration
It was discovered today that the 'config-reference' directory
was supposed to have been renamed to 'configuration'.  The doc
team was expecting it to be at that location so that they could
automatically link to it from contributor/index.html .

This patch just moves the directory.  I am going to be submitting
a subsequent patch that properly sets out the framework for the
additional directories so that we don't have addition problems
in the future.

Change-Id: I6729aaf4593a0b089277f6d7d0aa50fee3ca340f
2017-07-18 13:10:25 -05:00