Jump to: navigation, search


Revision as of 12:44, 15 May 2014 by Ilya Shakhat (talk | contribs) (Tracked drivers)


The DriverLog project is on a mission to provide information about drivers and plugins developed for both OpenStack itself and projects related to OpenStack. When it comes to a production OpenStack deployment a customer wants to have an assurance that certain hardware/virtual appliances will really work with certain OpenStack components. The DriverLog project aimed at enabling potential users/developers to quickly determine if a particular vendor driver exists and has been tested for a particular OpenStack release.

Target audience


  • Readily available, community supported driver marketplace.
  • One common and measurable version of the truth with regards to vendor driver compatibility with OpenStack releases.

OpenStack customers

  • Standardized information OpenStack users can use and trust.
  • Improved quality and reliability of OpenStack.

OpenStack Community

  • Encourage more participation of vendors in the community.
  • Meet the quality, reliability and openness expected by OpenStack users.
  • Accelerate OpenStack mission of building a universal, open fabric for an heterogeneous set of components while avoiding component fragmentation and non-operable point products.


DriverLog is a service that collects and processes information about OpenStack drivers, their maintainers, availability in trunk, CI testing status and makes it possible to visualize it in a convenient web dashboard. The Driver dashboard makes it possible to view data by project, vendor and other factors.

Tracked projects

DriverLog stores a list of projects and their drivers in the configuration file default_data.json. Any contributor can add an untracked project. The projects section represents the list of tracked projects. It has the following format:

