42cfd1b3c6
This change adds a new "agent mode" to GARM. The agent enables GARM to set up a persistent websocket connection between the garm server and the runners it spawns. The goal is to be able to easier keep track of state, even without subsequent webhooks from the forge. The Agent will report via websockets when the runner is actually online, when it started a job and when it finished a job. Additionally, the agent allows us to enable optional remote shell between the user and any runner that is spun up using agent mode. The remote shell is multiplexed over the same persistent websocket connection the agent sets up with the server (the agent never listens on a port). Enablement has also been done in the web UI for this functionality. Signed-off-by: Gabriel Adrian Samfira <gsamfira@cloudbasesolutions.com>
218 lines
12 KiB
Go
218 lines
12 KiB
Go
// Copyright 2022 Cloudbase Solutions SRL
|
|
//
|
|
// Licensed under the Apache License, Version 2.0 (the "License"); you may
|
|
// not use this file except in compliance with the License. You may obtain
|
|
// a copy of the License at
|
|
//
|
|
// http://www.apache.org/licenses/LICENSE-2.0
|
|
//
|
|
// Unless required by applicable law or agreed to in writing, software
|
|
// distributed under the License is distributed on an "AS IS" BASIS, WITHOUT
|
|
// WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the
|
|
// License for the specific language governing permissions and limitations
|
|
// under the License.
|
|
|
|
package common
|
|
|
|
import (
|
|
"context"
|
|
"io"
|
|
|
|
commonParams "github.com/cloudbase/garm-provider-common/params"
|
|
"github.com/cloudbase/garm/params"
|
|
)
|
|
|
|
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 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 RepoStore interface {
|
|
CreateRepository(ctx context.Context, owner, name string, credentials params.ForgeCredentials, webhookSecret string, poolBalancerType params.PoolBalancerType, agentMode bool) (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 OrgStore interface {
|
|
CreateOrganization(ctx context.Context, name string, credentials params.ForgeCredentials, webhookSecret string, poolBalancerType params.PoolBalancerType, agentMode bool) (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 EnterpriseStore interface {
|
|
CreateEnterprise(ctx context.Context, name string, credentialsName params.ForgeCredentials, webhookSecret string, poolBalancerType params.PoolBalancerType, agentMode bool) (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 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)
|
|
FindPoolsMatchingAllTags(ctx context.Context, entityType params.ForgeEntityType, entityID string, tags []string) ([]params.Pool, error)
|
|
}
|
|
|
|
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
|
|
}
|
|
|
|
type InstanceStore interface {
|
|
CreateInstance(ctx context.Context, poolID string, param params.CreateInstanceParams) (params.Instance, error)
|
|
DeleteInstance(ctx context.Context, poolID string, instanceNameOrID string) error
|
|
DeleteInstanceByName(ctx context.Context, instanceName string) error
|
|
UpdateInstance(ctx context.Context, instanceNameOrID 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)
|
|
|
|
GetInstance(ctx context.Context, instanceNameOrID string) (params.Instance, error)
|
|
AddInstanceEvent(ctx context.Context, instanceNameOrID string, event params.EventType, eventLevel params.EventLevel, eventMessage string) error
|
|
}
|
|
|
|
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 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 ControllerStore interface {
|
|
ControllerInfo() (params.ControllerInfo, error)
|
|
InitController() (params.ControllerInfo, error)
|
|
UpdateController(info params.UpdateControllerParams) (params.ControllerInfo, error)
|
|
HasEntitiesWithAgentModeEnabled() (bool, error)
|
|
}
|
|
|
|
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 ScaleSetInstanceStore interface {
|
|
ListScaleSetInstances(_ context.Context, scalesetID uint) ([]params.Instance, error)
|
|
CreateScaleSetInstance(_ context.Context, scaleSetID uint, param params.CreateInstanceParams) (instance params.Instance, err error)
|
|
}
|
|
|
|
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 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 TemplateStore interface {
|
|
ListTemplates(ctx context.Context, osType *commonParams.OSType, forgeType *params.EndpointType, partialName *string) ([]params.Template, error)
|
|
CreateTemplate(ctx context.Context, param params.CreateTemplateParams) (template params.Template, err error)
|
|
GetTemplate(ctx context.Context, id uint) (params.Template, error)
|
|
GetTemplateByName(ctx context.Context, name string) (params.Template, error)
|
|
UpdateTemplate(ctx context.Context, id uint, param params.UpdateTemplateParams) (template params.Template, err error)
|
|
DeleteTemplate(ctx context.Context, id uint) (err error)
|
|
}
|
|
|
|
type FileObjectStore interface {
|
|
ListFileObjects(ctx context.Context, page, pageSize uint64) (params.FileObjectPaginatedResponse, error)
|
|
SearchFileObjectByTags(ctx context.Context, tags []string, page, pageSize uint64) (params.FileObjectPaginatedResponse, error)
|
|
GetFileObject(ctx context.Context, objID uint) (params.FileObject, error)
|
|
CreateFileObject(ctx context.Context, param params.CreateFileObjectParams, reader io.Reader) (fileObjParam params.FileObject, err error)
|
|
UpdateFileObject(ctx context.Context, objID uint, param params.UpdateFileObjectParams) (params.FileObject, error)
|
|
DeleteFileObject(ctx context.Context, objID uint) error
|
|
DeleteFileObjectsByTags(ctx context.Context, tags []string) (int64, error)
|
|
OpenFileObjectContent(ctx context.Context, objID uint) (io.ReadCloser, error)
|
|
}
|
|
|
|
//go:generate go run github.com/vektra/mockery/v2@latest
|
|
type Store interface {
|
|
RepoStore
|
|
OrgStore
|
|
EnterpriseStore
|
|
PoolStore
|
|
UserStore
|
|
InstanceStore
|
|
JobsStore
|
|
GithubEndpointStore
|
|
GithubCredentialsStore
|
|
ControllerStore
|
|
EntityPoolStore
|
|
ScaleSetsStore
|
|
ScaleSetInstanceStore
|
|
GiteaEndpointStore
|
|
GiteaCredentialsStore
|
|
TemplateStore
|
|
FileObjectStore
|
|
|
|
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
|
|
}
|