Backup compression algorithm setting should not be case sensitive

Bug #1823852 reported by Eric Miller
6
This bug affects 1 person
Affects Status Importance Assigned to Milestone
Cinder
Fix Released
Undecided
Sean McGinnis

Bug Description

This bug tracker is for errors with the documentation, use the following as a template and remove or add fields as you see fit. Convert [ ] into [x] to check boxes:

- [X] This doc is inaccurate in this way:

This sentence: The option backup_compression_algorithm can be set to bz2 or None.
should be: The option backup_compression_algorithm can be set to bz2 or none.

"None" is invalid. The cinder-backup service logs this:

ConfigFileValueError: Value for option backup_compression_algorithm is not valid: Valid values are [none, off, no, zlib, gzip, bz2, bzip2], but found 'None'

- [ ] This is a doc addition request.
- [ ] I have a fix to the document that I can paste below including example: input and output.

If you have a troubleshooting or support issue, use the following resources:

 - Ask OpenStack: http://ask.openstack.org
 - The mailing list: http://lists.openstack.org
 - IRC: 'openstack' channel on Freenode

-----------------------------------
Release: 11.1.2.dev58 on 2019-01-18 09:07
SHA: 324cc2e3783a0b756f0617a4ec86874223a8554e
Source: https://git.openstack.org/cgit/openstack/cinder/tree/doc/source/admin/blockstorage-volume-backups.rst
URL: https://docs.openstack.org/cinder/pike/admin/blockstorage-volume-backups.html

Revision history for this message
Sean McGinnis (sean-mcginnis) wrote :

This is actually an issue in the code. It should be able to handle different casing.

tags: added: backup-service
removed: doc
summary: - Back up and restore volumes and snapshots in cinder
+ Backup compression algorithm setting should not be case sensitive
Revision history for this message
OpenStack Infra (hudson-openstack) wrote : Fix proposed to cinder (master)

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

Changed in cinder:
assignee: nobody → Sean McGinnis (sean-mcginnis)
status: New → In Progress
Revision history for this message
OpenStack Infra (hudson-openstack) wrote :

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

Revision history for this message
OpenStack Infra (hudson-openstack) wrote : Fix merged to cinder (master)

Reviewed: https://review.opendev.org/651619
Committed: https://git.openstack.org/cgit/openstack/cinder/commit/?id=333e83b8a48b8bfe8960c45a79ab1661179eea2f
Submitter: Zuul
Branch: master

commit 333e83b8a48b8bfe8960c45a79ab1661179eea2f
Author: Sean McGinnis <email address hidden>
Date: Wed Apr 10 12:54:42 2019 -0500

    Use proper casing in backup_compression_algorithm doc

    Docs were stating to set to "None" to disable compression, but currently
    that option is case sensitive and needs to be set to "none".

    Partial-bug: #1823852

    Change-Id: I38c6dacf3bd2a750085da4b48ab9dcfc2ecb0b93
    Signed-off-by: Sean McGinnis <email address hidden>

Revision history for this message
OpenStack Infra (hudson-openstack) wrote :

Reviewed: https://review.opendev.org/651209
Committed: https://git.openstack.org/cgit/openstack/cinder/commit/?id=0c1e261c8b73b07e1fd8d5e6d8f03998fec0fc8c
Submitter: Zuul
Branch: master

commit 0c1e261c8b73b07e1fd8d5e6d8f03998fec0fc8c
Author: Sean McGinnis <email address hidden>
Date: Tue Apr 9 06:52:01 2019 -0500

    Make backup_compression_algorithm case insensitive

    Disaling compression is done by setting the
    backup_compression_algorithm config option to None. The valid values is
    has the option of "none" but our documentation stated "None". This
    caused an error, but should be allowed.

    Closes-bug: #1823852

    Change-Id: I5ae6e715117d0e89a9d2641602f6b70a0ce94c69
    Signed-off-by: Sean McGinnis <email address hidden>

Changed in cinder:
status: In Progress → Fix Released
Revision history for this message
OpenStack Infra (hudson-openstack) wrote : Fix included in openstack/cinder 15.0.0.0rc1

This issue was fixed in the openstack/cinder 15.0.0.0rc1 release candidate.

Revision history for this message
OpenStack Infra (hudson-openstack) wrote : Fix proposed to cinder (stable/stein)

Fix proposed to branch: stable/stein
Review: https://review.opendev.org/687148

Revision history for this message
OpenStack Infra (hudson-openstack) wrote : Fix merged to cinder (stable/stein)

Reviewed: https://review.opendev.org/687148
Committed: https://git.openstack.org/cgit/openstack/cinder/commit/?id=bcf25eb02404a8bf5c7f154f1a36116e2ce08a54
Submitter: Zuul
Branch: stable/stein

commit bcf25eb02404a8bf5c7f154f1a36116e2ce08a54
Author: Sean McGinnis <email address hidden>
Date: Tue Apr 9 06:52:01 2019 -0500

    Make backup_compression_algorithm case insensitive

    Disaling compression is done by setting the
    backup_compression_algorithm config option to None. The valid values is
    has the option of "none" but our documentation stated "None". This
    caused an error, but should be allowed.

    Closes-bug: #1823852

    Change-Id: I5ae6e715117d0e89a9d2641602f6b70a0ce94c69
    Signed-off-by: Sean McGinnis <email address hidden>
    (cherry picked from commit 0c1e261c8b73b07e1fd8d5e6d8f03998fec0fc8c)

tags: added: in-stable-stein
Revision history for this message
OpenStack Infra (hudson-openstack) wrote : Fix included in openstack/cinder 14.0.3

This issue was fixed in the openstack/cinder 14.0.3 release.

To post a comment you must log in.
This report contains Public information  
Everyone can see this information.

Other bug subscribers

Remote bug watches

Bug watches keep track of this bug in other bug trackers.