app

package
v0.0.0-...-9f1a7a8 Latest Latest
Warning

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

 Go to latest Published: Apr 5, 2018 License: BSD-3-Clause Imports: 48 Imported by: 0

Documentation

Index

Constants

View Source 
const (
	// InternalAppName is a reserved name used for token generation. For
	// backward compatibility and historical purpose, the value remained
	// "tsr" when the name of the daemon changed to "tsurud".
	InternalAppName = "tsr"

	TsuruServicesEnvVar = "TSURU_SERVICES"
)

Variables

View Source 
var (
	ErrAppAlreadyExists = errors.New("there is already an app with this name")
	ErrAppNotFound      = errors.New("App not found.")
)
View Source 
var (
	ErrAlreadyHaveAccess = errors.New("team already have access to this app")
	ErrNoAccess          = errors.New("team does not have access to this app")
	ErrCannotOrphanApp   = errors.New("cannot revoke access from this team, as it's the unique team with access to the app")
	ErrDisabledPlatform  = errors.New("Disabled Platform, only admin users can create applications with the platform")
)
View Source 
var AuthScheme auth.Scheme

Functions

func AcquireApplicationLock 

func AcquireApplicationLock(appName string, owner string, reason string) (bool, error)

AcquireApplicationLock acquires an application lock by setting the lock field in the database. This method is already called by a connection middleware on requests with :app or :appname params that have side-effects.

func AcquireApplicationLockWait 

func AcquireApplicationLockWait(appName string, owner string, reason string, timeout time.Duration) (bool, error)

Same as AcquireApplicationLock but it keeps trying to acquire the lock until timeout is reached.

func AcquireApplicationLockWaitMany 

func AcquireApplicationLockWaitMany(appNames []string, owner string, reason string, timeout time.Duration) error

func Build 

func Build(opts DeployOptions) (string, error)

func ChangeQuota 

func ChangeQuota(app *App, limit int) error

ChangeQuota redefines the limit of the app. The new limit must be bigger than or equal to the current number of units in the app. The new limit may be smaller than 0, which means that the app should have an unlimited number of units.

func CreateApp 

func CreateApp(app *App, user *auth.User) error

CreateApp creates a new app.

Creating a new app is a process composed of the following steps:

  1. Save the app in the database
  2. Create the git repository using the repository manager
  3. Provision the app using the provisioner

func Delete 

func Delete(app *App, evt *event.Event, requestID string) error

Delete deletes an app.

func Deploy 

func Deploy(opts DeployOptions) (string, error)

Deploy runs a deployment of an application. It will first try to run an archive based deploy (if opts.ArchiveURL is not empty), and then fallback to the Git based deployment.

func GetAppRouterUpdater 

func GetAppRouterUpdater() *appRouterUpdater

func MigrateDeploysToEvents 

func MigrateDeploysToEvents() error

func PlanService 

func PlanService() appTypes.PlanService

func PlatformService 

func PlatformService() appTypes.PlatformService

func ReleaseApplicationLock 

func ReleaseApplicationLock(appName string)

ReleaseApplicationLock releases a lock hold on an app, currently it's called by a middleware, however, ideally, it should be called individually by each handler since they might be doing operations in background.

func ReleaseApplicationLockMany 

func ReleaseApplicationLockMany(appNames []string)

func RenameTeam 

func RenameTeam(oldName, newName string) error

func RollbackUpdate 

func RollbackUpdate(appName, imageID, reason string, disableRollback bool) error

func Swap 

func Swap(app1, app2 *App, cnameOnly bool) error

Swap calls the Router.Swap and updates the app.CName in the database.

func Units 

func Units(apps []App) (map[string]AppUnitsResponse, error)

func ValidateOrigin 

func ValidateOrigin(origin string) bool

Types

type App 

type App struct {
	Env            map[string]bind.EnvVar
	ServiceEnvs    []bind.ServiceEnvVar
	Platform       string `bson:"framework"`
	Name           string
	CName          []string
	Teams          []string
	TeamOwner      string
	Owner          string
	Plan           appTypes.Plan
	UpdatePlatform bool
	Lock           AppLock
	Pool           string
	Description    string
	Router         string
	RouterOpts     map[string]string
	Deploys        uint
	Tags           []string
	Error          string
	Routers        []appTypes.AppRouter

	quota.Quota
	// contains filtered or unexported fields
}

App is the main type in tsuru. An app represents a real world application. This struct holds information about the app: its name, address, list of teams that have access to it, used platform, etc.

func GetByName 

func GetByName(name string) (*App, error)

