/
util.go
554 lines (496 loc) · 16.7 KB
/
util.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
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
// Copyright © 2019 Cisco Systems, Inc. and/or its affiliates
//
// 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 util
import (
"bytes"
"compress/gzip"
"context"
"crypto/tls"
"crypto/x509"
"encoding/base64"
"encoding/json"
"fmt"
"io"
"math/rand"
"reflect"
"sort"
"strconv"
"strings"
"time"
"emperror.dev/errors"
"github.com/Shopify/sarama"
clusterregv1alpha1 "github.com/cisco-open/cluster-registry-controller/api/v1alpha1"
"github.com/go-logr/logr"
"github.com/imdario/mergo"
"go.uber.org/zap"
"go.uber.org/zap/zapcore"
corev1 "k8s.io/api/core/v1"
apierrors "k8s.io/apimachinery/pkg/api/errors"
"k8s.io/apimachinery/pkg/api/resource"
metav1 "k8s.io/apimachinery/pkg/apis/meta/v1"
"k8s.io/apimachinery/pkg/types"
"k8s.io/apimachinery/pkg/util/intstr"
"k8s.io/apimachinery/pkg/util/wait"
clientCtrl "sigs.k8s.io/controller-runtime/pkg/client"
k8s_zap "sigs.k8s.io/controller-runtime/pkg/log/zap"
"github.com/banzaicloud/koperator/api/v1alpha1"
"github.com/banzaicloud/koperator/api/v1beta1"
"github.com/banzaicloud/koperator/pkg/errorfactory"
"github.com/banzaicloud/koperator/pkg/util/cert"
envoyutils "github.com/banzaicloud/koperator/pkg/util/envoy"
"github.com/banzaicloud/koperator/pkg/util/istioingress"
properties "github.com/banzaicloud/koperator/properties/pkg"
)
const (
symbolSet = "ABCDEFGHIJKLMNOPQRSTUVWXYZabcdefghijklmnopqrstuvwxyz0123456789"
IngressConfigGlobalName = "globalConfig"
ExternalListenerLabelNameTemplate = "%s-%s"
ExternalListenerLabelNameKey = "eListenerName"
)
// IntstrPointer generate IntOrString pointer from int
func IntstrPointer(i int) *intstr.IntOrString {
is := intstr.FromInt(i)
return &is
}
// Int64Pointer generates int64 pointer from int64
func Int64Pointer(i int64) *int64 {
return &i
}
// Int32Pointer generates int32 pointer from int32
func Int32Pointer(i int32) *int32 {
return &i
}
// BoolPointer generates bool pointer from bool
func BoolPointer(b bool) *bool {
return &b
}
// IntPointer generates int pointer from int
func IntPointer(i int) *int {
return &i
}
// StringPointer generates string pointer from string
func StringPointer(s string) *string {
return &s
}
// QuantityPointer generates Quantity pointer from Quantity
func QuantityPointer(q resource.Quantity) *resource.Quantity {
return &q
}
// MapStringStringPointer generates a map[string]*string
func MapStringStringPointer(in map[string]string) (out map[string]*string) {
out = make(map[string]*string)
for k, v := range in {
out[k] = StringPointer(v)
}
return
}
func MergeAnnotations(annotations ...map[string]string) map[string]string {
rtn := make(map[string]string)
for _, a := range annotations {
for k, v := range a {
rtn[k] = v
}
}
return rtn
}
// ConvertStringToInt32 converts the given string to int32
func ConvertStringToInt32(s string) int32 {
i, err := strconv.ParseInt(s, 10, 32)
if err != nil {
return -1
}
return int32(i)
}
// IsSSLEnabledForInternalCommunication checks if ssl is enabled for internal communication
func IsSSLEnabledForInternalCommunication(l []v1beta1.InternalListenerConfig) (enabled bool) {
for _, listener := range l {
if listener.UsedForInnerBrokerCommunication && listener.Type.IsSSL() {
enabled = true
break
}
}
return enabled
}
// ConvertPropertiesToMapStringPointer converts a Properties object to map[string]*string
func ConvertPropertiesToMapStringPointer(pp *properties.Properties) map[string]*string {
result := make(map[string]*string, pp.Len())
for _, key := range pp.Keys() {
if p, ok := pp.Get(key); ok {
result[key] = StringPointer(p.Value())
}
}
return result
}
// StringSliceContains returns true if list contains s
func StringSliceContains(list []string, s string) bool {
for _, v := range list {
if v == s {
return true
}
}
return false
}
// StringSliceRemove will remove s from list
func StringSliceRemove(list []string, s string) []string {
for i, v := range list {
if v == s {
list = append(list[:i], list[i+1:]...)
}
}
return list
}
func AreStringSlicesIdentical(a, b []string) bool {
sort.Strings(a)
sort.Strings(b)
return reflect.DeepEqual(a, b)
}
// returns the union of the ids of the configured (Spec.Brokers) and the running (BrokerState) brokers
func GetBrokerIdsFromStatusAndSpec(brokerStatuses map[string]v1beta1.BrokerState, brokers []v1beta1.Broker, log logr.Logger) []int {
brokerIDMap := make(map[int]struct{})
// add brokers from spec
for _, broker := range brokers {
brokerIDMap[int(broker.Id)] = struct{}{}
}
// add brokers from status
for brokerID := range brokerStatuses {
id, err := strconv.Atoi(brokerID)
if err != nil {
log.Error(err, "could not parse brokerID properly")
continue
}
brokerIDMap[id] = struct{}{}
}
// collect unique broker ids
brokerIDs := make([]int, 0, len(brokerIDMap))
for id := range brokerIDMap {
brokerIDs = append(brokerIDs, id)
}
sort.Ints(brokerIDs)
return brokerIDs
}
// IsIngressConfigInUse returns true if the provided ingressConfigName is bound to the given broker
func IsIngressConfigInUse(iConfigName, defaultConfigName string, cluster *v1beta1.KafkaCluster, log logr.Logger) bool {
// Check if the global default is in use
if iConfigName == IngressConfigGlobalName {
return true
}
// Check if the given iConfigName is bound to a given broker
for _, broker := range cluster.Spec.Brokers {
brokerConfig, err := broker.GetBrokerConfig(cluster.Spec)
if err != nil {
log.Error(err, "could not determine if ingressConfig is in use")
return false
}
if len(brokerConfig.BrokerIngressMapping) == 0 && iConfigName == defaultConfigName ||
StringSliceContains(brokerConfig.BrokerIngressMapping, iConfigName) {
return true
}
}
for _, status := range cluster.Status.BrokersState {
if StringSliceContains(status.ExternalListenerConfigNames, iConfigName) {
return true
}
}
return false
}
// ConstructEListenerLabelName construct an eListener label name based on ingress config name and listener name
func ConstructEListenerLabelName(ingressConfigName, eListenerName string) string {
if ingressConfigName == IngressConfigGlobalName {
return eListenerName
}
return fmt.Sprintf(ExternalListenerLabelNameTemplate, eListenerName, ingressConfigName)
}
// ShouldIncludeBroker returns true if the broker should be included as a resource on external listener resources
func ShouldIncludeBroker(brokerConfig *v1beta1.BrokerConfig, status v1beta1.KafkaClusterStatus, brokerID int,
defaultIngressConfigName, ingressConfigName string) bool {
if brokerConfig != nil {
if len(brokerConfig.BrokerIngressMapping) == 0 && (ingressConfigName == defaultIngressConfigName || defaultIngressConfigName == "") ||
StringSliceContains(brokerConfig.BrokerIngressMapping, ingressConfigName) {
return true
}
}
if brokerState, ok := status.BrokersState[strconv.Itoa(brokerID)]; ok {
if StringSliceContains(brokerState.ExternalListenerConfigNames, ingressConfigName) {
return true
}
}
return false
}
// GetIngressConfigs compose the ingress configuration for a given externalListener
func GetIngressConfigs(kafkaClusterSpec v1beta1.KafkaClusterSpec,
eListenerConfig v1beta1.ExternalListenerConfig) (map[string]v1beta1.IngressConfig, string, error) {
var ingressConfigs map[string]v1beta1.IngressConfig
var defaultIngressConfigName string
// Merge specific external listener configuration with the global one if none specified
switch kafkaClusterSpec.GetIngressController() {
case envoyutils.IngressControllerName:
if eListenerConfig.Config != nil {
defaultIngressConfigName = eListenerConfig.Config.DefaultIngressConfig
ingressConfigs = make(map[string]v1beta1.IngressConfig, len(eListenerConfig.Config.IngressConfig))
for k, iConf := range eListenerConfig.Config.IngressConfig {
if iConf.EnvoyConfig != nil {
err := mergo.Merge(iConf.EnvoyConfig, kafkaClusterSpec.EnvoyConfig)
if err != nil {
return nil, "", errors.WrapWithDetails(err,
"could not merge global envoy config with local one", "envoyConfig", k)
}
err = mergo.Merge(&iConf.IngressServiceSettings, eListenerConfig.IngressServiceSettings)
if err != nil {
return nil, "", errors.WrapWithDetails(err,
"could not merge global loadbalancer config with local one",
"externalListenerName", eListenerConfig.Name)
}
ingressConfigs[k] = iConf
}
}
} else {
ingressConfigs = map[string]v1beta1.IngressConfig{
IngressConfigGlobalName: {
IngressServiceSettings: eListenerConfig.IngressServiceSettings,
EnvoyConfig: &kafkaClusterSpec.EnvoyConfig,
},
}
}
case istioingress.IngressControllerName:
if eListenerConfig.Config != nil {
defaultIngressConfigName = eListenerConfig.Config.DefaultIngressConfig
ingressConfigs = make(map[string]v1beta1.IngressConfig, len(eListenerConfig.Config.IngressConfig))
for k, iConf := range eListenerConfig.Config.IngressConfig {
if iConf.IstioIngressConfig != nil {
err := mergo.Merge(iConf.IstioIngressConfig, kafkaClusterSpec.IstioIngressConfig)
if err != nil {
return nil, "", errors.WrapWithDetails(err,
"could not merge global istio config with local one", "istioConfig", k)
}
err = mergo.Merge(&iConf.IngressServiceSettings, eListenerConfig.IngressServiceSettings)
if err != nil {
return nil, "", errors.WrapWithDetails(err,
"could not merge global loadbalancer config with local one",
"externalListenerName", eListenerConfig.Name)
}
ingressConfigs[k] = iConf
}
}
} else {
ingressConfigs = map[string]v1beta1.IngressConfig{
IngressConfigGlobalName: {
IngressServiceSettings: eListenerConfig.IngressServiceSettings,
IstioIngressConfig: &kafkaClusterSpec.IstioIngressConfig,
},
}
}
default:
return nil, "", errors.NewWithDetails("not supported ingress type", "name", kafkaClusterSpec.GetIngressController())
}
return ingressConfigs, defaultIngressConfigName, nil
}
// GetBrokerImage returns the used broker image
func GetBrokerImage(brokerConfig *v1beta1.BrokerConfig, clusterImage string) string {
if brokerConfig.Image != "" {
return brokerConfig.Image
}
return clusterImage
}
// GetBrokerMetricsReporterImage returns the image used for cruise-control metrics reporter
func GetBrokerMetricsReporterImage(brokerConfig *v1beta1.BrokerConfig, kafkaClusterSpec v1beta1.KafkaClusterSpec) string {
if brokerConfig.MetricsReporterImage != "" {
return brokerConfig.MetricsReporterImage
}
return kafkaClusterSpec.GetClusterMetricsReporterImage()
}
// getRandomString returns a random string containing uppercase, lowercase and number characters with the length given
func GetRandomString(length int) (string, error) {
rand.Seed(time.Now().UnixNano())
chars := []rune(symbolSet)
var b strings.Builder
for i := 0; i < length; i++ {
b.WriteRune(chars[rand.Intn(len(chars))])
}
return b.String(), nil
}
// computes the max between 2 ints
func Max(x, y int) int {
if x < y {
return y
}
return x
}
func CreateLogger(debug bool, development bool) logr.Logger {
// create encoder config
var config zapcore.EncoderConfig
if development {
config = zap.NewDevelopmentEncoderConfig()
} else {
config = zap.NewProductionEncoderConfig()
}
// set human readable timestamp format regardless whether development mode is on
config.EncodeTime = zapcore.ISO8601TimeEncoder
// create the encoder
var encoder zapcore.Encoder
if development {
encoder = zapcore.NewConsoleEncoder(config)
} else {
encoder = zapcore.NewJSONEncoder(config)
}
// set the log level
level := zap.InfoLevel
if debug {
level = zap.DebugLevel
}
return k8s_zap.New(k8s_zap.UseDevMode(development), k8s_zap.Encoder(encoder), k8s_zap.Level(level))
}
// ConvertConfigEntryListToProperties function takes []sarama.ConfigEntry and coverts it to Properties object
func ConvertConfigEntryListToProperties(config []sarama.ConfigEntry) (*properties.Properties, error) {
p := properties.NewProperties()
for _, c := range config {
err := p.Set(c.Name, c.Value)
if err != nil {
return nil, err
}
}
return p, nil
}
func GenerateEnvoyResourceName(resourceNameFormat string, resourceNameWithScopeFormat string, extListener v1beta1.ExternalListenerConfig, ingressConfig v1beta1.IngressConfig,
ingressConfigName, clusterName string) string {
var resourceName string
if ingressConfigName == IngressConfigGlobalName {
resourceName = fmt.Sprintf(resourceNameFormat, extListener.Name, clusterName)
} else {
resourceName = fmt.Sprintf(resourceNameWithScopeFormat, extListener.Name, ingressConfigName, clusterName)
}
return resourceName
}
func StorageConfigKafkaMountPath(mountPath string) string {
return mountPath + "/kafka"
}
func GetClientTLSConfig(client clientCtrl.Reader, secretNamespaceName types.NamespacedName) (*tls.Config, error) {
tlsKeys := &corev1.Secret{}
err := client.Get(context.TODO(),
types.NamespacedName{
Namespace: secretNamespaceName.Namespace,
Name: secretNamespaceName.Name,
},
tlsKeys,
)
if err != nil {
if apierrors.IsNotFound(err) {
err = errorfactory.New(errorfactory.ResourceNotReady{}, err, "client secret not found")
}
return nil, err
}
config, err := CreateTLSConfigFromSecret(tlsKeys)
if err != nil {
return nil, errorfactory.New(errorfactory.InternalError{}, err, fmt.Sprintf("could not get client certificate for kafka client, name: %s namespace: %s", secretNamespaceName.Name, secretNamespaceName.Namespace))
}
return config, nil
}
func CreateTLSConfigFromSecret(tlsKeys *corev1.Secret) (*tls.Config, error) {
rootCAs := x509.NewCertPool()
if err := cert.CheckSSLCertSecret(tlsKeys); err != nil {
return nil, err
}
tlsCert, err := cert.ParseKeyStoreToTLSCertificate(tlsKeys.Data[v1alpha1.TLSJKSKeyStore], tlsKeys.Data[v1alpha1.PasswordKey])
if err != nil {
return nil, errors.WrapIf(err, "couldn't parse keystore")
}
caCerts, err := cert.ParseTrustStoreToCaChain(tlsKeys.Data[v1alpha1.TLSJKSTrustStore], tlsKeys.Data[v1alpha1.PasswordKey])
if err != nil {
return nil, errors.WrapIf(err, "couldn't parse truststore")
}
for i := range caCerts {
rootCAs.AddCert(caCerts[i])
}
config := &tls.Config{
Certificates: []tls.Certificate{tlsCert},
RootCAs: rootCAs,
}
return config, nil
}
func ObjectManagedByClusterRegistry(object metav1.Object) bool {
annotations := object.GetAnnotations()
_, ok := annotations[clusterregv1alpha1.OwnershipAnnotation]
return ok
}
func GzipAndBase64BrokerConfiguration(broker *v1beta1.Broker) (string, error) {
if broker == nil {
return "", nil
}
configJSON, err := json.Marshal(broker)
if err != nil {
return "", err
}
var buff bytes.Buffer
gz := gzip.NewWriter(&buff)
if _, err := gz.Write(configJSON); err != nil {
return "", err
}
gz.Close()
return base64.StdEncoding.EncodeToString(buff.Bytes()), nil
}
func GetBrokerFromBrokerConfigurationBackup(config string) (v1beta1.Broker, error) {
if config == "" {
return v1beta1.Broker{}, errors.New("broker configurationBackup is empty")
}
configGzip, err := base64.StdEncoding.DecodeString(config)
if err != nil {
return v1beta1.Broker{}, err
}
reader := bytes.NewBuffer(configGzip)
gzipReader, err := gzip.NewReader(reader)
if err != nil {
return v1beta1.Broker{}, err
}
configJSON, err := io.ReadAll(gzipReader)
if err != nil {
return v1beta1.Broker{}, err
}
gzipReader.Close()
broker := v1beta1.Broker{}
if err := json.Unmarshal(configJSON, &broker); err != nil {
return v1beta1.Broker{}, err
}
return broker, nil
}
// start with 20 ms, multiply by 2.5 each step, 6 steps = ~3 seconds
var DefaultBackOffForConflict wait.Backoff = wait.Backoff{
Duration: 20 * time.Millisecond,
Jitter: 0,
Factor: 2.5,
Steps: 6,
}
func RetryOnError(backoff wait.Backoff, fn func() error, isRetryableError func(error) bool) error {
var lastErr error
err := wait.ExponentialBackoff(backoff, func() (bool, error) {
err := fn()
switch {
case err == nil:
return true, nil
case isRetryableError(err):
lastErr = err
return false, nil
default:
return false, err
}
})
if err == wait.ErrWaitTimeout {
err = lastErr
}
return err
}
func RetryOnConflict(backoff wait.Backoff, fn func() error) error {
return RetryOnError(backoff, fn, apierrors.IsConflict)
}
func GetExternalPortForBroker(externalStartingPort, brokerId int32) int32 {
return externalStartingPort + brokerId
}