Documentation
¶
Index ¶
- Constants
- Variables
- type APIStore
- func (a *APIStore) CheckAndCancelConcurrentBuilds(ctx context.Context, templateID api.TemplateID, buildID uuid.UUID, ...) error
- func (a *APIStore) Close(ctx context.Context) error
- func (a *APIStore) DeleteAccessTokensAccessTokenID(c *gin.Context, accessTokenID string)
- func (a *APIStore) DeleteApiKeysApiKeyID(c *gin.Context, apiKeyID string)
- func (a *APIStore) DeleteSandboxesSandboxID(c *gin.Context, sandboxID string)
- func (a *APIStore) DeleteTemplatesTags(c *gin.Context)
- func (a *APIStore) DeleteTemplatesTemplateID(c *gin.Context, aliasOrTemplateID api.TemplateID)
- func (a *APIStore) DeleteVolumesVolumeID(c *gin.Context, volumeID api.VolumeID)
- func (a *APIStore) GetApiKeys(c *gin.Context)
- func (a *APIStore) GetHealth(c *gin.Context)
- func (a *APIStore) GetNodes(c *gin.Context, params api.GetNodesParams)
- func (a *APIStore) GetNodesNodeID(c *gin.Context, nodeID api.NodeID, params api.GetNodesNodeIDParams)
- func (a *APIStore) GetSandboxes(c *gin.Context, params api.GetSandboxesParams)
- func (a *APIStore) GetSandboxesMetrics(c *gin.Context, params api.GetSandboxesMetricsParams)
- func (a *APIStore) GetSandboxesSandboxID(c *gin.Context, id string)
- func (a *APIStore) GetSandboxesSandboxIDLogs(c *gin.Context, sandboxID string, params api.GetSandboxesSandboxIDLogsParams)
- func (a *APIStore) GetSandboxesSandboxIDMetrics(c *gin.Context, sandboxID string, ...)
- func (a *APIStore) GetSnapshots(c *gin.Context, params api.GetSnapshotsParams)
- func (a *APIStore) GetTeam(ctx context.Context, c *gin.Context, teamID *string) (*types.Team, *api.APIError)
- func (a *APIStore) GetTeamFromAPIKey(ctx context.Context, ginCtx *gin.Context, apiKey string) (*types.Team, *api.APIError)
- func (a *APIStore) GetTeamFromAuthProviderToken(ctx context.Context, ginCtx *gin.Context, teamID string) (*types.Team, *api.APIError)
- func (a *APIStore) GetTeamFromSupabaseToken(ctx context.Context, ginCtx *gin.Context, teamID string) (*types.Team, *api.APIError)
- func (a *APIStore) GetTeams(c *gin.Context)
- func (a *APIStore) GetTeamsTeamIDMetrics(c *gin.Context, teamID string, params api.GetTeamsTeamIDMetricsParams)
- func (a *APIStore) GetTeamsTeamIDMetricsMax(c *gin.Context, teamID string, params api.GetTeamsTeamIDMetricsMaxParams)
- func (a *APIStore) GetTemplates(c *gin.Context, params api.GetTemplatesParams)
- func (a *APIStore) GetTemplatesAliasesAlias(c *gin.Context, alias string)
- func (a *APIStore) GetTemplatesTemplateID(c *gin.Context, templateID api.TemplateID, ...)
- func (a *APIStore) GetTemplatesTemplateIDBuildsBuildIDLogs(c *gin.Context, templateID api.TemplateID, buildID api.BuildID, ...)
- func (a *APIStore) GetTemplatesTemplateIDBuildsBuildIDStatus(c *gin.Context, templateID api.TemplateID, buildID api.BuildID, ...)
- func (a *APIStore) GetTemplatesTemplateIDFilesHash(c *gin.Context, templateID api.TemplateID, hash string)
- func (a *APIStore) GetTemplatesTemplateIDTags(c *gin.Context, templateID api.TemplateID)
- func (a *APIStore) GetUserFromAccessToken(ctx context.Context, ginCtx *gin.Context, accessToken string) (uuid.UUID, *api.APIError)
- func (a *APIStore) GetUserIDFromAuthProviderToken(ctx context.Context, ginCtx *gin.Context, token string) (uuid.UUID, *api.APIError)
- func (a *APIStore) GetV2Sandboxes(c *gin.Context, params api.GetV2SandboxesParams)
- func (a *APIStore) GetV2SandboxesSandboxIDLogs(c *gin.Context, sandboxID api.SandboxID, ...)
- func (a *APIStore) GetVolumes(c *gin.Context)
- func (a *APIStore) GetVolumesVolumeID(c *gin.Context, volumeID api.VolumeID)
- func (a *APIStore) PatchApiKeysApiKeyID(c *gin.Context, apiKeyID string)
- func (a *APIStore) PatchTemplatesTemplateID(c *gin.Context, aliasOrTemplateID api.TemplateID)
- func (a *APIStore) PatchV2TemplatesTemplateID(c *gin.Context, aliasOrTemplateID api.TemplateID)
- func (a *APIStore) PostAccessTokens(c *gin.Context)
- func (a *APIStore) PostAdminTeamsTeamIDBuildsCancel(c *gin.Context, teamID uuid.UUID)
- func (a *APIStore) PostAdminTeamsTeamIDSandboxesKill(c *gin.Context, teamID uuid.UUID)
- func (a *APIStore) PostApiKeys(c *gin.Context)
- func (a *APIStore) PostNodesNodeID(c *gin.Context, nodeId api.NodeID)
- func (a *APIStore) PostSandboxes(c *gin.Context)
- func (a *APIStore) PostSandboxesSandboxIDConnect(c *gin.Context, sandboxID api.SandboxID)
- func (a *APIStore) PostSandboxesSandboxIDPause(c *gin.Context, sandboxID api.SandboxID)
- func (a *APIStore) PostSandboxesSandboxIDRefreshes(c *gin.Context, sandboxID string)
- func (a *APIStore) PostSandboxesSandboxIDResume(c *gin.Context, sandboxID api.SandboxID)
- func (a *APIStore) PostSandboxesSandboxIDSnapshots(c *gin.Context, sandboxID api.SandboxID)
- func (a *APIStore) PostSandboxesSandboxIDTimeout(c *gin.Context, sandboxID string)
- func (a *APIStore) PostTemplates(c *gin.Context)
- func (a *APIStore) PostTemplatesTags(c *gin.Context)
- func (a *APIStore) PostTemplatesTemplateID(c *gin.Context, rawTemplateID api.TemplateID)
- func (a *APIStore) PostTemplatesTemplateIDBuildsBuildID(c *gin.Context, templateID api.TemplateID, buildID api.BuildID)
- func (a *APIStore) PostV2Templates(c *gin.Context)
- func (a *APIStore) PostV2TemplatesTemplateIDBuildsBuildID(c *gin.Context, templateID api.TemplateID, buildID api.BuildID)
- func (a *APIStore) PostV3Templates(c *gin.Context)
- func (a *APIStore) PostVolumes(c *gin.Context)
- func (a *APIStore) PutSandboxesSandboxIDNetwork(c *gin.Context, sandboxID string)
- type InvalidMount
- type InvalidVolumeMountsError
- type SandboxService
Constants ¶
const ( InstanceIDPrefix = "i" // Network validation error messages ErrMsgDomainsRequireBlockAll = "When specifying allowed domains in allow out, you must include 'ALL_TRAFFIC' in deny out to block all other traffic." )
Variables ¶
var ErrClusterNotFound = errors.New("cluster not found")
var ErrNoHealthyOrchestratorFound = errors.New("no healthy orchestrator found")
var ErrUnknownVolumeType = errors.New("unknown volume type")
var ErrVolumeMountsDisabled = errors.New("volume mounts are not enabled")
Functions ¶
This section is empty.
Types ¶
type APIStore ¶
type APIStore struct {
Healthy atomic.Bool
Telemetry *telemetry.Client
// contains filtered or unexported fields
}
func NewAPIStore ¶
func (*APIStore) CheckAndCancelConcurrentBuilds ¶
func (a *APIStore) CheckAndCancelConcurrentBuilds(ctx context.Context, templateID api.TemplateID, buildID uuid.UUID, teamClusterID uuid.UUID) error
CheckAndCancelConcurrentBuilds checks for concurrent builds and cancels them if found
func (*APIStore) DeleteAccessTokensAccessTokenID ¶
func (*APIStore) DeleteApiKeysApiKeyID ¶
func (*APIStore) DeleteSandboxesSandboxID ¶
func (*APIStore) DeleteTemplatesTags ¶
DeleteTemplatesTags deletes multiple tags from a template
func (*APIStore) DeleteTemplatesTemplateID ¶
func (a *APIStore) DeleteTemplatesTemplateID(c *gin.Context, aliasOrTemplateID api.TemplateID)
DeleteTemplatesTemplateID serves to delete a template (e.g. in CLI)
func (*APIStore) DeleteVolumesVolumeID ¶
func (*APIStore) GetApiKeys ¶
func (*APIStore) GetNodesNodeID ¶
func (*APIStore) GetSandboxes ¶
func (a *APIStore) GetSandboxes(c *gin.Context, params api.GetSandboxesParams)
func (*APIStore) GetSandboxesMetrics ¶
func (a *APIStore) GetSandboxesMetrics(c *gin.Context, params api.GetSandboxesMetricsParams)
func (*APIStore) GetSandboxesSandboxID ¶
func (*APIStore) GetSandboxesSandboxIDLogs ¶
func (*APIStore) GetSandboxesSandboxIDMetrics ¶
func (*APIStore) GetSnapshots ¶
func (a *APIStore) GetSnapshots(c *gin.Context, params api.GetSnapshotsParams)
func (*APIStore) GetTeamFromAPIKey ¶
func (*APIStore) GetTeamFromAuthProviderToken ¶
func (*APIStore) GetTeamFromSupabaseToken ¶
func (*APIStore) GetTeamsTeamIDMetrics ¶
func (*APIStore) GetTeamsTeamIDMetricsMax ¶
func (*APIStore) GetTemplates ¶
func (a *APIStore) GetTemplates(c *gin.Context, params api.GetTemplatesParams)
GetTemplates serves to list templates (e.g. in CLI)
func (*APIStore) GetTemplatesAliasesAlias ¶
func (*APIStore) GetTemplatesTemplateID ¶
func (a *APIStore) GetTemplatesTemplateID(c *gin.Context, templateID api.TemplateID, params api.GetTemplatesTemplateIDParams)
func (*APIStore) GetTemplatesTemplateIDBuildsBuildIDLogs ¶
func (a *APIStore) GetTemplatesTemplateIDBuildsBuildIDLogs(c *gin.Context, templateID api.TemplateID, buildID api.BuildID, params api.GetTemplatesTemplateIDBuildsBuildIDLogsParams)
func (*APIStore) GetTemplatesTemplateIDBuildsBuildIDStatus ¶
func (a *APIStore) GetTemplatesTemplateIDBuildsBuildIDStatus(c *gin.Context, templateID api.TemplateID, buildID api.BuildID, params api.GetTemplatesTemplateIDBuildsBuildIDStatusParams)
GetTemplatesTemplateIDBuildsBuildIDStatus serves to get a template build status (e.g. to CLI)
func (*APIStore) GetTemplatesTemplateIDFilesHash ¶
func (*APIStore) GetTemplatesTemplateIDTags ¶
func (a *APIStore) GetTemplatesTemplateIDTags(c *gin.Context, templateID api.TemplateID)
GetTemplatesTemplateIDTags lists all tags for a template
func (*APIStore) GetUserFromAccessToken ¶
func (*APIStore) GetUserIDFromAuthProviderToken ¶
func (*APIStore) GetV2Sandboxes ¶
func (a *APIStore) GetV2Sandboxes(c *gin.Context, params api.GetV2SandboxesParams)
func (*APIStore) GetV2SandboxesSandboxIDLogs ¶
func (*APIStore) GetVolumes ¶
func (*APIStore) GetVolumesVolumeID ¶
func (*APIStore) PatchApiKeysApiKeyID ¶
func (*APIStore) PatchTemplatesTemplateID ¶
func (a *APIStore) PatchTemplatesTemplateID(c *gin.Context, aliasOrTemplateID api.TemplateID)
PatchTemplatesTemplateID serves to update a template (v1 - deprecated, for older CLIs, creates backward-compatible aliases)
func (*APIStore) PatchV2TemplatesTemplateID ¶
func (a *APIStore) PatchV2TemplatesTemplateID(c *gin.Context, aliasOrTemplateID api.TemplateID)
PatchV2TemplatesTemplateID serves to update a template (v2 - for new CLIs)
func (*APIStore) PostAccessTokens ¶
func (*APIStore) PostAdminTeamsTeamIDBuildsCancel ¶
func (*APIStore) PostAdminTeamsTeamIDSandboxesKill ¶
func (*APIStore) PostApiKeys ¶
func (*APIStore) PostNodesNodeID ¶
func (*APIStore) PostSandboxes ¶
func (*APIStore) PostSandboxesSandboxIDConnect ¶
func (*APIStore) PostSandboxesSandboxIDPause ¶
func (*APIStore) PostSandboxesSandboxIDRefreshes ¶
func (*APIStore) PostSandboxesSandboxIDResume ¶
func (*APIStore) PostSandboxesSandboxIDSnapshots ¶
func (*APIStore) PostSandboxesSandboxIDTimeout ¶
func (*APIStore) PostTemplates ¶
func (*APIStore) PostTemplatesTags ¶
PostTemplatesTags assigns tags to a template build The target template is specified in the request body via the "target" field
func (*APIStore) PostTemplatesTemplateID ¶
func (a *APIStore) PostTemplatesTemplateID(c *gin.Context, rawTemplateID api.TemplateID)
func (*APIStore) PostTemplatesTemplateIDBuildsBuildID ¶
func (a *APIStore) PostTemplatesTemplateIDBuildsBuildID(c *gin.Context, templateID api.TemplateID, buildID api.BuildID)
PostTemplatesTemplateIDBuildsBuildID triggers a new build after the user pushes the Docker image to the registry
func (*APIStore) PostV2Templates ¶
PostV2Templates triggers a new template build
func (*APIStore) PostV2TemplatesTemplateIDBuildsBuildID ¶
func (a *APIStore) PostV2TemplatesTemplateIDBuildsBuildID(c *gin.Context, templateID api.TemplateID, buildID api.BuildID)
PostV2TemplatesTemplateIDBuildsBuildID triggers a new build
func (*APIStore) PostV3Templates ¶
PostV3Templates triggers a new template build
func (*APIStore) PostVolumes ¶
type InvalidMount ¶
type InvalidVolumeMountsError ¶
type InvalidVolumeMountsError struct {
InvalidMounts []InvalidMount
}
func (InvalidVolumeMountsError) Error ¶
func (im InvalidVolumeMountsError) Error() string
type SandboxService ¶
type SandboxService struct {
proxygrpc.UnimplementedSandboxServiceServer
// contains filtered or unexported fields
}
func NewSandboxService ¶
func NewSandboxService(api *APIStore, requireEdgeClientProxyAuth bool, clientProxyOAuth oauth.Verifier) *SandboxService
func (*SandboxService) ResumeSandbox ¶
func (s *SandboxService) ResumeSandbox(ctx context.Context, req *proxygrpc.SandboxResumeRequest) (*proxygrpc.SandboxResumeResponse, error)
Source Files
¶
- accesstoken.go
- admin.go
- admin_cancel_team_builds.go
- admin_kill_team_sandboxes.go
- apikey.go
- auth.go
- deprecated_template_request_build.go
- deprecated_template_request_build_v2.go
- deprecated_template_start_build.go
- proxy_grpc.go
- sandbox.go
- sandbox_connect.go
- sandbox_create.go
- sandbox_get.go
- sandbox_kill.go
- sandbox_logs.go
- sandbox_metrics.go
- sandbox_network_update.go
- sandbox_pause.go
- sandbox_refresh.go
- sandbox_resume.go
- sandbox_timeout.go
- sandboxes_list.go
- sandboxes_list_metrics.go
- snapshot_template_create.go
- snapshot_template_list.go
- store.go
- team_metrics.go
- team_metrics_max.go
- teams.go
- template_alias.go
- template_build_logs.go
- template_build_status.go
- template_delete.go
- template_get.go
- template_layer_files_upload.go
- template_request_build_v3.go
- template_start_build_v2.go
- template_tags.go
- template_update.go
- templates_list.go
- timeout_helper.go
- volume_create.go
- volume_delete.go
- volume_get.go
- volume_token.go
- volume_util.go
- volumes_list.go