api

package

Go to main page

Versions in this module

v2

v2.6.0

Jun 9, 2022

v2.6.0-rc.2

May 31, 2022

v2.6.0-rc.1

May 24, 2022

v2.5.0

May 13, 2022

v2.5.0-rc.2

May 11, 2022

v2.5.0-rc.1

May 4, 2022

v2.4.0

Apr 14, 2022

Changes in this version

type JobSpec

+ Fallible bool

v2.4.0-rc.3

Apr 12, 2022

v2.4.0-rc.2

Mar 30, 2022

v2.4.0-rc.1

Mar 30, 2022

v2.3.1

Feb 22, 2022

v2.3.1-rc.1

Feb 17, 2022

v2.3.0

Feb 9, 2022

Changes in this version

+ const PrincipalReferenceKind

+ type ObserverPrincipal struct

+ func (o *ObserverPrincipal) RoleAssignments() []RoleAssignment

type PrincipalReference

+ func (p PrincipalReference) MarshalJSON() ([]byte, error)

type PrincipalType

+ const PrincipalTypeRoot

+ type PrincipalsService interface

+ WhoAmI func(context.Context) (PrincipalReference, error)

+ func NewPrincipalsService(authorizeFn AuthorizeFn) PrincipalsService

+ type ProjectUpdateOptions struct

+ CreateIfNotFound bool

+ type RootPrincipal struct

+ func (r *RootPrincipal) ProjectRoleAssignments() []ProjectRoleAssignment

+ func (r *RootPrincipal) RoleAssignments() []RoleAssignment

+ type SchedulerPrincipal struct

+ func (s *SchedulerPrincipal) RoleAssignments() []RoleAssignment

type SessionsServiceConfig

+ GrantReadOnInitialLogin bool

+ type WorkerPrincipal struct

+ func GetWorkerPrincipal(eventID string) *WorkerPrincipal

+ func (w *WorkerPrincipal) RoleAssignments() []RoleAssignment

v2.2.0

Jan 4, 2022

v2.1.0

Dec 13, 2021

v2.0.0

Dec 1, 2021

Changes in this version

+ const CloneLabelKey

+ const EventKind

+ const JobKind

+ const ProjectKind

+ const ProjectRoleAssignmentKind

+ const ProjectRoleAssignmentListKind

+ const ProjectRoleScopeGlobal

+ const RetryLabelKey

+ const RoleAssignmentKind

+ const RoleAssignmentListKind

+ const RoleScopeGlobal

+ const ServiceAccountKind

+ const SessionKind

+ const UserKind

+ func ContextWithPrincipal(ctx context.Context, principal interface{}) context.Context

+ func ContextWithSessionID(ctx context.Context, sessionID string) context.Context

+ func PrincipalFromContext(ctx context.Context) interface

+ func SessionIDFromContext(ctx context.Context) string

+ type AuthorizeFn func(ctx context.Context, role Role, scope string) error

+ type Authorizer interface

+ Authorize func(ctx context.Context, roles Role, scope string) error

+ func NewAuthorizer(roleAssignmentsStore RoleAssignmentsStore) Authorizer

+ type CancelManyEventsResult struct

+ Count int64

+ func (c CancelManyEventsResult) MarshalJSON() ([]byte, error)

+ type ContainerSpec struct

+ Arguments []string

+ Command []string

+ Environment map[string]string

+ Image string

+ ImagePullPolicy ImagePullPolicy

+ func (cs ContainerSpec) EqualTo(cs2 ContainerSpec) bool

+ type CoolLogsStore interface

+ DeleteEventLogs func(ctx context.Context, id string) error

+ DeleteProjectLogs func(ctx context.Context, id string) error

+ type DeleteManyEventsResult struct

+ Count int64

+ func (d DeleteManyEventsResult) MarshalJSON() ([]byte, error)

+ type Event struct

+ Git *GitDetails

+ Labels map[string]string

+ LongTitle string

+ Payload string

+ ProjectID string

+ Qualifiers Qualifiers

+ ShortTitle string

+ Source string

+ SourceState *SourceState

+ Summary string

