v1beta1

package
v1.0.0-alpha9 Latest Latest
Warning

This package is not in the latest version of its module.

 Go to latest Published: Jun 22, 2021 License: Apache-2.0 Imports: 5 Imported by: 0

Documentation

Overview

Package v1beta1 contains API Schema definitions for the av v1beta1 API group +kubebuilder:object:generate=true +groupName=av.mittwald.de

Index

Constants

This section is empty.

Variables

View Source 
var (
	// GroupVersion is group version used to register these objects
	GroupVersion = schema.GroupVersion{Group: "av.mittwald.de", Version: "v1beta1"}

	// SchemeBuilder is used to add go types to the GroupVersionKind scheme
	SchemeBuilder = &scheme.Builder{GroupVersion: GroupVersion}

	// AddToScheme adds the types in this group-version to the given scheme.
	AddToScheme = SchemeBuilder.AddToScheme
)

Functions

This section is empty.

Types

type ScanEngine 

type ScanEngine string
const (
	ScanEngineClamAV ScanEngine = "ClamAV"
)

type ScheduledVirusScan 

type ScheduledVirusScan struct {
	metav1.TypeMeta   `json:",inline"`
	metav1.ObjectMeta `json:"metadata,omitempty"`

	Spec   ScheduledVirusScanSpec   `json:"spec,omitempty"`
	Status ScheduledVirusScanStatus `json:"status,omitempty"`
}

ScheduledVirusScan is the Schema for the scheduledvirusscans API

func (*ScheduledVirusScan) DeepCopy 

func (in *ScheduledVirusScan) DeepCopy() *ScheduledVirusScan

DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new ScheduledVirusScan.

func (*ScheduledVirusScan) DeepCopyInto 

func (in *ScheduledVirusScan) DeepCopyInto(out *ScheduledVirusScan)

DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.

func (*ScheduledVirusScan) DeepCopyObject 

func (in *ScheduledVirusScan) DeepCopyObject() runtime.Object

DeepCopyObject is an autogenerated deepcopy function, copying the receiver, creating a new runtime.Object.

type ScheduledVirusScanList 

type ScheduledVirusScanList struct {
	metav1.TypeMeta `json:",inline"`
	metav1.ListMeta `json:"metadata,omitempty"`
	Items           []ScheduledVirusScan `json:"items"`
}

ScheduledVirusScanList contains a list of ScheduledVirusScan

func (*ScheduledVirusScanList) DeepCopy 

func (in *ScheduledVirusScanList) DeepCopy() *ScheduledVirusScanList

DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new ScheduledVirusScanList.

func (*ScheduledVirusScanList) DeepCopyInto 

func (in *ScheduledVirusScanList) DeepCopyInto(out *ScheduledVirusScanList)

DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.

func (*ScheduledVirusScanList) DeepCopyObject 

func (in *ScheduledVirusScanList) DeepCopyObject() runtime.Object

DeepCopyObject is an autogenerated deepcopy function, copying the receiver, creating a new runtime.Object.

type ScheduledVirusScanSpec 

type ScheduledVirusScanSpec struct {
	// Schedule is a crontab schedule that describes how often a VirusScan
	// resource should be created.
	Schedule string `json:"schedule"`

	// HistorySize is the amount of VirusScan jobs that should be kept after
	// completion.
	// +optional
	HistorySize *int `json:"historySize,omitempty"`

	// Template is the template for the actual VirusScan object.
	Template VirusScanTemplate `json:"template"`
}

ScheduledVirusScanSpec defines the desired state of ScheduledVirusScan

func (*ScheduledVirusScanSpec) DeepCopy 

func (in *ScheduledVirusScanSpec) DeepCopy() *ScheduledVirusScanSpec

DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new ScheduledVirusScanSpec.

func (*ScheduledVirusScanSpec) DeepCopyInto 

func (in *ScheduledVirusScanSpec) DeepCopyInto(out *ScheduledVirusScanSpec)

DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.

type ScheduledVirusScanStatus 

type ScheduledVirusScanStatus struct {
	// LastScheduledScan is a reference to the last VirusScan object created
	// from this ScheduledVirusScan instance.
	// +optional
	LastScheduledScan *corev1.ObjectReference `json:"lastScheduledScan,omitempty"`

	// LastScheduledTime is the time at which the last VirusScan was scheduled
	// +optional
	LastScheduledTime *metav1.Time `json:"lastScheduledTime,omitempty"`
}

