Skip to content

canonical/hydra-operator

Repository files navigation

Charmed Ory Hydra

CharmHub Badge Juju License

Continuous Integration Status pre-commit Conventional Commits

Description

Python Operator for Ory Hydra - a scalable, security first OAuth 2.0 and OpenID Connect server. For more details and documentation, visit https://www.ory.sh/docs/hydra/.

Usage

juju deploy postgresql-k8s --channel edge --trust
juju deploy hydra --trust
juju integrate postgresql-k8s hydra

You can follow the deployment status with watch -c juju status --color.

Integrations

PostgreSQL

This charm requires an integration with postgresql-k8s-operator.

Ingress

The Hydra Operator offers integration with the traefik-k8s-operator for ingress. Hydra has two APIs which can be exposed through ingress, the public API and the admin API.

If you have traefik deployed and configured in your hydra model, to provide ingress to the admin API run:

juju integrate traefik-admin hydra:admin-ingress

To provide ingress to the public API run:

juju integrate traefik-public hydra:public-ingress

Kratos

This charm offers integration with kratos-operator. In order to integrate hydra with kratos, it needs to be able to access hydra's admin API endpoint. To enable that, integrate the two charms:

juju integrate kratos hydra

Identity Platform Login UI

The following instructions assume that you have deployed traefik-admin and traefik-public charms and integrated them with hydra. Note that the UI charm should run behind a proxy.

This charm offers integration with identity-platform-login-ui-operator. In order to integrate them, run:

juju integrate hydra:ui-endpoint-info identity-platform-login-ui-operator:ui-endpoint-info
juju integrate identity-platform-login-ui-operator:hydra-endpoint-info hydra:hydra-endpoint-info

OCI Images

The image used by this charm is hosted on Docker Hub and maintained by Ory.

Security

Security issues can be reported through LaunchPad. Please do not file GitHub issues about security issues.

Contributing

Please see the Juju SDK docs for guidelines on enhancements to this charm following best practice guidelines, and CONTRIBUTING.md for developer guidance.

License

The Charmed Hydra Operator is free software, distributed under the Apache Software License, version 2.0. See LICENSE for more information.