This repository has been archived by the owner on Apr 17, 2019. It is now read-only.
-
Notifications
You must be signed in to change notification settings - Fork 1.7k
[nginx-ingress-controller] Allow custom health checks in upstreams #1002
Merged
bprashanth
merged 1 commit into
kubernetes-retired:master
from
aledbf:nginx-check-upstreams
May 30, 2016
Merged
Changes from all commits
Commits
File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
45 changes: 45 additions & 0 deletions
45
ingress/controllers/nginx/examples/custom-upstream-check/README.md
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,45 @@ | ||
|
|
||
| This example shows how is possible to create a custom configuration for a particular upstream associated with an Ingress rule. | ||
|
|
||
| echo " | ||
| apiVersion: extensions/v1beta1 | ||
| kind: Ingress | ||
| metadata: | ||
| name: echoheaders | ||
| annotations: | ||
| ingress-nginx.kubernetes.io/upstream-fail-timeout: "30" | ||
| spec: | ||
| rules: | ||
| - host: foo.bar.com | ||
| http: | ||
| paths: | ||
| - path: / | ||
| backend: | ||
| serviceName: echoheaders | ||
| servicePort: 80 | ||
| " | kubectl create -f - | ||
|
|
||
|
|
||
| Check the annotation is present in the Ingress rule: | ||
| ``` | ||
| kubectl get ingress echoheaders -o yaml | ||
| `` | ||
|
|
||
| Check the NGINX configuration is updated using kubectl or the status page: | ||
|
|
||
| ``` | ||
| $ kubectl exec nginx-ingress-controller-v1ppm cat /etc/nginx/nginx.conf | ||
| ``` | ||
|
|
||
| ``` | ||
| .... | ||
| upstream default-echoheaders-x-80 { | ||
| least_conn; | ||
| server 10.2.92.2:8080 max_fails=5 fail_timeout=30; | ||
|
|
||
| } | ||
| .... | ||
| ``` | ||
|
|
||
|
|
||
|  |
Binary file added
BIN
+59.2 KB
ingress/controllers/nginx/examples/custom-upstream-check/custom-upstream.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,101 @@ | ||
| /* | ||
| Copyright 2016 The Kubernetes Authors All rights reserved. | ||
|
|
||
| Licensed under the Apache License, Version 2.0 (the "License"); | ||
| you may not use this file except in compliance with the License. | ||
| You may obtain a copy of the License at | ||
|
|
||
| http://www.apache.org/licenses/LICENSE-2.0 | ||
|
|
||
| Unless required by applicable law or agreed to in writing, software | ||
| distributed under the License is distributed on an "AS IS" BASIS, | ||
| WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. | ||
| See the License for the specific language governing permissions and | ||
| limitations under the License. | ||
| */ | ||
|
|
||
| package healthcheck | ||
|
|
||
| import ( | ||
| "errors" | ||
| "strconv" | ||
|
|
||
| "k8s.io/kubernetes/pkg/apis/extensions" | ||
|
|
||
| "k8s.io/contrib/ingress/controllers/nginx/nginx" | ||
| ) | ||
|
|
||
| const ( | ||
| upsMaxFails = "ingress-nginx.kubernetes.io/upstream-max-fails" | ||
| upsFailTimeout = "ingress-nginx.kubernetes.io/upstream-fail-timeout" | ||
| ) | ||
|
|
||
| var ( | ||
| // ErrMissingMaxFails returned error when the ingress does not contains the | ||
| // max-fails annotation | ||
| ErrMissingMaxFails = errors.New("max-fails annotations is missing") | ||
|
|
||
| // ErrMissingFailTimeout returned error when the ingress does not contains | ||
| // the fail-timeout annotation | ||
| ErrMissingFailTimeout = errors.New("fail-timeout annotations is missing") | ||
|
|
||
| // ErrInvalidNumber returned | ||
| ErrInvalidNumber = errors.New("the annotation does not contains a number") | ||
| ) | ||
|
|
||
| // Upstream returns the URL and method to use check the status of | ||
| // the upstream server/s | ||
| type Upstream struct { | ||
| MaxFails int | ||
| FailTimeout int | ||
| } | ||
|
|
||
| type ingAnnotations map[string]string | ||
|
|
||
| func (a ingAnnotations) maxFails() (int, error) { | ||
| val, ok := a[upsMaxFails] | ||
| if !ok { | ||
| return 0, ErrMissingMaxFails | ||
| } | ||
|
|
||
| mf, err := strconv.Atoi(val) | ||
| if err != nil { | ||
| return 0, ErrInvalidNumber | ||
| } | ||
|
|
||
| return mf, nil | ||
| } | ||
|
|
||
| func (a ingAnnotations) failTimeout() (int, error) { | ||
| val, ok := a[upsFailTimeout] | ||
| if !ok { | ||
| return 0, ErrMissingFailTimeout | ||
| } | ||
|
|
||
| ft, err := strconv.Atoi(val) | ||
| if err != nil { | ||
| return 0, ErrInvalidNumber | ||
| } | ||
|
|
||
| return ft, nil | ||
| } | ||
|
|
||
| // ParseAnnotations parses the annotations contained in the ingress | ||
| // rule used to configure upstream check parameters | ||
| func ParseAnnotations(cfg nginx.NginxConfiguration, ing *extensions.Ingress) *Upstream { | ||
| if ing.GetAnnotations() == nil { | ||
| return &Upstream{cfg.UpstreamMaxFails, cfg.UpstreamFailTimeout} | ||
| } | ||
|
|
||
| mf, err := ingAnnotations(ing.GetAnnotations()).maxFails() | ||
| if err != nil { | ||
| mf = cfg.UpstreamMaxFails | ||
| } | ||
|
|
||
| ft, err := ingAnnotations(ing.GetAnnotations()).failTimeout() | ||
| if err != nil { | ||
| ft = cfg.UpstreamFailTimeout | ||
| } | ||
|
|
||
| return &Upstream{mf, ft} | ||
| } |
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
s/liveness/readiness
Also this language makes me think nginx scrapes the pods for their readiness probes but that's not the case. Please clarify with something like: nginx will not health check your backends, and whenever the endpoints controller notices a readiness probe failure that pod's ip will be removed from the list of endpoints, causing nginx to also remove it from the upstreams.