configuration_types.go

package v1alpha3

import (
	metav1 "k8s.io/apimachinery/pkg/apis/meta/v1"
)

// ConfigurationKind is the default scorecard componentconfig kind.
const ConfigurationKind = "Configuration"

// Configuration represents the set of test configurations which scorecard would run.
type Configuration struct {
	metav1.TypeMeta `json:",inline" yaml:",inline"`

	// Do not use metav1.ObjectMeta because this "object" should not be treated as an actual object.
	Metadata struct {
		// Name is a required field for kustomize-able manifests, and is not used on-cluster (nor is the config itself).
		Name string `json:"name,omitempty" yaml:"name,omitempty"`
	} `json:"metadata,omitempty" yaml:"metadata,omitempty"`

	// Stages is a set of test stages to run. Once a stage is finished, the next stage in the slice will be run.
	Stages []StageConfiguration `json:"stages" yaml:"stages"`

	// Storage is the optional storage configuration
	Storage Storage `json:"storage,omitempty" yaml:"storage,omitempty"`

	// ServiceAccount is the service account under which scorecard tests are run. This field is optional. If left unset, the `default` service account will be used.
	ServiceAccount string `json:"serviceaccount,omitempty" yaml:"serviceaccount,omitempty"`
}

// StageConfiguration configures a set of tests to be run.
type StageConfiguration struct {
	// Parallel, if true, will run each test in tests in parallel.
	// The default is to wait until a test finishes to run the next.
	Parallel bool `json:"parallel,omitempty" yaml:"parallel,omitempty"`
	// Tests are a list of tests to run.
	Tests []TestConfiguration `json:"tests" yaml:"tests"`
}

// TestConfiguration configures a specific scorecard test, identified by entrypoint.
type TestConfiguration struct {
	// Image is the name of the test image.
	Image string `json:"image" yaml:"image"`
	// UniqueID is is an optional unique test identifier of the test image.
	UniqueID string `json:"uniqueID,omitempty" yaml:"uniqueID,omitempty"`
	// Entrypoint is a list of commands and arguments passed to the test image.
	Entrypoint []string `json:"entrypoint,omitempty" yaml:"entrypoint,omitempty"`
	// Labels further describe the test and enable selection.
	Labels map[string]string `json:"labels,omitempty" yaml:"labels,omitempty"`
	// Storage is the optional storage configuration for the test image.
	Storage Storage `json:"storage,omitempty" yaml:"storage,omitempty"`
}

// Storage configures custom storage options
type Storage struct {
	// Spec contains the storage configuration options
	Spec StorageSpec `json:"spec" yaml:"spec"`
}

// StorageSpec contains storage configuration options
type StorageSpec struct {
	// MountPath configures the path to mount directories in the test pod
	MountPath MountPath `json:"mountPath,omitempty" yaml:"mountPath,omitempty"`
}

// MountPath configures the path to mount directories in the test pod
type MountPath struct {
	// Path is the fully qualified path that a directory should be mounted in the test pod
	Path string `json:"path,omitempty" yaml:"path,omitempty"`
}