ScheduledVirusScanStatus defines the observed state of ScheduledVirusScan

func (*ScheduledVirusScanStatus) DeepCopy 

func (in *ScheduledVirusScanStatus) DeepCopy() *ScheduledVirusScanStatus

DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new ScheduledVirusScanStatus.

func (*ScheduledVirusScanStatus) DeepCopyInto 

func (in *ScheduledVirusScanStatus) DeepCopyInto(out *ScheduledVirusScanStatus)

DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.

type VirusScan 

type VirusScan struct {
	metav1.TypeMeta   `json:",inline"`
	metav1.ObjectMeta `json:"metadata,omitempty"`

	Spec   VirusScanSpec   `json:"spec,omitempty"`
	Status VirusScanStatus `json:"status,omitempty"`
}

VirusScan is the Schema for the virusscans API

func (*VirusScan) DeepCopy 

func (in *VirusScan) DeepCopy() *VirusScan

DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new VirusScan.

func (*VirusScan) DeepCopyInto 

func (in *VirusScan) DeepCopyInto(out *VirusScan)

DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.

func (*VirusScan) DeepCopyObject 

func (in *VirusScan) DeepCopyObject() runtime.Object

DeepCopyObject is an autogenerated deepcopy function, copying the receiver, creating a new runtime.Object.

type VirusScanCondition 

type VirusScanCondition struct {
	Type VirusScanConditionType `json:"type"`

	Status corev1.ConditionStatus `json:"status"`

	// Last time the condition transitioned from one status to another.
	// +optional
	LastTransitionTime metav1.Time `json:"lastTransitionTime,omitempty"`

	// Unique, one-word, CamelCase reason for the condition's last transition.
	// +optional
	Reason string `json:"reason,omitempty"`

	// Human-readable message indicating details about last transition.
	// +optional
	Message string `json:"message,omitempty"`
}

func (*VirusScanCondition) DeepCopy 

func (in *VirusScanCondition) DeepCopy() *VirusScanCondition

DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new VirusScanCondition.

func (*VirusScanCondition) DeepCopyInto 

func (in *VirusScanCondition) DeepCopyInto(out *VirusScanCondition)

DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.

type VirusScanConditionType 

type VirusScanConditionType string
const (
	VirusScanConditionTypeScheduled VirusScanConditionType = "Scheduled"
	VirusScanConditionTypeCompleted VirusScanConditionType = "Completed"
	VirusScanConditionTypePositive  VirusScanConditionType = "Positive"
)

type VirusScanList 

type VirusScanList struct {
	metav1.TypeMeta `json:",inline"`
	metav1.ListMeta `json:"metadata,omitempty"`
	Items           []VirusScan `json:"items"`
}

VirusScanList contains a list of VirusScan

func (*VirusScanList) DeepCopy 

func (in *VirusScanList) DeepCopy() *VirusScanList

DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new VirusScanList.

func (*VirusScanList) DeepCopyInto 

func (in *VirusScanList) DeepCopyInto(out *VirusScanList)

DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.

func (*VirusScanList) DeepCopyObject 

func (in *VirusScanList) DeepCopyObject() runtime.Object

DeepCopyObject is an autogenerated deepcopy function, copying the receiver, creating a new runtime.Object.

type VirusScanPhase 

type VirusScanPhase string
const (
	VirusScanPhaseUnspecified       VirusScanPhase = ""
	VirusScanPhasePending           VirusScanPhase = "Pending"
	VirusScanPhaseRunning           VirusScanPhase = "Running"
	VirusScanPhaseCompletedPositive VirusScanPhase = "CompletedPositive"
	VirusScanPhaseCompletedNegative VirusScanPhase = "CompletedNegative"
	VirusScanPhaseFailed            VirusScanPhase = "Failed"
)

type VirusScanResultItem 

type VirusScanResultItem struct {
	FilePath          string `json:"filePath"`
	MatchingSignature string `json:"matchingSignature"`
}

func (*VirusScanResultItem) DeepCopy 

func (in *VirusScanResultItem) DeepCopy() *VirusScanResultItem

DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new VirusScanResultItem.

