domain

package

Go to main page

Versions in this module

v1

v1.2.0

Dec 21, 2023

Changes in this version

type AppCleanupRequested

+ func (AppCleanupRequested) Name_() string

type AppCreated

+ func (AppCreated) Name_() string

type AppDeleted

+ func (AppDeleted) Name_() string

type AppEnvChanged

+ func (AppEnvChanged) Name_() string

type AppEnvRemoved

+ func (AppEnvRemoved) Name_() string

type AppVCSConfigured

+ func (AppVCSConfigured) Name_() string

type AppVCSRemoved

+ func (AppVCSRemoved) Name_() string

type DeploymentCreated

+ func (DeploymentCreated) Name_() string

type DeploymentStateChanged

+ func (DeploymentStateChanged) Name_() string

type SourceData

+ Kind func() string

v1.1.0

Nov 17, 2023

Changes in this version

+ var ErrInvalidSourcePayload = errors.New("invalid_source_payload")

+ var ErrNoValidSourceFound = errors.New("no_valid_source_found")

+ var SourceDataTypes = storage.NewDiscriminatedMapper[SourceData]()

+ type ArtifactManager interface

+ Cleanup func(context.Context, App) error

+ LogPath func(context.Context, Deployment) string

+ PrepareBuild func(context.Context, Deployment) (string, DeploymentLogger, error)

type Deployment

+ func (d Deployment) Requested() shared.Action[domain.UserID]

+ func (d Deployment) Source() SourceData

type DeploymentCreated

+ Source SourceData

+ type DeploymentLogger interface

+ Error func(error)

+ Infof func(string, ...any)

+ Stepf func(string, ...any)

+ Warnf func(string, ...any)

+ type Source interface

+ Fetch func(context.Context, string, DeploymentLogger, Deployment) error

+ Prepare func(App, any) (SourceData, error)

+ type SourceData interface

+ NeedVCS func() bool

v1.0.3

Jul 4, 2023

v1.0.2

Jun 12, 2023

Changes in this version

+ var ErrInvalidSourceDeployment = apperr.New("invalid_source_deployment")

v1.0.1

May 25, 2023

v1.0.0

May 22, 2023

Changes in this version

+ var ErrAppCleanupNeeded = apperr.New("app_cleanup_needed")

+ var ErrAppCleanupRequested = apperr.New("app_cleanup_requested")

+ var ErrAppHasRunningOrPendingDeployments = apperr.New("app_has_running_or_pending_deployments")

+ var ErrAppNameAlreadyTaken = apperr.New("app_name_already_taken")

+ var ErrCouldNotPromoteProductionDeployment = apperr.New("could_not_promote_production_deployment")

+ var ErrInvalidAppName = apperr.New("invalid_app_name")

+ var ErrInvalidEnvironmentName = apperr.New("invalid_environment_name")

+ var ErrInvalidTriggerPayload = apperr.New("invalid_trigger_payload")

+ var ErrInvalidUrl = apperr.New("invalid_url")

+ var ErrNoValidTriggerFound = apperr.New("no_valid_trigger_found")

+ var ErrNotInPendingState = apperr.New("not_in_pending_state")

+ var ErrNotInRunningState = apperr.New("not_in_running_state")

+ var ErrTriggerFetchFailed = apperr.New("trigger_fetch_failed")

+ var ErrVCSNotConfigured = apperr.New("vcs_not_configured")

+ type App struct

+ func AppFrom(scanner storage.Scanner) (a App, err error)

+ func NewApp(name UniqueAppName, createdBy domain.UserID) (app App)

+ func (a *App) Delete(deployments RunningOrPendingAppDeploymentsCount) error

+ func (a *App) HasEnvironmentVariables(vars EnvironmentsEnv)

+ func (a *App) RemoveEnvironmentVariables()

+ func (a *App) RemoveVersionControl()

+ func (a *App) RequestCleanup(requestedBy domain.UserID)

+ func (a *App) UseVersionControl(config VCSConfig)

+ func (a App) ID() AppID

+ func (a App) NewDeployment(deployNumber DeploymentNumber, meta Meta, env Environment, ...) (d Deployment, err error)

+ func (a App) Path(relativeTo ...string) string

+ func (a App) Promote(source Deployment, deployNumber DeploymentNumber, tmpl DeploymentDirTemplate, ...) (d Deployment, err error)

+ func (a App) Redeploy(source Deployment, deployNumber DeploymentNumber, tmpl DeploymentDirTemplate, ...) (d Deployment, err error)

+ func (a App) VCS() monad.Maybe[VCSConfig]

+ type AppCleanupRequested struct

+ ID AppID

+ Requested shared.Action[domain.UserID]

+ type AppCreated struct

+ Created shared.Action[domain.UserID]

+ ID AppID

+ Name UniqueAppName

+ type AppDeleted struct

+ ID AppID

+ type AppEnvChanged struct

+ Env EnvironmentsEnv

+ ID AppID

+ type AppEnvRemoved struct

+ ID AppID

+ type AppID string

+ type AppName string

+ func AppNameFrom(value string) (AppName, error)

+ type AppVCSConfigured struct

+ Config VCSConfig

+ ID AppID

+ type AppVCSRemoved struct

+ ID AppID

+ type AppsReader interface

+ GetByID func(context.Context, AppID) (App, error)

+ IsNameUnique func(context.Context, AppName) (UniqueAppName, error)

+ type AppsWriter interface

+ Write func(context.Context, ...*App) error

+ type Backend interface

+ Cleanup func(context.Context, App) error

+ Run func(context.Context, Deployment) (Services, error)

