agent

Documentation

Index

• Variables
• func Run(cmd *cobra.Command, args []string)
• type Config
  • func ParseConfig(data []byte) (Config, error)
  • func (c *Config) Dump() (string, error)
• type Endpoint

Variables

var AuthToken string

AuthToken is the authorization token that will be used for API calls

var BackoffMaxTime time.Duration

BackoffMaxTime is the maximum time for which data gatherers will be retried

var ConfigFilePath string

ConfigFilePath is where the agent will try to load the configuration from

var CredentialsPath string

CredentialsPath is where the agent will try to loads the credentials. (Experimental)

var InputPath string

InputPath is where the agent will read data from instead of gathering from clusters if specified

var OneShot bool

OneShot flag causes agent to run once

var OutputPath string

OutputPath is where the agent will write data to locally if specified

var Period time.Duration

Period is the time waited between scans

Functions

func Run

func Run(cmd *cobra.Command, args []string)

Run starts the agent process

Types

type Config

type Config struct {
	Schedule string `yaml:"schedule"`
	// Token is the agent token if using basic authentication.
	// If not provided it will assume OAuth2 authentication.
	Token string `yaml:"token"`
	// Deprecated: Endpoint is being replaced with Server.
	Endpoint Endpoint `yaml:"endpoint"`
	// Server is the base url for the Preflight server.
	// It defaults to https://preflight.jetstack.io.
	Server string `yaml:"server"`
	// OrganizationID within Preflight that will receive the data.
	OrganizationID string `yaml:"organization_id"`
	// ClusterID is the cluster that the agent is scanning.
	ClusterID     string         `yaml:"cluster_id"`
	DataGatherers []dataGatherer `yaml:"data-gatherers"`
	// InputPath replaces DataGatherers with input data file
	InputPath string `yaml:"input-path"`
	// OutputPath replaces Server with output data file
	OutputPath string `yaml:"output-path"`
}

Config wraps the options for a run of the agent.

func ParseConfig

func ParseConfig(data []byte) (Config, error)

ParseConfig reads config into a struct used to configure running agents

func (*Config) Dump

func (c *Config) Dump() (string, error)

Dump generates a YAML string of the Config object

type Endpoint

type Endpoint struct {
	Protocol string `yaml:"protocol"`
	Host     string `yaml:"host"`
	Path     string `yaml:"path"`
}