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
|
package config
import (
"fmt"
"io"
"os"
"os/exec"
"path/filepath"
"strings"
log "github.com/sirupsen/logrus"
"github.com/BurntSushi/toml"
"github.com/kelseyhightower/envconfig"
)
var (
// Config stores the global configuration
Config config
)
type config struct {
SocketPath string `toml:"socket_path" split_words:"true"`
ListenAddr string `toml:"listen_addr" split_words:"true"`
PrometheusListenAddr string `toml:"prometheus_listen_addr" split_words:"true"`
BinDir string `toml:"bin_dir"`
Git Git `toml:"git" envconfig:"git"`
Storages []Storage `toml:"storage" envconfig:"storage"`
Logging Logging `toml:"logging" envconfig:"logging"`
Prometheus Prometheus `toml:"prometheus"`
Auth Auth `toml:"auth"`
Ruby Ruby `toml:"gitaly-ruby"`
GitlabShell GitlabShell `toml:"gitlab-shell"`
Concurrency []Concurrency `toml:"concurrency"`
}
// GitlabShell contains the settings required for executing `gitlab-shell`
type GitlabShell struct {
Dir string `toml:"dir"`
}
// Git contains the settings for the Git executable
type Git struct {
BinPath string `toml:"bin_path"`
}
// Storage contains a single storage-shard
type Storage struct {
Name string
Path string
}
// Logging contains the logging configuration for Gitaly
type Logging struct {
Format string
SentryDSN string `toml:"sentry_dsn"`
RubySentryDSN string `toml:"ruby_sentry_dsn"`
Level string `toml:"level"`
}
// Prometheus contains additional configuration data for prometheus
type Prometheus struct {
GRPCLatencyBuckets []float64 `toml:"grpc_latency_buckets"`
}
// Concurrency allows endpoints to be limited to a maximum concurrency per repo
type Concurrency struct {
RPC string `toml:"rpc"`
MaxPerRepo int `toml:"max_per_repo"`
}
// Load initializes the Config variable from file and the environment.
// Environment variables take precedence over the file.
func Load(file io.Reader) error {
Config = config{}
if _, err := toml.DecodeReader(file, &Config); err != nil {
return fmt.Errorf("load toml: %v", err)
}
if err := envconfig.Process("gitaly", &Config); err != nil {
return fmt.Errorf("envconfig: %v", err)
}
return nil
}
// Validate checks the current Config for sanity.
func Validate() error {
for _, err := range []error{
validateListeners(),
validateStorages(),
validateToken(),
SetGitPath(),
validateShell(),
ConfigureRuby(),
validateBinDir(),
} {
if err != nil {
return err
}
}
return nil
}
func validateListeners() error {
if len(Config.SocketPath) == 0 && len(Config.ListenAddr) == 0 {
return fmt.Errorf("invalid listener config: at least one of socket_path and listen_addr must be set")
}
return nil
}
func validateShell() error {
if len(Config.GitlabShell.Dir) == 0 {
return fmt.Errorf("gitlab-shell.dir is not set")
}
return validateIsDirectory(Config.GitlabShell.Dir, "gitlab-shell.dir")
}
func validateIsDirectory(path, name string) error {
s, err := os.Stat(path)
if err != nil {
return err
}
if !s.IsDir() {
return fmt.Errorf("not a directory: %q", path)
}
log.WithField("dir", path).
Debugf("%s set", name)
return nil
}
func validateStorages() error {
if len(Config.Storages) == 0 {
return fmt.Errorf("no storage configurations found. Are you using the right format? https://gitlab.com/gitlab-org/gitaly/issues/397")
}
for i, storage := range Config.Storages {
if storage.Name == "" {
return fmt.Errorf("empty storage name in %v", storage)
}
if storage.Path == "" {
return fmt.Errorf("empty storage path in %v", storage)
}
stPath := filepath.Clean(storage.Path)
for j := 0; j < i; j++ {
other := Config.Storages[j]
if other.Name == storage.Name {
return fmt.Errorf("storage %q is defined more than once", storage.Name)
}
otherPath := filepath.Clean(other.Path)
if stPath == otherPath {
// This is weird but we allow it for legacy gitlab.com reasons.
continue
}
if strings.HasPrefix(stPath, otherPath) || strings.HasPrefix(otherPath, stPath) {
return fmt.Errorf("storage paths may not nest: %q and %q", storage.Name, storage.Name)
}
}
}
return nil
}
// SetGitPath populates the variable GitPath with the path to the `git`
// executable. It warns if no path was specified in the configuration.
func SetGitPath() error {
if Config.Git.BinPath != "" {
return nil
}
resolvedPath, err := exec.LookPath("git")
if err != nil {
return err
}
log.WithFields(log.Fields{
"resolvedPath": resolvedPath,
}).Warn("git path not configured. Using default path resolution")
Config.Git.BinPath = resolvedPath
return nil
}
// StoragePath looks up the base path for storageName. The second boolean
// return value indicates if anything was found.
func StoragePath(storageName string) (string, bool) {
for _, storage := range Config.Storages {
if storage.Name == storageName {
return storage.Path, true
}
}
return "", false
}
func validateBinDir() error {
if err := validateIsDirectory(Config.BinDir, "bin_dir"); err != nil {
log.WithError(err).Warn("Gitaly bin directory is not configured")
// TODO this must become a fatal error
return nil
}
var err error
Config.BinDir, err = filepath.Abs(Config.BinDir)
return err
}
|
