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 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235
|
package server
import (
"bytes"
"context"
"errors"
"fmt"
"path"
"gitlab.com/gitlab-org/cluster-integration/gitlab-agent/v16/internal/api"
"gitlab.com/gitlab-org/cluster-integration/gitlab-agent/v16/internal/gitaly"
"gitlab.com/gitlab-org/cluster-integration/gitlab-agent/v16/internal/gitlab"
gapi "gitlab.com/gitlab-org/cluster-integration/gitlab-agent/v16/internal/gitlab/api"
"gitlab.com/gitlab-org/cluster-integration/gitlab-agent/v16/internal/module/agent_configuration"
"gitlab.com/gitlab-org/cluster-integration/gitlab-agent/v16/internal/module/agent_configuration/rpc"
"gitlab.com/gitlab-org/cluster-integration/gitlab-agent/v16/internal/module/agent_tracker"
"gitlab.com/gitlab-org/cluster-integration/gitlab-agent/v16/internal/module/modserver"
"gitlab.com/gitlab-org/cluster-integration/gitlab-agent/v16/internal/tool/errz"
"gitlab.com/gitlab-org/cluster-integration/gitlab-agent/v16/internal/tool/logz"
"gitlab.com/gitlab-org/cluster-integration/gitlab-agent/v16/internal/tool/mathz"
"gitlab.com/gitlab-org/cluster-integration/gitlab-agent/v16/internal/tool/retry"
"gitlab.com/gitlab-org/cluster-integration/gitlab-agent/v16/internal/tool/syncz"
"gitlab.com/gitlab-org/cluster-integration/gitlab-agent/v16/pkg/agentcfg"
"go.uber.org/zap"
"google.golang.org/grpc/codes"
"google.golang.org/grpc/status"
"google.golang.org/protobuf/encoding/protojson"
"google.golang.org/protobuf/types/known/timestamppb"
"k8s.io/apimachinery/pkg/util/wait"
"sigs.k8s.io/yaml"
)
type server struct {
rpc.UnimplementedAgentConfigurationServer
serverApi modserver.Api
gitaly gitaly.PoolInterface
gitLabClient gitlab.ClientInterface
agentRegisterer agent_tracker.Registerer
maxConfigurationFileSize int64
getConfigurationPollConfig retry.PollConfigFactory
gitLabExternalUrl string
}
func (s *server) GetConfiguration(req *rpc.ConfigurationRequest, server rpc.AgentConfiguration_GetConfigurationServer) error {
connectedAgentInfo := &agent_tracker.ConnectedAgentInfo{
AgentMeta: req.AgentMeta,
ConnectedAt: timestamppb.Now(),
ConnectionId: mathz.Int63(),
}
ctx := server.Context()
rpcApi := modserver.AgentRpcApiFromContext(ctx)
log := rpcApi.Log()
defer s.maybeUnregisterAgent(log, rpcApi, connectedAgentInfo)
pollCfg := s.getConfigurationPollConfig()
wh := syncz.NewComparableWorkerHolder[string](
func(projectId string) syncz.Worker {
return syncz.WorkerFunc(func(ctx context.Context) {
s.serverApi.OnGitPushEvent(ctx, func(ctx context.Context, message *modserver.Project) {
// NOTE: yes, the req.ProjectId is NOT a project id, but a full project path ...
if message.FullPath == projectId {
pollCfg.Poke()
}
})
})
},
)
defer wh.StopAndWait()
lastProcessedCommitId := req.CommitId
return rpcApi.PollWithBackoff(pollCfg, func() (error, retry.AttemptResult) {
// This call is made on each poll because:
// - it checks that the agent's token is still valid
// - repository location in Gitaly might have changed
agentInfo, err := rpcApi.AgentInfo(ctx, log)
if err != nil {
if status.Code(err) == codes.Unavailable {
return nil, retry.Backoff
}
return err, retry.Done
}
wh.ApplyConfig(ctx, agentInfo.Repository.GlProjectPath)
// re-define log to avoid accidentally using the old one
log := log.With(logz.AgentId(agentInfo.Id), logz.ProjectId(agentInfo.Repository.GlProjectPath)) // nolint:govet
s.maybeRegisterAgent(ctx, log, rpcApi, connectedAgentInfo, agentInfo)
info, err := s.poll(ctx, agentInfo, lastProcessedCommitId)
if err != nil {
switch gitaly.ErrorCodeFromError(err) { // nolint:exhaustive
case gitaly.NotFound: // ref not found
return status.Errorf(codes.NotFound, "Config: repository poll failed: %v", err), retry.Done
default:
rpcApi.HandleProcessingError(log, agentInfo.Id, "Config: repository poll failed", err)
return nil, retry.Backoff
}
}
if info.EmptyRepository {
log.Debug("Config: empty repository")
return nil, retry.Continue
}
if !info.UpdateAvailable {
log.Debug("Config: no updates", logz.CommitId(lastProcessedCommitId))
return nil, retry.Continue
}
log.Info("Config: new commit", logz.CommitId(info.CommitId))
configFile, err := s.fetchConfiguration(ctx, agentInfo, info.CommitId)
if err != nil {
rpcApi.HandleProcessingError(log, agentInfo.Id, "Config: failed to fetch", err)
var ue errz.UserError
if errors.As(err, &ue) {
// return the error to the client because it's a user error
return status.Errorf(codes.FailedPrecondition, "Config: %v", err), retry.Done
}
return nil, retry.Backoff
}
var wg wait.Group
defer wg.Wait()
wg.Start(func() {
err := gapi.PostAgentConfiguration(ctx, s.gitLabClient, agentInfo.Id, configFile) // nolint:govet
switch {
case err == nil:
case gitlab.IsNotFound(err):
// Agent has been deleted from DB, but it's still running in the cluster. Don't need to send this error
// to Sentry.
log.Debug("Failed to notify GitLab of new agent configuration. Deleted agent?", logz.Error(err))
default:
rpcApi.HandleProcessingError(log, agentInfo.Id, "Failed to notify GitLab of new agent configuration", err)
}
})
err = s.sendConfigResponse(server, agentInfo, configFile, info.CommitId)
if err != nil {
return rpcApi.HandleIoError(log, "Config: failed to send config", err), retry.Done
}
lastProcessedCommitId = info.CommitId
return nil, retry.Continue
})
}
func (s *server) poll(ctx context.Context, agentInfo *api.AgentInfo, lastProcessedCommitId string) (*gitaly.PollInfo, error) {
p, err := s.gitaly.Poller(ctx, &agentInfo.GitalyInfo)
if err != nil {
return nil, err
}
return p.Poll(ctx, agentInfo.Repository, lastProcessedCommitId, "refs/heads/"+agentInfo.DefaultBranch)
}
func (s *server) sendConfigResponse(server rpc.AgentConfiguration_GetConfigurationServer,
agentInfo *api.AgentInfo, configFile *agentcfg.ConfigurationFile, commitId string) error {
return server.Send(&rpc.ConfigurationResponse{
Configuration: &agentcfg.AgentConfiguration{
Gitops: configFile.Gitops,
Observability: configFile.Observability,
AgentId: agentInfo.Id,
ProjectId: agentInfo.ProjectId,
ProjectPath: agentInfo.Repository.GlProjectPath,
CiAccess: configFile.CiAccess,
ContainerScanning: configFile.ContainerScanning,
RemoteDevelopment: configFile.RemoteDevelopment,
Flux: configFile.Flux,
GitlabExternalUrl: s.gitLabExternalUrl,
},
CommitId: commitId,
})
}
// fetchConfiguration fetches agent's configuration from a corresponding repository.
// Assumes configuration is stored in ".gitlab/agents/<agent id>/config.yaml" file.
// fetchConfiguration returns a wrapped context.Canceled, context.DeadlineExceeded or gRPC error if ctx signals done and interrupts a running gRPC call.
func (s *server) fetchConfiguration(ctx context.Context, agentInfo *api.AgentInfo, commitId string) (*agentcfg.ConfigurationFile, error) {
pf, err := s.gitaly.PathFetcher(ctx, &agentInfo.GitalyInfo)
if err != nil {
return nil, fmt.Errorf("PathFetcher: %w", err) // wrap
}
filename := path.Join(agent_configuration.Directory, agentInfo.Name, agent_configuration.FileName)
configYAML, err := pf.FetchFile(ctx, agentInfo.Repository, []byte(commitId), []byte(filename), s.maxConfigurationFileSize)
if err != nil {
switch gitaly.ErrorCodeFromError(err) { // nolint:exhaustive
case gitaly.NotFound:
configYAML = nil // Missing config is the same as empty config
case gitaly.FileTooBig, gitaly.UnexpectedTreeEntryType:
return nil, errz.NewUserErrorWithCause(err, "agent configuration file")
default:
return nil, fmt.Errorf("fetch agent configuration: %w", err) // wrap
}
}
configFile, err := parseYAMLToConfiguration(configYAML)
if err != nil {
return nil, errz.NewUserErrorWithCause(err, "failed to parse agent configuration")
}
err = configFile.ValidateAll()
if err != nil {
return nil, errz.NewUserErrorWithCause(err, "invalid agent configuration")
}
return configFile, nil
}
func (s *server) maybeRegisterAgent(ctx context.Context, log *zap.Logger, rpcApi modserver.AgentRpcApi,
connectedAgentInfo *agent_tracker.ConnectedAgentInfo, agentInfo *api.AgentInfo) {
if connectedAgentInfo.AgentId != 0 {
return
}
connectedAgentInfo.AgentId = agentInfo.Id
connectedAgentInfo.ProjectId = agentInfo.ProjectId
err := s.agentRegisterer.RegisterConnection(ctx, connectedAgentInfo)
if err != nil {
rpcApi.HandleProcessingError(log, agentInfo.Id, "Failed to register agent", err)
}
}
func (s *server) maybeUnregisterAgent(log *zap.Logger, rpcApi modserver.AgentRpcApi, connectedAgentInfo *agent_tracker.ConnectedAgentInfo) {
if connectedAgentInfo.AgentId == 0 {
return
}
err := s.agentRegisterer.UnregisterConnection(context.Background(), connectedAgentInfo)
if err != nil {
rpcApi.HandleProcessingError(log, connectedAgentInfo.AgentId, "Failed to unregister agent", err)
}
}
func parseYAMLToConfiguration(configYAML []byte) (*agentcfg.ConfigurationFile, error) {
configJSON, err := yaml.YAMLToJSON(configYAML)
if err != nil {
return nil, fmt.Errorf("YAMLToJSON: %w", err)
}
configFile := &agentcfg.ConfigurationFile{}
if bytes.Equal(configJSON, []byte("null")) {
// Empty config
return configFile, nil
}
err = protojson.Unmarshal(configJSON, configFile)
if err != nil {
return nil, fmt.Errorf("protojson.Unmarshal: %w", err)
}
return configFile, nil
}
|