A catalogue of opinionated and standardized interface specifications for charmed operator relations. The purpose of the repository is to outline the behavior and requirements for key interface names, ensuring that charms claiming to implement a certain interface actually are capable of being integrated with each other.
To contribute an interface specification, open a pull request containing a README.md, json schemas for both sides of the relation and a charms.yaml file consisting of a list of any providers and consumers known to adhere to the specification. See the template interface for an example of what to include and how it should be structured. For interface schemas, make sure to include both the unit and application databag in your schema, and also make sure to set additionalProperties to true as we want to be able to keep it extendable.
To quickly get started, you can copy the interfaces/__template__ folder to create a basic template.
| Category | Interface | Status |
|---|---|---|
| Data | mysql_client |
 |
postgresql_client |
|
|
mongodb_client |
|
|
kafka_client |
|
|
opensearch_client |
|
|
database_backup |
|
|
| Identity | oauth |
|
| Observability | grafana_auth |
|
prometheus_remote_write |
 |
|
prometheus_scrape |
|
|
| Networking | ingress |
|
ingress_per_unit |
|
|
| Security | tls_certificates/v0 |
|
tls_certificates/v1 |
|
|
| Storage | s3 |
|
| Category | Interface | Status |
|---|---|---|
| Metadata | k8s-service |
|
| Category | Interface | Status |
|---|---|---|
| Identity | hydra_endpoints |
|
kratos_external_idp |
|
For a more detailed explanation of statuses and how they should be used, see the legend.