/
installer_controller.go
545 lines (500 loc) · 17.4 KB
/
installer_controller.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
/*
Copyright 2020 Devtron Labs Pvt Ltd.
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 controllers
import (
"context"
"crypto/sha1"
"encoding/base64"
"encoding/hex"
"encoding/json"
"fmt"
"github.com/antlr/antlr4/runtime/Go/antlr"
installerv1alpha1 "github.com/devtron-labs/inception/api/v1alpha1"
"github.com/devtron-labs/inception/pkg/language"
parser2 "github.com/devtron-labs/inception/pkg/language/parser"
"github.com/devtron-labs/inception/pkg/providerIdentifier"
"github.com/go-logr/logr"
"github.com/patrickmn/go-cache"
"github.com/posthog/posthog-go"
"google.golang.org/grpc/codes"
"google.golang.org/grpc/status"
"io"
"io/ioutil"
v1 "k8s.io/api/core/v1"
"k8s.io/apimachinery/pkg/api/errors"
metav1 "k8s.io/apimachinery/pkg/apis/meta/v1"
"k8s.io/apimachinery/pkg/runtime"
v12 "k8s.io/client-go/kubernetes/typed/core/v1"
"k8s.io/client-go/rest"
"net/http"
"os"
ctrl "sigs.k8s.io/controller-runtime"
"sigs.k8s.io/controller-runtime/pkg/client"
"sigs.k8s.io/controller-runtime/pkg/reconcile"
"strconv"
"time"
)
// InstallerReconciler reconciles a Installer object
type InstallerReconciler struct {
client.Client
Log logr.Logger
Scheme *runtime.Scheme
//Instead of KLangListener
Mapper *language.Mapper
PosthogClient posthog.Client
Cache *cache.Cache
PosthogApiKey string
PosthogEndpoint string
}
const DevtronUniqueClientIdConfigMap = "devtron-ucid"
const DevtronUniqueClientIdConfigMapKey = "UCID"
const InstallEventKey = "installEvent"
const DevtronNamespace = "devtroncd"
const DevtronFullMode = "FULL"
type TelemetryEventType string
const (
Heartbeat TelemetryEventType = "Heartbeat"
InstallationStart TelemetryEventType = "InstallationStart"
InstallationInProgress TelemetryEventType = "InstallationInProgress"
InstallationInterrupt TelemetryEventType = "InstallationInterrupt"
InstallationSuccess TelemetryEventType = "InstallationSuccess"
InstallationFailure TelemetryEventType = "InstallationFailure"
UpgradeStart TelemetryEventType = "UpgradeStart"
UpgradeInProgress TelemetryEventType = "UpgradeInProgress"
UpgradeInterrupt TelemetryEventType = "UpgradeInterrupt"
UpgradeSuccess TelemetryEventType = "UpgradeSuccess"
UpgradeFailure TelemetryEventType = "UpgradeFailure"
Summary TelemetryEventType = "Summary"
InstallationInternalApplicationError TelemetryEventType = "InstallationInternalApplicationError"
)
type TelemetryEventDto struct {
UCID string `json:"ucid"` //unique client id
Timestamp time.Time `json:"timestamp"`
EventMessage string `json:"eventMessage,omitempty"`
EventType TelemetryEventType `json:"eventType"`
ServerVersion string `json:"serverVersion,omitempty"`
DevtronVersion string `json:"devtronVersion,omitempty"`
DevtronMode string `json:"devtronMode,omitempty"`
CloudProvider string `json:"cloudProvider,omitempty"`
}
// +kubebuilder:rbac:groups=installer.devtron.ai,resources=installers,verbs=get;list;watch;create;update;patch;delete
// +kubebuilder:rbac:groups=installer.devtron.ai,resources=installers/status,verbs=get;update;patch
var installEvent = -1
var objectEventType ObjectEventType
type ObjectEventType string
var IsOptOut = false
const TelemetryOptOutApiBaseUrl = "aHR0cHM6Ly90ZWxlbWV0cnkuZGV2dHJvbi5haS9kZXZ0cm9uL3RlbGVtZXRyeS9vcHQtb3V0"
const (
SpecChanged ObjectEventType = "SpecChanged"
Downloaded ObjectEventType = "Downloaded"
Applied ObjectEventType = "Applied"
)
func (r *InstallerReconciler) Reconcile(req ctrl.Request) (ctrl.Result, error) {
_ = context.Background()
_ = r.Log.WithValues("installer", req.NamespacedName)
installer := &installerv1alpha1.Installer{}
err := r.Client.Get(context.Background(), req.NamespacedName, installer)
if err != nil {
//Dont requeue if it is not found
if errors.IsNotFound(err) {
return reconcile.Result{}, nil
}
//This will requeue the request
return reconcile.Result{}, err
}
if len(installer.Spec.URL) == 0 {
return reconcile.Result{}, fmt.Errorf("url is not specified")
}
updated := false
if hasSpecChanged(installer) {
fmt.Println("url changed")
installer.Status.Sync.Status = installerv1alpha1.SyncStatusCodeOutOfSync
installer.Status.Sync.StatusMessage = installerv1alpha1.SyncStatusMessageOutOfSync
installer.Status.Sync.URL = installer.Spec.URL
installer.Spec.ReSync = false
updated = true
objectEventType = SpecChanged
} else if shouldDownload(installer) {
fmt.Println("should download")
err := r.sync(installer)
if err != nil {
return reconcile.Result{}, err
}
updated = true
objectEventType = Downloaded
} else if shouldApply(installer) {
fmt.Println("applying")
r.apply(installer)
updated = true
objectEventType = Applied
}
cloudIdentifier := providerIdentifier.NewProviderIdentifierServiceImpl(r.Log)
provider, err := cloudIdentifier.IdentifyProvider()
if err != nil {
r.Log.Error(err, "exception while getting cluster provider", "error", err, "provider", provider)
return reconcile.Result{}, err
}
//TODO - setup correct event trigger points
if updated {
fmt.Println("updating")
var payload *TelemetryEventDto
fromCache := true
if installEvent == -1 {
fromCache = false
}
UCID, cm, err := r.getUCID(fromCache)
if err != nil {
r.Log.Error(err, "failed to get ucid from config map")
}
if cm != nil && cm.Data != nil && installEvent == -1 {
dataMap := cm.Data
installEventStr := dataMap["installEvent"]
installEvent, err = strconv.Atoi(installEventStr)
if err != nil {
installEvent = 1 // there might be no key in first time in cm get
r.Log.Error(err, "failed to fetch install event status from cm")
}
}
err = r.Client.Update(context.Background(), installer)
if err != nil {
if installEvent == 1 {
payload = &TelemetryEventDto{UCID: UCID, Timestamp: time.Now(), EventType: InstallationInterrupt}
} else if installEvent == 2 {
payload = &TelemetryEventDto{UCID: UCID, Timestamp: time.Now(), EventType: UpgradeInterrupt}
}
if installEvent == -1 {
payload = &TelemetryEventDto{Timestamp: time.Now(), EventType: InstallationInternalApplicationError}
}
if payload != nil {
payload.CloudProvider = provider
err = r.sendEvent(payload)
if err != nil {
r.Log.Error(err, "failed to send event to posthog")
}
}
return reconcile.Result{}, err
} else {
// when update success following events should send
payload = &TelemetryEventDto{UCID: UCID, Timestamp: time.Now()}
if installEvent == 1 && objectEventType == SpecChanged {
payload.EventType = InstallationStart
} else if installEvent == 1 && objectEventType == Downloaded {
payload.EventType = InstallationInProgress
} else if installEvent == 1 && objectEventType == Applied {
payload.EventType = InstallationSuccess
installEvent = 2
} else if installEvent == 2 && objectEventType == SpecChanged {
payload.EventType = UpgradeStart
} else if installEvent == 2 && objectEventType == Downloaded {
payload.EventType = UpgradeInProgress
} else if installEvent == 2 && objectEventType == Applied {
payload.EventType = UpgradeSuccess
}
if installEvent == -1 {
payload.EventType = InstallationInternalApplicationError
}
if payload != nil {
payload.CloudProvider = provider
err = r.sendEvent(payload)
if err != nil {
r.Log.Error(err, "failed to send event to posthog")
}
if payload.EventType == InstallationSuccess && cm != nil {
err = r.updateStatusOnCm(cm)
if err != nil {
r.Log.Error(err, "failed to update cm")
}
}
}
}
}
return ctrl.Result{}, nil
}
func (r *InstallerReconciler) sendEvent(payload *TelemetryEventDto) error {
if IsOptOut {
r.Log.Info("telemetry is opt-out for this client ....")
return nil
}
payload.DevtronMode = DevtronFullMode
prop := make(map[string]interface{})
reqBody, err := json.Marshal(payload)
if err != nil {
r.Log.Error(err, "telemetry event to posthog from operator, payload marshal error")
return nil
}
err = json.Unmarshal(reqBody, &prop)
if err != nil {
r.Log.Error(err, "telemetry event to posthog from operator, payload unmarshal error")
return nil
}
if r.PosthogClient == nil {
r.Log.Error(err, "no posthog client found, creating new")
client, err := r.retryPosthogClient(r.PosthogApiKey, r.PosthogEndpoint)
if err == nil {
r.PosthogClient = client
}
}
if r.PosthogClient != nil {
r.PosthogClient.Enqueue(posthog.Capture{
DistinctId: payload.UCID,
Event: string(payload.EventType),
Properties: prop,
})
}
return nil
}
func (r *InstallerReconciler) sync(installer *installerv1alpha1.Installer) error {
//Download from url
url := installer.Status.Sync.URL
data, err := downloadDSL(url)
if err != nil {
return err
}
//Update url on which action was taken to handle race condition
installer.Status.Sync.URL = url
installer.Status.Sync.Data = data
installer.Status.Sync.Status = installerv1alpha1.SyncStatusCodeDownloaded
installer.Status.Sync.StatusMessage = installerv1alpha1.SyncStatusMessageDownloaded
return nil
}
func (r *InstallerReconciler) apply(installer *installerv1alpha1.Installer) *language.KlangListener {
url := installer.Status.Sync.URL
data := installer.Status.Sync.Data
//parse and process data
is := antlr.NewInputStream(data)
lexer := parser2.NewKlangLexer(is)
stream := antlr.NewCommonTokenStream(lexer, antlr.TokenDefaultChannel)
p := parser2.NewKlangParser(stream)
p.BuildParseTrees = true
listener := language.NewKlangListener(r.Mapper)
antlr.ParseTreeWalkerDefault.Walk(listener, p.Parse())
//TODO: Use r.Parser.Values() to check data and get resources
//Update the status of resources
var resourceStatuses []installerv1alpha1.ResourceStatus
for _, resources := range listener.KubernetesResources() {
for _, resource := range resources {
rs := installerv1alpha1.ResourceStatus{
Group: resource.Group,
Version: resource.Version,
Kind: resource.Kind,
Namespace: resource.Namespace,
Name: resource.Name,
Status: toSyncStatus(resource.Status),
Health: nil,
Operation: resource.Operation,
Message: resource.Message,
}
resourceStatuses = append(resourceStatuses, rs)
}
}
//Update URL and data on which action was taken to handle race condition
installer.Status.Sync.URL = url
installer.Status.Sync.Data = data
installer.Status.Sync.Status = installerv1alpha1.SyncStatusCodeApplied
installer.Status.Sync.StatusMessage = installerv1alpha1.SyncStatusMessageApplied
installer.Status.Sync.Resources = resourceStatuses
return listener
}
func toSyncStatus(code language.ResourceSyncStatusCode) installerv1alpha1.SyncStatusCode {
switch code {
case language.ResourceSyncStatusCodeOutOfSync:
return installerv1alpha1.SyncStatusCodeOutOfSync
case language.ResourceSyncStatusCodeSynced:
return installerv1alpha1.SyncStatusCodeSynced
case language.ResourceSyncStatusCodeUnknown:
return installerv1alpha1.SyncStatusCodeUnknown
default:
return installerv1alpha1.SyncStatusCodeUnknown
}
}
func downloadDSL(url string) (string, error) {
hasher := sha1.New()
hasher.Write([]byte(url))
hash := hex.EncodeToString(hasher.Sum(nil))
fileName := fmt.Sprintf("/tmp/%s", hash)
file, err := os.Create(fileName)
if err != nil {
return "", err
}
defer func() {
err := file.Close()
if err != nil {
//Log
}
}()
resp, err := http.Get(url)
if err != nil {
return "", err
}
defer resp.Body.Close()
_, err = io.Copy(file, resp.Body)
if err != nil {
return "", err
}
data, err := ioutil.ReadFile(fileName)
if err != nil {
return "", err
}
return string(data), nil
}
func hasSpecChanged(installer *installerv1alpha1.Installer) bool {
if installer.Spec.URL != installer.Status.Sync.URL || installer.Spec.ReSync {
return true
}
return false
}
func shouldDownload(installer *installerv1alpha1.Installer) bool {
if installer.Status.Sync.Status == installerv1alpha1.SyncStatusCodeOutOfSync {
return true
}
return false
}
func shouldApply(installer *installerv1alpha1.Installer) bool {
if installer.Status.Sync.Status == installerv1alpha1.SyncStatusCodeDownloaded {
return true
}
return false
}
func (r *InstallerReconciler) SetupWithManager(mgr ctrl.Manager) error {
return ctrl.NewControllerManagedBy(mgr).
For(&installerv1alpha1.Installer{}).
Complete(r)
}
func (r *InstallerReconciler) GetClientForInCluster() (*v12.CoreV1Client, error) {
// creates the in-cluster config
cfg, err := rest.InClusterConfig()
if err != nil {
r.Log.Error(err, " error on in cluster config")
return nil, err
}
// creates the clientset
clientset, err := v12.NewForConfig(cfg)
if err != nil {
r.Log.Error(err, " error on in cluster config client")
return nil, err
}
return clientset, err
}
func (r *InstallerReconciler) GetConfigMap(namespace string, name string, client *v12.CoreV1Client) (*v1.ConfigMap, error) {
ctx := context.Background()
cm, err := client.ConfigMaps(namespace).Get(ctx, name, metav1.GetOptions{})
if err != nil {
return nil, err
} else {
return cm, nil
}
}
func (r *InstallerReconciler) CreateConfigMap(namespace string, cm *v1.ConfigMap, client *v12.CoreV1Client) (*v1.ConfigMap, error) {
ctx := context.Background()
cm, err := client.ConfigMaps(namespace).Create(ctx, cm, metav1.CreateOptions{})
if err != nil {
return nil, err
} else {
return cm, nil
}
}
func (r *InstallerReconciler) UpdateConfigMap(namespace string, cm *v1.ConfigMap, client *v12.CoreV1Client) (*v1.ConfigMap, error) {
ctx := context.Background()
cm, err := client.ConfigMaps(namespace).Update(ctx, cm, metav1.UpdateOptions{})
if err != nil {
return nil, err
} else {
return cm, nil
}
}
func (r *InstallerReconciler) updateStatusOnCm(cm *v1.ConfigMap) error {
client, err := r.GetClientForInCluster()
if err != nil {
r.Log.Error(err, "exception while update updateStatusOnCm")
return err
}
if cm != nil && cm.Data != nil {
dataMap := cm.Data
dataMap[InstallEventKey] = "2"
cm.Data = dataMap
_, err = r.UpdateConfigMap(DevtronNamespace, cm, client)
if err != nil {
r.Log.Error(err, "exception while update updateStatusOnCm")
return err
}
}
return nil
}
func (r *InstallerReconciler) getUCID(fromCache bool) (string, *v1.ConfigMap, error) {
var cm *v1.ConfigMap
ucid, found := r.Cache.Get(DevtronUniqueClientIdConfigMapKey)
//TODO: refactor the code to include only one if condition i.e; if !found {
if found && fromCache {
return ucid.(string), nil, nil
} else {
//TODO: use r.Client instead of creating new client
client, err := r.GetClientForInCluster()
if err != nil {
r.Log.Error(err, "exception while getting unique client id")
return "", nil, err
}
cm, err = r.GetConfigMap(DevtronNamespace, DevtronUniqueClientIdConfigMap, client)
if errStatus, ok := status.FromError(err); !ok || errStatus.Code() == codes.NotFound || errStatus.Code() == codes.Unknown {
// if not found, create new cm
cm = &v1.ConfigMap{ObjectMeta: metav1.ObjectMeta{Name: DevtronUniqueClientIdConfigMap}}
data := map[string]string{}
//TODO: we can rather use SHA1 to generate uniqueId, that has low chances of collision
data[DevtronUniqueClientIdConfigMapKey] = language.Generate(16) // generate unique random number
data[InstallEventKey] = "1"
cm.Data = data
cm, err = r.CreateConfigMap(DevtronNamespace, cm, client)
if err != nil {
r.Log.Error(err, "exception while getting unique client id")
return "", nil, err
}
}
if cm == nil {
r.Log.Error(err, "configmap not found while getting unique client id", "cm", cm)
return "", nil, nil
}
dataMap := cm.Data
ucid = dataMap[DevtronUniqueClientIdConfigMapKey]
r.Cache.Set(DevtronUniqueClientIdConfigMapKey, ucid, cache.DefaultExpiration)
flag, err := r.checkForOptOut(ucid.(string))
if err != nil {
r.Log.Error(err, "error sending event to posthog, failed check for opt-out")
return "", nil, nil
}
IsOptOut = flag
}
return ucid.(string), cm, nil
}
func (r *InstallerReconciler) checkForOptOut(UCID string) (bool, error) {
decodedUrl, err := base64.StdEncoding.DecodeString(TelemetryOptOutApiBaseUrl)
if err != nil {
r.Log.Error(err, "check opt-out list failed, decode error")
return false, err
}
encodedUrl := string(decodedUrl)
url := fmt.Sprintf("%s/%s", encodedUrl, UCID)
response, err := language.HttpRequest(url)
if err != nil {
r.Log.Error(err, "check opt-out list failed, rest api error")
return false, err
}
flag := response["result"].(bool)
return flag, err
}
func (r *InstallerReconciler) retryPosthogClient(PosthogApiKey string, PosthogEndpoint string) (posthog.Client, error) {
client, err := posthog.NewWithConfig(PosthogApiKey, posthog.Config{Endpoint: PosthogEndpoint})
//defer client.Close()
if err != nil {
r.Log.Error(err, "exception caught while creating posthog client")
}
return client, err
}