v1alpha8

type CommandVariablesSpec struct {
	// Indexed determines whether to use the same value for each allocation, or to use
	// a different value based on the index of the allocation.
	Indexed bool `json:"indexed,omitempty"`

	// Name of the variable
	Name string `json:"name,omitempty"`

	// Value for the variable
	Value string `json:"value,omitempty"`

	// IndexedValues is a list of strings values for the variable. The list length should
	// be the same as the allocation count in the NnfNodeStorageSpec.
	IndexedValues []string `json:"indexedValues,omitempty"`
}

type LustreStorageSpec struct {
	// FileSystemName is the fsname parameter for the Lustre filesystem.
	// +kubebuilder:validation:MaxLength:=8
	FileSystemName string `json:"fileSystemName,omitempty"`

	// TargetType is the type of Lustre target to be created.
	// +kubebuilder:validation:Enum=mgt;mdt;mgtmdt;ost
	TargetType string `json:"targetType,omitempty"`

	// StartIndex is used to order a series of MDTs or OSTs.  This is used only
	// when creating MDT and OST targets. If count in the NnfNodeStorageSpec is more
	// than 1, then StartIndex is the index of the first allocation, and the indexes
	// increment from there.
	// +kubebuilder:validation:Minimum:=0
	StartIndex int `json:"startIndex,omitempty"`

	// MgsAddress is the NID of the MGS to use. This is used only when
	// creating MDT and OST targets.
	MgsAddress string `json:"mgsAddress,omitempty"`

	// BackFs is the type of backing filesystem to use.
	// +kubebuilder:validation:Enum=ldiskfs;zfs
	BackFs string `json:"backFs,omitempty"`

	// LustreComponents defines that list of NNF Nodes that are used for the components (e.g. OSTs)
	// in the lustre filesystem. This information is helpful when creating the lustre filesystem and
	// using PostMount commands (e.g. to set the striping).
	LustreComponents NnfStorageLustreComponents `json:"lustreComponents,omitempty"`
}

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

	Spec   NnfAccessSpec   `json:"spec,omitempty"`
	Status NnfAccessStatus `json:"status,omitempty"`
}

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

type NnfAccessSpec struct {
	// DesiredState is the desired state for the mounts on the client
	// +kubebuilder:validation:Enum=mounted;unmounted
	DesiredState string `json:"desiredState"`

	// TeardownState is the desired state of the workflow for this NNF Access resource to
	// be torn down and deleted.
	// +kubebuilder:validation:Enum:=PreRun;PostRun;Teardown
	// +kubebuilder:validation:Type:=string
	TeardownState dwsv1alpha6.WorkflowState `json:"teardownState"`

	// Target specifies which storage targets the client should mount
	// - single: Only one of the storage the client can access
	// - all: All of the storage the client can access
	// - shared: Multiple clients access the same storage
	// +kubebuilder:validation:Enum=single;all;shared
	Target string `json:"target"`

	// UserID for the new mount. Currently only used for raw
	UserID uint32 `json:"userID"`

	// GroupID for the new mount. Currently only used for raw
	GroupID uint32 `json:"groupID"`

	// ClientReference is for a client resource. (DWS) Computes is the only client
	// resource type currently supported
	ClientReference corev1.ObjectReference `json:"clientReference,omitempty"`

	// MountPath for the storage target on the client
	MountPath string `json:"mountPath,omitempty"`

	// MakeClientMounts determines whether the ClientMount resources are made, or if only
	// the access list on the NnfNodeBlockStorage is updated
	// +kubebuilder:default=true
	MakeClientMounts bool `json:"makeClientMounts"`

	MountPathPrefix string `json:"mountPathPrefix,omitempty"`

	// StorageReference is the NnfStorage reference
	StorageReference corev1.ObjectReference `json:"storageReference"`

	// +kubebuilder:default=false
	IgnoreOfflineComputes bool `json:"ignoreOfflineComputes"`
}

type NnfAccessStatus struct {
	// State is the current state
	// +kubebuilder:validation:Enum=mounted;unmounted
	State string `json:"state"`

	// Ready signifies whether status.state has been achieved
	Ready bool `json:"ready"`

	dwsv1alpha6.ResourceError `json:",inline"`
}

