service

Documentation

Overview

Package service provides the runnable service that acts as the root of the overall system. It provides a configuration structure, a way to initialise a primed instance of the service which can then be start via the .Start() func.

Index

• type App
  • func Initialise(c Config) (app *App, err error)
  • func (app *App) Start(ctx context.Context) error
• type Config

Types

type App

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

App stores application state

func Initialise

func Initialise(c Config) (app *App, err error)

Initialise prepares an instance of the app to run

func (*App) Start

func (app *App) Start(ctx context.Context) error

Start launches the app and blocks until fatal error

type Config

type Config struct {
	Target          task.Repo
	Hostname        string
	SSH             bool
	Directory       string
	PassEnvironment bool
	CheckInterval   time.Duration
	VaultAddress    string
	VaultToken      string `json:"-"`
	VaultPath       string
	VaultRenewal    time.Duration
	VaultConfig     string
}

Config specifies static configuration parameters (from CLI or environment)