Commit 03374e60 authored by Geoff Simmons's avatar Geoff Simmons

Add info about the ingress.class annotation to the front-page README.

parent a68a9aaf
......@@ -55,6 +55,19 @@ The [``examples/``](/examples) folder contains YAML configurations for
sample Services and an Ingress to test and demonstrate the Ingress
implementation (based on the "cafe" example from other projects).
This implementation requires that the Ingress definition includes an
``ingress.class`` Annotation identifying ``varnish``:
```
kind: Ingress
metadata:
annotations:
kubernetes.io/ingress.class: "varnish"
[...]
```
The controller ignores all Ingress definitions that do not include the
annotation. So you can work with other Ingress controllers that are
based on other technologies in the same Kubernetes cluster.
# Development
The executable ``k8s-ingress``, which acts as the Ingress controller,
......
Markdown is supported
0% or
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment