v1beta1

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

	Spec   BootModuleConfigSpec   `json:"spec,omitempty"`
	Status BootModuleConfigStatus `json:"status,omitempty"`
}

type BootModuleConfigList struct {
	metav1.TypeMeta `json:",inline"`
	metav1.ListMeta `json:"metadata,omitempty"`

	// List of BootModuleConfig. More info:
	// https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md
	Items []BootModuleConfig `json:"items"`
}

type BootModuleConfigSpec struct {
	// machine config that is targeted by the BMC
	MachineConfigName string `json:"machineConfigName"`

	// the machine config pool that is linked to the targeted machine config
	MachineConfigPoolName string `json:"machineConfigPoolName"`

	// kernel module container image that contains the kernel module .ko file
	KernelModuleImage string `json:"kernelModuleImage"`

	// the name of the kernel module to be loaded(the name of the .ko file without the .ko)
	KernelModuleName string `json:"kernelModuleName"`

	//+optional
	// the in-tree kernel module to remove prior to loading the OOT kernel module
	InTreeModuleToRemove string `json:"inTreeModuleToRemove,omitempty"`

	//+optional
	// path of the firmware files in the kernel module container image
	FirmwareFilesPath string `json:"firmwareFilesPath,omitempty"`

	//+optional
	// KMM worker image. if missing, the current worker image will be used
	WorkerImage string `json:"workerImage,omitempty"`
}

type BootModuleConfigStatus struct {
	//+optional
	ConfigStatus string `json:"configStatus,omitempty"`
}

type Build struct {
	// +optional
	// BuildArgs is an array of build variables that are provided to the image building backend.
	BuildArgs []BuildArg `json:"buildArgs"`

	// ConfigMap that holds Dockerfile contents
	DockerfileConfigMap *v1.LocalObjectReference `json:"dockerfileConfigMap"`

	// +optional
	// BaseImageRegistryTLS contains settings determining how to access registries of the base images in the build-process' Dockerfile.
	BaseImageRegistryTLS TLSOptions `json:"baseImageRegistryTLS,omitempty"`

	// +optional
	// Secrets is an optional list of secrets to be made available to the build system.
	// Those secrets should be used for private resources such as a private Github repo.
	// For container registries auth use module.spec.imagePullSecret instead.
	Secrets []v1.LocalObjectReference `json:"secrets"`

	// +optional
	// KanikoParams is used to customize the building process of the image.
	KanikoParams *KanikoParams `json:"kanikoParams,omitempty"`

	// +optional
	// Selector describes on which nodes will run the building process.
	Selector map[string]string `json:"selector,omitempty"`
}

type BuildArg struct {
	Name  string `json:"name"`
	Value string `json:"value"`
}

type BuildOrSignAction string

type BuildOrSignStatus string

type BuildSignImageState struct {
	Image string `json:"image"`

	// +kubebuilder:validation:Enum=Success;Failure
	Status BuildOrSignStatus `json:"status"`

	// +kubebuilder:validation:Enum=BuildImage;SignImage
	Action BuildOrSignAction `json:"action"`
}

type CRStatus = v1beta2.CRBaseStatus

type DaemonSetStatus struct {
	// number of nodes that are targeted by the module selector
	NodesMatchingSelectorNumber int32 `json:"nodesMatchingSelectorNumber,omitempty"`
	// number of the pods that should be deployed for daemonset
	DesiredNumber int32 `json:"desiredNumber,omitempty"`
	// number of the actually deployed and running pods
	AvailableNumber int32 `json:"availableNumber,omitempty"`
}

type DevicePluginContainerSpec struct {
	// Entrypoint array. Not executed within a shell.
	// The container image's ENTRYPOINT is used if this is not provided.
	// Variable references $(VAR_NAME) are expanded using the container's environment. If a variable
	// cannot be resolved, the reference in the input string will be unchanged. Double $$ are reduced
	// to a single $, which allows for escaping the $(VAR_NAME) syntax: i.e. "$$(VAR_NAME)" will
	// produce the string literal "$(VAR_NAME)". Escaped references will never be expanded, regardless
	// of whether the variable exists or not. Cannot be updated.
	// More info: https://kubernetes.io/docs/tasks/inject-data-application/define-command-argument-container/#running-a-command-in-a-shell
	// +optional
	Command []string `json:"command,omitempty" protobuf:"bytes,3,rep,name=command"`

	// Arguments to the entrypoint.
	// The container image's CMD is used if this is not provided.
	// Variable references $(VAR_NAME) are expanded using the container's environment. If a variable
	// cannot be resolved, the reference in the input string will be unchanged. Double $$ are reduced
	// to a single $, which allows for escaping the $(VAR_NAME) syntax: i.e. "$$(VAR_NAME)" will
	// produce the string literal "$(VAR_NAME)". Escaped references will never be expanded, regardless
	// of whether the variable exists or not. Cannot be updated.
	// More info: https://kubernetes.io/docs/tasks/inject-data-application/define-command-argument-container/#running-a-command-in-a-shell
	// +optional
	Args []string `json:"args,omitempty" protobuf:"bytes,4,rep,name=args"`

	// List of environment variables to set in the container.
	// Cannot be updated.
	// +optional
	// +patchMergeKey=name
	// +patchStrategy=merge
	Env []v1.EnvVar `json:"env,omitempty" patchStrategy:"merge" patchMergeKey:"name" protobuf:"bytes,7,rep,name=env"`

	// Image is the name of the container image that the device plugin container will run.
	Image string `json:"image"`

	// Image pull policy.
	// One of Always, Never, IfNotPresent.
	// Defaults to Always if :latest tag is specified, or IfNotPresent otherwise.
	// Cannot be updated.
	// More info: https://kubernetes.io/docs/concepts/containers/images#updating-images
	// +optional
	ImagePullPolicy v1.PullPolicy `json:"imagePullPolicy,omitempty" protobuf:"bytes,14,opt,name=imagePullPolicy,casttype=PullPolicy"`

	// Compute Resources required by this container.
	// Cannot be updated.
	// More info: https://kubernetes.io/docs/concepts/configuration/manage-resources-containers/
	// +optional
	Resources v1.ResourceRequirements `json:"resources,omitempty" protobuf:"bytes,8,opt,name=resources"`

	// VolumeMounts is a list of volume mounts that are appended to the default ones.
	// +optional
	VolumeMounts []v1.VolumeMount `json:"volumeMounts,omitempty"`
}

type DevicePluginSpec struct {
	Container DevicePluginContainerSpec `json:"container"`

	// +optional
	// InitContainer allows defines the init container that will be used by the device plugin
	InitContainer *DevicePluginContainerSpec `json:"initContainer,omitempty"`

	// +optional
	// ServiceAccountName is the name of the ServiceAccount to use to run this pod.
	// More info: https://kubernetes.io/docs/tasks/configure-pod-container/configure-service-account/
	ServiceAccountName string `json:"serviceAccountName,omitempty"`

	Volumes []v1.Volume `json:"volumes,omitempty"`
}

type ImageState string

type KanikoParams struct {
	// +optional
	// Kaniko image tag to use when creating the build Job
	Tag string `json:"tag,omitempty"`
}

