metadata.yaml

# Copyright 2023 Canonical Ltd.
# See LICENSE file for licensing details.

name: opensearch
display-name: OpenSearch

description: |
  Machine charm for OpenSearch
docs: https://discourse.charmhub.io/t/charmed-opensearch-documentation/9729
summary: |
  Machine charm for OpenSearch

peers:
  opensearch-peers:
    interface: opensearch_peers
  node-lock-fallback:
    interface: node_lock_fallback
  upgrade-version-a:
    # Relation versioning scheme:
    # DA056 - Upgrading in-place upgrade protocol
    # https://docs.google.com/document/d/1H7qy5SAwLiCOKO9xMQJbbQP5_-jGV6Lhi-mJOk4gZ08/edit
    interface: upgrade

provides:
  peer-cluster-orchestrator:
    interface: peer_cluster
    optional: true
  opensearch-client:
    interface: opensearch_client
  cos-agent:
    description: |
      `cos-agent` is a dedicated relation for the grafana agent machine
      charm. It will allow you to set up custom scrape jobs, fetch files
      from arbitrary locations, send alert rules, dashboards, etc.
    interface: cos_agent
    scope: container

requires:
  certificates:
    interface: tls-certificates
    limit: 1
  peer-cluster:
    interface: peer_cluster
    limit: 2  # (main+failover)_cluster_orchestrator(s)
    optional: true
  s3-credentials:
    interface: s3
    limit: 1

storage:
  opensearch-data:
    type: filesystem
    location: /var/snap/opensearch/common  # /mnt/opensearch/data