Skip to content

Commit

Permalink
document network options (#92)
Browse files Browse the repository at this point in the history
  • Loading branch information
jakolehm committed Mar 16, 2018
1 parent 52722dc commit 1322b60
Showing 1 changed file with 16 additions and 6 deletions.
22 changes: 16 additions & 6 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -42,6 +42,14 @@ addons:
enabled: true
```

You can view full sample of cluster.yml [here](./cluster.example.yml).

## Network Options

- `service_cidr` - IP address range for service VIPs. (default "10.96.0.0/12")
- `pod_network_cidr` - IP address range for the pod network. (default "10.32.0.0/12")
- `trusted_subnets` - array of trusted subnets where overlay network can be used without IPSEC.

## Addons

Kupo includes common functionality as addons. Addons can be enabled by introducing and enabling them in `cluster.yml`.
Expand All @@ -55,13 +63,15 @@ https://github.com/kubernetes/ingress-nginx
```yaml
ingress-nginx:
enabled: true
node_selector:
disk: ssd
configmap:
load-balance: least_conn
```
#### Options

- `node_selector`: if given, deploys ingress to only matching nodes.
- `configmap`: custom configuration (hash). For all supported `configmap` options, see: https://github.com/kubernetes/ingress-nginx/blob/master/docs/user-guide/configmap.md
- `node_selector` - deployment node selector (map), deploys ingress only to matching nodes.
- `configmap` - custom configuration (map). For all supported `configmap` options, see: https://github.com/kubernetes/ingress-nginx/blob/master/docs/user-guide/configmap.md

### Cert Manager

Expand All @@ -80,9 +90,9 @@ cert-manager:

#### Options

- `issuer.name`: registered issuer resource name
- `issuer.server`: ACME server url
- `issuer.email`: email address used for ACME registration
- `issuer.name` - registered issuer resource name
- `issuer.server`- ACME server url
- `issuer.email` - email address used for ACME registration

### Host Upgrades

Expand All @@ -96,7 +106,7 @@ host-upgrades:

#### Options

* `interval`: how often upgrades are applied (string)
* `interval` - how often upgrades are applied (string)

### Kured

Expand Down

0 comments on commit 1322b60

Please sign in to comment.