+ Type string

+ Worker Worker

+ func (e Event) MarshalJSON() ([]byte, error)

+ type EventList struct

+ Items []Event

+ func (e EventList) MarshalJSON() ([]byte, error)

+ type EventSubscription struct

+ Labels map[string]string

+ Qualifiers Qualifiers

+ Source string

+ Types []string

+ type EventSummary struct

+ Text string

+ type EventsSelector struct

+ Labels map[string]string

+ ProjectID string

+ Qualifiers Qualifiers

+ Source string

+ SourceState map[string]string

+ Type string

+ WorkerPhases []WorkerPhase

+ type EventsService interface

+ Cancel func(context.Context, string) error

+ CancelMany func(context.Context, EventsSelector) (CancelManyEventsResult, error)

+ Clone func(context.Context, string) (Event, error)

+ Create func(context.Context, Event) (EventList, error)

+ Delete func(context.Context, string) error

+ DeleteMany func(context.Context, EventsSelector) (DeleteManyEventsResult, error)

+ Get func(context.Context, string) (Event, error)

+ GetByWorkerToken func(context.Context, string) (Event, error)

+ List func(context.Context, EventsSelector, meta.ListOptions) (EventList, error)

+ Retry func(context.Context, string) (Event, error)

+ UpdateSourceState func(context.Context, string, SourceState) error

+ UpdateSummary func(context.Context, string, EventSummary) error

+ func NewEventsService(authorizeFn AuthorizeFn, projectAuthorize ProjectAuthorizeFn, ...) EventsService

+ type EventsStore interface

+ Cancel func(context.Context, string) error

+ CancelMany func(context.Context, EventsSelector) (<-chan Event, int64, error)

+ Create func(context.Context, Event) error

+ Delete func(context.Context, string) error

+ DeleteByProjectID func(context.Context, string) error

+ DeleteMany func(context.Context, EventsSelector) (<-chan Event, int64, error)

+ Get func(context.Context, string) (Event, error)

+ GetByHashedWorkerToken func(context.Context, string) (Event, error)

+ List func(context.Context, EventsSelector, meta.ListOptions) (EventList, error)

+ UpdateSourceState func(context.Context, string, SourceState) error

+ UpdateSummary func(context.Context, string, EventSummary) error

+ type GitConfig struct

+ CloneURL string

+ Commit string

+ InitSubmodules bool

+ Ref string

+ type GitDetails struct

+ CloneURL string

+ Commit string

+ Ref string

+ type ImagePullPolicy string

+ type Job struct

+ Created *time.Time

+ Name string

+ Spec JobSpec

+ Status *JobStatus

+ func (j Job) UsesWorkspace() bool

+ type JobContainerSpec struct

+ Privileged bool

+ SourceMountPath string

+ WorkingDirectory string

+ WorkspaceMountPath string

+ func (jcs JobContainerSpec) EqualTo(jcs2 JobContainerSpec) bool

+ type JobHost struct

+ NodeSelector map[string]string

+ OS OSFamily

+ func (jh *JobHost) EqualTo(jh2 *JobHost) bool

+ type JobPhase string

+ const JobPhaseAborted

+ const JobPhaseCanceled

+ const JobPhaseFailed

+ const JobPhasePending

+ const JobPhaseRunning

+ const JobPhaseSchedulingFailed

+ const JobPhaseStarting

+ const JobPhaseSucceeded

+ const JobPhaseTimedOut

+ const JobPhaseUnknown

+ func (j JobPhase) IsTerminal() bool

+ type JobPolicies struct

+ AllowPrivileged bool

+ type JobSpec struct

+ Host *JobHost

+ PrimaryContainer JobContainerSpec

+ SidecarContainers map[string]JobContainerSpec

+ TimeoutDuration string

+ func (js JobSpec) EqualTo(js2 JobSpec) bool

+ type JobStatus struct

+ Ended *time.Time

+ LogsEventID string

+ Phase JobPhase

+ Started *time.Time

+ type JobsService interface

+ Cleanup func(ctx context.Context, eventID, jobName string) error

