Many OpenStack projects include drivers to support specific hardware or software. Examples are:
The documentation team documents the following reference drivers in the Configuration Reference Guide:
If a vendor wants to document their driver, they are invited - but not forced - to include their documentation in the Configuration Reference if they commit to maintain the documentation.
Important
Other documentation (including the Cloud Admin Guide and Networking Guide) will not contain content for third-party drivers. In these books, where third party drivers exist, add the statement: “For other drivers, see Chapter X in the Configuration Reference Guide”.
The following are guidelines for drivers documented by the OpenStack community:
For documentation of other drivers, the following guidelines apply:
If a vendor wants to add more than the minimal documentation, they need to commit to the following guidelines:
For each external driver, the driver is briefly documented in a way that is version independent and includes the current configuration options.
Each section should follow this format:
A short paragraph explaining the driver.
A link with detailed instructions to the vendor site (if there is one).
A default paragraph, for example:
Set the following in your ``cinder.conf``, and use the following options
to configure it.
volume_driver = cinder.volume.drivers.smbfs.SmbfsDriver
And finally, the autogenerated configuration options.
Driver vendors can send in patches for these, or create bugs.
If a vendor wants full documentation in the Configuration Reference, they have to add to the wiki page a contact editor that will take care of the vendor driver documentation. The Documentation team will assign bugs to the contact person, include the contact person in reviews for the vendor driver, and expects timely responses.
If vendor driver documentation becomes outdated and the contact person is not reacting to requests, the Documentation team will change the full documentation to a minimal version.
The documentation team will review vendor drivers and ensure that the various driver documents follow a consistent standard.
Except where otherwise noted, this document is licensed under Creative Commons Attribution 3.0 License. See all OpenStack Legal Documents.