metadata.yaml

# Copyright 2024 Canonical Ltd.
# See LICENSE file for licensing details.
name: kafka-k8s
display-name: Apache Kafka - K8s
description: |
  Apache Kafka is an event streaming platform. This charm deploys and operates Apache Kafka on
  a K8s environment.

  Apache Kafka is a free, open source software project by the Apache Software Foundation. 
  Users can find out more at the [Apache Kafka project page](https://kafka.apache.org/).
summary: Charmed Apache Kafka K8s Operator
docs: https://discourse.charmhub.io/t/charmed-kafka-k8s-documentation/10296
source: https://github.com/canonical/kafka-k8s-operator
issues: https://github.com/canonical/kafka-k8s-operator/issues
website:
  - https://ubuntu.com/data/kafka
  - https://canonical.com/data/docs/kafka/k8s
  - https://charmhub.io/kafka-k8s
  - https://github.com/canonical/kafka-k8s-operator
  - https://matrix.to/#/%23charmhub-data-platform%3Aubuntu.com
maintainers:
  - Canonical Data Platform <data-platform@lists.launchpad.net>
assumes:
  - k8s-api

containers:
  kafka:
    resource: kafka-image
    mounts:
      - storage: data
        location: /var/lib/kafka/data

resources:
  kafka-image:
    type: oci-image
    description: OCI Image for Apache Kafka
    upstream-source: ghcr.io/canonical/charmed-kafka@sha256:788c5c4639fb659959758b24ff133ba387f34bf4f91feeda082f0162553561a4

peers:
  cluster:
    interface: cluster
  restart:
    interface: rolling_op
  upgrade:
    interface: upgrade

provides:
  kafka-client:
    interface: kafka_client
  metrics-endpoint:
    interface: prometheus_scrape
  grafana-dashboard:
    interface: grafana_dashboard
  peer-cluster-orchestrator:
    interface: peer_cluster
    limit: 1

requires:
  zookeeper:
    interface: zookeeper
    limit: 1
  certificates:
    interface: tls-certificates
    limit: 1
    optional: true
  trusted-ca:
    interface: tls-certificates
    optional: true
  trusted-certificate:
    interface: tls-certificates
    optional: true
  logging:
    interface: loki_push_api
    optional: true
  peer-cluster:
    interface: peer_cluster
    optional: true
  oauth:
    interface: oauth
    limit: 1
    optional: true

storage:
  data:
    type: filesystem
    description: Directories where the log data is stored
    minimum-size: 10G
    location: /var/lib/kafka/data