-
Notifications
You must be signed in to change notification settings - Fork 350
/
ingress.go
412 lines (367 loc) · 12.8 KB
/
ingress.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
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
package kubernetes
import (
"crypto/tls"
b64 "encoding/base64"
"encoding/json"
"errors"
"fmt"
"regexp"
"strconv"
"strings"
log "github.com/sirupsen/logrus"
"github.com/zalando/skipper/dataclients/kubernetes/definitions"
"github.com/zalando/skipper/eskip"
"github.com/zalando/skipper/secrets/certregistry"
)
const (
ingressRouteIDPrefix = "kube"
backendWeightsAnnotationKey = "zalando.org/backend-weights"
ratelimitAnnotationKey = "zalando.org/ratelimit"
skipperLoadBalancerAnnotationKey = "zalando.org/skipper-loadbalancer"
skipperBackendProtocolAnnotationKey = "zalando.org/skipper-backend-protocol"
pathModeAnnotationKey = "zalando.org/skipper-ingress-path-mode"
ingressOriginName = "ingress"
tlsSecretType = "kubernetes.io/tls"
tlsSecretDataCrt = "tls.crt"
tlsSecretDataKey = "tls.key"
)
type ingressContext struct {
state *clusterState
ingressV1 *definitions.IngressV1Item
logger *logger
annotationFilters []*eskip.Filter
annotationPredicate string
extraRoutes []*eskip.Route
backendWeights map[string]float64
pathMode PathMode
redirect *redirectInfo
hostRoutes map[string][]*eskip.Route
defaultFilters defaultFilters
certificateRegistry *certregistry.CertRegistry
calculateTraffic func([]*weightedIngressBackend) map[string]backendTraffic
}
type ingress struct {
eastWestRangeDomains []string
eastWestRangePredicates []*eskip.Predicate
allowedExternalNames []*regexp.Regexp
kubernetesEastWestDomain string
pathMode PathMode
httpsRedirectCode int
kubernetesEnableEastWest bool
provideHTTPSRedirect bool
disableCatchAllRoutes bool
forceKubernetesService bool
backendTrafficAlgorithm BackendTrafficAlgorithm
defaultLoadBalancerAlgorithm string
}
var nonWord = regexp.MustCompile(`\W`)
var errNotAllowedExternalName = errors.New("ingress with not allowed external name service")
func (ic *ingressContext) addHostRoute(host string, route *eskip.Route) {
ic.hostRoutes[host] = append(ic.hostRoutes[host], route)
}
func newIngress(o Options) *ingress {
return &ingress{
provideHTTPSRedirect: o.ProvideHTTPSRedirect,
httpsRedirectCode: o.HTTPSRedirectCode,
disableCatchAllRoutes: o.DisableCatchAllRoutes,
pathMode: o.PathMode,
kubernetesEnableEastWest: o.KubernetesEnableEastWest,
kubernetesEastWestDomain: o.KubernetesEastWestDomain,
eastWestRangeDomains: o.KubernetesEastWestRangeDomains,
eastWestRangePredicates: o.KubernetesEastWestRangePredicates,
allowedExternalNames: o.AllowedExternalNames,
forceKubernetesService: o.ForceKubernetesService,
backendTrafficAlgorithm: o.BackendTrafficAlgorithm,
defaultLoadBalancerAlgorithm: o.DefaultLoadBalancerAlgorithm,
}
}
func getLoadBalancerAlgorithm(m *definitions.Metadata, defaultAlgorithm string) string {
algorithm := defaultAlgorithm
if algorithmAnnotationValue, ok := m.Annotations[skipperLoadBalancerAnnotationKey]; ok {
algorithm = algorithmAnnotationValue
}
return algorithm
}
// TODO: find a nicer way to autogenerate route IDs
func routeID(namespace, name, host, path, backend string) string {
namespace = nonWord.ReplaceAllString(namespace, "_")
name = nonWord.ReplaceAllString(name, "_")
host = nonWord.ReplaceAllString(host, "_")
path = nonWord.ReplaceAllString(path, "_")
backend = nonWord.ReplaceAllString(backend, "_")
return fmt.Sprintf("%s_%s__%s__%s__%s__%s", ingressRouteIDPrefix, namespace, name, host, path, backend)
}
// routeIDForCustom generates a route id for a custom route of an ingress
// resource.
func routeIDForCustom(namespace, name, id, host string, index int) string {
name = name + "_" + id + "_" + strconv.Itoa(index)
return routeID(namespace, name, host, "", "")
}
func externalNameRoute(
ns, name, idHost string,
hostRegexps []string,
svc *service,
servicePort *servicePort,
allowedNames []*regexp.Regexp,
) (*eskip.Route, error) {
if !isExternalDomainAllowed(allowedNames, svc.Spec.ExternalName) {
return nil, fmt.Errorf("%w: %s", errNotAllowedExternalName, svc.Spec.ExternalName)
}
scheme := "https"
if n, _ := servicePort.TargetPort.Number(); n != 443 {
scheme = "http"
}
u := fmt.Sprintf("%s://%s:%s", scheme, svc.Spec.ExternalName, servicePort.TargetPort)
f, err := eskip.ParseFilters(fmt.Sprintf(`setRequestHeader("Host", "%s")`, svc.Spec.ExternalName))
if err != nil {
return nil, err
}
return &eskip.Route{
Id: routeID(ns, name, idHost, "", svc.Spec.ExternalName),
BackendType: eskip.NetworkBackend,
Backend: u,
Filters: f,
HostRegexps: hostRegexps,
}, nil
}
func applyAnnotationPredicates(m PathMode, r *eskip.Route, annotation string) error {
if annotation == "" {
return nil
}
predicates, err := eskip.ParsePredicates(annotation)
if err != nil {
return err
}
// to avoid conflict, give precedence for those predicates that come
// from annotations
if m == PathPrefix {
for _, p := range predicates {
if p.Name != "Path" && p.Name != "PathSubtree" {
continue
}
r.Path = ""
for i, p := range r.Predicates {
if p.Name != "PathSubtree" && p.Name != "Path" {
continue
}
copy(r.Predicates[i:], r.Predicates[i+1:])
r.Predicates[len(r.Predicates)-1] = nil
r.Predicates = r.Predicates[:len(r.Predicates)-1]
break
}
}
}
r.Predicates = append(r.Predicates, predicates...)
return nil
}
func addExtraRoutes(ic *ingressContext, ruleHost, path, pathType, eastWestDomain string, enableEastWest bool) {
hosts := []string{createHostRx(ruleHost)}
var ns, name string
name = ic.ingressV1.Metadata.Name
ns = ic.ingressV1.Metadata.Namespace
// add extra routes from optional annotation
for extraIndex, r := range ic.extraRoutes {
route := *r
route.HostRegexps = hosts
route.Id = routeIDForCustom(
ns,
name,
route.Id,
ruleHost+strings.ReplaceAll(path, "/", "_"),
extraIndex)
setPathV1(ic.pathMode, &route, pathType, path)
if n := countPathRoutes(&route); n <= 1 {
ic.addHostRoute(ruleHost, &route)
ic.redirect.updateHost(ruleHost)
} else {
ic.logger.Errorf("Failed to add route having %d path routes: %v", n, r)
}
if enableEastWest {
ewRoute := createEastWestRouteIng(eastWestDomain, name, ns, &route)
ewHost := fmt.Sprintf("%s.%s.%s", name, ns, eastWestDomain)
ic.addHostRoute(ewHost, ewRoute)
}
}
}
func countPathRoutes(r *eskip.Route) int {
i := 0
for _, p := range r.Predicates {
if p.Name == "PathSubtree" || p.Name == "Path" {
i++
}
}
if r.Path != "" {
i++
}
return i
}
// parse filter and ratelimit annotation
func annotationFilter(m *definitions.Metadata, logger *logger) []*eskip.Filter {
var annotationFilter string
if ratelimitAnnotationValue, ok := m.Annotations[ratelimitAnnotationKey]; ok {
annotationFilter = ratelimitAnnotationValue
}
if val, ok := m.Annotations[definitions.IngressFilterAnnotation]; ok {
if annotationFilter != "" {
annotationFilter += " -> "
}
annotationFilter += val
}
if annotationFilter != "" {
annotationFilters, err := eskip.ParseFilters(annotationFilter)
if err == nil {
return annotationFilters
}
logger.Errorf("Can not parse annotation filters: %v", err)
}
return nil
}
// parse predicate annotation
func annotationPredicate(m *definitions.Metadata) string {
var annotationPredicate string
if val, ok := m.Annotations[definitions.IngressPredicateAnnotation]; ok {
annotationPredicate = val
}
return annotationPredicate
}
// parse routes annotation
func extraRoutes(m *definitions.Metadata) []*eskip.Route {
var extraRoutes []*eskip.Route
annotationRoutes := m.Annotations[definitions.IngressRoutesAnnotation]
if annotationRoutes != "" {
extraRoutes, _ = eskip.Parse(annotationRoutes) // We ignore the error here because it should be handled by the validator object
}
return extraRoutes
}
// parse backend-weights annotation if it exists
func backendWeights(m *definitions.Metadata, logger *logger) map[string]float64 {
var backendWeights map[string]float64
if backends, ok := m.Annotations[backendWeightsAnnotationKey]; ok {
err := json.Unmarshal([]byte(backends), &backendWeights)
if err != nil {
logger.Errorf("Error while parsing backend-weights annotation: %v", err)
}
}
return backendWeights
}
// parse pathmode from annotation or fallback to global default
func pathMode(m *definitions.Metadata, globalDefault PathMode, logger *logger) PathMode {
pathMode := globalDefault
if pathModeString, ok := m.Annotations[pathModeAnnotationKey]; ok {
if p, err := ParsePathMode(pathModeString); err != nil {
logger.Errorf("Failed to get path mode: %v", err)
} else {
logger.Debugf("Set pathMode to %s", p)
pathMode = p
}
}
return pathMode
}
func (ing *ingress) addCatchAllRoutes(host string, r *eskip.Route, redirect *redirectInfo) []*eskip.Route {
catchAll := &eskip.Route{
Id: routeID("", "catchall", host, "", ""),
HostRegexps: r.HostRegexps,
BackendType: eskip.ShuntBackend,
}
routes := []*eskip.Route{catchAll}
if ing.kubernetesEnableEastWest {
if ew := createEastWestRouteIng(ing.kubernetesEastWestDomain, r.Name, r.Namespace, catchAll); ew != nil {
routes = append(routes, ew)
}
}
if code, ok := redirect.setHostCode[host]; ok {
routes = append(routes, createIngressEnableHTTPSRedirect(catchAll, code))
}
if redirect.disableHost[host] {
routes = append(routes, createIngressDisableHTTPSRedirect(catchAll))
}
return routes
}
// hasCatchAllRoutes returns true if one of the routes in the list has a catchAll
// path expression.
//
// TODO: this should also consider path types exact and subtree
func hasCatchAllRoutes(routes []*eskip.Route) bool {
for _, route := range routes {
if len(route.PathRegexps) == 0 {
return true
}
for _, exp := range route.PathRegexps {
if exp == "^/" {
return true
}
}
}
return false
}
// convert logs if an invalid found, but proceeds with the valid ones.
// Reporting failures in Ingress status is not possible, because
// Ingress status field only supports IP and Hostname as string.
func (ing *ingress) convert(state *clusterState, df defaultFilters, r *certregistry.CertRegistry, loggingEnabled bool) ([]*eskip.Route, error) {
var ewIngInfo map[string][]string // r.Id -> {namespace, name}
if ing.kubernetesEnableEastWest {
ewIngInfo = make(map[string][]string)
}
routes := make([]*eskip.Route, 0, len(state.ingressesV1))
hostRoutes := make(map[string][]*eskip.Route)
redirect := createRedirectInfo(ing.provideHTTPSRedirect, ing.httpsRedirectCode)
for _, i := range state.ingressesV1 {
r, err := ing.ingressV1Route(i, redirect, state, hostRoutes, df, r, loggingEnabled)
if err != nil {
return nil, err
}
if r != nil {
routes = append(routes, r)
if ing.kubernetesEnableEastWest {
ewIngInfo[r.Id] = []string{i.Metadata.Namespace, i.Metadata.Name}
}
}
}
for host, rs := range hostRoutes {
if len(rs) == 0 {
continue
}
applyEastWestRange(ing.eastWestRangeDomains, ing.eastWestRangePredicates, host, rs)
routes = append(routes, rs...)
if !ing.disableCatchAllRoutes {
// if routes were configured, but there is no catchall route
// defined for the host name, create a route which returns 404
if !hasCatchAllRoutes(rs) {
routes = append(routes, ing.addCatchAllRoutes(host, rs[0], redirect)...)
}
}
}
if ing.kubernetesEnableEastWest && len(routes) > 0 && len(ewIngInfo) > 0 {
ewroutes := make([]*eskip.Route, 0, len(routes))
for _, r := range routes {
if v, ok := ewIngInfo[r.Id]; ok {
ewroutes = append(ewroutes, createEastWestRouteIng(ing.kubernetesEastWestDomain, v[0], v[1], r))
}
}
l := len(routes)
routes = append(routes, ewroutes...)
log.Infof("Enabled east west routes: %d %d %d %d", l, len(routes), len(ewroutes), len(hostRoutes))
}
return routes, nil
}
func generateTLSCertFromSecret(secret *secret) (*tls.Certificate, error) {
if secret.Data[tlsSecretDataCrt] == "" || secret.Data[tlsSecretDataKey] == "" {
return nil, fmt.Errorf("secret must contain %s and %s in data field", tlsSecretDataCrt, tlsSecretDataKey)
}
crt, err := b64.StdEncoding.DecodeString(secret.Data[tlsSecretDataCrt])
if err != nil {
return nil, fmt.Errorf("failed to decode %s from secret %s", tlsSecretDataCrt, secret.Metadata.Name)
}
key, err := b64.StdEncoding.DecodeString(secret.Data[tlsSecretDataKey])
if err != nil {
return nil, fmt.Errorf("failed to decode %s from secret %s", tlsSecretDataKey, secret.Metadata.Name)
}
cert, err := tls.X509KeyPair([]byte(crt), []byte(key))
if err != nil {
return nil, fmt.Errorf("failed to create tls certificate from secret %s", secret.Metadata.Name)
}
if secret.Type != tlsSecretType {
return nil, fmt.Errorf("secret %s is not of type %s", secret.Metadata.Name, tlsSecretType)
}
return &cert, nil
}