# charm-interface-magpie

**Repository Path**: mirrors_openstack/charm-interface-magpie

## Basic Information

- **Project Name**: charm-interface-magpie
- **Description**: Charm Interface - Magpie peer relation. Mirror of code maintained at opendev.org.
- **Primary Language**: Unknown
- **License**: Apache-2.0
- **Default Branch**: master
- **Homepage**: None
- **GVP Project**: No

## Statistics

- **Stars**: 0
- **Forks**: 0
- **Created**: 2020-12-03
- **Last Updated**: 2026-03-07

## Categories & Tags

**Categories**: Uncategorized

**Tags**: None

## README

# Overview

This interface layer handles the communication among Magpie peers.

# Usage

## Peers

This interface allows the peers of the Magpie deployment to be aware of
each other. This interface layer will set the following states, as appropriate:

  * `{relation_name}.joined` A new peer in the Magpie service has
  joined. The Magpie charm should call `get_nodes()` to get
  a list of tuples with unit ids and IP addresses for peer members.

    * When a unit joins the set of peers, the interface ensures there
    is no `{relation_name}.departed` state set in the conversation.

    * A call to `dismiss_joined()` will remove the `joined` state in the
    peer conversation so this charm can react to subsequent peers joining.


  * `{relation_name}.departed` A peer in the Magpie service has
  departed. The Magpie charm should call `get_nodes()` to get
  a list of tuples with unit ids and IP addresses for remaining peer members.

    * When a unit leaves the set of peers, the interface ensures there
    is no `{relation_name}.joined` state set in the conversation.

    * A call to `dismiss_departed()` will remove the `departed` state in the
    peer conversation so this charm can react to subsequent peers departing.


For example, let's say that a peer is added to the Magpie service
deployment. The Magpie charm should handle the new peer like this:

```python
@when('magpie.joined')
def check_peers(magpie):
    nodes = magpie.get_nodes()
    # do stuff with nodes
```

# Bugs

Please report bugs on [Launchpad](https://bugs.launchpad.net/charm-interface-magpie/+filebug).

For general questions please refer to the OpenStack [Charm Guide](https://docs.openstack.org/charm-guide/latest/).