deployment

Documentation

Index

• type Deployment
• type JobContext
  • func NewJobContext(jobName string, client *remote.Client, logger func(data string)) (*JobContext, context.CancelFunc)
  • func (p *JobContext) ExecuteCommand(command string) (string, error)
  • func (p *JobContext) Log(data string)
• type SSHConfig

Types

type Deployment

type Deployment struct {
	Name      string
	Variables map[string]string
	Config    struct {
		SSH map[string]SSHConfig
	}
	Jobs []map[string]any
}

A deployment is the configuration file that contain all the instructions to deploy your project.

type JobContext

type JobContext struct {
	context.Context
	JobName string
	// contains filtered or unexported fields
}

A JobContext is passed to each executed jobs. It it provide useful functions for executing commands, logging output, and more!

func NewJobContext

func NewJobContext(jobName string, client *remote.Client, logger func(data string)) (*JobContext, context.CancelFunc)

Create a new JobContext.

func (*JobContext) ExecuteCommand

func (p *JobContext) ExecuteCommand(command string) (string, error)

Execute a command on the remote host.

func (*JobContext) Log

func (p *JobContext) Log(data string)

Log a message to the logger, the output will be logged to the deployment log.

type SSHConfig

type SSHConfig struct {
	Host       string
	Port       uint16
	Type       string
	Username   string
	Password   string
	KeyFile    string `yaml:"key_file"`
	KeyContent string `yaml:"key_content"`
	KeyPass    string `yaml:"key_pass"`
}

The SSHConfig struct hold a SSH configuration for a single host