-
Notifications
You must be signed in to change notification settings - Fork 9
/
volumes.go
315 lines (262 loc) · 8.61 KB
/
volumes.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
// Copyright 2022 Namespace Labs Inc; All rights reserved.
// Licensed under the Apache License, Version 2.0 (the "License");
// you may not use this file except in compliance with the License.
package cuefrontend
import (
"context"
"io"
"io/fs"
"path/filepath"
"strings"
"cuelang.org/go/cue"
"github.com/docker/go-units"
"google.golang.org/protobuf/proto"
"google.golang.org/protobuf/types/known/anypb"
"namespacelabs.dev/foundation/internal/bytestream"
"namespacelabs.dev/foundation/internal/fnerrors"
"namespacelabs.dev/foundation/internal/fnfs"
"namespacelabs.dev/foundation/internal/fnfs/memfs"
"namespacelabs.dev/foundation/internal/frontend/fncue"
hrconstants "namespacelabs.dev/foundation/internal/hotreload/constants"
"namespacelabs.dev/foundation/internal/parsing"
"namespacelabs.dev/foundation/schema"
"namespacelabs.dev/foundation/std/pkggraph"
"namespacelabs.dev/foundation/std/runtime/constants"
)
func ParseVolumes(ctx context.Context, pl parsing.EarlyPackageLoader, loc pkggraph.Location, v *fncue.CueV) ([]*schema.Volume, error) {
// Ensure all fields are bound.
if err := v.Val.Validate(cue.Concrete(true)); err != nil {
return nil, err
}
it, err := v.Val.Fields()
if err != nil {
return nil, err
}
out := []*schema.Volume{}
for it.Next() {
parsedVolume, err := parseVolume(ctx, pl, loc, it.Label(), false /* isInlined */, it.Value())
if err != nil {
return nil, err
}
out = append(out, parsedVolume)
}
return out, nil
}
type cueVolume struct {
cuePersistentVolume
cueWorkspaceSyncVolume
Kind string `json:"kind"`
// Shortcuts
Ephemeral *cueEphemeralVolume `json:"ephemeral,omitempty"`
Persistent *cuePersistentVolume `json:"persistent,omitempty"`
WorkspaceSync *cueWorkspaceSyncVolume `json:"syncWorkspace,omitempty"`
Configurable any `json:"configurable,omitempty"`
HostPath *cueHostPathVolume `json:"hostPath,omitempty"`
}
type cueEphemeralVolume struct {
Size string `json:"size"`
}
type cuePersistentVolume struct {
Id string `json:"id"`
Size string `json:"size"`
}
type cueWorkspaceSyncVolume struct {
FromDir string `json:"fromDir"`
}
type cueHostPathVolume struct {
Directory string `json:"directory"`
}
type cueConfigurableEntry struct {
FromDir string `json:"fromDir"`
FromFile string `json:"fromFile"`
FromSecret string `json:"fromSecret"`
FromKubernetesSecret string `json:"fromKubernetesSecret"`
}
func parseVolume(ctx context.Context, pl parsing.EarlyPackageLoader, loc pkggraph.Location, name string, isInlined bool, value cue.Value) (*schema.Volume, error) {
var bits cueVolume
if err := value.Decode(&bits); err != nil {
return nil, err
}
// Parsing shortcuts
if bits.Kind == "" {
if bits.Ephemeral != nil {
bits.Kind = constants.VolumeKindEphemeral
}
if bits.Persistent != nil {
bits.cuePersistentVolume = *bits.Persistent
bits.Kind = constants.VolumeKindPersistent
}
if bits.WorkspaceSync != nil {
bits.cueWorkspaceSyncVolume = *bits.WorkspaceSync
bits.Kind = constants.VolumeKindWorkspaceSync
}
if bits.Configurable != nil {
// Parsing can't be done via JSON unmarshalling, so doing it manually below.
bits.Kind = constants.VolumeKindConfigurable
}
if bits.HostPath != nil {
bits.Kind = constants.VolumeKindHostPath
}
}
out := &schema.Volume{
Owner: loc.PackageName.String(),
Kind: bits.Kind,
Name: name,
Inline: isInlined,
}
var definition proto.Message
switch bits.Kind {
case constants.VolumeKindEphemeral:
var usizeBytes uint64
if bits.Ephemeral.Size != "" {
sizeBytes, err := units.FromHumanSize(bits.Ephemeral.Size)
if err != nil {
return nil, fnerrors.NewWithLocation(loc, "failed to parse value: %w", err)
}
usizeBytes = uint64(sizeBytes)
}
definition = &schema.EphemeralVolume{
SizeBytes: usizeBytes,
}
case constants.VolumeKindPersistent:
sizeBytes, err := units.FromHumanSize(bits.Size)
if err != nil {
return nil, fnerrors.NewWithLocation(loc, "failed to parse value: %w", err)
}
definition = &schema.PersistentVolume{
Id: bits.Id,
SizeBytes: uint64(sizeBytes),
}
case constants.VolumeKindHostPath:
if err := parsing.RequireFeature(loc.Module, "experimental/volume/hostPath"); err != nil {
return nil, fnerrors.AttachLocation(loc, err)
}
if bits.HostPath == nil || bits.HostPath.Directory == "" {
return nil, fnerrors.NewWithLocation(loc, "host: missing required field 'directory'")
}
definition = &schema.HostPathVolume{Directory: bits.HostPath.Directory}
case constants.VolumeKindWorkspaceSync:
if bits.FromDir == "" {
return nil, fnerrors.NewWithLocation(loc, "workspace sync: missing required field 'fromDir'")
}
definition = &schema.WorkspaceSyncVolume{
Path: bits.FromDir,
}
// Making sure that the controller package is loaded.
if err := pl.Ensure(ctx, hrconstants.ControllerPkg.AsPackageName()); err != nil {
return nil, err
}
case constants.VolumeKindConfigurable:
val := &fncue.CueV{Val: value}
if bits.Configurable != nil {
cueV := fncue.CueV{Val: value}
val = cueV.LookupPath("configurable")
}
entries := []*schema.ConfigurableVolume_Entry{}
contents := val.LookupPath("contents")
if contents.Exists() {
it, err := contents.Val.Fields()
if err != nil {
return nil, err
}
for it.Next() {
parsedEntry, err := parseConfigurableEntry(ctx, pl, loc, isInlined, it.Value())
if err != nil {
return nil, fnerrors.NewWithLocation(loc, "%s: %w", it.Label(), err)
}
parsedEntry.Path = it.Label()
entries = append(entries, parsedEntry)
}
} else {
// Entry name is the volume/mount name.
entry, err := parseConfigurableEntry(ctx, pl, loc, isInlined, val.Val)
if err != nil {
return nil, fnerrors.NewWithLocation(loc, "%s: %w", name, err)
}
entry.Path = name
entries = append(entries, entry)
}
definition = &schema.ConfigurableVolume{
Entries: entries,
}
default:
return nil, fnerrors.BadInputError("%s: unsupported volume type", bits.Kind)
}
var err error
out.Definition, err = anypb.New(definition)
if err != nil {
return nil, fnerrors.InternalError("failed to serialize definition: %w", err)
}
return out, nil
}
func parseConfigurableEntry(ctx context.Context, pl parsing.EarlyPackageLoader, loc pkggraph.Location, isVolumeInlined bool, v cue.Value) (*schema.ConfigurableVolume_Entry, error) {
if v.Kind() == cue.StringKind {
// Inlined content.
str, _ := v.String()
if !isVolumeInlined {
return nil, fnerrors.NewWithLocation(loc, "Configurable content %q without target path must be inlined", str)
}
return &schema.ConfigurableVolume_Entry{
Inline: &schema.FileContents{
Contents: []byte(str),
},
}, nil
}
var bits cueConfigurableEntry
if err := v.Decode(&bits); err != nil {
return nil, err
}
fsys, err := pl.WorkspaceOf(ctx, loc.Module)
if err != nil {
return nil, err
}
switch {
case bits.FromDir != "":
snapshot, err := memfs.SnapshotDir(fsys, bits.FromDir, memfs.SnapshotOpts{})
if err != nil {
return nil, fnerrors.InternalError("%s: failed to snapshot: %w", bits.FromDir, err)
}
set := &schema.ResourceSet{}
if err := fnfs.VisitFiles(ctx, snapshot, func(path string, bs bytestream.ByteStream, de fs.DirEntry) error {
r, err := bs.Reader()
if err != nil {
return err
}
contents, err := io.ReadAll(r)
if err != nil {
return fnerrors.InternalError("%s: failed to read contents: %w", path, err)
}
set.Resource = append(set.Resource, &schema.FileContents{
Path: loc.Rel(filepath.Join(bits.FromDir, path)),
Contents: contents,
})
return nil
}); err != nil {
return nil, fnerrors.InternalError("%s: failed to consume snapshot: %w", bits.FromDir, err)
}
return &schema.ConfigurableVolume_Entry{InlineSet: set}, nil
case bits.FromFile != "":
rsc, err := LoadResource(fsys, loc, bits.FromFile)
if err != nil {
return nil, err
}
return &schema.ConfigurableVolume_Entry{Inline: rsc}, nil
case bits.FromSecret != "":
secretRef, err := schema.ParsePackageRef(loc.PackageName, bits.FromSecret)
if err != nil {
return nil, err
}
return &schema.ConfigurableVolume_Entry{SecretRef: secretRef}, nil
case bits.FromKubernetesSecret != "":
parts := strings.SplitN(bits.FromKubernetesSecret, ":", 2)
if len(parts) != 2 {
return nil, fnerrors.BadInputError("kubernetes secrets are specified as {name}:{key}")
}
return &schema.ConfigurableVolume_Entry{KubernetesSecretRef: &schema.ConfigurableVolume_Entry_KubernetesSecretRef{
SecretName: parts[0],
SecretKey: parts[1],
}}, nil
default:
return nil, fnerrors.NewWithLocation(loc, "must have a source")
}
}