charm-interface-ceph-client/src/ceph_client
James Page f86d2614b4 Use properties correctly
Its not possible to call a method which is annotated as a property
so which to just using the property directly.

Its also difficult to patch a property during unit testing so
provide private methods for unit testing to allow properties
to be specified during testing.

Change-Id: Id9db6578e00fa412e4cf58e75bd89970b6e8e682
2020-08-27 10:04:09 +01:00
..
README.md Re-organise interface 2020-08-17 08:14:43 +00:00
interface.yaml Re-organise interface 2020-08-17 08:14:43 +00:00
lib Re-organise interface 2020-08-17 08:14:43 +00:00
provides.py Re-organise interface 2020-08-17 08:14:43 +00:00
requires.py Use properties correctly 2020-08-27 10:04:09 +01:00

README.md

Overview

This interface layer handles the communication between the Ceph Monitor cluster and a client that requires an access key and a pool to use.

Usage

Requires

This interface layer will set the following states, as appropriate:

  • {relation_name}.available The ceph client has been related to a provider.

The following accessors will be available:

  • key - The cephx access key
  • auth - Whether or not strict auth is supported
  • mon_hosts - The public addresses list of the monitor cluster

Client example:

@when('ceph-client.connected')
def ceph_connected(ceph_client):
  ceph_client.create_pool('newpool')

@when('ceph-client.available')
def ceph_ready(ceph_client):
  charm_ceph_conf= os.path.join(os.sep, 'etc', 'ceph', 'ceph.conf')
  cephx_key = os.path.join(os.sep, 'etc', 'ceph', 'ceph.client.charm.keyring')

  ceph_context = {
      'auth_supported': ceph_client.auth,
      'mon_hosts': ceph_client.mon_hosts,
  }

  with open(charm_ceph_conf, 'w') as cephconf:
    cephconf.write(render_template('ceph.conf', ceph_context))

  # Write out the cephx_key also
  with open(cephx_key, 'w') as cephconf:
    cephconf.write(ceph_client.key)