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.
Convert_v1alpha1_AllocationSetColocationConstraint_To_v1alpha2_AllocationSetColocationConstraint is an autogenerated conversion function.
Convert_v1alpha1_AllocationSetConstraints_To_v1alpha2_AllocationSetConstraints is an autogenerated conversion function.
Convert_v1alpha1_ClientMount_To_v1alpha2_ClientMount is an autogenerated conversion function.
Convert_v1alpha1_ClientMountDevice_To_v1alpha2_ClientMountDevice is an autogenerated conversion function.
Convert_v1alpha1_ClientMountDeviceLustre_To_v1alpha2_ClientMountDeviceLustre is an autogenerated conversion function.
Convert_v1alpha1_ClientMountDeviceLVM_To_v1alpha2_ClientMountDeviceLVM is an autogenerated conversion function.
Convert_v1alpha1_ClientMountDeviceReference_To_v1alpha2_ClientMountDeviceReference is an autogenerated conversion function.
Convert_v1alpha1_ClientMountInfo_To_v1alpha2_ClientMountInfo is an autogenerated conversion function.
Convert_v1alpha1_ClientMountInfoStatus_To_v1alpha2_ClientMountInfoStatus is an autogenerated conversion function.
Convert_v1alpha1_ClientMountList_To_v1alpha2_ClientMountList is an autogenerated conversion function.
Convert_v1alpha1_ClientMountNVMeDesc_To_v1alpha2_ClientMountNVMeDesc is an autogenerated conversion function.
Convert_v1alpha1_ClientMountSpec_To_v1alpha2_ClientMountSpec is an autogenerated conversion function.
Convert_v1alpha1_ClientMountStatus_To_v1alpha2_ClientMountStatus is an autogenerated conversion function.
Convert_v1alpha1_ComputeBreakdown_To_v1alpha2_ComputeBreakdown is an autogenerated conversion function.
Convert_v1alpha1_ComputeConstraints_To_v1alpha2_ComputeConstraints is an autogenerated conversion function.
Convert_v1alpha1_ComputeLocationAccess_To_v1alpha2_ComputeLocationAccess is an autogenerated conversion function.
Convert_v1alpha1_ComputeLocationConstraint_To_v1alpha2_ComputeLocationConstraint is an autogenerated conversion function.
Convert_v1alpha1_Computes_To_v1alpha2_Computes is an autogenerated conversion function.
Convert_v1alpha1_ComputesData_To_v1alpha2_ComputesData is an autogenerated conversion function.
Convert_v1alpha1_ComputesList_To_v1alpha2_ComputesList is an autogenerated conversion function.
Convert_v1alpha1_DirectiveBreakdown_To_v1alpha2_DirectiveBreakdown is an autogenerated conversion function.
Convert_v1alpha1_DirectiveBreakdownList_To_v1alpha2_DirectiveBreakdownList is an autogenerated conversion function.
Convert_v1alpha1_DirectiveBreakdownSpec_To_v1alpha2_DirectiveBreakdownSpec is an autogenerated conversion function.
Convert_v1alpha1_DirectiveBreakdownStatus_To_v1alpha2_DirectiveBreakdownStatus is an autogenerated conversion function.
Convert_v1alpha1_DWDirectiveRule_To_v1alpha2_DWDirectiveRule is an autogenerated conversion function.
Convert_v1alpha1_DWDirectiveRuleList_To_v1alpha2_DWDirectiveRuleList is an autogenerated conversion function.
Convert_v1alpha1_Node_To_v1alpha2_Node is an autogenerated conversion function.
Convert_v1alpha1_PersistentStorageInstance_To_v1alpha2_PersistentStorageInstance is an autogenerated conversion function.
Convert_v1alpha1_PersistentStorageInstanceList_To_v1alpha2_PersistentStorageInstanceList is an autogenerated conversion function.
Convert_v1alpha1_PersistentStorageInstanceSpec_To_v1alpha2_PersistentStorageInstanceSpec is an autogenerated conversion function.
Convert_v1alpha1_PersistentStorageInstanceStatus_To_v1alpha2_PersistentStorageInstanceStatus is an autogenerated conversion function.
Convert_v1alpha1_ResourceError_To_v1alpha2_ResourceError is an autogenerated conversion function.
No description provided by the author
Convert_v1alpha1_Servers_To_v1alpha2_Servers is an autogenerated conversion function.
Convert_v1alpha1_ServersList_To_v1alpha2_ServersList is an autogenerated conversion function.
Convert_v1alpha1_ServersSpec_To_v1alpha2_ServersSpec is an autogenerated conversion function.
Convert_v1alpha1_ServersSpecAllocationSet_To_v1alpha2_ServersSpecAllocationSet is an autogenerated conversion function.
Convert_v1alpha1_ServersSpecStorage_To_v1alpha2_ServersSpecStorage is an autogenerated conversion function.
Convert_v1alpha1_ServersStatus_To_v1alpha2_ServersStatus is an autogenerated conversion function.
Convert_v1alpha1_ServersStatusAllocationSet_To_v1alpha2_ServersStatusAllocationSet is an autogenerated conversion function.
Convert_v1alpha1_ServersStatusStorage_To_v1alpha2_ServersStatusStorage is an autogenerated conversion function.
Convert_v1alpha1_Storage_To_v1alpha2_Storage is an autogenerated conversion function.
Convert_v1alpha1_StorageAccess_To_v1alpha2_StorageAccess is an autogenerated conversion function.
Convert_v1alpha1_StorageAllocationSet_To_v1alpha2_StorageAllocationSet is an autogenerated conversion function.
Convert_v1alpha1_StorageBreakdown_To_v1alpha2_StorageBreakdown is an autogenerated conversion function.
Convert_v1alpha1_StorageDevice_To_v1alpha2_StorageDevice is an autogenerated conversion function.
Convert_v1alpha1_StorageList_To_v1alpha2_StorageList is an autogenerated conversion function.
Convert_v1alpha1_StorageSpec_To_v1alpha2_StorageSpec is an autogenerated conversion function.
Convert_v1alpha1_StorageStatus_To_v1alpha2_StorageStatus is an autogenerated conversion function.
Convert_v1alpha1_SystemConfiguration_To_v1alpha2_SystemConfiguration is an autogenerated conversion function.
Convert_v1alpha1_SystemConfigurationComputeNodeReference_To_v1alpha2_SystemConfigurationComputeNodeReference is an autogenerated conversion function.
Convert_v1alpha1_SystemConfigurationList_To_v1alpha2_SystemConfigurationList is an autogenerated conversion function.
No description provided by the author
Convert_v1alpha1_SystemConfigurationStatus_To_v1alpha2_SystemConfigurationStatus is an autogenerated conversion function.
Convert_v1alpha1_SystemConfigurationStorageNode_To_v1alpha2_SystemConfigurationStorageNode is an autogenerated conversion function.
Convert_v1alpha1_Workflow_To_v1alpha2_Workflow is an autogenerated conversion function.
Convert_v1alpha1_WorkflowDriverStatus_To_v1alpha2_WorkflowDriverStatus is an autogenerated conversion function.
Convert_v1alpha1_WorkflowList_To_v1alpha2_WorkflowList is an autogenerated conversion function.
No description provided by the author
Convert_v1alpha1_WorkflowStatus_To_v1alpha2_WorkflowStatus is an autogenerated conversion function.
Convert_v1alpha2_AllocationSetColocationConstraint_To_v1alpha1_AllocationSetColocationConstraint is an autogenerated conversion function.
Convert_v1alpha2_AllocationSetConstraints_To_v1alpha1_AllocationSetConstraints is an autogenerated conversion function.
Convert_v1alpha2_ClientMount_To_v1alpha1_ClientMount is an autogenerated conversion function.
Convert_v1alpha2_ClientMountDevice_To_v1alpha1_ClientMountDevice is an autogenerated conversion function.
Convert_v1alpha2_ClientMountDeviceLustre_To_v1alpha1_ClientMountDeviceLustre is an autogenerated conversion function.
Convert_v1alpha2_ClientMountDeviceLVM_To_v1alpha1_ClientMountDeviceLVM is an autogenerated conversion function.
Convert_v1alpha2_ClientMountDeviceReference_To_v1alpha1_ClientMountDeviceReference is an autogenerated conversion function.
Convert_v1alpha2_ClientMountInfo_To_v1alpha1_ClientMountInfo is an autogenerated conversion function.
Convert_v1alpha2_ClientMountInfoStatus_To_v1alpha1_ClientMountInfoStatus is an autogenerated conversion function.
Convert_v1alpha2_ClientMountList_To_v1alpha1_ClientMountList is an autogenerated conversion function.
Convert_v1alpha2_ClientMountNVMeDesc_To_v1alpha1_ClientMountNVMeDesc is an autogenerated conversion function.
Convert_v1alpha2_ClientMountSpec_To_v1alpha1_ClientMountSpec is an autogenerated conversion function.
No description provided by the author
Convert_v1alpha2_ComputeBreakdown_To_v1alpha1_ComputeBreakdown is an autogenerated conversion function.
Convert_v1alpha2_ComputeConstraints_To_v1alpha1_ComputeConstraints is an autogenerated conversion function.
Convert_v1alpha2_ComputeLocationAccess_To_v1alpha1_ComputeLocationAccess is an autogenerated conversion function.
Convert_v1alpha2_ComputeLocationConstraint_To_v1alpha1_ComputeLocationConstraint is an autogenerated conversion function.
Convert_v1alpha2_Computes_To_v1alpha1_Computes is an autogenerated conversion function.
Convert_v1alpha2_ComputesData_To_v1alpha1_ComputesData is an autogenerated conversion function.
Convert_v1alpha2_ComputesList_To_v1alpha1_ComputesList is an autogenerated conversion function.
Convert_v1alpha2_DirectiveBreakdown_To_v1alpha1_DirectiveBreakdown is an autogenerated conversion function.
Convert_v1alpha2_DirectiveBreakdownList_To_v1alpha1_DirectiveBreakdownList is an autogenerated conversion function.
Convert_v1alpha2_DirectiveBreakdownSpec_To_v1alpha1_DirectiveBreakdownSpec is an autogenerated conversion function.
No description provided by the author
Convert_v1alpha2_DWDirectiveRule_To_v1alpha1_DWDirectiveRule is an autogenerated conversion function.
Convert_v1alpha2_DWDirectiveRuleList_To_v1alpha1_DWDirectiveRuleList is an autogenerated conversion function.
Convert_v1alpha2_Node_To_v1alpha1_Node is an autogenerated conversion function.
Convert_v1alpha2_PersistentStorageInstance_To_v1alpha1_PersistentStorageInstance is an autogenerated conversion function.
Convert_v1alpha2_PersistentStorageInstanceList_To_v1alpha1_PersistentStorageInstanceList is an autogenerated conversion function.
Convert_v1alpha2_PersistentStorageInstanceSpec_To_v1alpha1_PersistentStorageInstanceSpec is an autogenerated conversion function.
Convert_v1alpha2_PersistentStorageInstanceStatus_To_v1alpha1_PersistentStorageInstanceStatus is an autogenerated conversion function.
Convert_v1alpha2_ResourceError_To_v1alpha1_ResourceError is an autogenerated conversion function.
No description provided by the author
Convert_v1alpha2_Servers_To_v1alpha1_Servers is an autogenerated conversion function.
Convert_v1alpha2_ServersList_To_v1alpha1_ServersList is an autogenerated conversion function.
Convert_v1alpha2_ServersSpec_To_v1alpha1_ServersSpec is an autogenerated conversion function.
Convert_v1alpha2_ServersSpecAllocationSet_To_v1alpha1_ServersSpecAllocationSet is an autogenerated conversion function.
Convert_v1alpha2_ServersSpecStorage_To_v1alpha1_ServersSpecStorage is an autogenerated conversion function.
No description provided by the author
Convert_v1alpha2_ServersStatusAllocationSet_To_v1alpha1_ServersStatusAllocationSet is an autogenerated conversion function.
Convert_v1alpha2_ServersStatusStorage_To_v1alpha1_ServersStatusStorage is an autogenerated conversion function.
Convert_v1alpha2_Storage_To_v1alpha1_Storage is an autogenerated conversion function.
Convert_v1alpha2_StorageAccess_To_v1alpha1_StorageAccess is an autogenerated conversion function.
Convert_v1alpha2_StorageAllocationSet_To_v1alpha1_StorageAllocationSet is an autogenerated conversion function.
Convert_v1alpha2_StorageBreakdown_To_v1alpha1_StorageBreakdown is an autogenerated conversion function.
Convert_v1alpha2_StorageDevice_To_v1alpha1_StorageDevice is an autogenerated conversion function.
Convert_v1alpha2_StorageList_To_v1alpha1_StorageList is an autogenerated conversion function.
No description provided by the author
Convert_v1alpha2_StorageStatus_To_v1alpha1_StorageStatus is an autogenerated conversion function.
Convert_v1alpha2_SystemConfiguration_To_v1alpha1_SystemConfiguration is an autogenerated conversion function.
Convert_v1alpha2_SystemConfigurationComputeNodeReference_To_v1alpha1_SystemConfigurationComputeNodeReference is an autogenerated conversion function.
Convert_v1alpha2_SystemConfigurationList_To_v1alpha1_SystemConfigurationList is an autogenerated conversion function.
No description provided by the author
No description provided by the author
Convert_v1alpha2_SystemConfigurationStorageNode_To_v1alpha1_SystemConfigurationStorageNode is an autogenerated conversion function.
Convert_v1alpha2_Workflow_To_v1alpha1_Workflow is an autogenerated conversion function.
Convert_v1alpha2_WorkflowDriverStatus_To_v1alpha1_WorkflowDriverStatus is an autogenerated conversion function.
Convert_v1alpha2_WorkflowList_To_v1alpha1_WorkflowList is an autogenerated conversion function.
No description provided by the author
Convert_v1alpha2_WorkflowStatus_To_v1alpha1_WorkflowStatus is an autogenerated conversion function.
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
RegisterConversions adds conversion functions to the given scheme.
No description provided by the author

# 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.
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
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.
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.
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.
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.

# 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.
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
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.
SystemConfigurationComputeNode describes a compute node in the system.
SystemConfigurationComputeNodeReference describes a compute node that has access to a server.
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.
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.

# 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.
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;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.