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
|
package kasapp
import (
"context"
"crypto/tls"
"net"
"time"
"github.com/ash2k/stager"
grpc_validator "github.com/grpc-ecosystem/go-grpc-middleware/v2/interceptors/validator"
"github.com/prometheus/client_golang/prometheus"
"github.com/redis/rueidis"
"gitlab.com/gitlab-org/cluster-integration/gitlab-agent/v16/internal/module/modserver"
"gitlab.com/gitlab-org/cluster-integration/gitlab-agent/v16/internal/module/observability"
"gitlab.com/gitlab-org/cluster-integration/gitlab-agent/v16/internal/tool/grpctool"
"gitlab.com/gitlab-org/cluster-integration/gitlab-agent/v16/internal/tool/httpz"
"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/tlstool"
"gitlab.com/gitlab-org/cluster-integration/gitlab-agent/v16/internal/tool/wstunnel"
"gitlab.com/gitlab-org/cluster-integration/gitlab-agent/v16/pkg/kascfg"
"go.opentelemetry.io/contrib/instrumentation/google.golang.org/grpc/otelgrpc"
"go.opentelemetry.io/otel/propagation"
"go.opentelemetry.io/otel/trace"
"go.uber.org/zap"
"google.golang.org/grpc"
"google.golang.org/grpc/credentials"
"google.golang.org/grpc/keepalive"
"google.golang.org/grpc/stats"
)
const (
defaultMaxMessageSize = 10 * 1024 * 1024
agentConnectionRateExceededMetricName = "agent_server_rate_exceeded_total"
)
type agentServer struct {
log *zap.Logger
listenCfg *kascfg.ListenAgentCF
tlsConfig *tls.Config
server *grpc.Server
auxCancel context.CancelFunc
ready func()
}
func newAgentServer(log *zap.Logger, cfg *kascfg.ConfigurationFile, tp trace.TracerProvider,
redisClient rueidis.Client, ssh stats.Handler, factory modserver.AgentRpcApiFactory,
probeRegistry *observability.ProbeRegistry, reg *prometheus.Registry, streamProm grpc.StreamServerInterceptor,
unaryProm grpc.UnaryServerInterceptor) (*agentServer, error) {
listenCfg := cfg.Agent.Listen
tlsConfig, err := tlstool.MaybeDefaultServerTLSConfig(listenCfg.CertificateFile, listenCfg.KeyFile)
if err != nil {
return nil, err
}
rateExceededCounter := prometheus.NewCounter(prometheus.CounterOpts{
Name: agentConnectionRateExceededMetricName,
Help: "The total number of times configured rate limit of new agent connections was exceeded",
})
err = reg.Register(rateExceededCounter)
if err != nil {
return nil, err
}
agentConnectionLimiter := redistool.NewTokenLimiter(
redisClient,
cfg.Redis.KeyPrefix+":agent_limit",
uint64(listenCfg.ConnectionsPerTokenPerMinute),
rateExceededCounter,
func(ctx context.Context) redistool.RpcApi {
return &tokenLimiterApi{
rpcApi: modserver.AgentRpcApiFromContext(ctx),
}
},
)
auxCtx, auxCancel := context.WithCancel(context.Background())
traceContextProp := propagation.TraceContext{} // only want trace id, not baggage from external clients/agents
keepaliveOpt, sh := grpctool.MaxConnectionAge2GrpcKeepalive(auxCtx, listenCfg.MaxConnectionAge.AsDuration())
serverOpts := []grpc.ServerOption{
grpc.StatsHandler(ssh),
grpc.StatsHandler(sh),
grpc.ChainStreamInterceptor(
streamProm, // 1. measure all invocations
otelgrpc.StreamServerInterceptor(otelgrpc.WithTracerProvider(tp), otelgrpc.WithPropagators(traceContextProp)), // 2. trace
modserver.StreamAgentRpcApiInterceptor(factory), // 3. inject RPC API
grpc_validator.StreamServerInterceptor(), // x. wrap with validator
grpctool.StreamServerLimitingInterceptor(agentConnectionLimiter),
),
grpc.ChainUnaryInterceptor(
unaryProm, // 1. measure all invocations
otelgrpc.UnaryServerInterceptor(otelgrpc.WithTracerProvider(tp), otelgrpc.WithPropagators(traceContextProp)), // 2. trace
modserver.UnaryAgentRpcApiInterceptor(factory), // 3. inject RPC API
grpc_validator.UnaryServerInterceptor(), // x. wrap with validator
grpctool.UnaryServerLimitingInterceptor(agentConnectionLimiter),
),
grpc.KeepaliveEnforcementPolicy(keepalive.EnforcementPolicy{
MinTime: 20 * time.Second,
PermitWithoutStream: true,
}),
keepaliveOpt,
}
if !listenCfg.Websocket && tlsConfig != nil {
// If we are listening for WebSocket connections, gRPC server doesn't need TLS as it's handled by the
// HTTP/WebSocket server. Otherwise, we handle it here (if configured).
serverOpts = append(serverOpts, grpc.Creds(credentials.NewTLS(tlsConfig)))
}
return &agentServer{
log: log,
listenCfg: listenCfg,
tlsConfig: tlsConfig,
server: grpc.NewServer(serverOpts...),
auxCancel: auxCancel,
ready: probeRegistry.RegisterReadinessToggle("agentServer"),
}, nil
}
func (s *agentServer) Start(stage stager.Stage) {
grpctool.StartServer(stage, s.server, func() (net.Listener, error) {
var lis net.Listener
var err error
if s.listenCfg.Websocket { // Explicitly handle TLS for a WebSocket server
if s.tlsConfig != nil {
s.tlsConfig.NextProtos = []string{httpz.TLSNextProtoH2, httpz.TLSNextProtoH1} // h2 for gRPC, http/1.1 for WebSocket
lis, err = tls.Listen(*s.listenCfg.Network, s.listenCfg.Address, s.tlsConfig)
} else {
lis, err = net.Listen(*s.listenCfg.Network, s.listenCfg.Address)
}
if err != nil {
return nil, err
}
wsWrapper := wstunnel.ListenerWrapper{
// TODO set timeouts
ReadLimit: defaultMaxMessageSize,
ServerName: kasServerName(),
}
lis = wsWrapper.Wrap(lis, s.tlsConfig != nil)
} else {
lis, err = net.Listen(*s.listenCfg.Network, s.listenCfg.Address)
if err != nil {
return nil, err
}
}
addr := lis.Addr()
s.log.Info("Agentk API endpoint is up",
logz.NetNetworkFromAddr(addr),
logz.NetAddressFromAddr(addr),
logz.IsWebSocket(s.listenCfg.Websocket),
)
s.ready()
return lis, nil
}, func() {
time.Sleep(s.listenCfg.ListenGracePeriod.AsDuration())
s.auxCancel()
})
}
|
