store

package
v0.0.0-...-aa36cb2 Latest Latest
Warning

This package is not in the latest version of its module.

 Go to latest Published: Nov 15, 2024 License: AGPL-3.0 Imports: 10 Imported by: 0

Documentation

Index

Constants

This section is empty.

Variables

View Source 
var ErrAppNotFound = errors.New("app not found")
View Source 
var ErrDuplicateWaitlistEntry = errors.New("email already exists in waitlist")

ErrDuplicateWaitlistEntry is returned when trying to add a duplicate email to the waitlist

View Source 
var ErrEnvNotFound = errors.New("env not found")

Functions

func NewStoreTestSuite 

func NewStoreTestSuite(stores TestStoresConfig) func(t *testing.T)

Types

type ApiToken 

type ApiToken struct {
	Common
	TeamId     string        `json:"team_id" gorm:"index"`
	CreatorId  string        `json:"creator_id"`
	Name       string        `json:"name"`
	Token      string        `json:"token" gorm:"uniqueIndex"`
	Scope      ApiTokenScope `json:"scope"`
	LastUsedAt *time.Time    `json:"last_used"`
}

ApiToken represents an API token for a team

type ApiTokenScope 

type ApiTokenScope string

ApiTokenScope represents the access level of an API token 

const (
	ApiTokenScopeAdmin ApiTokenScope = "admin"
)

type ApiTokenStore 

type ApiTokenStore interface {
	Create(teamId string, creatorId string, name string, scope ApiTokenScope) (*ApiToken, error)
	Get(id string) (*ApiToken, error)
	GetByToken(token string) (*ApiToken, error)
	List(teamId string) ([]ApiToken, error)
	Delete(id string) error
	UpdateLastUsedAt(id string, lastUsedAt time.Time) error
}

ApiTokenStore interface for managing API tokens

type App 

type App struct {
	Common
	TeamId    string    `json:"team_id" gorm:"index:idx_team_createdat"`
	UserId    string    `json:"user_id"`
	Name      string    `json:"name"`
	CreatedAt time.Time `gorm:"index:idx_team_createdat"`
}

type AppEnvVars 

type AppEnvVars struct {
	Common
	TeamId  string
	EnvId   string
	AppId   string
	EnvVars datatypes.JSONType[[]EnvVar]
}

type AppSettings 

type AppSettings struct {
	Common
	TeamId        string                            `json:"team_id"`
	AppId         string                            `json:"app_id"`
	Artifact      datatypes.JSONType[Artifact]      `gorm:"type:jsonb" json:"artifact"`
	Ports         datatypes.JSONType[Ports]         `gorm:"type:jsonb" json:"ports"`
	ExternalPorts datatypes.JSONType[ExternalPorts] `gorm:"type:jsonb" json:"external_ports"`
	Resources     datatypes.JSONType[Resources]     `gorm:"type:jsonb" json:"resources"`
}

type AppStore 

type AppStore interface {
	Create(opts CreateAppOptions) (App, error)
	Get(ctx context.Context, id string) (App, error)
	Delete(ctx context.Context, id string) error
	GetForTeam(ctx context.Context, teamId string) ([]App, error)
	CreateAppSettings(opts CreateAppSettingsOptions) (AppSettings, error)
	GetAppSettings(id string) (AppSettings, error)
}

type Artifact 

type Artifact struct {
	Image *ImageArtifact
}

type Bandwidth 

type Bandwidth struct {
	SpeedGbps int
	Unlimited bool
}

Bandwidth available on a server

type Build 

type Build struct {
	Common
	TeamId       string
	CreatorId    string
	AppId        string
	Status       BuildStatus
	StatusReason string
	Logs         datatypes.JSONType[BuildLogs]
	Artifacts    datatypes.JSONType[[]Artifact]
}

type BuildLog 

type BuildLog struct {
	Time    time.Time `json:"time"`
	Message string    `json:"message"`
}

type BuildLogs 

type BuildLogs []BuildLog

type BuildStatus 

type BuildStatus string
const (
	BuildStatusPending   BuildStatus = "pending"
	BuildStatusBuilding  BuildStatus = "building"
	BuildStatusCompleted BuildStatus = "completed"
	BuildStatusFailed    BuildStatus = "failed"
)

type BuildStore 

type BuildStore interface {
	Init(ctx context.Context, opts InitBuildOptions) (Build, error)
	Get(ctx context.Context, id string) (Build, error)
	UpdateStatus(ctx context.Context, id string, status BuildStatus, statusReason string) error
	UpdateLogs(ctx context.Context, id string, logs BuildLogs) error
	UpdateArtifacts(ctx context.Context, id string, artifacts []Artifact) error
}