type KernelMapping struct {

	// +optional
	// Build enables in-cluster builds for this mapping and allows overriding the Module's build settings.
	Build *Build `json:"build"`

	// +optional
	// Sign enables in-cluster signing for this mapping
	Sign *Sign `json:"sign,omitempty"`

	// ContainerImage is the name of the DriverContainer image that should be used to deploy the module.
	ContainerImage string `json:"containerImage"`

	// +optional
	// Literal defines a literal target kernel version to be matched exactly against node kernels.
	Literal string `json:"literal"`

	// +optional
	// RegistryTLS set the TLS configs for accessing the registry of the module-loader's image.
	RegistryTLS *TLSOptions `json:"registryTLS"`

	// +optional
	// Regexp is a regular expression to be match against node kernels.
	Regexp string `json:"regexp"`

	// Deprecated: please use InTreeModulesToRemove.
	// +optional
	// InTreeModuleToRemove specifies one in-tree kernel module that should be removed (if present)
	// before loading the kernel module from the ContainerImage
	InTreeModuleToRemove string `json:"inTreeModuleToRemove"`

	// +optional
	// InTreeModulesToRemove specifies any number of  in-tree kernel modules that should be removed (if present)
	// before loading the kernel module from the ContainerImage
	InTreeModulesToRemove []string `json:"inTreeModulesToRemove"`
}

type ModprobeArgs struct {
	// Load is an optional list of arguments to be used when loading the kernel module.
	// +kubebuilder:validation:MinItems=1
	Load []string `json:"load,omitempty"`

	// Unload is an optional list of arguments to be used when unloading the kernel module.
	// +kubebuilder:validation:MinItems=1
	Unload []string `json:"unload,omitempty"`
}

type ModprobeSpec struct {
	// ModuleName is the name of the Module to be loaded.
	// This field can only be unset if rawArgs is set.
	// +optional
	ModuleName string `json:"moduleName,omitempty"`

	// Parameters is an optional list of kernel module parameters to be provided to modprobe.
	// They should be in the form of key=value and will be separated by spaces in the modprobe command.
	// The resulting loading command will be: `modprobe module_name ${Parameters}`.
	Parameters []string `json:"parameters,omitempty"`

	// DirName is the root directory for modules.
	// It adds `-d ${DirName}` to the modprobe command-line.
	// +kubebuilder:default=/opt
	DirName string `json:"dirName,omitempty"`

	// Args is an optional list of arguments to be passed to modprobe before the name of the kernel module.
	// The resulting commands will be: `modprobe ${Args} module_name`.
	// +optional
	Args *ModprobeArgs `json:"args,omitempty"`

	// If RawArgs are specified, they are passed straight to the modprobe binary; all other properties in this
	// object are ignored.
	// The resulting commands will be: `modprobe ${RawArgs}`.
	// +optional
	RawArgs *ModprobeArgs `json:"rawArgs,omitempty"`

	// FirmwarePath is the path of the firmware(s).
	// The firmware(s) will be copied to the host for the kernel to find them.
	// +optional
	FirmwarePath string `json:"firmwarePath,omitempty"`

	// ModulesLoadingOrder defines the dependency between kernel modules loading, in case
	// it was not created by depmod (independent kernel modules).
	// The list order should be: upmost module, then the module it depends on and so on.
	// Example: if moduleA depends on first loading moduleB, and moduleB depends on first loading moduleC
	// the entry should look:
	// ModulesLoadingOrder:
	//    - moduleA
	//    - moduleB
	//    - moduleC
	// In order to load all 3 modules, moduleA shoud be defined in the ModuleName parameter of this struct
	// +optional
	ModulesLoadingOrder []string `json:"modulesLoadingOrder,omitempty"`
}

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

	Spec   ModuleSpec   `json:"spec,omitempty"`
	Status ModuleStatus `json:"status,omitempty"`
}

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

	Spec   ModuleBuildSignConfigSpec   `json:"spec,omitempty"`
	Status ModuleBuildSignConfigStatus `json:"status,omitempty"`
}

type ModuleBuildSignConfigList struct {
	metav1.TypeMeta `json:",inline"`
	metav1.ListMeta `json:"metadata,omitempty"`

	// List of ModuleBuildSignConfig. More info:
	// https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md
	Items []ModuleBuildSignConfig `json:"items"`
}

type ModuleBuildSignConfigSpec struct {
	Images []ModuleBuildSignSpec `json:"images"`

	// ImageRepoSecret contains pull secret for the image's repo, if needed
	// +optional
	ImageRepoSecret *v1.LocalObjectReference `json:"imageRepoSecret,omitempty"`

	// Boolean flag that determines whether images built must also
	// be pushed to a defined repository
	// +optional
	PushBuiltImage bool `json:"pushBuiltImage"`
}

