-
Notifications
You must be signed in to change notification settings - Fork 24
/
store.go
435 lines (372 loc) · 13.4 KB
/
store.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
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
/*
Copyright 2017 The Kubernetes Authors.
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 store
import (
"fmt"
"sort"
"strings"
ingressv1alpha1 "github.com/ngrok/ngrok-operator/api/ingress/v1alpha1"
ngrokv1alpha1 "github.com/ngrok/ngrok-operator/api/ngrok/v1alpha1"
"github.com/ngrok/ngrok-operator/internal/errors"
corev1 "k8s.io/api/core/v1"
netv1 "k8s.io/api/networking/v1"
"k8s.io/apimachinery/pkg/runtime"
gatewayv1 "sigs.k8s.io/gateway-api/apis/v1"
"github.com/go-logr/logr"
)
// Storer is the interface that wraps the required methods to gather information
// about ingresses, services, secrets and ingress annotations.
// It exposes methods to list both all and filtered resources
type Storer interface {
Get(obj runtime.Object) (item interface{}, exists bool, err error)
Add(runtime.Object) error
Update(runtime.Object) error
Delete(runtime.Object) error
GetIngressClassV1(name string) (*netv1.IngressClass, error)
GetIngressV1(name, namespace string) (*netv1.Ingress, error)
GetServiceV1(name, namespace string) (*corev1.Service, error)
GetNgrokIngressV1(name, namespace string) (*netv1.Ingress, error)
GetNgrokModuleSetV1(name, namespace string) (*ingressv1alpha1.NgrokModuleSet, error)
GetNgrokTrafficPolicyV1(name, namespace string) (*ngrokv1alpha1.NgrokTrafficPolicy, error)
GetGateway(name string, namespace string) (*gatewayv1.Gateway, error)
GetHTTPRoute(name string, namespace string) (*gatewayv1.HTTPRoute, error)
ListIngressClassesV1() []*netv1.IngressClass
ListNgrokIngressClassesV1() []*netv1.IngressClass
ListIngressesV1() []*netv1.Ingress
ListNgrokIngressesV1() []*netv1.Ingress
ListGateways() []*gatewayv1.Gateway
ListHTTPRoutes() []*gatewayv1.HTTPRoute
ListDomainsV1() []*ingressv1alpha1.Domain
ListTunnelsV1() []*ingressv1alpha1.Tunnel
ListHTTPSEdgesV1() []*ingressv1alpha1.HTTPSEdge
ListNgrokModuleSetsV1() []*ingressv1alpha1.NgrokModuleSet
}
// Store implements Storer and can be used to list Ingress, Services
// and other resources from k8s APIserver. The backing stores should
// be synced and updated by the caller.
// It is ingressClass filter aware.
type Store struct {
stores CacheStores
controllerName string
log logr.Logger
}
var _ Storer = Store{}
// New creates a new object store to be used in the ingress controller.
func New(cs CacheStores, controllerName string, logger logr.Logger) Storer {
return Store{
stores: cs,
controllerName: controllerName,
log: logger,
}
}
// Get proxies the call to the underlying store.
func (s Store) Get(obj runtime.Object) (interface{}, bool, error) {
return s.stores.Get(obj)
}
// Add proxies the call to the underlying store.
func (s Store) Add(obj runtime.Object) error {
return s.stores.Add(obj.DeepCopyObject())
}
// Update proxies the call to the underlying store.
// An add for an object with the same key thats already present is just an update
func (s Store) Update(obj runtime.Object) error {
return s.stores.Add(obj.DeepCopyObject())
}
// Delete proxies the call to the underlying store.
func (s Store) Delete(obj runtime.Object) error {
return s.stores.Delete(obj)
}
// GetIngressClassV1 returns the 'name' IngressClass resource.
func (s Store) GetIngressClassV1(name string) (*netv1.IngressClass, error) {
p, exists, err := s.stores.IngressClassV1.GetByKey(name)
if err != nil {
return nil, err
}
if !exists {
return nil, errors.NewErrorNotFound(fmt.Sprintf("IngressClass %v not found", name))
}
return p.(*netv1.IngressClass), nil
}
// GetIngressV1 returns the 'name' Ingress resource.
func (s Store) GetIngressV1(name, namespcae string) (*netv1.Ingress, error) {
p, exists, err := s.stores.IngressV1.GetByKey(getKey(name, namespcae))
if err != nil {
return nil, err
}
if !exists {
return nil, errors.NewErrorNotFound(fmt.Sprintf("Ingress %v not found", name))
}
return p.(*netv1.Ingress), nil
}
func (s Store) GetServiceV1(name, namespace string) (*corev1.Service, error) {
p, exists, err := s.stores.ServiceV1.GetByKey(getKey(name, namespace))
if err != nil {
return nil, err
}
if !exists {
return nil, errors.NewErrorNotFound(fmt.Sprintf("Service %v not found", name))
}
return p.(*corev1.Service), nil
}
// GetNgrokIngressV1 looks up the Ingress resource by name and namespace and returns it if it's found
func (s Store) GetNgrokIngressV1(name, namespace string) (*netv1.Ingress, error) {
ing, err := s.GetIngressV1(name, namespace)
if err != nil {
return nil, err
}
ok, err := s.shouldHandleIngress(ing)
if !ok || err != nil {
return nil, err
}
return ing, nil
}
func (s Store) GetNgrokModuleSetV1(name, namespace string) (*ingressv1alpha1.NgrokModuleSet, error) {
p, exists, err := s.stores.NgrokModuleV1.GetByKey(getKey(name, namespace))
if err != nil {
return nil, err
}
if !exists {
return nil, errors.NewErrorNotFound(fmt.Sprintf("NgrokModuleSet %v not found", name))
}
return p.(*ingressv1alpha1.NgrokModuleSet), nil
}
func (s Store) GetNgrokTrafficPolicyV1(name, namespace string) (*ngrokv1alpha1.NgrokTrafficPolicy, error) {
p, exists, err := s.stores.NgrokTrafficPolicyV1.GetByKey(getKey(name, namespace))
if err != nil {
return nil, err
}
if !exists {
return nil, errors.NewErrorNotFound(fmt.Sprintf("NgrokTrafficPolicy %v not found", name))
}
return p.(*ngrokv1alpha1.NgrokTrafficPolicy), nil
}
func (s Store) GetGateway(name string, namespace string) (*gatewayv1.Gateway, error) {
gtw, exists, err := s.stores.Gateway.GetByKey(getKey(name, namespace))
if err != nil {
return nil, err
}
if !exists {
return nil, errors.NewErrorNotFound(fmt.Sprintf("Gateway %v not found", name))
}
return gtw.(*gatewayv1.Gateway), nil
}
func (s Store) GetHTTPRoute(name string, namespace string) (*gatewayv1.HTTPRoute, error) {
obj, exists, err := s.stores.HTTPRoute.GetByKey(getKey(name, namespace))
if err != nil {
return nil, err
}
if !exists {
return nil, errors.NewErrorNotFound(fmt.Sprintf("HTTPRoute %v not found", name))
}
return obj.(*gatewayv1.HTTPRoute), nil
}
// ListIngressClassesV1 returns the list of Ingresses in the Ingress v1 store.
func (s Store) ListIngressClassesV1() []*netv1.IngressClass {
// filter ingress rules
var classes []*netv1.IngressClass
for _, item := range s.stores.IngressClassV1.List() {
class, ok := item.(*netv1.IngressClass)
if !ok {
s.log.Info("listIngressClassesV1: dropping object of unexpected type: %#v", item)
continue
}
classes = append(classes, class)
}
sort.SliceStable(classes, func(i, j int) bool {
return strings.Compare(classes[i].Name, classes[j].Name) < 0
})
return classes
}
// ListNgrokIngressClassesV1 returns the list of Ingresses in the Ingress v1 store filtered
// by ones that match the controllerName
func (s Store) ListNgrokIngressClassesV1() []*netv1.IngressClass {
filteredClasses := []*netv1.IngressClass{}
classes := s.ListIngressClassesV1()
for _, class := range classes {
if class.Spec.Controller == s.controllerName {
filteredClasses = append(filteredClasses, class)
}
}
return filteredClasses
}
// ListIngressesV1 returns the list of Ingresses in the Ingress v1 store.
func (s Store) ListIngressesV1() []*netv1.Ingress {
// filter ingress rules
var ingresses []*netv1.Ingress
for _, item := range s.stores.IngressV1.List() {
ing, ok := item.(*netv1.Ingress)
if !ok {
s.log.Error(nil, "listIngressesV1: dropping object of unexpected type", "type", fmt.Sprintf("%v", item))
continue
}
ingresses = append(ingresses, ing)
}
sort.SliceStable(ingresses, func(i, j int) bool {
return strings.Compare(fmt.Sprintf("%s/%s", ingresses[i].Namespace, ingresses[i].Name),
fmt.Sprintf("%s/%s", ingresses[j].Namespace, ingresses[j].Name)) < 0
})
return ingresses
}
func (s Store) ListGateways() []*gatewayv1.Gateway {
var gateways []*gatewayv1.Gateway
for _, item := range s.stores.Gateway.List() {
gtw, ok := item.(*gatewayv1.Gateway)
if !ok {
s.log.Error(nil, "Gateway: dropping object of unexpected type", "type", fmt.Sprintf("%#v", item))
continue
}
gateways = append(gateways, gtw)
}
sort.SliceStable(gateways, func(i, j int) bool {
return strings.Compare(fmt.Sprintf("%s/%s", gateways[i].Namespace, gateways[i].Name),
fmt.Sprintf("%s/%s", gateways[j].Namespace, gateways[j].Name)) < 0
})
return gateways
}
func (s Store) ListHTTPRoutes() []*gatewayv1.HTTPRoute {
var httproutes []*gatewayv1.HTTPRoute
for _, item := range s.stores.HTTPRoute.List() {
httproute, ok := item.(*gatewayv1.HTTPRoute)
if !ok {
s.log.Error(nil, "HTTPRoute: dropping object of unexpected type", "type", fmt.Sprintf("%#v", item))
continue
}
httproutes = append(httproutes, httproute)
}
return httproutes
}
func (s Store) ListNgrokIngressesV1() []*netv1.Ingress {
ings := s.ListIngressesV1()
var ingresses []*netv1.Ingress
for _, ing := range ings {
ok, err := s.shouldHandleIngress(ing)
if ok && err == nil {
ingresses = append(ingresses, ing)
}
}
return ingresses
}
// ListDomainsV1 returns the list of Domains in the Domain v1 store.
func (s Store) ListDomainsV1() []*ingressv1alpha1.Domain {
// filter ingress rules
var domains []*ingressv1alpha1.Domain
for _, item := range s.stores.DomainV1.List() {
domain, ok := item.(*ingressv1alpha1.Domain)
if !ok {
s.log.Info("listDomainsV1: dropping object of unexpected type: %#v", item)
continue
}
domains = append(domains, domain)
}
sort.SliceStable(domains, func(i, j int) bool {
return strings.Compare(fmt.Sprintf("%s/%s", domains[i].Namespace, domains[i].Name),
fmt.Sprintf("%s/%s", domains[j].Namespace, domains[j].Name)) < 0
})
return domains
}
// ListTunnelsV1 returns the list of Tunnels in the Tunnel v1 store.
func (s Store) ListTunnelsV1() []*ingressv1alpha1.Tunnel {
var tunnels []*ingressv1alpha1.Tunnel
for _, item := range s.stores.TunnelV1.List() {
tunnel, ok := item.(*ingressv1alpha1.Tunnel)
if !ok {
s.log.Info("listTunnelsV1: dropping object of unexpected type: %#v", item)
continue
}
tunnels = append(tunnels, tunnel)
}
sort.SliceStable(tunnels, func(i, j int) bool {
return strings.Compare(fmt.Sprintf("%s/%s", tunnels[i].Namespace, tunnels[i].Name),
fmt.Sprintf("%s/%s", tunnels[j].Namespace, tunnels[j].Name)) < 0
})
return tunnels
}
// ListHTTPSEdgesV1 returns the list of HTTPSEdges in the HTTPSEdge v1 store.
func (s Store) ListHTTPSEdgesV1() []*ingressv1alpha1.HTTPSEdge {
var edges []*ingressv1alpha1.HTTPSEdge
for _, item := range s.stores.HTTPSEdgeV1.List() {
edge, ok := item.(*ingressv1alpha1.HTTPSEdge)
if !ok {
s.log.Info("listHTTPSEdgesV1: dropping object of unexpected type: %#v", item)
continue
}
edges = append(edges, edge)
}
sort.SliceStable(edges, func(i, j int) bool {
return strings.Compare(fmt.Sprintf("%s/%s", edges[i].Namespace, edges[i].Name),
fmt.Sprintf("%s/%s", edges[j].Namespace, edges[j].Name)) < 0
})
return edges
}
// ListNgrokModuleSetsV1 returns the list of NgrokModules in the NgrokModuleSet v1 store.
func (s Store) ListNgrokModuleSetsV1() []*ingressv1alpha1.NgrokModuleSet {
var modules []*ingressv1alpha1.NgrokModuleSet
for _, item := range s.stores.NgrokModuleV1.List() {
module, ok := item.(*ingressv1alpha1.NgrokModuleSet)
if !ok {
s.log.Info("listNgrokModulesV1: dropping object of unexpected type: %#v", item)
continue
}
modules = append(modules, module)
}
sort.SliceStable(modules, func(i, j int) bool {
return strings.Compare(fmt.Sprintf("%s/%s", modules[i].Namespace, modules[i].Name),
fmt.Sprintf("%s/%s", modules[j].Namespace, modules[j].Name)) < 0
})
return modules
}
func (s Store) shouldHandleIngress(ing *netv1.Ingress) (bool, error) {
ok, err := s.shouldHandleIngressIsValid(ing)
if err != nil {
return ok, err
}
return s.shouldHandleIngressCheckClass(ing)
}
// shouldHandleIngressCheckClass checks if the ingress should be handled by the controller based on the ingress class
func (s Store) shouldHandleIngressCheckClass(ing *netv1.Ingress) (bool, error) {
ngrokClasses := s.ListNgrokIngressClassesV1()
if ing.Spec.IngressClassName != nil {
for _, class := range ngrokClasses {
if *ing.Spec.IngressClassName == class.Name {
return true, nil
}
}
} else {
for _, class := range ngrokClasses {
if class.Annotations["ingressclass.kubernetes.io/is-default-class"] == "true" {
return true, nil
}
}
}
return false, errors.NewErrDifferentIngressClass(s.ListNgrokIngressClassesV1(), ing.Spec.IngressClassName)
}
// shouldHandleIngressIsValid checks if the ingress should be handled by the controller based on the ingress spec
func (s Store) shouldHandleIngressIsValid(ing *netv1.Ingress) (bool, error) {
errs := errors.NewErrInvalidIngressSpec()
if len(ing.Spec.Rules) == 0 {
errs.AddError("At least one rule is required to be set")
} else {
if ing.Spec.Rules[0].Host == "" {
errs.AddError("A host is required to be set")
}
for _, path := range ing.Spec.Rules[0].HTTP.Paths {
if path.Backend.Resource != nil {
errs.AddError("Resource backends are not supported")
}
}
}
if errs.HasErrors() {
return false, errs
}
return true, nil
}