type Cell 

type Cell struct {
	Common
	Type        CellType
	Name        string
	TeamId      string
	Description string

	// relations
	Servers       []Server
	TalosCellData *TalosCellData `gorm:"foreignKey:CellId;references:Id"`
	Deployments   []Deployment   `gorm:"many2many:deployment_cells;"`
}

Cell is a group of servers, primarily used as to separate workloads from any combination of environments / teams / etc.

type CellStore 

type CellStore interface {
	Create(c Cell) (Cell, error)
	Get(id string) (Cell, error)
	GetForTeam(ctx context.Context, teamId string) ([]Cell, error)
	UpdateTalosCellData(talosCellData *TalosCellData) error
	AddServer(cellId string, server Server) error
}

type CellType 

type CellType string
const (
	CellTypeTalos CellType = "talos"
)

type Common 

type Common struct {
	Id        string         `gorm:"primaryKey" json:"id"`
	CreatedAt time.Time      `json:"created_at"`
	UpdatedAt time.Time      `json:"updated_at"`
	DeletedAt gorm.DeletedAt `gorm:"index"`
}

type Cpu 

type Cpu struct {
	Brand        string
	Family       string
	Name         string
	Cores        int
	Threads      int
	BaseSpeedGHz float64
	MaxSpeedGHz  float64
	Arch         string
}

Cpu description on a server offering

type CreateAppEnvVarOptions 

type CreateAppEnvVarOptions struct {
	TeamId  string   `validate:"required"`
	EnvId   string   `validate:"required"`
	AppId   string   `validate:"required"`
	EnvVars []EnvVar `validate:"required"`
}

type CreateAppOptions 

type CreateAppOptions struct {
	Name   string `validate:"required,lowercasealphanumhyphen"`
	TeamId string `validate:"required"`
	UserId string `validate:"required"`
}

type CreateAppSettingsOptions 

type CreateAppSettingsOptions struct {
	TeamId        string        `validate:"required"`
	AppId         string        `validate:"required"`
	Artifact      Artifact      `validate:"required"`
	Ports         Ports         `validate:"required"`
	ExternalPorts ExternalPorts `validate:"required"`
	Resources     Resources     `validate:"required"`
}

type CreateDeploymentOptions 

type CreateDeploymentOptions struct {
	TeamId        string         `validate:"required"`
	EnvId         string         `validate:"required"`
	AppId         string         `validate:"required"`
	Type          DeploymentType `validate:"required,oneof=deploy rollback scale restart"`
	AppSettingsId string         `validate:"required"`
	AppEnvVarsId  string         `validate:"required"`
	CellIds       []string       `validate:"required"`
	Replicas      int            `validate:"required"`
}

type CreateEnvOptions 

type CreateEnvOptions struct {
	TeamId string `validate:"required"`
	Name   string `validate:"required,lowercasealphanumhyphen"`
}

type Currency 

type Currency string
const (
	CurrencyUSD Currency = "USD"
	CurrencyEUR Currency = "EUR"
)

type Deployment 

type Deployment struct {
	Id            uint   `gorm:"primarykey"`
	EnvId         string `gorm:"primaryKey;index"`
	AppId         string `gorm:"primaryKey;index:idx_app_createdat"`
	TeamId        string `gorm:"index:idx_team_createdat"`
	Env           Env    `gorm:"foreignKey:EnvId"`
	App           App    `gorm:"foreignKey:AppId"`
	Type          DeploymentType
	Status        DeploymentStatus
	StatusReason  string
	Replicas      int
	AppSettingsId string
	AppSettings   AppSettings `gorm:"foreignKey:AppSettingsId"`
	AppEnvVarsId  string
	AppEnvVars    AppEnvVars `gorm:"foreignKey:AppEnvVarsId"`
	Cells         []Cell     `gorm:"many2many:deployment_cells;"`
	CreatedAt     time.Time  `gorm:"index:idx_app_createdat;index:idx_team_createdat"`
	UpdatedAt     time.Time
	DeletedAt     gorm.DeletedAt `gorm:"index"`
}

Deployment has a monotonic id that is incremented for each deployment of an app/env combination

func (*Deployment) BeforeCreate 

func (d *Deployment) BeforeCreate(tx *gorm.DB) error

type DeploymentStatus 