+ Create func(ctx context.Context, eventID string, job Job) error

+ GetStatus func(ctx context.Context, eventID string, jobName string) (JobStatus, error)

+ Start func(ctx context.Context, eventID string, jobName string) error

+ Timeout func(ctx context.Context, eventID, jobName string) error

+ UpdateStatus func(ctx context.Context, eventID string, jobName string, status JobStatus) error

+ WatchStatus func(ctx context.Context, eventID string, jobName string) (<-chan JobStatus, error)

+ func NewJobsService(authorizeFn AuthorizeFn, projectsStore ProjectsStore, eventsStore EventsStore, ...) JobsService

+ type JobsStore interface

+ Create func(ctx context.Context, eventID string, job Job) error

+ UpdateStatus func(ctx context.Context, eventID string, jobName string, status JobStatus) error

+ type KubernetesConfig struct

+ ImagePullSecrets []string

+ type KubernetesDetails struct

+ Namespace string

+ type LogEntry struct

+ Message string

+ Time *time.Time

+ func (l LogEntry) MarshalJSON() ([]byte, error)

+ type LogLevel string

+ const LogLevelInfo

+ type LogStreamOptions struct

+ Follow bool

+ type LogsSelector struct

+ Container string

+ Job string

+ type LogsService interface

+ Stream func(ctx context.Context, eventID string, selector LogsSelector, ...) (<-chan LogEntry, error)

+ func NewLogsService(authorize AuthorizeFn, projectAuthorize ProjectAuthorizeFn, ...) LogsService

+ type LogsStore interface

+ StreamLogs func(ctx context.Context, project Project, event Event, selector LogsSelector, ...) (<-chan LogEntry, error)

+ type OSFamily string

+ const OSFamilyLinux

+ const OSFamilyWindows

+ type PrincipalReference struct

+ ID string

+ Type PrincipalType

+ type PrincipalType string

+ const PrincipalTypeServiceAccount

+ const PrincipalTypeUser

+ type Project struct

+ Description string

+ Kubernetes *KubernetesDetails

+ Spec ProjectSpec

+ func (p Project) MarshalJSON() ([]byte, error)

+ type ProjectAuthorizeFn func(ctx context.Context, projectID string, role Role) error

+ type ProjectAuthorizer interface

+ Authorize func(ctx context.Context, projectID string, role Role) error

+ func NewProjectAuthorizer(projectRoleAssignmentsStore ProjectRoleAssignmentsStore) ProjectAuthorizer

+ type ProjectList struct

+ Items []Project

+ func (p ProjectList) Contains(project Project) bool

+ func (p ProjectList) MarshalJSON() ([]byte, error)

+ type ProjectRoleAssignment struct

+ Principal PrincipalReference

+ ProjectID string

+ Role Role

+ func (p ProjectRoleAssignment) MarshalJSON() ([]byte, error)

+ func (p ProjectRoleAssignment) Matches(projectID string, role Role) bool

+ type ProjectRoleAssignmentList struct

+ Items []ProjectRoleAssignment

+ func (p ProjectRoleAssignmentList) MarshalJSON() ([]byte, error)

+ type ProjectRoleAssignmentsSelector struct

+ Principal *PrincipalReference

+ ProjectID string

+ Role Role

+ type ProjectRoleAssignmentsService interface

+ Grant func(context.Context, ProjectRoleAssignment) error

+ List func(context.Context, ProjectRoleAssignmentsSelector, meta.ListOptions) (ProjectRoleAssignmentList, error)

+ Revoke func(context.Context, ProjectRoleAssignment) error

+ func NewProjectRoleAssignmentsService(authorize AuthorizeFn, projectAuthorize ProjectAuthorizeFn, ...) ProjectRoleAssignmentsService

+ type ProjectRoleAssignmentsStore interface

+ Exists func(context.Context, ProjectRoleAssignment) (bool, error)

+ Grant func(context.Context, ProjectRoleAssignment) error

+ List func(context.Context, ProjectRoleAssignmentsSelector, meta.ListOptions) (ProjectRoleAssignmentList, error)