type ModuleBuildSignConfigStatus struct {
	Images []BuildSignImageState `json:"images"`
}

type ModuleBuildSignSpec struct {
	ModuleImageSpec `json:",inline"`

	// +kubebuilder:validation:Enum=BuildImage;SignImage
	Action BuildOrSignAction `json:"action"`
}

type ModuleConfig struct {
	KernelVersion  string `json:"kernelVersion"`
	ContainerImage string `json:"containerImage"`
	// +kubebuilder:default=IfNotPresent
	//+optional
	ImagePullPolicy v1.PullPolicy `json:"imagePullPolicy"`
	// When InsecurePull is true, the container image can be pulled without TLS.
	InsecurePull bool `json:"insecurePull"`
	//+optional
	InTreeModulesToRemove []string `json:"inTreeModulesToRemove,omitempty"`
	//+optional
	InTreeModuleToRemove string       `json:"inTreeModuleToRemove,omitempty"`
	Modprobe             ModprobeSpec `json:"modprobe"`
}

type ModuleImageSpec struct {
	// image
	Image string `json:"image"`

	// kernel version for which this image is targeted
	KernelVersion string `json:"kernelVersion"`

	// Build contains build instructions, in case image needs building
	// +optional
	Build *Build `json:"build,omitempty"`

	// Sign contains sign instructions, in case image needs signing
	// +optional
	Sign *Sign `json:"sign,omitempty"`

	// SkipWaitMissingImage signals to MIC to stop waiting for image to be present
	// in case Build andSign not define, and report the image as DoesNotExist
	SkipWaitMissingImage bool `json:"skipWaitMissingImage,omitempty"`

	// +optional
	// RegistryTLS set the TLS configs for accessing the registry of the image.
	RegistryTLS *TLSOptions `json:"registryTLS,omitempty"`
}

type ModuleImageState struct {
	// image
	Image string `json:"image"`
	// status of the image
	// one of: Exists, notExists
	Status ImageState `json:"status"`
}

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

	Spec   ModuleImagesConfigSpec   `json:"spec,omitempty"`
	Status ModuleImagesConfigStatus `json:"status,omitempty"`
}

type ModuleImagesConfigList struct {
	metav1.TypeMeta `json:",inline"`
	metav1.ListMeta `json:"metadata,omitempty"`

	// List of ModuleImagesConfig. More info:
	// https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md
	Items []ModuleImagesConfig `json:"items"`
}

type ModuleImagesConfigSpec struct {
	Images []ModuleImageSpec `json:"images,omitempty"`

	// ImageRepoSecret contains pull secret for the image's repo, if needed
	// +optional
	ImageRepoSecret *v1.LocalObjectReference `json:"imageRepoSecret,omitempty"`

	// +kubebuilder:default=IfNotPresent
	// ImagePullPolicy defines the pull policy used for verifying the presence of the image
	//+optional
	ImagePullPolicy v1.PullPolicy `json:"imagePullPolicy"`

	// Boolean flag that determines whether images built must also
	// be pushed to a defined repository
	// +optional
	PushBuiltImage bool `json:"pushBuiltImage"`
}

type ModuleImagesConfigStatus struct {
	ImagesStates []ModuleImageState `json:"imagesStates"`
}

type ModuleItem struct {
	ImageRepoSecret    *v1.LocalObjectReference `json:"imageRepoSecret,omitempty"`
	Name               string                   `json:"name"`
	Namespace          string                   `json:"namespace"`
	ServiceAccountName string                   `json:"serviceAccountName"`
	//+optional
	// tolerations define which tolerations should be added for every load/unload pod running on the node
	Tolerations []v1.Toleration `json:"tolerations,omitempty"`
	//+optional
	// Version is the version of the kernel module that should be loaded
	Version string `json:"version,omitempty"`
}

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

