1365 Commits

Author SHA1 Message Date
Gorka Eguileor
2707632147 Doc: Improve name_id documentation
Currently our code and contributor documentation doesn't mention the
difference between the two different UUIDs we can have and how drivers
should use them.

This patch tries to provide a brief description about it in multiple
places to reduce the number of bugs that happen around it.

Change-Id: I946ead7547571ccd1b2df55ac1f3d4689d1f8089
2022-05-12 19:54:03 +02:00
Zuul
b146d41877 Merge "JovianDSS: fix default value in documentation" 2022-05-12 15:04:26 +00:00
Zuul
5204c6eb16 Merge "Added documentation about backup_file_size about memory usage" 2022-05-02 07:21:35 +00:00
Zuul
6fb89b0c08 Merge "Add review best practices section" 2022-04-29 20:27:40 +00:00
Zuul
51f310ce3b Merge "Fix reported storage_protocol" 2022-04-29 19:50:29 +00:00
Zuul
519d3d571a Merge "Fix example of failed migrarion for LVM->RBD" 2022-04-29 19:50:20 +00:00
Zuul
d6a14cff8f Merge "[doc] update releasecycle tasks" 2022-04-29 16:47:39 +00:00
Zuul
1ab044a22d Merge "Rename Dell EMC to Dell" 2022-04-29 16:47:33 +00:00
Zuul
879ee17d9b Merge "[docs] Update cinder-stable-maint description" 2022-04-29 16:47:16 +00:00
Vladislav Belogrudov
7ee223837e Fix example of failed migrarion for LVM->RBD
Migration from and to RBD devices works for in-use volumes since
Ussuri release. Also as of now a migration of in-use volumes for
non-active VMs is prohibited for any backends.

Related-Bug: #1673090
Related-Bug: #1868996
Closes-Bug: #1969913
Change-Id: Id639c412a6f5ad24ab9c80416c56c1d99b3f104c
2022-04-29 17:47:24 +03:00
Zuul
f34eb4928a Merge "Add statement about CI for backports" 2022-04-28 05:04:30 +00:00
Alexander Malashenko
5cb4e21d93 Rename Dell EMC to Dell
cinder/docs directory has a references to the Dell EMC company name.
Rename all Dell EMC references to Dell, except for those references where there are paths.
When the user will read the documentation he will see the new company name.
These changes are due to the company’s rebranding.

Closes-Bug: #1970208
Change-Id: I60e06b1b42974ce7ef4d790f050d706dc1a8a7a3
2022-04-25 07:28:45 -07:00
Brian Rosmaita
ddc0d39b38 [doc] update releasecycle tasks
Add reminder to update meeting info at meetings.opendev.org

Change-Id: Id903012774df596e9a8b200abd39947b99325157
2022-04-22 08:54:38 -04:00
whoami-rajat
cf6e53b2ee Add review best practices section
This doc change aims at creating a checklist of points which would
help reviewers provide useful feedback while reviewing patches.

Change-Id: I1af1ea6b1dab2bc2e5420076ffe7977f11a4aa75
2022-04-22 16:57:32 +05:30
Brian Rosmaita
9cb338b821 [doc] update driver review checklist
Add info about using well-respected cryptographic libraries.

Change-Id: If50a8f18ceab920bb5c82fb1f79b5f63e6399497
2022-04-20 15:18:32 -04:00
Brian Rosmaita
b45379de37 Add statement about CI for backports
Back in February, the cinder project announced a policy that we'd
like to see CI results documented on driver backports:
http://lists.openstack.org/pipermail/openstack-discuss/2022-February/027021.html

Bring this info into the contributor documentation.

Change-Id: Ide112de44887c031cf160e30dbdfe083c1998bda
2022-04-20 12:50:24 -04:00
Gorka Eguileor
39e518456c Fix reported storage_protocol
Cinder has multiple drivers reporting the same storage_protocol in their
stats but with different strings:

For example we have the following variants:
- nfs and NFS
- nveof, NVMe-oF, NVMeOF
- iSCSI, iscsi
- FC, fc, fibre_channel

This patch documents the right values (to use existing constants) and
makes the scheduler treat all variants as if they were equal.

This is done by changing the storage_protocol into a list in the
scheduler upon reception of the stats from the volume.  Most of the code
in the scheduler is already able to handle this, the only changes
necessary are on the filter and goodness function code, which will now
run the respective functions for all the different protocol alternatives
and select the right one, but only when the function actually uses the
storage_protocol.

The API will now report the preferred protocol name in operations like
"cinder get-pools --detail".