GetByName queries the database to find an app identified by the given name.

func List 

func List(filter *Filter) ([]App, error)

List returns the list of apps filtered through the filter parameter.

func (*App) AddCName 

func (app *App) AddCName(cnames ...string) error

AddCName adds a CName to app. It updates the attribute, calls the SetCName function on the provisioner and saves the app in the database, returning an error when it cannot save the change in the database or add the CName on the provisioner.

func (*App) AddInstance 

func (app *App) AddInstance(addArgs bind.AddInstanceArgs) error

func (*App) AddRouter 

func (app *App) AddRouter(appRouter appTypes.AppRouter) error

func (*App) AddUnits 

func (app *App) AddUnits(n uint, process string, w io.Writer) error

AddUnits creates n new units within the provisioner, saves new units in the database and enqueues the apprc serialization.

func (*App) BindUnit 

func (app *App) BindUnit(unit *provision.Unit) error

func (*App) CleanImage 

func (app *App) CleanImage(img string) error

func (*App) Envs 

func (app *App) Envs() map[string]bind.EnvVar

Envs returns a map representing the apps environment variables.

func (*App) GetAddresses 

func (app *App) GetAddresses() ([]string, error)

func (*App) GetCertificates 

func (app *App) GetCertificates() (map[string]map[string]string, error)

func (*App) GetCname 

func (app *App) GetCname() []string

GetCname returns the cnames of the app.

func (*App) GetCpuShare 

func (app *App) GetCpuShare() int

GetCpuShare returns the cpu share for the app.

func (*App) GetDeploys 

func (app *App) GetDeploys() uint

GetDeploys returns the amount of deploys of an app.

func (*App) GetHealthcheckData 

func (app *App) GetHealthcheckData() (router.HealthcheckData, error)

func (*App) GetLock 

func (app *App) GetLock() provision.AppLock

GetLock returns the app lock information.

func (*App) GetMemory 

func (app *App) GetMemory() int64

GetMemory returns the memory limit (in bytes) for the app.

func (*App) GetName 

func (app *App) GetName() string

GetName returns the name of the app.

func (*App) GetPlatform 

func (app *App) GetPlatform() string

GetPlatform returns the platform of the app.

func (*App) GetPool 

func (app *App) GetPool() string

GetPool returns the pool of the app.

func (*App) GetQuota 

func (app *App) GetQuota() quota.Quota

func (*App) GetRouters 

func (app *App) GetRouters() []appTypes.AppRouter

func (*App) GetRoutersWithAddr 

func (app *App) GetRoutersWithAddr() ([]appTypes.AppRouter, error)

func (*App) GetSwap 

func (app *App) GetSwap() int64

GetSwap returns the swap limit (in bytes) for the app.

func (*App) GetTeamOwner 

func (app *App) GetTeamOwner() string

GetTeamOwner returns the team owner of the app.

func (*App) GetTeams 

func (app *App) GetTeams() []authTypes.Team

GetTeams returns a slice of teams that have access to the app.

func (*App) GetTeamsName 

func (app *App) GetTeamsName() []string

GetTeamsName returns the names of the app teams.

func (*App) GetUnits 

func (app *App) GetUnits() ([]bind.Unit, error)

GetUnits returns the internal list of units converted to bind.Unit.

func (*App) GetUpdatePlatform 

func (app *App) GetUpdatePlatform() bool

func (*App) Grant 

func (app *App) Grant(team *authTypes.Team) error

Grant allows a team to have access to an app. It returns an error if the team already have access to the app.

func (*App) InstanceEnvs 

func (app *App) InstanceEnvs(serviceName, instanceName string) map[string]bind.EnvVar

InstanceEnvs returns a map of environment variables that belongs to the given service and service instance.

func (*App) InternalLock 

func (app *App) InternalLock(reason string) (bool, error)

func (*App) LastLogs 

func (app *App) LastLogs(lines int, filterLog Applog) ([]Applog, error)

LastLogs returns a list of the last `lines` log of the app, matching the fields in the log instance received as an example.

func (*App) Log 

func (app *App) Log(message, source, unit string) error

Log adds a log message to the app. Specifying a good source is good so the user can filter where the message come from.

func (*App) MarshalJSON 

func (app *App) MarshalJSON() ([]byte, error)

MarshalJSON marshals the app in json format.

func (*App) MetricEnvs 

func (app *App) MetricEnvs() (map[string]string, error)

func (*App) RegisterUnit 

func (app *App) RegisterUnit(unitId string, customData map[string]interface{}) error

func (*App) RemoveCName 

