config

Documentation

Index

• Constants
• func ConfigureConcurrencyLimits()
• func ConfigureLogging()
• func ConfigurePrometheus()
• func ConfigureRuby() error
• func ConfigureSentry(version string)
• func Load(file io.Reader) error
• func RegisterHook(f func(c Cfg) error)
• func SetGitPath() error
• func Validate() error
• type Cfg
  • func (c Cfg) Storage(storageName string) (Storage, bool)
  • func (c Cfg) StoragePath(storageName string) (string, bool)
• type Concurrency
• type Git
• type GitlabShell
• type Logging
• type Prometheus
• type Ruby
• type Storage
• type TLS

Constants

const (
	// EnvPidFile is the name of the environment variable containing the pid file path
	EnvPidFile = "GITALY_PID_FILE"
	// EnvUpgradesEnabled is an environment variable that when defined gitaly must enable graceful upgrades on SIGHUP
	EnvUpgradesEnabled = "GITALY_UPGRADES_ENABLED"
)

Functions

func ConfigureConcurrencyLimits

func ConfigureConcurrencyLimits()

ConfigureConcurrencyLimits configures the per-repo, per RPC rate limits

func ConfigureLogging

func ConfigureLogging()

ConfigureLogging uses the global conf and environmental vars to configure log levels and format

func ConfigurePrometheus

func ConfigurePrometheus()

ConfigurePrometheus uses the global configuration to configure prometheus

func ConfigureRuby

func ConfigureRuby() error

ConfigureRuby validates the gitaly-ruby configuration and sets default values.

func ConfigureSentry

func ConfigureSentry(version string)

ConfigureSentry configures the sentry DSN

func Load

func Load(file io.Reader) error

Load initializes the Config variable from file and the environment.

Environment variables take precedence over the file.

func RegisterHook

func RegisterHook(f func(c Cfg) error)

RegisterHook adds a post-validation callback. Your hook should only access config via the Cfg instance it gets passed. This avoids race conditions during testing, when the global config.Config instance gets updated after these hooks have run.

func SetGitPath

func SetGitPath() error

SetGitPath populates the variable GitPath with the path to the `git` executable. It warns if no path was specified in the configuration.

func Validate

func Validate() error

Validate checks the current Config for sanity. It also runs all hooks registered with RegisterHook.

Types

type Cfg

type Cfg struct {
	SocketPath                 string        `toml:"socket_path" split_words:"true"`
	ListenAddr                 string        `toml:"listen_addr" split_words:"true"`
	TLSListenAddr              string        `toml:"tls_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.Config   `toml:"auth"`
	TLS                        TLS           `toml:"tls"`
	Ruby                       Ruby          `toml:"gitaly-ruby"`
	GitlabShell                GitlabShell   `toml:"gitlab-shell"`
	Concurrency                []Concurrency `toml:"concurrency"`
	GracefulRestartTimeout     time.Duration
	GracefulRestartTimeoutToml duration `toml:"graceful_restart_timeout"`
}

Cfg is a container for all config derived from config.toml.

var (
	// Config stores the global configuration
	Config Cfg
)

func (Cfg) Storage

func (c Cfg) Storage(storageName string) (Storage, bool)

Storage looks up storageName.

func (Cfg) StoragePath

func (c Cfg) StoragePath(storageName string) (string, bool)

StoragePath looks up the base path for storageName. The second boolean return value indicates if anything was found.

type Concurrency

type Concurrency struct {
	RPC        string `toml:"rpc"`
	MaxPerRepo int    `toml:"max_per_repo"`
}

Concurrency allows endpoints to be limited to a maximum concurrency per repo

type Git

type Git struct {
	BinPath string `toml:"bin_path"`

	// ProtocolV2Enabled can be set to true to enable the newer Git protocol
	// version. This should not be enabled until GitLab *either* stops
	// using transfer.hideRefs for security purposes, *or* Git protocol v2
	// respects this setting:
	//
	// https://public-inbox.org/git/20181213155817.27666-1-avarab@gmail.com/T/
	//
	// This is not user-configurable. Once a new Git version has been released,
	// we can add code to enable it if the detected git binary is new enough
	ProtocolV2Enabled bool

	CatfileCacheSize int `toml:"catfile_cache_size"`
}

Git contains the settings for the Git executable

type GitlabShell

type GitlabShell struct {
	Dir string `toml:"dir"`
}

GitlabShell contains the settings required for executing `gitlab-shell`

type Logging

type Logging struct {
	Dir               string `toml:"dir"`
	Format            string `toml:"format"`
	SentryDSN         string `toml:"sentry_dsn"`
	RubySentryDSN     string `toml:"ruby_sentry_dsn"`
	SentryEnvironment string `toml:"sentry_environment"`
	Level             string `toml:"level"`
}

Logging contains the logging configuration for Gitaly

type Prometheus

type Prometheus struct {
	GRPCLatencyBuckets []float64 `toml:"grpc_latency_buckets"`
}

Prometheus contains additional configuration data for prometheus

type Ruby

type Ruby struct {
	Dir                        string `toml:"dir"`
	MaxRSS                     int    `toml:"max_rss"`
	GracefulRestartTimeout     time.Duration
	GracefulRestartTimeoutToml duration `toml:"graceful_restart_timeout"`
	RestartDelay               time.Duration
	RestartDelayToml           duration `toml:"restart_delay"`
	NumWorkers                 int      `toml:"num_workers"`
	LinguistLanguagesPath      string   `toml:"linguist_languages_path"`
	RuggedGitConfigSearchPath  string   `toml:"rugged_git_config_search_path"`
}

Ruby contains setting for Ruby worker processes

type Storage

type Storage struct {
	Name string
	Path string
}

Storage contains a single storage-shard

type TLS

type TLS struct {
	CertPath string `toml:"certificate_path"`
	KeyPath  string `toml:"key_path"`
}

TLS configuration