cgroups

Documentation

Index

• type CPU
• type Config
  • func (c *Config) FallbackToOldVersion()
  • func (c *Config) Validate() error
• type Memory
• type Repositories
  • func (r *Repositories) Validate(memBytes int64, cpuShares uint64, cpuQuotaUs int64) error

Types

type CPU

type CPU struct {
	Enabled bool `toml:"enabled"`
	// Shares is the number of CPU shares (relative weight (ratio) vs. other cgroups with CPU shares).
	Shares uint64 `toml:"shares"`
}

CPU is a struct storing cgroups CPU config Deprecated: Not in use after 15.0.

type Config

type Config struct {
	// Mountpoint is where the cgroup filesystem is mounted, usually under /sys/fs/cgroup/
	Mountpoint string `toml:"mountpoint"`
	// HierarchyRoot is the parent cgroup under which Gitaly creates <Count> of cgroups.
	// A system administrator is expected to create such cgroup/directory under <Mountpoint>/memory
	// and/or <Mountpoint>/cpu depending on which resource is enabled. HierarchyRoot is expected to
	// be owned by the user and group Gitaly runs as.
	HierarchyRoot string       `toml:"hierarchy_root"`
	Repositories  Repositories `toml:"repositories"`
	// MemoryBytes is the memory limit for the parent cgroup. 0 implies no memory limit.
	MemoryBytes int64 `toml:"memory_bytes"`
	// CPUShares are the shares of CPU the parent cgroup is allowed to utilize. A value of 1024
	// is full utilization of the CPU. 0 implies no CPU limit.
	CPUShares uint64 `toml:"cpu_shares"`
	// CPUQuotaUs sets cpu_quota_us for the parent cgroup
	// https://docs.kernel.org/scheduler/sched-bwc.html?highlight=cfs_period_us#management
	// below 0 implies no quota
	//
	// The cfs_period_us is hardcoded to 100ms
	CPUQuotaUs     int64 `toml:"cpu_quota_us"`
	MetricsEnabled bool  `toml:"metrics_enabled"`

	// Deprecated: No longer supported after 15.0
	Count  uint   `toml:"count"`
	CPU    CPU    `toml:"cpu"`
	Memory Memory `toml:"memory"`
}

Config is a struct for cgroups config

func (*Config) FallbackToOldVersion

func (c *Config) FallbackToOldVersion()

FallbackToOldVersion translates the old format of cgroups into the new format.

func (*Config) Validate

func (c *Config) Validate() error

Validate runs validation on all fields and compose all found errors.

type Memory

type Memory struct {
	Enabled bool `toml:"enabled"`
	// Limit is the memory limit in bytes. Could be -1 to indicate unlimited memory.
	Limit int64 `toml:"limit"`
}

Memory is a struct storing cgroups memory config Deprecated: Not in use after 15.0.

type Repositories

type Repositories struct {
	// Count is the number of cgroups that will be created for repository-level isolation
	// of git commands.
	Count uint `toml:"count"`
	// MaxCgroupsPerRepo specifies the maximum number of cgroups to which a single repository can allocate its
	// processes.
	// By default, a repository can spawn processes in at most one cgroups. If the number of repositories
	// is more than the number of cgroups (likely), multiple repositories share the same one. This model works very
	// well if the repositories under the management of Cgroup are equivalent in size or traffic. If a node has some
	// enormous repositories (mono-repo, for example), the scoping cgroups become excessively large comparing to the
	// rest. This imbalance situation might force the operators to lift the repository-level cgroups. As a result,
	// the isolation effect is not effective.
	// This config is designed to balance resource usage between cgroups, mitigate competition for resources
	// within a single cgroup, and enhance memory usage efficiency and isolation. The value can be adjusted based on
	// the specific workload and number of repository cgroups on the node.
	// A Git process uses its target repository's relative path as the hash key to find the corresponding cgroup. It
	// is allocated randomly to any of the consequent MaxCgroupsPerRepo cgroups. It wraps around if needed.
	//                repo-X
	//               ┌───────┐
	// □ □ □ □ □ □ □ ■ ■ ■ ■ ■ ■ ■ ■ □ □ □ □
	//                     └────────┘
	//                      repo-Y
	// The default value is "1".
	MaxCgroupsPerRepo uint `toml:"max_cgroups_per_repo"`
	// MemoryBytes is the memory limit for each cgroup. 0 implies no memory limit.
	MemoryBytes int64 `toml:"memory_bytes"`
	// CPUShares are the shares of CPU that each cgroup is allowed to utilize. A value of 1024
	// is full utilization of the CPU. 0 implies no CPU limit.
	CPUShares uint64 `toml:"cpu_shares"`
	// CPUQuotaUs sets the value of `cfs_quota_us` for the repository cgroup.
	// https://docs.kernel.org/scheduler/sched-bwc.html?highlight=cfs_period_us
	// Below 0 implies no quota
	//
	// The cfs_period_us is hardcoded to 100ms
	CPUQuotaUs int64 `toml:"cpu_quota_us"`
}

Repositories configures cgroups to be created that are isolated by repository.

func (*Repositories) Validate

func (r *Repositories) Validate(memBytes int64, cpuShares uint64, cpuQuotaUs int64) error

Validate runs validation on all fields and compose all found errors.