applyinator

Documentation

Overview

Package applyinator is a library to apply plans to a host. It is referred from: https://github.com/rancher/system-agent/blob/bf4eb096f5a79009badec37f59b16b60c36c191a/pkg/applyinator/applyinator.go

Index

• func CreateDirectory(file File) error
• type ApplyInput
• type ApplyOutput
• type Applyinator
  • func NewApplyinator(workDir string, preserveWorkDir bool, appliedPlanDir, interlockDir string, ...) *Applyinator
  • func (a *Applyinator) Apply(ctx context.Context, input ApplyInput) (ApplyOutput, error)
• type CalculatedPlan
  • func CalculatePlan(rawPlan []byte) (CalculatedPlan, error)
• type CommonInstruction
• type File
• type OneTimeInstruction
• type PeriodicInstruction
• type PeriodicInstructionOutput
• type Plan

Functions

func CreateDirectory

func CreateDirectory(file File) error

Types

type ApplyInput

type ApplyInput struct {
	CalculatedPlan             CalculatedPlan
	RunOneTimeInstructions     bool
	OneTimeInstructionAttempts int
	ReconcileFiles             bool
	ExistingOneTimeOutput      []byte
	ExistingPeriodicOutput     []byte
}

type ApplyOutput

type ApplyOutput struct {
	OneTimeOutput          []byte
	OneTimeApplySucceeded  bool
	PeriodicOutput         []byte
	PeriodicApplySucceeded bool
}

type Applyinator

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

func NewApplyinator

func NewApplyinator(workDir string, preserveWorkDir bool, appliedPlanDir, interlockDir string, imageUtil *image.Utility) *Applyinator

func (*Applyinator) Apply

func (a *Applyinator) Apply(ctx context.Context, input ApplyInput) (ApplyOutput, error)

Apply accepts a context, calculated plan, a bool to indicate whether to run the onetime instructions, the existing onetimeinstruction output, and an input byte slice which is a base64+gzip json-marshalled map of PeriodicInstructionOutput entries where the key is the PeriodicInstructionOutput.Name. It outputs a revised versions of the existing outputs, and if specified, runs the one time instructions. Notably, ApplyOutput.OneTimeApplySucceeded will be false if ApplyInput.RunOneTimeInstructions is false

type CalculatedPlan

type CalculatedPlan struct {
	Plan     Plan
	Checksum string
}

CalculatedPlan is passed into Applyinator and is a Plan with checksum calculated

func CalculatePlan

func CalculatePlan(rawPlan []byte) (CalculatedPlan, error)

type CommonInstruction

type CommonInstruction struct {
	Name    string   `json:"name,omitempty"`
	Image   string   `json:"image,omitempty"`
	Env     []string `json:"env,omitempty"`
	Args    []string `json:"args,omitempty"`
	Command string   `json:"command,omitempty"`
}

type File

type File struct {
	Content     string `json:"content,omitempty"`
	Directory   bool   `json:"directory,omitempty"`
	UID         int    `json:"uid,omitempty"`
	GID         int    `json:"gid,omitempty"`
	Path        string `json:"path,omitempty"`
	Permissions string `json:"permissions,omitempty"` // internally, the string will be converted to a uint32 to satisfy os.FileMode
}

Path would be `/etc/kubernetes/ssl/ca.pem`, Content is base64 encoded. If Directory is true, then we are creating a directory, not a file

type OneTimeInstruction

type OneTimeInstruction struct {
	CommonInstruction
	SaveOutput bool `json:"saveOutput,omitempty"`
}

type PeriodicInstruction

type PeriodicInstruction struct {
	CommonInstruction
	PeriodSeconds    int  `json:"periodSeconds,omitempty"` // default 600, i.e. 10 minutes
	SaveStderrOutput bool `json:"saveStderrOutput,omitempty"`
}

type PeriodicInstructionOutput

type PeriodicInstructionOutput struct {
	Name                  string `json:"name"`
	Stdout                []byte `json:"stdout"`                // Stdout is a byte array of the gzip+base64 stdout output
	Stderr                []byte `json:"stderr"`                // Stderr is a byte array of the gzip+base64 stderr output
	ExitCode              int    `json:"exitCode"`              // ExitCode is an int representing the exit code of the last run instruction
	LastSuccessfulRunTime string `json:"lastSuccessfulRunTime"` // LastSuccessfulRunTime is a time.UnixDate formatted string of the last successful time (exit code 0) the instruction was run
	Failures              int    `json:"failures"`              // Failures is the number of time the periodic instruction has failed to run
	LastFailedRunTime     string `json:"lastFailedRunTime"`     // LastFailedRunTime is a time.UnixDate formatted string of the time that the periodic instruction started failing
}

type Plan

type Plan struct {
	Files                []File                  `json:"files,omitempty"`
	OneTimeInstructions  []OneTimeInstruction    `json:"instructions,omitempty"`
	Probes               map[string]prober.Probe `json:"probes,omitempty"`
	PeriodicInstructions []PeriodicInstruction   `json:"periodicInstructions,omitempty"`
}