+ Revoke func(context.Context, ProjectRoleAssignment) error

+ RevokeByPrincipal func(context.Context, PrincipalReference) error

+ RevokeByProjectID func(ctx context.Context, projectID string) error

+ type ProjectSpec struct

+ EventSubscriptions []EventSubscription

+ WorkerTemplate WorkerSpec

+ type ProjectsService interface

+ Create func(context.Context, Project) (Project, error)

+ Delete func(context.Context, string) error

+ Get func(context.Context, string) (Project, error)

+ List func(context.Context, meta.ListOptions) (ProjectList, error)

+ Update func(context.Context, Project) error

+ func NewProjectsService(authorizeFn AuthorizeFn, projectAuthorize ProjectAuthorizeFn, ...) ProjectsService

+ type ProjectsStore interface

+ Create func(context.Context, Project) error

+ Delete func(context.Context, string) error

+ Get func(context.Context, string) (Project, error)

+ List func(context.Context, meta.ListOptions) (ProjectList, error)

+ ListSubscribers func(ctx context.Context, event Event) (ProjectList, error)

+ Update func(context.Context, Project) error

+ type Qualifiers map[string]string

+ func (q Qualifiers) MarshalBSONValue() (bsontype.Type, []byte, error)

+ type Role string

+ const RoleAdmin

+ const RoleEventCreator

+ const RoleObserver

+ const RoleProjectAdmin

+ const RoleProjectCreator

+ const RoleProjectDeveloper

+ const RoleProjectUser

+ const RoleReader

+ const RoleScheduler

+ const RoleWorker

+ type RoleAssignment struct

+ Principal PrincipalReference

+ Role Role

+ Scope string

+ func (r RoleAssignment) MarshalJSON() ([]byte, error)

+ func (r RoleAssignment) Matches(role Role, scope string) bool

+ type RoleAssignmentList struct

+ Items []RoleAssignment

+ func (r RoleAssignmentList) MarshalJSON() ([]byte, error)

+ type RoleAssignmentsSelector struct

+ Principal *PrincipalReference

+ Role Role

+ type RoleAssignmentsService interface

+ Grant func(ctx context.Context, roleAssignment RoleAssignment) error

+ List func(context.Context, RoleAssignmentsSelector, meta.ListOptions) (RoleAssignmentList, error)

+ Revoke func(ctx context.Context, roleAssignment RoleAssignment) error

+ func NewRoleAssignmentsService(authorizeFn AuthorizeFn, usersStore UsersStore, ...) RoleAssignmentsService

+ type RoleAssignmentsStore interface

+ Exists func(context.Context, RoleAssignment) (bool, error)

+ Grant func(context.Context, RoleAssignment) error

+ List func(context.Context, RoleAssignmentsSelector, meta.ListOptions) (RoleAssignmentList, error)

+ Revoke func(context.Context, RoleAssignment) error

+ RevokeByPrincipal func(context.Context, PrincipalReference) error

+ type Secret struct

+ Key string

+ Value string

+ func (s Secret) MarshalJSON() ([]byte, error)

+ type SecretList struct

+ Items []Secret

+ func (s SecretList) Len() int

+ func (s SecretList) Less(i, j int) bool

+ func (s SecretList) MarshalJSON() ([]byte, error)

+ func (s SecretList) Swap(i, j int)

+ type SecretsService interface

+ List func(ctx context.Context, projectID string, opts meta.ListOptions) (SecretList, error)

+ Set func(ctx context.Context, projectID string, secret Secret) error

+ Unset func(ctx context.Context, projectID string, key string) error

+ func NewSecretsService(authorizeFn AuthorizeFn, projectAuthorize ProjectAuthorizeFn, ...) SecretsService

+ type SecretsStore interface

+ List func(ctx context.Context, project Project, opts meta.ListOptions) (SecretList, error)

+ Set func(ctx context.Context, project Project, secret Secret) error

+ Unset func(ctx context.Context, project Project, key string) error

+ type ServiceAccount struct

+ Description string

+ HashedToken string

+ Locked *time.Time

+ func (s ServiceAccount) MarshalJSON() ([]byte, error)

