validations

Documentation

Index

• func CheckDockerAllocatedMemory(ctx context.Context, dockerExecutable DockerExecutable)
• 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 ProcessValidationResults(validations []Validation) error
• func ValidateAuthenticationForGitProvider(clusterSpec *cluster.Spec, cliConfig *config.CliConfig) error
• func ValidateAuthenticationForRegistryMirror(clusterSpec *cluster.Spec) error
• func ValidateCertForRegistryMirror(clusterSpec *cluster.Spec, tlsValidator TlsValidator) error
• func ValidateClusterNameArg(args []string) (string, error)
• func ValidateDockerExecutable(ctx context.Context, docker DockerExecutable, os string) error
• func ValidateManagementClusterName(ctx context.Context, k KubectlClient, mgmtCluster *types.Cluster, ...) error
• func ValidateOSForRegistryMirror(clusterSpec *cluster.Spec, provider providers.Provider) 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
  • func (v *ValidationError) String() string
• 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 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 ProcessValidationResults

func ProcessValidationResults(validations []Validation) error

ProcessValidationResults is currently used for unit test processing.

func ValidateAuthenticationForGitProvider

func ValidateAuthenticationForGitProvider(clusterSpec *cluster.Spec, cliConfig *config.CliConfig) error

func ValidateAuthenticationForRegistryMirror

func ValidateAuthenticationForRegistryMirror(clusterSpec *cluster.Spec) error

ValidateAuthenticationForRegistryMirror checks if REGISTRY_USERNAME and REGISTRY_PASSWORD is set if authenticated registry mirrors are used.

func ValidateCertForRegistryMirror

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

func ValidateClusterNameArg

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

func ValidateDockerExecutable

func ValidateDockerExecutable(ctx context.Context, docker DockerExecutable, os string) error

func ValidateManagementClusterName

func ValidateManagementClusterName(ctx context.Context, k KubectlClient, mgmtCluster *types.Cluster, mgmtClusterName string) error

ValidateManagementClusterName checks if the management cluster specified in the workload cluster spec is valid.

func ValidateOSForRegistryMirror

func ValidateOSForRegistryMirror(clusterSpec *cluster.Spec, provider providers.Provider) error

ValidateOSForRegistryMirror checks if the OS is valid for the provided registry mirror configuration.

Types

type DockerExecutable

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

type KubectlClient

type KubectlClient interface {
	List(ctx context.Context, kubeconfig string, list kubernetes.ObjectList) error
	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)
	GetBundles(ctx context.Context, kubeconfigFile, name, namespace string) (*releasev1alpha1.Bundles, 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)
	GetEksaTinkerbellDatacenterConfig(ctx context.Context, tinkerbellDatacenterConfigName string, kubeconfigFile string, namespace string) (*v1alpha1.TinkerbellDatacenterConfig, error)
	GetEksaTinkerbellMachineConfig(ctx context.Context, tinkerbellMachineConfigName string, kubeconfigFile string, namespace string) (*v1alpha1.TinkerbellMachineConfig, error)
	GetEksaAWSIamConfig(ctx context.Context, awsIamConfigName string, kubeconfigFile string, namespace string) (*v1alpha1.AWSIamConfig, error)
	SearchIdentityProviderConfig(ctx context.Context, ipName string, kind string, kubeconfigFile string, namespace string) ([]*v1alpha1.VSphereDatacenterConfig, error)
	GetObject(ctx context.Context, resourceType, name, namespace, kubeconfig string, obj runtime.Object) 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
	SkippedValidations map[string]bool
}

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
	IsSignedByUnknownAuthority(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

func (*ValidationError) String

func (v *ValidationError) String() 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()