How To Contribute a driver to Cinder
Third Party CI Requirement Policy
One thing that has been lacking for plugins over the past is any sort of formal CI testing. The OpenStack Project as a whole has had an extremely comprehensive CI implementation for some time now that runs against reference implementations and some of the more common optional configs that are out there. As a Community Cinder (and other projects as well) have agreed that if a vendor wishes to submit a driver for their particular storage device that said vendor should also be required to set up a third party CI system in their lab which runs tempest-dsvm-full against their device for every Cinder commit, and provides feedback in to Gerrit.
This is very much an evolving process and is subject to change, but currently here's where we stand as of June 13, 2014:
- All vendors with a driver in the Cinder code-base are required to have 3'rd party CI testing prior to Juno 3 opening
- Every commit made to Cinder should be ran against the vendors 3'rd party CI environment
- Currently the tests that should be run are 'tempest-dsvm-full'
- Your version should follow a naming template like: "tempest-dsvm-full-<DriverName>"
- Results/logs should be reported just as they are with the OpenStack Infra CI systems
- If a vendor has more than one driver, they need more than one CI system. In other words if you have 3 drivers, you'll be expected to test all 3 of those drivers.
There are a number of resources out there to help deploy your own CI environment. One of the best sources currently is a series of blog posting from Jay Pipes that can be found here: http://www.joinfu.com/2014/02/setting-up-an-openstack-external-testing-system-part-2/
As I mentioned this is an evolving process, there's a good deal more information that's needed here to help folks and we'll get that flushed out as we go along and start having some successes on this.
Before you write any code
- The most important place to start is the How To Contribute Page:
- Hopefully you already familiarized yourself with the Cinder wiki page
Cinder offers a reference implementation that should be used as a model. The reference implementation driver file is cinder/volume/drivers/lvm.py, not to be mistaken for cinder/volume/driver.py which is the base class that all of the drivers inherit from. You must implement all of the methods that exist as core features (check out the driver compat matrix from the cinder wiki).
Note that there are a lot of options that show up there regarding iSCSI targets etc, but this gives you an idea of the expectations in terms of features that are implemented and some of the behaviors. I strongly recommend loading up devstack (you're going to need it to test your driver anyway) and play around with the default LVM. It's really important that you get a feel for how Ciinder works and interacts with the other OpenStack projects before you get too far along.
We have a development channel on freenode: #openstack-cinder There are developers here round the clock, it's a great resource for you get started. Log in, ask questions, don't stare at code in isolation for a week... if you're stuck on something just ask. There' also no need to start off with "Can I ask a question"... you likely won't get a response. Just type in your question, that way anybody monitoring the channel that might know the answer can step in and answer.
Before You Submit Code
There's a number of things that you should get from the "how to contribute guide" but to reiterate as they're often missed:
- You need to submit a detailed blueprint in Launchpad introducing your driver and submitting it for approval
- Have a general idea of how Cinder works, what it's used for, why the other projects in OpenStack may or may not use it
- Fully understand the difference between ephemeral storage on the Nova side versus the persistent storage offered by Cinder
Oh, and don't forget
Unit tests for new code are required. We're in the process of converting everything to use mock (rather than mox) for our unit tests. Be sure when writing unit tests and setting up fakes to use mock, examples of it's usage can be found in the existing tests like cinder/tests/test_volume.py.
There's an expectation that unit tests leave the system as they found it. That means using things like the tempfile module if you have to write out some persistent data somewhere for your test.
There's an expectation that any backend device and every driver that is submitted can successfully run and pass the existing OpenStack Tempest tests. Every commit in OpenStack goes through an automated gate test, all we ask here is that since we won't have your backend device that you run this yourself an make sure you've covered all of the required features and that everything works as expected. We have a script to help you with that in the devstack tree: https://github.com/openstack-dev/devstack/tree/master/driver_certs. This is relatively new and needs some more flushing out as well as some documentation, but it's a start and it should progress and grow as time goes by.