/
cache_response.go
305 lines (278 loc) · 9.4 KB
/
cache_response.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
// Copyright 2019 The Operator-SDK 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 proxy
import (
"bytes"
"context"
"encoding/json"
"fmt"
"net/http"
"regexp"
"strings"
libhandler "github.com/operator-framework/operator-lib/handler"
"k8s.io/apimachinery/pkg/api/meta"
metainternalscheme "k8s.io/apimachinery/pkg/apis/meta/internalversion/scheme"
metav1 "k8s.io/apimachinery/pkg/apis/meta/v1"
"k8s.io/apimachinery/pkg/apis/meta/v1/unstructured"
"k8s.io/apimachinery/pkg/fields"
"k8s.io/apimachinery/pkg/labels"
"k8s.io/apimachinery/pkg/runtime/schema"
"k8s.io/apimachinery/pkg/util/sets"
"sigs.k8s.io/controller-runtime/pkg/cache"
"sigs.k8s.io/controller-runtime/pkg/client"
"github.com/operator-framework/operator-sdk/internal/ansible/proxy/controllermap"
k8sRequest "github.com/operator-framework/operator-sdk/internal/ansible/proxy/requestfactory"
)
type marshaler interface {
MarshalJSON() ([]byte, error)
}
type cacheResponseHandler struct {
next http.Handler
informerCache cache.Cache
restMapper meta.RESTMapper
watchedNamespaces map[string]interface{}
cMap *controllermap.ControllerMap
injectOwnerRef bool
apiResources *apiResources
skipPathRegexp []*regexp.Regexp
}
func (c *cacheResponseHandler) ServeHTTP(w http.ResponseWriter, req *http.Request) {
switch req.Method {
case http.MethodGet:
// GET request means we need to check the cache
rf := k8sRequest.RequestInfoFactory{APIPrefixes: sets.NewString("api", "apis"),
GrouplessAPIPrefixes: sets.NewString("api")}
r, err := rf.NewRequestInfo(req)
if err != nil {
log.Error(err, "Failed to convert request")
break
}
// Skip cache for non-cacheable requests, not a part of skipCacheLookup for performance.
if !r.IsResourceRequest || !(r.Subresource == "" || r.Subresource == "status") {
log.V(2).Info("Skipping cache lookup", "resource", r)
break
}
if c.restMapper == nil {
c.restMapper = meta.NewDefaultRESTMapper([]schema.GroupVersion{schema.GroupVersion{
Group: r.APIGroup,
Version: r.APIVersion,
}})
}
k, err := getGVKFromRequestInfo(r, c.restMapper)
if err != nil {
// break here in case resource doesn't exist in cache
log.Error(err, "Cache miss, can not find in rest mapper")
break
}
if c.skipCacheLookup(r, k, req) {
log.V(2).Info("Skipping cache lookup", "resource", r)
break
}
// Determine if the resource is virtual. If it is then we should not attempt to use cache
isVR, err := c.apiResources.IsVirtualResource(k)
if err != nil {
// break here in case we can not understand if virtual resource or not
log.Error(err, "Unable to determine if virtual resource", "gvk", k)
break
}
if isVR {
log.V(2).Info("Virtual resource, must ask the cluster API", "gvk", k)
break
}
var m marshaler
log.V(2).Info("Get resource in our cache", "r", r)
if r.Verb == "list" {
m, err = c.getListFromCache(r, req, k)
if err != nil {
break
}
} else {
m, err = c.getObjectFromCache(r, req, k)
if err != nil {
break
}
}
i := bytes.Buffer{}
resp, err := m.MarshalJSON()
if err != nil {
// return will give a 500
log.Error(err, "Failed to marshal data")
http.Error(w, "", http.StatusInternalServerError)
return
}
// Set Content-Type header
w.Header().Set("Content-Type", "application/json")
// Set X-Cache header to signal that response is served from Cache
w.Header().Set("X-Cache", "HIT")
if err := json.Indent(&i, resp, "", " "); err != nil {
log.Error(err, "Failed to indent json")
}
_, err = w.Write(i.Bytes())
if err != nil {
log.Error(err, "Failed to write response")
http.Error(w, "", http.StatusInternalServerError)
return
}
// Return so that request isn't passed along to APIserver
log.Info("Read object from cache", "resource", r)
return
}
c.next.ServeHTTP(w, req)
}
// skipCacheLookup - determine if we should skip the cache lookup
func (c *cacheResponseHandler) skipCacheLookup(r *k8sRequest.RequestInfo, gvk schema.GroupVersionKind,
req *http.Request) bool {
skip := matchesRegexp(req.URL.String(), c.skipPathRegexp)
if skip {
return true
}
owner, err := getRequestOwnerRef(req)
if err != nil {
log.Error(err, "Could not get owner reference from proxy.")
return false
}
if owner != nil {
ownerGV, err := schema.ParseGroupVersion(owner.APIVersion)
if err != nil {
m := fmt.Sprintf("Could not get group version for: %v.", owner)
log.Error(err, m)
return false
}
ownerGVK := schema.GroupVersionKind{
Group: ownerGV.Group,
Version: ownerGV.Version,
Kind: owner.Kind,
}
relatedController, ok := c.cMap.Get(ownerGVK)
if !ok {
log.Info("Could not find controller for gvk.", "ownerGVK:", ownerGVK)
return false
}
if relatedController.Blacklist[gvk] {
log.Info("Skipping, because gvk is blacklisted", "GVK", gvk)
return true
}
}
// check if resource doesn't exist in watched namespaces
// if watchedNamespaces[""] exists then we are watching all namespaces
// and want to continue
_, allNsPresent := c.watchedNamespaces[metav1.NamespaceAll]
_, reqNsPresent := c.watchedNamespaces[r.Namespace]
if !allNsPresent && !reqNsPresent {
return true
}
if strings.HasPrefix(r.Path, "/version") {
// Temporarily pass along to API server
// Ideally we cache this response as well
return true
}
return false
}
func (c *cacheResponseHandler) recoverDependentWatches(req *http.Request, un *unstructured.Unstructured) {
ownerRef, err := getRequestOwnerRef(req)
if err != nil {
log.Error(err, "Could not get ownerRef from proxy")
return
}
// This happens when a request unrelated to reconciliation hits the proxy
if ownerRef == nil {
return
}
for _, oRef := range un.GetOwnerReferences() {
if oRef.APIVersion == ownerRef.APIVersion && oRef.Kind == ownerRef.Kind {
err := addWatchToController(*ownerRef, c.cMap, un, c.restMapper, true)
if err != nil {
log.Error(err, "Could not recover dependent resource watch", "owner", ownerRef)
return
}
}
}
if typeString, ok := un.GetAnnotations()[libhandler.TypeAnnotation]; ok {
ownerGV, err := schema.ParseGroupVersion(ownerRef.APIVersion)
if err != nil {
m := fmt.Sprintf("could not get group version for: %v", ownerGV)
log.Error(err, m)
return
}
if typeString == fmt.Sprintf("%v.%v", ownerRef.Kind, ownerGV.Group) {
err := addWatchToController(*ownerRef, c.cMap, un, c.restMapper, false)
if err != nil {
log.Error(err, "Could not recover dependent resource watch", "owner", ownerRef)
return
}
}
}
}
func (c *cacheResponseHandler) getListFromCache(r *k8sRequest.RequestInfo, req *http.Request,
k schema.GroupVersionKind) (marshaler, error) {
k8sListOpts := &metav1.ListOptions{}
if err := metainternalscheme.ParameterCodec.DecodeParameters(req.URL.Query(), metav1.SchemeGroupVersion,
k8sListOpts); err != nil {
log.Error(err, "Unable to decode list options from request")
return nil, err
}
clientListOpts := []client.ListOption{
client.InNamespace(r.Namespace),
}
if k8sListOpts.LabelSelector != "" {
sel, err := labels.ConvertSelectorToLabelsMap(k8sListOpts.LabelSelector)
if err != nil {
log.Error(err, "Unable to convert label selectors for the client")
return nil, err
}
clientListOpts = append(clientListOpts, client.MatchingLabels(sel))
}
if k8sListOpts.FieldSelector != "" {
sel, err := fields.ParseSelector(k8sListOpts.FieldSelector)
if err != nil {
log.Error(err, "Unable to parse field selectors for the client")
return nil, err
}
clientListOpts = append(clientListOpts, client.MatchingFieldsSelector{Selector: sel})
}
k.Kind = k.Kind + "List"
un := unstructured.UnstructuredList{}
un.SetGroupVersionKind(k)
ctx, cancel := context.WithTimeout(context.Background(), cacheEstablishmentTimeout)
defer cancel()
err := c.informerCache.List(ctx, &un, clientListOpts...)
if err != nil {
// break here in case resource doesn't exist in cache but exists on APIserver
// This is very unlikely but provides user with expected 404
log.Info(fmt.Sprintf("cache miss: %v err-%v", k, err))
return nil, err
}
return &un, nil
}
func (c *cacheResponseHandler) getObjectFromCache(r *k8sRequest.RequestInfo, req *http.Request,
k schema.GroupVersionKind) (marshaler, error) {
un := &unstructured.Unstructured{}
un.SetGroupVersionKind(k)
obj := client.ObjectKey{Namespace: r.Namespace, Name: r.Name}
ctx, cancel := context.WithTimeout(context.Background(), cacheEstablishmentTimeout)
defer cancel()
err := c.informerCache.Get(ctx, obj, un)
if err != nil {
// break here in case resource doesn't exist in cache but exists on APIserver
// This is very unlikely but provides user with expected 404
log.Info(fmt.Sprintf("Cache miss: %v, %v", k, obj))
return nil, err
}
// Once we get the resource, we are going to attempt to recover the dependent watches here,
// This will happen in the background, and log errors.
if c.injectOwnerRef {
go c.recoverDependentWatches(req, un)
}
return un, nil
}