+ type Config struct

+ func NewConfig(app App, environment Environment) Config

+ func (c Config) AppName() UniqueAppName

+ func (c Config) Env() monad.Maybe[ServicesEnv]

+ func (c Config) Environment() Environment

+ func (c Config) EnvironmentVariablesFor(service string) (m monad.Maybe[EnvVars])

+ func (c Config) ProjectName() string

+ func (c Config) SubDomain() string

+ type Deployment struct

+ func DeploymentFrom(scanner storage.Scanner) (d Deployment, err error)

+ func (d *Deployment) HasEnded(services Services, deploymentErr error) error

+ func (d *Deployment) HasStarted() error

+ func (d Deployment) Config() Config

+ func (d Deployment) ID() DeploymentID

+ func (d Deployment) LogPath(relativeTo ...string) string

+ func (d Deployment) Path(relativeTo ...string) string

+ func (d Deployment) Trigger() Meta

+ type DeploymentCreated struct

+ Config Config

+ ID DeploymentID

+ Path string

+ Requested shared.Action[domain.UserID]

+ State State

+ Trigger Meta

+ type DeploymentDirTemplate interface

+ Execute func(DeploymentTemplateData) string

+ type DeploymentID struct

+ func DeploymentIDFrom(app AppID, number DeploymentNumber) DeploymentID

+ func (i DeploymentID) AppID() AppID

+ func (i DeploymentID) DeploymentNumber() DeploymentNumber

+ type DeploymentNumber int

+ type DeploymentStateChanged struct

+ ID DeploymentID

+ State State

+ type DeploymentStatus uint8

+ const DeploymentStatusFailed

+ const DeploymentStatusPending

+ const DeploymentStatusRunning

+ const DeploymentStatusSucceeded

+ type DeploymentTemplateData struct

+ Environment Environment

+ Number DeploymentNumber

+ type DeploymentsReader interface

+ GetByID func(context.Context, DeploymentID) (Deployment, error)

+ GetNextDeploymentNumber func(context.Context, AppID) (DeploymentNumber, error)

+ GetRunningDeployments func(context.Context) ([]Deployment, error)

+ GetRunningOrPendingDeploymentsCount func(context.Context, AppID) (RunningOrPendingAppDeploymentsCount, error)

+ type DeploymentsWriter interface

+ Write func(context.Context, ...*Deployment) error

+ type EnvVars map[string]string

+ type Environment string

+ const Production

+ const Staging

+ func EnvironmentFrom(value string) (Environment, error)

+ func (e Environment) IsProduction() bool

+ type EnvironmentsEnv map[Environment]ServicesEnv

+ func EnvironmentsEnvFrom(raw map[string]map[string]map[string]string) (EnvironmentsEnv, error)

+ func (e *EnvironmentsEnv) Scan(value any) error

+ func (e EnvironmentsEnv) Equals(other EnvironmentsEnv) bool

+ func (e EnvironmentsEnv) Value() (driver.Value, error)

+ type Kind string

+ const KindGit

+ func (k Kind) IsVCS() bool

+ type Meta struct

+ func NewMeta(kind Kind, data string) Meta

+ func (m Meta) Data() string

+ func (m Meta) Kind() Kind

+ type RunningOrPendingAppDeploymentsCount uint

+ type Service struct

+ func (s *Service) UnmarshalJSON(b []byte) error

+ func (s Service) Image() string

+ func (s Service) IsExposed() bool

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

+ func (s Service) Name() string

+ func (s Service) QualifiedName() string

+ func (s Service) Url() monad.Maybe[Url]

+ type Services []Service

+ func (s *Services) Scan(value any) error

+ func (s Services) Internal(conf Config, name, image string) (Services, Service)

+ func (s Services) Public(baseUrl Url, conf Config, name, image string) (Services, Service)

+ func (s Services) Value() (driver.Value, error)

+ type ServicesEnv map[string]EnvVars

+ func (e *ServicesEnv) Scan(value any) error

+ func (e ServicesEnv) Value() (driver.Value, error)

+ type State struct

+ func NewState(logfile string) State

+ func (s State) ErrCode() monad.Maybe[string]

+ func (s State) Failed(err error) (State, error)

+ func (s State) FinishedAt() monad.Maybe[time.Time]

+ func (s State) LogFile() string

+ func (s State) Services() monad.Maybe[Services]

+ func (s State) Started() (State, error)

+ func (s State) StartedAt() monad.Maybe[time.Time]

+ func (s State) Status() DeploymentStatus

+ func (s State) Succeeded(services Services) (State, error)

+ type Trigger interface

+ Fetch func(context.Context, Deployment) error

+ Prepare func(App, any) (Meta, error)

+ type UniqueAppName AppName

+ type Url struct

+ func UrlFrom(raw string) (Url, error)

+ func (u *Url) Scan(value any) error

+ func (u *Url) UnmarshalJSON(b []byte) error

+ func (u Url) Host() string

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

+ func (u Url) String() string

+ func (u Url) SubDomain(subdomain string) Url

+ func (u Url) UseSSL() bool

+ func (u Url) Value() (driver.Value, error)

+ type VCSConfig struct

+ func NewVCSConfig(url Url) VCSConfig

+ func (c VCSConfig) Authenticated(token string) VCSConfig

+ func (c VCSConfig) Equals(other VCSConfig) bool

+ func (c VCSConfig) Public() VCSConfig

+ func (c VCSConfig) Token() monad.Maybe[string]

+ func (c VCSConfig) Url() Url

+ func (c VCSConfig) WithUrl(url Url) VCSConfig

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