type ModuleLoaderContainerSpec struct {
	// Build contains build instructions.
	// +optional
	Build *Build `json:"build,omitempty"`

	// +optional
	// Sign provides default kmod signing settings
	Sign *Sign `json:"sign,omitempty"`

	// Version defines the current version of the kernel module being used
	// Used for upgrading the currently loaded kernel module to a new version
	// +optional
	Version string `json:"version,omitempty"`

	// ContainerImage is a top-level field
	// +optional
	ContainerImage string `json:"containerImage,omitempty"`

	// Image pull policy.
	// One of Always, Never, IfNotPresent.
	// Defaults to Always if :latest tag is specified, or IfNotPresent otherwise.
	// Cannot be updated.
	// More info: https://kubernetes.io/docs/concepts/containers/images#updating-images
	// +optional
	ImagePullPolicy v1.PullPolicy `json:"imagePullPolicy,omitempty" protobuf:"bytes,14,opt,name=imagePullPolicy,casttype=PullPolicy"`

	// KernelMappings is a list of kernel mappings.
	// When a node's labels match Selector, then the KMM Operator will look for the first mapping that matches its
	// kernel version, and use the corresponding container image to run the DriverContainer.
	// +kubebuilder:validation:MinItems=1
	KernelMappings []KernelMapping `json:"kernelMappings"`

	// Modprobe is a set of properties to customize which module modprobe loads and with which properties.
	Modprobe ModprobeSpec `json:"modprobe"`

	// +optional
	// RegistryTLS set the TLS configs for accessing the registry of the module-loader's image.
	RegistryTLS TLSOptions `json:"registryTLS"`

	// Deprecated: please use InTreeModulesToRemove.
	// +optional
	// InTreeModuleToRemove specifies one in-tree kernel module that should be removed (if present)
	// before loading the kernel module from the ContainerImage
	InTreeModuleToRemove string `json:"inTreeModuleToRemove"`

	// +optional
	// InTreeModulesToRemove specifies any number of  in-tree kernel modules that should be removed (if present)
	// before loading the kernel module from the ContainerImage
	InTreeModulesToRemove []string `json:"inTreeModulesToRemove"`
}

type ModuleLoaderSpec struct {
	// Container holds the properties for the module loader container that runs modprobe.
	Container ModuleLoaderContainerSpec `json:"container"`

	// +optional
	// ServiceAccountName is the name of the ServiceAccount to use to run this pod.
	// More info: https://kubernetes.io/docs/tasks/configure-pod-container/configure-service-account/
	ServiceAccountName string `json:"serviceAccountName,omitempty"`
}

type ModuleSpec struct {
	// DevicePlugin allows overriding some properties of the container that deploys the device plugin on the node.
	// Name is ignored and is set automatically by the KMM Operator.
	// +optional
	DevicePlugin *DevicePluginSpec `json:"devicePlugin"`

	// ModuleLoader allows overriding some properties of the container that loads the kernel module on the node.
	// Name and image are ignored and are set automatically by the KMM Operator.
	// +optional
	ModuleLoader *ModuleLoaderSpec `json:"moduleLoader,omitempty"`

	// ImageRepoSecret is an optional secret that is used to pull both the module loader and the device plugin, and
	// to push the resulting image from the module loader build, if enabled.
	// +optional
	ImageRepoSecret *v1.LocalObjectReference `json:"imageRepoSecret,omitempty"`

	// Selector describes on which nodes the Module should be loaded and optionally built.
	Selector map[string]string `json:"selector"`

	// If specified, the pod's tolerations.
	// +optional
	Tolerations []v1.Toleration `json:"tolerations,omitempty"`
}

type ModuleStatus struct {
	// DevicePlugin contains the status of the Device Plugin daemonset
	// if it was deployed during reconciliation
	DevicePlugin DaemonSetStatus `json:"devicePlugin,omitempty"`
	// ModuleLoader contains the status of the ModuleLoader daemonset
	ModuleLoader DaemonSetStatus `json:"moduleLoader,omitempty"`
}

