validations

Documentation

Index

• func CheckDockerAllocatedMemory(ctx context.Context, dockerExecutable DockerExecutable)
• func CheckDockerDesktopVersion(ctx context.Context, dockerExecutable DockerExecutable) error
• func CheckMinimumDockerVersion(ctx context.Context, dockerExecutable DockerExecutable) error
• func FileExists(filename string) bool
• func FileExistsAndIsNotEmpty(filename string) bool
• func NewKubectl(t *testing.T) (*executables.Kubectl, context.Context, *types.Cluster, ...)
• func RunPreflightValidations(validations []ValidationResult) error
• func ValidateCertForRegistryMirror(clusterSpec *cluster.Spec, tlsValidator TlsValidator) error
• func ValidateClusterNameArg(args []string) (string, error)
• func ValidateDockerDesktopVersion(ctx context.Context, dockerExecutable DockerExecutable, ...) error
• func ValidateK8s123Support(clusterSpec *cluster.Spec) error
• type DockerExecutable
• type KubectlClient
• type Opts
  • func (o *Opts) SetDefaults()
• type Runner
  • func NewRunner() *Runner
  • func (r *Runner) Register(validations ...Validation)
  • func (r *Runner) Run() error
• type TlsValidator
• type Validation
• type ValidationError
  • func (v *ValidationError) Error() string
• type ValidationResult
  • func (v *ValidationResult) LogPass()
  • func (v *ValidationResult) Report()

Functions

func CheckDockerAllocatedMemory

func CheckDockerAllocatedMemory(ctx context.Context, dockerExecutable DockerExecutable)

func CheckDockerDesktopVersion

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

func CheckMinimumDockerVersion

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

func FileExists

func FileExists(filename string) bool

func FileExistsAndIsNotEmpty

func FileExistsAndIsNotEmpty(filename string) bool

func NewKubectl

func NewKubectl(t *testing.T) (*executables.Kubectl, context.Context, *types.Cluster, *mockexecutables.MockExecutable)

func RunPreflightValidations

func RunPreflightValidations(validations []ValidationResult) error

func ValidateCertForRegistryMirror

func ValidateCertForRegistryMirror(clusterSpec *cluster.Spec, tlsValidator TlsValidator) error

func ValidateClusterNameArg

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

func ValidateDockerDesktopVersion

func ValidateDockerDesktopVersion(ctx context.Context, dockerExecutable DockerExecutable, dockerDesktopVersion string) error

func ValidateK8s123Support

func ValidateK8s123Support(clusterSpec *cluster.Spec) error

Types

type DockerExecutable

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

type KubectlClient

type KubectlClient interface {
	ValidateControlPlaneNodes(ctx context.Context, cluster *types.Cluster, clusterName string) error
	ValidateWorkerNodes(ctx context.Context, clusterName string, kubeconfig string) error
	ValidateNodes(ctx context.Context, kubeconfig string) error
	ValidateClustersCRD(ctx context.Context, cluster *types.Cluster) error
	ValidateEKSAClustersCRD(ctx context.Context, cluster *types.Cluster) error
	Version(ctx context.Context, cluster *types.Cluster) (*executables.VersionResponse, error)
	GetClusters(ctx context.Context, cluster *types.Cluster) ([]types.CAPICluster, error)
	GetEksaCluster(ctx context.Context, cluster *types.Cluster, clusterName string) (*v1alpha1.Cluster, error)
	GetEksaGitOpsConfig(ctx context.Context, gitOpsConfigName string, kubeconfigFile string, namespace string) (*v1alpha1.GitOpsConfig, error)
	GetEksaFluxConfig(ctx context.Context, fluxConfigName string, kubeconfigFile string, namespace string) (*v1alpha1.FluxConfig, error)
	GetEksaOIDCConfig(ctx context.Context, oidcConfigName string, kubeconfigFile string, namespace string) (*v1alpha1.OIDCConfig, error)
	GetEksaVSphereDatacenterConfig(ctx context.Context, vsphereDatacenterConfigName string, kubeconfigFile string, namespace string) (*v1alpha1.VSphereDatacenterConfig, error)
	GetEksaAWSIamConfig(ctx context.Context, awsIamConfigName string, kubeconfigFile string, namespace string) (*v1alpha1.AWSIamConfig, error)
	SearchEksaGitOpsConfig(ctx context.Context, gitOpsConfigName string, kubeconfigFile string, namespace string) ([]*v1alpha1.GitOpsConfig, error)
	SearchIdentityProviderConfig(ctx context.Context, ipName string, kind string, kubeconfigFile string, namespace string) ([]*v1alpha1.VSphereDatacenterConfig, error)
}

type Opts

type Opts struct {
	Kubectl           KubectlClient
	Spec              *cluster.Spec
	WorkloadCluster   *types.Cluster
	ManagementCluster *types.Cluster
	Provider          providers.Provider
	TlsValidator      TlsValidator
	CliConfig         *config.CliConfig
}

func (*Opts) SetDefaults

func (o *Opts) SetDefaults()

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 TlsValidator

type TlsValidator interface {
	ValidateCert(host, port, caCertContent string) error
	HasSelfSignedCert(host, port string) (bool, error)
}

type Validation

type Validation func() *ValidationResult

type ValidationError

type ValidationError struct {
	Errs []string
}

func (*ValidationError) Error

func (v *ValidationError) Error() string

type ValidationResult

type ValidationResult struct {
	Name        string
	Err         error
	Remediation string
	Silent      bool
}

func (*ValidationResult) LogPass

func (v *ValidationResult) LogPass()

func (*ValidationResult) Report

func (v *ValidationResult) Report()