func (app *App) RemoveCName(cnames ...string) error

func (*App) RemoveCertificate 

func (app *App) RemoveCertificate(name string) error

func (*App) RemoveInstance 

func (app *App) RemoveInstance(removeArgs bind.RemoveInstanceArgs) error

func (*App) RemoveRouter 

func (app *App) RemoveRouter(name string) error

func (*App) RemoveUnits 

func (app *App) RemoveUnits(n uint, process string, w io.Writer) error

RemoveUnits removes n units from the app. It's a process composed of multiple steps:

  1. Remove units from the provisioner
  2. Update quota

func (*App) Restart 

func (app *App) Restart(process string, w io.Writer) error

Restart runs the restart hook for the app, writing its output to w.

func (*App) Revoke 

func (app *App) Revoke(team *authTypes.Team) error

Revoke removes the access from a team. It returns an error if the team do not have access to the app.

func (*App) RoutableAddresses 

func (app *App) RoutableAddresses() ([]url.URL, error)

func (*App) Run 

func (app *App) Run(cmd string, w io.Writer, args provision.RunArgs) error

Run executes the command in app units, sourcing apprc before running the command.

func (*App) SetCertificate 

func (app *App) SetCertificate(name, certificate, key string) error

func (*App) SetEnvs 

func (app *App) SetEnvs(setEnvs bind.SetEnvArgs) error

SetEnvs saves a list of environment variables in the app.

func (*App) SetPool 

func (app *App) SetPool() error

func (*App) SetQuotaInUse 

func (app *App) SetQuotaInUse(inUse int) error

func (*App) SetUnitStatus 

func (app *App) SetUnitStatus(unitName string, status provision.Status) error

SetUnitStatus changes the status of the given unit.

func (*App) SetUpdatePlatform 

func (app *App) SetUpdatePlatform(check bool) error

func (*App) Shell 

func (app *App) Shell(opts provision.ShellOptions) error

func (*App) Sleep 

func (app *App) Sleep(w io.Writer, process string, proxyURL *url.URL) error

func (*App) Start 

func (app *App) Start(w io.Writer, process string) error

Start starts the app calling the provisioner.Start method and changing the units state to StatusStarted.

func (*App) Stop 

func (app *App) Stop(w io.Writer, process string) error

func (*App) UnbindUnit 

func (app *App) UnbindUnit(unit *provision.Unit) error

func (*App) Units 

func (app *App) Units() ([]provision.Unit, error)

Units returns the list of units.

func (*App) Unlock 

func (app *App) Unlock()

func (*App) UnsetEnvs 

func (app *App) UnsetEnvs(unsetEnvs bind.UnsetEnvArgs) error

UnsetEnvs removes environment variables from an app, serializing the remaining list of environment variables to all units of the app.

func (*App) Update 

func (app *App) Update(updateData App, w io.Writer) (err error)

Update changes informations of the application.

func (*App) UpdateRouter 

func (app *App) UpdateRouter(appRouter appTypes.AppRouter) error

func (*App) ValidateService 

func (app *App) ValidateService(service string) error

type AppCreationError 

type AppCreationError struct {
	Err error
	// contains filtered or unexported fields
}

func (*AppCreationError) Error 

func (e *AppCreationError) Error() string

type AppLock 

type AppLock struct {
	Locked      bool
	Reason      string
	Owner       string
	AcquireDate time.Time
}

AppLock stores information about a lock hold on the app

func (*AppLock) GetAcquireDate 

func (l *AppLock) GetAcquireDate() time.Time

func (*AppLock) GetLocked 

func (l *AppLock) GetLocked() bool

func (*AppLock) GetOwner 

func (l *AppLock) GetOwner() string

func (*AppLock) GetReason 

func (l *AppLock) GetReason() string

func (*AppLock) MarshalJSON 

func (l *AppLock) MarshalJSON() ([]byte, error)

func (*AppLock) String 

func (l *AppLock) String() string

type AppUnitsResponse 

type AppUnitsResponse struct {
	Units []provision.Unit
	Err   error
}

type Applog 

type Applog struct {
	MongoID bson.ObjectId `bson:"_id,omitempty" json:"-"`
	Date    time.Time
	Message string
	Source  string
	AppName string
	Unit    string
}

Applog represents a log entry.

type DeployData 

type DeployData struct {
	ID          bson.ObjectId `bson:"_id,omitempty"`
	App         string
	Timestamp   time.Time
	Duration    time.Duration
	Commit      string
	Error       string
	Image       string
	Log         string
	User        string
	Origin      string
	CanRollback bool
	RemoveDate  time.Time `bson:",omitempty"`
	Diff        string
	Message     string
}

