Method GetControllerInfo

runner/runner.go:319–360

GetControllerInfo returns the controller id and the hostname. This data might be used in metrics and logging.

(ctx context.Context)

// GetControllerInfo returns the controller id and the hostname.
// This data might be used in metrics and logging.
func (r *Runner) GetControllerInfo(ctx context.Context) (params.ControllerInfo, error) {
	if !auth.IsAdmin(ctx) {
		return params.ControllerInfo{}, runnerErrors.ErrUnauthorized
	}
	// It is unlikely that fetching the hostname will encounter an error on a standard
	// linux (or Windows) system, but if os.Hostname() can fail, we need to at least retry
	// a few times before giving up.
	// This retries 10 times within one second. While it has the potential to give us a
	// one second delay before returning either the hostname or an error, I expect this
	// to succeed on the first try.
	// As a side note, Windows requires a reboot for the hostname change to take effect,
	// so if we'll ever support Windows as a target system, the hostname can be cached.
	var hostname string
	var err error
	for range 10 {
		hostname, err = os.Hostname()
		if err != nil {
			select {
			case <-time.After(10 * time.Millisecond):
				continue
			case <-ctx.Done():
			}
			return params.ControllerInfo{}, fmt.Errorf("error fetching hostname: %w", err)
		}
		break
	}
	if err != nil {
		return params.ControllerInfo{}, fmt.Errorf("error fetching hostname: %w", err)
	}

	info, err := r.store.ControllerInfo()
	if err != nil {
		return params.ControllerInfo{}, fmt.Errorf("error fetching controller info: %w", err)
	}

	// This is temporary. Right now, GARM is a single-instance deployment. When we add the
	// ability to scale out, the hostname field will be moved form here to a dedicated node
	// object. As a single controller will be made up of multiple nodes, we will need to model
	// that aspect of GARM.
	info.Hostname = hostname
	return info, nil
}

func (r *Runner) ListProviders(ctx context.Context) ([]params.Provider, error) {
	if !auth.IsAdmin(ctx) {