-
Notifications
You must be signed in to change notification settings - Fork 1.5k
Expand file tree
/
Copy pathinstaller.go
More file actions
861 lines (771 loc) · 27 KB
/
Copy pathinstaller.go
File metadata and controls
861 lines (771 loc) · 27 KB
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
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
// Unless explicitly stated otherwise all files in this repository are licensed
// under the Apache License Version 2.0.
// This product includes software developed at Datadog (https://www.datadoghq.com/).
// Copyright 2016-present Datadog, Inc.
// Package installer provides a package manager that installs and uninstalls packages.
package installer
import (
"context"
"errors"
"fmt"
"os"
"path/filepath"
"runtime"
"strings"
"sync"
"time"
"github.com/DataDog/datadog-agent/pkg/fleet/installer/config"
"github.com/DataDog/datadog-agent/pkg/fleet/installer/paths"
"github.com/DataDog/datadog-agent/pkg/fleet/installer/telemetry"
"github.com/DataDog/datadog-agent/pkg/fleet/installer/db"
"github.com/DataDog/datadog-agent/pkg/fleet/installer/env"
installerErrors "github.com/DataDog/datadog-agent/pkg/fleet/installer/errors"
"github.com/DataDog/datadog-agent/pkg/fleet/installer/oci"
"github.com/DataDog/datadog-agent/pkg/fleet/installer/packages"
"github.com/DataDog/datadog-agent/pkg/fleet/installer/repository"
"github.com/DataDog/datadog-agent/pkg/util/log"
"github.com/DataDog/datadog-agent/pkg/version"
)
const (
packageDatadogAgent = "datadog-agent"
packageAPMInjector = "datadog-apm-inject"
packageDatadogInstaller = "datadog-installer"
packageAPMLibraryDotnet = "datadog-apm-library-dotnet"
)
// Installer is a package manager that installs and uninstalls packages.
type Installer interface {
IsInstalled(ctx context.Context, pkg string) (bool, error)
AvailableDiskSpace() (uint64, error)
State(ctx context.Context, pkg string) (repository.State, error)
States(ctx context.Context) (map[string]repository.State, error)
ConfigState(ctx context.Context, pkg string) (repository.State, error)
ConfigStates(ctx context.Context) (map[string]repository.State, error)
Install(ctx context.Context, url string, args []string) error
ForceInstall(ctx context.Context, url string, args []string) error
SetupInstaller(ctx context.Context, path string) error
Remove(ctx context.Context, pkg string) error
Purge(ctx context.Context)
InstallExperiment(ctx context.Context, url string) error
RemoveExperiment(ctx context.Context, pkg string) error
PromoteExperiment(ctx context.Context, pkg string) error
InstallConfigExperiment(ctx context.Context, pkg string, operations config.Operations) error
RemoveConfigExperiment(ctx context.Context, pkg string) error
PromoteConfigExperiment(ctx context.Context, pkg string) error
GarbageCollect(ctx context.Context) error
InstrumentAPMInjector(ctx context.Context, method string) error
UninstrumentAPMInjector(ctx context.Context, method string) error
Close() error
}
// installerImpl is the implementation of the package manager.
type installerImpl struct {
m sync.Mutex
env *env.Env
db *db.PackagesDB
downloader *oci.Downloader
packages *repository.Repositories
config *config.Directories
hooks packages.Hooks
packagesDir string
userConfigsDir string
}
// NewInstaller returns a new Package Manager.
func NewInstaller(env *env.Env) (Installer, error) {
err := ensureRepositoriesExist()
if err != nil {
return nil, fmt.Errorf("could not ensure packages and config directory exists: %w", err)
}
db, err := db.New(filepath.Join(paths.PackagesPath, "packages.db"), db.WithTimeout(10*time.Second))
if err != nil {
return nil, fmt.Errorf("could not create packages db: %w", err)
}
pkgs := repository.NewRepositories(paths.PackagesPath, packages.AsyncPreRemoveHooks)
i := &installerImpl{
env: env,
db: db,
downloader: oci.NewDownloader(env, env.HTTPClient()),
packages: pkgs,
config: &config.Directories{
StablePath: paths.AgentConfigDir,
ExperimentPath: paths.AgentConfigDir + "-exp",
},
hooks: packages.NewHooks(env, pkgs),
userConfigsDir: paths.DefaultUserConfigsDir,
packagesDir: paths.PackagesPath,
}
return i, nil
}
// AvailableDiskSpace returns the available disk space.
func (i *installerImpl) AvailableDiskSpace() (uint64, error) {
return i.packages.AvailableDiskSpace()
}
// State returns the state of a package.
func (i *installerImpl) State(_ context.Context, pkg string) (repository.State, error) {
return i.packages.GetState(pkg)
}
// States returns the states of all packages.
func (i *installerImpl) States(_ context.Context) (map[string]repository.State, error) {
return i.packages.GetStates()
}
// ConfigState returns the state of a package.
func (i *installerImpl) ConfigState(_ context.Context, _ string) (repository.State, error) {
state, err := i.config.GetState()
if err != nil {
return repository.State{}, fmt.Errorf("could not get config state: %w", err)
}
return repository.State{
Stable: state.StableDeploymentID,
Experiment: state.ExperimentDeploymentID,
}, nil
}
// ConfigStates returns the states of all packages.
func (i *installerImpl) ConfigStates(_ context.Context) (map[string]repository.State, error) {
state, err := i.config.GetState()
if err != nil {
return nil, fmt.Errorf("could not get config state: %w", err)
}
stableDeploymentID := state.StableDeploymentID
if stableDeploymentID == "" {
stableDeploymentID = "empty"
}
return map[string]repository.State{
"datadog-agent": {
Stable: stableDeploymentID,
Experiment: state.ExperimentDeploymentID,
},
}, nil
}
// IsInstalled checks if a package is installed.
func (i *installerImpl) IsInstalled(_ context.Context, pkg string) (bool, error) {
// The install script passes the package name as either <package>-<version> or <package>=<version>
// depending on the platform so we strip the version prefix by looking for the "real" package name
hasMatch := false
for _, p := range PackagesList {
if strings.HasPrefix(pkg, p.Name) {
if hasMatch {
return false, fmt.Errorf("the package %v matches multiple known packages", pkg)
}
pkg = p.Name
hasMatch = true
}
}
hasPackage, err := i.db.HasPackage(pkg)
if err != nil {
return false, fmt.Errorf("could not list packages: %w", err)
}
return hasPackage, nil
}
// ForceInstall installs or updates a package, even if it's already installed
func (i *installerImpl) ForceInstall(ctx context.Context, url string, args []string) error {
return i.doInstall(ctx, url, args, func(dbPkg db.Package, pkg *oci.DownloadedPackage) bool {
if dbPkg.Name == pkg.Name && dbPkg.Version == pkg.Version {
log.Warnf("package %s version %s is already installed, updating it anyway", pkg.Name, pkg.Version)
}
return true
})
}
// Install installs or updates a package.
func (i *installerImpl) Install(ctx context.Context, url string, args []string) error {
return i.doInstall(ctx, url, args, func(dbPkg db.Package, pkg *oci.DownloadedPackage) bool {
if dbPkg.Name == pkg.Name && dbPkg.Version == pkg.Version {
log.Warnf("package %s version %s is already installed", pkg.Name, pkg.Version)
return false
}
return true
})
}
// SetupInstaller with given path sets up the installer/agent package.
func (i *installerImpl) SetupInstaller(ctx context.Context, path string) error {
i.m.Lock()
defer i.m.Unlock()
// make sure data directory is set up correctly
err := paths.EnsureInstallerDataDir()
if err != nil {
return fmt.Errorf("could not ensure installer data directory permissions: %w", err)
}
_, err = i.db.GetPackage(packageDatadogAgent)
if err == nil {
// need to remove the agent before installing the installer
err = i.db.DeletePackage(packageDatadogAgent)
if err != nil {
return fmt.Errorf("could not remove agent: %w", err)
}
} else if !errors.Is(err, db.ErrPackageNotFound) {
// there was a real error
return fmt.Errorf("could not get package: %w", err)
}
// remove the agent from the repository no matter database state
pkgState, err := i.packages.Get(packageDatadogAgent).GetState()
if err != nil {
return fmt.Errorf("could not get agent state: %w", err)
}
// need to make sure there is an agent package
// in the repository before we can call Delete
if pkgState.HasStable() {
err = i.packages.Delete(ctx, packageDatadogAgent)
if err != nil {
return fmt.Errorf("could not delete agent repository: %w", err)
}
}
// if windows we need to copy the MSI to temp directory
if runtime.GOOS == "windows" {
// copy the MSI to the temp directory
tmpDir, err := i.packages.MkdirTemp()
if err != nil {
return fmt.Errorf("could not create temporary directory: %w", err)
}
defer os.RemoveAll(tmpDir)
msiName := fmt.Sprintf("datadog-agent-%s-x86_64.msi", version.AgentPackageVersion)
err = paths.CopyFile(path, filepath.Join(tmpDir, msiName))
if err != nil {
return fmt.Errorf("could not copy installer: %w", err)
}
path = tmpDir
}
// create the installer package
err = i.packages.Create(ctx, packageDatadogAgent, version.AgentPackageVersion, path)
if err != nil {
return fmt.Errorf("could not create installer repository: %w", err)
}
// add to the db
err = i.db.SetPackage(db.Package{
Name: packageDatadogAgent,
Version: version.AgentPackageVersion,
InstallerVersion: version.AgentVersion,
})
if err != nil {
return fmt.Errorf("could not store package installation in db: %w", err)
}
return nil
}
func (i *installerImpl) doInstall(ctx context.Context, url string, args []string, shouldInstallPredicate func(dbPkg db.Package, pkg *oci.DownloadedPackage) bool) error {
i.m.Lock()
defer i.m.Unlock()
pkg, err := i.downloader.Download(ctx, url) // Downloads pkg metadata only
if err != nil {
return installerErrors.Wrap(
installerErrors.ErrDownloadFailed,
fmt.Errorf("could not download package: %w", err),
)
}
span, ok := telemetry.SpanFromContext(ctx)
if ok {
span.SetResourceName(pkg.Name)
span.SetTag("package_version", pkg.Version)
}
dbPkg, err := i.db.GetPackage(pkg.Name)
if err != nil && !errors.Is(err, db.ErrPackageNotFound) {
return fmt.Errorf("could not get package: %w", err)
}
if !shouldInstallPredicate(dbPkg, pkg) {
return nil
}
upgrade := !errors.Is(err, db.ErrPackageNotFound) && dbPkg.Version != pkg.Version
if upgrade {
err = i.hooks.PreRemove(ctx, pkg.Name, packages.PackageTypeOCI, true)
if err != nil {
return fmt.Errorf("could not prepare package: %w", err)
}
}
err = i.hooks.PreInstall(ctx, pkg.Name, packages.PackageTypeOCI, upgrade)
if err != nil {
return fmt.Errorf("could not prepare package: %w", err)
}
err = checkAvailableDiskSpace(i.packages, pkg)
if err != nil {
return installerErrors.Wrap(
installerErrors.ErrNotEnoughDiskSpace,
fmt.Errorf("not enough disk space: %w", err),
)
}
tmpDir, err := i.packages.MkdirTemp()
if err != nil {
return fmt.Errorf("could not create temporary directory: %w", err)
}
defer os.RemoveAll(tmpDir)
err = i.db.DeletePackage(pkg.Name)
if err != nil {
return fmt.Errorf("could not remove package installation in db: %w", err)
}
configDir := filepath.Join(i.userConfigsDir, "datadog-agent")
err = pkg.ExtractLayers(oci.DatadogPackageLayerMediaType, tmpDir)
if err != nil {
return fmt.Errorf("could not extract package layers: %w", err)
}
err = pkg.ExtractLayers(oci.DatadogPackageConfigLayerMediaType, configDir)
if err != nil {
return fmt.Errorf("could not extract package config layer: %w", err)
}
err = i.packages.Create(ctx, pkg.Name, pkg.Version, tmpDir)
if err != nil {
return fmt.Errorf("could not create repository: %w", err)
}
err = i.hooks.PostInstall(ctx, pkg.Name, packages.PackageTypeOCI, upgrade, args)
if err != nil {
return fmt.Errorf("could not setup package: %w", err)
}
err = i.db.SetPackage(db.Package{
Name: pkg.Name,
Version: pkg.Version,
InstallerVersion: version.AgentVersion,
})
if err != nil {
return fmt.Errorf("could not store package installation in db: %w", err)
}
return nil
}
// InstallExperiment installs an experiment on top of an existing package.
func (i *installerImpl) InstallExperiment(ctx context.Context, url string) error {
i.m.Lock()
defer i.m.Unlock()
pkg, err := i.downloader.Download(ctx, url)
if err != nil {
return installerErrors.Wrap(
installerErrors.ErrDownloadFailed,
fmt.Errorf("could not download package: %w", err),
)
}
err = checkAvailableDiskSpace(i.packages, pkg)
if err != nil {
return installerErrors.Wrap(
installerErrors.ErrNotEnoughDiskSpace,
fmt.Errorf("not enough disk space: %w", err),
)
}
tmpDir, err := i.packages.MkdirTemp()
if err != nil {
return installerErrors.Wrap(
installerErrors.ErrFilesystemIssue,
fmt.Errorf("could create temporary directory: %w", err),
)
}
defer os.RemoveAll(tmpDir)
configDir := filepath.Join(i.userConfigsDir, "datadog-agent")
err = pkg.ExtractLayers(oci.DatadogPackageLayerMediaType, tmpDir)
if err != nil {
return installerErrors.Wrap(
installerErrors.ErrDownloadFailed,
fmt.Errorf("could not extract package layer: %w", err),
)
}
err = pkg.ExtractLayers(oci.DatadogPackageConfigLayerMediaType, configDir)
if err != nil {
return installerErrors.Wrap(
installerErrors.ErrDownloadFailed,
fmt.Errorf("could not extract package config layer: %w", err),
)
}
err = i.hooks.PreStartExperiment(ctx, pkg.Name)
if err != nil {
return fmt.Errorf("could not install experiment: %w", err)
}
repository := i.packages.Get(pkg.Name)
err = repository.SetExperiment(ctx, pkg.Version, tmpDir)
if err != nil {
return installerErrors.Wrap(
installerErrors.ErrFilesystemIssue,
fmt.Errorf("could not set experiment: %w", err),
)
}
err = i.config.RemoveExperiment(ctx)
if err != nil {
return fmt.Errorf("could not remove config experiment: %w", err)
}
// HACK: close so package can be updated as watchdog runs
if pkg.Name == packageDatadogAgent && runtime.GOOS == "windows" {
i.db.Close()
}
err = i.hooks.PostStartExperiment(ctx, pkg.Name)
if err != nil {
return fmt.Errorf("could not install experiment: %w", err)
}
return nil
}
// RemoveExperiment removes an experiment.
func (i *installerImpl) RemoveExperiment(ctx context.Context, pkg string) error {
i.m.Lock()
defer i.m.Unlock()
repository := i.packages.Get(pkg)
state, err := repository.GetState()
if err != nil {
return fmt.Errorf("could not get repository state: %w", err)
}
if !state.HasExperiment() {
// Return early
return nil
}
if runtime.GOOS != "windows" && (pkg == packageDatadogInstaller || pkg == packageDatadogAgent) {
// Special case for the Linux installer since `preStopExperiment`
// will kill the current process, delete the experiment first.
err := repository.DeleteExperiment(ctx)
if err != nil {
return installerErrors.Wrap(
installerErrors.ErrFilesystemIssue,
fmt.Errorf("could not delete experiment: %w", err),
)
}
err = i.hooks.PreStopExperiment(ctx, pkg)
if err != nil {
return fmt.Errorf("could not stop experiment: %w", err)
}
} else {
err = i.hooks.PreStopExperiment(ctx, pkg)
if err != nil {
return fmt.Errorf("could not stop experiment: %w", err)
}
err = repository.DeleteExperiment(ctx)
if err != nil {
return installerErrors.Wrap(
installerErrors.ErrFilesystemIssue,
fmt.Errorf("could not delete experiment: %w", err),
)
}
}
err = i.hooks.PostStopExperiment(ctx, pkg)
if err != nil {
return fmt.Errorf("could not stop experiment: %w", err)
}
return nil
}
// PromoteExperiment promotes an experiment to stable.
func (i *installerImpl) PromoteExperiment(ctx context.Context, pkg string) error {
i.m.Lock()
defer i.m.Unlock()
repository := i.packages.Get(pkg)
state, err := repository.GetState()
if err != nil {
return fmt.Errorf("could not get repository state: %w", err)
}
if !state.HasExperiment() {
// Fail early
return fmt.Errorf("no experiment to promote")
}
err = i.hooks.PrePromoteExperiment(ctx, pkg)
if err != nil {
return fmt.Errorf("could not promote experiment: %w", err)
}
err = repository.PromoteExperiment(ctx)
if err != nil {
return fmt.Errorf("could not promote experiment: %w", err)
}
err = i.hooks.PostPromoteExperiment(ctx, pkg)
if err != nil {
return err
}
// Update db
state, err = repository.GetState()
if err != nil {
return fmt.Errorf("could not get repository state: %w", err)
}
return i.db.SetPackage(db.Package{
Name: pkg,
Version: state.Stable,
InstallerVersion: version.AgentVersion,
})
}
// InstallConfigExperiment installs an experiment on top of an existing package.
func (i *installerImpl) InstallConfigExperiment(ctx context.Context, pkg string, operations config.Operations) error {
i.m.Lock()
defer i.m.Unlock()
err := i.packages.Get(pkg).DeleteExperiment(ctx)
if err != nil {
return fmt.Errorf("could not delete experiment: %w", err)
}
err = i.config.WriteExperiment(ctx, operations)
if err != nil {
return fmt.Errorf("could not write experiment: %w", err)
}
// HACK: close so package can be updated as watchdog runs
if pkg == packageDatadogAgent && runtime.GOOS == "windows" {
i.db.Close()
}
return i.hooks.PostStartConfigExperiment(ctx, pkg)
}
// RemoveConfigExperiment removes an experiment.
func (i *installerImpl) RemoveConfigExperiment(ctx context.Context, pkg string) error {
i.m.Lock()
defer i.m.Unlock()
err := i.hooks.PreStopConfigExperiment(ctx, pkg)
if err != nil {
return fmt.Errorf("could not stop experiment: %w", err)
}
err = i.config.RemoveExperiment(ctx)
if err != nil {
return fmt.Errorf("could not remove experiment: %w", err)
}
return nil
}
// PromoteConfigExperiment promotes an experiment to stable.
func (i *installerImpl) PromoteConfigExperiment(ctx context.Context, pkg string) error {
i.m.Lock()
defer i.m.Unlock()
err := i.config.PromoteExperiment(ctx)
if err != nil {
return fmt.Errorf("could not promote experiment: %w", err)
}
return i.hooks.PostPromoteConfigExperiment(ctx, pkg)
}
// Purge removes all packages.
func (i *installerImpl) Purge(ctx context.Context) {
i.m.Lock()
defer i.m.Unlock()
dbPackages, err := i.db.ListPackages()
if err != nil {
// if we can't list packages we'll only remove the installer
dbPackages = nil
log.Warnf("could not list packages: %v", err)
}
for _, pkg := range dbPackages {
if pkg.Name == packageDatadogInstaller {
continue
}
if pkg.Name == packageDatadogAgent {
continue
}
err := i.hooks.PreRemove(ctx, pkg.Name, packages.PackageTypeOCI, false)
if err != nil {
log.Warnf("could not remove package %s: %v", pkg.Name, err)
}
}
// NOTE: On Windows, purge must be called from a copy of the installer that
// exists outside of the install directory. If purge is called from
// within the installer package, then one of two things may happen:
// - this process will be ctrl-c killed and purge will not complete
// - this process will ignore ctrl-c and msiexec will kill msiserver,
// failing the uninstall.
// We can't workaround this by moving removePackage to the end of purge,
// as the daemon may be running and holding locks on files that need to be removed.
//
// Note: If DD_NO_AGENT_UNINSTALL is set, then the agent will not be uninstalled.
// This is used to prevent the agent from being uninstalled when purge is
// called from within the MSI.
if _, ok := os.LookupEnv("DD_NO_AGENT_UNINSTALL"); !ok {
err = i.hooks.PreRemove(ctx, packageDatadogAgent, packages.PackageTypeOCI, false)
if err != nil {
log.Warnf("could not remove agent: %v", err)
}
}
// TODO: wont need this when Linux packages are merged
if runtime.GOOS != "windows" {
// on windows the installer package has been merged with the agent package
err = i.hooks.PreRemove(ctx, packageDatadogInstaller, packages.PackageTypeOCI, false)
if err != nil {
log.Warnf("could not remove installer: %v", err)
}
}
// Must close dependencies before removing the rest of the files,
// as some may be open/locked by the dependencies
i.close()
err = os.RemoveAll(paths.ConfigsPath)
if err != nil {
log.Warnf("could not delete configs dir: %v", err)
}
// explicitly remove the packages database from disk
// It's in the packagesDir which we'll completely remove below,
// however RemoveAll stops on the first failure and we want to
// avoid leaving a stale database behind. Any stale repository
// files will simply be removed by the next Install, but the packages.db
// is still used as a source of truth.
err = os.Remove(filepath.Join(i.packagesDir, "packages.db"))
if err != nil {
log.Warnf("could not delete packages db: %v", err)
}
// remove all from disk
span, _ := telemetry.StartSpanFromContext(ctx, "remove_all")
err = os.RemoveAll(i.packagesDir)
defer span.Finish(err)
if err != nil {
log.Warnf("could not delete packages dir: %v", err)
}
err = purgeTmpDirectory(paths.RootTmpDir)
if err != nil {
log.Warnf("could not delete tmp directory: %v", err)
}
}
// Remove uninstalls a package.
func (i *installerImpl) Remove(ctx context.Context, pkg string) error {
i.m.Lock()
defer i.m.Unlock()
err := i.hooks.PreRemove(ctx, pkg, packages.PackageTypeOCI, false)
if err != nil {
return fmt.Errorf("could not remove package: %w", err)
}
err = i.packages.Delete(ctx, pkg)
if err != nil {
return fmt.Errorf("could not delete repository: %w", err)
}
err = i.db.DeletePackage(pkg)
if err != nil {
return fmt.Errorf("could not remove package installation in db: %w", err)
}
return nil
}
// GarbageCollect removes unused packages.
func (i *installerImpl) GarbageCollect(ctx context.Context) error {
i.m.Lock()
defer i.m.Unlock()
err := i.packages.Cleanup(ctx)
if err != nil {
return fmt.Errorf("could not cleanup packages: %w", err)
}
err = cleanupTmpDirectory(paths.RootTmpDir)
if err != nil {
return fmt.Errorf("could not cleanup tmp directory: %w", err)
}
return nil
}
// InstrumentAPMInjector instruments the APM injector.
func (i *installerImpl) InstrumentAPMInjector(ctx context.Context, method string) error {
i.m.Lock()
defer i.m.Unlock()
injectorInstalled, err := i.IsInstalled(ctx, packageAPMInjector)
if err != nil {
return fmt.Errorf("could not check if APM injector is installed: %w", err)
}
if !injectorInstalled {
return fmt.Errorf("APM injector is not installed")
}
err = packages.InstrumentAPMInjector(ctx, method)
if err != nil {
return fmt.Errorf("could not instrument APM: %w", err)
}
return nil
}
// UninstrumentAPMInjector instruments the APM injector.
func (i *installerImpl) UninstrumentAPMInjector(ctx context.Context, method string) error {
i.m.Lock()
defer i.m.Unlock()
injectorInstalled, err := i.IsInstalled(ctx, packageAPMInjector)
if err != nil {
return fmt.Errorf("could not check if APM injector is installed: %w", err)
}
if !injectorInstalled {
return fmt.Errorf("APM injector is not installed")
}
err = packages.UninstrumentAPMInjector(ctx, method)
if err != nil {
return fmt.Errorf("could not instrument APM: %w", err)
}
return nil
}
// Close cleans up the Installer's dependencies, lock must be held by the caller
func (i *installerImpl) close() error {
var errs []error
if i.db != nil {
if dbErr := i.db.Close(); dbErr != nil {
dbErr = fmt.Errorf("failed to close packages database: %w", dbErr)
errs = append(errs, dbErr)
}
i.db = nil
}
if len(errs) > 0 {
return errors.Join(errs...)
}
return nil
}
// Close cleans up the Installer's dependencies
func (i *installerImpl) Close() error {
i.m.Lock()
defer i.m.Unlock()
return i.close()
}
const (
packageUnknownSize = 2 << 30 // 2GiB
installerOverhead = 10 << 20 // 10MiB
)
// checkAvailableDiskSpace checks if there is enough disk space to install a package at the given path.
// This will check the underlying partition of the given path. Note that the path must be an existing dir.
//
// On Unix, it is computed using `statfs` and is the number of free blocks available to an unprivileged used * block size
// See https://man7.org/linux/man-pages/man2/statfs.2.html for more details
// On Windows, it is computed using `GetDiskFreeSpaceExW` and is the number of bytes available
// See https://docs.microsoft.com/en-us/windows/win32/api/fileapi/nf-fileapi-getdiskfreespaceexw for more details
func checkAvailableDiskSpace(repositories *repository.Repositories, pkg *oci.DownloadedPackage) error {
requiredDiskSpace := pkg.Size
if requiredDiskSpace == 0 {
requiredDiskSpace = packageUnknownSize
}
requiredDiskSpace += installerOverhead
availableDiskSpace, err := repositories.AvailableDiskSpace()
if err != nil {
return fmt.Errorf("could not get available disk space: %w", err)
}
if availableDiskSpace < uint64(requiredDiskSpace) {
return fmt.Errorf("not enough disk space at %s: %d bytes available, %d bytes required", repositories.RootPath(), availableDiskSpace, requiredDiskSpace)
}
return nil
}
// ensureRepositoriesExist creates the temp, packages and configs directories if they don't exist
func ensureRepositoriesExist() error {
// TODO: should we call paths.EnsureInstallerDataDir() here?
// It should probably be anywhere that the below directories must be
// created, but it feels wrong to have the constructor perform work
// like this. For example, "read only" subcommands like `get-states`
// will end up iterating the filesystem tree to apply permissions,
// and every subprocess during experiments will repeat the work,
// even though it should only be needed at install/setup time.
err := os.MkdirAll(paths.PackagesPath, 0755)
if err != nil {
return fmt.Errorf("error creating packages directory: %w", err)
}
err = os.MkdirAll(paths.ConfigsPath, 0755)
if err != nil {
return fmt.Errorf("error creating configs directory: %w", err)
}
err = os.MkdirAll(paths.RootTmpDir, 0755)
if err != nil {
return fmt.Errorf("error creating tmp directory: %w", err)
}
err = os.MkdirAll(paths.RunPath, 0755)
if err != nil {
return fmt.Errorf("error creating tmp directory: %w", err)
}
return nil
}
// cleanupTmpDirectory removes files and directories in RootTmpDir that are older than 24 hours
func cleanupTmpDirectory(rootTmpDir string) error {
// Check if RootTmpDir exists
if _, err := os.Stat(rootTmpDir); os.IsNotExist(err) {
// Directory doesn't exist, nothing to clean up
return nil
}
// Calculate the cutoff time (24 hours ago)
cutoffTime := time.Now().Add(-24 * time.Hour)
// Read the directory contents
entries, err := os.ReadDir(rootTmpDir)
if err != nil {
return fmt.Errorf("could not read tmp directory: %w", err)
}
var cleanupErrors []string
for _, entry := range entries {
entryPath := filepath.Join(rootTmpDir, entry.Name())
// Get file info to check modification time
info, err := entry.Info()
if err != nil {
log.Warnf("Could not get info for %s: %v", entryPath, err)
continue
}
// Check if the file/directory is older than 24 hours
if info.ModTime().Before(cutoffTime) {
log.Debugf("Removing old tmp file/directory: %s (modified: %v)", entryPath, info.ModTime())
err := os.RemoveAll(entryPath)
if err != nil {
cleanupErrors = append(cleanupErrors, fmt.Sprintf("failed to remove %s: %v", entryPath, err))
log.Warnf("Could not remove old tmp file/directory %s: %v", entryPath, err)
} else {
log.Debugf("Successfully removed old tmp file/directory: %s", entryPath)
}
}
}
if len(cleanupErrors) > 0 {
return fmt.Errorf("tmp directory cleanup completed with errors: %s", strings.Join(cleanupErrors, "; "))
}
return nil
}
// purgeTmpDirectory removes the tmp directory
var purgeTmpDirectory = func(rootTmpDir string) error {
err := os.RemoveAll(rootTmpDir)
if err != nil {
return err
}
return nil
}