Consul client operator

ConsulNotify Provides and Requires module.

This library contains Provider and Requirer classes for consul-notify interface.

The provider side offers the service of network monitoring and notification. It monitors network connectivity to servers and notifies when issues are detected.

The requirer side receives notifications about network failures and provides the socket path where it wants to receive these notifications.

Provider Example

Import ConsulNotifyProvider in your charm, with the charm object and the relation name: - self - "consul-notify"

An event is also available to respond to: - socket_available

A basic example showing the usage of the provider side:

from charms.consul_client.v0.consul_notify import (
    ConsulNotifyProvider
)

class MyProviderCharm(CharmBase):
    def __init__(self, *args):
        super().__init__(*args)
        # ConsulNotify Provider
        self.consul_notify = ConsulNotifyProvider(
            self, "consul-notify",
        )
        self.framework.observe(
            self.consul_notify.on.socket_available,
            self._on_socket_available
        )

    def _on_socket_available(self, event):
        '''React to the socket available event.

        This event happens when a requirer charm relates to this charm
        and provides its socket information.
        '''
        # Get the socket information
        snap_name = self.consul_notify.snap_name
        socket_path = self.consul_notify.unix_socket_filepath

        if snap_name and socket_path:
            # Configure TCP health check with the socket information
            # This will enable monitoring and notification
            self._configure_tcp_health_check(snap_name, socket_path)

Requirer Example

Import ConsulNotifyRequirer in your charm, with the charm object and the relation name: - self - "consul-notify"

An event is also available to respond to: - relation_ready

A basic example showing the usage of the requirer side:

from charms.consul_client.v0.consul_notify import (
    ConsulNotifyRequirer
)

class MyRequirerCharm(CharmBase):
    def __init__(self, *args):
        super().__init__(*args)
        # ConsulNotify Requires
        self.consul_notify = ConsulNotifyRequirer(
            self, "consul-notify",
        )

        # Observe the relation_ready event
        self.framework.observe(
            self.consul_notify.on.relation_ready,
            self._on_consul_notify_ready
        )

    def _on_consul_notify_ready(self, event):
        '''React to the consul-notify relation being ready.

        This event happens when the relation is created or joined.
        '''
        # Set the socket information for the provider.
        # unix_socket_filepath as the socket file name, not as an absolute path.
        self.consul_notify.set_socket_info(
            snap_name="my-service-snap",
            unix_socket_filepath="socket.sock"
        )