Documentation
¶
Index ¶
- Variables
- type ChangePayload
- type Consumer
- type ControllerStore
- type DatabaseEntityType
- type EnterpriseStore
- type EntityPoolStore
- type GiteaCredentialsStore
- type GiteaEndpointStore
- type GithubCredentialsStore
- type GithubEndpointStore
- type InstanceStore
- type JobsStore
- type OperationType
- type OrgStore
- type PayloadFilterFunc
- type PoolStore
- type Producer
- type RepoStore
- type ScaleSetInstanceStore
- type ScaleSetsStore
- type Store
- type UserStore
- type Watcher
Constants ¶
This section is empty.
Variables ¶
View Source
var ( ErrProducerClosed = fmt.Errorf("producer is closed") ErrProducerTimeoutErr = fmt.Errorf("producer timeout error") ErrProducerAlreadyRegistered = fmt.Errorf("producer already registered") ErrConsumerAlreadyRegistered = fmt.Errorf("consumer already registered") ErrWatcherAlreadyStarted = fmt.Errorf("watcher already started") ErrWatcherNotInitialized = fmt.Errorf("watcher not initialized") ErrInvalidOperationType = fmt.Errorf("invalid operation") ErrInvalidEntityType = fmt.Errorf("invalid entity type") ErrNoFiltersProvided = fmt.Errorf("no filters provided") )
Functions ¶
This section is empty.
Types ¶
type ChangePayload ¶ added in v0.1.5
type ChangePayload struct {
EntityType DatabaseEntityType `json:"entity-type"`
Operation OperationType `json:"operation"`
Payload interface{} `json:"payload"`
}
type Consumer ¶ added in v0.1.5
type Consumer interface {
Watch() <-chan ChangePayload
IsClosed() bool
Close()
SetFilters(filters ...PayloadFilterFunc)
}
type ControllerStore ¶ added in v0.1.5
type ControllerStore interface {
ControllerInfo() (params.ControllerInfo, error)
InitController() (params.ControllerInfo, error)
UpdateController(info params.UpdateControllerParams) (params.ControllerInfo, error)
}
type DatabaseEntityType ¶ added in v0.1.5
type DatabaseEntityType string
const ( RepositoryEntityType DatabaseEntityType = "repository" OrganizationEntityType DatabaseEntityType = "organization" EnterpriseEntityType DatabaseEntityType = "enterprise" PoolEntityType DatabaseEntityType = "pool" UserEntityType DatabaseEntityType = "user" InstanceEntityType DatabaseEntityType = "instance" JobEntityType DatabaseEntityType = "job" ControllerEntityType DatabaseEntityType = "controller" GithubCredentialsEntityType DatabaseEntityType = "github_credentials" // #nosec G101 GiteaCredentialsEntityType DatabaseEntityType = "gitea_credentials" // #nosec G101 GithubEndpointEntityType DatabaseEntityType = "github_endpoint" ScaleSetEntityType DatabaseEntityType = "scaleset" )
type EnterpriseStore ¶
type EnterpriseStore interface {
CreateEnterprise(ctx context.Context, name string, credentialsName params.ForgeCredentials, webhookSecret string, poolBalancerType params.PoolBalancerType) (params.Enterprise, error)
GetEnterprise(ctx context.Context, name, endpointName string) (params.Enterprise, error)
GetEnterpriseByID(ctx context.Context, enterpriseID string) (params.Enterprise, error)
ListEnterprises(ctx context.Context, filter params.EnterpriseFilter) ([]params.Enterprise, error)
DeleteEnterprise(ctx context.Context, enterpriseID string) error
UpdateEnterprise(ctx context.Context, enterpriseID string, param params.UpdateEntityParams) (params.Enterprise, error)
}
type EntityPoolStore ¶ added in v0.1.5
type EntityPoolStore interface {
CreateEntityPool(ctx context.Context, entity params.ForgeEntity, param params.CreatePoolParams) (params.Pool, error)
GetEntityPool(ctx context.Context, entity params.ForgeEntity, poolID string) (params.Pool, error)
DeleteEntityPool(ctx context.Context, entity params.ForgeEntity, poolID string) error
UpdateEntityPool(ctx context.Context, entity params.ForgeEntity, poolID string, param params.UpdatePoolParams) (params.Pool, error)
ListEntityPools(ctx context.Context, entity params.ForgeEntity) ([]params.Pool, error)
ListEntityInstances(ctx context.Context, entity params.ForgeEntity) ([]params.Instance, error)
}
type GiteaCredentialsStore ¶
type GiteaCredentialsStore interface {
CreateGiteaCredentials(ctx context.Context, param params.CreateGiteaCredentialsParams) (gtCreds params.ForgeCredentials, err error)
GetGiteaCredentialsByName(ctx context.Context, name string, detailed bool) (params.ForgeCredentials, error)
GetGiteaCredentials(ctx context.Context, id uint, detailed bool) (params.ForgeCredentials, error)
ListGiteaCredentials(ctx context.Context) ([]params.ForgeCredentials, error)
UpdateGiteaCredentials(ctx context.Context, id uint, param params.UpdateGiteaCredentialsParams) (gtCreds params.ForgeCredentials, err error)
DeleteGiteaCredentials(ctx context.Context, id uint) (err error)
}
type GiteaEndpointStore ¶
type GiteaEndpointStore interface {
CreateGiteaEndpoint(_ context.Context, param params.CreateGiteaEndpointParams) (ghEndpoint params.ForgeEndpoint, err error)
ListGiteaEndpoints(_ context.Context) ([]params.ForgeEndpoint, error)
DeleteGiteaEndpoint(_ context.Context, name string) (err error)
GetGiteaEndpoint(_ context.Context, name string) (params.ForgeEndpoint, error)
UpdateGiteaEndpoint(_ context.Context, name string, param params.UpdateGiteaEndpointParams) (ghEndpoint params.ForgeEndpoint, err error)
}
type GithubCredentialsStore ¶ added in v0.1.5
type GithubCredentialsStore interface {
CreateGithubCredentials(ctx context.Context, param params.CreateGithubCredentialsParams) (params.ForgeCredentials, error)
GetGithubCredentials(ctx context.Context, id uint, detailed bool) (params.ForgeCredentials, error)
GetGithubCredentialsByName(ctx context.Context, name string, detailed bool) (params.ForgeCredentials, error)
ListGithubCredentials(ctx context.Context) ([]params.ForgeCredentials, error)
UpdateGithubCredentials(ctx context.Context, id uint, param params.UpdateGithubCredentialsParams) (params.ForgeCredentials, error)
DeleteGithubCredentials(ctx context.Context, id uint) error
}
type GithubEndpointStore ¶ added in v0.1.5
type GithubEndpointStore interface {
CreateGithubEndpoint(ctx context.Context, param params.CreateGithubEndpointParams) (params.ForgeEndpoint, error)
GetGithubEndpoint(ctx context.Context, name string) (params.ForgeEndpoint, error)
ListGithubEndpoints(ctx context.Context) ([]params.ForgeEndpoint, error)
UpdateGithubEndpoint(ctx context.Context, name string, param params.UpdateGithubEndpointParams) (params.ForgeEndpoint, error)
DeleteGithubEndpoint(ctx context.Context, name string) error
}
type InstanceStore ¶
type InstanceStore interface {
CreateInstance(ctx context.Context, poolID string, param params.CreateInstanceParams) (params.Instance, error)
DeleteInstance(ctx context.Context, poolID string, instanceName string) error
DeleteInstanceByName(ctx context.Context, instanceName string) error
UpdateInstance(ctx context.Context, instanceName string, param params.UpdateInstanceParams) (params.Instance, error)
// Probably a bad idea without some king of filter or at least pagination
//
// nolint:golangci-lint,godox
// TODO: add filter/pagination
ListAllInstances(ctx context.Context) ([]params.Instance, error)
GetInstanceByName(ctx context.Context, instanceName string) (params.Instance, error)
AddInstanceEvent(ctx context.Context, instanceName string, event params.EventType, eventLevel params.EventLevel, eventMessage string) error
}
type JobsStore ¶ added in v0.1.2
type JobsStore interface {
CreateOrUpdateJob(ctx context.Context, job params.Job) (params.Job, error)
ListEntityJobsByStatus(ctx context.Context, entityType params.ForgeEntityType, entityID string, status params.JobStatus) ([]params.Job, error)
ListJobsByStatus(ctx context.Context, status params.JobStatus) ([]params.Job, error)
ListAllJobs(ctx context.Context) ([]params.Job, error)
GetJobByID(ctx context.Context, jobID int64) (params.Job, error)
DeleteJob(ctx context.Context, jobID int64) error
UnlockJob(ctx context.Context, jobID int64, entityID string) error
LockJob(ctx context.Context, jobID int64, entityID string) error
BreakLockJobIsQueued(ctx context.Context, jobID int64) error
DeleteCompletedJobs(ctx context.Context) error
}
type OperationType ¶ added in v0.1.5
type OperationType string
const ( CreateOperation OperationType = "create" UpdateOperation OperationType = "update" DeleteOperation OperationType = "delete" )
type OrgStore ¶
type OrgStore interface {
CreateOrganization(ctx context.Context, name string, credentials params.ForgeCredentials, webhookSecret string, poolBalancerType params.PoolBalancerType) (org params.Organization, err error)
GetOrganization(ctx context.Context, name, endpointName string) (params.Organization, error)
GetOrganizationByID(ctx context.Context, orgID string) (params.Organization, error)
ListOrganizations(ctx context.Context, filter params.OrganizationFilter) ([]params.Organization, error)
DeleteOrganization(ctx context.Context, orgID string) error
UpdateOrganization(ctx context.Context, orgID string, param params.UpdateEntityParams) (params.Organization, error)
}
type PayloadFilterFunc ¶ added in v0.1.5
type PayloadFilterFunc func(ChangePayload) bool
type PoolStore ¶
type PoolStore interface {
// Probably a bad idea without some king of filter or at least pagination
// nolint:golangci-lint,godox
// TODO: add filter/pagination
ListAllPools(ctx context.Context) ([]params.Pool, error)
GetPoolByID(ctx context.Context, poolID string) (params.Pool, error)
DeletePoolByID(ctx context.Context, poolID string) error
ListPoolInstances(ctx context.Context, poolID string) ([]params.Instance, error)
PoolInstanceCount(ctx context.Context, poolID string) (int64, error)
GetPoolInstanceByName(ctx context.Context, poolID string, instanceName string) (params.Instance, error)
FindPoolsMatchingAllTags(ctx context.Context, entityType params.ForgeEntityType, entityID string, tags []string) ([]params.Pool, error)
}
type Producer ¶ added in v0.1.5
type Producer interface {
Notify(ChangePayload) error
IsClosed() bool
Close()
}
type RepoStore ¶
type RepoStore interface {
CreateRepository(ctx context.Context, owner, name string, credentials params.ForgeCredentials, webhookSecret string, poolBalancerType params.PoolBalancerType) (param params.Repository, err error)
GetRepository(ctx context.Context, owner, name, endpointName string) (params.Repository, error)
GetRepositoryByID(ctx context.Context, repoID string) (params.Repository, error)
ListRepositories(ctx context.Context, filter params.RepositoryFilter) ([]params.Repository, error)
DeleteRepository(ctx context.Context, repoID string) error
UpdateRepository(ctx context.Context, repoID string, param params.UpdateEntityParams) (params.Repository, error)
}
type ScaleSetInstanceStore ¶
type ScaleSetsStore ¶
type ScaleSetsStore interface {
ListAllScaleSets(ctx context.Context) ([]params.ScaleSet, error)
CreateEntityScaleSet(_ context.Context, entity params.ForgeEntity, param params.CreateScaleSetParams) (scaleSet params.ScaleSet, err error)
ListEntityScaleSets(_ context.Context, entity params.ForgeEntity) ([]params.ScaleSet, error)
UpdateEntityScaleSet(_ context.Context, entity params.ForgeEntity, scaleSetID uint, param params.UpdateScaleSetParams, callback func(old, newSet params.ScaleSet) error) (updatedScaleSet params.ScaleSet, err error)
GetScaleSetByID(ctx context.Context, scaleSet uint) (params.ScaleSet, error)
DeleteScaleSetByID(ctx context.Context, scaleSetID uint) (err error)
SetScaleSetLastMessageID(ctx context.Context, scaleSetID uint, lastMessageID int64) error
SetScaleSetDesiredRunnerCount(ctx context.Context, scaleSetID uint, desiredRunnerCount int) error
}
type Store ¶
type Store interface {
RepoStore
OrgStore
EnterpriseStore
PoolStore
UserStore
InstanceStore
JobsStore
GithubEndpointStore
GithubCredentialsStore
ControllerStore
EntityPoolStore
ScaleSetsStore
ScaleSetInstanceStore
GiteaEndpointStore
GiteaCredentialsStore
ControllerInfo() (params.ControllerInfo, error)
InitController() (params.ControllerInfo, error)
GetForgeEntity(_ context.Context, entityType params.ForgeEntityType, entityID string) (params.ForgeEntity, error)
AddEntityEvent(ctx context.Context, entity params.ForgeEntity, event params.EventType, eventLevel params.EventLevel, statusMessage string, maxEvents int) error
}
type UserStore ¶
type UserStore interface {
GetUser(ctx context.Context, user string) (params.User, error)
GetUserByID(ctx context.Context, userID string) (params.User, error)
GetAdminUser(ctx context.Context) (params.User, error)
CreateUser(ctx context.Context, user params.NewUserParams) (params.User, error)
UpdateUser(ctx context.Context, user string, param params.UpdateUserParams) (params.User, error)
HasAdminUser(ctx context.Context) bool
}
Click to show internal directories.
Click to hide internal directories.