Difference between revisions of "Cinder"

Jump to: navigation, search

Revision as of 22:33, 20 September 2017

Official Title: OpenStack Block Storage Cinder

PTL: Jay Bryant <jsbryant at electronicjungle d0t net>

Mission Statement:

To implement services and libraries to provide on demand, self-service access to Block Storage resources. Provide Software Defined Block Storage via abstraction and automation on top of various traditional backend block storage devices.

1 Description
2 Core Team
3 Project Meetings
4 Getting in Touch
5 Related projects
6 Core Volume Drivers
7 Contributing Code
- 7.1 How To Contribute A Driver
- 7.2 How To Contribute A New Feature
8 Sample cinder.conf
9 Resources

Description

Cinder is a Block Storage service for OpenStack. It's designed to present storage resources to end users that can be consumed by the OpenStack Compute Project (Nova). This is done through the use of either a reference implementation (LVM) or plugin drivers for other storage. The short description of Cinder is that it virtualizes the management of block storage devices and provides end users with a self service API to request and consume those resources without requiring any knowledge of where their storage is actually deployed or on what type of device.

Core Team

See current members.

Project Meetings

See Meetings/Cinder.

Getting in Touch

We use the openstack-dev@lists.openstack.org mailing list for discussions using subjects with the prefix "[cinder]". We also hang out on IRC in #openstack-cinder on freenode. IRC logs are available in: http://eavesdrop.openstack.org/irclogs/#openstack-cinder/

Related projects

Core Volume Drivers

For a list of the core drivers in each OpenStack release and the volume operations they support, see https://wiki.openstack.org/wiki/CinderSupportMatrix

Contributing Code

For any new features, significant code changes, new drivers, or major bug fixes, please add a release note along with your patch. See the Reno Documentation for details on how to generate new release notes.

How To Contribute A Driver

See How to contribute a driver

How To Contribute A New Feature

See How to contribute a new feature

Sample cinder.conf

The cinder.conf.sample is no longer maintained and tested in the source tree. Currently you can obtain a copy by running the command 'tox -e genconfig' in a cloned version of the Cinder project and then look in etc/cinder/ for the cinder.conf.sample file.

The newly generated file will have all options in the Cinder project, driver options included.

For more information about the generation of the file, please see: Cinder Sample Configuration Devref

Resources

Etherpads

Active

Historic

Review Links

PTG and Summit Meeting Summaries

Cinder YouTube Channel

Midcycle/PTG Videos and Related Content

Retrieved from "https://wiki.openstack.org/w/index.php?title=Cinder&oldid=156848"

Category:

Cinder

