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
package hostrelease
import (
"context"
"errors"
"fmt"
"log/slog"
"strings"
"sync"
metav1 "k8s.io/apimachinery/pkg/apis/meta/v1"
"github.com/johnandersen777/socialweb-computer-kcp/api/v1alpha1"
ctlruntime "github.com/johnandersen777/socialweb-computer-kcp/internal/controllers/runtime"
"github.com/johnandersen777/socialweb-computer-kcp/internal/hostlifecycle"
"github.com/johnandersen777/socialweb-computer-kcp/internal/kit/conds"
)
const (
Name = "hostrelease"
Export = "applications"
ObjectName = "host-release"
ConditionReady = "Ready"
ConditionCurrent = "Current"
ConditionSelfCheck = "SelfCheck"
ConditionGC = "GC"
authorityUnreadable = "the host authority could not be read; the controller retries"
)
type Options struct {
Log *slog.Logger
Authority hostlifecycle.Authority
Scope func(workspace string) bool
Changed <-chan struct{}
}
type Controller struct {
log *slog.Logger
authority hostlifecycle.Authority
mu sync.Mutex
known map[ctlruntime.Request]struct{}
}
func Register(m *ctlruntime.Manager, opts Options) (*Controller, error) {
if opts.Authority == nil {
return nil, errors.New("hostrelease: an authority is required")
}
log := opts.Log
if log == nil {
log = slog.New(slog.DiscardHandler)
}
c := &Controller{log: log.With("component", Name+"-controller"), authority: opts.Authority, known: map[ctlruntime.Request]struct{}{}}
options := []ctlruntime.Option{ctlruntime.Export(Export), ctlruntime.Gone(c.gone)}
if opts.Scope != nil {
options = append(options, ctlruntime.InWorkspaces(opts.Scope))
}
if opts.Changed != nil {
events, err := ctlruntime.Forward(m, Name+": changes", opts.Changed, c.forwarded)
if err != nil {
return nil, fmt.Errorf("hostrelease: forwarding changes: %w", err)
}
options = append(options, ctlruntime.Events(events))
}
if err := ctlruntime.For[*v1alpha1.HostRelease](m, Name, c, options...); err != nil {
return nil, err
}
return c, nil
}
func Desired(ctx context.Context, a hostlifecycle.Authority) (*v1alpha1.HostRelease, error) {
obj := &v1alpha1.HostRelease{ObjectMeta: metav1.ObjectMeta{Name: ObjectName}}
obs, err := a.ObserveHostRelease(ctx, v1alpha1.HostReleaseSpec{})
obj.Spec.Version = obs.Current
return obj, err
}
func (c *Controller) forwarded(struct{}) []ctlruntime.Request {
return c.requests()
}
func (c *Controller) requests() []ctlruntime.Request {
c.mu.Lock()
defer c.mu.Unlock()
out := make([]ctlruntime.Request, 0, len(c.known))
for r := range c.known {
out = append(out, r)
}
return out
}
func (c *Controller) gone(_ context.Context, req ctlruntime.Request) {
c.mu.Lock()
defer c.mu.Unlock()
delete(c.known, ctlruntime.Request{Cluster: req.Cluster, Name: req.Name})
}
func (c *Controller) Reconcile(ctx context.Context, req ctlruntime.Request, obj *v1alpha1.HostRelease) (ctlruntime.Result, error) {
if !obj.DeletionTimestamp.IsZero() {
c.gone(ctx, req)
return ctlruntime.Result{}, nil
}
c.mu.Lock()
c.known[ctlruntime.Request{Cluster: req.Cluster, Name: req.Name}] = struct{}{}
c.mu.Unlock()
spec := obj.Spec
generation := obj.Generation
obs, err := c.authority.ObserveHostRelease(ctx, spec)
status := v1alpha1.HostReleaseStatus{ObservedGeneration: generation, Current: obs.Current, Previous: obs.Previous,
SelfCheck: obs.SelfCheck, GC: obs.GC, Conditions: obj.Status.Conditions}
if err != nil {
c.log.Warn("reading the host release authority", "name", obj.Name, "err", err.Error())
for _, kind := range []string{ConditionCurrent, ConditionSelfCheck, ConditionGC} {
conds.SetStatus(&status.Conditions, generation, kind, metav1.ConditionUnknown, "AuthorityUnreadable", authorityUnreadable)
}
conds.SetStatus(&status.Conditions, generation, ConditionReady, metav1.ConditionFalse, "AuthorityUnreadable", authorityUnreadable)
return ctlruntime.Result{}, errors.Join(c.apply(ctx, req, obj, status), err)
}
matches := spec.Version == "" || obs.Current == spec.Version
ready := obs.Current != "" && matches
msg := message(obs, ready, matches)
conds.SetStatus(&status.Conditions, generation, ConditionReady, conds.Status(ready), boolReason(ready, "Current", "NotCurrent"), msg)
conds.SetStatus(&status.Conditions, generation, ConditionCurrent, conds.Status(ready), boolReason(ready, "MatchesSpec", "DiffersFromSpec"), msg)
value, reason, selfMessage := selfCheckCondition(obs.SelfCheck)
conds.SetStatus(&status.Conditions, generation, ConditionSelfCheck, value, reason, selfMessage)
gcValue, gcReason, gcMessage := gcCondition(obs.GC)
conds.SetStatus(&status.Conditions, generation, ConditionGC, gcValue, gcReason, gcMessage)
return ctlruntime.Result{}, c.apply(ctx, req, obj, status)
}
func (c *Controller) apply(ctx context.Context, req ctlruntime.Request, obj *v1alpha1.HostRelease, status v1alpha1.HostReleaseStatus) error {
next := obj.DeepCopy()
next.Status = status
return req.ApplyStatus(ctx, next)
}
func message(obs hostlifecycle.HostReleaseObservation, ready, matches bool) string {
switch {
case obs.Current == "":
return "the current release is not known"
case !matches:
return fmt.Sprintf("the requested version is not current; the current version is %s", obs.Current)
case ready:
return fmt.Sprintf("version %s is current", obs.Current)
default:
return "the host release is not ready"
}
}
func selfCheckCondition(sc *v1alpha1.HostReleaseSelfCheck) (metav1.ConditionStatus, string, string) {
if sc == nil {
return metav1.ConditionUnknown, "NoSelfCheck", "no self-check report has been recorded"
}
switch strings.ToLower(strings.TrimSpace(sc.Phase)) {
case "ok", "pass", "passed", "ready", "succeeded", "success", "healthy":
return metav1.ConditionTrue, "SelfCheckPassed", "the self-check passed"
case "", "pending", "running", "queued":
return metav1.ConditionUnknown, "SelfCheckPending", "the self-check has not finished"
default:
return metav1.ConditionFalse, "SelfCheckFailed", "the self-check reported phase " + sc.Phase
}
}
func gcCondition(gc *v1alpha1.HostReleaseGC) (metav1.ConditionStatus, string, string) {
if gc == nil {
return metav1.ConditionUnknown, "NoGC", "no GC report has been recorded"
}
return metav1.ConditionTrue, "Collected", fmt.Sprintf("GC kept %d and removed %d", gc.Kept, len(gc.Removed))
}
func boolReason(value bool, yes, no string) string {
if value {
return yes
}
return no
}