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
|
package scriptlet
import (
"context"
"errors"
"fmt"
"go.starlark.net/starlark"
"github.com/lxc/incus/v6/internal/server/cluster"
"github.com/lxc/incus/v6/internal/server/db"
dbCluster "github.com/lxc/incus/v6/internal/server/db/cluster"
internalInstance "github.com/lxc/incus/v6/internal/server/instance"
scriptletLoad "github.com/lxc/incus/v6/internal/server/scriptlet/load"
"github.com/lxc/incus/v6/internal/server/scriptlet/log"
"github.com/lxc/incus/v6/internal/server/state"
"github.com/lxc/incus/v6/shared/api"
apiScriptlet "github.com/lxc/incus/v6/shared/api/scriptlet"
"github.com/lxc/incus/v6/shared/logger"
"github.com/lxc/incus/v6/shared/resources"
"github.com/lxc/incus/v6/shared/scriptlet"
)
// InstancePlacementRun runs the instance placement scriptlet and returns the chosen cluster member target.
func InstancePlacementRun(ctx context.Context, l logger.Logger, s *state.State, req *apiScriptlet.InstancePlacement, candidateMembers []db.NodeInfo, leaderAddress string) (*db.NodeInfo, error) {
ctx, cancel := context.WithCancel(ctx)
defer cancel()
logFunc := log.CreateLogger(l, "Instance placement scriptlet")
var targetMember *db.NodeInfo
setTargetFunc := func(thread *starlark.Thread, b *starlark.Builtin, args starlark.Tuple, kwargs []starlark.Tuple) (starlark.Value, error) {
var memberName string
err := starlark.UnpackArgs(b.Name(), args, kwargs, "member_name", &memberName)
if err != nil {
return nil, err
}
for i := range candidateMembers {
if candidateMembers[i].Name == memberName {
targetMember = &candidateMembers[i]
break
}
}
if targetMember == nil {
l.Error("Instance placement scriptlet set invalid member target", logger.Ctx{"member": memberName})
return nil, fmt.Errorf("Invalid member name: %s", memberName)
}
l.Info("Instance placement scriptlet set member target", logger.Ctx{"member": targetMember.Name})
return starlark.None, nil
}
getClusterMemberResourcesFunc := func(thread *starlark.Thread, b *starlark.Builtin, args starlark.Tuple, kwargs []starlark.Tuple) (starlark.Value, error) {
var memberName string
err := starlark.UnpackArgs(b.Name(), args, kwargs, "member_name", &memberName)
if err != nil {
return nil, err
}
var res *api.Resources
// Get the local resource usage.
if memberName == s.ServerName {
res, err = resources.GetResources()
if err != nil {
return nil, err
}
} else {
// Get remote member resource usage.
var targetMember *db.NodeInfo
for i := range candidateMembers {
if candidateMembers[i].Name == memberName {
targetMember = &candidateMembers[i]
break
}
}
if targetMember == nil {
return nil, fmt.Errorf("Invalid member name: %s", memberName)
}
client, err := cluster.Connect(targetMember.Address, s.Endpoints.NetworkCert(), s.ServerCert(), nil, true)
if err != nil {
return nil, err
}
res, err = client.GetServerResources()
if err != nil {
return nil, err
}
}
rv, err := scriptlet.StarlarkMarshal(res)
if err != nil {
return nil, fmt.Errorf("Marshalling cluster member resources for %q failed: %w", memberName, err)
}
return rv, nil
}
getClusterMemberStateFunc := func(thread *starlark.Thread, b *starlark.Builtin, args starlark.Tuple, kwargs []starlark.Tuple) (starlark.Value, error) {
var memberName string
err := starlark.UnpackArgs(b.Name(), args, kwargs, "member_name", &memberName)
if err != nil {
return nil, err
}
var memberState *api.ClusterMemberState
// Get the local resource usage.
if memberName == s.ServerName {
memberState, err = cluster.MemberState(ctx, s, memberName)
if err != nil {
return nil, err
}
} else {
// Get remote member resource usage.
var targetMember *db.NodeInfo
for i := range candidateMembers {
if candidateMembers[i].Name == memberName {
targetMember = &candidateMembers[i]
break
}
}
if targetMember == nil {
return nil, fmt.Errorf("Invalid member name: %s", memberName)
}
client, err := cluster.Connect(targetMember.Address, s.Endpoints.NetworkCert(), s.ServerCert(), nil, true)
if err != nil {
return nil, err
}
memberState, _, err = client.GetClusterMemberState(memberName)
if err != nil {
return nil, err
}
}
rv, err := scriptlet.StarlarkMarshal(memberState)
if err != nil {
return nil, fmt.Errorf("Marshalling cluster member state for %q failed: %w", memberName, err)
}
return rv, nil
}
getInstanceResourcesFunc := func(thread *starlark.Thread, b *starlark.Builtin, args starlark.Tuple, kwargs []starlark.Tuple) (starlark.Value, error) {
var err error
var res apiScriptlet.InstanceResources
usageCPU, usageMemory, usageDisk, err := internalInstance.ResourceUsage(req.Config, req.Devices, req.Type)
if err != nil {
return nil, fmt.Errorf("Failed to calculate instance resource usage: %w", err)
}
res.CPUCores = uint64(usageCPU)
res.MemorySize = uint64(usageMemory)
res.RootDiskSize = uint64(usageDisk)
rv, err := scriptlet.StarlarkMarshal(res)
if err != nil {
return nil, fmt.Errorf("Marshalling instance resources failed: %w", err)
}
return rv, nil
}
getInstancesFunc := func(thread *starlark.Thread, b *starlark.Builtin, args starlark.Tuple, kwargs []starlark.Tuple) (starlark.Value, error) {
var project string
var location string
err := starlark.UnpackArgs(b.Name(), args, kwargs, "project??", &project, "location??", &location)
if err != nil {
return nil, err
}
instanceList := []api.Instance{}
err = s.DB.Cluster.Transaction(ctx, func(ctx context.Context, tx *db.ClusterTx) error {
var objects []dbCluster.Instance
if project != "" || location != "" {
// Prepare a filter.
filter := dbCluster.InstanceFilter{}
if project != "" {
filter.Project = &project
}
if location != "" {
filter.Node = &location
}
// Get instances based on Project and/or Location filters.
objects, err = dbCluster.GetInstances(ctx, tx.Tx(), filter)
if err != nil {
return err
}
} else {
// Get all instances.
objects, err = dbCluster.GetInstances(ctx, tx.Tx())
if err != nil {
return err
}
}
objectDevices, err := dbCluster.GetAllInstanceDevices(ctx, tx.Tx())
if err != nil {
return err
}
// Convert the []Instances into []api.Instances.
for _, obj := range objects {
instance, err := obj.ToAPI(ctx, tx.Tx(), objectDevices, nil, nil)
if err != nil {
return err
}
instanceList = append(instanceList, *instance)
}
return nil
})
if err != nil {
return nil, err
}
rv, err := scriptlet.StarlarkMarshal(instanceList)
if err != nil {
return nil, fmt.Errorf("Marshalling instances failed: %w", err)
}
return rv, nil
}
getInstancesCountFunc := func(thread *starlark.Thread, b *starlark.Builtin, args starlark.Tuple, kwargs []starlark.Tuple) (starlark.Value, error) {
var projectName string
var locationName string
var includePending bool
err := starlark.UnpackArgs(b.Name(), args, kwargs, "project??", &projectName, "location??", &locationName, "pending??", &includePending)
if err != nil {
return nil, err
}
var count int
err = s.DB.Cluster.Transaction(ctx, func(ctx context.Context, tx *db.ClusterTx) error {
count, err = tx.GetInstancesCount(ctx, projectName, locationName, includePending)
return err
})
if err != nil {
return nil, err
}
rv, err := scriptlet.StarlarkMarshal(count)
if err != nil {
return nil, fmt.Errorf("Marshalling instance count failed: %w", err)
}
return rv, nil
}
getClusterMembersFunc := func(thread *starlark.Thread, b *starlark.Builtin, args starlark.Tuple, kwargs []starlark.Tuple) (starlark.Value, error) {
var group string
var allMembers []db.NodeInfo
err := starlark.UnpackArgs(b.Name(), args, kwargs, "group??", &group)
if err != nil {
return nil, err
}
err = s.DB.Cluster.Transaction(ctx, func(ctx context.Context, tx *db.ClusterTx) error {
allMembers, err = tx.GetNodes(ctx)
if err != nil {
return err
}
allMembers, err = tx.GetCandidateMembers(ctx, allMembers, nil, group, nil, s.GlobalConfig.OfflineThreshold())
if err != nil {
return err
}
return nil
})
if err != nil {
return nil, err
}
var raftNodes []db.RaftNode
err = s.DB.Node.Transaction(ctx, func(ctx context.Context, tx *db.NodeTx) error {
raftNodes, err = tx.GetRaftNodes(ctx)
if err != nil {
return fmt.Errorf("Failed loading RAFT nodes: %w", err)
}
return nil
})
if err != nil {
return nil, err
}
allMembersInfo := make([]*api.ClusterMember, 0, len(allMembers))
err = s.DB.Cluster.Transaction(ctx, func(ctx context.Context, tx *db.ClusterTx) error {
failureDomains, err := tx.GetFailureDomainsNames(ctx)
if err != nil {
return fmt.Errorf("Failed loading failure domains names: %w", err)
}
memberFailureDomains, err := tx.GetNodesFailureDomains(ctx)
if err != nil {
return fmt.Errorf("Failed loading member failure domains: %w", err)
}
maxVersion, err := tx.GetNodeMaxVersion(ctx)
if err != nil {
return fmt.Errorf("Failed getting max member version: %w", err)
}
args := db.NodeInfoArgs{
LeaderAddress: leaderAddress,
FailureDomains: failureDomains,
MemberFailureDomains: memberFailureDomains,
OfflineThreshold: s.GlobalConfig.OfflineThreshold(),
MaxMemberVersion: maxVersion,
RaftNodes: raftNodes,
}
for i := range allMembers {
candidateMemberInfo, err := allMembers[i].ToAPI(ctx, tx, args)
if err != nil {
return err
}
allMembersInfo = append(allMembersInfo, candidateMemberInfo)
}
return nil
})
if err != nil {
return nil, err
}
rv, err := scriptlet.StarlarkMarshal(allMembersInfo)
if err != nil {
return nil, fmt.Errorf("Marshalling cluster members failed: %w", err)
}
return rv, nil
}
getProjectFunc := func(thread *starlark.Thread, b *starlark.Builtin, args starlark.Tuple, kwargs []starlark.Tuple) (starlark.Value, error) {
var name string
err := starlark.UnpackArgs(b.Name(), args, kwargs, "name??", &name)
if err != nil {
return nil, err
}
var p *api.Project
err = s.DB.Cluster.Transaction(ctx, func(ctx context.Context, tx *db.ClusterTx) error {
dbProject, err := dbCluster.GetProject(ctx, tx.Tx(), name)
if err != nil {
return err
}
p, err = dbProject.ToAPI(ctx, tx.Tx())
if err != nil {
return err
}
return nil
})
if err != nil {
return nil, err
}
rv, err := scriptlet.StarlarkMarshal(p)
if err != nil {
return nil, fmt.Errorf("Marshalling project failed: %w", err)
}
return rv, nil
}
var err error
var raftNodes []db.RaftNode
err = s.DB.Node.Transaction(ctx, func(ctx context.Context, tx *db.NodeTx) error {
raftNodes, err = tx.GetRaftNodes(ctx)
if err != nil {
return fmt.Errorf("Failed loading RAFT nodes: %w", err)
}
return nil
})
if err != nil {
return nil, err
}
candidateMembersInfo := make([]*api.ClusterMember, 0, len(candidateMembers))
err = s.DB.Cluster.Transaction(ctx, func(ctx context.Context, tx *db.ClusterTx) error {
failureDomains, err := tx.GetFailureDomainsNames(ctx)
if err != nil {
return fmt.Errorf("Failed loading failure domains names: %w", err)
}
memberFailureDomains, err := tx.GetNodesFailureDomains(ctx)
if err != nil {
return fmt.Errorf("Failed loading member failure domains: %w", err)
}
maxVersion, err := tx.GetNodeMaxVersion(ctx)
if err != nil {
return fmt.Errorf("Failed getting max member version: %w", err)
}
args := db.NodeInfoArgs{
LeaderAddress: leaderAddress,
FailureDomains: failureDomains,
MemberFailureDomains: memberFailureDomains,
OfflineThreshold: s.GlobalConfig.OfflineThreshold(),
MaxMemberVersion: maxVersion,
RaftNodes: raftNodes,
}
for i := range candidateMembers {
candidateMemberInfo, err := candidateMembers[i].ToAPI(ctx, tx, args)
if err != nil {
return err
}
candidateMembersInfo = append(candidateMembersInfo, candidateMemberInfo)
}
return nil
})
if err != nil {
return nil, err
}
// Remember to match the entries in scriptletLoad.InstancePlacementCompile() with this list so Starlark can
// perform compile time validation of functions used.
env := starlark.StringDict{
"log_info": starlark.NewBuiltin("log_info", logFunc),
"log_warn": starlark.NewBuiltin("log_warn", logFunc),
"log_error": starlark.NewBuiltin("log_error", logFunc),
"set_target": starlark.NewBuiltin("set_target", setTargetFunc),
"get_cluster_member_resources": starlark.NewBuiltin("get_cluster_member_resources", getClusterMemberResourcesFunc),
"get_cluster_member_state": starlark.NewBuiltin("get_cluster_member_state", getClusterMemberStateFunc),
"get_instance_resources": starlark.NewBuiltin("get_instance_resources", getInstanceResourcesFunc),
"get_instances": starlark.NewBuiltin("get_instances", getInstancesFunc),
"get_instances_count": starlark.NewBuiltin("get_instances_count", getInstancesCountFunc),
"get_cluster_members": starlark.NewBuiltin("get_cluster_members", getClusterMembersFunc),
"get_project": starlark.NewBuiltin("get_project", getProjectFunc),
}
prog, thread, err := scriptletLoad.InstancePlacementProgram()
if err != nil {
return nil, err
}
go func() {
<-ctx.Done()
thread.Cancel("Request finished")
}()
globals, err := prog.Init(thread, env)
if err != nil {
return nil, fmt.Errorf("Failed initializing: %w", err)
}
globals.Freeze()
// Retrieve a global variable from starlark environment.
instancePlacement := globals["instance_placement"]
if instancePlacement == nil {
return nil, errors.New("Scriptlet missing instance_placement function")
}
rv, err := scriptlet.StarlarkMarshal(req)
if err != nil {
return nil, fmt.Errorf("Marshalling request failed: %w", err)
}
candidateMembersv, err := scriptlet.StarlarkMarshal(candidateMembersInfo)
if err != nil {
return nil, fmt.Errorf("Marshalling candidate members failed: %w", err)
}
// Call starlark function from Go.
v, err := starlark.Call(thread, instancePlacement, nil, []starlark.Tuple{
{
starlark.String("request"),
rv,
}, {
starlark.String("candidate_members"),
candidateMembersv,
},
})
if err != nil {
return nil, fmt.Errorf("Failed to run: %w", err)
}
if v.Type() != "NoneType" {
return nil, fmt.Errorf("Failed with unexpected return value: %v", v)
}
return targetMember, nil
}
|