charmcraft.yaml

type: charm
name: openstack-exporter
title: OpenStack Exporter
summary: Openstack exporter for Charmed OpenStack
description: |
  This is an exporter that exposes information gathered from Openstack for use
  by the Prometheus monitoring system. This operator works with the Canonical
  Observability Stack (COS).
subordinate: false

bases:
  - build-on:
    - name: ubuntu
      channel: "22.04"
    run-on:
    - name: ubuntu
      channel: "22.04"

requires:
  credentials:
    interface: keystone-admin

provides:
  cos-agent:
    interface: cos_agent

config:
  options:
    port:
      type: int
      default: 9180
      description: |
        The openstack-exporter service (metrics endpoint for prometheus scraping)
        will listen at this port.
    ssl_ca:
      default: ""
      type: string
      description: |
        Custom SSL CA for keystone if required.

        The format should be the raw contents of a PEM encoded file.
        (no base64 encoding).
    cache_ttl:
      default: "300s"
      type: string
      description: |
        Cache expiry time-to-live (TTL), e.g., 10s, 11m, 12h. Cache refreshes at
        intervals of cache_ttl/2.
        Customizable based on the size of the OpenStack cluster.
        Format details: https://pkg.go.dev/time#ParseDuration
    cache:
      default: false
      type: boolean
      description: |
        Enables the exporter cache globally. Refreshes at intervals of cache_ttl/2.
        If the cache is empty or expired, the response will be empty.


links:
  documentation: https://discourse.charmhub.io/t/openstack-exporter-docs-index/13876
  issues:
  - https://github.com/canonical/openstack-exporter-operator/issues
  source:
  - https://github.com/canonical/openstack-exporter-operator
  website:
  - https://github.com/canonical/openstack-exporter-operator

resources:
  openstack-exporter:
    type: file
    filename: openstack-exporter.snap
    description: |
      Snap for openstack-exporter.
      This is the software that implements actual metrics collection and endpoint for prometheus scraping.

      The snap resource on Charmhub is intended to be an empty file.
      The charm will ignore an empty file resource,
      so that the resource can be used as an override by the user,
      if they wish to provide a local snap.

      Currently a local snap must be provided via the resource,
      since the supported snap isn't published on the snap store.
      When it is published, the charm will use the snap from the store,
      and a user can provide a local snap to use instead.

      This override may be useful for testing or in environments with network restrictions.