Closes-Bug: #1966103
Change-Id: I07d74078dbb102490dd722029e32c74cec3aa44c
2022-04-20 18:48:24 +02:00
Andrew Bogott
b661d115f5 Added documentation about backup_file_size about memory usage
I just spent a while chasing phantom OOM crashes in the backup
agent; I'm hoping this comment will help future users avoid
my problem.

Change-Id: I58ff10d212283b032cabf623021d3955111ff8f0
2022-04-14 14:21:04 -05:00
Brian Rosmaita
61fa40b2ba [docs] Update cinder-stable-maint description
The OpenStack stable-maint-core team has changed from having approval
over project stable core teams to having a consulting role by this
resolution:
https://governance.openstack.org/tc/resolutions/20210923-stable-core-team.html

Change-Id: I8963dbd9e7890804ad50315e8295ae007590b939
2022-04-01 16:19:45 -04:00
Zuul
7d5270dc0e Merge "Update new driver review checklist" 2022-04-01 13:40:30 +00:00
Zuul
0d9076383c Merge "PowerMax Docs - Clarify Replication Group" 2022-03-29 21:55:47 +00:00
Helen Walsh
12a3e20507 PowerMax Docs - Clarify Replication Group
Clarification on how to set up a replication group
for the PowerMax driver.

Change-Id: I50fc926275dec1360fc3880bbfb8780078e01bce
2022-03-29 17:52:41 +03:00
Brian Rosmaita
3ab151cdba [doc] Add info about backport policies
Change-Id: Ic2ac2a2b3356f7d98cc5c17da925f90739b4c061
2022-03-23 09:10:02 -04:00
Zuul
18bc46080f Merge "doc: RBD: add documentation to configure RBD mirroring" 2022-03-18 20:40:22 +00:00
Zuul
17697bd91a Merge "PowerFlex: update supported versions in driver documentation" 2022-03-18 19:59:25 +00:00
Zuul
162d3fb705 Merge "In support matrix, move Nimble driver entries next to HPE driver" 2022-03-18 19:36:38 +00:00
Gorka Eguileor
ce4cae9bf7 Docs: fix small typo on contributor gerrit
Fix a typo where it said locking instead of looking.

Change-Id: I81a6957bba82775712350ca841db6dd83016eaf0
2022-03-16 15:40:17 +01:00
Zuul
9a8f867321 Merge "lightos - bugfix compression stats should be True" 2022-03-10 21:53:20 +00:00
yuval brave
c04e2084f3 lightos - bugfix compression stats should be True
the compression value in get_volume_stats should be ["True", "False"]
and not dependent on the
configuration: "lightos_default_compression_enabled"
if the flag is false, we can not create volume type with
compression=True. the backend is filtered in the scheduler.

Closes-Bug: #1962221

Signed-off-by: Yuval Brave  <yuval@lightbitslabs.com>
Change-Id: I09fe872eca1b112f67bad7297de5893696f83373
2022-03-10 18:36:41 +02:00
Zuul
6a8f7c1edf Merge "Doc: IBM FlashSystem family update in IBM Spectrum Virtualize user guide" 2022-03-10 14:16:19 +00:00
Zuul
82e6ada531 Merge "docs: Remove unnecessary 'blockstorage-' prefix" 2022-03-08 15:45:44 +00:00
Zuul
a803c275c1 Merge "db: Enable auto-generation of database migrations" 2022-03-08 15:45:40 +00:00
manishladdha
634c81e697 Doc: IBM FlashSystem family update in IBM Spectrum
Virtualize user guide

This change is in order to include all of the new
products that are coming out for SVC 8.5.0.0

Change-Id: I3d798f0f880b4cccec918807acfcce7f70d7d1d7
2022-03-08 07:40:21 +00:00
Zuul
b1fd778cc8 Merge "docs: Rework and move upgrades guide" 2022-03-08 02:16:13 +00:00
Zuul
c7f700db9c Merge "docs: Add whereto for testing redirect rules" 2022-03-08 00:37:57 +00:00
Zuul
fab51b6af0 Merge "Move nimble driver code to hpe folder" 2022-03-02 11:54:20 +00:00
raghavendrat
6e836bda3c In support matrix, move Nimble driver entries next to HPE driver
This patch is follow up patch to:
https://review.opendev.org/c/openstack/cinder/+/786054
Move nimble driver code to hpe folder

Updated the support matrix

Change-Id: I5e95acfe6c3066e038ca77698baa94807b0fbedb
2022-02-28 12:19:45 +00:00
Zuul
5b89039e9e Merge "Remove the need for project_id from API endpoints" 2022-02-23 15:40:46 +00:00
Stephen Finucane
52370e58fe docs: Remove unnecessary 'blockstorage-' prefix
These are in the cinder doc tree so of course they're block
storage-related.

