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
- func New(config Config) (http.Handler, error)
- type Capacity
- type Config
- type Dispatcher
- type OIDCVerifier
- type Server
- func (s *Server) ActivateProjectImage(ctx context.Context, ...) (*connect.Response[autbackv1.ActivateProjectImageResponse], error)
- func (s *Server) AddProjectMember(ctx context.Context, ...) (*connect.Response[autbackv1.AddProjectMemberResponse], error)
- func (s *Server) CancelBuild(ctx context.Context, request *connect.Request[autbackv1.CancelBuildRequest]) (*connect.Response[autbackv1.CancelBuildResponse], error)
- func (s *Server) CancelJob(ctx context.Context, request *connect.Request[autbackv1.CancelJobRequest]) (*connect.Response[autbackv1.CancelJobResponse], error)
- func (s *Server) CreateDeviceToken(ctx context.Context, ...) (*connect.Response[autbackv1.CreateDeviceTokenResponse], error)
- func (s *Server) CreateEnrollmentCode(ctx context.Context, ...) (*connect.Response[autbackv1.CreateEnrollmentCodeResponse], error)
- func (s *Server) CreateGitHubTrust(ctx context.Context, ...) (*connect.Response[autbackv1.CreateGitHubTrustResponse], error)
- func (s *Server) CreateProject(ctx context.Context, request *connect.Request[autbackv1.CreateProjectRequest]) (*connect.Response[autbackv1.CreateProjectResponse], error)
- func (s *Server) CreateUser(ctx context.Context, request *connect.Request[autbackv1.CreateUserRequest]) (*connect.Response[autbackv1.CreateUserResponse], error)
- func (s *Server) ExchangeEnrollmentCode(ctx context.Context, ...) (*connect.Response[autbackv1.ExchangeEnrollmentCodeResponse], error)
- func (s *Server) ExchangeGitHubOIDC(ctx context.Context, ...) (*connect.Response[autbackv1.ExchangeGitHubOIDCResponse], error)
- func (s *Server) FinishBuild(ctx context.Context, request *connect.Request[autbackv1.FinishBuildRequest]) (*connect.Response[autbackv1.FinishBuildResponse], error)
- func (s *Server) GetBuild(ctx context.Context, request *connect.Request[autbackv1.GetBuildRequest]) (*connect.Response[autbackv1.GetBuildResponse], error)
- func (s *Server) GetJob(ctx context.Context, request *connect.Request[autbackv1.GetJobRequest]) (*connect.Response[autbackv1.GetJobResponse], error)
- func (s *Server) GetServiceInfo(context.Context, *connect.Request[autbackv1.GetServiceInfoRequest]) (*connect.Response[autbackv1.GetServiceInfoResponse], error)
- func (s *Server) ListDeviceTokens(ctx context.Context, ...) (*connect.Response[autbackv1.ListDeviceTokensResponse], error)
- func (s *Server) ListGitHubTrusts(ctx context.Context, ...) (*connect.Response[autbackv1.ListGitHubTrustsResponse], error)
- func (s *Server) ListJobs(ctx context.Context, request *connect.Request[autbackv1.ListJobsRequest]) (*connect.Response[autbackv1.ListJobsResponse], error)
- func (s *Server) ListProjectImageHistory(ctx context.Context, ...) (*connect.Response[autbackv1.ListProjectImageHistoryResponse], error)
- func (s *Server) ListProjects(ctx context.Context, request *connect.Request[autbackv1.ListProjectsRequest]) (*connect.Response[autbackv1.ListProjectsResponse], error)
- func (s *Server) PrepareBuild(ctx context.Context, request *connect.Request[autbackv1.PrepareBuildRequest]) (*connect.Response[autbackv1.PrepareBuildResponse], error)
- func (s *Server) PrepareJob(ctx context.Context, request *connect.Request[autbackv1.PrepareJobRequest]) (*connect.Response[autbackv1.PrepareJobResponse], error)
- func (s *Server) RevokeDeviceToken(ctx context.Context, ...) (*connect.Response[autbackv1.RevokeDeviceTokenResponse], error)
- func (s *Server) RevokeGitHubTrust(ctx context.Context, ...) (*connect.Response[autbackv1.RevokeGitHubTrustResponse], error)
- func (s *Server) RollbackProjectImage(ctx context.Context, ...) (*connect.Response[autbackv1.RollbackProjectImageResponse], error)
- func (s *Server) SetProjectImagePolicy(ctx context.Context, ...) (*connect.Response[autbackv1.SetProjectImagePolicyResponse], error)
- func (s *Server) StartJob(ctx context.Context, request *connect.Request[autbackv1.StartJobRequest]) (*connect.Response[autbackv1.StartJobResponse], error)
- func (s *Server) StreamJobLogs(ctx context.Context, request *connect.Request[autbackv1.StreamJobLogsRequest], ...) error
Constants ¶
View Source
const Version = version.Current
Variables ¶
This section is empty.
Functions ¶
Types ¶
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
}
type Dispatcher ¶
type OIDCVerifier ¶
type Server ¶
type Server struct {
// contains filtered or unexported fields
}
func (*Server) ActivateProjectImage ¶
func (*Server) AddProjectMember ¶
func (*Server) CancelBuild ¶
func (*Server) CreateDeviceToken ¶
func (*Server) CreateEnrollmentCode ¶
func (*Server) CreateGitHubTrust ¶
func (*Server) CreateProject ¶
func (*Server) CreateUser ¶
func (*Server) ExchangeEnrollmentCode ¶
func (*Server) ExchangeGitHubOIDC ¶
func (*Server) FinishBuild ¶
func (*Server) GetServiceInfo ¶
func (*Server) ListDeviceTokens ¶
func (*Server) ListGitHubTrusts ¶
func (*Server) ListProjectImageHistory ¶
func (*Server) ListProjects ¶
func (*Server) PrepareBuild ¶
func (*Server) PrepareJob ¶
func (*Server) RevokeDeviceToken ¶
func (*Server) RevokeGitHubTrust ¶
func (*Server) RollbackProjectImage ¶
func (*Server) SetProjectImagePolicy ¶
func (*Server) StreamJobLogs ¶
func (s *Server) StreamJobLogs(ctx context.Context, request *connect.Request[autbackv1.StreamJobLogsRequest], stream *connect.ServerStream[autbackv1.StreamJobLogsResponse]) error
Click to show internal directories.
Click to hide internal directories.