refactor: embed ServiceSpecResolver into Deployment to handle spec only there

This commit is contained in:
Pavel Sviderski
2025-03-24 20:10:28 +10:00
parent 7a9d0cf9db
commit 3910101a88
17 changed files with 191 additions and 148 deletions
+2
View File
@@ -24,6 +24,8 @@ func CompareContainerToSpec(ctr api.Container, spec api.ServiceSpec) (ContainerS
}
// TODO: compare mutable properties such as memory or CPU limits when they are implemented.
// TODO: compare ports
return ContainerUpToDate, nil
}
+41 -17
View File
@@ -10,6 +10,7 @@ import (
type Client interface {
api.ContainerClient
api.DNSClient
api.MachineClient
api.ServiceClient
}
@@ -17,11 +18,12 @@ type Client interface {
// Deployment manages the process of creating or updating a service to match a desired state.
// It coordinates the validation, planning, and execution of deployment operations.
type Deployment struct {
Service *api.Service
Spec api.ServiceSpec
Strategy Strategy
cli Client
plan *Plan
Service *api.Service
Spec api.ServiceSpec
Strategy Strategy
cli Client
specResolver *ServiceSpecResolver
plan *Plan
}
type Plan struct {
@@ -38,16 +40,27 @@ var ErrNoMatchingMachines = errors.New("no machines match the filter")
// NewDeployment creates a new deployment for the given service specification.
// If strategy is nil, a default RollingStrategy will be used.
func NewDeployment(cli Client, spec api.ServiceSpec, strategy Strategy) *Deployment {
func NewDeployment(ctx context.Context, cli Client, spec api.ServiceSpec, strategy Strategy) (*Deployment, error) {
if strategy == nil {
strategy = &RollingStrategy{}
}
return &Deployment{
Spec: spec,
Strategy: strategy,
cli: cli,
clusterDomain, err := cli.GetDomain(ctx)
if err != nil && !errors.Is(err, api.ErrNotFound) {
return nil, fmt.Errorf("get cluster domain: %w", err)
}
specResolver := &ServiceSpecResolver{
// If the domain is not found (not reserved), an empty domain is used for the resolver.
ClusterDomain: clusterDomain,
}
return &Deployment{
Spec: spec,
Strategy: strategy,
cli: cli,
specResolver: specResolver,
}, nil
}
// Plan returns a plan of operations to reconcile the service to the desired state.
@@ -57,12 +70,17 @@ func (d *Deployment) Plan(ctx context.Context) (Plan, error) {
return *d.plan, nil
}
// Validate the new spec before planning.
// Validate the user-provided spec before resolving it.
if err := d.Validate(ctx); err != nil {
return Plan{}, fmt.Errorf("invalid deployment: %w", err)
}
plan, err := d.Strategy.Plan(ctx, d.cli, d.Service, d.Spec)
resolvedSpec, err := d.specResolver.Resolve(d.Spec)
if err != nil {
return Plan{}, fmt.Errorf("resolve service spec: %w", err)
}
plan, err := d.Strategy.Plan(ctx, d.cli, d.Service, resolvedSpec)
if err != nil {
return Plan{}, fmt.Errorf("create plan using %s strategy: %w", d.Strategy.Type(), err)
}
@@ -76,9 +94,6 @@ func (d *Deployment) Validate(ctx context.Context) error {
if err := d.Spec.Validate(); err != nil {
return fmt.Errorf("invalid service spec: %w", err)
}
if d.Spec.Name == "" {
return errors.New("service name is required")
}
if d.Service == nil {
svc, err := d.cli.InspectService(ctx, d.Spec.Name)
@@ -96,10 +111,19 @@ func (d *Deployment) Validate(ctx context.Context) error {
if d.Service.Name != d.Spec.Name {
return errors.New("service name cannot be changed")
}
if d.Service.Mode != d.Spec.Mode {
// Resolve the default mode if not specified.
mode := d.Spec.Mode
if mode == "" {
mode = api.ServiceModeReplicated
}
if mode != d.Service.Mode {
return errors.New("service mode cannot be changed")
}
if d.Spec.Mode == api.ServiceModeReplicated && d.Spec.Replicas < 1 {
if mode == api.ServiceModeReplicated && d.Spec.Replicas < 1 {
// Scaling down to zero is not allowed as this would effectively remove the service without preserving
// its configuration, making it impossible to scale back up.
return errors.New("number of replicas must be at least 1")
}
+8 -5
View File
@@ -19,11 +19,13 @@ type ServiceSpecResolver struct {
}
// Resolve transforms a service spec into its fully resolved form ready for deployment.
func (r *ServiceSpecResolver) Resolve(spec *api.ServiceSpec) error {
func (r *ServiceSpecResolver) Resolve(spec api.ServiceSpec) (api.ServiceSpec, error) {
if err := spec.Validate(); err != nil {
return fmt.Errorf("invalid service spec: %w", err)
return spec, fmt.Errorf("invalid service spec: %w", err)
}
spec = spec.Clone()
steps := []func(*api.ServiceSpec) error{
r.applyDefaults,
r.resolveServiceName,
@@ -32,12 +34,12 @@ func (r *ServiceSpecResolver) Resolve(spec *api.ServiceSpec) error {
}
for _, step := range steps {
if err := step(spec); err != nil {
return err
if err := step(&spec); err != nil {
return spec, err
}
}
return nil
return spec, nil
}
func (r *ServiceSpecResolver) applyDefaults(spec *api.ServiceSpec) error {
@@ -52,6 +54,7 @@ func (r *ServiceSpecResolver) applyDefaults(spec *api.ServiceSpec) error {
return nil
}
// resolveServiceName generates a service name from the image when not provided.
func (r *ServiceSpecResolver) resolveServiceName(spec *api.ServiceSpec) error {
if spec.Name != "" {
return nil