-
Notifications
You must be signed in to change notification settings - Fork 0
Expand file tree
/
Copy pathcomponent.go
More file actions
373 lines (323 loc) · 11.9 KB
/
component.go
File metadata and controls
373 lines (323 loc) · 11.9 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
package main
import (
"context"
"fmt"
"io/fs"
"log/slog"
"os"
"os/exec"
"runtime"
"slices"
"strings"
"text/template"
"github.com/scaleway/k8s-agent/repo"
"gopkg.in/yaml.v3"
)
// Structs to unmarshal metadata.yaml
type ComponentVersions struct {
Versions map[string]ComponentSections
}
type ComponentSections struct {
Install []ComponentResources `yaml:"install,omitempty"`
Uninstall []ComponentResources `yaml:"uninstall,omitempty"`
}
type ComponentResources struct {
Files []ComponentFile `yaml:"files,omitempty"`
Services []ComponentService `yaml:"services,omitempty"`
Scripts []ComponentScript `yaml:"scripts,omitempty"`
}
type ComponentFile struct {
State string `yaml:"state"`
Src string `yaml:"src,omitempty"`
Dst string `yaml:"dst,omitempty"`
Mode string `yaml:"mode,omitempty"`
Owner string `yaml:"owner,omitempty"`
Group string `yaml:"group,omitempty"`
}
type ComponentService struct {
State string `yaml:"state"`
Name string `yaml:"name"`
Enabled bool `yaml:"enabled"`
}
type ComponentScript struct {
Cmd string `yaml:"cmd"`
}
func processComponents(ctx context.Context, nodemetadata NodeMetadata) error {
// Open repository FS (local zip or remote http(s))
slog.Info("Opening repositories", slog.String("uri", nodemetadata.RepoURI))
repoFS, err := repo.NewRepoFS(nodemetadata.RepoURI)
if err != nil {
return err
}
// Get the release components for the node version
releaseComponents, err := releaseComponents(repoFS, nodemetadata)
if err != nil {
return fmt.Errorf("failed to get release components: %w", err)
}
// Uninstall components (components are uninstalled in reverse order)
err = uninstallComponents(ctx, repoFS, releaseComponents, nodemetadata)
if err != nil {
return fmt.Errorf("failed to uninstall components: %w", err)
}
// Install components
err = installComponents(ctx, repoFS, releaseComponents, nodemetadata)
if err != nil {
return fmt.Errorf("failed to install components: %w", err)
}
// Cleanup the repository FS (eg: remove the zip file for local zipFS)
err = repoFS.Cleanup()
if err != nil {
return fmt.Errorf("failed to cleanup repository: %w", err)
}
return nil
}
func uninstallComponents(ctx context.Context, repoFS fs.FS, components []Component, nodemetadata NodeMetadata) error {
// Copy and reverse component list to uninstall
reversedComponents := make([]Component, len(components))
copy(reversedComponents, components)
slices.Reverse(reversedComponents)
// Uninstall component one by one
for _, component := range reversedComponents {
// Check context cancellation
select {
case <-ctx.Done():
return fmt.Errorf("context cancelled")
default:
}
// If the component is not installed or the version is the same, skip it
installedVersion, err := GetComponentVersion(component.Name)
if err != nil {
return fmt.Errorf("failed to get component version: %w", err)
}
expectedVersion := expandVersion(component.Version, nodemetadata.PoolVersion)
if installedVersion == "" || installedVersion == expectedVersion {
continue
}
// Read component specific "metadata.yaml" file inside the component directory in root of the repository
componentSections, err := componentMetadata(repoFS, component.Name, installedVersion)
if err != nil {
return fmt.Errorf("failed to read component metadata: %w", err)
}
// Uninstall the component
slog.Info("Uninstall component", slog.String("component", component.Name), slog.String("version", installedVersion))
err = processComponentMetadata(repoFS, component.Name, "uninstalled", componentSections.Uninstall, nodemetadata)
if err != nil {
return fmt.Errorf("failed to uninstall component %s: %w", component.Name, err)
}
}
return nil
}
func installComponents(ctx context.Context, repoFS fs.FS, components []Component, nodemetadata NodeMetadata) error {
// Install component one by one
for _, component := range components {
// Check context cancellation
select {
case <-ctx.Done():
return fmt.Errorf("context cancelled")
default:
}
// Get current installed version of the component
installedVersion, err := GetComponentVersion(component.Name)
if err != nil {
return fmt.Errorf("failed to get component version: %w", err)
}
expectedVersion := expandVersion(component.Version, nodemetadata.PoolVersion)
// If the component is already installed and the version is the same, skip it
if installedVersion == expectedVersion {
slog.Info("Component already installed", slog.String("component", component.Name), slog.String("version", expectedVersion))
continue
}
// Read component specific "metadata.yaml" file inside the component directory in root of the repository
componentSections, err := componentMetadata(repoFS, component.Name, expectedVersion)
if err != nil {
return fmt.Errorf("failed to read component metadata: %w", err)
}
// Install the component
slog.Info("Install component", slog.String("component", component.Name), slog.String("version", expectedVersion))
err = processComponentMetadata(repoFS, component.Name, expectedVersion, componentSections.Install, nodemetadata)
if err != nil {
return fmt.Errorf("failed to install component %s: %w", component.Name, err)
}
}
return nil
}
func processComponentFiles(repoFS fs.FS, name, version string, files []ComponentFile, nodeMetadata NodeMetadata) error {
for _, file := range files {
// Template the source and destination paths
src, err := templateComponentPath(file.Src, version)
if err != nil {
return fmt.Errorf("failed to template source path: %w", err)
}
dst, err := templateComponentPath(file.Dst, version)
if err != nil {
return fmt.Errorf("failed to template destination path: %w", err)
}
switch file.State {
case "file":
// When type is file, only copy the file from the repository to the filesystem
filePath, err := writeFile(repoFS, name, src, dst, file.Mode, file.Owner, file.Group)
if err != nil {
return fmt.Errorf("failed to write file %s: %w", file.Dst, err)
}
slog.Info("File copied", slog.String("file", filePath))
case "template":
// When type is template, render the file with the node metadata and copy it to the filesystem
filePath, err := templateFile(repoFS, name, src, dst, file.Mode, file.Owner, file.Group, nodeMetadata)
if err != nil {
return fmt.Errorf("failed to write file %s: %w", file.Dst, err)
}
slog.Info("Template rendered", slog.String("template", filePath))
case "directory":
// When type is dir, create the directory with the specified permissions
// if the directory already exists, the ownership and permissions are ensured
err := mkdir(file.Dst, file.Mode, file.Owner, file.Group)
if err != nil {
return fmt.Errorf("failed to make directory %s: %w", dst, err)
}
slog.Info("Directory created", slog.String("directory", dst))
case "absent":
// When type is absent, remove the file or directory
err := os.RemoveAll(dst)
if err != nil {
return fmt.Errorf("failed to remove %s: %w", dst, err)
}
slog.Info("File/Directory removed", slog.String("path", dst))
}
}
return nil
}
func processComponentScripts(scripts []ComponentScript) error {
// Execute the scripts in bash
for _, script := range scripts {
// Execute the script with with the arguments via bash
cmd := exec.Command("/bin/bash", "-c", script.Cmd)
err := cmd.Run()
if err != nil {
return fmt.Errorf("failed to execute script %s: %w", script.Cmd, err)
}
}
return nil
}
func processComponentServices(services []ComponentService) error {
// Daemon-reload to pick up the updated service files
cmd := exec.Command("/usr/bin/systemctl", "daemon-reload")
err := cmd.Run()
if err != nil {
return fmt.Errorf("failed to daemon-reload: %w", err)
}
for _, service := range services {
// Enable the service
if service.Enabled {
cmd = exec.Command("/usr/bin/systemctl", "enable", service.Name)
err = cmd.Run()
if err != nil {
return fmt.Errorf("failed to enable service %s: %w", service.Name, err)
}
slog.Info("Service enabled", slog.String("service", service.Name))
} else {
cmd = exec.Command("/usr/bin/systemctl", "disable", service.Name)
err = cmd.Run()
if err != nil {
if exitErr, ok := err.(*exec.ExitError); ok && exitErr.ExitCode() == 1 {
// 1 is the exit code for systemctl disable when the service
// does not exist so just ignore this error
continue
}
return fmt.Errorf("failed to disable service %s: %w", service.Name, err)
}
slog.Info("Service disabled", slog.String("service", service.Name))
}
switch service.State {
case "started":
cmd = exec.Command("/usr/bin/systemctl", "start", service.Name)
err = cmd.Run()
if err != nil {
return fmt.Errorf("failed to start service %s: %w", service.Name, err)
}
slog.Info("Service started", slog.String("service", service.Name))
case "stopped":
cmd = exec.Command("/usr/bin/systemctl", "stop", service.Name)
err = cmd.Run()
if err != nil {
if exitErr, ok := err.(*exec.ExitError); ok && exitErr.ExitCode() == 5 {
// 5 is the exit code for systemctl stop when the service
// does not exist so just ignore this error
continue
}
return fmt.Errorf("failed to stop service %s: %w", service.Name, err)
}
slog.Info("Service stopped", slog.String("service", service.Name))
default:
return fmt.Errorf("unknown service state: %s", service.State)
}
}
return nil
}
// processComponentMetadata processes the files and services operations defined in the component metadata
func processComponentMetadata(repoFS fs.FS, name, version string, resources []ComponentResources, nodeMetadata NodeMetadata) error {
for _, resource := range resources {
// Process files operations
err := processComponentFiles(repoFS, name, version, resource.Files, nodeMetadata)
if err != nil {
return fmt.Errorf("failed to process files: %w", err)
}
// Process services operations
err = processComponentServices(resource.Services)
if err != nil {
return fmt.Errorf("failed to process services: %w", err)
}
// Process scripts operations
err = processComponentScripts(resource.Scripts)
if err != nil {
return fmt.Errorf("failed to process scripts: %w", err)
}
}
// Store the component version in the versions file
err := SetComponentVersion(name, version)
if err != nil {
return fmt.Errorf("failed to store component version: %w", err)
}
return nil
}
// releaseComponents returns the list of components for the given version
func componentMetadata(repoFS fs.FS, name, version string) (ComponentSections, error) {
// Read component specific "metadata.yaml" file inside the component directory in root of the repository
componentMetadataFile, err := fs.ReadFile(repoFS, name+"/metadata.yaml")
if err != nil {
return ComponentSections{}, fmt.Errorf("failed to read component file: %w", err)
}
// Unmarshal the metadata file
var componentMetadata ComponentVersions
err = yaml.Unmarshal(componentMetadataFile, &componentMetadata)
if err != nil {
return ComponentSections{}, fmt.Errorf("failed to unmarshal component file: %w", err)
}
// Remove subversion suffix from the version
version = trimVersion(version)
// Get the metadata for the given version
componentMetadataVersion, ok := componentMetadata.Versions[version]
if !ok {
return ComponentSections{}, fmt.Errorf("component version %s not found", version)
}
return componentMetadataVersion, nil
}
// templateComponentPath renders a component path based on the version and architecture
func templateComponentPath(path, version string) (string, error) {
tmpl, err := template.New("path").Parse(path)
if err != nil {
return "", fmt.Errorf("failed to parse path: %w", err)
}
// Template the path with the version and architecture
var renderedPath strings.Builder
err = tmpl.Execute(&renderedPath, struct {
Version string
Arch string
}{
Version: trimVersion(version),
Arch: runtime.GOARCH,
})
if err != nil {
return "", fmt.Errorf("failed to execute template: %w", err)
}
return renderedPath.String(), nil
}