v1alpha1

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"`
}

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 dwsv1alpha2.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
	// +kubebuilder:validation:Enum=single;all
	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"`

	// MountPathPrefix to  mount the storage target on the client when there is
	// more than one mount on a client
	MountPathPrefix string `json:"mountPathPrefix,omitempty"`

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

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"`

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

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 60 if not set. A value of 0 disables this behavior.
	// +kubebuilder:default:=60
	// +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 60 if not set. A value of 0 disables this behavior.
	// +kubebuilder:default:=60
	// +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 communication with the user container. These ports are opened on
	// the targeted NNF nodes and can be accessed outside of 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"`

	// Spec to define the containers created from this profile. This is used for non-MPI containers.
	// Refer to the K8s documentation for `PodSpec` for more definition:
	// https://kubernetes.io/docs/reference/kubernetes-api/workload-resources/pod-v1/#PodSpec
	// Either this or MPISpec must be provided, but not both.
	Spec *corev1.PodSpec `json:"spec,omitempty"`

	// MPIJobSpec to define the MPI containers created from this profile. This functionality is
	// provided via mpi-operator, a 3rd party tool to assist in running MPI applications across
	// worker containers.
	// Either this or Spec must be provided, but not both.
	//
	// All the fields defined drive mpi-operator behavior. See the type definition of MPISpec for
	// more detail:
	// https://github.com/kubeflow/mpi-operator/blob/v0.4.0/pkg/apis/kubeflow/v2beta1/types.go#L137
	//
	// Note: most of these fields are fully customizable with a few exceptions. These fields are
	// overridden by NNF software to ensure proper behavior to interface with the DWS workflow
	// - Replicas
	// - RunPolicy.BackoffLimit (this is set above by `RetryLimit`)
	// - Worker/Launcher.RestartPolicy
	MPISpec *mpiv2beta1.MPIJobSpec `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"`

	// Progress 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"`
}

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 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 nnf-dm-config ConfigMap.
	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 nnf-dm-config ConfigMap.
	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"`

	// Template defines the pod template that is used for the basis of the worker Daemon Set that
	// manages the per node data movement operations.
	Template corev1.PodTemplateSpec `json:"template"`

	// 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 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"`

	// Profile specifies the name of profile in the nnf-dm-config ConfigMap to be used for
	// configuring data movement. Defaults to the default profile.
	// +kubebuilder:default:=default
	Profile string `json:"profile,omitempty"`

	// User defined configuration on how data movement should be performed. This overrides the
	// configuration defined in the nnf-dm-config ConfigMap. 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"`

	dwsv1alpha2.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 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 {
	// 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"`

	dwsv1alpha2.ResourceError `json:",inline"`

	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 {
}

type NnfNodeECDataStatus struct {
	Data map[string]NnfNodeECPrivateData `json:"data,omitempty"`
}

type NnfNodeECPrivateData map[string]string

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

type NnfNodeSpec struct {

	// The unique name for this NNF Node
	Name string `json:"name,omitempty"`

	// Pod name for this NNF Node
	Pod string `json:"pod,omitempty"`

	// State reflects the desired state of this NNF Node resource
	// +kubebuilder:validation:Enum=Enable;Disable
	State NnfResourceStateType `json:"state"`
}

type NnfNodeStatus struct {

	// Status reflects the current status of the NNF Node
	Status NnfResourceStatusType `json:"status,omitempty"`

	Health NnfResourceHealthType `json:"health,omitempty"`

	// Fenced is true when the NNF Node is fenced by the STONITH agent, and false otherwise.
	Fenced bool `json:"fenced,omitempty"`

	// LNetNid is the LNet address for the NNF node
	LNetNid string `json:"lnetNid,omitempty"`

	Capacity          int64 `json:"capacity,omitempty"`
	CapacityAllocated int64 `json:"capacityAllocated,omitempty"`

	Servers []NnfServerStatus `json:"servers,omitempty"`

	Drives []NnfDriveStatus `json:"drives,omitempty"`
}

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

	Spec   NnfNodeStorageSpec   `json:"spec,omitempty"`
	Status NnfNodeStorageStatus `json:"status,omitempty"`
}

