barrel

Documentation

Index

• Constants
• type Barrel
  • func (barrel *Barrel) Build(ctx context.Context, progress io.Writer, start bool) error
  • func (barrel Barrel) LastRebuild(ctx context.Context) (t time.Time, err error)
  • func (barrel *Barrel) Running(ctx context.Context) (bool, error)
  • func (barrel *Barrel) Shell(ctx context.Context, io stream.IOStream, argv ...string) error
  • func (barrel *Barrel) ShellScript(ctx context.Context, io stream.IOStream, commands ...string) error
  • func (barrel *Barrel) Stack() component.StackWithResources
• type ExitError
  • func (ee ExitError) Code() exit.ExitCode
  • func (ee ExitError) Error() string
• type LastRebuildFetcher
  • func (lbr *LastRebuildFetcher) Fetch(ctx context.Context, flags ingredient.FetcherFlags, info *status.WissKI) (err error)
• type RunningFetcher
  • func (rf *RunningFetcher) Fetch(flags ingredient.FetcherFlags, info *status.WissKI) (err error)

Constants

const (
	BaseDirectory     = "/var/www/data"
	ComposerDirectory = BaseDirectory + "/project"
	WebDirectory      = ComposerDirectory + "/web"
	OntologyDirectory = SitesDirectory + "/default/files/ontology"
	SitesDirectory    = WebDirectory + "/sites"
	WissKIDirectory   = WebDirectory + "/modules/contrib/wisski"
)

Types

type Barrel

type Barrel struct {
	ingredient.Base
	Dependencies struct {
		Locker *locker.Locker
		MStore *mstore.MStore
	}
}

Barrel provides access to the underlying Barrel

func (*Barrel) Build

func (barrel *Barrel) Build(ctx context.Context, progress io.Writer, start bool) error

Build builds or rebuilds the barrel connected to this instance.

It also logs the current time into the metadata belonging to this instance.

func (Barrel) LastRebuild

func (barrel Barrel) LastRebuild(ctx context.Context) (t time.Time, err error)

func (*Barrel) Running

func (barrel *Barrel) Running(ctx context.Context) (bool, error)

Running checks if this WissKI is currently running.

func (*Barrel) Shell

func (barrel *Barrel) Shell(ctx context.Context, io stream.IOStream, argv ...string) error

Shell executes a shell with the given command line arguments inside the container. If an error occurs, it is of type ExitError.

func (*Barrel) ShellScript

func (barrel *Barrel) ShellScript(ctx context.Context, io stream.IOStream, commands ...string) error

ShellScript quotes the given command and executes it as a shell script inside the container.

func (*Barrel) Stack

func (barrel *Barrel) Stack() component.StackWithResources

Barrel returns a stack representing the running WissKI Instance

type ExitError

type ExitError int

func (ExitError) Code

func (ee ExitError) Code() exit.ExitCode

func (ExitError) Error

func (ee ExitError) Error() string

type LastRebuildFetcher

type LastRebuildFetcher struct {
	ingredient.Base
	Dependencies struct {
		Barrel *Barrel
	}
}

func (*LastRebuildFetcher) Fetch

func (lbr *LastRebuildFetcher) Fetch(ctx context.Context, flags ingredient.FetcherFlags, info *status.WissKI) (err error)

type RunningFetcher

type RunningFetcher struct {
	ingredient.Base
	Dependencies struct {
		Barrel *Barrel
	}
}

func (*RunningFetcher) Fetch

func (rf *RunningFetcher) Fetch(flags ingredient.FetcherFlags, info *status.WissKI) (err error)