-
Notifications
You must be signed in to change notification settings - Fork 111
/
deployments.go
473 lines (414 loc) · 15 KB
/
deployments.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
package admin
import (
"context"
"fmt"
"regexp"
"strconv"
"strings"
"time"
"github.com/google/uuid"
"github.com/hashicorp/go-version"
"github.com/rilldata/rill/admin/database"
"github.com/rilldata/rill/admin/provisioner"
runtimev1 "github.com/rilldata/rill/proto/gen/rill/runtime/v1"
"github.com/rilldata/rill/runtime/client"
"github.com/rilldata/rill/runtime/pkg/observability"
"github.com/rilldata/rill/runtime/server/auth"
"go.uber.org/multierr"
"go.uber.org/zap"
)
type createDeploymentOptions struct {
ProjectID string
Provisioner string
Annotations DeploymentAnnotations
ProdBranch string
ProdVariables map[string]string
ProdOLAPDriver string
ProdOLAPDSN string
ProdSlots int
ProdVersion string
}
func (s *Service) createDeployment(ctx context.Context, opts *createDeploymentOptions) (*database.Deployment, error) {
// We require a branch to be specified to create a deployment
if opts.ProdBranch == "" {
return nil, fmt.Errorf("cannot create project without a branch")
}
// Use default if no provisioner is specified
if opts.Provisioner == "" {
opts.Provisioner = s.opts.DefaultProvisioner
}
// Get provisioner from the set
p, ok := s.ProvisionerSet[opts.Provisioner]
if !ok {
return nil, fmt.Errorf("provisioner: %q is not in the provisioner set", opts.Provisioner)
}
runtimeVersion := opts.ProdVersion
// Resolve 'latest' version
if runtimeVersion == "latest" {
runtimeVersion = s.ResolveLatestRuntimeVersion()
}
// Verify version is valid
err := s.ValidateRuntimeVersion(runtimeVersion)
if err != nil {
return nil, err
}
// Create instance ID and use the same ID for the provision ID
instanceID := strings.ReplaceAll(uuid.New().String(), "-", "")
provisionID := instanceID
// Get a runtime with capacity for the deployment
alloc, err := p.Provision(ctx, &provisioner.ProvisionOptions{
ProvisionID: provisionID,
RuntimeVersion: runtimeVersion,
Slots: opts.ProdSlots,
Annotations: opts.Annotations.toMap(),
})
if err != nil {
s.Logger.Error("provisioner: failed provisioning", zap.String("project_id", opts.ProjectID), zap.String("provisioner", opts.Provisioner), zap.String("provision_id", provisionID), zap.Error(err), observability.ZapCtx(ctx))
return nil, err
}
// Prepare instance config
var connectors []*runtimev1.Connector
// Always configure a DuckDB connector, even if it's not set as the default OLAP connector
connectors = append(connectors, &runtimev1.Connector{
Name: "duckdb",
Type: "duckdb",
// duckdb DSN will automatically be computed based on these parameters
Config: map[string]string{
"cpu": strconv.Itoa(alloc.CPU),
"memory_limit_gb": strconv.Itoa(alloc.MemoryGB),
"storage_limit_bytes": strconv.FormatInt(alloc.StorageBytes, 10),
"external_table_storage": strconv.FormatBool(true),
},
})
// Determine the default OLAP connector
var olapConnector string
switch opts.ProdOLAPDriver {
case "duckdb", "duckdb-ext-storage":
if opts.ProdSlots == 0 {
return nil, fmt.Errorf("slot count can't be 0 for OLAP driver 'duckdb'")
}
olapConnector = "duckdb"
// Already configured DuckDB above
default:
olapConnector = opts.ProdOLAPDriver
connectors = append(connectors, &runtimev1.Connector{
Name: opts.ProdOLAPDriver,
Type: opts.ProdOLAPDriver,
Config: map[string]string{
"dsn": opts.ProdOLAPDSN,
},
})
}
// Create the deployment
depl, err := s.DB.InsertDeployment(ctx, &database.InsertDeploymentOptions{
ProjectID: opts.ProjectID,
Provisioner: opts.Provisioner,
ProvisionID: provisionID,
Branch: opts.ProdBranch,
Slots: opts.ProdSlots,
RuntimeHost: alloc.Host,
RuntimeInstanceID: instanceID,
RuntimeAudience: alloc.Audience,
RuntimeVersion: runtimeVersion,
Status: database.DeploymentStatusPending,
})
if err != nil {
return nil, err
}
// Wait for the runtime to be ready
err = p.AwaitReady(ctx, provisionID)
if err != nil {
s.Logger.Error("provisioner: failed awaiting runtime to be ready", zap.String("project_id", opts.ProjectID), zap.String("deployment_id", depl.ID), zap.String("provisioner", depl.Provisioner), zap.String("provision_id", depl.ProvisionID), zap.Error(err), observability.ZapCtx(ctx))
err2 := p.Deprovision(ctx, provisionID)
// Mark deployment error
_, err3 := s.DB.UpdateDeploymentStatus(ctx, depl.ID, database.DeploymentStatusError, err.Error())
return nil, multierr.Combine(err, err2, err3)
}
// Open a runtime client
rt, err := s.openRuntimeClient(alloc.Host, alloc.Audience)
if err != nil {
err2 := p.Deprovision(ctx, provisionID)
err3 := s.DB.DeleteDeployment(ctx, depl.ID)
return nil, multierr.Combine(err, err2, err3)
}
defer rt.Close()
// Create an access token the deployment can use to authenticate with the admin server.
dat, err := s.IssueDeploymentAuthToken(ctx, depl.ID, nil)
if err != nil {
err2 := p.Deprovision(ctx, provisionID)
err3 := s.DB.DeleteDeployment(ctx, depl.ID)
return nil, multierr.Combine(err, err2, err3)
}
adminAuthToken := dat.Token().String()
// Add the admin connector
connectors = append(connectors, &runtimev1.Connector{
Name: "admin",
Type: "admin",
Config: map[string]string{
"admin_url": s.opts.ExternalURL,
"access_token": adminAuthToken,
"project_id": opts.ProjectID,
"branch": opts.ProdBranch,
"nonce": time.Now().Format(time.RFC3339Nano), // Only set for consistency with updateDeployment
},
})
// Create the instance
_, err = rt.CreateInstance(ctx, &runtimev1.CreateInstanceRequest{
InstanceId: instanceID,
Environment: "prod",
OlapConnector: olapConnector,
RepoConnector: "admin",
AdminConnector: "admin",
AiConnector: "admin",
Connectors: connectors,
Variables: opts.ProdVariables,
Annotations: opts.Annotations.toMap(),
EmbedCatalog: false,
})
if err != nil {
err2 := p.Deprovision(ctx, provisionID)
err3 := s.DB.DeleteDeployment(ctx, depl.ID)
return nil, multierr.Combine(err, err2, err3)
}
// Mark deployment ready
depl, err = s.DB.UpdateDeploymentStatus(ctx, depl.ID, database.DeploymentStatusOK, "")
if err != nil {
// NOTE: Unlikely case – we'll leave it pending in this case, the user can reset.
return nil, err
}
return depl, nil
}
type UpdateDeploymentOptions struct {
Version string
Branch string
Variables map[string]string
Annotations DeploymentAnnotations
EvictCachedRepo bool // Set to true if config returned by GetRepoMeta has changed such that the runtime should do a fresh clone instead of a pull.
}
func (s *Service) UpdateDeployment(ctx context.Context, depl *database.Deployment, opts *UpdateDeploymentOptions) error {
if opts.Branch == "" {
return fmt.Errorf("cannot update deployment without specifying a valid branch")
}
// Update the provisioned runtime if the version has changed
if opts.Version != depl.RuntimeVersion {
// Get provisioner from the set
p, ok := s.ProvisionerSet[depl.Provisioner]
if !ok {
return fmt.Errorf("provisioner: %q is not in the provisioner set", depl.Provisioner)
}
// Update the runtime
err := p.Update(ctx, depl.ProvisionID, opts.Version)
if err != nil {
s.Logger.Error("provisioner: failed to update", zap.String("deployment_id", depl.ID), zap.String("provisioner", depl.Provisioner), zap.String("provision_id", depl.ProvisionID), zap.Error(err), observability.ZapCtx(ctx))
return err
}
// Wait for the runtime to be ready after update
err = p.AwaitReady(ctx, depl.ProvisionID)
if err != nil {
s.Logger.Error("provisioner: failed awaiting runtime to be ready after update", zap.String("deployment_id", depl.ID), zap.String("provisioner", depl.Provisioner), zap.String("provision_id", depl.ProvisionID), zap.Error(err), observability.ZapCtx(ctx))
// Mark deployment error
_, err2 := s.DB.UpdateDeploymentStatus(ctx, depl.ID, database.DeploymentStatusError, err.Error())
return multierr.Combine(err, err2)
}
// Update the deployment runtime version
_, err = s.DB.UpdateDeploymentRuntimeVersion(ctx, depl.ID, opts.Version)
if err != nil {
// NOTE: If the update was triggered by a scheduled job like 'upgrade_latest_version_projects',
// then this error will cause the update to be retried on the next job invocation and it should eventually become consistent.
// TODO: Handle inconsistent state when a manually triggered update failed, where we can't rely on job retries.
return err
}
}
rt, err := s.openRuntimeClientForDeployment(depl)
if err != nil {
return err
}
defer rt.Close()
res, err := rt.GetInstance(ctx, &runtimev1.GetInstanceRequest{
InstanceId: depl.RuntimeInstanceID,
Sensitive: true,
})
if err != nil {
return err
}
connectors := res.Instance.Connectors
for _, c := range connectors {
if c.Name == "admin" {
if c.Config == nil {
c.Config = make(map[string]string)
}
c.Config["branch"] = opts.Branch
// Adding a nonce will cause the runtime to evict any currently open handle and open a new one.
if opts.EvictCachedRepo {
c.Config["nonce"] = time.Now().Format(time.RFC3339Nano)
}
}
}
_, err = rt.EditInstance(ctx, &runtimev1.EditInstanceRequest{
InstanceId: depl.RuntimeInstanceID,
Connectors: connectors,
Annotations: opts.Annotations.toMap(),
Variables: opts.Variables,
})
if err != nil {
return err
}
// Branch is the only property that's persisted on the Deployment
if opts.Branch != depl.Branch {
newDepl, err := s.DB.UpdateDeploymentBranch(ctx, depl.ID, opts.Branch)
if err != nil {
// TODO: Handle inconsistent state (instance updated successfully, but deployment did not update)
return err
}
depl.Branch = opts.Branch
depl.UpdatedOn = newDepl.UpdatedOn
}
return nil
}
// HibernateDeployments tears down unused deployments
func (s *Service) HibernateDeployments(ctx context.Context) error {
depls, err := s.DB.FindExpiredDeployments(ctx)
if err != nil {
return err
}
if len(depls) == 0 {
return nil
}
s.Logger.Info("hibernate: starting", zap.Int("deployments", len(depls)))
for _, depl := range depls {
proj, err := s.DB.FindProject(ctx, depl.ProjectID)
if err != nil {
s.Logger.Error("hibernate: find project error", zap.String("deployment_id", depl.ID), zap.Error(err), observability.ZapCtx(ctx))
continue
}
s.Logger.Info("hibernate: deleting deployment", zap.String("project_id", proj.ID), zap.String("deployment_id", depl.ID))
err = s.teardownDeployment(ctx, depl)
if err != nil {
s.Logger.Error("hibernate: teardown deployment error", zap.String("project_id", proj.ID), zap.String("deployment_id", depl.ID), zap.Error(err), observability.ZapCtx(ctx))
continue
}
// Update prod deployment on project
_, err = s.DB.UpdateProject(ctx, proj.ID, &database.UpdateProjectOptions{
Name: proj.Name,
Description: proj.Description,
Public: proj.Public,
Provisioner: proj.Provisioner,
GithubURL: proj.GithubURL,
GithubInstallationID: proj.GithubInstallationID,
ProdVersion: proj.ProdVersion,
ProdBranch: proj.ProdBranch,
ProdVariables: proj.ProdVariables,
ProdSlots: proj.ProdSlots,
ProdTTLSeconds: proj.ProdTTLSeconds,
ProdDeploymentID: nil,
Annotations: proj.Annotations,
})
if err != nil {
return err
}
}
s.Logger.Info("hibernate: completed", zap.Int("deployments", len(depls)))
return nil
}
func (s *Service) teardownDeployment(ctx context.Context, depl *database.Deployment) error {
// Delete the deployment
err := s.DB.DeleteDeployment(ctx, depl.ID)
if err != nil {
return err
}
// Connect to the deployment's runtime and delete the instance
rt, err := s.openRuntimeClientForDeployment(depl)
if err != nil {
s.Logger.Error("failed to open runtime client", zap.String("deployment_id", depl.ID), zap.String("runtime_instance_id", depl.RuntimeInstanceID), zap.Error(err), observability.ZapCtx(ctx))
} else {
defer rt.Close()
_, err = rt.DeleteInstance(ctx, &runtimev1.DeleteInstanceRequest{
InstanceId: depl.RuntimeInstanceID,
})
if err != nil {
s.Logger.Error("failed to delete instance", zap.String("deployment_id", depl.ID), zap.String("runtime_instance_id", depl.RuntimeInstanceID), zap.Error(err), observability.ZapCtx(ctx))
}
}
// Get provisioner and deprovision, skip if the provisioner is no longer defined in the provisioner set
p, ok := s.ProvisionerSet[depl.Provisioner]
if ok {
err = p.Deprovision(ctx, depl.ProvisionID)
if err != nil {
s.Logger.Error("provisioner: failed to deprovision", zap.String("deployment_id", depl.ID), zap.String("provisioner", depl.Provisioner), zap.String("provision_id", depl.ProvisionID), zap.Error(err), observability.ZapCtx(ctx))
}
} else {
s.Logger.Warn("provisioner: deprovisioning skipped, provisioner not found", zap.String("deployment_id", depl.ID), zap.String("provisioner", depl.Provisioner), zap.String("provision_id", depl.ProvisionID), zap.Error(err), observability.ZapCtx(ctx))
}
return nil
}
func (s *Service) openRuntimeClientForDeployment(d *database.Deployment) (*client.Client, error) {
return s.openRuntimeClient(d.RuntimeHost, d.RuntimeAudience)
}
func (s *Service) openRuntimeClient(host, audience string) (*client.Client, error) {
jwt, err := s.issuer.NewToken(auth.TokenOptions{
AudienceURL: audience,
TTL: time.Hour,
SystemPermissions: []auth.Permission{auth.ManageInstances, auth.ReadInstance, auth.EditInstance, auth.ReadObjects},
})
if err != nil {
return nil, err
}
rt, err := client.New(host, jwt)
if err != nil {
return nil, err
}
return rt, nil
}
type DeploymentAnnotations struct {
orgID string
orgName string
projID string
projName string
projAnnotations map[string]string
}
func (s *Service) NewDeploymentAnnotations(org *database.Organization, proj *database.Project) DeploymentAnnotations {
return DeploymentAnnotations{
orgID: org.ID,
orgName: org.Name,
projID: proj.ID,
projName: proj.Name,
projAnnotations: proj.Annotations,
}
}
func (s *Service) ResolveLatestRuntimeVersion() string {
if s.VersionNumber != "" {
return s.VersionNumber
}
if s.VersionCommit != "" {
return s.VersionCommit
}
return "latest"
}
func (s *Service) ValidateRuntimeVersion(ver string) error {
// Verify version is a valid SemVer, a full Git commit hash or 'latest'
if ver != "latest" {
_, err := version.NewVersion(ver)
if err != nil {
// Not a valid SemVer, try as a full commit hash
matched, err := regexp.MatchString(`\b([a-f0-9]{40})\b`, ver)
if err != nil {
return err
}
if !matched {
return fmt.Errorf("not a valid version %q", ver)
}
}
}
return nil
}
func (da *DeploymentAnnotations) toMap() map[string]string {
res := make(map[string]string, len(da.projAnnotations)+4)
for k, v := range da.projAnnotations {
res[k] = v
}
res["organization_id"] = da.orgID
res["organization_name"] = da.orgName
res["project_id"] = da.projID
res["project_name"] = da.projName
return res
}