options

Documentation

Overview

Package options implements the generic logic to manage the common options shared by all the falcoctl commands.

Index

• Constants
• type Artifact
  • func (art *Artifact) AddFlags(cmd *cobra.Command) error
  • func (art *Artifact) OSArch(index int) (os, arch string)
  • func (art *Artifact) Validate() error
• type Common
  • func NewOptions() *Common
  • func (o *Common) AddFlags(flags *pflag.FlagSet)
  • func (o *Common) Initialize(cfgs ...Configs)
• type Configs
  • func WithIndexCache(c *cache.Cache) Configs
  • func WithWriter(writer io.Writer) Configs
• type Directory
  • func (o *Directory) AddFlags(cmd *cobra.Command)
• type Driver
  • func (d *Driver) ToDriverConfig() *config.Driver
  • func (d *Driver) Validate() error
• type DriverTypes
  • func NewDriverTypes() *DriverTypes
• type Enum
  • func NewEnum(allowed []string, d string) *Enum
  • func (e *Enum) Allowed() string
  • func (e *Enum) Set(p string) error
  • func (e *Enum) String() string
  • func (e *Enum) Type() string
• type LogFormat
  • func NewLogFormat() *LogFormat
  • func (lg *LogFormat) ToPtermFormatter() pterm.LogFormatter
• type LogLevel
  • func NewLogLevel() *LogLevel
  • func (ll *LogLevel) ToPtermLogLevel() pterm.LogLevel
• type Registry
  • func (r *Registry) AddFlags(cmd *cobra.Command)

Constants

const (
	// FlagRulesFilesDir is the name of the flag to specify the directory path of rules files.
	FlagRulesFilesDir = "rulesfiles-dir"

	// FlagPluginsFilesDir is the name of the flag to specify the directory path of plugins.
	FlagPluginsFilesDir = "plugins-dir"

	// FlagAssetsFilesDir is the name of the flag to specify the directory path of assets.
	FlagAssetsFilesDir = "assets-dir"
)

const (
	// LogFormatColor formatting option for logs.
	LogFormatColor = "color"
	// LogFormatText formatting option for logs.
	LogFormatText = "text"
	// LogFormatJSON formatting otion for logs.
	LogFormatJSON = "json"
)

const (
	// LogLevelInfo level option for logs.
	LogLevelInfo = "info"
	// LogLevelWarn level opiton for logs.
	LogLevelWarn = "warn"
	// LogLevelDebug level option for logs.
	LogLevelDebug = "debug"
	// LogLevelTrace level option for logs.
	LogLevelTrace = "trace"
)

Types

type Artifact

type Artifact struct {
	ArtifactType     oci.ArtifactType
	Name             string
	Version          string
	Platforms        []string // orders matter (same as args)
	Dependencies     []string
	Requirements     []string
	Tags             []string
	AnnotationSource string
}

Artifact specific options. Commands that need these options may embed this struct in their options.

func (*Artifact) AddFlags

func (art *Artifact) AddFlags(cmd *cobra.Command) error

AddFlags registers the artifacts flags.

func (*Artifact) OSArch

func (art *Artifact) OSArch(index int) (os, arch string)

OSArch returns the OS and the ARCH of the platform at index-th position.

func (*Artifact) Validate

func (art *Artifact) Validate() error

Validate validates the options passed by the user.

type Common

type Common struct {
	// Printer used by all commands to output messages.
	Printer *output.Printer

	// Config file. It must not be possible to be reinitialized by subcommands,
	// using the Initialize function. It will be attached as global flags.
	ConfigFile string
	// IndexCache caches the entries for the configured indexes.
	IndexCache *cache.Cache
	// contains filtered or unexported fields
}

Common provides the common flags, options, and printers for all the commands. All the fields provided by the Common will be initialized before the commands are executed through the Initialize func.

func NewOptions

func NewOptions() *Common

NewOptions returns a new Common struct.

func (*Common) AddFlags

func (o *Common) AddFlags(flags *pflag.FlagSet)

AddFlags registers the common flags.

func (*Common) Initialize

func (o *Common) Initialize(cfgs ...Configs)

Initialize initializes the options based on the configs. Subsequent calls will overwrite the previous configurations based on the new configs passed to the functions.

type Configs

type Configs func(options *Common)

Configs type of the configs accepted by the Initialize function.

func WithIndexCache

func WithIndexCache(c *cache.Cache) Configs

WithIndexCache sets the index cache.

func WithWriter

func WithWriter(writer io.Writer) Configs

WithWriter sets the writer for the printer.

type Directory

type Directory struct {
	// RulesfilesDir path where rule are installed
	RulesfilesDir string
	// PluginsDir path where plugins are installed
	PluginsDir string
	// AssetsDire path where assets are installed
	AssetsDir string
}

Directory options for install directories for artifacts.

func (*Directory) AddFlags

func (o *Directory) AddFlags(cmd *cobra.Command)

AddFlags registers the directories flags.

type Driver

type Driver struct {
	Type     drivertype.DriverType
	Name     string
	Repos    []string
	Version  string
	HostRoot string
}

Driver defines options that are common while interacting with driver commands.

func (*Driver) ToDriverConfig

func (d *Driver) ToDriverConfig() *config.Driver

ToDriverConfig maps a Driver options to Driver config struct.

func (*Driver) Validate

func (d *Driver) Validate() error

Validate runs all validators steps for Driver options.

type DriverTypes

type DriverTypes struct {
	*Enum
}

DriverTypes data structure for driver types.

func NewDriverTypes

func NewDriverTypes() *DriverTypes

NewDriverTypes returns a new Enum configured for the driver types.

type Enum

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

Enum implements the flag interface. It can be used as a base for new flags that can have a limited set of values.

func NewEnum

func NewEnum(allowed []string, d string) *Enum

NewEnum returns an enum struct. The firs argument is a set of values allowed for the flag. The second argument is the default value of the flag.

func (*Enum) Allowed

func (e *Enum) Allowed() string

Allowed returns the list of allowed values enclosed in parenthesis.

func (*Enum) Set

func (e *Enum) Set(p string) error

Set the value for the flag.

func (*Enum) String

func (e *Enum) String() string

String returns the value.

func (*Enum) Type

func (e *Enum) Type() string

Type returns the type of the flag.

type LogFormat

type LogFormat struct {
	*Enum
}

LogFormat data structure for log-format flag.

func NewLogFormat

func NewLogFormat() *LogFormat

NewLogFormat returns a new Enum configured for the log formats flag.

func (*LogFormat) ToPtermFormatter

func (lg *LogFormat) ToPtermFormatter() pterm.LogFormatter

ToPtermFormatter converts the current formatter to pterm.LogFormatter.

type LogLevel

type LogLevel struct {
	*Enum
}

LogLevel data structure for log-level flag.

func NewLogLevel

func NewLogLevel() *LogLevel

NewLogLevel returns a new Enum configured for the log level flag.

func (*LogLevel) ToPtermLogLevel

func (ll *LogLevel) ToPtermLogLevel() pterm.LogLevel

ToPtermLogLevel converts the current log level to pterm.LogLevel.

type Registry

type Registry struct {
	PlainHTTP bool
}

Registry defines options that are common while interacting with a remote registry.

func (*Registry) AddFlags

func (r *Registry) AddFlags(cmd *cobra.Command)

AddFlags registers the registry flags.