package
0.1.7
Repository: https://github.com/dataworkflowservices/dws.git
Documentation: pkg.go.dev

# Functions

AddOwnerLabels adds labels to a child resource that identifies the owner.
AddPersistentStorageLabels adds labels to a resource to indicate which persistent storage instance it belongs to.
AddWorkflowLabels adds labels to a resource to indicate which workflow it belongs to.
DeleteChildren deletes all the children of a parent with the resource types defined in a list of ObjectList types.
DeleteChildrenWithLabels deletes all the children of a parent with the resource types defined in a list of ObjectList types and the labels defined in matchingLabels.
InheritParentLabels adds all labels from a parent resource to a child resource, excluding the owner labels.
MatchingOwner returns the MatchingLabels to match the owner labels.
MatchingPersistentStorage returns the MatchingLabels to match the persistent storage labels.
MatchingWorkflow returns the MatchingLabels to match the workflow labels.
No description provided by the author
No description provided by the author
No description provided by the author
SeverityStringToStatus will return a Status* string that goes with the given severity.

# Constants

No description provided by the author
No description provided by the author
No description provided by the author
ClientMountDeviceTypeLustre is used to define the device as a Lustre file system.
ClientMountDeviceTypeLVM is used to define the device as a LVM logical volume.
ClientMountDeviceTypeReference is used when the device information is described in a separate Kubernetes resource.
ClientMountLVMDeviceTypeNVMe specifies the NVMe constant device type.
ClientMountState string constants.
ClientMountState string constants.
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
Degraded means the resource is ready but operating in a degraded state.
DirectiveLifetimeJob specifies storage allocated for the lifetime of the job.
DirectiveLifetimePersistent specifies storage allocated an indefinite lifetime usually longer than a job.
Disabled means the resource shall be disabled.
Disabled means the resource is present but disabled by an administrator or external user.
Drained means the resource has had its pods drained from the node.
Enabled means the resource shall be enabled.
Failed means the resource has failed during startup or execution.
NotPresent means the resource is not present within the system, likely because it is missing or powered down.
No description provided by the author
Offline means the resource is offline and cannot be communicated with.
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
PersistentStorageNameLabel is defined for resources that relate to the name of a DWS PersistentStorageInstance.
PersistentStorageNamespaceLabel is defined for resources that relate to the namespace of a DWS PersistentStorageInstance.
The storage and filesystem represented by the PSI exists and is ready for use.
The PSI resource exists in k8s, but the storage and filesystem that it represents has not been created yet.
A #DW destroy_persistent directive has been issued in a workflow.
Ready means the resource is fully operational and ready for use.
Fatal errors will never succeed.
Major errors may or may not succeed.
Minor errors are very likely to eventually succeed (e.g., errors caused by a stale cache) The WLM doesn't see these errors directly.
Starting means the resource is currently starting prior to becoming ready.
WorkflowState values.
WorkflowState values.
WorkflowState values.
WorkflowState values.
WorkflowState values.
WorkflowState values.
WorkflowState values.
Strings associated with workflow statuses.
Strings associated with workflow statuses.
Strings associated with workflow statuses.
Strings associated with workflow statuses.
Strings associated with workflow statuses.
Strings associated with workflow statuses.
Strings associated with workflow statuses.
No description provided by the author
No description provided by the author
StorageTypeLabel is the label key used for tagging Storage resources with a driver specific label.
Internal errors are due to an error in the DWS/driver code.
User errors are due to an error with the input from a user.
WLM errors are due to an error with the input from the WLM.
Unknown means the resource status is unknown.
WorkflowNameLabel is defined for resources that relate to the name of a DWS Workflow.
WorkflowNamespaceLabel is defined for resources that relate to the namespace of a DWS Workflow.
WorkflowUIDLabel holds the UID of the parent workflow resource.

# Variables

AddToScheme adds the types in this group-version to the given scheme.
GroupVersion is group version used to register these objects.
SchemeBuilder is used to add go types to the GroupVersionKind scheme.

# Structs