type NnfNodeStorageAllocationStatus struct {
	// Name of the LVM VG
	VolumeGroup string `json:"volumeGroup,omitempty"`

	// Name of the LVM LV
	LogicalVolume string `json:"logicalVolume,omitempty"`

	Ready bool `json:"ready,omitempty"`
}

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

type NnfNodeStorageSpec struct {
	// Count is the number of allocations to make on this node. All of the allocations will
	// be created with the same parameters
	// +kubebuilder:validation:Minimum:=0
	Count int `json:"count"`

	// User ID for file system
	UserID uint32 `json:"userID"`

	// Group ID for file system
	GroupID uint32 `json:"groupID"`

	// FileSystemType defines the type of the desired filesystem, or raw
	// block device.
	// +kubebuilder:validation:Enum=raw;lvm;zfs;xfs;gfs2;lustre
	// +kubebuilder:default:=raw
	FileSystemType string `json:"fileSystemType"`

	// LustreStorageSpec describes the Lustre target created here, if
	// FileSystemType specifies a Lustre target.
	LustreStorage LustreStorageSpec `json:"lustreStorage,omitempty"`

	// BlockReference is an object reference to an NnfNodeBlockStorage
	BlockReference corev1.ObjectReference `json:"blockReference,omitempty"`
}

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

	Ready bool `json:"ready,omitempty"`

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

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

	Spec   NnfPortManagerSpec   `json:"spec,omitempty"`
	Status NnfPortManagerStatus `json:"status,omitempty"`
}

type NnfPortManagerAllocationSpec struct {
	// Requester is an object reference to the requester of a ports.
	Requester corev1.ObjectReference `json:"requester"`

	// Count is the number of desired ports the requester needs. The port manager
	// will attempt to allocate this many ports.
	// +kubebuilder:default:=1
	Count int `json:"count"`
}

type NnfPortManagerAllocationStatus struct {
	// Requester is an object reference to the requester of the port resource, if one exists, or
	// empty otherwise.
	Requester *corev1.ObjectReference `json:"requester,omitempty"`

	// Ports is list of ports allocated to the owning resource.
	Ports []uint16 `json:"ports,omitempty"`

	// Status is the ownership status of the port.
	Status NnfPortManagerAllocationStatusStatus `json:"status"`

	// TimeUnallocated is when the port was unallocated. This is to ensure the proper cooldown
	// duration.
	TimeUnallocated *metav1.Time `json:"timeUnallocated,omitempty"`
}

type NnfPortManagerAllocationStatusStatus string

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

type NnfPortManagerSpec struct {

	// SystemConfiguration is an object reference to the system configuration. The
	// Port Manager will use the available ports defined in the system configuration.
	SystemConfiguration corev1.ObjectReference `json:"systemConfiguration"`

	// Allocations is a list of allocation requests that the Port Manager will attempt
	// to satisfy. To request port resources from the port manager, clients should add
	// an entry to the allocations. Entries must be unique. The port manager controller
	// will attempt to allocate port resources for each allocation specification in the
	// list. To remove an allocation and free up port resources, remove the allocation
	// from the list.
	Allocations []NnfPortManagerAllocationSpec `json:"allocations"`
}

type NnfPortManagerStatus struct {

	// Allocations is a list of port allocation status'.
	Allocations []NnfPortManagerAllocationStatus `json:"allocations,omitempty"`

	// Status is the current status of the port manager.
	Status NnfPortManagerStatusStatus `json:"status"`
}

type NnfPortManagerStatusStatus string

type NnfResourceHealthType string

type NnfResourceStateType string

type NnfResourceStatus struct {
	// ID reflects the NNF Node unique identifier for this NNF Server resource.
	ID string `json:"id,omitempty"`

	// Name reflects the common name of this NNF Server resource.
	Name string `json:"name,omitempty"`

	Status NnfResourceStatusType `json:"status,omitempty"`

	Health NnfResourceHealthType `json:"health,omitempty"`
}