@@ Line 1: / Line 1: @@
+'''Official Title:''' OpenStack Block Storage Cinder<br />
-= OpenStack Block Storage ("Cinder") =
+'''PTL:''' Jay Bryant <jsbryant at electronicjungle d0t net><br />
-{| border="1" cellpadding="2" cellspacing="0"
+'''Mission Statement:''' <blockquote>To implement services and libraries to provide on demand, self-service access to Block Storage resources.  Provide Software Defined Block Storage via abstraction and automation on top of various traditional backend block storage devices.</blockquote>
-|  [[https://launchpad.net/cinder/ Cinder on launchpad (including bug tracker and blueprints)]]
-|-
-|  [[https://github.com/openstack/cinder Source code]]
-|-
-|  [[http://docs.openstack.org/developer/cinder/ Developer docs]]
-|-
-|  [[http://docs.openstack.org/grizzly/openstack-block-storage/admin/content/ OpenStack Block Storage Service Administration Guide]]
-|}
-== Related projects ==
+== Description ==
-* Python Cinder client
+Cinder is a Block Storage service for OpenStack.  It's designed to present storage resources to end users that can be consumed by the OpenStack Compute Project (Nova).  This is done through the use of either a reference implementation (LVM) or plugin drivers for other storage. The short description of Cinder is that it virtualizes the management of block storage devices and provides end users with a self service API to request and consume those resources without requiring any knowledge of where their storage is actually deployed or on what type of device.
-* Block Storage API documentation
+== Core Team ==
+See [https://review.openstack.org/#/admin/groups/83,members current members].
+== Project Meetings ==
+See [[CinderMeetings|Meetings/Cinder]].
-== What is Cinder ? ==
+== Getting in Touch ==
+We use the [http://lists.openstack.org/cgi-bin/mailman/listinfo/openstack-dev openstack-dev@lists.openstack.org] mailing list for discussions using subjects with the prefix "[cinder]". We also hang out on IRC in #openstack-cinder on freenode. IRC logs are available in: [http://eavesdrop.openstack.org/irclogs/%23openstack-cinder/ http://eavesdrop.openstack.org/irclogs/#openstack-cinder/]
-Cinder provides an infrastructure for managing volumes in OpenStack.  It was originally a Nova component called nova-volume, but has become an independent project since the Folsom release.
+== Related projects ==
+* [https://github.com/openstack/python-cinderclient Python Cinder client]
+* [https://wiki.openstack.org/wiki/CinderBrick Brick]
-== Reasoning: ==
+== Core Volume Drivers ==
-# Nova is currently a very large project; managing all of the dependencies in linkages of services within Nova can make the  ability to advance new features and functionality very difficult.
+For a list of the core drivers in each OpenStack release and the volume operations they support, see https://wiki.openstack.org/wiki/CinderSupportMatrix
-# As a result of the many components and dependencies in Nova, it's difficult for anybody to really have a complete view of Nova and to be a true expert.  This makes the job of core team member on Nova very difficult, and inhibits good thorough reviews of bug and blueprint submissions.
-# Block storage is a critical component of [[OpenStack]], as such it warrants focused and dedicated attention.
-# Having Block Storage as a dedicated core project in [[OpenStack]] enables the ability to greatly improve functionality and reliability of the block storage component of [[OpenStack]]
-== Documents: ==
+== Contributing Code ==
-* Cinder deep dive (updated for Grizzly): [[File:cinder-grizzly-deep-dive-pub.pdf]]
+For any new features, significant code changes, new drivers, or major bug fixes, please add a release note along with your patch. See the [http://docs.openstack.org/developer/reno/usage.html#creating-new-release-notes Reno Documentation] for details on how to generate new release notes.
-== Minimum Driver Features ==
+=== How To Contribute A Driver ===
-See [https://github.com/openstack/cinder/blob/master/doc/source/devref/drivers.rst driver dev docs]
+See [https://wiki.openstack.org/wiki/Cinder/how-to-contribute-a-driver How to contribute a driver]
-=== Keeping consistant with multi backend ===
+=== How To Contribute A New Feature ===
-In order to maintain consistency with multi backend, do not directly use FLAGS.my_flag, instead use the self.configuration that is provided to the volume drivers. If this does not exist, look @ lvm.py and add it to your driver. using FLAGS.my_flag instead of self.configuration.my_flag will cause multi backend to not work properly. Multi backend relies on the configurations to be within a specific config group in the config file, and the self.configuration abstracts that away from the drivers.
+See [https://wiki.openstack.org/wiki/Cinder/how-to-contribute-new-feature How to contribute a new feature]
-== Keeping informed and providing '''CONSTRUCTIVE INPUT''' ==
+== Sample cinder.conf ==
-The Cinder team currently meets on a weekly basis in #openstack-meeting at 16:00 UTC on Wednesdays.  I try to keep the meetings wiki agenda page http://wiki.openstack.org/CinderMeetings up to date and follow it.  Also keep in mind that '''anybody''' is able to add/suggest agenda items via the meeting wiki page.
+The cinder.conf.sample is no longer maintained and tested in the source tree.  Currently you can obtain a copy by running the command 'tox -e genconfig' in a cloned version of the Cinder project and then look in etc/cinder/ for the cinder.conf.sample file.
-Of course, there's also IRC... a number of us monitor #openstack-cinder or you can always send a PM to jgriffith (that's me)
+The newly generated file will have all options in the Cinder project, driver options included.
-== Concerns from the community: ==
+For more information about the generation of the file, please see: [https://github.com/openstack/cinder/blob/master/doc/source/devref/genconfig.rst Cinder Sample Configuration Devref]
-=== Compatibility and Migration: ===
-There has been a significant amount of concern raised regarding "compatibility"; unfortunately this seems to mean different things to different people.  For those that haven't looked at the Cinder code or tried a demo in devstack, here are some question/answers:
-* Do the same nova client commands I use for volumes today still work the same? '''YES'''
+== Resources ==
-* Do the same euca2ools that I use for volumes today still work the same? '''YES'''
+===Etherpads===
-* Does block storage still work the same as it does today in terms of LVM, iSCSI and the drivers that are curently in place? '''YES'''
+====Active====
-* Are the associated database tables the same as they are in the current nova volume code?  '''For the most part YES, all volume related tables and columns are migrated, non-volume related tables however are not present'''
+*[https://etherpad.openstack.org/p/newton-cinder-midcycle Newton Midcycle]
-* Does it use the same nova database as we use today? '''No, it does require a new independent database'''
+*[https://etherpad.openstack.org/p/cinder-spec-review-tracking Newton Spec Review Tracking]
-* Are you going to implement cinder with complete disregard for my current install and completely change everything out from under me?  '''ABSOLUTELY NOT'''
+*[https://etherpad.openstack.org/p/cinder-outreachy-project-ideas Outreachy Project Ideas]
-* Are you going to test migrating from nova-vol to Cinder? '''YES'''
+*[https://etherpad.openstack.org/p/cinder-default-iscsihelper-lio Default iscsihelper LIO]
-* Are those migration tests going to be done just using fakes/unit tests?  '''NO, we would require running setups, most likely devstack'''
+*[https://etherpad.openstack.org/p/cinder-nova-api-changes Cinder/Nova API Changes]
-* Are you planning to provide migration scripts/tools to move from nova to cinder?  '''YES'''
-=== Additional thoughts to keep in mind: ===
+====Historic====
-* The Cinder core team is fortunate enough to have a number of members who currently work for companies that are using [[OpenStack]] in production environments.  There is a strong representation and the concerns of Providers is in fact a major consideration
+*[https://etherpad.openstack.org/p/newton-cinder-summit-ideas Newton Summit Ideas]
-* The goal is '''NOT''' to throw away nova-volume as it is today, but to separate it, focus on it and improve it.
+*[https://etherpad.openstack.org/p/cinder-mataka-release-final-push Mitaka Final Push]
-* Migration is one of the top priorities for introduction of Cinder into Folsom (regardless of whether nova-volume is still in place or not).  This is something that is just considered a part of the requirements for the project.
+*[https://etherpad.openstack.org/p/mitaka-cinder-spec-review-tracking Mitaka Spec Review Tracking]
+*[https://etherpad.openstack.org/p/mitaka-cinder-midcycle Mitaka Midcycle Meetup- Planning]
+*[https://etherpad.openstack.org/p/cinder-mitaka-summit-topics Mitaka Summit- Planning]
+*[https://etherpad.openstack.org/p/cinder-meetup-summer-2015 Liberty Midcycle Meetup- Notes]
+*[https://etherpad.openstack.org/p/cinder-liberty-midcycle-meetup Liberty Midcycle Meetup- Planning]
-== Cinder Core Drivers ==
+=== Review Links ===
-For a list of the core drivers in each OpenStack release and the volume operations they support, see https://wiki.openstack.org/wiki/CinderSupportMatrix
+* [https://review.openstack.org/#/dashboard/?foreach=project%3A%5Eopenstack%2F.%2Acinder.%2A+status%3Aopen+NOT+owner%3Aself+NOT+label%3AWorkflow%3C%3D%252D1+label%3AVerified%3E%3D1+NOT+label%3ACode%252DReview%3C%3D%252D1%252cself+NOT+label%3ACode%252DReview%3E%3D1%252cself&title=Cinder+Review+Inbox&Cinder+Specs=project%3Aopenstack%2Fcinder%252Dspecs&Bug+Fixes=topic%3A%5Ebug%2F.%2A&Needs+Feedback+%28Changes+older+than+5+days+that+have+not+been+reviewed+by+anyone%29=NOT+label%3ACode%252DReview%3C%3D2+age%3A5d&You+are+a+reviewer%252c+but+haven%27t+voted+in+the+current+revision=reviewer%3Aself&Needs+final+%2B2=label%3ACode%252DReview%3E%3D2+limit%3A50&New+Contributors=reviewer%3A10068&Passed+Jenkins%252c+No+Negative+Feedback=NOT+label%3ACode%252DReview%3E%3D2+NOT+label%3ACode%252DReview%3C%3D%252D1+limit%3A50&Wayward+Changes+%28Changes+with+no+code+review+in+the+last+2days%29=NOT+label%3ACode%252DReview%3C%3D2+age%3A2d Cinder Projects Review Inbox]
+* [https://bugs.launchpad.net/cinder/+bugs?field.searchtext=&orderby=-importance&search=Search&field.status%3Alist=INPROGRESS&assignee_option=any&field.assignee=&field.bug_reporter=&field.bug_commenter=&field.subscriber=&field.structural_subscriber=&field.tag=-drivers&field.tags_combinator=ANY&field.has_cve.used=&field.omit_dupes.used=&field.omit_dupes=on&field.affects_me.used=&field.has_patch.used=&field.has_branches.used=&field.has_no_branches.used=&field.has_blueprints.used=&field.has_no_blueprints.used= In progress bugs]
+* [https://review.openstack.org/#/dashboard/?foreach=project%3A%5Eopenstack%2F.%2Aos-brick.%2A+status%3Aopen+NOT+owner%3Aself+NOT+label%3AWorkflow%3C%3D%252D1+label%3AVerified%3E%3D1+NOT+label%3ACode%252DReview%3C%3D%252D1%252cself+NOT+label%3ACode%252DReview%3E%3D1%252cself&title=OS-Brick+Review+Inbox&Cinder+Specs=project%3Aopenstack%2Fcinder%252Dspecs&Bug+Fixes=topic%3A%5Ebug%2F.%2A&Needs+Feedback+%28Changes+older+than+5+days+that+have+not+been+reviewed+by+anyone%29=NOT+label%3ACode%252DReview%3C%3D2+age%3A5d&You+are+a+reviewer%252c+but+haven%27t+voted+in+the+current+revision=reviewer%3Aself&Needs+final+%2B2=label%3ACode%252DReview%3E%3D2+limit%3A50&New+Contributors=reviewer%3A10068&Passed+Jenkins%252c+No+Negative+Feedback=NOT+label%3ACode%252DReview%3E%3D2+NOT+label%3ACode%252DReview%3C%3D%252D1+limit%3A50&Wayward+Changes+%28Changes+with+no+code+review+in+the+last+2days%29=NOT+label%3ACode%252DReview%3C%3D2+age%3A2d os-brick Review Inbox]
+* [https://review.openstack.org/#/dashboard/?foreach=project:%5Eopenstack/.*python-brick-cinderclient-ext.*%20status:open%20NOT%20owner:self%20NOT%20label:Workflow%3C=%252D1%20label:Verified%3E=1%20NOT%20label:Code%252DReview%3C=%252D1%252cself%20NOT%20label:Code%252DReview%3E=1%252cself&title=python-brick-cinderclient-ext%20Review%20Inbox&Cinder%20Specs=project:openstack/cinder%252Dspecs&Bug%20Fixes=topic:%5Ebug/.*&Needs%20Feedback%20(Changes%20older%20than%205%20days%20that%20have%20not%20been%20reviewed%20by%20anyone)=NOT%20label:Code%252DReview%3C=2%20age:5d&You%20are%20a%20reviewer%252c%20but%20haven't%20voted%20in%20the%20current%20revision=reviewer:self&Needs%20final%20+2=label:Code%252DReview%3E=2%20limit:50&New%20Contributors=reviewer:10068&Passed%20Jenkins%252c%20No%20Negative%20Feedback=NOT%20label:Code%252DReview%3E=2%20NOT%20label:Code%252DReview%3C=%252D1%20limit:50&Wayward%20Changes%20(Changes%20with%20no%20code%20review%20in%20the%20last%202days)=NOT%20label:Code%252DReview%3C=2%20age:2d python-brick-cinderclient-ext Review Inbox]
-== Notes About Submitting Patches ==
+=== PTG and Summit Meeting Summaries ===
-Everyone is welcome to sign the CLA and submit code.  Please be sure you familiarize yourself with the "how to contribute guide" (https://wiki.openstack.org/wiki/How_To_Contribute#If_you.27re_a_developer).
-Keep in mind, there is a disproportionate number of submitters to reviewers.  YOU can help with this!!  Anybody is welcome to review patches, jump in, give a review.  It's a great way to learn more about the code and to help you make better submissions in the future.  It also helps your karma, when you submit a patch if you're an active reviewer core team members are more likely to notice your patch and give it some attention before some others.
+*[[CinderQueensPTGSummary|Queens PTG Summary]]
+*[[CinderPikePTGSummary|Pike PTG Summary]]
-== Cinder Plugins ==
+=== Cinder YouTube Channel ===
-How to submit a plugin/driver: https://wiki.openstack.org/wiki/Cinder/how-to-contribute-a-driver
+* [https://www.youtube.com/channel/UCJ8Koy4gsISMy0qW3CWZmaQ/videos Midcycle/PTG Videos and Related Content]
-The following plugins (from other sources) are avaialble for this project
+[[Category: Cinder]]
-* [https://wiki.openstack.org/wiki/Mellanox-Cinder Mellanox Cinder Plugin] Mellanox Cinder Plugin