---
title: Charmhub | mimir_cluster interface
description: Interfaces describe the relation between two charms. This interface shows
  opinionated, standardized interface specifications for charm relations.
url: https://charmhub.io/integrations/mimir_cluster
---

# mimir\_cluster

## Usage

This relation interface describes the protocol for communication between the `mimir-coordinator-k8s` charm and the `mimir-worker-k8s` charm. The interface is only intended to be used between these two charms.

## Direction

The `mimir_cluster` interface implements a provider/requirer pattern.
The provider is `mimir-coordinator-k8s` and the requirers are `mimir-worker-k8s`.

```
flowchart TD
    mimir-coordinator
    mimir-worker-0 -- mimir_cluster --> mimir-coordinator
    mimir-worker-1 -- mimir_cluster --> mimir-coordinator
    mimir-worker-2 -- mimir_cluster --> mimir-coordinator
```

## Behavior

The requirer and provider should provide specific information to facilitate the running of Mimir.

### Provider

* Is expected to provided a working configuration file for the mimir workers to use.

### Requirer

* Provide information about how to access the node api endpoints of the worker application.
* Provide juju topology information for the worker nodes.
* Specify which roles the worker application will run with.

## Relation Data

[[Pydantic Schema]](https://github.com/canonical/charmlibs/blob/main/interfaces/mimir_cluster/interface/vv0/schema.py)
All fields are json-serialized.

### Example

```
provider:
  app: {<python object representing mimir config>}
requirer:
  app: {"roles": ["read"]}
  unit:
    juju_topology:
      unit: "worker/0"
      app: "worker"
      charm: "mimir-worker-k8s"
      model: "cos"
      model_uuid: "<uuid of model>"
    address: "hostname"
    port: 12345
    scheme: "http"
```

## Charms implementing this interface

### Providers

### Requirers

## Other charms using this interface

### Providers

* [mimir-coordinator-k8s](https://charmhub.io/mimir-coordinator-k8s)

### Requirers

* [mimir-worker-k8s](https://charmhub.io/mimir-worker-k8s)