Skip to content

Commit

Permalink
doc: reuse_connections option/env variable
Browse files Browse the repository at this point in the history
the default configuration changes: now kubenurse will NOT reuse
connections per default. this permits to have a clearer picture,
as closed long-lived connections might not involve DNS resolution,
and might hide Load balancer pool problems.

Signed-off-by: Clément Nussbaumer <clement.nussbaumer@postfinance.ch>
  • Loading branch information
clementnuss committed Jan 19, 2024
1 parent f32c37b commit 9cb33d7
Show file tree
Hide file tree
Showing 3 changed files with 6 additions and 0 deletions.
2 changes: 2 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -52,6 +52,7 @@ The following command can be used to install kubenurse with Helm: `helm upgrade
| check_me_service | Sets `KUBENURSE_CHECK_ME_SERVICE` environment variable | `true` |
| check_neighbourhood | Sets `KUBENURSE_CHECK_NEIGHBOURHOOD` environment variable | `true` |
| check_interval | Sets `KUBENURSE_CHECK_INTERVAL` environment variable | `5s` |
| reuse_connections | Sets `KUBENURSE_REUSE_CONNECTIONS` environment variable | `false` |
| use_tls | Sets `KUBENURSE_USE_TLS` environment variable | `false` |
| cert_file | Sets `KUBENURSE_CERT_FILE` environment variable | |
| cert_key | Sets `KUBENURSE_CERT_KEY` environment variable | |
Expand Down Expand Up @@ -91,6 +92,7 @@ kubenurse is configured with environment variables:
- `KUBENURSE_CHECK_ME_SERVICE`: If this is `"true"`, kubenurse will perform the check [Me Service](#Me Service). default is "true"
- `KUBENURSE_CHECK_NEIGHBOURHOOD`: If this is `"true"`, kubenurse will perform the check [Neighbourhood](#Neighbourhood). default is "true"
- `KUBENURSE_CHECK_INTERVAL`: the frequency to perform kubenurse checks. the string should be formatted for [time.ParseDuration](https://pkg.go.dev/time#ParseDuration). defaults to `5s`
- `KUBENURSE_REUSE_CONNECTIONS`: whether to reuse connections or not for all checks. default is "false"
- `KUBENURSE_HISTOGRAM_BUCKETS`: optional comma-separated list of float64, used in place of the [default prometheus histogram buckets](https://pkg.go.dev/github.com/prometheus/client_golang@v1.16.0/prometheus#DefBuckets)
- `KUBENURSE_USE_TLS`: If this is `"true"`, enable TLS endpoint on port 8443
- `KUBENURSE_CERT_FILE`: Certificate to use with TLS endpoint
Expand Down
2 changes: 2 additions & 0 deletions helm/kubenurse/templates/daemonset.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -72,6 +72,8 @@ spec:
value: {{ .Values.check_neighbourhood | quote }}
- name: KUBENURSE_CHECK_INTERVAL
value: {{ .Values.check_interval }}
- name: KUBENURSE_REUSE_CONNECTIONS
value: {{ .Values.reuse_connections | quote }}
- name: KUBENURSE_SHUTDOWN_DURATION
value: {{ .Values.shutdown_duration }}
- name: KUBENURSE_USE_TLS
Expand Down
2 changes: 2 additions & 0 deletions helm/kubenurse/values.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -49,6 +49,8 @@ check_api_me_service: true
check_neighbourhood: true
# KUBENURSE_CHECK_INTERVAL
check_interval: 5s
# KUBENURSE_REUSE_CONNECTIONS
reuse_connections: false
# KUBENURSE_SHUTDOWN_DURATION
shutdown_duration: 5s
# KUBENURSE_USE_TLS
Expand Down

0 comments on commit 9cb33d7

Please sign in to comment.