hydra-maester/README.md

# Hydra-maester


This project contains a Kubernetes controller that uses Custom Resources to manage Hydra Oauth2 clients.
ORY Hydra Maester watches for instances of `oauth2clients.oathkeeper.ory.sh/v1alpha1` and creates, updates, or deletes corresponding OAuth2 clients by communicating with ORY Hydra API.

The project is based on [Kubebuilder](https://github.com/kubernetes-sigs/kubebuilder).

## Prerequisites

- recent version of Go language with support for modules (e.g: 1.12.6)
- make
- kubectl
- kustomize
- [ginkgo](https://onsi.github.io/ginkgo/) for local integration testing
- access to K8s environment: minikube or a remote K8s cluster


## Design

Take a look at [Design Readme](./docs/README.md).

## How to use it

- `make test` to run tests
- `make test-integration` to run integration tests
- `make install` to generate CRD file from go sources and install it on the cluster
- `export HYDRA_URL={HYDRA_SERVICE_URL} && make run` to run the controller

To deploy the controller, edit the value of the ```--hydra-url``` argument in the [manager.yaml](config/manager/manager.yaml) file and run ```make deploy```.
readme 2019-08-29 12:55:29 +02:00			`# Hydra-maester`
Initial readme (#1) 2019-07-31 14:44:45 +02:00

			`This project contains a Kubernetes controller that uses Custom Resources to manage Hydra Oauth2 clients.`
readme 2019-08-29 12:55:29 +02:00			ORY Hydra Maester watches for instances of `oauth2clients.oathkeeper.ory.sh/v1alpha1` and creates, updates, or deletes corresponding OAuth2 clients by communicating with ORY Hydra API.
Initial readme (#1) 2019-07-31 14:44:45 +02:00
readme 2019-08-29 12:55:29 +02:00			`The project is based on [Kubebuilder](https://github.com/kubernetes-sigs/kubebuilder).`
Initial readme (#1) 2019-07-31 14:44:45 +02:00
readme 2019-08-29 12:55:29 +02:00			`## Prerequisites`
Initial readme (#1) 2019-07-31 14:44:45 +02:00
readme 2019-08-29 12:55:29 +02:00			`- recent version of Go language with support for modules (e.g: 1.12.6)`
			`- make`
			`- kubectl`
			`- kustomize`
			`- [ginkgo](https://onsi.github.io/ginkgo/) for local integration testing`
			`- access to K8s environment: minikube or a remote K8s cluster`



			`## Design`

			`Take a look at [Design Readme](./docs/README.md).`

			`## How to use it`

			- `make test` to run tests
			- `make test-integration` to run integration tests
			- `make install` to generate CRD file from go sources and install it on the cluster
			- `export HYDRA_URL={HYDRA_SERVICE_URL} && make run` to run the controller

			To deploy the controller, edit the value of the ```--hydra-url``` argument in the [manager.yaml](config/manager/manager.yaml) file and run ```make deploy```.