Merge ~chris.macnaughton/ubuntu/+source/python-os-brick:bug/1865754 into ~ubuntu-server-dev/ubuntu/+source/python-os-brick:stable/ussuri

[Chris MacNaughton]

[Chris MacNaughton (chris.macnaughton)]

I have manually built this as well as uploading it to a bionic and focal ussuri PPA:

https://launchpad.net/~chris.macnaughton/+archive/ubuntu/bionic-ussuri
https://launchpad.net/~chris.macnaughton/+archive/ubuntu/focal-ussuri

[Corey Bryant (corey.bryant)]

review: Approve

diff --git a/debian/changelog b/debian/changelog
index 59e444a..cbeeb6f 100644
--- a/debian/changelog
+++ b/debian/changelog
@@ -1,3 +1,10 @@
+python-os-brick (3.0.1-0ubuntu1.3) UNRELEASED; urgency=medium
+
+  * d/p/lp1865754-fix-rbd-connector-for-octopus.patch: Fix RBD connector to
+    work with Ceph Octopus (LP: #1865754).
+
+ -- Chris MacNaughton <[e-mail]>  Wed, 23 Sep 2020 15:17:56 +0000
+
 python-os-brick (3.0.1-0ubuntu1.2) focal-security; urgency=medium
 
   * d/gbp.conf: Create stable/ussuri branch.
diff --git a/debian/patches/lp1865754-fix-rbd-connector-for-octopus.patch b/debian/patches/lp1865754-fix-rbd-connector-for-octopus.patch
new file mode 100644
index 0000000..e7e6eaa
--- /dev/null
+++ b/debian/patches/lp1865754-fix-rbd-connector-for-octopus.patch
@@ -0,0 +1,74 @@
+From 91c73a433a2b3675e661f1fe007b58c2bfaff757 Mon Sep 17 00:00:00 2001
+From: Brian Rosmaita <[e-mail]>
+Date: Tue, 08 Sep 2020 11:44:25 -0400
+Subject: [PATCH] New fix for rbd connector to work with ceph octopus
+
+Found while testing cinder-backup with ceph on Ubuntu Focal, which
+installs ceph Octopus.  Octopus apparently enforces the requirement
+that the config file contain a '[global]' section for general
+requirements.  The '[global]' section goes back at least to ceph
+Hammer [0], so we will simply add it to the temporary ceph config
+file that os-brick generates in the RBDConnector class.
+
+[0] https://docs.ceph.com/docs/hammer/rados/configuration/mon-config-ref/
+
+Co-authored-by: Alex Kavanagh <[e-mail]>
+Co-authored-by: Ivan Kolodyazhny <[e-mail]>
+
+Change-Id: I86eb31535d990291945de5d9846b1a03157ec2cf
+Closes-bug: #1865754
+(cherry picked from commit c6ad4d864c6088b6686919dd0229c926bce7073a)
+(cherry picked from commit 474583b4f8469f7957d6ffbf62829b516189aeae)
+---
+
+diff --git a/os_brick/initiator/connectors/rbd.py b/os_brick/initiator/connectors/rbd.py
+index f62c06b..5135dd8 100644
+--- a/os_brick/initiator/connectors/rbd.py
++++ b/os_brick/initiator/connectors/rbd.py
+@@ -97,7 +97,12 @@
+         try:
+             fd, ceph_conf_path = tempfile.mkstemp(prefix="brickrbd_")
+             with os.fdopen(fd, 'w') as conf_file:
+-                conf_file.writelines([mon_hosts, "\n", keyring, "\n"])
++                # Bug #1865754 - '[global]' has been the appropriate
++                # place for this stuff since at least Hammer, but in
++                # Octopus (15.2.0+), Ceph began enforcing this.
++                conf_file.writelines(["[global]", "\n",
++                                      mon_hosts, "\n",
++                                      keyring, "\n"])
+             return ceph_conf_path
+         except IOError:
+             msg = (_("Failed to write data to %s.") % (ceph_conf_path))
+diff --git a/os_brick/tests/initiator/connectors/test_rbd.py b/os_brick/tests/initiator/connectors/test_rbd.py
+index b8ce8b9..d001765 100644
+--- a/os_brick/tests/initiator/connectors/test_rbd.py
++++ b/os_brick/tests/initiator/connectors/test_rbd.py
+@@ -171,6 +171,10 @@
+                 self.keyring)
+         self.assertEqual(conf_path, tmpfile)
+         mock_mkstemp.assert_called_once_with(prefix='brickrbd_')
++        # Bug #1865754 - make sure generated config file has a '[global]'
++        # section
++        _, args, _ = mockopen().writelines.mock_calls[0]
++        self.assertIn('[global]', args[0])
+ 
+     @mock.patch.object(priv_rootwrap, 'execute', return_value=None)
+     def test_connect_local_volume(self, mock_execute):
+diff --git a/releasenotes/notes/bug-1865754-ceph-octopus-compatibility-0aa9b8bc1b028301.yaml b/releasenotes/notes/bug-1865754-ceph-octopus-compatibility-0aa9b8bc1b028301.yaml
+new file mode 100644
+index 0000000..bdd5986
+--- /dev/null
++++ b/releasenotes/notes/bug-1865754-ceph-octopus-compatibility-0aa9b8bc1b028301.yaml
+@@ -0,0 +1,12 @@
++---
++fixes:
++  - |
++    `Bug #1865754 <https://bugs.launchpad.net/cinder/+bug/1865754>`_:
++    the ``RBDConnector`` class generates a temporary configuration file
++    to connect to Ceph.  Previously, os-brick did not include a
++    ``[global]`` section to contain the options it sets, but with the
++    Octopus release (15.2.0+), Ceph has begun enforcing the presence
++    of this section marker, which dates back at least to the Hammer
++    release of Ceph.  With this release, os-brick includes the
++    ``[global]`` section in the generated configuration file, which
++    should be backward-compatible at least to Ceph Hammer.
diff --git a/debian/patches/series b/debian/patches/series
index fb20c1f..d612674 100644
--- a/debian/patches/series
+++ b/debian/patches/series
@@ -1,2 +1,3 @@
 removes-privacy-breach-in-docs.patch
 CVE-2020-10755.patch
+lp1865754-fix-rbd-connector-for-octopus.patch