Git Product home page Git Product logo

charm-relation-interfaces's Introduction

Charm Relation Interfaces

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.

Contributing

To contribute an interface specification, open a pull request containing a README.md, json schemas for both sides of the relation, as well as a charms.yaml file consisting of a list of any providers and consumers known to adhere to the specification. See the grafana-auth interface for examples 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.

Interfaces

Category Interface Status
Data mysql_client Status: Draft
postgresql_client Status: Draft
mongodb_client Status: Draft
kafka_client Status: Draft
Observability grafana_auth Status: Draft
ingress Status: Live
ingress_per_unit Status: Live
prometheus_remote_write Status: Live
prometheus_scrape Status: Live
Metadata k8s-service Status: Draft
Security tls_certificates/v0 Status: Live
tls_certificates/v1 Status: Draft
Storage s3 Status: Draft

For a more detailed explanation of statuses and how they should be used, see the legend.

charm-relation-interfaces's People

Contributors

simskij avatar pietropasotti avatar delgod avatar marcoppenheimer avatar jnsgruk avatar gruyaume avatar nsklikas avatar ghislainbourgeois avatar saltiyazan avatar domfleischmann avatar javacruft avatar deusebio avatar

Watchers

James Cloos avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.