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
|
package modserver
import (
"context"
"github.com/prometheus/client_golang/prometheus"
"github.com/redis/rueidis"
"gitlab.com/gitlab-org/cluster-integration/gitlab-agent/v16/internal/gitaly"
"gitlab.com/gitlab-org/cluster-integration/gitlab-agent/v16/internal/gitlab"
"gitlab.com/gitlab-org/cluster-integration/gitlab-agent/v16/internal/module/modshared"
"gitlab.com/gitlab-org/cluster-integration/gitlab-agent/v16/internal/module/observability"
"gitlab.com/gitlab-org/cluster-integration/gitlab-agent/v16/internal/module/usage_metrics"
"gitlab.com/gitlab-org/cluster-integration/gitlab-agent/v16/pkg/kascfg"
"go.opentelemetry.io/otel/metric"
"go.opentelemetry.io/otel/propagation"
"go.opentelemetry.io/otel/trace"
"go.uber.org/zap"
"google.golang.org/grpc"
)
const (
// RoutingHopPrefix is a metadata key prefix that is used for metadata keys that should be consumed by
// the gateway kas instances and not passed along to agentk.
RoutingHopPrefix = "kas-hop-"
// RoutingAgentIdMetadataKey is used to pass destination agent id in request metadata
// from the routing kas instance, that is handling the incoming request, to the gateway kas instance,
// that is forwarding the request to an agentk.
RoutingAgentIdMetadataKey = RoutingHopPrefix + "routing-agent-id"
RoutingFeaturePrefix = RoutingHopPrefix + "feat-"
RoutingFeatureNoTunnel = RoutingFeaturePrefix + "no-tun" // TODO remove somewhere in e.g. v16.5
// SentryFieldTraceId is the name of the Sentry field for trace ID.
SentryFieldTraceId = "trace_id"
SentryFieldTraceSampled = "trace_sampled"
GrpcServiceSentryField = "grpc.service"
GrpcMethodSentryField = "grpc.method"
)
// ApplyDefaults is a signature of a public function, exposed by modules to perform defaulting.
// The function should be called ApplyDefaults.
type ApplyDefaults func(*kascfg.ConfigurationFile)
// Config holds configuration for a Module.
type Config struct {
// Log can be used for logging from the module.
// It should not be used for logging from gRPC Api methods. Use grpctool.LoggerFromContext(ctx) instead.
Log *zap.Logger
Api Api
Config *kascfg.ConfigurationFile
GitLabClient gitlab.ClientInterface
// Registerer allows to register metrics.
// Metrics should be registered in Run and unregistered before Run returns.
Registerer prometheus.Registerer
UsageTracker usage_metrics.UsageTrackerRegisterer
// AgentServer is the gRPC server agentk is talking to.
// This can be used to add endpoints in Factory.New.
// Request handlers can obtain the per-request logger using grpctool.LoggerFromContext(requestContext).
AgentServer *grpc.Server
// ApiServer is the gRPC server GitLab is talking to.
// This can be used to add endpoints in Factory.New.
// Request handlers can obtain the per-request logger using grpctool.LoggerFromContext(requestContext).
ApiServer *grpc.Server
// RegisterAgentApi allows to register a gRPC Api endpoint that kas proxies to agentk.
RegisterAgentApi func(*grpc.ServiceDesc)
// AgentConn is a gRPC connection that can be used to send requests to an agentk instance.
// Agent Id must be specified in the request metadata in RoutingAgentIdMetadataKey field.
// Make sure factory returns modshared.ModuleStartAfterServers if module uses this connection.
AgentConn grpc.ClientConnInterface
Gitaly gitaly.PoolInterface
TraceProvider trace.TracerProvider
TracePropagator propagation.TextMapPropagator
MeterProvider metric.MeterProvider
RedisClient rueidis.Client
// KasName is a string "gitlab-kas". Can be used as a user agent, server name, service name, etc.
KasName string
// Version is gitlab-kas version.
Version string
// CommitId is gitlab-kas commit sha.
CommitId string
// ProbeRegistry is for registering liveness probes and readiness probes
ProbeRegistry *observability.ProbeRegistry
}
type GitPushEventCallback func(ctx context.Context, project *Project)
// Api provides the API for the module to use.
type Api interface {
modshared.Api
// OnGitPushEvent runs the given callback function for a received Git push event.
// The Git push event may come from any GitLab project and as such it's up to the
// callback to filter out the events that it's interested in.
// The callback MUST NOT block i.e. perform I/O or acquire contended locks. Perform those operations
// asynchronously in a separate goroutine when required.
OnGitPushEvent(ctx context.Context, callback GitPushEventCallback)
}
type Factory interface {
modshared.Factory
// New creates a new instance of a Module.
New(*Config) (Module, error)
}
type Module interface {
// Run starts the module.
// Run can block until the context is canceled or exit with nil if there is nothing to do.
Run(context.Context) error
// Name returns module's name.
Name() string
}
|
