cli

Documentation

Overview

Package cli implements the functionality for running proxydhcp as a CLI.

Index

• func RegisterFlags(c *Config, fs *flag.FlagSet)
• func SupportedBins(_ context.Context, opts ...Option) *ffcli.Command
• type Config
  • func ProxyDHCP(_ context.Context) (*ffcli.Command, *Config)
• type Option
  • func WithFlagSet(flagSet *flag.FlagSet) Option
  • func WithName(name string) Option
  • func WithOptions(opts ...ff.Option) Option
  • func WithShortUsage(shortUsage string) Option
  • func WithUsageFunc(usageFunc func(*ffcli.Command) string) Option

Functions

func RegisterFlags

func RegisterFlags(c *Config, fs *flag.FlagSet)

RegisterFlags registers CLI flags for the proxydhcp comand.

func SupportedBins

func SupportedBins(_ context.Context, opts ...Option) *ffcli.Command

SupportedBins returns the command for printing the arch to iPXE binary mapping.

Types

type Config

type Config struct {
	LogLevel        string `vname:"-loglevel" validate:"oneof=debug info"`
	TFTPAddr        string `vname:"-remote-tftp" validate:"required,hostname_port"`
	HTTPAddr        string `vname:"-remote-http" validate:"required,hostname_port"`
	IPXEAddr        string `vname:"-remote-ipxe" validate:"required,url"`
	IPXEScript      string `vname:"-ipxe-script" validate:"required"`
	ProxyAddr       string `vname:"-proxy-addr" validate:"required,ip"`
	CustomUserClass string
	Log             logr.Logger
}

Config is the configuration for the proxydhcp command.

func ProxyDHCP

func ProxyDHCP(_ context.Context) (*ffcli.Command, *Config)

ProxyDHCP returns the CLI command and Config struct for the proxydhcp command.

type Option

type Option func(*bin)

Option for setting optional Client values.

func WithFlagSet

func WithFlagSet(flagSet *flag.FlagSet) Option

WithFlagSet adds a flag set to the command.

func WithName

func WithName(name string) Option

WithName sets the name of the command.

func WithOptions

func WithOptions(opts ...ff.Option) Option

WithOptions adds command options to the command.

func WithShortUsage

func WithShortUsage(shortUsage string) Option

WithShortUsage sets the short usage of the command.

func WithUsageFunc

func WithUsageFunc(usageFunc func(*ffcli.Command) string) Option

WithUsageFunc sets the usage function for the command.