Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Update docs #111

Merged
merged 2 commits into from
May 22, 2017
Merged

Update docs #111

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
d24e626
added-all
tamalsaha May 22, 2017
6da0160
added-all
tamalsaha May 22, 2017
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
5 changes: 4 additions & 1 deletion docs/user-guide/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -35,7 +35,7 @@ Now Create Your Ingress/Certificated.
// ingress with annotation kubernetes.io/ingress.class=voyager.
```

Voyager can run HAProxy in 2 different modes. `cloude-provider` and `cluster-name` flags should be set appropriately depending on the mode. These modes are:
Voyager can run HAProxy in 3 different modes. `cloude-provider` and `cluster-name` flags should be set appropriately depending on the mode. These modes are:

- HostPort: In this mode, HAProxy is run as DaemonSet using nodeSelector and hostNetwork:true. As a result,
HAProxy's IP will be same as the IP address for nodes where it is running. This is supported on any cloud provider
Expand All @@ -46,6 +46,9 @@ HAProxy's IP will be same as the IP address for nodes where it is running. This
- LoadBalancer: In this mode, a Kubernetes LoadBalancer type service is used to expose HAProxy to the internet.
This is supported for cloud providers known to Kubernetes (`aws`, `gce` and `azure`), `--cloud-provider` and `--cluster-name` is required to properly setup this loadbalancer. This mode supports reserved ip on GCE.

- NodePort: In this mode, a Kubernetes NodePort type service is used to expose HAProxy to the internet. This is supported on any cloud provider including
baremetal clusters. Users are required to configure firewall as needed.

You can choose the mode in your Ingress YAML using label: [ingress.appscode.com/type](/docs/user-guide/component/ingress#configurations-options)

## Run with helm
Expand Down
20 changes: 9 additions & 11 deletions docs/user-guide/component/ingress/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -85,26 +85,24 @@ ingress.appscode.com/stickySession = indicates the session affinity for
session affinity will apply to all the rulses set.
defaults to false

ingress.appscode.com/type = indicates loadbalancer type to run via Kubernets Service
Load balancer or in Node Port Mode.
Values in:
ingress.appscode.com/type = indicates type of service used to expose HAproxy to the internet. Possible values are:
- LoadBalancer (default)
- HostPort (previously called Daemon)
- NodePort

ingress.appscode.com/daemon.nodeSelector = only applicatble when lb.appscode.com/type is set to HostPort (previously called Daemon),
ingress.appscode.com/replicas = indicates number of replicas of HAProxy is run. The default value is 1.

ingress.appscode.com/daemon.nodeSelector = only applicatble when lb.appscode.com/type is set to HostPort (previously called Daemon),
this nodeSelector will indicate which host the load balancer
needs to run.
The format of providing nodeSelector is -
`foo=bar,foo2=bar2`

ingress.appscode.com/ip = This only applies to "gce" and "gke" cloud providers. If set, it will be
assigned loadbalancer used to expose HAProxy. Usually this is set to a static IP preserve DNS configuration.

ingress.appscode.com/ip = provide ip to run loadbalancer on the ip, it will only work
if the ip is available to the clod provider. Works best with
a persistance ip from the underlying cloud provider
and set the ip as the value.

ingress.appscode.com/loadbalancer.persist = if set to true load balancer will run in node port mode.

ingress.appscode.com/persist = This only applies to "aws" cloud provider. If set to true, AWS load balancer will
not be deleted when the ingress resource is deleted.

ingress.appscode.com/stats = if set to true it will open HAProxy stats in IP's 1936 port.
defaults to false.
Expand Down