Charm Interface - HA Cluster
Go to file
James Page 52a760b8fb Pass data over interface using json keys
Switch to using json encoded data when passing configuration
to the hacluster charm.

Note that this requires an up-to-date version of the hacluster
charm, but ensures that data is presented consistently over the
relation due to deterministic encoding using json.

Change-Id: If2ace4b37f4152bf8bc44526b609a034433efc67
Closes-Bug: 1741304
2018-01-05 12:19:02 +00:00
.gitignore First commit of the proposed hacluster interface. 2016-01-05 21:22:27 -07:00
.gitreview Add .gitreview, update tox.ini, update readme. 2016-07-06 12:56:24 +00:00
README.md Add .gitreview, update tox.ini, update readme. 2016-07-06 12:56:24 +00:00
common.py Add functions for managing DNS Entries 2017-10-26 21:47:26 +01:00
copyright First commit of the proposed hacluster interface. 2016-01-05 21:22:27 -07:00
interface.yaml First commit of the proposed hacluster interface. 2016-01-05 21:22:27 -07:00
requires.py Pass data over interface using json keys 2018-01-05 12:19:02 +00:00
test-requirements.txt Enable the hascluster interface to do less juju work 2017-08-07 16:49:41 +01:00
tox.ini Add .gitreview, update tox.ini, update readme. 2016-07-06 12:56:24 +00:00

README.md

Overview

This interface handles the communication with the hacluster subordinate charm using the ha interface protocol.

Usage

Requires

The interface layer will set the following reactive states, as appropriate:

  • {relation_name}.connected The relation is established and ready for the local charm to configure the hacluster subordinate charm. The configuration of the resources to manage for the hacluster charm can be managed via one of the following methods:

    • manage_resources method
    • bind_on method

    Configuration of the managed resources within the hacluster can be managed by passing common.CRM object definitions to the manage_resources method.

  • {relation_name}.available The hacluster is up and ready.

For example:

from charms.reactive import when, when_not
from charms.reactive import set_state, remove_state

from relations.hacluster.common import CRM


@when('ha.connected')
def cluster_connected(hacluster):

    resources = CRM()
    resources.primitive('res_vip', 'ocf:IPAddr2',
                        params='ip=10.0.3.100 nic=eth0',
                        op='monitor interval="10s"')
    resources.clone('cl_res_vip', 'res_vip')

    hacluster.bind_on(iface='eth0', mcastport=4430)
    hacluster.manage_resources(resources)

Additionally, for more code clarity a custom object implements the interface defined in common.ResourceDescriptor can be used to simplify the code for reuse.

For example:

import ipaddress

from relation.hacluster.common import CRM
from relation.hacluster.common import ResourceDescriptor

class VirtualIP(ResourceDescriptor):
    def __init__(self, vip, nic='eth0'):
        self.vip = vip
        self.nic = 'eth0'

    def configure_resource(self, crm):
        ipaddr = ipaddress.ip_address(self.vip)
        if isinstance(ipaddr, ipaddress.IPv4Address):
            res_type = 'ocf:heartbeat:IPAddr2'
            res_parms = 'ip={ip} nic={nic}'.format(ip=self.vip,
                                                   nic=self.nic)
        else:
            res_type = 'ocf:heartbeat:IPv6addr'
            res_params = 'ipv6addr={ip} nic={nic}'.format(ip=self.vip,
                                                          nic=self.nic)

        crm.primitive('res_vip', res_type, params=res_params,
                      op='monitor interval="10s"')
        crm.clone('cl_res_vip', 'res_vip')

Once the VirtualIP class above has been defined in charm code, it can make the code a bit cleaner. The example above can thusly be written as:

@when('ha.connected')
def cluster_connected(hacluster):
    resources = CRM()
    resources.add(VirtualIP('10.0.3.100'))

    hacluster.bind_on(iface='eth0', mcastport=4430)
    hacluster.manage_resources(resources)