type DeploymentStatus string
const (
	DeploymentStatusPending   DeploymentStatus = "pending"
	DeploymentStatusDeploying DeploymentStatus = "deploying"
	DeploymentStatusRunning   DeploymentStatus = "running"
	DeploymentStatusFailed    DeploymentStatus = "failed"
	DeploymentStatusStopped   DeploymentStatus = "stopped"
)

type DeploymentStore 

type DeploymentStore interface {
	CreateEnv(opts CreateEnvOptions) (Env, error)
	GetEnv(id string) (Env, error)
	GetEnvsForTeam(teamId string) ([]Env, error)
	DeleteEnv(id string) error

	CreateAppEnvVars(opts CreateAppEnvVarOptions) (AppEnvVars, error)
	GetAppEnvVars(id string) (AppEnvVars, error)
	GetAppEnvVarsForAppEnv(appId string, envId string) ([]AppEnvVars, error)
	DeleteAppEnvVars(id string) error

	Create(opts CreateDeploymentOptions) (Deployment, error)
	Get(appId string, envId string, id uint) (Deployment, error)
	GetForTeam(ctx context.Context, teamId string) ([]Deployment, error)
	GetForApp(ctx context.Context, appId string) ([]Deployment, error)
	GetForAppEnv(ctx context.Context, appId string, envId string) ([]Deployment, error)
	GetLatestForAppEnv(ctx context.Context, appId string, envId string) (*Deployment, error)
	GetForEnv(envId string) ([]Deployment, error)
	GetForCell(cellId string) ([]Deployment, error)
	DeleteDeployment(appId string, envId string, id uint) error
	UpdateDeploymentStatus(appId string, envId string, id uint, status DeploymentStatus, statusReason string) error
}

DeploymentStore allows for - creating, retrieving (by teamId), and deleting environments - creating, retrieving (by teamId, appId, envId), and deleting AppEnvVars - creating, retrieving (by teamId or by Id or by appId, or by envId, or by cellId), and deleting Deployments

type DeploymentType 

type DeploymentType string
const (
	DeploymentTypeDeploy   DeploymentType = "deploy"
	DeploymentTypeRollback DeploymentType = "rollback"
	DeploymentTypeScale    DeploymentType = "scale"
	DeploymentTypeRestart  DeploymentType = "restart"
)

type Disk 

type Disk struct {
	SizeGB int
	Type   string // e.g. ssd, hdd
	Device string // e.g. sda, sdb
}

Disk available on a server

type Env 

type Env struct {
	Common
	TeamId string
	Name   string
}

type EnvVar 

type EnvVar struct {
	Name  string
	Value string
}

type ExternalPort 

type ExternalPort struct {
	Name     string `validate:"required,lowercasealphanumhyphen"`
	PortName string `validate:"required,lowercasealphanumhyphen"` // reference to a Port
	Proto    string `validate:"required,oneof=http https"`
	Port     int    `validate:"required"`
}

type ExternalPorts 

type ExternalPorts []ExternalPort

type ImageArtifact 

type ImageArtifact struct {
	// Registry is optional. If not provided, dockerhub is used. Else, it could be something like registry.k8s.io.
	Registry string `json:"registry"`
	// Repository of the image. Required. E.g. busybox, stefanprodan/podinfo
	Repository string `json:"repository" validate:"required"`
	// Tag of the image. If not specified, latest is used.
	Tag string `json:"tag"`
	// Digest of the image can be used in place of a tag. E.g. sha256:1ff6c18fbef2045af6b9c16bf034cc421a29027b800e4f9
	Digest string `json:"digest"`
}

func (*ImageArtifact) Name 

func (i *ImageArtifact) Name() string

Name returns the full name of the image: <registry>/<repository>:<tag>

type InitBuildOptions 

type InitBuildOptions struct {
	TeamId    string `validate:"required"`
	CreatorId string `validate:"required"`
	AppId     string `validate:"required"`
}

type InviteStore 

type InviteStore interface {
	Add(email string) error
	Get(email string) (*InvitedUser, error)
}

type InvitedUser 

type InvitedUser struct {
	Email     string    `gorm:"primaryKey" validate:"required,email"`
	CreatedAt time.Time `gorm:"index"`
}

type Location 

type Location struct {
	Id        string // e.g. hel1
	Continent string
	Country   string
	City      string
}

Location of a server. Servers have a location that can be broken down into - continent, e.g. North America - country, e.g. United States of America - city, e.g. Dallas

type PaymentMethod 

