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 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"
)

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
	AutoFloatingTags bool
	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
	Distro   driverdistro.Distro
	Kr       kernelrelease.KernelRelease
}

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.Enum
}

DriverTypes data structure for driver types.

func NewDriverTypes

func NewDriverTypes() *DriverTypes

NewDriverTypes returns a new Enum configured for the driver types.

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.