Interface libraries

This page lists interface libraries. The search box supports regular expressions.

In future, this page will show which libraries are officially recommended based on review by Charm Tech, as well as whether they are currently passing automated tests.

Library status is shown in the left column. See tooltips, or click here for a key.

Description

🚫
Deprecated library, not recommended for use in new charms.

Deprecated library, not recommended for use in new charms.

None of the above.

Library

Kind

Interface

alertmanager_k8s.alertmanager_dispatch (src)
Charmhub
alertmanager_dispatch
alertmanager_k8s.alertmanager_remote_configuration (src)
Charmhub
alertmanager_remote_configuration
oathkeeper.auth_proxy (src)
Charmhub
auth_proxy (schema)
oauth2_proxy_k8s.auth_proxy (src)
Charmhub
auth_proxy (schema)
blackbox_exporter_k8s.blackbox_probes (src)
Charmhub
blackbox_exporter_probes
(The Charmhub interfaces page doesn’t load, this link is to a charm that uses the interface.)
catalogue_k8s.catalogue (src)
Charmhub
catalogue
Transfer catalogue data for display by the provider.
certificate_transfer_interface.certificate_transfer (src)
Charmhub
certificate_transfer (schema)
Transfer certificates between charms.
cloudflare_configurator.cloudflared_route (src)
Charmhub
cloudflared_route (schema)
grafana_agent.cos_agent (src)
Charmhub
cos_agent (schema)
Machine charm specific interface for exchanging observability related data.
dex_auth.dex_oidc_config (src)
Charmhub
dex-oidc-config
data_platform_libs.data_interfaces (src)
Charmhub
etcd_client (schema)
Database charms from the Data Platform Team recommend using the generic data_platform_libs.data_interfaces library to implement the interface.
kratos_external_idp_integrator.kratos_external_provider (src)
Charmhub
external_provider
sdcore_nms_k8s.fiveg_core_gnb (src)
Charmhub
fiveg_core_gnb (schema)
sdcore_amf_k8s.fiveg_n2 (src)
Charmhub
fiveg_n2 (schema)
sdcore_upf_k8s.fiveg_n4 (src)
Charmhub
fiveg_n4 (schema)
sdcore_nrf_k8s.fiveg_nrf (src)
Charmhub
fiveg_nrf (schema)
Transfer Network Repository Function information from one charm to another.
oathkeeper.forward_auth (src)
Charmhub
forward_auth (schema)
oauth2_proxy_k8s.forward_auth (src)
Charmhub
forward_auth (schema)
glauth_utils.glauth_auxiliary (src)
Charmhub
glauth_auxilary
grafana_k8s.grafana_source (src)
Charmhub
grafana-source
Provide a data source for Grafana dashboards.
grafana_k8s.grafana_auth (src)
Charmhub
grafana_auth (schema)
grafana_cloud_integrator.cloud_config_provider (src)
Charmhub
grafana_cloud_config
grafana_cloud_integrator.cloud_config_requirer (src)
Charmhub
grafana_cloud_config
grafana_k8s.grafana_dashboard (src)
Charmhub
grafana_dashboard
Manage dashboards for Grafana.
grafana_k8s.grafana_metadata (src)
Charmhub
grafana_metadata
hydra.hydra_endpoints (src)
Charmhub
hydra_endpoints (schema)
traefik_k8s.ingress_per_unit (src)
Charmhub
ingress_per_unit (schema)
nginx_ingress_integrator.ingress (src)
Charmhub
ingress
Manage ingress.
traefik_k8s.ingress (src)
Charmhub
ingress
Manage per-application ingress and and load-balancing.
istio_pilot.istio_gateway_info (src)
Charmhub
istio-gateway-info
mlops_libs.k8s_service_info (src)
Charmhub
k8s-service
karma_k8s.karma_dashboard (src)
Charmhub
karma_dashboard
kratos.kratos_info (src)
Charmhub
kratos_info (schema)
ops.interface_kube_control (src)
PyPI
kube-control
kubeflow_dashboard.kubeflow_dashboard_links (src)
Charmhub
kubeflow_dashboard_links (schema)
resource_dispatcher.kubernetes_manifests (src)
Charmhub
kubernetes_manifest
glauth_k8s.ldap (src)
Charmhub
ldap (schema)
loadbalancer_interface (docs, src)
PyPI
loadbalancer
identity_platform_login_ui_operator.login_ui_endpoints (src)
Charmhub
login_ui_endpoints (schema)
loki_k8s.loki_push_api (src)
Charmhub
loki_push_api
Manage logs for Loki.
synapse.matrix_auth (src)
Charmhub
matrix_auth
(The Charmhub interfaces page doesn’t load, this link is to a charm that uses the interface.)
data_platform_libs.data_interfaces (src)
Charmhub
mongodb_client (schema)
Database charms from the Data Platform Team recommend using the generic data_platform_libs.data_interfaces library to implement the interface.
data_platform_libs.data_interfaces (src)
Charmhub
mysql_client (schema)
Database charms from the Data Platform Team recommend using the generic data_platform_libs.data_interfaces library to implement the interface.
nginx_ingress_integrator.nginx_route (src)
Charmhub
nginx_route (schema)
Manage external HTTP access to Kubernetes workloads using Nginx.
oathkeeper.oathkeeper_info (src)
Charmhub
oathkeeper_info
hydra.oauth (src)
Charmhub
oauth (schema)
openfga_k8s.openfga (src)
Charmhub
openfga (schema)
data_platform_libs.data_interfaces (src)
Charmhub
opensearch_client (schema)
Database charms from the Data Platform Team recommend using the generic data_platform_libs.data_interfaces library to implement the interface.
parca_k8s.parca_scrape (src)
Charmhub
parca_scrape
data_platform_libs.data_interfaces (src)
Charmhub
postgresql_client (schema)
Database charms from the Data Platform Team recommend using the generic data_platform_libs.data_interfaces library to implement the interface.
mimir_coordinator_k8s.prometheus_api (src)
Charmhub
prometheus_api
prometheus_k8s.prometheus_remote_write (src)
Charmhub
prometheus_remote_write (schema)
Transfer Prometheus metrics data between charms.
prometheus_k8s.prometheus_scrape (src)
Charmhub
prometheus_scrape (schema)
Manage metrics for Prometheus.
prometheus_pushgateway_k8s.pushgateway (src)
Charmhub
pushgateway
(The Charmhub interfaces page doesn’t load, this link is to a charm that uses the interface.)
redis_k8s.redis (src)
Charmhub
redis
s3proxy_k8s.object_storage (src)
Charmhub
s3 (schema)
data_platform_libs.s3 (src)
Charmhub
s3 (schema)
Manage s3 credentials and metadata.
saml_integrator.saml (src)
Charmhub
saml (schema)
sdcore_nms_k8s.sdcore_config (src)
Charmhub
sdcore_config (schema)
Provide or require the web UI gRPC address for SD-Core configuration.
sdcore_webui_k8s.sdcore_management (src)
Charmhub
sdcore_management (schema)
smtp_integrator.smtp (src)
Charmhub
smtp (schema)
tempo_coordinator_k8s.tempo_api (src)
Charmhub
tempo_api
tls_certificates_interface.tls_certificates (docs, src)
Charmhub
tls_certificates (schema)
Manage TLS certificates.
tempo_coordinator_k8s.tracing (src)
Charmhub
tracing (schema)
Provide and consume tracing data.
traefik_k8s.traefik_route (src)
Charmhub
traefik_route
vault_k8s.vault_kv (src)
Charmhub
vault_kv (schema)
🚫
Deprecated library, not recommended for use in new charms.
ops-lib-mysql (src)
PyPI
mysql
Modern charms should use the mysql_client interface, using the data_interfaces lib from data-platform-helpers.
🚫
Deprecated library, not recommended for use in new charms.
parca.parca_scrape (src)
Charmhub
parca_scrape
Deprecated in favour of the parca-k8s charm’s parka_scrape lib.
🚫
Deprecated library, not recommended for use in new charms.
ops-lib-pgsql (src)
PyPI
pgsql
Modern charms should use the mysql_client interface, using the data_interfaces lib from data-platform-helpers.
🚫
Deprecated library, not recommended for use in new charms.
lego_base_k8s.lego_client (src)
Charmhub
tls_certificates (schema)
Legacy charm library used to implement the provider side of this interface.
🚫
Deprecated library, not recommended for use in new charms.
tempo_k8s.tracing (src)
Charmhub
tracing (schema)
Deprecated in favour of tempo_coordinator_k8s .tracing.
🚫
Deprecated library, not recommended for use in new charms.
traefik_route_k8s.traefik_route (src)
Charmhub
traefik_route
Deprecated in favour of the traefik-k8s charm’s traefik_route lib.
🚫
Deprecated library, not recommended for use in new charms.
data_platform_libs.database_provides (src)
Charmhub
Deprecated in favour of data_platform_helpers.data_interfaces.
🚫
Deprecated library, not recommended for use in new charms.
data_platform_libs.database_requires (src)
Charmhub
Deprecated in favour of data_platform_helpers.data_interfaces.