type PaymentMethod struct {
	Common
	TeamId                string `json:"team_id" gorm:"uniqueIndex:idx_team_payment_method"`
	StripePaymentMethodId string `json:"stripe_payment_method_id" gorm:"uniqueIndex:idx_team_payment_method"`
	Default               bool   `json:"default"`
	Type                  string `json:"type"` // e.g., "card", "bank_account"
	Last4                 string `json:"last4"`
	ExpirationMonth       int    `json:"expiration_month,omitempty"`
	ExpirationYear        int    `json:"expiration_year,omitempty"`
}

type Port 

type Port struct {
	Name  string `validate:"required,lowercasealphanumhyphen"`
	Port  int    `validate:"required"`
	Proto string `validate:"required,oneof=http"`
}

type Ports 

type Ports []Port

type Price 

type Price struct {
	LocationId               string
	Setup                    float64
	Hourly                   float64
	Daily                    float64
	Monthly                  float64
	MonthlyOneYearUpfront    *float64 // potentially discounted
	MonthlyThreeYearsUpfront *float64 // potentially discounted
	Currency                 Currency
}

Price of a server offering

type ProviderSlug 

type ProviderSlug string
const (
	ProviderSlugHetzner ProviderSlug = "hetzner"
	ProviderSlugOVHUS   ProviderSlug = "ovh-us"
)

type ResourceLimits 

type ResourceLimits struct {
	CpuCores  float64 `json:"cpu_cores"`
	MemoryMiB int     `json:"memory_mib"`
}

type ResourceRequests 

type ResourceRequests struct {
	CpuCores  float64 `json:"cpu_cores"`
	MemoryMiB int     `json:"memory_mib"`
}

type Resources 

type Resources struct {
	Limits   ResourceLimits   `json:"limits"`
	Requests ResourceRequests `json:"requests"`
}

type Server 

type Server struct {
	Common
	// TeamId is the team that owns this server
	TeamId string
	// UserId is the user that created this server
	UserId string
	// OfferingId is the id of the server offering that this server is based on
	OfferingId string
	// LocationId is the location of the server
	LocationId string
	// Status is the current status of the server
	Status ServerStatus

	// ProviderSlug is the provider name, e.g. hetzner
	ProviderSlug string
	// ProviderId is the id within the provider
	ProviderId *string
	// PublicIpv4 is the public IP of the server
	PublicIpv4 *string

	// CellId is the id of the cell that this server belongs to
	CellId *string `gorm:"constraint:OnDelete:SET NULL"`

	// BillingStripeHourlyUsage keeps track of hourly billing for the server (nullabe in case of different billing schemes in the future)
	BillingStripeUsageBasedHourly *ServerBillingStripeUsageBasedHourly `gorm:"foreignKey:ServerId;references:Id"`
}

type ServerBillingStripeUsageBasedHourly 

type ServerBillingStripeUsageBasedHourly struct {
	ServerId string `gorm:"primaryKey"`
	// EventName is the event we send to stripe. We configure this as a "count" i.e. 1 event = 1 hour of usage
	EventName string
	// LastEventSent is the last time we sent an event to stripe and can be used to determine if we need to send one or more new events
	LastEventSent sql.NullTime
}

ServerStripeUsageBasedHourly keeps track of the last time we recorded a usage event for a server

type ServerOffering 

type ServerOffering struct {
	Id             string
	ProviderSlug   ProviderSlug // e.g. hetzner
	Type           string       // e.g. AX42
	Description    string
	Locations      []Location
	Prices         []Price
	Cpu            Cpu
	MemoryGB       int
	Disks          []Disk
	TotalStorageGB int
	Bandwidth      Bandwidth
}

ServerOffering is a server that can be purchased.

type ServerOfferingStore 

type ServerOfferingStore interface {
	GetServerOfferings() ([]ServerOffering, error)
	GetServerOffering(id string) (*ServerOffering, error)
}

type ServerStatus 

type ServerStatus string
const (
	ServerStatusPendingPayment  ServerStatus = "pending-payment"
	ServerStatusPendingProvider ServerStatus = "pending-provider"
	ServerStatusRunning         ServerStatus = "running"
	ServerStatusRunningCanceled ServerStatus = "running-canceled"
	ServerStatusDestroyed       ServerStatus = "destroyed"
)

type ServerStore 

