config

Documentation

Index

• Variables
• func SaveRegistration(file string, reg *Registration) error
• type Cache
• type Config
  • func LoadDefault(file string) (*Config, error)
• type Container
• type Host
• type Log
• type Registration
  • func LoadRegistration(file string) (*Registration, error)
• type Runner

Variables

var Example []byte

Functions

func SaveRegistration

func SaveRegistration(file string, reg *Registration) error

Types

type Cache

type Cache struct {
	Enabled        *bool  `yaml:"enabled"`         // Enabled indicates whether caching is enabled. It is a pointer to distinguish between false and not set. If not set, it will be true.
	Dir            string `yaml:"dir"`             // Dir specifies the directory path for caching.
	Host           string `yaml:"host"`            // Host specifies the caching host.
	Port           uint16 `yaml:"port"`            // Port specifies the caching port.
	ExternalServer string `yaml:"external_server"` // ExternalServer specifies the URL of external cache server
}

Cache represents the configuration for caching.

type Config

type Config struct {
	Log       Log       `yaml:"log"`       // Log represents the configuration for logging.
	Runner    Runner    `yaml:"runner"`    // Runner represents the configuration for the runner.
	Cache     Cache     `yaml:"cache"`     // Cache represents the configuration for caching.
	Container Container `yaml:"container"` // Container represents the configuration for the container.
	Host      Host      `yaml:"host"`      // Host represents the configuration for the host.
}

Config represents the overall configuration.

func LoadDefault

func LoadDefault(file string) (*Config, error)

LoadDefault returns the default configuration. If file is not empty, it will be used to load the configuration.

type Container

type Container struct {
	Network       string   `yaml:"network"`        // Network specifies the network for the container.
	NetworkMode   string   `yaml:"network_mode"`   // Deprecated: use Network instead. Could be removed after Gitea 1.20
	Privileged    bool     `yaml:"privileged"`     // Privileged indicates whether the container runs in privileged mode.
	Options       string   `yaml:"options"`        // Options specifies additional options for the container.
	WorkdirParent string   `yaml:"workdir_parent"` // WorkdirParent specifies the parent directory for the container's working directory.
	ValidVolumes  []string `yaml:"valid_volumes"`  // ValidVolumes specifies the volumes (including bind mounts) can be mounted to containers.
	DockerHost    string   `yaml:"docker_host"`    // DockerHost specifies the Docker host. It overrides the value specified in environment variable DOCKER_HOST.
	ForcePull     bool     `yaml:"force_pull"`     // Pull docker image(s) even if already present
	ForceRebuild  bool     `yaml:"force_rebuild"`  // Rebuild docker image(s) even if already present
}

Container represents the configuration for the container.

type Host

type Host struct {
	WorkdirParent string `yaml:"workdir_parent"` // WorkdirParent specifies the parent directory for the host's working directory.
}

Host represents the configuration for the host.

type Log

type Log struct {
	Level string `yaml:"level"` // Level indicates the logging level.
}

Log represents the configuration for logging.

type Registration

type Registration struct {
	Warning string `json:"WARNING"` // Warning message to display, it's always the registrationWarning constant

	ID      int64    `json:"id"`
	UUID    string   `json:"uuid"`
	Name    string   `json:"name"`
	Token   string   `json:"token"`
	Address string   `json:"address"`
	Labels  []string `json:"labels"`
}

Registration is the registration information for a runner

func LoadRegistration

func LoadRegistration(file string) (*Registration, error)

type Runner

type Runner struct {
	File          string            `yaml:"file"`           // File specifies the file path for the runner.
	Capacity      int               `yaml:"capacity"`       // Capacity specifies the capacity of the runner.
	Envs          map[string]string `yaml:"envs"`           // Envs stores environment variables for the runner.
	EnvFile       string            `yaml:"env_file"`       // EnvFile specifies the path to the file containing environment variables for the runner.
	Timeout       time.Duration     `yaml:"timeout"`        // Timeout specifies the duration for runner timeout.
	Insecure      bool              `yaml:"insecure"`       // Insecure indicates whether the runner operates in an insecure mode.
	FetchTimeout  time.Duration     `yaml:"fetch_timeout"`  // FetchTimeout specifies the timeout duration for fetching resources.
	FetchInterval time.Duration     `yaml:"fetch_interval"` // FetchInterval specifies the interval duration for fetching resources.
	Labels        []string          `yaml:"labels"`         // Labels specify the labels of the runner. Labels are declared on each startup
}

Runner represents the configuration for the runner.