type NnfContainer struct {
	// Name of the container specified as a DNS_LABEL. Each container in a pod must have a unique
	// name (DNS_LABEL).
	// +kubebuilder:validation:Pattern="^[a-z0-9]([-a-z0-9]*[a-z0-9])?$"
	// +kubebuilder:validation:MaxLength=253
	// +kubebuilder:validation:MinLength=1
	// +kubebuilder:validation:Required
	Name string `json:"name"`

	// Container image name. More info: https://kubernetes.io/docs/concepts/containers/images
	// +kubebuilder:validation:MaxLength=253
	// +kubebuilder:validation:MinLength=1
	// +kubebuilder:validation:Required
	Image string `json:"image"`

	// 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.
	// More info:
	// https://kubernetes.io/docs/tasks/inject-data-application/define-command-argument-container/#running-a-command-in-a-shell
	// +kubebuilder:validation:Optional
	Command []string `json:"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. More info:
	// https://kubernetes.io/docs/tasks/inject-data-application/define-command-argument-container/#running-a-command-in-a-shell
	Args []string `json:"args,omitempty"`

	// List of environment variables to set in the container.
	Env []corev1.EnvVar `json:"env,omitempty"`

	// List of sources to populate environment variables in the container. The keys defined within a
	// source must be a C_IDENTIFIER. All invalid keys will be reported as an event when the
	// container is starting. When a key exists in multiple sources, the value associated with the
	// last source will take precedence. Values defined by an Env with a duplicate key will take
	// precedence.
	EnvFrom []corev1.EnvFromSource `json:"envFrom,omitempty"`

	// Pod volumes to mount into the container's filesystem. NNF Volumes will be patched in from the
	// Storages field.
	VolumeMounts []corev1.VolumeMount `json:"volumeMounts,omitempty"`

	// Container's working directory.
	// +kubebuilder:validation:MaxLength=253
	WorkingDir string `json:"workingDir,omitempty"`

	// RestartPolicy defines the restart behavior of individual containers in a pod. This field may
	// only be set for init containers, and the only allowed value is "Always". For non-init
	// containers or when this field is not specified, the restart behavior is defined by the Pod's
	// restart policy and the container type.
	RestartPolicy *corev1.ContainerRestartPolicy `json:"restartPolicy,omitempty"`

	// Periodic probe of container liveness.
	// Container will be restarted if the probe fails.
	LivenessProbe *corev1.Probe `json:"livenessProbe,omitempty"`

	// Periodic probe of container service readiness.
	// Container will be removed from service endpoints if the probe fails.
	ReadinessProbe *corev1.Probe `json:"readinessProbe,omitempty"`

	// StartupProbe indicates that the Pod has successfully initialized.
	// If specified, no other probes are executed until this completes successfully.
	// If this probe fails, the Pod will be restarted, just as if the livenessProbe failed.
	// This can be used to provide different probe parameters at the beginning of a Pod's lifecycle,
	// when it might take a long time to load data or warm a cache, than during steady-state operation.
	StartupProbe *corev1.Probe `json:"startupProbe,omitempty"`

	// Path at which the file to which the container's termination message
	// will be written is mounted into the container's filesystem.
	// Message written is intended to be brief final status, such as an assertion failure message.
	// Will be truncated by the node if greater than 4096 bytes. The total message length across
	// all containers will be limited to 12kb.
	// Defaults to /dev/termination-log.
	TerminationMessagePath string `json:"terminationMessagePath,omitempty"`

	// Indicate how the termination message should be populated. File will use the contents of
	// terminationMessagePath to populate the container status message on both success and failure.
	// FallbackToLogsOnError will use the last chunk of container log output if the termination
	// message file is empty and the container exited with an error.
	// The log output is limited to 2048 bytes or 80 lines, whichever is smaller.
	// Defaults to File.
	TerminationMessagePolicy corev1.TerminationMessagePolicy `json:"terminationMessagePolicy,omitempty"`

	// Image pull policy for the container.  One of Always, Never, IfNotPresent. Set this to Always
	// if :latest tag is specified in the image field.
	// Defaults to IfNotPresent
	// +kubebuilder:validation:Enum=Always;Never;IfNotPresent
	// +kubebuilder:default:=IfNotPresent
	ImagePullPolicy corev1.PullPolicy `json:"imagePullPolicy,omitempty"`
}

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

	Data NnfContainerProfileData `json:"data"`
}

type NnfContainerProfileData struct {
	// Pinned is true if this instance is an immutable copy
	// +kubebuilder:default:=false
	Pinned bool `json:"pinned,omitempty"`

	// List of possible filesystems supported by this container profile
	Storages []NnfContainerProfileStorage `json:"storages,omitempty"`

	// Containers are launched in the PreRun state. Allow this many seconds for the containers to
	// start before declaring an error to the workflow.
	// Defaults to 300 if not set. A value of 0 disables this behavior.
	// +kubebuilder:default:=300
	// +kubebuilder:validation:Minimum:=0
	PreRunTimeoutSeconds *int64 `json:"preRunTimeoutSeconds,omitempty"`

	// Containers are expected to complete in the PostRun State. Allow this many seconds for the
	// containers to exit before declaring an error the workflow.
	// Defaults to 300 if not set. A value of 0 disables this behavior.
	// +kubebuilder:default:=300
	// +kubebuilder:validation:Minimum:=0
	PostRunTimeoutSeconds *int64 `json:"postRunTimeoutSeconds,omitempty"`

	// Specifies the number of times a container will be retried upon a failure. A new pod is
	// deployed on each retry. Defaults to 6 by kubernetes itself and must be set. A value of 0
	// disables retries.
	// +kubebuilder:validation:Minimum:=0
	// +kubebuilder:default:=6
	RetryLimit int32 `json:"retryLimit"`

	// UserID specifies the user ID that is allowed to use this profile. If this is specified, only
	// Workflows that have a matching user ID can select this profile.
	UserID *uint32 `json:"userID,omitempty"`

	// GroupID specifies the group ID that is allowed to use this profile. If this is specified,
	// only Workflows that have a matching group ID can select this profile.
	GroupID *uint32 `json:"groupID,omitempty"`

	// Number of ports to open for each container specified in the PodSpec. For MPI Jobs, this is
	// only for the Launcher container(s) listed in the MPIReplicaSet's PodSpec. These ports are
	// opened on the targeted NNF nodes and can be accessed outside the k8s cluster (e.g. compute
	// nodes). The requested ports are made available as environment variables inside the container
	// and in the DWS workflow (NNF_CONTAINER_PORTS).
	NumPorts int32 `json:"numPorts,omitempty"`

	// NnfSpec to define the containers created from this profile. This is used for non-MPI containers.
	// Either this or NnfMPISpec must be provided, but not both.
	// +kubebuilder:validation:Rule="(self.spec != null) != (self.mpiSpec != null)",Message="Exactly one of 'spec' or 'mpiSpec' must be set."
	NnfSpec *NnfPodSpec `json:"spec,omitempty"`

	// MPIJobSpec to define the MPI containers created from this profile.
	// Either this or NnfSpec must be provided, but not both.
	// +kubebuilder:validation:Rule="(self.spec != null) != (self.mpiSpec != null)",Message="Exactly one of 'spec' or 'mpiSpec' must be set."
	NnfMPISpec *NnfMPISpec `json:"mpiSpec,omitempty"`
}

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

type NnfContainerProfileStorage struct {
	// Name specifies the name of the mounted filesystem; must match the user supplied #DW directive
	Name string `json:"name"`

	// Optional designates that this filesystem is available to be mounted, but can be ignored by
	// the user not supplying this filesystem in the #DW directives
	//+kubebuilder:default:=false
	Optional bool `json:"optional"`

	// For DW_GLOBAL_ (global lustre) storages, the access mode must match what is configured in
	// the LustreFilesystem resource for the namespace. Defaults to `ReadWriteMany` for global
	// lustre, otherwise empty.
	PVCMode corev1.PersistentVolumeAccessMode `json:"pvcMode,omitempty"`
}

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

	Spec   NnfDataMovementSpec   `json:"spec,omitempty"`
	Status NnfDataMovementStatus `json:"status,omitempty"`
}

type NnfDataMovementCommandStatus struct {
	// The command that was executed during data movement.
	Command string `json:"command,omitempty"`

	// ElapsedTime reflects the elapsed time since the underlying data movement command started.
	ElapsedTime metav1.Duration `json:"elapsedTime,omitempty"`

	// ProgressPercentage refects the progress of the underlying data movement command as captured from
	// standard output.  A best effort is made to parse the command output as a percentage. If no
	// progress has yet to be measured than this field is omitted. If the latest command output does
	// not contain a valid percentage, then the value is unchanged from the previously parsed value.
	ProgressPercentage *int32 `json:"progress,omitempty"`

	// LastMessage reflects the last message received over standard output or standard error as
	// captured by the underlying data movement command.
	LastMessage string `json:"lastMessage,omitempty"`

	// LastMessageTime reflects the time at which the last message was received over standard output
	// or standard error by the underlying data movement command.
	LastMessageTime metav1.MicroTime `json:"lastMessageTime,omitempty"`

	// Seconds is parsed from the dcp output when the command is finished.
	Seconds string `json:"seconds,omitempty"`

	// Items is parsed from the dcp output when the command is finished. This is a total of
	// the number of directories, files, and links that dcp copied.
	Items *int32 `json:"items,omitempty"`

	// Directories is parsed from the dcp output when the command is finished. This is the number of
	// directories that dcp copied. Note: This value may be inflated due to NNF index mount
	// directories when copying from XFS or GFS2 filesystems.
	Directories *int32 `json:"directories,omitempty"`

	// Files is parsed from the dcp output when the command is finished. This is the number of files
	// that dcp copied.
	Files *int32 `json:"files,omitempty"`

	// Links is parsed from the dcp output when the command is finished. This is the number of links
	// that dcp copied.
	Links *int32 `json:"links,omitempty"`

	// Data is parsed from the dcp output when the command is finished. This is the total amount of
	// data copied by dcp.
	Data string `json:"data,omitempty"`

	// Rate is parsed from the dcp output when the command is finished. This is transfer rate of the
	// data copied by dcp.
	Rate string `json:"rate,omitempty"`
}

type NnfDataMovementConfig struct {

	// Fake the Data Movement operation. The system "performs" Data Movement but the command to do so
	// is trivial. This means a Data Movement request is still submitted but the IO is skipped.
	// +kubebuilder:default:=false
	Dryrun bool `json:"dryrun,omitempty"`

	// Extra options to pass to the mpirun command (used to perform data movement).
	MpirunOptions string `json:"mpirunOptions,omitempty"`

	// Extra options to pass to the dcp command (used to perform data movement).
	DcpOptions string `json:"dcpOptions,omitempty"`

	// If true, enable the command's stdout to be saved in the log when the command completes
	// successfully. On failure, the output is always logged.
	// Note: Enabling this option may degrade performance.
	// +kubebuilder:default:=false
	LogStdout bool `json:"logStdout,omitempty"`

	// Similar to LogStdout, store the command's stdout in Status.Message when the command completes
	// successfully. On failure, the output is always stored.
	// Note: Enabling this option may degrade performance.
	// +kubebuilder:default:=false
	StoreStdout bool `json:"storeStdout,omitempty"`

	// The number of slots specified in the MPI hostfile. A value of 0 disables the use of slots in
	// the hostfile. Nil will defer to the value specified in the NnfDataMovementProfile.
	Slots *int `json:"slots,omitempty"`

	// The number of max_slots specified in the MPI hostfile. A value of 0 disables the use of slots
	// in the hostfile. Nil will defer to the value specified in the NnfDataMovementProfile.
	MaxSlots *int `json:"maxSlots,omitempty"`
}

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

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

	Spec   NnfDataMovementManagerSpec   `json:"spec,omitempty"`
	Status NnfDataMovementManagerStatus `json:"status,omitempty"`
}

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

type NnfDataMovementManagerSpec struct {

	// Selector defines the pod selector used in scheduling the worker nodes. This value is duplicated
	// to the template.spec.metadata.labels to satisfy the requirements of the worker's Daemon Set.
	Selector metav1.LabelSelector `json:"selector"`

	// Spec defines the slim PodSpec that is used for the basis of the worker Daemon Set that
	// manages the per node data movement operations.
	PodSpec NnfPodSpec `json:"podSpec"`

	// UpdateStrategy defines the UpdateStrategy that is used for the basis of the worker Daemon Set
	// that manages the per node data movement operations.
	UpdateStrategy appsv1.DaemonSetUpdateStrategy `json:"updateStrategy"`

	// Host Path defines the directory location of shared mounts on an individual worker node.
	HostPath string `json:"hostPath"`

	// Mount Path defines the location within the container at which the Host Path volume should be mounted.
	MountPath string `json:"mountPath"`
}

type NnfDataMovementManagerStatus struct {

	// Ready indicates that the Data Movement Manager has achieved the desired readiness state
	// and all managed resources are initialized.
	// +kubebuilder:default:=false
	Ready bool `json:"ready"`
}

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

	Data NnfDataMovementProfileData `json:"data,omitempty"`
}

type NnfDataMovementProfileData struct {

	// Default is true if this instance is the default resource to use
	// +kubebuilder:default:=false
	Default bool `json:"default,omitempty"`

	// Pinned is true if this instance is an immutable copy
	// +kubebuilder:default:=false
	Pinned bool `json:"pinned,omitempty"`

	// Slots is the number of slots specified in the MPI hostfile. A value of 0 disables the use of
	// slots in the hostfile. The hostfile is used for both `statCommand` and `Command`.
	// +kubebuilder:default:=8
	// +kubebuilder:validation:Minimum:=0
	Slots int `json:"slots"`

	// MaxSlots is the number of max_slots specified in the MPI hostfile. A value of 0 disables the
	// use of max_slots in the hostfile. The hostfile is used for both `statCommand` and `Command`.
	// +kubebuilder:default:=0
	// +kubebuilder:validation:Minimum:=0
	MaxSlots int `json:"maxSlots"`

	// Command to execute to perform data movement. $VARS are replaced by the nnf software and must
	// be present in the command.
	// Available $VARS:
	//   HOSTFILE: hostfile that is created and used for mpirun. Contains a list of hosts and the
	//             slots/max_slots for each host. This hostfile is created at `/tmp/<dm-name>/hostfile`
	//   UID: User ID that is inherited from the Workflow
	//   GID: Group ID that is inherited from the Workflow
	//   SRC: source for the data movement
	//   DEST destination for the data movement
	// +kubebuilder:default:="ulimit -n 2048 && mpirun --allow-run-as-root --hostfile $HOSTFILE dcp --progress 1 --uid $UID --gid $GID $SRC $DEST"
	// +kubebuilder:validation:XValidation:rule=`!self.contains("dcp") || (self.contains("$HOSTFILE") && self.contains("$UID") && self.contains("$GID") && self.contains("$SRC") && self.contains("$DEST"))`
	Command string `json:"command"`

	// If true, enable the command's stdout to be saved in the log when the command completes
	// successfully. On failure, the output is always logged.
	// +kubebuilder:default:=false
	LogStdout bool `json:"logStdout,omitempty"`

	// Similar to logStdout, store the command's stdout in Status.Message when the command completes
	// successfully. On failure, the output is always stored.
	// +kubebuilder:default:=false
	StoreStdout bool `json:"storeStdout,omitempty"`

	// NnfDataMovement resources have the ability to collect and store the progress percentage and the
	// last few lines of output in the CommandStatus field. This number is used for the interval to collect
	// the progress data. `dcp --progress N` must be included in the data movement command in order for
	// progress to be collected. A value of 0 disables this functionality.
	// +kubebuilder:default:=5
	// +kubebuilder:validation:Minimum:=0
	ProgressIntervalSeconds int `json:"progressIntervalSeconds,omitempty"`

	// CreateDestDir will ensure that the destination directory exists before performing data
	// movement. This will cause a number of stat commands to determine the source and destination
	// file types, so that the correct pathing for the destination can be determined. Then, a mkdir
	// is issued.
	// +kubebuilder:default:=true
	CreateDestDir bool `json:"createDestDir"`

	// If CreateDestDir is true, then use StatCommand to perform the stat commands.
	// Use setpriv to execute with the specified UID/GID.
	// Available $VARS:
	//   HOSTFILE: Hostfile that is created and used for mpirun. Contains a list of hosts and the
	//             slots/max_slots for each host. This hostfile is created at
	//             `/tmp/<dm-name>/hostfile`. This is the same hostfile used as the one for Command.
	//   SETPRIV: Placeholder for where to inject the SETPRIV command to become the UID/GID
	//   		  inherited from the workflow.
	//   PATH: Path to stat
	// +kubebuilder:default:="mpirun --allow-run-as-root -np 1 --hostfile $HOSTFILE -- $SETPRIV stat --cached never -c '%F' $PATH"
	// +kubebuilder:validation:XValidation:rule=`!self.contains("stat") || (self.contains("$HOSTFILE") && self.contains("$SETPRIV") && self.contains("$PATH"))`
	StatCommand string `json:"statCommand"`

	// If CreateDestDir is true, then use MkdirCommand to perform the mkdir commands.
	// Use setpriv to execute with the specified UID/GID.
	// Available $VARS:
	//   HOSTFILE: Hostfile that is created and used for mpirun. Contains a list of hosts and the
	//             slots/max_slots for each host. This hostfile is created at
	//             `/tmp/<dm-name>/hostfile`. This is the same hostfile used as the one for Command.
	//   SETPRIV: Placeholder for where to inject the SETPRIV command to become the UID/GID
	//   		  inherited from the workflow.
	//   PATH: Path to stat
	// +kubebuilder:default:="mpirun --allow-run-as-root -np 1 --hostfile $HOSTFILE -- $SETPRIV mkdir -p $PATH"
	// +kubebuilder:validation:XValidation:rule=`!self.contains("mkdir") || (self.contains("$HOSTFILE") && self.contains("$SETPRIV") && self.contains("$PATH"))`
	MkdirCommand string `json:"mkdirCommand"`

	// The full setpriv command that is used to become the user and group specified in the workflow.
	// This is used by the StatCommand and MkdirCommand.
	// Available $VARS:
	//   UID: User ID that is inherited from the Workflow
	//   GID: Group ID that is inherited from the Workflow
	// +kubebuilder:default:="setpriv --euid $UID --egid $GID --clear-groups"
	// +kubebuilder:validation:XValidation:rule=`!self.contains("setpriv") || (self.contains("$UID") && self.contains("$GID"))`
	SetprivCommand string `json:"setprivCommand"`
}

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

type NnfDataMovementSpec struct {

	// Source describes the source of the data movement operation
	Source *NnfDataMovementSpecSourceDestination `json:"source,omitempty"`

	// Destination describes the destination of the data movement operation
	Destination *NnfDataMovementSpecSourceDestination `json:"destination,omitempty"`

	// User Id specifies the user ID for the data movement operation. This value is used
	// in conjunction with the group ID to ensure the user has valid permissions to perform
	// the data movement operation.
	UserId uint32 `json:"userId,omitempty"`

	// Group Id specifies the group ID for the data movement operation. This value is used
	// in conjunction with the user ID to ensure the user has valid permissions to perform
	// the data movement operation.
	GroupId uint32 `json:"groupId,omitempty"`

	// Set to true if the data movement operation should be canceled.
	// +kubebuilder:default:=false
	Cancel bool `json:"cancel,omitempty"`

	// ProfileReference is an object reference to an NnfDataMovementProfile that is used to
	// configure data movement. If empty, the default profile is used.
	ProfileReference corev1.ObjectReference `json:"profileReference,omitempty"`

	// User defined configuration on how data movement should be performed. This overrides the
	// configuration defined in the supplied ProfileReference/NnfDataMovementProfile. These values
	// are typically set by the Copy Offload API.
	UserConfig *NnfDataMovementConfig `json:"userConfig,omitempty"`
}

type NnfDataMovementSpecSourceDestination struct {

	// Path describes the location of the user data relative to the storage instance
	Path string `json:"path,omitempty"`

	// Storage describes the storage backing this data movement specification; Storage can reference
	// either NNF storage or global Lustre storage depending on the object references Kind field.
	StorageReference corev1.ObjectReference `json:"storageReference,omitempty"`
}

type NnfDataMovementStatus struct {
	// Current state of data movement.
	// +kubebuilder:validation:Enum=Starting;Running;Finished
	State string `json:"state,omitempty"`

	// Status of the current state.
	// +kubebuilder:validation:Enum=Success;Failed;Invalid;Cancelled
	Status string `json:"status,omitempty"`

	// Message contains any text that explains the Status. If Data Movement failed or storeStdout is
	// enabled, this will contain the command's output.
	Message string `json:"message,omitempty"`

	// StartTime reflects the time at which the Data Movement operation started.
	StartTime *metav1.MicroTime `json:"startTime,omitempty"`

	// EndTime reflects the time at which the Data Movement operation ended.
	EndTime *metav1.MicroTime `json:"endTime,omitempty"`

	// Restarts contains the number of restarts of the Data Movement operation.
	Restarts int `json:"restarts,omitempty"`

	// CommandStatus reflects the current status of the underlying Data Movement command
	// as it executes. The command status is polled at a certain frequency to avoid excessive
	// updates to the Data Movement resource.
	CommandStatus *NnfDataMovementCommandStatus `json:"commandStatus,omitempty"`

	dwsv1alpha6.ResourceError `json:",inline"`
}

type NnfDriveStatus struct {
	// Model is the manufacturer information about the device
	Model string `json:"model,omitempty"`

	// The serial number for this storage controller.
	SerialNumber string `json:"serialNumber,omitempty"`

	// The firmware version of this storage controller.
	FirmwareVersion string `json:"firmwareVersion,omitempty"`

	// Physical slot location of the storage controller.
	Slot string `json:"slot,omitempty"`

	// Capacity in bytes of the device. The full capacity may not
	// be usable depending on what the storage driver can provide.
	Capacity int64 `json:"capacity,omitempty"`

	// WearLevel in percent for SSDs
	WearLevel int64 `json:"wearLevel,omitempty"`

	NnfResourceStatus `json:",inline"`
}

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

	Spec   NnfLustreMGTSpec   `json:"spec,omitempty"`
	Status NnfLustreMGTStatus `json:"status,omitempty"`
}

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

type NnfLustreMGTSpec struct {
	// Addresses is the list of LNet addresses for the MGT
	Addresses []string `json:"addresses"`

	// FsNameBlackList is a list of fsnames that can't be used. This may be
	// necessary if the MGT hosts file systems external to Rabbit
	FsNameBlackList []string `json:"fsNameBlackList,omitempty"`

	// FsNameStart is the starting fsname to be used
	// +kubebuilder:validation:MaxLength:=8
	// +kubebuilder:validation:MinLength:=8
	FsNameStart string `json:"fsNameStart,omitempty"`

	// FsNameStartReference can be used to add a configmap where the starting fsname is
	// stored. If this reference is set, it takes precendence over FsNameStart. The configmap
	// will be updated with the next available fsname anytime an fsname is used.
	FsNameStartReference corev1.ObjectReference `json:"fsNameStartReference,omitempty"`

	// ClaimList is the list of currently in use fsnames
	ClaimList []corev1.ObjectReference `json:"claimList,omitempty"`

	// CommandList is the list of commands requested to run on the MGT
	CommandList []NnfLustreMGTSpecCommand `json:"commandList,omitempty"`
}

type NnfLustreMGTSpecCommand struct {
	// Reference is an ObjectReference of the NnfStorage requesting the commands
	Reference corev1.ObjectReference `json:"reference,omitempty"`

	// Commands is the list of commands to run
	Commands []string `json:"commands,omitempty"`
}

type NnfLustreMGTStatus struct {
	// FsNameNext is the next available fsname that hasn't been used
	// +kubebuilder:validation:MaxLength:=8
	// +kubebuilder:validation:MinLength:=8
	FsNameNext string `json:"fsNameNext,omitempty"`

	// ClaimList is the list of currently in use fsnames
	ClaimList []NnfLustreMGTStatusClaim `json:"claimList,omitempty"`

	// CommandList is the status of commands requested to run on the MGT
	CommandList []NnfLustreMGTStatusCommand `json:"commandList,omitempty"`

	dwsv1alpha6.ResourceError `json:",inline"`
}

type NnfLustreMGTStatusClaim struct {
	Reference corev1.ObjectReference `json:"reference,omitempty"`
	FsName    string                 `json:"fsname,omitempty"`
}

type NnfLustreMGTStatusCommand struct {
	// Reference is an ObjectReference of the NnfStorage requesting the commands
	Reference corev1.ObjectReference `json:"reference,omitempty"`

	// Ready is true when all commands have been run successfully
	Ready bool `json:"ready"`

	// Error information
	dwsv1alpha6.ResourceError `json:",inline"`
}

type NnfMPISpec struct {

	// Launcher is the specification for the launcher container in the MPI job. In a typical MPI
	// job, the launcher runs an MPI application with mpirun and contacts the workers to distribute
	// the job.
	Launcher NnfPodSpec `json:"launcher"`

	// Worker is the specification for the worker containers in the MPI job. In a typical MPI job,
	// the workers are running sshd and listening for the launcher to connect.
	Worker NnfPodSpec `json:"worker"`

	// CopyOffload indicates that this profile is configured to drive the NNF Copy Offload API. This
	// instructions the NNF software to configure specifies for the Copy Offload API (e.g.
	// serviceAccount).
	// +kubebuilder:default:=false
	CopyOffload bool `json:"copyOffload,omitempty"`

	// Specifies the number of slots per worker used in hostfile.
	// Note: This is only for container directives that do not use Copy Offload. For Copy Offload
	// API, the slots field in the specific Data Movement profile will be used instead of this
	// value.
	SlotsPerWorker *int32 `json:"slotsPerWorker,omitempty"`
}

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

	Spec   NnfNodeSpec   `json:"spec,omitempty"`
	Status NnfNodeStatus `json:"status,omitempty"`
}

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

	Spec   NnfNodeBlockStorageSpec   `json:"spec,omitempty"`
	Status NnfNodeBlockStorageStatus `json:"status,omitempty"`
}

type NnfNodeBlockStorageAccessStatus struct {
	// /dev paths for each of the block devices
	DevicePaths []string `json:"devicePaths,omitempty"`

	// Redfish ID for the storage group
	StorageGroupId string `json:"storageGroupId,omitempty"`
}

type NnfNodeBlockStorageAllocationSpec struct {
	// Aggregate capacity of the block devices for each allocation
	Capacity int64 `json:"capacity,omitempty"`

	// List of nodes where /dev devices should be created
	Access []string `json:"access,omitempty"`
}

type NnfNodeBlockStorageAllocationStatus struct {
	// Accesses is a map of node name to the access status
	Accesses map[string]NnfNodeBlockStorageAccessStatus `json:"accesses,omitempty"`

	// List of NVMe namespaces used by this allocation
	Devices []NnfNodeBlockStorageDeviceStatus `json:"devices,omitempty"`

	// Total capacity allocated for the storage. This may differ from the requested storage
	// capacity as the system may round up to the requested capacity to satisify underlying
	// storage requirements (i.e. block size / stripe size).
	CapacityAllocated int64 `json:"capacityAllocated,omitempty"`

	// Redfish ID for the storage pool
	StoragePoolId string `json:"storagePoolId,omitempty"`
}

type NnfNodeBlockStorageDeviceStatus struct {
	// NQN of the base NVMe device
	NQN string `json:"NQN"`

	// Id of the Namespace on the NVMe device (e.g., "2")
	NamespaceId string `json:"namespaceId"`

	// Total capacity allocated for the storage. This may differ from the requested storage
	// capacity as the system may round up to the requested capacity to satisify underlying
	// storage requirements (i.e. block size / stripe size).
	CapacityAllocated int64 `json:"capacityAllocated,omitempty"`
}

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

type NnfNodeBlockStorageSpec struct {
	// SharedAllocation is used when a single NnfNodeBlockStorage allocation is used by multiple NnfNodeStorage allocations
	SharedAllocation bool `json:"sharedAllocation"`

	// Allocations is the list of storage allocations to make
	Allocations []NnfNodeBlockStorageAllocationSpec `json:"allocations,omitempty"`
}

type NnfNodeBlockStorageStatus struct {
	// Allocations is the list of storage allocations that were made
	Allocations []NnfNodeBlockStorageAllocationStatus `json:"allocations,omitempty"`

	dwsv1alpha6.ResourceError `json:",inline"`

	// PodStartTime is the value of pod.status.containerStatuses[].state.running.startedAt from the pod that did
	// last successful full reconcile of the NnfNodeBlockStorage. This is used to tell whether the /dev paths
	// listed in the status section are from the current boot of the node.
	PodStartTime metav1.Time `json:"podStartTime,omitempty"`

	Ready bool `json:"ready"`
}

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

	Spec   NnfNodeECDataSpec   `json:"spec,omitempty"`
	Status NnfNodeECDataStatus `json:"status,omitempty"`
}

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

type NnfNodeECDataSpec struct {
}