func (*VirusScanResultItem) DeepCopyInto 

func (in *VirusScanResultItem) DeepCopyInto(out *VirusScanResultItem)

DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.

type VirusScanSpec 

type VirusScanSpec struct {
	// Engine describes which AV engine should be used for the virus scan.
	// May be left empty, in which case the default engine (probably ClamAV)
	// will be used.
	// +optional
	Engine ScanEngine `json:"engine,omitempty"`

	// Resources define the resource requirements that should be allocated for
	// the scanner Pod. May be left empty, in which case KubeAV will use some
	// default resource requirements.
	// +optional
	Resources corev1.ResourceRequirements `json:"resources,omitempty"`

	// Targets defines which directories to scan.
	Targets []VirusScanTargetSpec `json:"targets"`

	// ServiceAccountName specified the name of the service account that should
	// be used for the actual scanning containers. If left empty, this will
	// fall back to a default value.
	// +optional
	ServiceAccountName string `json:"serviceAccountName,omitempty"`
}

VirusScanSpec defines the desired state of VirusScan

func (*VirusScanSpec) DeepCopy 

func (in *VirusScanSpec) DeepCopy() *VirusScanSpec

DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new VirusScanSpec.

func (*VirusScanSpec) DeepCopyInto 

func (in *VirusScanSpec) DeepCopyInto(out *VirusScanSpec)

DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.

type VirusScanStatus 

type VirusScanStatus struct {
	// +optional
	Conditions map[VirusScanConditionType]VirusScanCondition `json:"conditions,omitempty"`

	// +optional
	Phase VirusScanPhase `json:"phase,omitempty"`

	// Summary contains a human-readable summary of the current scan status
	// +optional
	Summary string `json:"summary,omitempty"`

	// Job is a reference to the respective batchv1.Job object as soon as the
	// VirusScan has been scheduled.
	// +optional
	Job *corev1.ObjectReference `json:"job,omitempty"`

	// ScanResults contains the results of the virus scan.
	// +optional
	ScanResults []VirusScanResultItem `json:"scanResults,omitempty"`
}

VirusScanStatus defines the observed state of VirusScan

func (*VirusScanStatus) DeepCopy 

func (in *VirusScanStatus) DeepCopy() *VirusScanStatus

DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new VirusScanStatus.

func (*VirusScanStatus) DeepCopyInto 

func (in *VirusScanStatus) DeepCopyInto(out *VirusScanStatus)

DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.

func (*VirusScanStatus) GetCondition 

func (in *VirusScanStatus) GetCondition(conditionType VirusScanConditionType) corev1.ConditionStatus

type VirusScanTargetSpec 

type VirusScanTargetSpec struct {
	Volume corev1.VolumeSource `json:"volume"`

	// +optional
	SubPath string `json:"subPath,omitempty"`

	// +optional
	MountPath string `json:"mountPath,omitempty"`

	// ExcludeFiles is a list of regular expressions that is used for excluding
	// files from scanning.
	// +optional
	ExcludeFiles []string `json:"excludeFiles,omitempty"`

	// ExcludeDirectories is a list of regular expressions that is used for
	// excluding directories from scanning.
	// +optional
	ExcludeDirectories []string `json:"excludeDirectories,omitempty"`
}

func (*VirusScanTargetSpec) DeepCopy 

func (in *VirusScanTargetSpec) DeepCopy() *VirusScanTargetSpec

DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new VirusScanTargetSpec.

func (*VirusScanTargetSpec) DeepCopyInto 

func (in *VirusScanTargetSpec) DeepCopyInto(out *VirusScanTargetSpec)

DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.

type VirusScanTemplate 

type VirusScanTemplate struct {
	metav1.ObjectMeta `json:"metadata,omitempty"`
	Spec              VirusScanSpec `json:"spec,omitempty"`
}

func (*VirusScanTemplate) DeepCopy 

func (in *VirusScanTemplate) DeepCopy() *VirusScanTemplate

DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new VirusScanTemplate.

func (*VirusScanTemplate) DeepCopyInto 

func (in *VirusScanTemplate) DeepCopyInto(out *VirusScanTemplate)

DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.

Source Files

View all Source files

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL
go.dev uses cookies from Google to deliver and enhance the quality of its services and to analyze traffic. Learn more.