Backup drivers in OpenStack Configuration Reference Incorrect Drivers

[John Oshiro]

-----------------------------------
Built: 2014-04-17T16:38:06 00:00
git SHA: c0ba4fdd23e934e9a9ac5453dbfbbff8cc21e508
URL: http://docs.openstack.org/icehouse/config-reference/content/section_backup-drivers.html
source File: file:/home/jenkins/workspace/openstack-manuals-tox-doc-publishdocs/doc/config-reference/block-storage/section_backup-drivers.xml
xml:id: section_backup-drivers

The three subsections of thic chapter state that the backup_driver flag needs to be set for each driver type. There is a typographical error that should correct the drivers as follows (".driver." should be ".drivers.", plural, in all cases):
backup_driver=cinder.backup.drivers.ceph
backup_driver=cinder.backup.drivers.tsm
backup_driver=cinder.backup.drivers.swift

In addition, the chapter states, "This section describes how to configure the cinder-backup service and its drivers." but fails to mention that the cinder-backup service is not started by default. Therefore an instruction to start the driver, depending on the OS type, needs to be added to indicate that a service start commands needs to be issued after cinder.conf is updated.

The commands for most Linux (Red Hat, SUSE) will look something like the following (refer to the installation guides):
# service openstack-cinder-backup start
# chkconfig openstack-cinder-backup on

For Ubuntu:
# service cinder-scheduler restart

[Openstack Gerrit (openstack-gerrit)]

Fix proposed to branch: master
Review: https://review.openstack.org/88408

[Openstack Gerrit (openstack-gerrit)]

Reviewed: https://review.openstack.org/88408
Committed: https://git.openstack.org/cgit/openstack/openstack-manuals/commit/?id=874a358eb959a1a47668c01da5cf903bcfce46cf
Submitter: Jenkins
Branch: master

commit 874a358eb959a1a47668c01da5cf903bcfce46cf
Author: Gauvain Pocentek <email address hidden>
Date: Thu Apr 17 21:01:00 2014 +0200

    Fix the cinder backup drivers path

    Correct the values of backup_driver in the config reference.

    Also add some spaces to make samples more easily readable.

    Change-Id: I6f5d9fd40355c3a45b93cec2946257d505aef73f
    Partial-Bug: #1309137

[John Oshiro (joshiro)]

Will you also mention the need to start the cinder-backup service?

The command for Ubuntu above is wrong. It should be:
For Ubuntu:
# service cinder-backup restart

[Gauvain Pocentek (gpocentek)]

Hi John,

I'm not sure that the start of the cinder-backup service should be documented in the config-ref. I'd rather document it in the cloud-admin-guide (if it's not already there).