"projects": [
           "id": "openstack/cinder",
           "name": "Cinder (Block Storage)"
           "id": "openstack/neutron",
           "name": "Neutron (Networking)"
           "id": "openstack/nova",
           "name": "Nova (Compute)"
           "id": "openstack/sahara",
           "name": "Sahara (Data Processing)"

Tracked releases

The releases section represents the list of OpenStack releases. It has the following format:

   "releases": [
           "id": "austin",
           "wiki": "https://wiki.openstack.org/wiki/ReleaseNotes/Austin"
           "id": "bexar",
           "wiki": "https://wiki.openstack.org/wiki/ReleaseNotes/Bexar"
           "id": "cactus",
           "wiki": "https://wiki.openstack.org/wiki/ReleaseNotes/Cactus"
           "id": "diablo",
           "wiki": "https://wiki.openstack.org/wiki/ReleaseNotes/Diablo"
           "id": "essex",
           "wiki": "https://wiki.openstack.org/wiki/ReleaseNotes/Essex"
           "id": "folsom",
           "wiki": "https://wiki.openstack.org/wiki/ReleaseNotes/Folsom"
           "id": "grizzly",
           "wiki": "https://wiki.openstack.org/wiki/ReleaseNotes/Grizzly"
           "id": "havana",
           "wiki": "https://wiki.openstack.org/wiki/ReleaseNotes/Havana"
           "id": "icehouse",
           "wiki": "https://wiki.openstack.org/wiki/ReleaseNotes/Icehouse"
           "id": "juno",
           "wiki": "https://wiki.openstack.org/wiki/Releases"

Tracked drivers

Any contributor can add an untracked driver. The drivers section represents the list of tracked drivers . It has the following format:

           "project_id": "openstack/neutron",
           "vendor": "Tail-f",
           "name": "Tail-f NCS ML2 Mechanism Driver",
           "description": "The Tail-f NCS Mechanism Driver allows OpenStack to drive the Tail-f Network Control System (NCS)",
           "maintainers": [
                   "name": "Luke Gorrie",
                   "irc": "lukego",
                   "email": "luke@tail-f.com",
                   "launchpad_id": "lukego"
           "releases": ["Havana", "Icehouse"],
           "wiki": "https://wiki.openstack.org/wiki/Neutron/ML2/Tail-f-NCS-neutron-ml2-driver",
           "ci": {
               "id": "tailfncs",
               "success_pattern": "Successful",
               "failure_pattern": "Failed"

For each driver the following parameters may be specified:

  • project_id - OpenStack project - one from the list of projects configured in default_data.json (mandatory)
  • vendor - a driver's vendor (mandatory)
  • name - a driver's name (mandatory)
  • description - a driver's description
  • maintainers - information about driver maintainers (there could be several of them), including:
    • name - person's name (mandatory)
    • email - person's email
    • irc - person's nick in IRC
    • launchpad_id - person's id at Launchpad
  • wiki - link to the OpenStack wiki page with driver configuration instructions
  • releases - a list of OpenStack releases the driver supported in (filled for releases not tested by CI)
  • ci - information about CI
    • id - Gerrit id of external CI
    • success_pattern - pattern to parse CI's comment for a successful run
    • failure_pattern - pattern to parse CI's comment for a failed run

Note: CI patterns are needed for determine result for non-voting CIs or if one vote corresponds to multiple drivers

How To: Add a new driver to DriverLog


Before a vendor adds a new driver to the DriverLog, a driver must meet the following requirements:

  • A driver must have a unique and clear name
  • A driver must have a complete and full description. The text should answer the questions: "What does this driver enable? What features does it have?"
  • A driver must have a maintainer. A vendor should provide a maintainer's name and contacts (email, IRC nick).
  • A driver must have a dedicated page on https://wiki.openstack.org/wiki/Main_Page or vendor's web site with configuration details. It's good to add a driver's section to the OpenStack configuration overview document.
  • A driver must be accepted to the OpenStack trunk.

Note: A driver can be deprecated in the current OpenStack release.

Adding a new driver to DriverLog

  • Stackforge/DriverLog uses Gerrit for code review.

Note: Check http://wiki.openstack.org/GerritWorkflow to get the instructions there to upload your change to Gerrit.

            "project_id": "openstack/neutron",
            "vendor": "Extreme Networks",
            "name": "Neutron Plugin",
            "description":"The Extreme Networks OpenStack plugin runs on Extreme XOS 15.3 and later releases. This plug-in is supported on all EXOS based platforms and includes the latest OpenStack API capabilities. The Extreme Networks OpenStack 2.0 plugin enables “Networking-as-a-Service” for both Physical and Virtual Extreme Networks.",
            "wiki": "http://extrcdn.extremenetworks.com/wp-content/uploads/2014/02/SDN_OpenStack_Install_Guide_Final1.pdf",
            "releases": ["Icehouse"]
  • Note: Records in config file should be sorted by key - (project_id, vendor). The configuration file automatically validated against the config file scheme.
  • Send a pull request. Provide it with detailed comments on what was done.
  • A project DriverLog Core Engineer reviews a commit. If everything is ok he/she merges an update.
  • A driver is getting displayed in the Drivers list on the DriverLog Dashboard.
  • ‘CI tested’ column will show cross mark meaning that CI is not present.
  • 'In trunk' column will show a list of releases specified in field 'releases'.

How To: Add a 'CI tested' mark


To be able to add a 'CI tested' mark a vendor must deploy an external voting CI environment that runs automatic tests against a driver on every commit. Instructions for setting up external CI can be found here:

Adding a 'CI tested' mark

To configure the DriverLog to poll external CI for current verification status field 'ci_id' needs to be provided. 'ci_id' is Gerrit Id of external CI, see example below:

           "project_id": "openstack/neutron",
           "vendor": "Embrane",
           "name": "Neutron Plugin",
           "description": "Embrane Neutron plugin enables users to interface Neutron with the Embrane heleos platform.",
           "maintainer": {
               "name": "Ivar Lazzaro",
               "irc": "ivar-lazzaro"
           "wiki": "https://wiki.openstack.org/wiki/Neutron/EmbraneNeutronPlugin",
           "ci_id": "eci"
  • The actual results of driver testing are stored in Gerrit. The backend runs as a scheduled background butch performing the following logic every 4 hours:
  • The DriverLog backend by using CI environment ID (ci_id) recognizes which Gerrit reviews are related to this driver.
  • The backend parses all merged patches from new to old.
  • For every review it checks ci_id and branch (version).
  • If pair ci_id+branch appears for the first time, then the backend stores the pair with test run result and link
  • A 'CI tested’ column will show a check mark meaning that CI is present.

Note: Only known ci_id’s from default_data.json are processed by the backend.

Release Notes

Release 0.1

  • Nova, Cinder, Neutron and Sahara projects included into DriverLog.
  • Information about supported drivers from projects’ wiki pages was manually converted into JSON config file:




Pending Code Reviews


Project space