+ type ServiceAccountList struct

+ Items []ServiceAccount

+ func (s ServiceAccountList) MarshalJSON() ([]byte, error)

+ type ServiceAccountsService interface

+ Create func(context.Context, ServiceAccount) (Token, error)

+ Delete func(context.Context, string) error

+ Get func(context.Context, string) (ServiceAccount, error)

+ GetByToken func(context.Context, string) (ServiceAccount, error)

+ List func(context.Context, meta.ListOptions) (ServiceAccountList, error)

+ Lock func(context.Context, string) error

+ Unlock func(context.Context, string) (Token, error)

+ func NewServiceAccountsService(authorizeFn AuthorizeFn, store ServiceAccountsStore, ...) ServiceAccountsService

+ type ServiceAccountsStore interface

+ Create func(context.Context, ServiceAccount) error

+ Delete func(context.Context, string) error

+ Get func(context.Context, string) (ServiceAccount, error)

+ GetByHashedToken func(context.Context, string) (ServiceAccount, error)

+ List func(context.Context, meta.ListOptions) (ServiceAccountList, error)

+ Lock func(context.Context, string) error

+ Unlock func(ctx context.Context, id string, newHashedToken string) error

+ type Session struct

+ AuthSuccessURL string

+ Authenticated *time.Time

+ Expires *time.Time

+ HashedOAuth2State string

+ HashedToken string

+ Root bool

+ UserID string

+ type SessionsService interface

+ Authenticate func(ctx context.Context, state string, code string) (string, error)

+ CreateRootSession func(ctx context.Context, username string, password string) (Token, error)

+ CreateUserSession func(context.Context, *ThirdPartyAuthOptions) (ThirdPartyAuthDetails, error)

+ Delete func(ctx context.Context, id string) error

+ GetByToken func(ctx context.Context, token string) (Session, error)

+ func NewSessionsService(sessionsStore SessionsStore, usersStore UsersStore, ...) SessionsService

+ type SessionsServiceConfig struct

+ AdminUserIDs []string

+ RootUserEnabled bool

+ RootUserPassword string

+ RootUserSessionTTL time.Duration

+ ThirdPartyAuthEnabled bool

+ UserSessionTTL time.Duration

+ type SessionsStore interface

+ Authenticate func(ctx context.Context, sessionID string, userID string, expires time.Time) error

+ Create func(context.Context, Session) error

+ Delete func(context.Context, string) error

+ DeleteByUser func(ctx context.Context, userID string) error

+ GetByHashedOAuth2State func(context.Context, string) (Session, error)

+ GetByHashedToken func(context.Context, string) (Session, error)

+ type SourceState struct

+ State map[string]string

+ type Substrate interface

+ CountRunningJobs func(context.Context) (SubstrateJobCount, error)

+ CountRunningWorkers func(context.Context) (SubstrateWorkerCount, error)

+ CreateProject func(context.Context, Project) (Project, error)

+ DeleteJob func(ctx context.Context, project Project, event Event, jobName string) error

+ DeleteProject func(context.Context, Project) error

+ DeleteWorkerAndJobs func(context.Context, Project, Event) error

+ ScheduleJob func(ctx context.Context, project Project, event Event, jobName string) error

+ ScheduleWorker func(context.Context, Event) error

+ StartJob func(ctx context.Context, project Project, event Event, jobName string) error

+ StartWorker func(ctx context.Context, project Project, event Event, token string) error

+ StoreJobEnvironment func(ctx context.Context, project Project, eventID string, jobName string, ...) error

+ type SubstrateJobCount struct

+ Count int

+ func (s SubstrateJobCount) MarshalJSON() ([]byte, error)

+ type SubstrateService interface

+ CountRunningJobs func(context.Context) (SubstrateJobCount, error)

+ CountRunningWorkers func(context.Context) (SubstrateWorkerCount, error)

+ func NewSubstrateService(authorizeFn AuthorizeFn, substrate Substrate) SubstrateService

+ type SubstrateWorkerCount struct

+ Count int

+ func (s SubstrateWorkerCount) MarshalJSON() ([]byte, error)

