validations

Documentation

Index

• func CheckDockerAllocatedMemory(ctx context.Context, dockerExecutable DockerExecutable)
• func CheckMinimumDockerVersion(ctx context.Context, dockerExecutable DockerExecutable) error
• func ClusterName(clusterName string) error
• func ClusterNameLength(clusterName string) error
• func FileExists(filename string) bool
• func KubeConfigExists(dir, clusterName string, kubeConfigFileOverride string, ...) bool
• func ValidateClusterNameArg(args []string) (string, error)
• type DockerExecutable
• type Runner
  • func NewRunner() *Runner
  • func (r *Runner) Register(validations ...Validation)
  • func (r *Runner) Run() error
• type Validation
• type ValidationResult
  • func (v *ValidationResult) LogPass()
  • func (v *ValidationResult) Report()

Functions

func CheckDockerAllocatedMemory

func CheckDockerAllocatedMemory(ctx context.Context, dockerExecutable DockerExecutable)

func CheckMinimumDockerVersion

func CheckMinimumDockerVersion(ctx context.Context, dockerExecutable DockerExecutable) error

func ClusterName

func ClusterName(clusterName string) error

func ClusterNameLength

func ClusterNameLength(clusterName string) error

func FileExists

func FileExists(filename string) bool

func KubeConfigExists

func KubeConfigExists(dir, clusterName string, kubeConfigFileOverride string, kubeconfigPattern string) bool

func ValidateClusterNameArg

func ValidateClusterNameArg(args []string) (string, error)

Types

type DockerExecutable

type DockerExecutable interface {
	Version(ctx context.Context) (int, error)
	AllocatedMemory(ctx context.Context) (uint64, error)
}

type Runner

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

func NewRunner

func NewRunner() *Runner

func (*Runner) Register

func (r *Runner) Register(validations ...Validation)

func (*Runner) Run

func (r *Runner) Run() error

type Validation

type Validation func() *ValidationResult

type ValidationResult

type ValidationResult struct {
	Name        string
	Err         error
	Remediation string
}

func (*ValidationResult) LogPass

func (v *ValidationResult) LogPass()

func (*ValidationResult) Report

func (v *ValidationResult) Report()