Skip to content

Commit

Permalink
Merge pull request #709 from M00nF1sh/fix-doc
Browse files Browse the repository at this point in the history
Modifications to docs
  • Loading branch information
k8s-ci-robot committed Nov 1, 2018
2 parents ef9f48d + 167633f commit 438c750
Show file tree
Hide file tree
Showing 3 changed files with 12 additions and 9 deletions.
15 changes: 9 additions & 6 deletions docs/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -49,12 +49,15 @@ Along with the above, the controller also...
recover if the controller were to be restarted.

### Ingress Traffic

This section details how traffic reaches the cluster.

As seen above, the ingress traffic for controller-managed resources starts at the ALB and reaches the Kubernetes nodes through each service's NodePort. This means that
services referenced from ingress resource must be exposed on a node port in order to be
reached by the ALB.
ALB Ingress controller supports two traffic modes:
* Instance mode
* IP mode

By default, `Instance mode` is used, users can explicitly select the mode via `alb.ingress.kubernetes.io/target-type` annotation.
#### Instance mode
Ingress traffic starts at the ALB and reaches the Kubernetes nodes through each service's NodePort. This means that services referenced from ingress resources must be exposed by `type:NodePort` in order to be reached by the ALB.
#### IP mode
Ingress traffic starts at the ALB and reaches the Kubernetes pods directly. CNIs must support directly accessible POD ip via [secondary IP addresses on ENI](https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/using-eni.html).

## Setup

Expand Down
6 changes: 3 additions & 3 deletions docs/guide/setup.md
Original file line number Diff line number Diff line change
Expand Up @@ -24,7 +24,7 @@ The controller determines subnets to deploy each ALB to based on an annotation o

##### Via annotation

`alb.ingress.kubernetes.io/subnets` may be specified in each ingress resource with the subnet IDs or `Name` tags. This allows for flexibility in where ALBs land. This list of subnets must include 2 or more that exist in unique availability zones. See the [annotations documentation](ingress-resources.md#annotations) for more details.
`alb.ingress.kubernetes.io/subnets` may be specified in each ingress resource with the subnet IDs or `Name` tags. This allows for flexibility in where ALBs land. The list of subnets must include 2 or more that exist in unique availability zones. See the [annotations documentation](../api/ingress.md#annotations) for more details.

##### Via tags on the subnets

Expand Down Expand Up @@ -56,7 +56,7 @@ helm registry install quay.io/coreos/alb-ingress-controller-helm
A sample manifest can be found below.

```
$ wget https://raw.githubusercontent.com/kubernetes-sigs/aws-alb-ingress-controller/master/examples/alb-ingress-controller.yaml
$ wget https://raw.githubusercontent.com/kubernetes-sigs/aws-alb-ingress-controller/master/docs/examples/alb-ingress-controller.yaml
```

At minimum, edit the following variables.
Expand Down Expand Up @@ -112,7 +112,7 @@ helm registry install quay.io/coreos/alb-ingress-controller-helm
1. Download external-dns to manage Route 53.

```bash
$ wget https://raw.githubusercontent.com/kubernetes-sigs/aws-alb-ingress-controller/master/examples/external-dns.yaml
$ wget https://raw.githubusercontent.com/kubernetes-sigs/aws-alb-ingress-controller/master/docs/examples/external-dns.yaml
```

1. Edit the `--domain-filter` flag to include your hosted zone(s)
Expand Down
Binary file modified docs/imgs/controller-design.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.

0 comments on commit 438c750

Please sign in to comment.