type NnfResourceStatusType string

type NnfServerStatus struct {
	Hostname string `json:"hostname,omitempty"`

	NnfResourceStatus `json:",inline"`
}

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

	Spec   NnfStorageSpec   `json:"spec,omitempty"`
	Status NnfStorageStatus `json:"status,omitempty"`
}

type NnfStorageAllocationNodes struct {
	// Name of the node to make the allocation on
	Name string `json:"name"`

	// Number of allocations to make on this node
	Count int `json:"count"`
}

type NnfStorageAllocationSetSpec struct {
	// Name is a human readable label for this set of allocations (e.g., xfs)
	Name string `json:"name"`

	// Capacity defines the capacity, in bytes, of this storage specification. The NNF Node itself
	// may split the storage among the available drives operating in the NNF Node.
	Capacity int64 `json:"capacity"`

	// Lustre specific configuration
	NnfStorageLustreSpec `json:",inline"`

	// Nodes is the list of Rabbit nodes to make allocations on
	Nodes []NnfStorageAllocationNodes `json:"nodes"`
}

type NnfStorageAllocationSetStatus struct {
	Ready bool `json:"ready,omitempty"`

	// AllocationCount is the total number of allocations that currently
	// exist
	AllocationCount int `json:"allocationCount"`
}

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

type NnfStorageLustreSpec 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"`

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

	// MgsAddress is the NID of the MGS when a pre-existing MGS is
	// provided in the NnfStorageProfile
	MgsAddress string `json:"mgsAddress,omitempty"`

	// PersistentMgsReference is a reference to a persistent storage that is providing
	// the external MGS.
	PersistentMgsReference corev1.ObjectReference `json:"persistentMgsReference,omitempty"`
}

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

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

type NnfStorageProfileCmdLines struct {
	// Mkfs specifies the mkfs commandline, minus the "mkfs".
	Mkfs string `json:"mkfs,omitempty"`

	// PvCreate specifies the pvcreate commandline, minus the "pvcreate".
	PvCreate string `json:"pvCreate,omitempty"`

	// PvRemove specifies the pvremove commandline, minus the "pvremove".
	PvRemove string `json:"pvRemove,omitempty"`

	// VgCreate specifies the vgcreate commandline, minus the "vgcreate".
	VgCreate string `json:"vgCreate,omitempty"`

	// VgChange specifies the various vgchange commandlines, minus the "vgchange"
	VgChange NnfStorageProfileLVMVgChangeCmdLines `json:"vgChange,omitempty"`

	// VgCreate specifies the vgcreate commandline, minus the "vgremove".
	VgRemove string `json:"vgRemove,omitempty"`

	// LvCreate specifies the lvcreate commandline, minus the "lvcreate".
	LvCreate string `json:"lvCreate,omitempty"`

	// LvChange specifies the various lvchange commandlines, minus the "lvchange"
	LvChange NnfStorageProfileLVMLvChangeCmdLines `json:"lvChange,omitempty"`

	// LvRemove specifies the lvcreate commandline, minus the "lvremove".
	LvRemove string `json:"lvRemove,omitempty"`

	// MountRabbit specifies mount options for mounting on the Rabbit.
	MountRabbit string `json:"mountRabbit,omitempty"`

	// MountCompute specifies mount options for mounting on the Compute.
	MountCompute string `json:"mountCompute,omitempty"`
}

type NnfStorageProfileData 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"`

	// LustreStorage defines the Lustre-specific configuration
	LustreStorage NnfStorageProfileLustreData `json:"lustreStorage"`

	// GFS2Storage defines the GFS2-specific configuration
	GFS2Storage NnfStorageProfileGFS2Data `json:"gfs2Storage"`

	// XFSStorage defines the XFS-specific configuration
	XFSStorage NnfStorageProfileXFSData `json:"xfsStorage"`

	// RawStorage defines the Raw-specific configuration
	RawStorage NnfStorageProfileRawData `json:"rawStorage"`
}