Change-Id: Ic1950ff89021a89de397619eef17f8100eb3d847
Signed-off-by: Stephen Finucane <stephenfin@redhat.com>
2022-02-20 19:06:32 +00:00
Stephen Finucane
31f8ad4eb4 db: Enable auto-generation of database migrations
Alembic does lots of new things. Provide docs for how to use this. This
doesn't actually work that well at the moment because it appears our
database migrations are not in sync with the models. Those issues will
have to be resolved separately.

Change-Id: I6645ca951114b94ce9ed5a83e5e11d53879a7cd5
Signed-off-by: Stephen Finucane <stephenfin@redhat.com>
2022-02-20 19:06:01 +00:00
Stephen Finucane
0d7f3ba862 docs: Rework and move upgrades guide
This shouldn't be in the root of the docs: it's not easily discoverable
and it doesn't belong there. We also modify the header style to better
match the OpenStack style guide [1] and set things up for a future guide
on writing database migrations.

[1] https://docs.openstack.org/doc-contrib-guide/rst-conv/titles.html#cg-titles

Change-Id: I277b9ad8d275aa21d2c3ce478d2a30e4f6e5f0ba
Signed-off-by: Stephen Finucane <stephenfin@redhat.com>
2022-02-20 19:06:00 +00:00
Stephen Finucane
31303ed65e docs: Add whereto for testing redirect rules
Use whereto to test that the redirect rules do what we expect. This has
been used in nova-land for years and is helpful as things move around.

Change-Id: I4697c4ce53eb8d67d2f7593085e3eb88f239d1dd
Signed-off-by: Stephen Finucane <stephenfin@redhat.com>
2022-02-20 19:05:46 +00:00
Zuul
ac0779ad18 Merge "PowerMax docs - Include a note in cinder backup section" 2022-02-18 16:48:32 +00:00
Zuul
5c12e13ffd Merge "PowerFlex documentation contains invalid paths" 2022-02-18 15:20:03 +00:00
Zuul
15b5dacb78 Merge "DOC: Add cinder modules on initial configuration" 2022-02-18 14:21:35 +00:00
Zuul
39482ea6ed Merge "docs: Add docs for 'RateLimitingMiddleware'" 2022-02-17 23:04:48 +00:00
Brian Rosmaita
955d6a6e25 Update 'cinder-specs-core' description
We've expanded it to include appropriate non-cinder-core people,
so update the description to reflect that.

Change-Id: If9e6d841ada5938a6c42f9fc75b5e11313dd3bcf
2022-02-14 15:10:57 -05:00
Alan Bishop
31b34e91e0 Remove the need for project_id from API endpoints
Inclusion of a project_id in API URLs is now optional, and no longer
required. Removing the project_id requirement facilitates supporting
Secure RBAC's notion of system scope, in which an API method is not
associated with a specific project.

The API v3 routing is enhanced to provide duplicate routes for API
methods that traditionally required a project_id in the URL:
- The existing route for which a project_id is in the URL
- A new route for when the URL does not include a project_id

To test both routes and ensure there are no regresssions, the "API
samples" functional tests include a project_id in the URLs, and the
rest of the functional tests do not include the project_id. This is
handled by changing the 'noauth' WSGI middleware to no longer add the
project_id, and adding a new 'noauth_include_project_id' middleware
filter that implements the legacy behavior.

A new microversion V3.67 is introduced, but it only serves to inform
clients whether the project_id is optional or required. When an API
node supports mv 3.67, the project_id is optional in all API requests,
even when the request specifies a earlier microversion. See the spec
Ia44f199243be8f862520d7923007e7182b32f67d for more details on this
behavior.

Note: Much of the groundwork for this is based on manila's patch
I5127e150e8a71e621890f30dba6720b3932cf583.

DocImpact
APIImpact

Implements: blueprint project-id-optional-in-urls
Change-Id: I3729cbe1902ab4dc335451d13ed921ec236fb8fd
2022-02-08 08:32:23 -08:00
Brian Rosmaita
bf0b6e7940 Update new driver review checklist
- add info about reporting common config options
- update python version testing info for third party CI
- add info about unit test discovery
- add warning about a child driver reporting parent capabilities
  that it may not have

Change-Id: Ife214328cdb08ea9a3939b61469fd70b100ed3c7
2022-02-04 12:00:27 -05:00
Brian Rosmaita
f1062f4be0 docs: Update "Getting your patch merged"
Move the "how to review" note to the "Getting your patch merged"
section of the new contributor doc, add some info about project
priorities and milestones/freezes, and the importance of having
a +1 from Zuul.

Change-Id: Ia184482946a0afda783004c7902c682141ed9278
2022-02-03 18:54:01 -05:00