cmd

Documentation

Index

• Constants
• Variables
• func GetBuildDataPlaneType() string
• type AgentRootCmd
  • func NewCmd(rootCmd *cobra.Command, exeName, desc string, ...) AgentRootCmd
  • func NewRootCmd(exeName, desc string, initConfigHandler InitConfigHandler, ...) AgentRootCmd
• type AgentVersionCheckJob
  • func NewAgentVersionCheckJob(cfg config.CentralConfig) (*AgentVersionCheckJob, error)
  • func (avj *AgentVersionCheckJob) Execute() error
  • func (avj *AgentVersionCheckJob) Ready() bool
  • func (avj *AgentVersionCheckJob) Status() error
• type CommandHandler
• type InitConfigHandler

Constants

const (
	EnvFileFlag               = "envFile"
	EnvFileFlagDescription    = "Path of the file with environment variables to override configuration"
	InstallDirFlag            = "installDir"
	InstallDirFlagDescription = "The path to the working directory. If not set, will default the working directory to the execution path"
)

Constants for cmd flags

Variables

var BuildAgentDescription string

BuildAgentDescription - agent name you wish to display in things like the version and help command

var BuildAgentName string

BuildAgentName - internal identification name for the agent

var BuildCommitSha string

BuildCommitSha -

var BuildDataPlaneType string

BuildDataPlaneType -

var BuildTime string

BuildTime -

var BuildVersion string

BuildVersion -

var SDKBuildVersion string

SDKBuildVersion -

Functions

func GetBuildDataPlaneType

func GetBuildDataPlaneType() string

GetBuildDataPlaneType - returns the BuildDataPlaneType

Types

type AgentRootCmd

type AgentRootCmd interface {
	RootCmd() *cobra.Command
	Execute() error

	// Get the agentType
	GetAgentType() config.AgentType
	AddCommand(*cobra.Command)

	GetProperties() properties.Properties
}

AgentRootCmd - Root Command for the Agents

func NewCmd

func NewCmd(rootCmd *cobra.Command, exeName, desc string, initConfigHandler InitConfigHandler, commandHandler CommandHandler, agentType config.AgentType) AgentRootCmd

NewCmd - Creates a new Agent Root Command using existing cmd

func NewRootCmd

func NewRootCmd(exeName, desc string, initConfigHandler InitConfigHandler, commandHandler CommandHandler, agentType config.AgentType) AgentRootCmd

NewRootCmd - Creates a new Agent Root Command

type AgentVersionCheckJob

type AgentVersionCheckJob struct {
	jobs.Job
	// contains filtered or unexported fields
}

AgentVersionCheckJob - polls for agent versions

func NewAgentVersionCheckJob

func NewAgentVersionCheckJob(cfg config.CentralConfig) (*AgentVersionCheckJob, error)

NewAgentVersionCheckJob - creates a new agent version check job structure

func (*AgentVersionCheckJob) Execute

func (avj *AgentVersionCheckJob) Execute() error

Execute - run agent version check job one time

func (*AgentVersionCheckJob) Ready

func (avj *AgentVersionCheckJob) Ready() bool

Ready -

func (*AgentVersionCheckJob) Status

func (avj *AgentVersionCheckJob) Status() error

Status -

type CommandHandler

type CommandHandler func() error

CommandHandler - Root command execution handler

type InitConfigHandler

type InitConfigHandler func(centralConfig config.CentralConfig) (interface{}, error)

InitConfigHandler - Handler to be invoked on config initialization