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
|
package tracker
import (
"context"
"sync"
"time"
"github.com/redis/rueidis"
"gitlab.com/gitlab-org/cluster-integration/gitlab-agent/v16/internal/module/modshared"
"gitlab.com/gitlab-org/cluster-integration/gitlab-agent/v16/internal/tool/logz"
"gitlab.com/gitlab-org/cluster-integration/gitlab-agent/v16/internal/tool/redistool"
"gitlab.com/gitlab-org/cluster-integration/gitlab-agent/v16/internal/tool/syncz"
"go.uber.org/zap"
)
const (
refreshOverlap = 5 * time.Second
clearTimeout = 10 * time.Second
)
type KasUrlsByAgentIdCallback func(kasUrl string) (bool /* done */, error)
type Querier interface {
KasUrlsByAgentId(ctx context.Context, agentId int64, cb KasUrlsByAgentIdCallback) error
}
type Registerer interface {
// RegisterTunnel registers tunnel with the tracker.
RegisterTunnel(ctx context.Context, agentId int64) error
// UnregisterTunnel unregisters tunnel with the tracker.
UnregisterTunnel(ctx context.Context, agentId int64) error
}
type Tracker interface {
Registerer
Querier
Run(ctx context.Context) error
}
type RedisTracker struct {
log *zap.Logger
api modshared.Api
refreshPeriod time.Duration
gcPeriod time.Duration
ownPrivateApiUrl string
// mu protects fields below
mu sync.Mutex
tunnelsByAgentIdCount map[int64]uint16
tunnelsByAgentId redistool.ExpiringHashInterface[int64, string] // agentId -> kas URL -> nil
done bool
}
func NewRedisTracker(log *zap.Logger, api modshared.Api, client rueidis.Client, agentKeyPrefix string,
ttl, refreshPeriod, gcPeriod time.Duration, ownPrivateApiUrl string) *RedisTracker {
return &RedisTracker{
log: log,
api: api,
refreshPeriod: refreshPeriod,
gcPeriod: gcPeriod,
ownPrivateApiUrl: ownPrivateApiUrl,
tunnelsByAgentIdCount: make(map[int64]uint16),
tunnelsByAgentId: redistool.NewExpiringHash(client, tunnelsByAgentIdHashKey(agentKeyPrefix), strToStr, ttl),
}
}
func (t *RedisTracker) Run(ctx context.Context) error {
defer t.stop() // nolint: contextcheck
refreshTicker := time.NewTicker(t.refreshPeriod)
defer refreshTicker.Stop()
gcTicker := time.NewTicker(t.gcPeriod)
defer gcTicker.Stop()
done := ctx.Done()
for {
select {
case <-done:
return nil
case <-refreshTicker.C:
err := t.refreshRegistrations(ctx, time.Now().Add(t.refreshPeriod-refreshOverlap))
if err != nil {
t.api.HandleProcessingError(ctx, t.log, modshared.NoAgentId, "Failed to refresh data in Redis", err)
}
case <-gcTicker.C:
deletedKeys, err := t.runGC(ctx)
if err != nil {
t.api.HandleProcessingError(ctx, t.log, modshared.NoAgentId, "Failed to GC data in Redis", err)
// fallthrough
}
if deletedKeys > 0 {
t.log.Info("Deleted expired agent tunnel records", logz.RemovedHashKeys(deletedKeys))
}
}
}
}
func (t *RedisTracker) RegisterTunnel(ctx context.Context, agentId int64) error {
register := syncz.RunWithMutex(&t.mu, func() redistool.IOFunc {
if t.done {
return noopIO
}
cnt := t.tunnelsByAgentIdCount[agentId]
cnt++
t.tunnelsByAgentIdCount[agentId] = cnt
if cnt == 1 {
// First tunnel for this agentId
return t.tunnelsByAgentId.Set(agentId, t.ownPrivateApiUrl, nil)
} else {
return noopIO
}
})
return register(ctx)
}
func (t *RedisTracker) UnregisterTunnel(ctx context.Context, agentId int64) error {
unregister := syncz.RunWithMutex(&t.mu, func() redistool.IOFunc {
if t.done {
return noopIO
}
cnt := t.tunnelsByAgentIdCount[agentId]
cnt--
if cnt == 0 {
delete(t.tunnelsByAgentIdCount, agentId)
return t.tunnelsByAgentId.Unset(agentId, t.ownPrivateApiUrl)
} else {
t.tunnelsByAgentIdCount[agentId] = cnt
return noopIO
}
})
return unregister(ctx)
}
func (t *RedisTracker) KasUrlsByAgentId(ctx context.Context, agentId int64, cb KasUrlsByAgentIdCallback) error {
_, err := t.tunnelsByAgentId.Scan(ctx, agentId, func(rawHashKey string, value []byte, err error) (bool, error) {
if err != nil {
t.api.HandleProcessingError(ctx, t.log.With(logz.AgentId(agentId)), agentId, "Redis hash scan", err)
return false, nil
}
return cb(rawHashKey)
})
return err
}
func (t *RedisTracker) stop() {
t.mu.Lock()
defer t.mu.Unlock()
t.done = true
ctx, cancel := context.WithTimeout(context.Background(), clearTimeout)
defer cancel()
_, err := t.tunnelsByAgentId.Clear(ctx)
if err != nil {
t.api.HandleProcessingError(context.Background(), t.log, modshared.NoAgentId, "Failed to remove tunnel registrations", err)
}
}
func (t *RedisTracker) refreshRegistrations(ctx context.Context, nextRefresh time.Time) error {
refresh := syncz.RunWithMutex(&t.mu, func() redistool.IOFunc {
return t.tunnelsByAgentId.Refresh(nextRefresh)
})
return refresh(ctx)
}
func (t *RedisTracker) runGC(ctx context.Context) (int /* keysDeleted */, error) {
gc := syncz.RunWithMutex(&t.mu, func() func(ctx context.Context) (int /* keysDeleted */, error) {
return t.tunnelsByAgentId.GC()
})
return gc(ctx)
}
// tunnelsByAgentIdHashKey returns a key for agentId -> (kasUrl -> nil).
func tunnelsByAgentIdHashKey(agentKeyPrefix string) redistool.KeyToRedisKey[int64] {
prefix := agentKeyPrefix + ":kas_by_agent_id:"
return func(agentId int64) string {
return redistool.PrefixedInt64Key(prefix, agentId)
}
}
func strToStr(key string) string {
return key
}
func noopIO(ctx context.Context) error {
return nil
}
|
