hydra_endpoints

Relevant links

  Submit a bug

  Specification archive

Help us improve this page

Most of this content can be collaboratively discussed and changed in the respective README file.

Contribute

Discuss this interface

Share your thoughts on this interface with the community on discourse

Join the discussion

Charms

Providing hydra_endpoints

Featured charms

Other charms

How to test a charm

Requiring hydra_endpoints

Featured charms

Other charms

How to test a charm

Developer documentation

Overview

This relation interface describes the expected behavior of charms claiming to be able to provide or consume a hydra endpoint.

Usage

The interface will provide admin and public endpoints, in case any other charm belonging to the IAM bundle requires them both.

Direction

The interface will consist of a provider and a requirer. The provider is expected to supply its public and admin endpoints, while the requirer will just read the information from the application databag.

hydra_admin_endpoint, hydra_public_endpoint

Requirer

Provider

Behavior

Both the requirer and the provider need to adhere to a certain set of criteria to be considered compatible with the interface:

Provider

  • Is expected to serve admin and public API endpoints
  • Is expected to write the public and admin URLs to the application databag.

Requirer

  • Is expected to consume the relation data to set up integration with Hydra.

Relation Data

Provider

[JSON Schema]

Example

{
  "application_data": {
    "admin_endpoint": "admin-endpoint",
    "public_endpoint": "public-endpoint"
  }
}

Requirer

Last updated 12 days ago. Help us improve this page.