Skip to content

Latest commit

 

History

History
103 lines (79 loc) · 2.82 KB

CONTRIBUTING.md

File metadata and controls

103 lines (79 loc) · 2.82 KB
Raw

Contributing

Overview

This document explains the processes and practices recommended for contributing enhancements to this operator.

  • Generally, before developing bugs or enhancements to this charm, you should open an issue explaining your use case.
  • If you would like to chat with us about charm development, you can reach us at Canonical Mattermost public channel or Discourse.
  • Familiarising yourself with the Charmed Operator Framework library will help you a lot when working on new features or bug fixes.
  • All enhancements require review before being merged. Code review typically examines
    • code quality
    • test coverage
    • user experience for Juju administrators of this charm.
  • Please help us out in ensuring easy to review branches by rebasing your pull request branch onto the main branch. This also avoids merge commits and creates a linear Git commit history.

Developing

You can use the environments created by tox for development. It helps install pre-commit, mypy type checker, linting tools, and formatting tools.

tox -e dev
source .tox/dev/bin/activate

Testing

tox -e unit          # unit tests
tox -e integration   # integration tests

To test this charm manually, execute the container:

kubectl exec -it hydra-0 -c hydra -n <model> -- sh

Create an exemplary client:

$ hydra create client --endpoint https://127.0.0.1:4445/ --name example-client

CLIENT ID	b55b6857-968e-4fb7-be77-f701ec751405
CLIENT SECRET	b3wFYH2N_epJY6C8jCuinBRP60
GRANT TYPES	authorization_code
RESPONSE TYPES	code
SCOPE		offline_access offline openid
AUDIENCE
REDIRECT URIS

List the clients:

$ hydra list clients --endpoint https://127.0.0.1:4445/

CLIENT ID				CLIENT SECRET	GRANT TYPES		RESPONSE TYPES	SCOPE				AUDIENCE	REDIRECT URIS
b55b6857-968e-4fb7-be77-f701ec751405			authorization_code	code		offline_access offline openid

NEXT PAGE TOKEN
IS LAST PAGE				true

Building

Build the charm in this git repository using:

charmcraft pack

Deploying

# Create a model
juju add-model dev
# Enable DEBUG logging
juju model-config logging-config="<root>=INFO;unit=DEBUG"
# Deploy postgresql-k8s charm
juju deploy postgresql-k8s --channel edge --trust
# Deploy the charm
juju deploy ./hydra*.charm --resource oci-image=$(yq eval '.resources.oci-image.upstream-source' charmcraft.yaml)
# Add integration
juju integrate postgresql-k8s hydra

Canonical Contributor Agreement

Canonical welcomes contributions to Charmed Ory Hydra. Please check out our contributor agreement if you're interested in contributing to the solution.