type NnfStorageProfileGFS2Data struct {
	// CmdLines contains commands to create volumes and filesystems.
	CmdLines NnfStorageProfileCmdLines `json:"commandlines,omitempty"`
}

type NnfStorageProfileLVMLvChangeCmdLines struct {
	// The lvchange commandline for activate, minus the "lvchange" command
	Activate string `json:"activate,omitempty"`

	// The lvchange commandline for deactivate, minus the "lvchange" command
	Deactivate string `json:"deactivate,omitempty"`
}

type NnfStorageProfileLVMVgChangeCmdLines struct {
	// The vgchange commandline for lockStart, minus the "vgchange" command
	LockStart string `json:"lockStart,omitempty"`

	// The vgchange commandline for lockStop, minus the "vgchange" command
	LockStop string `json:"lockStop,omitempty"`
}

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

type NnfStorageProfileLustreCmdLines struct {
	// ZpoolCreate specifies the zpool create commandline, minus the "zpool create".
	// This is where you may specify zpool create options, and the virtual device (vdev) such as
	// "mirror", or "draid".  See zpoolconcepts(7).
	ZpoolCreate string `json:"zpoolCreate,omitempty"`

	// Mkfs specifies the mkfs.lustre commandline, minus the "mkfs.lustre".
	// Use the --mkfsoptions argument to specify the zfs create options.  See zfsprops(7).
	// Use the --mountfsoptions argument to specify persistent mount options for the lustre targets.
	Mkfs string `json:"mkfs,omitempty"`

	// MountTarget specifies the mount command line for the lustre target.
	// For persistent mount options for lustre targets, do not use this array; use the --mountfsoptions
	// argument to mkfs.lustre instead.
	MountTarget string `json:"mountTarget,omitempty"`
}

type NnfStorageProfileLustreData struct {
	// CombinedMGTMDT indicates whether the MGT and MDT should be created on the same target device
	// +kubebuilder:default:=false
	CombinedMGTMDT bool `json:"combinedMgtMdt,omitempty"`

	// ExternalMGS specifies the use of an existing MGS rather than creating one. This can
	// be either the NID(s) of a pre-existing MGS that should be used, or it can be an NNF Persistent
	// Instance that was created with the "StandaloneMGTPoolName" option. In the latter case, the format
	// is "pool:poolName" where "poolName" is the argument from "StandaloneMGTPoolName". A single MGS will
	// be picked from the pool.
	ExternalMGS string `json:"externalMgs,omitempty"`

	// CapacityMGT specifies the size of the MGT device.
	// +kubebuilder:validation:Pattern:="^\\d+(KiB|KB|MiB|MB|GiB|GB|TiB|TB)$"
	// +kubebuilder:default:="5GiB"
	CapacityMGT string `json:"capacityMgt,omitempty"`

	// CapacityMDT specifies the size of the MDT device.  This is also
	// used for a combined MGT+MDT device.
	// +kubebuilder:validation:Pattern:="^\\d+(KiB|KB|MiB|MB|GiB|GB|TiB|TB)$"
	// +kubebuilder:default:="5GiB"
	CapacityMDT string `json:"capacityMdt,omitempty"`

	// ExclusiveMDT indicates that the MDT should not be colocated with any other target on the chosen server.
	// +kubebuilder:default:=false
	ExclusiveMDT bool `json:"exclusiveMdt,omitempty"`

	// StandaloneMGTPoolName creates a Lustre MGT without a MDT or OST. This option can only be used when creating
	// a persistent Lustre instance. The MGS is placed into a named pool that can be used by the "ExternalMGS" option.
	// Multiple pools can be created.
	StandaloneMGTPoolName string `json:"standaloneMgtPoolName,omitempty"`

	// MgtCmdLines contains commands to create an MGT target.
	MgtCmdLines NnfStorageProfileLustreCmdLines `json:"mgtCommandlines,omitempty"`

	// MdtCmdLines contains commands to create an MDT target.
	MdtCmdLines NnfStorageProfileLustreCmdLines `json:"mdtCommandlines,omitempty"`

	// MgtMdtCmdLines contains commands to create a combined MGT/MDT target.
	MgtMdtCmdLines NnfStorageProfileLustreCmdLines `json:"mgtMdtCommandlines,omitempty"`

	// OstCmdLines contains commands to create an OST target.
	OstCmdLines NnfStorageProfileLustreCmdLines `json:"ostCommandlines,omitempty"`

	// MgtOptions contains options to use for libraries used for an MGT target.
	MgtOptions NnfStorageProfileLustreMiscOptions `json:"mgtOptions,omitempty"`

	// MdtOptions contains options to use for libraries used for an MDT target.
	MdtOptions NnfStorageProfileLustreMiscOptions `json:"mdtOptions,omitempty"`

	// MgtMdtOptions contains options to use for libraries used for a combined MGT/MDT target.
	MgtMdtOptions NnfStorageProfileLustreMiscOptions `json:"mgtMdtOptions,omitempty"`

	// OstOptions contains options to use for libraries used for an OST target.
	OstOptions NnfStorageProfileLustreMiscOptions `json:"ostOptions,omitempty"`

	// MountRabbit specifies mount options for making the Lustre client mount on the Rabbit.
	MountRabbit string `json:"mountRabbit,omitempty"`

	// MountCompute specifies mount options for making the Lustre client mount on the Compute.
	MountCompute string `json:"mountCompute,omitempty"`
}