func GetDeploy 

func GetDeploy(id string) (*DeployData, error)

func ListDeploys 

func ListDeploys(filter *Filter, skip, limit int) ([]DeployData, error)

ListDeploys returns the list of deploy that match a given filter.

type DeployKind 

type DeployKind string
const (
	DeployArchiveURL   DeployKind = "archive-url"
	DeployGit          DeployKind = "git"
	DeployImage        DeployKind = "image"
	DeployBuildedImage DeployKind = "imagebuild"
	DeployRollback     DeployKind = "rollback"
	DeployUpload       DeployKind = "upload"
	DeployUploadBuild  DeployKind = "uploadbuild"
	DeployRebuild      DeployKind = "rebuild"
)

type DeployOptions 

type DeployOptions struct {
	App          *App
	Commit       string
	BuildTag     string
	ArchiveURL   string
	FileSize     int64
	File         io.ReadCloser `bson:"-"`
	OutputStream io.Writer     `bson:"-"`
	User         string
	Image        string
	Origin       string
	Rollback     bool
	Build        bool
	Event        *event.Event `bson:"-"`
	Kind         DeployKind
	Message      string
}

func (*DeployOptions) GetKind 

func (o *DeployOptions) GetKind() (kind DeployKind)

func (*DeployOptions) GetOrigin 

func (o *DeployOptions) GetOrigin() string

type ErrAppNotLocked 

type ErrAppNotLocked struct {
	App string
}

func (ErrAppNotLocked) Error 

func (e ErrAppNotLocked) Error() string

type Filter 

type Filter struct {
	Name        string
	NameMatches string
	Platform    string
	TeamOwner   string
	UserOwner   string
	Pool        string
	Pools       []string
	Statuses    []string
	Locked      bool
	Tags        []string
	Extra       map[string][]string
}

func (*Filter) ExtraIn 

func (f *Filter) ExtraIn(name string, value string)

func (*Filter) Query 

func (f *Filter) Query() bson.M

type LogDispatcher 

type LogDispatcher struct {
	// contains filtered or unexported fields
}

func NewlogDispatcher 

func NewlogDispatcher(chanSize int) *LogDispatcher

func (*LogDispatcher) Send 

func (d *LogDispatcher) Send(msg *Applog) error

func (*LogDispatcher) Shutdown 

func (d *LogDispatcher) Shutdown(ctx context.Context) error

func (*LogDispatcher) String 

func (a *LogDispatcher) String() string

type LogListener 

type LogListener struct {
	// contains filtered or unexported fields
}

func NewLogListener 

func NewLogListener(a *App, filterLog Applog) (*LogListener, error)

func (*LogListener) Close 

func (l *LogListener) Close()

func (*LogListener) ListenChan 

func (l *LogListener) ListenChan() <-chan Applog

type LogWriter 

type LogWriter struct {
	App    Logger
	Source string
	// contains filtered or unexported fields
}

func (*LogWriter) Async 

func (w *LogWriter) Async()

func (*LogWriter) Close 

func (w *LogWriter) Close()

func (*LogWriter) Wait 

func (w *LogWriter) Wait(timeout time.Duration) error

func (*LogWriter) Write 

func (w *LogWriter) Write(data []byte) (int, error)

Write writes and logs the data.

type Logger 

type Logger interface {
	Log(string, string, string) error
}

type ManyTeamsError 

type ManyTeamsError struct{}

ManyTeamsError is the error returned when the user has more than one team and tries to create an app without specify a app team owner.

func (ManyTeamsError) Error 

func (err ManyTeamsError) Error() string

type NoTeamsError 

type NoTeamsError struct{}

NoTeamsError is the error returned when one tries to create an app without any team.

func (NoTeamsError) Error 

func (err NoTeamsError) Error() string

type ProcfileError 

type ProcfileError struct {
	// contains filtered or unexported fields
}

func (*ProcfileError) Error 

func (e *ProcfileError) Error() string

type UpdateUnitsResult 

type UpdateUnitsResult struct {
	ID    string
	Found bool
}

func UpdateNodeStatus 

func UpdateNodeStatus(nodeData provision.NodeStatusData) ([]UpdateUnitsResult, error)

UpdateNodeStatus updates the status of the given node and its units, returning a map which units were found during the update.

Source Files

View all Source files

Directories

Path Synopsis
Package bind provides interfaces and types for use when binding an app to a service.
 Package bind provides interfaces and types for use when binding an app to a service.
gc

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.