From e22814e092ccd3de450145ac5ff68cf1c1b01630 Mon Sep 17 00:00:00 2001 From: James Page Date: Thu, 7 Apr 2016 11:44:46 +0100 Subject: [PATCH] Add support for Juju network spaces Juju 2.0 provides support for network spaces, allowing charm authors to support direct binding of relations and extra-bindings onto underlying network spaces. Add public and cluster extra bindings to this charm to support separation of client facing and cluster network traffic using Juju network spaces. Existing network configuration options will still be preferred over any Juju provided network bindings, ensuring that upgrades to existing deployments don't break. Change-Id: If4ce1ef545638130cb7e5f0d77b949d9b2e28090 --- .project | 2 +- .pydevproject | 5 ++- README.md | 23 ++++++++++++++ hooks/ceph_hooks.py | 4 +++ hooks/utils.py | 32 ++++++++++++++++--- metadata.yaml | 3 ++ unit_tests/test_ceph_networking.py | 51 ++++++++++++++++++++++++++++++ 7 files changed, 114 insertions(+), 6 deletions(-) create mode 100644 unit_tests/test_ceph_networking.py diff --git a/.project b/.project index be5d420..17434fc 100644 --- a/.project +++ b/.project @@ -1,6 +1,6 @@ - ceph + ceph-mon diff --git a/.pydevproject b/.pydevproject index 998e0aa..683d89d 100644 --- a/.pydevproject +++ b/.pydevproject @@ -3,6 +3,9 @@ python 2.7 Default -/ceph/hooks +/ceph-mon/hooks +/ceph-mon/unit_tests +/ceph-mon/tests +/ceph-mon/actions diff --git a/README.md b/README.md index a66ca06..5d66b59 100644 --- a/README.md +++ b/README.md @@ -54,6 +54,29 @@ You can use the Ceph OSD and Ceph Radosgw charms: - [Ceph OSD](https://jujucharms.com/precise/ceph-osd) - [Ceph Rados Gateway](https://jujucharms.com/precise/ceph-radosgw) +## Network Space support + +This charm supports the use of Juju Network Spaces, allowing the charm to be bound to network space configurations managed directly by Juju. This is only supported with Juju 2.0 and above. + +Network traffic can be bound to specific network spaces using the public (front-side) and cluster (back-side) bindings: + + juju deploy ceph-mon --bind "public=data-space cluster=cluster-space" + +alternatively these can also be provided as part of a Juju native bundle configuration: + + ceph-mon: + charm: cs:xenial/ceph-mon + num_units: 1 + bindings: + public: data-space + cluster: cluster-space + +Please refer to the [Ceph Network Reference](http://docs.ceph.com/docs/master/rados/configuration/network-config-ref) for details on how using these options effects network traffic within a Ceph deployment. + +**NOTE:** Spaces must be configured in the underlying provider prior to attempting to use them. + +**NOTE**: Existing deployments using ceph-*-network configuration options will continue to function; these options are preferred over any network space binding provided if set. + # Contact Information ## Authors diff --git a/hooks/ceph_hooks.py b/hooks/ceph_hooks.py index 0f168ea..3769f52 100755 --- a/hooks/ceph_hooks.py +++ b/hooks/ceph_hooks.py @@ -66,6 +66,7 @@ from charmhelpers.contrib.storage.linux.ceph import ( from utils import ( get_networks, get_public_addr, + get_cluster_addr, assert_charm_supports_ipv6 ) from ceph_broker import ( @@ -305,6 +306,9 @@ def emit_cephconf(): cephcontext['public_addr'] = dynamic_ipv6_address if not cluster_network: cephcontext['cluster_addr'] = dynamic_ipv6_address + else: + cephcontext['public_addr'] = get_public_addr() + cephcontext['cluster_addr'] = get_cluster_addr() # Install ceph.conf as an alternative to support # co-existence with other charms that write this file diff --git a/hooks/utils.py b/hooks/utils.py index 9b42159..b61912a 100644 --- a/hooks/utils.py +++ b/hooks/utils.py @@ -14,6 +14,8 @@ from charmhelpers.core.hookenv import ( cached, config, status_set, + network_get_primary_address, + log, DEBUG, ) from charmhelpers.fetch import ( apt_install, @@ -72,6 +74,32 @@ def get_host_ip(hostname=None): return answers[0].address +@cached +def get_public_addr(): + if config('ceph-public-network'): + return get_network_addrs('ceph-public-network')[0] + + try: + return network_get_primary_address('public') + except NotImplementedError: + log("network-get not supported", DEBUG) + + return get_host_ip() + + +@cached +def get_cluster_addr(): + if config('ceph-cluster-network'): + return get_network_addrs('ceph-cluster-network')[0] + + try: + return network_get_primary_address('cluster') + except NotImplementedError: + log("network-get not supported", DEBUG) + + return get_host_ip() + + def get_networks(config_opt='ceph-public-network'): """Get all configured networks from provided config option. @@ -86,10 +114,6 @@ def get_networks(config_opt='ceph-public-network'): return [] -def get_public_addr(): - return get_network_addrs('ceph-public-network')[0] - - def get_network_addrs(config_opt): """Get all configured public networks addresses. diff --git a/metadata.yaml b/metadata.yaml index 238ef07..9c3969d 100644 --- a/metadata.yaml +++ b/metadata.yaml @@ -12,6 +12,9 @@ tags: peers: mon: interface: ceph +extra-bindings: + public: + cluster: provides: nrpe-external-master: interface: nrpe-external-master diff --git a/unit_tests/test_ceph_networking.py b/unit_tests/test_ceph_networking.py new file mode 100644 index 0000000..ae3a7ff --- /dev/null +++ b/unit_tests/test_ceph_networking.py @@ -0,0 +1,51 @@ +import test_utils +import charmhelpers.core.hookenv as hookenv +import utils as ceph_utils + +TO_PATCH_SPACES = [ + 'network_get_primary_address', + 'log', + 'get_host_ip', + 'config', + 'get_network_addrs', + 'cached', +] + + +class CephNetworkSpaceTestCase(test_utils.CharmTestCase): + def setUp(self): + super(CephNetworkSpaceTestCase, self).setUp(ceph_utils, + TO_PATCH_SPACES) + self.config.side_effect = self.test_config.get + + def tearDown(self): + # Reset @cached cache + hookenv.cache = {} + + def test_no_network_space_support(self): + self.get_host_ip.return_value = '192.168.2.1' + self.network_get_primary_address.side_effect = NotImplementedError + self.assertEqual(ceph_utils.get_cluster_addr(), + '192.168.2.1') + self.assertEqual(ceph_utils.get_public_addr(), + '192.168.2.1') + + def test_public_network_space(self): + self.network_get_primary_address.return_value = '10.20.40.2' + self.assertEqual(ceph_utils.get_public_addr(), + '10.20.40.2') + self.network_get_primary_address.assert_called_with('public') + self.config.assert_called_with('ceph-public-network') + + def test_cluster_network_space(self): + self.network_get_primary_address.return_value = '10.20.50.2' + self.assertEqual(ceph_utils.get_cluster_addr(), + '10.20.50.2') + self.network_get_primary_address.assert_called_with('cluster') + self.config.assert_called_with('ceph-cluster-network') + + def test_config_options_in_use(self): + self.get_network_addrs.return_value = ['192.122.20.2'] + self.test_config.set('ceph-cluster-network', '192.122.20.0/24') + self.assertEqual(ceph_utils.get_cluster_addr(), + '192.122.20.2')