forked from projectcontour/contour
/
annotations.go
129 lines (115 loc) · 4.79 KB
/
annotations.go
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
// Copyright © 2018 Heptio
// 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 dag
import (
"fmt"
"strconv"
"strings"
"time"
"github.com/gogo/protobuf/types"
"k8s.io/api/extensions/v1beta1"
)
const (
// set docs/annotations.md for details of how these annotations
// are applied by Contour.
annotationRequestTimeout = "contour.heptio.com/request-timeout"
annotationWebsocketRoutes = "contour.heptio.com/websocket-routes"
annotationUpstreamProtocol = "contour.heptio.com/upstream-protocol"
annotationMaxConnections = "contour.heptio.com/max-connections"
annotationMaxPendingRequests = "contour.heptio.com/max-pending-requests"
annotationMaxRequests = "contour.heptio.com/max-requests"
annotationMaxRetries = "contour.heptio.com/max-retries"
annotationRetryOn = "contour.heptio.com/retry-on"
annotationNumRetries = "contour.heptio.com/num-retries"
annotationPerTryTimeout = "contour.heptio.com/per-try-timeout"
// By default envoy applies a 15 second timeout to all backend requests.
// The explicit value 0 turns off the timeout, implying "never time out"
// https://www.envoyproxy.io/docs/envoy/v1.5.0/api-v2/rds.proto#routeaction
infiniteTimeout = -1
noTimeout = 0
)
// parseAnnotationTimeout parses the annotations map for the supplied key as a timeout.
// If the value is present, but malformed, the timeout value is valid, and represents
// infinite timeout.
func parseAnnotationTimeout(annotations map[string]string, key string) time.Duration {
timeoutStr := annotations[key]
// Error or unspecified is interpreted as no timeout specified, use envoy defaults
if timeoutStr == "" {
return noTimeout
}
// Interpret "infinity" explicitly as an infinite timeout, which envoy config
// expects as a timeout of 0. This could be specified with the duration string
// "0s" but want to give an explicit out for operators.
if timeoutStr == "infinity" {
return infiniteTimeout
}
timeoutParsed, err := time.ParseDuration(timeoutStr)
if err != nil {
// TODO(cmalonty) plumb a logger in here so we can log this error.
// Assuming infinite duration is going to surprise people less for
// a not-parseable duration than a implicit 15 second one.
return infiniteTimeout
}
return timeoutParsed
}
// parseAnnotation parses the annotation map for the supplied key.
// If the value is not present, or malformed, then zero is returned.
func parseAnnotation(annotations map[string]string, annotation string) int {
v, _ := strconv.ParseInt(annotations[annotation], 10, 32)
return int(v)
}
// parseAnnotationUint32 parsers the annotation map for the supplied annotation key.
// If the value is not present, or malformed, then nil is returned.
func parseAnnotationUInt32(annotations map[string]string, annotation string) *types.UInt32Value {
v, err := strconv.ParseUint(annotations[annotation], 10, 32)
if err != nil {
return nil
}
return &types.UInt32Value{Value: uint32(v)}
}
// parseUpstreamProtocols parses the annotations map for a contour.heptio.com/upstream-protocol.{protocol}
// where 'protocol' identifies which protocol must be used in the upstream.
// If the value is not present, or malformed, then an empty map is returned.
func parseUpstreamProtocols(annotations map[string]string, annotation string, protocols ...string) map[string]string {
up := make(map[string]string)
for _, protocol := range protocols {
ports := annotations[fmt.Sprintf("%s.%s", annotation, protocol)]
for _, v := range strings.Split(ports, ",") {
port := strings.TrimSpace(v)
if port != "" {
up[port] = protocol
}
}
}
return up
}
// httpAllowed returns true unless the kubernetes.io/ingress.allow-http annotation is
// present and set to false.
func httpAllowed(i *v1beta1.Ingress) bool {
return !(i.Annotations["kubernetes.io/ingress.allow-http"] == "false")
}
// tlsRequired returns true if the ingress.kubernetes.io/force-ssl-redirect annotation is
// present and set to true.
func tlsRequired(i *v1beta1.Ingress) bool {
return i.Annotations["ingress.kubernetes.io/force-ssl-redirect"] == "true"
}
func websocketRoutes(i *v1beta1.Ingress) map[string]bool {
routes := make(map[string]bool)
for _, v := range strings.Split(i.Annotations[annotationWebsocketRoutes], ",") {
route := strings.TrimSpace(v)
if route != "" {
routes[route] = true
}
}
return routes
}