agents

Documentation

Index

• Constants
• type APIAction
• type APIActions
• type APIConfig
• type APIConfigAgent
• type Action
• type ActionPoller
  • func NewActionPoller() (*ActionPoller, error)
  • func (p *ActionPoller) Start(ctx context.Context)
• type Actions
  • func ParseAPIActions(data []byte) (Actions, error)
• type Command
• type CommandData
• type CommandResult
• type Config
• type ConfigData
• type ConfigResult
• type Result
• type StatusData
• type StatusPoller
  • func NewStatusPoller() (*StatusPoller, error)
  • func (p *StatusPoller) Start(ctx context.Context)
• type StatusResult

Constants

const (
	START     = "start"
	STOP      = "stop"
	RESTART   = "restart"
	STATUS    = "status"
	RELOAD    = "reload"
	INVENTORY = "inventory"
	VERSION   = "version"
)

const (
	// action types.
	CONFIG  = "config"
	COMMAND = "command"

	STATUS_ACTIVE = "active" //nolint:revive,nosnakecase,stylecheck
	STATUS_ERROR  = "error"  //nolint:revive,nosnakecase,stylecheck
)

Types

type APIAction

type APIAction struct {
	ConfigAssignmentID string         `json:"config_assignment_id"`
	Config             APIConfig      `json:"configuration"`
	Agent              APIConfigAgent `json:"agent"`
}

type APIActions

type APIActions []APIAction

type APIConfig

type APIConfig struct {
	FileID   string `json:"config_file_id"`
	Contents string `json:"config"`
}

type APIConfigAgent

type APIConfigAgent struct {
	ID string `json:"agent_type_id"`
}

type Action

type Action struct {
	Configs  map[string][]Config `json:"configs"  yaml:"configs"`
	ID       string              `json:"id"       yaml:"id"` // not used yet, api only supports configs
	Type     string              `json:"type"     yaml:"type"`
	Commands []Command           `json:"commands" yaml:"commands"`
}

type ActionPoller

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

func NewActionPoller

func NewActionPoller() (*ActionPoller, error)

func (*ActionPoller) Start

func (p *ActionPoller) Start(ctx context.Context)

type Actions

type Actions []Action

func ParseAPIActions

func ParseAPIActions(data []byte) (Actions, error)

type Command

type Command struct {
	ID      string `json:"id"      yaml:"id"`
	Agent   string `json:"agent"   yaml:"agent"`
	Command string `json:"command" yaml:"command"`
}

not OS commands, commands the agent knows (e.g. restart_agent, agent_status, etc.). how to restart an agent is in the agent inventory. agent status would be the result of running `systemctl status <agent>`.

type CommandData

type CommandData struct {
	Output   string `json:"output"    yaml:"output"`
	Error    string `json:"error"     yaml:"error"`
	ExitCode int    `json:"exit_code" yaml:"exit_code"`
}

type CommandResult

type CommandResult struct {
	ID          string      `json:"id"     yaml:"id"`
	Status      string      `json:"status" yaml:"status"` // active or error
	CommandData CommandData `json:"data"   yaml:"data"`
}

Output will be base64 encoded.

type Config

type Config struct {
	ID       string `json:"id"       yaml:"id"`
	Path     string `json:"path"     yaml:"path"`
	Contents string `json:"contents" yaml:"contents"`
}

Contest should be base64 encoded.

type ConfigData

type ConfigData struct {
	WriteResult  string `json:"write_result,omitempty"  yaml:"write_result,omitempty"`
	ReloadResult string `json:"reload_result,omitempty" yaml:"reload_result,omitempty"`
}

type ConfigResult

type ConfigResult struct {
	ID         string     `json:"config_assignment_id" yaml:"config_assignment_id"`
	Status     string     `json:"status"               yaml:"status"` // STATUS_ACTIVE or STATUS_ERROR
	Info       string     `json:"info,omitempty"       yaml:"info,omitempty"`
	ConfigData ConfigData `json:"data,omitempty"       yaml:"data,omitempty"`
}

write result will be "OK" or the err received when trying to write the file. reload result will be empty or base64 encoded as it may be multi-line output.

type Result

type Result struct {
	ActionID      string        `json:"action_id"      yaml:"action_id"` // not used at this time, api only supports configs
	ConfigResult  ConfigResult  `json:"config_result"  yaml:"config_result"`
	CommandResult CommandResult `json:"command_result" yaml:"command_result"`
}

type StatusData

type StatusData struct {
	SubStatus string `json:"substatus"`
	Error     string `json:"error"`
	RawResult string `json:"raw_result"`
	ExitCode  int    `json:"exit_code"`
}

type StatusPoller

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

func NewStatusPoller

func NewStatusPoller() (*StatusPoller, error)

func (*StatusPoller) Start

func (p *StatusPoller) Start(ctx context.Context)

type StatusResult

type StatusResult struct {
	Status     string     `json:"status"`
	StatusData StatusData `json:"status_data"`
}