-
Notifications
You must be signed in to change notification settings - Fork 667
/
status.go
194 lines (165 loc) · 5.62 KB
/
status.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
// Copyright Project Contour 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 k8s
import (
"context"
"fmt"
"github.com/sirupsen/logrus"
metav1 "k8s.io/apimachinery/pkg/apis/meta/v1"
"k8s.io/apimachinery/pkg/runtime/schema"
"k8s.io/apimachinery/pkg/types"
"k8s.io/client-go/util/retry"
"sigs.k8s.io/controller-runtime/pkg/client"
)
// StatusUpdate contains an all the information needed to change an object's status to perform a specific update.
// Send down a channel to the goroutine that actually writes the changes back.
type StatusUpdate struct {
NamespacedName types.NamespacedName
Resource schema.GroupVersionResource
Mutator StatusMutator
}
func NewStatusUpdate(name, namespace string, gvr schema.GroupVersionResource, mutator StatusMutator) StatusUpdate {
return StatusUpdate{
NamespacedName: types.NamespacedName{
Name: name,
Namespace: namespace,
},
Resource: gvr,
Mutator: mutator,
}
}
// StatusMutator is an interface to hold mutator functions for status updates.
type StatusMutator interface {
Mutate(obj interface{}) interface{}
}
// StatusMutatorFunc is a function adaptor for StatusMutators.
type StatusMutatorFunc func(interface{}) interface{}
// Mutate adapts the StatusMutatorFunc to fit through the StatusMutator interface.
func (m StatusMutatorFunc) Mutate(old interface{}) interface{} {
if m == nil {
return nil
}
return m(old)
}
// StatusUpdateHandler holds the details required to actually write an Update back to the referenced object.
type StatusUpdateHandler struct {
Log logrus.FieldLogger
Clients *Clients
UpdateChannel chan StatusUpdate
LeaderElected chan struct{}
IsLeader bool
Converter *UnstructuredConverter
}
func (suh *StatusUpdateHandler) apply(upd StatusUpdate) {
gvk, err := suh.Clients.KindFor(upd.Resource)
if err != nil {
suh.Log.WithError(err).
WithField("name", upd.NamespacedName.Name).
WithField("namespace", upd.NamespacedName.Namespace).
WithField("resource", upd.Resource).
Error("failed to map Resource to Kind ")
return
}
tmpl, err := suh.Converter.scheme.New(gvk)
if err != nil {
suh.Log.WithError(err).
WithField("name", upd.NamespacedName.Name).
WithField("namespace", upd.NamespacedName.Namespace).
WithField("kind", gvk).
Error("failed to allocate template object")
return
}
obj, ok := tmpl.(client.Object)
if !ok {
suh.Log.
WithField("name", upd.NamespacedName.Name).
WithField("namespace", upd.NamespacedName.Namespace).
WithField("kind", gvk).
Error("failed to type-assert to client.Object")
return
}
if err := retry.RetryOnConflict(retry.DefaultBackoff, func() error {
// Fetch the lister cache for the informer associated with this resource.
if err := suh.Clients.Cache().Get(context.Background(), upd.NamespacedName, obj); err != nil {
return err
}
newObj := upd.Mutator.Mutate(obj)
if isStatusEqual(obj, newObj) {
suh.Log.WithField("name", upd.NamespacedName.Name).
WithField("namespace", upd.NamespacedName.Namespace).
Debug("update was a no-op")
return nil
}
usNewObj, err := suh.Converter.ToUnstructured(newObj)
if err != nil {
return fmt.Errorf("unable to convert object: %w", err)
}
_, err = suh.Clients.DynamicClient().
Resource(upd.Resource).
Namespace(upd.NamespacedName.Namespace).
UpdateStatus(context.Background(), usNewObj, metav1.UpdateOptions{})
return err
}); err != nil {
suh.Log.WithError(err).
WithField("name", upd.NamespacedName.Name).
WithField("namespace", upd.NamespacedName.Namespace).
Error("unable to update status")
}
}
// Start runs the goroutine to perform status writes.
// Until the Contour is elected leader, will drop updates on the floor.
func (suh *StatusUpdateHandler) Start(stop <-chan struct{}) error {
for {
select {
case <-stop:
return nil
case <-suh.LeaderElected:
suh.Log.Info("elected leader")
suh.IsLeader = true
// disable this case
suh.LeaderElected = nil
case upd := <-suh.UpdateChannel:
if !suh.IsLeader {
suh.Log.WithField("name", upd.NamespacedName.Name).
WithField("namespace", upd.NamespacedName.Namespace).
Debug("not leader, not applying update")
continue
}
suh.Log.WithField("name", upd.NamespacedName.Name).
WithField("namespace", upd.NamespacedName.Namespace).
Debug("received a status update")
suh.apply(upd)
}
}
}
// Writer retrieves the interface that should be used to write to the StatusUpdateHandler.
func (suh *StatusUpdateHandler) Writer() StatusUpdater {
if suh.UpdateChannel == nil {
suh.UpdateChannel = make(chan StatusUpdate, 100)
}
return &StatusUpdateWriter{
UpdateChannel: suh.UpdateChannel,
}
}
// StatusUpdater describes an interface to send status updates somewhere.
type StatusUpdater interface {
Send(su StatusUpdate)
}
// StatusUpdateWriter takes status updates and sends these to the StatusUpdateHandler via a channel.
type StatusUpdateWriter struct {
UpdateChannel chan StatusUpdate
}
// Send sends the given StatusUpdate off to the update channel for writing by the StatusUpdateHandler.
func (suw *StatusUpdateWriter) Send(update StatusUpdate) {
suw.UpdateChannel <- update
}