Skip to content
Permalink
Browse files

doc(config): add example to readme

Add examples for proxyLocations and proxyDomain to give guidance how to
use them.
  • Loading branch information...
notmaxx committed Sep 24, 2018
1 parent d079bac commit 8c0d07d8301205a83e5ffea746ad182441715a5f
Showing with 36 additions and 2 deletions.
  1. +36 −2 README.md
@@ -288,8 +288,8 @@ _Note that Kubernetes annotation maps are all of Go type `map[string]string`. A
| <a name="app-nginx-proxy-buffers-number"></a>routable application | service | [router.deis.io/nginx.proxyBuffers.number](#app-nginx-proxy-buffers-number) | `"8"` | `number` argument to the nginx `proxy_buffers` directive. This can be used to override the same option set globally on the router. |
| <a name="app-nginx-proxy-buffers-size"></a>routable application | service | [router.deis.io/nginx.proxyBuffers.size](#app-nginx-proxy-buffers-size) | `"4k"` | `size` argument to the nginx `proxy_buffers` directive expressed in bytes (no suffix), kilobytes (suffixes `k` and `K`), or megabytes (suffixes `m` and `M`). This can be used to override the same option set globally on the router. |
| <a name="app-nginx-proxy-buffers-busy-size"></a>routable application | service | [router.deis.io/nginx.proxyBuffers.busySize](#app-nginx-proxy-buffers-busy-size) | `"8k"` | nginx `proxy_busy_buffers_size` expressed in bytes (no suffix), kilobytes (suffixes `k` and `K`), or megabytes (suffixes `m` and `M`). This can be used to override the same option set globally on the router. |
|<a name="app-proxy-locations"></a>routable application | service | [router.deis.io/proxyLocations](#app-proxy-locations) | N/A | A list of locations of this servide to plug-in into another service determined by `router.deis.io/proxyDomain` |
|<a name="app-proxy-domain"></a>routable application | service | [router.deis.io/proxyDomain](#app-proxy-domain) | N/A | A reference to another service to plug-in `router.deis.io/proxyLocations` to |
|<a name="app-proxy-locations"></a>routable application | service | [router.deis.io/proxyLocations](#app-proxy-locations) | N/A | A list of locations of this service to plug-in into another service determined by `router.deis.io/proxyDomain` (see example below) |
|<a name="app-proxy-domain"></a>routable application | service | [router.deis.io/proxyDomain](#app-proxy-domain) | N/A | A reference to another service to plug-in `router.deis.io/proxyLocations` to (see example below) |

#### Annotations by example

@@ -339,6 +339,40 @@ metadata:
# ...
```

##### proxy locations:

Service of the application where we want `/webhooks` path to be handled by another service
```
apiVersion: v1
kind: Service
metadata:
name: app_with_overwritten_webhooks_location
labels:
router.deis.io/routable: "true"
namespace: router-examples
# ...
annotations:
router.deis.io/domains: app_with_overwritten_webhooks_location
# ...
```

Service of the application which should handle `/webhooks` path of the app above
```
apiVersion: v1
kind: Service
metadata:
name: app_webhooks_location_handler
labels:
router.deis.io/routable: "true"
namespace: router-examples
# ...
annotations:
...
router.deis.io/proxyDomain=app_with_overwritten_webhooks_location
router.deis.io/proxyLocations=/webhooks
# ...
```

### <a name="ssl"></a>SSL

Router has support for HTTPS with the ability to perform SSL termination using certificates supplied via Kubernetes secrets. Just as router utilizes the Kubernetes API to discover routable services, router also uses the API to discover cert-bearing secrets. This allows the router to dynamically refresh and reload configuration whenever such a certificate is added, updated, or removed. There is never a need to explicitly restart the router.

0 comments on commit 8c0d07d

Please sign in to comment.
You can’t perform that action at this time.