diff --git a/README.md b/README.md index 05c56bad5..b8ee9ba5e 100644 --- a/README.md +++ b/README.md @@ -43,10 +43,21 @@ To deploy voyager in Kubernetes follow this [guide](docs/user-guide/README.md). 1. Create `ingress.appscode.com` and `certificate.appscode.com` Third Party Resource 2. Deploy voyager to kubernetes. +## Running voyager alongside with other ingress controller +voyager can be configured to handle default kubernetes ingress or only ingress.appscode.com. voyager can also be run +along side with other controllers. + +```sh + --ingress-class + // this flag can be set to 'voyager' to handle only ingress + // with annotation kubernetes.io/ingress.class=voyager. + + // If unset, voyager will also handle ingress without ingress-class annotation. +``` + ## Developer Guide Want to learn whats happening under the hood, read [the developer guide](docs/developer-guide/README.md). - ## Contribution If you're interested in being a contributor, read [the contribution guide](docs/contribution/README.md). @@ -54,6 +65,11 @@ If you're interested in being a contributor, read [the contribution guide](docs/ ## Building voyager Read [Build Instructions](docs/developer-guide/build.md) to build voyager. +## Acknowledgement + - kubernetes/contrib https://github.com/kubernetes/contrib/tree/master/service-loadbalancer + - xenolf/lego https://github.com/xenolf/lego + - kelseyhightower/kube-cert-manager https://github.com/kelseyhightower/kube-cert-manager + - PalmStoneGames/kube-cert-manager https://github.com/PalmStoneGames/kube-cert-manager ## Support If you have any questions, you can reach out to us. diff --git a/docs/developer-guide/README.md b/docs/developer-guide/README.md index e33110992..415a945c0 100644 --- a/docs/developer-guide/README.md +++ b/docs/developer-guide/README.md @@ -33,7 +33,8 @@ voyager works by implementing third party resource data watcher for kubernetes. for specific events as ADD, UPDATE and DELETE. and perform required operations. Ingress watcher generates the configuration for HAProxy and stores it as a ConfigMaps and creates a RC with -specified HAProxy - that is configured with auto reload while any changes happens to ConfigMap data. voyager -keeps the ingress resource and the configuration in sync by performing processing on the resources. +specified HAProxy - that is configured with auto reload while any changes happens to ConfigMap data. This is handled via +[kloader](https://github.com/appscode/kloader). Voyager keeps the ingress resource and the configuration in sync +by performing processing on the resources. -Certificate watcher watch and process certificates third party data and obtain a ACME certificates. \ No newline at end of file +Certificate watcher watch and process certificates third party data and obtain a ACME certificates. diff --git a/docs/developer-guide/build.md b/docs/developer-guide/build.md index 93dace40f..de081f5e6 100644 --- a/docs/developer-guide/build.md +++ b/docs/developer-guide/build.md @@ -33,3 +33,9 @@ $ docker push : $ docker tag appscode/voyager:default sadlil/voyager:default $ docker push sadlil/voyager:default ``` + +## Build HAProxy +```sh +$ ./hack/docker/haproxy//setup.sh +``` +Specific version of HAProxy can be used with Voyager via `--haproxy-image`. This packages HAProxy and [kloader](https://github.com/appscode/kloader) into a Debian jessie Docker image. diff --git a/docs/user-guide/README.md b/docs/user-guide/README.md index d4a531d1a..b4f99c478 100644 --- a/docs/user-guide/README.md +++ b/docs/user-guide/README.md @@ -167,3 +167,17 @@ certificate common name. ### Dive into Certificates You Can Learn more about `certificate.appscode.com` by reading [this doc](../component/certificate.md). + + +## Running voyager alongside with other ingress controller +voyager can be configured to handle default kubernetes ingress or only ingress.appscode.com. voyager can also be run +along side with other controllers. + +```sh + --ingress-class + // this flag can be set to 'voyager' to handle only ingress + // with annotation kubernetes.io/ingress.class=voyager. + + // If unset, voyager will also handle ingress without ingress-class annotation. +``` +Other ingress controller can be run alongside voyager to handle specific classed ingress.