readme

Makefile

@@ -21,7 +21,7 @@ manager: generate fmt vet
 
 # Run against the configured Kubernetes cluster in ~/.kube/config
 run: generate fmt vet
-	go run ./main.go
+	go run ./main.go --hydra-url ${HYDRA_URL}
 
 # Install CRDs into a cluster
 install: manifests

README.md

@@ -1,10 +1,31 @@
-# hydra-maester
+# Hydra-maester
 
 
 This project contains a Kubernetes controller that uses Custom Resources to manage Hydra Oauth2 clients.
-The project is based on [Kubebuilder](https://github.com/kubernetes-sigs/kubebuilder)
+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)
+## 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```.

config/manager/manager.yaml

@@ -27,6 +27,7 @@ spec:
         - /manager
         args:
         - --enable-leader-election
+        - --hydra-url=http://use.actual.hydra.fqdn #change it to your ORY Hydra address
         image: controller:latest
         name: manager
         resources: