Skip to content

Commit

Permalink
docs: update ingress.class to kong
Browse files Browse the repository at this point in the history
The default Ingress class changed to Kong with 0.3.0.

From #223
  • Loading branch information
sirajm authored and hbagdi committed Jan 16, 2019
1 parent de864a0 commit 1ebde2b
Show file tree
Hide file tree
Showing 3 changed files with 19 additions and 10 deletions.
2 changes: 1 addition & 1 deletion annotations.md
Original file line number Diff line number Diff line change
Expand Up @@ -31,7 +31,7 @@ On the other hand, an annotation such as
metadata:
name: foo
annotations:
kubernetes.io/ingress.class: "nginx"
kubernetes.io/ingress.class: "kong"
```
will target Kong Ingress controller, forcing the GCE controller to ignore it.
Expand Down
8 changes: 4 additions & 4 deletions deployment/gke.md
Original file line number Diff line number Diff line change
Expand Up @@ -246,7 +246,7 @@ IP address to the `kong-proxy` Service.
name: dummy
namespace: dummy
annotations:
kubernetes.io/ingress.class: "nginx"
kubernetes.io/ingress.class: "kong"
spec:
rules:
- host: dummy.kong.example
Expand Down Expand Up @@ -283,7 +283,7 @@ metadata:
name: kong-admin
namespace: kong
annotations:
kubernetes.io/ingress.class: "nginx"
kubernetes.io/ingress.class: "kong"
spec:
rules:
- host: dummy.kong.example
Expand Down Expand Up @@ -361,7 +361,7 @@ metadata:
name: dummy
namespace: dummy
annotations:
kubernetes.io/ingress.class: "nginx"
kubernetes.io/ingress.class: "kong"
configuration.konghq.com: sample-kong-ingress
spec:
rules:
Expand All @@ -373,4 +373,4 @@ spec:
serviceName: http-svc
servicePort: http" | kubectl apply -f -
```
```
19 changes: 14 additions & 5 deletions ingress-class.md
Original file line number Diff line number Diff line change
Expand Up @@ -20,7 +20,7 @@ On the other hand, an annotation such as
metadata:
name: foo
annotations:
kubernetes.io/ingress.class: "nginx"
kubernetes.io/ingress.class: "kong"
```
will target Kong Ingress controller, forcing the GCE controller to ignore it.
Expand All @@ -29,8 +29,15 @@ __Note__: Deploying multiple ingress controller and not specifying the
annotation will cause both controllers fighting to satisfy the Ingress
and will lead to unknown behaviour.
If you're running multiple ingress controllers, or running on a cloud provider that handles ingress, you need to specify the annotation `kubernetes.io/ingress.class: "nginx"` in all ingresses you would like this controller to claim. This mechanism also provides users the ability to run _multiple_ Kong ingress controllers (e.g. one which serves public traffic, one which serves "internal" traffic).
When using this functionality the option `--ingress-class` should set a value unique for the cluster. Here is a partial example:
If you're running multiple ingress controllers, or running on a
cloud provider that handles ingress,
you need to specify the annotation `kubernetes.io/ingress.class: "kong"`
in all ingresses you would like this controller to claim.
This mechanism also provides users the ability to run _multiple_
Kong ingress controllers (e.g. one which serves public traffic,
and another serving "internal" traffic).
When using this functionality the option `--ingress-class`
should set a value unique for the cluster. Here is a partial example:

```yaml
spec:
Expand All @@ -44,5 +51,7 @@ spec:
- '--ingress-class=kong-internal'
```

Not specifying the annotation will lead to multiple ingress controllers claiming the same ingress.
Setting a value which does not match the class of any existing ingress controllers will cause all ingress controllers ignoring the ingress.
Not specifying the annotation will lead to multiple ingress controllers
claiming the same ingress.
Setting a value which does not match the class of any existing ingress
controllers will cause all ingress controllers ignoring the ingress.

0 comments on commit 1ebde2b

Please sign in to comment.