AllocationSetColocationConstraint specifies how to colocate storage resources.
AllocationSetConstraints specifies the constraints required for colocation of Storage resources.
ClientMount is the Schema for the clientmounts API.
ClientMountDevice defines the device to mount.
ClientMountDeviceLustre defines the lustre device information for mounting.
ClientMountDeviceLVM defines an LVM device by the VG/LV pair and optionally the drives that are the PVs.
ClientMountDeviceReference is an reference to a different Kubernetes object where device information can be found.
ClientMountInfo defines a single mount.
ClientMountInfoStatus is the status for a single mount point.
ClientMountList contains a list of ClientMount.
ClientMountNVMeDesc uniquely describes an NVMe namespace.
ClientMountSpec defines the desired state of ClientMount.
ClientMountStatus defines the observed state of ClientMount.
ComputeBreakdown describes the compute requirements of a directive.
ComputeConstraints describes the constraints to use when picking compute nodes.
No description provided by the author
ComputeLocationConstraint describes a constraints on which compute nodes can be used with a directive based on their location.
Computes is the Schema for the computes API.
ComputesData defines the compute nodes that are assigned to the workflow.
ComputesList contains a list of Computes.
DeleteStatus provides information about the status of DeleteChildren* operation +kubebuilder:object:generate=false +k8s:conversion-gen=false.
DirectiveBreakdown is the Schema for the directivebreakdown API.
DirectiveBreakdownList contains a list of DirectiveBreakdown.
DirectiveBreakdownSpec defines the directive string to breakdown.
DirectiveBreakdownStatus defines the storage information WLM needs to select NNF Nodes and request storage from the selected nodes.
DWDirectiveRule is the Schema for the DWDirective API.
DWDirectiveRuleList contains a list of DWDirective.
MutatingRuleParser provides the rulelist +kubebuilder:object:generate=false.
Node provides the status of either a compute or a server.
PersistentStorageInstance is the Schema for the Persistentstorageinstances API.
PersistentStorageInstanceList contains a list of PersistentStorageInstances.
PersistentStorageInstanceSpec defines the desired state of PersistentStorageInstance.
PersistentStorageInstanceStatus defines the observed state of PersistentStorageInstance.
No description provided by the author
No description provided by the author
RuleList contains the rules to be applied for a particular driver +kubebuilder:object:generate=false.
Servers is the Schema for the servers API.
ServersList contains a list of Servers.
ServersSpec defines the desired state of Servers.
ServersSpecAllocationSet is a set of allocations that all share the same allocation size and allocation type (e.g., XFS).
ServersSpecStorage specifies info required to identify the storage to use, and the number of allocations to make on that storage.
ServersStatus specifies whether the Servers has achieved the ready condition along with the allocationSets that are managed by the Servers resource.
ServersStatusAllocationSet is the status of a set of allocations.
ServersStatusStorage is the status of the allocations on a storage.
Storage is the Schema for the storages API.
StorageAccess contains nodes and the protocol that may access the storage.
StorageAllocationSet defines the details of an allocation set.
StorageBreakdown describes the storage requirements of a directive.
StorageDevice contains the details of the storage hardware.
StorageList contains a list of Storage.
StorageSpec defines the desired specifications of Storage resource.
StorageData contains the data about the storage.
SystemConfiguration is the Schema for the systemconfigurations API.
SystemConfigurationComputeNodeReference describes a compute node that has access to a server.
SystemConfigurationExternalComputeNode describes a compute node that is not directly matched with any of the nodes in the StorageNodes list.
SystemConfigurationList contains a list of SystemConfiguration.
SystemConfigurationSpec describes the node layout of the system.
SystemConfigurationStatus defines the status of SystemConfiguration.
SystemConfigurationStorageNode describes a storage node in the system.
ValidatingRuleParser provides the rulelist +kubebuilder:object:generate=false.
Workflow is the Schema for the workflows API.
WorkflowDriverStatus defines the status information provided by integration drivers.
WorkflowList contains a list of Workflows.
WorkflowSpec defines the desired state of Workflow.
WorkflowStatus defines the observed state of the Workflow.

# Interfaces

+kubebuilder:object:generate=false.
RuleParser defines the interface a rule parser must provide +kubebuilder:object:generate=false.

# Type aliases

No description provided by the author
ClientMountDeviceType specifies the go type for device type.
ClientMountLVMDeviceType specifies the go type for LVMDeviceType.
ClientMountState specifies the go type for MountState.
No description provided by the author
No description provided by the author
PersistentStorageInstanceState specifies the golang type for PSIState.
No description provided by the author
No description provided by the author
ResourceState is the enumeration of the state of a DWS resource +kubebuilder:validation:Enum:=Enabled;Disabled.
ResourceStatus is the enumeration of the status of a DWS resource +kubebuilder:validation:Enum:=Starting;Ready;Disabled;NotPresent;Offline;Failed;Degraded;Drained;Unknown.
StorageAccessProtocol is the enumeration of supported protocols.
StorageType is the enumeration of storage types.
WorkflowState is the enumeration of the state of the workflow +kubebuilder:validation:Enum:=Proposal;Setup;DataIn;PreRun;PostRun;DataOut;Teardown.