+ type ThirdPartyAuthDetails struct

+ AuthURL string

+ Token string

+ func (t ThirdPartyAuthDetails) MarshalJSON() ([]byte, error)

+ type ThirdPartyAuthHelper interface

+ AuthURL func(oauth2State string) string

+ Exchange func(ctx context.Context, oauth2State string, oauth2Code string) (ThirdPartyIdentity, error)

+ type ThirdPartyAuthOptions struct

+ SuccessURL string

+ type ThirdPartyAuthStrategy string

+ type ThirdPartyIdentity struct

+ ID string

+ Name string

+ type Token struct

+ Value string

+ func (t Token) MarshalJSON() ([]byte, error)

+ type User struct

+ Locked *time.Time

+ Name string

+ func (u User) MarshalJSON() ([]byte, error)

+ type UserList struct

+ Items []User

+ func (u UserList) MarshalJSON() ([]byte, error)

+ type UsersService interface

+ Delete func(context.Context, string) error

+ Get func(context.Context, string) (User, error)

+ List func(context.Context, meta.ListOptions) (UserList, error)

+ Lock func(context.Context, string) error

+ Unlock func(context.Context, string) error

+ func NewUsersService(authorizeFn AuthorizeFn, usersStore UsersStore, sessionsStore SessionsStore, ...) UsersService

+ type UsersServiceConfig struct

+ ThirdPartyAuthEnabled bool

+ type UsersStore interface

+ Create func(context.Context, User) error

+ Delete func(context.Context, string) error

+ Get func(context.Context, string) (User, error)

+ List func(context.Context, meta.ListOptions) (UserList, error)

+ Lock func(context.Context, string) error

+ Unlock func(ctx context.Context, id string) error

+ type Worker struct

+ Jobs []Job

+ Spec WorkerSpec

+ Status WorkerStatus

+ func (w *Worker) Job(jobName string) (Job, bool)

+ type WorkerPhase string

+ const WorkerPhaseAborted

+ const WorkerPhaseCanceled

+ const WorkerPhaseFailed

+ const WorkerPhasePending

+ const WorkerPhaseRunning

+ const WorkerPhaseSchedulingFailed

+ const WorkerPhaseStarting

+ const WorkerPhaseSucceeded

+ const WorkerPhaseTimedOut

+ const WorkerPhaseUnknown

+ func WorkerPhasesAll() []WorkerPhase

+ func (w WorkerPhase) IsTerminal() bool

+ type WorkerSpec struct

+ ConfigFilesDirectory string

+ Container *ContainerSpec

+ DefaultConfigFiles map[string]string

+ Git *GitConfig

+ JobPolicies *JobPolicies

+ Kubernetes *KubernetesConfig

+ LogLevel LogLevel

+ TimeoutDuration string

+ UseWorkspace bool

+ WorkspaceSize string

+ type WorkerStatus struct

+ Ended *time.Time

+ Phase WorkerPhase

+ Started *time.Time

+ type WorkersService interface

+ Cleanup func(ctx context.Context, eventID string) error

+ GetStatus func(ctx context.Context, eventID string) (WorkerStatus, error)

+ Start func(ctx context.Context, eventID string) error

+ Timeout func(ctx context.Context, eventID string) error

+ UpdateStatus func(ctx context.Context, eventID string, status WorkerStatus) error

+ WatchStatus func(ctx context.Context, eventID string) (<-chan WorkerStatus, error)

+ func NewWorkersService(authorizeFn AuthorizeFn, projectsStore ProjectsStore, eventsStore EventsStore, ...) WorkersService

+ type WorkersStore interface

+ Timeout func(ctx context.Context, eventID string) error

+ UpdateHashedToken func(ctx context.Context, eventID string, hashedToken string) error

+ UpdateStatus func(ctx context.Context, eventID string, status WorkerStatus) error

v2.0.0-rc.1

Nov 18, 2021

v2.0.0-beta.4

Nov 12, 2021

v2.0.0-beta.3

Sep 20, 2021

v2.0.0-beta.2

Aug 24, 2021

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