controlapi

package
v0.1.12 Latest Latest
Warning

This package is not in the latest version of its module.

Go to latest
Published: Aug 4, 2026 License: Apache-2.0 Imports: 25 Imported by: 0

Documentation

Overview

Package controlapi implements the versioned autback Connect control plane.

The package is the authorization boundary for project resources. Its API lifecycle and transport semantics are documented in ../../../docs/control-api.md, and its role in the complete system is documented in ../../../docs/architecture.md.

Index

Constants

View Source
const Version = version.Current

Variables

This section is empty.

Functions

func New

func New(config Config) (http.Handler, error)

Types

type Capacity added in v0.1.7

type Capacity interface {
	Ensure(context.Context) error
	Admit(context.Context, func() error) error
	Check(context.Context) error
}

type Config

type Config struct {
	Store                         *controlsqlite.Store
	Scheduler                     control.Scheduler
	Dispatcher                    Dispatcher
	Authority                     *pki.Authority
	OIDCVerifier                  OIDCVerifier
	CASEndpoint                   string
	CASInstance                   string
	BuildKitEndpoint              string
	CredentialTTL                 time.Duration
	AllowUnpinnedImages           bool
	Capacity                      Capacity
	RequiredBuildClientCapability string
	RequiredJobClientCapability   string
	Ready                         func() bool
}

type Dispatcher

type Dispatcher interface {
	RunOnce(context.Context) error
	Advance()
	Release(context.Context, control.OperationKind, string) error
}

type OIDCVerifier

type OIDCVerifier interface {
	Verify(context.Context, string) (control.GitHubClaims, error)
}

type Server

type Server struct {
	// contains filtered or unexported fields
}

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL