validate

Documentation

Overview

Package validate implements utilities to validate the command configuration by, for example, validating a set of given options.

Index

• Variables
• func Flags(cmd *cobra.Command, vp *viper.Viper) error
• type FlagFunc

Variables

var (
	// ErrInvalidKeypair means that a TLS keypair is required but only one of the
	// key or certificate was provided.
	ErrInvalidKeypair = errors.New("certificate and private key are both required, but only one was provided")

	// ErrTLSRequired means that Transport Layer Security (TLS) is required but
	// not set.
	ErrTLSRequired = errors.New("transport layer security required")
)

var (
	// ErrInvalidBasicAuthCredentials occurs when only one of basic-auth-user or basic-auth-password is configured.
	ErrInvalidBasicAuthCredentials = fmt.Errorf("must specify both %s and %s", config.KeyBasicAuthUsername, config.KeyBasicAuthPassword)
)

var FlagFuncs []FlagFunc

FlagFuncs is a combination of multiple flag validation functions.

Functions

func Flags

func Flags(cmd *cobra.Command, vp *viper.Viper) error

Flags validates flags for the given command.

Types

type FlagFunc

type FlagFunc func(cmd *cobra.Command, vp *viper.Viper) error

FlagFunc is a function that validates a flag or set of flags of cmd.