type ServerStore interface {
	Create(s Server) (Server, error)
	Get(id string) (Server, error)
	UpdateServerStatus(serverId string, status ServerStatus) error
	UpdateServerPublicIpv4(serverId string, publicIpv4 string) error
	UpdateServerBillingStripeUsageBasedHourly(serverId string, usageBasedHourly *ServerBillingStripeUsageBasedHourly) error
	UpdateProviderId(serverId string, providerId string) error
	GetServersForTeam(ctx context.Context, teamId string) ([]Server, error)
}

type TalosCellData 

type TalosCellData struct {
	CellId      string `gorm:"primaryKey"`
	Talosconfig string
	Kubecfg     string
	Config      []byte
}

type Team 

type Team struct {
	Common
	Name             string             `json:"name"`
	Description      string             `json:"description"`
	StripeCustomerId string             `json:"stripe_customer_id"`
	AgePublicKey     string             `json:"age_public_key"`
	AgePrivateKey    string             `json:"-"`
	InvitedMembers   []TeamMemberInvite `json:"invited_members"`
	Members          []TeamMember       `json:"members"`
	PaymentMethods   []PaymentMethod    `json:"payment_methods"`

	// relations
	Servers     []Server     `gorm:"foreignKey:TeamId"`
	Cells       []Cell       `gorm:"foreignKey:TeamId"`
	Apps        []App        `gorm:"foreignKey:TeamId"`
	Envs        []Env        `gorm:"foreignKey:TeamId"`
	Deployments []Deployment `gorm:"foreignKey:TeamId"`
	ApiTokens   []ApiToken   `gorm:"foreignKey:TeamId"`
}

type TeamMember 

type TeamMember struct {
	UserId    string    `gorm:"primaryKey" json:"user_id"`
	User      User      `gorm:"foreignKey:UserId"`
	TeamId    string    `gorm:"primaryKey" json:"team_id"`
	Role      TeamRole  `json:"role"`
	CreatedAt time.Time `json:"created_at"`
	UpdatedAt time.Time `json:"updated_at"`
}

type TeamMemberInvite 

type TeamMemberInvite struct {
	TeamId    string
	Email     string    `json:"email" gorm:"index"`
	Role      TeamRole  `json:"role"`
	CreatedAt time.Time `json:"created_at"`
}

type TeamRole 

type TeamRole string
const (
	TeamRoleAdmin  TeamRole = "admin"
	TeamRoleMember TeamRole = "member"
)

type TeamStore 

type TeamStore interface {
	CreateTeam(name string, description string) (*Team, error)
	GetTeam(ctx context.Context, id string) (*Team, error)
	GetTeamKeys(id string) (string, string, error)
	AddUserToTeam(userId string, teamId string) error
	RemoveUserFromTeam(userId string, teamId string) error
	CreateTeamInvite(email string, teamId string) error
	DeleteTeamInvite(email string, teamId string) error
	GetInvitesForEmail(email string) ([]TeamMemberInvite, error)
	CreateStripeCustomer(ctx context.Context, teamId string, billingEmail string) error
	AddPaymentMethod(ctx context.Context, teamId string, paymentMethodData PaymentMethod) error
	RemovePaymentMethod(teamId string, paymentMethodId string) error
	GetPaymentMethods(teamId string) ([]PaymentMethod, error)
}

type TestStoresConfig 

type TestStoresConfig struct {
	WaitlistStore   WaitlistStore
	UserStore       UserStore
	TeamStore       TeamStore
	ServerStore     ServerStore
	CellStore       CellStore
	AppStore        AppStore
	DeploymentStore DeploymentStore
	ApiTokenStore   ApiTokenStore
	BuildStore      BuildStore
}

type User 

type User struct {
	Common
	Email           string       `json:"email"`
	Password        string       `json:"-"`
	TeamMemberships []TeamMember `json:"team_memberships"`

	// relations
	Servers []Server `gorm:"foreignKey:UserId"`
	Apps    []App    `gorm:"foreignKey:UserId"`
}

type UserStore 

type UserStore interface {
	CreateUser(email string, password string) error
	GetUser(email string) (*User, error)
	GetUserById(id string) (*User, error)
}

type WaitlistStore 

type WaitlistStore interface {
	Add(ctx context.Context, email string) error
}

type WaitlistedUser 

type WaitlistedUser struct {
	Email     string    `gorm:"primaryKey" validate:"required,email"`
	CreatedAt time.Time `gorm:"index"`
}

Source Files

View all Source files

Directories

Path Synopsis

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL
go.dev uses cookies from Google to deliver and enhance the quality of its services and to analyze traffic. Learn more.