type NnfStorageProfileLustreMiscOptions struct {
	// ColocateComputes indicates that the Lustre target should be placed on a Rabbit node that has a physical connection
	// to the compute nodes in a workflow
	// +kubebuilder:default:=false
	ColocateComputes bool `json:"colocateComputes"`

	// Count specifies how many Lustre targets to create
	// +kubebuilder:validation:Minimum:=1
	Count int `json:"count,omitempty"`

	// Scale provides a unitless value to determine how many Lustre targets to create
	// +kubebuilder:validation:Minimum:=1
	// +kubebuilder:validation:Maximum:=10
	Scale int `json:"scale,omitempty"`
}

type NnfStorageProfileRawData struct {
	// CmdLines contains commands to create volumes and filesystems.
	CmdLines NnfStorageProfileCmdLines `json:"commandlines,omitempty"`
}

type NnfStorageProfileXFSData struct {
	// CmdLines contains commands to create volumes and filesystems.
	CmdLines NnfStorageProfileCmdLines `json:"commandlines,omitempty"`
}

type NnfStorageSpec struct {

	// FileSystemType defines the type of the desired filesystem, or raw
	// block device.
	// +kubebuilder:validation:Enum=raw;lvm;zfs;xfs;gfs2;lustre
	// +kubebuilder:default:=raw
	FileSystemType string `json:"fileSystemType"`

	// User ID for file system
	UserID uint32 `json:"userID"`

	// Group ID for file system
	GroupID uint32 `json:"groupID"`

	// AllocationSets is a list of different types of storage allocations to make. Each
	// AllocationSet describes an entire allocation spanning multiple Rabbits. For example,
	// an AllocationSet could be all of the OSTs in a Lustre filesystem, or all of the raw
	// block devices in a raw block configuration.
	AllocationSets []NnfStorageAllocationSetSpec `json:"allocationSets"`
}

type NnfStorageStatus struct {
	// MgsAddress is the NID of the MGS.
	MgsAddress string `json:"mgsAddress,omitempty"`

	// AllocationsSets holds the status information for each of the AllocationSets
	// from the spec.
	AllocationSets []NnfStorageAllocationSetStatus `json:"allocationSets,omitempty"`

	dwsv1alpha2.ResourceError `json:",inline"`

	// Ready reflects the status of this NNF Storage
	Ready bool `json:"ready,omitempty"`
}

type VarHandler struct {
	VarMap map[string]string
}