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
|
package kasapp
import (
"context"
"fmt"
"net"
"time"
"github.com/ash2k/stager"
grpc_validator "github.com/grpc-ecosystem/go-grpc-middleware/v2/interceptors/validator"
"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/errz"
"gitlab.com/gitlab-org/cluster-integration/gitlab-agent/v16/internal/tool/grpctool"
"gitlab.com/gitlab-org/cluster-integration/gitlab-agent/v16/internal/tool/ioz"
"gitlab.com/gitlab-org/cluster-integration/gitlab-agent/v16/internal/tool/logz"
"gitlab.com/gitlab-org/cluster-integration/gitlab-agent/v16/internal/tool/tlstool"
"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/credentials/insecure"
"google.golang.org/grpc/keepalive"
"google.golang.org/grpc/stats"
)
var (
_ grpc.ServiceRegistrar = (*privateApiServer)(nil)
)
type privateApiServer struct {
log *zap.Logger
listenCfg *kascfg.ListenPrivateApiCF
server *grpc.Server
inMemServer *grpc.Server
inMemListener net.Listener
kasPool grpctool.PoolInterface
auxCancel context.CancelFunc
ready func()
}
func newPrivateApiServer(log *zap.Logger, errRep errz.ErrReporter, cfg *kascfg.ConfigurationFile, tp trace.TracerProvider,
p propagation.TextMapPropagator, csh, ssh stats.Handler, factory modserver.RpcApiFactory,
ownPrivateApiUrl, ownPrivateApiHost string, probeRegistry *observability.ProbeRegistry,
streamProm grpc.StreamServerInterceptor, unaryProm grpc.UnaryServerInterceptor,
streamClientProm grpc.StreamClientInterceptor, unaryClientProm grpc.UnaryClientInterceptor) (*privateApiServer, error) {
listenCfg := cfg.PrivateApi.Listen
jwtSecret, err := ioz.LoadBase64Secret(listenCfg.AuthenticationSecretFile)
if err != nil {
return nil, fmt.Errorf("auth secret file: %w", err)
}
// In-memory gRPC client->listener pipe
listener := grpctool.NewDialListener()
// Client pool
kasPool, err := newKasPool(log, errRep, tp, p, csh, jwtSecret, ownPrivateApiUrl, ownPrivateApiHost,
listenCfg.CaCertificateFile, listener.DialContext, streamClientProm, unaryClientProm)
if err != nil {
return nil, fmt.Errorf("kas pool: %w", err)
}
// Server
auxCtx, auxCancel := context.WithCancel(context.Background()) // nolint: govet
server, inMemServer, err := newPrivateApiServerImpl(auxCtx, cfg, tp, p, ssh, jwtSecret, factory, ownPrivateApiHost, streamProm, unaryProm)
if err != nil {
return nil, fmt.Errorf("new server: %w", err) // nolint: govet
}
return &privateApiServer{
log: log,
listenCfg: listenCfg,
server: server,
inMemServer: inMemServer,
inMemListener: listener,
kasPool: kasPool,
auxCancel: auxCancel,
ready: probeRegistry.RegisterReadinessToggle("privateApiServer"),
}, nil
}
func (s *privateApiServer) Start(stage stager.Stage) {
stopInMem := make(chan struct{})
grpctool.StartServer(stage, s.inMemServer, func() (net.Listener, error) {
return s.inMemListener, nil
}, func() {
<-stopInMem
})
grpctool.StartServer(stage, s.server, func() (net.Listener, error) {
lis, err := net.Listen(*s.listenCfg.Network, s.listenCfg.Address)
if err != nil {
return nil, err
}
addr := lis.Addr()
s.log.Info("Private API endpoint is up",
logz.NetNetworkFromAddr(addr),
logz.NetAddressFromAddr(addr),
)
s.ready()
return lis, nil
}, func() {
time.Sleep(s.listenCfg.ListenGracePeriod.AsDuration())
close(stopInMem)
s.auxCancel()
})
}
// RegisterService should be used rather than directly registering on the field servers.
func (s *privateApiServer) RegisterService(desc *grpc.ServiceDesc, impl interface{}) {
s.server.RegisterService(desc, impl)
s.inMemServer.RegisterService(desc, impl)
}
func newPrivateApiServerImpl(auxCtx context.Context, cfg *kascfg.ConfigurationFile, tp trace.TracerProvider,
p propagation.TextMapPropagator, ssh stats.Handler, jwtSecret []byte, factory modserver.RpcApiFactory,
ownPrivateApiHost string, streamProm grpc.StreamServerInterceptor, unaryProm grpc.UnaryServerInterceptor) (*grpc.Server, *grpc.Server, error) {
listenCfg := cfg.PrivateApi.Listen
credsOpt, err := maybeTLSCreds(listenCfg.CertificateFile, listenCfg.KeyFile)
if err != nil {
return nil, nil, err
}
if ownPrivateApiHost == "" && len(credsOpt) > 0 {
return nil, nil, fmt.Errorf("%s environment variable is not set. Set it to the kas' host name if you want to use TLS for kas->kas communication", envVarOwnPrivateApiHost)
}
jwtAuther := grpctool.NewJWTAuther(jwtSecret, kasName, kasName, func(ctx context.Context) *zap.Logger {
return modserver.RpcApiFromContext(ctx).Log()
})
keepaliveOpt, sh := grpctool.MaxConnectionAge2GrpcKeepalive(auxCtx, listenCfg.MaxConnectionAge.AsDuration())
sharedOpts := []grpc.ServerOption{
keepaliveOpt,
grpc.StatsHandler(ssh),
grpc.StatsHandler(sh),
grpc.ChainStreamInterceptor(
streamProm, // 1. measure all invocations
otelgrpc.StreamServerInterceptor(otelgrpc.WithTracerProvider(tp), otelgrpc.WithPropagators(p)), // 2. trace
modserver.StreamRpcApiInterceptor(factory), // 3. inject RPC API
jwtAuther.StreamServerInterceptor, // 4. auth and maybe log
grpc_validator.StreamServerInterceptor(), // x. wrap with validator
),
grpc.ChainUnaryInterceptor(
unaryProm, // 1. measure all invocations
otelgrpc.UnaryServerInterceptor(otelgrpc.WithTracerProvider(tp), otelgrpc.WithPropagators(p)), // 2. trace
modserver.UnaryRpcApiInterceptor(factory), // 3. inject RPC API
jwtAuther.UnaryServerInterceptor, // 4. auth and maybe log
grpc_validator.UnaryServerInterceptor(), // x. wrap with validator
),
grpc.KeepaliveEnforcementPolicy(keepalive.EnforcementPolicy{
MinTime: 20 * time.Second,
PermitWithoutStream: true,
}),
grpc.ForceServerCodec(grpctool.RawCodecWithProtoFallback{}),
}
server := grpc.NewServer(append(credsOpt, sharedOpts...)...)
inMemServer := grpc.NewServer(sharedOpts...)
return server, inMemServer, nil
}
func newKasPool(log *zap.Logger, errRep errz.ErrReporter, tp trace.TracerProvider, p propagation.TextMapPropagator,
csh stats.Handler, jwtSecret []byte, ownPrivateApiUrl, ownPrivateApiHost, caCertificateFile string,
dialer func(context.Context, string) (net.Conn, error),
streamClientProm grpc.StreamClientInterceptor, unaryClientProm grpc.UnaryClientInterceptor) (grpctool.PoolInterface, error) {
sharedPoolOpts := []grpc.DialOption{
grpc.WithStatsHandler(csh),
grpc.WithUserAgent(kasServerName()),
grpc.WithKeepaliveParams(keepalive.ClientParameters{
Time: 55 * time.Second,
PermitWithoutStream: true,
}),
grpc.WithPerRPCCredentials(&grpctool.JwtCredentials{
Secret: jwtSecret,
Audience: kasName,
Issuer: kasName,
Insecure: true, // We may or may not have TLS setup, so always say creds don't need TLS.
}),
grpc.WithChainStreamInterceptor(
streamClientProm,
otelgrpc.StreamClientInterceptor(otelgrpc.WithTracerProvider(tp), otelgrpc.WithPropagators(p)),
grpctool.StreamClientValidatingInterceptor,
),
grpc.WithChainUnaryInterceptor(
unaryClientProm,
otelgrpc.UnaryClientInterceptor(otelgrpc.WithTracerProvider(tp), otelgrpc.WithPropagators(p)),
grpctool.UnaryClientValidatingInterceptor,
),
}
// Construct in-memory connection to private API gRPC server
inMemConn, err := grpc.DialContext(context.Background(), "pipe", // nolint: contextcheck
append([]grpc.DialOption{
grpc.WithContextDialer(dialer),
grpc.WithTransportCredentials(insecure.NewCredentials()),
}, sharedPoolOpts...)...,
)
if err != nil {
return nil, err
}
tlsCreds, err := tlstool.DefaultClientTLSConfigWithCACert(caCertificateFile)
if err != nil {
return nil, err
}
tlsCreds.ServerName = ownPrivateApiHost
kasPool := grpctool.NewPool(log, errRep, credentials.NewTLS(tlsCreds), sharedPoolOpts...)
return grpctool.NewPoolSelf(kasPool, ownPrivateApiUrl, inMemConn), nil
}
|