type NodeModuleSpec struct {
	ModuleItem `json:",inline"`

	Config ModuleConfig `json:"config"`
}

type NodeModuleStatus struct {
	ModuleItem `json:",inline"`

	//+optional
	Config ModuleConfig `json:"config,omitempty"`
	//+optional
	BootId string `json:"bootId,omitempty"`
}

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

	Spec   NodeModulesConfigSpec   `json:"spec,omitempty"`
	Status NodeModulesConfigStatus `json:"status,omitempty"`
}

type NodeModulesConfigList struct {
	metav1.TypeMeta `json:",inline"`
	metav1.ListMeta `json:"metadata,omitempty"`

	// List of NodeModulesConfig. More info:
	// https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md
	Items []NodeModulesConfig `json:"items"`
}

type NodeModulesConfigSpec struct {
	// Modules list the spec of all the modules that need to be executed
	// on the node
	Modules []NodeModuleSpec `json:"modules,omitempty" patchStrategy:"merge" patchMergeKey:"type"`
}

type NodeModulesConfigStatus struct {
	// Modules contain observations about each Module's node state status
	// +patchMergeKey=type
	// +patchStrategy=merge
	// +optional
	Modules []NodeModuleStatus `json:"modules,omitempty" patchStrategy:"merge" patchMergeKey:"type"`
}

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

	Spec   PreflightValidationSpec   `json:"spec,omitempty"`
	Status PreflightValidationStatus `json:"status,omitempty"`
}

type PreflightValidationList struct {
	metav1.TypeMeta `json:",inline"`
	metav1.ListMeta `json:"metadata,omitempty"`

	// List of PreflightValidation. More info:
	// https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md
	Items []PreflightValidation `json:"items"`
}

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

	Spec   v1beta2.PreflightValidationOCPSpec `json:"spec,omitempty"`
	Status PreflightValidationStatus          `json:"status,omitempty"`
}

type PreflightValidationOCPList struct {
	metav1.TypeMeta `json:",inline"`
	metav1.ListMeta `json:"metadata,omitempty"`

	// List of PreflightValidation. More info:
	// https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md
	Items []PreflightValidationOCP `json:"items"`
}

type PreflightValidationOCPSpec = v1beta2.PreflightValidationOCPSpec

type PreflightValidationSpec = v1beta2.PreflightValidationSpec

type PreflightValidationStatus struct {
	// CRStatuses contain observations about each Module's preflight upgradability validation
	// +patchMergeKey=type
	// +patchStrategy=merge
	// +optional
	CRStatuses map[string]*CRStatus `json:"crStatuses,omitempty" patchStrategy:"merge" patchMergeKey:"type"`
}

type Sign struct {
	// +optional
	// Image to sign, ignored if a Build is present, required otherwise
	UnsignedImage string `json:"unsignedImage,omitempty"`

	// +optional
	// UnsignedImageRegistryTLS contains settings determining how to access registries of the unsigned image.
	UnsignedImageRegistryTLS TLSOptions `json:"unsignedImageRegistryTLS,omitempty"`

	// a secret containing the private key used to sign kernel modules for secureboot
	KeySecret *v1.LocalObjectReference `json:"keySecret"`

	// a secret containing the public key used to sign kernel modules for secureboot
	CertSecret *v1.LocalObjectReference `json:"certSecret"`

	// +optional
	// paths inside the image for the kernel modules to sign (if ommited all kmods are signed)
	FilesToSign []string `json:"filesToSign,omitempty"`
}

type TLSOptions struct {

	// +optional
	// If Insecure is true, the operator will be able to access a registry in an insecure (plain HTTP) protocol.
	Insecure bool `json:"insecure,omitempty"`

	// +optional
	// If InsecureSkipTLSVerify, the operator will accept any certificate provided by the registry.
	InsecureSkipTLSVerify bool `json:"insecureSkipTLSVerify,omitempty"`
}