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

# kubeflow-dashboard-links

## Usage

This relation interface describes the expected behavior of any charm claiming to be able to provide
or consume the `kubeflow-dashboard-links` interface. `kubeflow-dashboard-links` is an interface for defining links in the format needed by Kubeflow Dashboard.

## Behavior

### Provider

* Is expected to create a link in the dashboard UI for each link entry sent by the `requirer` over the relation

### Requirer

* Is expected to send zero or more links to the `provider` in the below-defined format.

## Relation Data

[[Pydantic Schema]](https://github.com/canonical/charmlibs/blob/main/interfaces/kubeflow_dashboard_links/interface/vv0/schema.py)

### Requirer

The requirer specifies zero or more sidebar items in the required format.

#### Example

The `dashboard_links` key might contain the following as a JSON-encoded string:

```
[
  {
    "text": "Some link text",
    "link": "/some-relative-link",
    "location": "menu",
    "type": "item",
    "icon": "assessment",
    "desc": "link description"
  },
  {
    "text": "Some other link text",
    "link": "/some-other-relative-link",
    "location": "quick",
    "type": "item",
    "icon": "book",
    "desc": "link description"
  }
```

]

### Provider

The `provider` sends no data on this interface.

## Charms implementing this interface

### Providers

* [kubeflow-dashboard](https://charmhub.io/kubeflow-dashboard)

### Requirers

## Other charms using this interface

### Providers

* [kubeflow-dashboard](https://charmhub.io/kubeflow-dashboard)

### Requirers

* [kfp-ui](https://charmhub.io/kfp-ui)
* [jupyter-ui](https://charmhub.io/jupyter-ui)
* [mlflow-server](https://charmhub.io/mlflow-server)
* [kubeflow-volumes](https://charmhub.io/kubeflow-volumes)
* [katib-ui](https://charmhub.io/katib-ui)