-
Notifications
You must be signed in to change notification settings - Fork 1.8k
/
dapr_handler.go
363 lines (318 loc) · 10.4 KB
/
dapr_handler.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
package handlers
import (
"context"
"strconv"
"github.com/argoproj/argo-rollouts/pkg/apis/rollouts"
argov1alpha1 "github.com/argoproj/argo-rollouts/pkg/apis/rollouts/v1alpha1"
appsv1 "k8s.io/api/apps/v1"
corev1 "k8s.io/api/core/v1"
apierrors "k8s.io/apimachinery/pkg/api/errors"
metaV1 "k8s.io/apimachinery/pkg/apis/meta/v1"
"k8s.io/apimachinery/pkg/runtime"
"k8s.io/apimachinery/pkg/types"
"k8s.io/apimachinery/pkg/util/intstr"
ctrl "sigs.k8s.io/controller-runtime"
"sigs.k8s.io/controller-runtime/pkg/client"
"sigs.k8s.io/controller-runtime/pkg/controller"
"github.com/dapr/dapr/pkg/injector/annotations"
"github.com/dapr/dapr/pkg/operator/meta"
"github.com/dapr/dapr/pkg/operator/monitoring"
"github.com/dapr/dapr/pkg/validation"
"github.com/dapr/dapr/utils"
"github.com/dapr/kit/logger"
)
const (
daprSidecarHTTPPortName = "dapr-http"
daprSidecarAPIGRPCPortName = "dapr-grpc"
daprSidecarInternalGRPCPortName = "dapr-internal"
daprSidecarMetricsPortName = "dapr-metrics"
daprSidecarHTTPPort = 3500
daprSidecarAPIGRPCPort = 50001
daprSidecarInternalGRPCPort = 50002
defaultMetricsEnabled = true
defaultMetricsPort = 9090
clusterIPNone = "None"
daprServiceOwnerField = ".metadata.controller"
annotationPrometheusProbe = "prometheus.io/probe"
annotationPrometheusScrape = "prometheus.io/scrape"
annotationPrometheusPort = "prometheus.io/port"
annotationPrometheusPath = "prometheus.io/path"
)
var log = logger.NewLogger("dapr.operator.handlers")
var defaultOptions = &Options{
ArgoRolloutServiceReconcilerEnabled: false,
}
type Options struct {
ArgoRolloutServiceReconcilerEnabled bool
}
// DaprHandler handles the lifetime for Dapr CRDs.
type DaprHandler struct {
mgr ctrl.Manager
client.Client
Scheme *runtime.Scheme
argoRolloutServiceReconcilerEnabled bool
}
type Reconciler struct {
*DaprHandler
newWrapper func() ObjectWrapper
}
// NewDaprHandler returns a new Dapr handler.
// This is a reconciler that watches all Deployment and StatefulSet resources and ensures that a matching Service resource is deployed to allow Dapr sidecar-to-sidecar communication and access to other ports.
func NewDaprHandler(mgr ctrl.Manager) *DaprHandler {
return NewDaprHandlerWithOptions(mgr, defaultOptions)
}
// NewDaprHandlerWithOptions returns a new Dapr handler with options.
func NewDaprHandlerWithOptions(mgr ctrl.Manager, opts *Options) *DaprHandler {
return &DaprHandler{
mgr: mgr,
Client: mgr.GetClient(),
Scheme: mgr.GetScheme(),
argoRolloutServiceReconcilerEnabled: opts.ArgoRolloutServiceReconcilerEnabled,
}
}
// Init allows for various startup tasks.
func (h *DaprHandler) Init(ctx context.Context) error {
err := h.mgr.GetFieldIndexer().IndexField(
ctx,
&corev1.Service{},
daprServiceOwnerField,
func(rawObj client.Object) []string {
svc := rawObj.(*corev1.Service)
owner := metaV1.GetControllerOf(svc)
if h.isReconciled(owner) {
return []string{owner.Name}
}
return nil
},
)
if err != nil {
return err
}
err = ctrl.NewControllerManagedBy(h.mgr).
For(&appsv1.Deployment{}).
Owns(&corev1.Service{}).
WithOptions(controller.Options{
MaxConcurrentReconciles: 100,
}).
Complete(&Reconciler{
DaprHandler: h,
newWrapper: func() ObjectWrapper {
return &DeploymentWrapper{}
},
})
if err != nil {
return err
}
err = ctrl.NewControllerManagedBy(h.mgr).
For(&appsv1.StatefulSet{}).
Owns(&corev1.Service{}).
WithOptions(controller.Options{
MaxConcurrentReconciles: 100,
}).
Complete(&Reconciler{
DaprHandler: h,
newWrapper: func() ObjectWrapper {
return &StatefulSetWrapper{}
},
})
if err != nil {
return err
}
if h.argoRolloutServiceReconcilerEnabled {
err = ctrl.NewControllerManagedBy(h.mgr).
For(&argov1alpha1.Rollout{}).
Owns(&corev1.Service{}).
WithOptions(controller.Options{
MaxConcurrentReconciles: 100,
}).
Complete(&Reconciler{
DaprHandler: h,
newWrapper: func() ObjectWrapper {
return &RolloutWrapper{}
},
})
if err != nil {
return err
}
}
return nil
}
func (h *DaprHandler) daprServiceName(appID string) string {
return appID + "-dapr"
}
// Reconcile the expected services for Deployment and StatefulSet resources annotated for Dapr.
func (r *Reconciler) Reconcile(ctx context.Context, req ctrl.Request) (ctrl.Result, error) {
// var wrapper appsv1.Deployment | appsv1.StatefulSet
wrapper := r.newWrapper()
expectedService := false
err := r.Get(ctx, req.NamespacedName, wrapper.GetObject())
if err != nil {
if apierrors.IsNotFound(err) {
log.Debugf("deployment has be deleted, %s", req.NamespacedName)
} else {
log.Errorf("unable to get deployment, %s, err: %s", req.NamespacedName, err)
return ctrl.Result{}, err
}
} else {
if wrapper.GetObject().GetDeletionTimestamp() != nil {
log.Debugf("deployment is being deleted, %s", req.NamespacedName)
return ctrl.Result{}, nil
}
expectedService = r.isAnnotatedForDapr(wrapper)
}
if expectedService {
err := r.ensureDaprServicePresent(ctx, req.Namespace, wrapper)
if err != nil {
log.Errorf("failed to ensure dapr service present, err: %v", err)
return ctrl.Result{Requeue: true}, err
}
}
return ctrl.Result{}, nil
}
func (h *DaprHandler) ensureDaprServicePresent(ctx context.Context, namespace string, wrapper ObjectWrapper) error {
appID := h.getAppID(wrapper)
err := validation.ValidateKubernetesAppID(appID)
if err != nil {
return err
}
daprSvcName := types.NamespacedName{
Namespace: namespace,
Name: h.daprServiceName(appID),
}
var daprSvc corev1.Service
err = h.Get(ctx, daprSvcName, &daprSvc)
if err != nil {
if apierrors.IsNotFound(err) {
log.Debugf("no service for wrapper found, wrapper: %s/%s", namespace, daprSvcName.Name)
return h.createDaprService(ctx, daprSvcName, wrapper)
}
log.Errorf("unable to get service, %s, err: %s", daprSvcName, err)
return err
}
err = h.patchDaprService(ctx, daprSvcName, wrapper, daprSvc)
if err != nil {
log.Errorf("unable to update service, %s, err: %s", daprSvcName, err)
return err
}
return nil
}
func (h *DaprHandler) patchDaprService(ctx context.Context, expectedService types.NamespacedName, wrapper ObjectWrapper, daprSvc corev1.Service) error {
appID := h.getAppID(wrapper)
service := h.createDaprServiceValues(ctx, expectedService, wrapper, appID)
err := ctrl.SetControllerReference(wrapper.GetObject(), service, h.Scheme)
if err != nil {
return err
}
service.ObjectMeta.ResourceVersion = daprSvc.ObjectMeta.ResourceVersion
err = h.Update(ctx, service)
if err != nil {
return err
}
monitoring.RecordServiceUpdatedCount(appID)
return nil
}
func (h *DaprHandler) createDaprService(ctx context.Context, expectedService types.NamespacedName, wrapper ObjectWrapper) error {
appID := h.getAppID(wrapper)
service := h.createDaprServiceValues(ctx, expectedService, wrapper, appID)
err := ctrl.SetControllerReference(wrapper.GetObject(), service, h.Scheme)
if err != nil {
return err
}
err = h.Create(ctx, service)
if err != nil {
log.Errorf("unable to create Dapr service for wrapper, service: %s, err: %s", expectedService, err)
return err
}
log.Debugf("created service: %s", expectedService)
monitoring.RecordServiceCreatedCount(appID)
return nil
}
func (h *DaprHandler) createDaprServiceValues(ctx context.Context, expectedService types.NamespacedName, wrapper ObjectWrapper, appID string) *corev1.Service {
enableMetrics := h.getEnableMetrics(wrapper)
metricsPort := h.getMetricsPort(wrapper)
log.Debugf("enableMetrics: %v", enableMetrics)
annotationsMap := map[string]string{
annotations.KeyAppID: appID,
}
if enableMetrics {
annotationsMap[annotationPrometheusProbe] = "true"
annotationsMap[annotationPrometheusScrape] = "true" // WARN: deprecated as of v1.7 please use prometheus.io/probe instead.
annotationsMap[annotationPrometheusPort] = strconv.Itoa(metricsPort)
annotationsMap[annotationPrometheusPath] = "/"
}
return &corev1.Service{
ObjectMeta: metaV1.ObjectMeta{
Name: expectedService.Name,
Namespace: expectedService.Namespace,
Labels: map[string]string{annotations.KeyEnabled: "true"},
Annotations: annotationsMap,
},
Spec: corev1.ServiceSpec{
Selector: wrapper.GetMatchLabels(),
ClusterIP: clusterIPNone,
Ports: []corev1.ServicePort{
{
Protocol: corev1.ProtocolTCP,
Port: 80,
TargetPort: intstr.FromInt(daprSidecarHTTPPort),
Name: daprSidecarHTTPPortName,
},
{
Protocol: corev1.ProtocolTCP,
Port: int32(daprSidecarAPIGRPCPort),
TargetPort: intstr.FromInt(daprSidecarAPIGRPCPort),
Name: daprSidecarAPIGRPCPortName,
},
{
Protocol: corev1.ProtocolTCP,
Port: int32(daprSidecarInternalGRPCPort),
TargetPort: intstr.FromInt(daprSidecarInternalGRPCPort),
Name: daprSidecarInternalGRPCPortName,
},
{
Protocol: corev1.ProtocolTCP,
Port: int32(metricsPort),
TargetPort: intstr.FromInt(metricsPort),
Name: daprSidecarMetricsPortName,
},
},
},
}
}
func (h *DaprHandler) getAppID(wrapper ObjectWrapper) string {
annotationsMap := wrapper.GetTemplateAnnotations()
return annotationsMap[annotations.KeyAppID]
}
func (h *DaprHandler) isAnnotatedForDapr(wrapper ObjectWrapper) bool {
return meta.IsAnnotatedForDapr(wrapper.GetTemplateAnnotations())
}
func (h *DaprHandler) getEnableMetrics(wrapper ObjectWrapper) bool {
annotationsMap := wrapper.GetTemplateAnnotations()
enableMetrics := defaultMetricsEnabled
if val := annotationsMap[annotations.KeyEnableMetrics]; val != "" {
enableMetrics = utils.IsTruthy(val)
}
return enableMetrics
}
func (h *DaprHandler) getMetricsPort(wrapper ObjectWrapper) int {
annotationsMap := wrapper.GetTemplateAnnotations()
metricsPort := defaultMetricsPort
if val := annotationsMap[annotations.KeyMetricsPort]; val != "" {
if v, err := strconv.Atoi(val); err == nil {
metricsPort = v
}
}
return metricsPort
}
func (h *DaprHandler) isReconciled(owner *metaV1.OwnerReference) bool {
if owner == nil {
return false
}
switch owner.APIVersion {
case appsv1.SchemeGroupVersion.String():
return owner.Kind == "Deployment" || owner.Kind == "StatefulSet"
case argov1alpha1.SchemeGroupVersion.String():
return h.argoRolloutServiceReconcilerEnabled && owner.Kind == rollouts.RolloutKind
}
return false
}