service

type AlreadyRunningError struct {
	Name string
}

type AlreadyStoppedError struct {
	Name string
}

type Config struct {
	// @default autoStart
	//
	// Defines how this service will be run by caretakerd.
	//
	// For details of possible values see {@ref github.com/amusedrange/caretakerd/values.RestartType}.
	//
	// > **Important**: Exactly one of the services have to be configured as
	// > {@ref github.com/amusedrange/caretakerd/service.Type#Master master}.
	Type Type `json:"type" yaml:"type"`

	// @default []
	//
	// The command the service process has to start with. The called command has to be run in the foreground - or in other words: Should not daemonize.
	//
	// > **Hint**: If there is no command line provided, this service cannot be started and caretakerd will
	// > fail.
	//
	// # PATH expansion
	//
	// The provided commands are resolved from the “PATH“ environment provided to caretakerd.
	// This makes it possible to use the names of the binaries like “sleep“ instead of “/usr/bin/sleep“.
	//
	// # Parameter evaluation
	//
	// Environment variables could be included like:
	// “`yaml
	// command: ["echo", "${MESSAGE}"]
	// environment:
	//     MESSAGE: "Hello world!"
	// “`
	//
	// “`bash
	// $ caretakerd run
	// Hello world!
	// “`
	//
	// # Special master handling
	//
	// If the service is configured as {@ref #Type type} = {@ref github.com/amusedrange/caretakerd/service.Type#Master master}
	// every parameter which was passed to caretakerd itself will be enriched to the called command line of the service process.
	//
	// Config example:
	// “`yaml
	// command: ["echo", "Hello"]
	// “`
	//
	// Run examples:
	// “`bash
	// $ caretakerd run
	// Hello
	//
	// $ caretakerd run "world!"
	// Hello world!
	// “`
	Command []values.String `json:"command" yaml:"command,flow"`

	// @default []
	//
	// Commands to be executed before execution of the actual {@ref #Command command}.
	//
	// If one of these commands fails, the whole service will also marked as failed. The actual
	// {@ref #Command command} will not be invoked and the {@ref #AutoRestart autoRestart} handling will be initiated.
	//
	// Only exit codes of value “0“ will be accepted as success.
	//
	// If there is a minus (“-“) provided as first item of the command, every error of this command will be ignored.
	//
	// Example:
	// “`yaml
	// preCommands:
	// - ["-", "program.sh", "prepare"]        # Ignore if fails
	// - ["program.sh", "prepareAndDoNotFail"] # Do not ignore if fails
	// command: ["program.sh", "run"]
	// “`
	PreCommands [][]values.String `json:"preCommands" yaml:"preCommands,flow"`

	// @default []
	//
	// Commands to be executed after execution of the actual {@ref #Command command}.
	//
	// Every result of these commands are ignored and will not force another behaviour - Exception: an error is logged.
	//
	// Only exit codes of value “0“ will be accepted as success.
	//
	// If there is a minus (“-“) provided as first item of the command, every error of this command will be ignored.
	//
	// Example:
	// “`yaml
	// command: ["program.sh", "run"]
	// postCommands:
	// - ["-", "program.sh", "cleanUp"]        # Ignore if fails
	// - ["program.sh", "cleanUpAndDoNotFail"] # Log if fails
	// “`
	PostCommands [][]values.String `json:"postCommands" yaml:"postCommands,flow"`

	// @default ""
	//
	// If configured this will trigger the service at this specific times. If not the service will
	// run as a normal process just once (except of the {@ref #AutoRestart autoRestart} handling).
	//
	// For details of possible values see {@ref github.com/amusedrange/caretakerd/service.CronExpression}.
	CronExpression CronExpression `json:"cronExpression" yaml:"cronExpression"`

	// @default 0
	//
	// Wait before the service process will start the first time.
	//
	// > **Hint:** Every run triggered by {@ref #CronExpression cronExpression} will also wait for this delay.
	StartDelayInSeconds values.NonNegativeInteger `json:"startDelayInSeconds" yaml:"startDelayInSeconds"`

	// @default [0]
	//
	// Every of these values represents an expected success exit code.
	// If a service ends with one of these values, the service will not be restarted.
	// Other values will trigger a auto restart if configured.
	//
	// See: {@ref #AutoRestart autoRestart}
	SuccessExitCodes values.ExitCodes `json:"successExitCodes" yaml:"successExitCodes,flow"`

	// @default "TERM"
	//
	// Signal which will be send to the service when a stop is requested.
	// You can use the signal number here and also names like “"TERM"“ or “"KILL"“.
	StopSignal values.Signal `json:"stopSignal" yaml:"stopSignal"`

	// @default "processGroup"
	//
	// Defines who have to receive the stop signal.
	//
	// > **Hint:** If the service have to be killed, always “processGroup“ is used.
	StopSignalTarget values.SignalTarget `json:"stopSignalTarget" yaml:"stopSignalTarget"`

	// @default []
	//
	// Command to be executed to stop the service.
	//
	// From the moment on this command is called, the {@ref #StopWaitInSeconds stopWaitInSeconds} are running.
	// It is not important when this stopCommand ends or what is the exit code.
	// If this command is executed and the service does not end within the configured {@ref #StopWaitInSeconds stopWaitInSeconds},
	// the service will be killed.
	//
	// Only exit codes of value “0“ will be accepted as success. Other codes are logged as error.
	//
	// If there is a minus (“-“) provided as first item of the command, every error of this command will be ignored.
	//
	// > **Hint:** If this property is configured, {@ref #StopSignal stopSignal} will not be evaluated.
	StopCommand []values.String `json:"stopCommand" yaml:"stopCommand,flow"`

	// @default 30
	//
	// Timeout to wait before killing the service process after a stop is requested.
	StopWaitInSeconds values.NonNegativeInteger `json:"stopWaitInSeconds" yaml:"stopWaitInSeconds"`

	// @default ""
	//
	// User under which the service process will be started.
	User values.String `json:"user" yaml:"user"`

	// @default []
	//
	// Environment variables to pass to the process.
	Environment Environments `json:"environment" yaml:"environment"`

	// @default true
	//
	// Additionally pass the environment variables started with caretakerd to the service process.
	InheritEnvironment values.Boolean `json:"inheritEnvironment" yaml:"inheritEnvironment"`

	// @default ""
	//
	// Working directory to start the service process in.
	Directory values.String `json:"directory" yaml:"directory"`

	// @default onFailures
	//
	// Configure how caretakerd will handle the end of a process.
	// It depends mainly on the {@ref #SuccessExitCodes successExitCodes} property.
	//
	// For details of possible values see {@ref github.com/amusedrange/caretakerd/values.RestartType}.
	AutoRestart values.RestartType `json:"autoRestart" yaml:"autoRestart"`

	// @default 5
	//
	// Seconds to wait before restart of a process.
	//
	// If a process should be restarted (because of {@ref #AutoRestart autoRestart}), caretakerd will wait this seconds before restart is initiated.
	RestartDelayInSeconds values.NonNegativeInteger `json:"restartDelayInSeconds" yaml:"restartDelayInSeconds"`

	// Configures the permission of this service to control caretakerd remotely
	// and how to obtain the credentials for it.
	//
	// For details see {@ref github.com/amusedrange/caretakerd/access.Config}.
	Access access.Config `json:"access" yaml:"access,omitempty"`

	// Configures the logger for this specific service.
	//
	// For details see {@ref github.com/amusedrange/caretakerd/logger.Config}.
	Logger logger.Config `json:"logger" yaml:"logger,omitempty"`
}

type Configs map[string]Config

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

type Environments map[string]string

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

type Information struct {
	Config Config         `json:"config"`
	Status Status         `json:"status"`
	PID    values.Integer `json:"pid"`
}

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

type Services map[string]*Service

type Status int

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

type Type int

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