Struct Pool

params/params.go:467–522

swagger:model Pool

// swagger:model Pool
type Pool struct {
	RunnerPrefix

	ID             string              `json:"id,omitempty"`
	ProviderName   string              `json:"provider_name,omitempty"`
	MaxRunners     uint                `json:"max_runners,omitempty"`
	MinIdleRunners uint                `json:"min_idle_runners,omitempty"`
	Image          string              `json:"image,omitempty"`
	Flavor         string              `json:"flavor,omitempty"`
	OSType         commonParams.OSType `json:"os_type,omitempty"`
	OSArch         commonParams.OSArch `json:"os_arch,omitempty"`
	Tags           []Tag               `json:"tags,omitempty"`
	Enabled        bool                `json:"enabled,omitempty"`
	Instances      []Instance          `json:"instances,omitempty"`
	EnableShell    bool                `json:"enable_shell"`

	// Generation holds the numeric generation of the pool. This number
	// will be incremented, every time certain settings of the pool, which
	// may influence how runners are created (flavor, specs, image) are changed.
	// When a runner is created, this generation will be copied to the runners as
	// well. That way if some settings diverge, we can target those runners
	// to be recreated.
	Generation uint64 `json:"generation"`

	RepoID   string `json:"repo_id,omitempty"`
	RepoName string `json:"repo_name,omitempty"`

	OrgID   string `json:"org_id,omitempty"`
	OrgName string `json:"org_name,omitempty"`

	EnterpriseID   string `json:"enterprise_id,omitempty"`
	EnterpriseName string `json:"enterprise_name,omitempty"`

	Endpoint ForgeEndpoint `json:"endpoint,omitempty"`

	RunnerBootstrapTimeout uint      `json:"runner_bootstrap_timeout,omitempty"`
	CreatedAt              time.Time `json:"created_at,omitempty"`
	UpdatedAt              time.Time `json:"updated_at,omitempty"`
	// ExtraSpecs is an opaque raw json that gets sent to the provider
	// as part of the bootstrap params for instances. It can contain
	// any kind of data needed by providers. The contents of this field means
	// nothing to garm itself. We don't act on the information in this field at
	// all. We only validate that it's a proper json.
	ExtraSpecs json.RawMessage `json:"extra_specs,omitempty"`
	// GithubRunnerGroup is the github runner group in which the runners will be added.
	// The runner group must be created by someone with access to the enterprise.
	GitHubRunnerGroup string `json:"github-runner-group,omitempty"`

	// Priority is the priority of the pool. The higher the number, the higher the priority.
	// When fetching matching pools for a set of tags, the result will be sorted in descending
	// order of priority.
	Priority uint `json:"priority,omitempty"`

	TemplateID   uint   `json:"template_id,omitempty"`
	TemplateName string `json:"template_name,omitempty"`
}

func (p Pool) BelongsTo(entity ForgeEntity) bool {