package
0.0.0-20200402034527-ac39e06ead5a
Repository: https://github.com/red-firefly/volcano.git
Documentation: pkg.go.dev

# Packages

No description provided by the author

# Functions

AllocatedStatus checks whether the tasks has AllocatedStatus.
EmptyResource creates a empty resource object and returns.
GetPodResourceRequest returns all the resource required for that pod.
GetPodResourceWithoutInitContainers returns Pod's resource request, it does not contain init containers' resource request.
JobTerminated checks whether job was terminated.
MergeErrors is used to merge multiple errors into single error.
NewFitError return FitError by message.
NewFitErrorByReasons return FitError by reasons.
NewFitErrors returns an FitErrors.
NewJobInfo creates a new jobInfo for set of tasks.
NewNamespaceCollection creates new NamespaceCollection object to record all information about a namespace.
NewNodeInfo is used to create new nodeInfo object.
NewQueueInfo creates new queueInfo object.
NewResource create a new resource object from resource list.
NewTaskInfo creates new taskInfo object for a Pod.
PodKey returns the string key of a pod.

# Constants

AllNodeUnavailableMsg is the default error message.
Allocated means the scheduler assigns a host to it.
Binding means the scheduler send Bind request to apiserver.
Bound means the task/Pod bounds to a host.
DefaultNamespaceWeight is the default weight of namespace.
Failed means that all containers in the pod have terminated, and at least one container has terminated in a failure (exited with a non-zero exit code or was stopped by the system).
GPUResourceName need to follow https://github.com/NVIDIA/k8s-device-plugin/blob/66a35b71ac4b5cbfb04714678b548bd77e5ba719/server.go#L20.
NamespaceWeightKey is the key in ResourceQuota.spec.hard indicating the weight of this namespace.
NodePodNumberExceeded means pods in node exceed the allocatable pod number.
NodeResourceFitFailed means node could not fit the request of pod.
NotReady means the node is not ready for scheduling.
Pending means the task is pending in the apiserver.
Pipelined means the scheduler assigns a host to wait for releasing resource.
PodGroupVersionV1Alpha1 represents PodGroupVersion of V1Alpha1.
PodGroupVersionV1Alpha2 represents PodGroupVersion of V1Alpha2.
Ready means the node is ready for scheduling.
Releasing means a task/pod is deleted.
Running means a task is running on the host.
Succeeded means that all containers in the pod have voluntarily terminated with a container exit code of 0, and the system is not going to restart any of these containers.
Unknown means the status of task/pod is unknown to the scheduler.

# Structs

ClusterInfo is a snapshot of cluster by cache.
FitError describe the reason why task could not fit that node.
FitErrors is set of FitError on many nodes.
JobInfo will have all info of a Job.
NamespaceCollection will record all details about namespace.
NamespaceInfo records information of namespace.
NodeInfo is node level aggregated information.
NodeState defines the current state of node.
PodGroup is a collection of Pod; used for batch workload.
QueueInfo will have all details about queue.
Resource struct defines all the resource type.
TaskInfo will have all infos about the task.
ValidateResult is struct to which can used to determine the result.

# Type aliases

BatchNodeOrderFn is the func declaration used to get priority score for ALL nodes for a particular task.
CompareFn is the func declaration used by sort or priority queue.
EvictableFn is the func declaration used to evict tasks.
JobID is the type of JobInfo's ID.
LessFn is the func declaration used by sort or priority queue.
NamespaceName is name of namespace.
NodeMapFn is the func declaration used to get priority score for a node for a particular task.
NodeOrderFn is the func declaration used to get priority score for a node for a particular task.
NodeOrderMapFn is the func declaration used to get priority score of all plugins for a node for a particular task.
NodeOrderReduceFn is the func declaration used to reduce priority score of all nodes for a plugiin for a particular task.
NodePhase defines the phase of node.
NodeReduceFn is the func declaration used to reduce priority score for a node for a particular task.
NodeResourceMap stores resource in a node.
PodGroupPhase is the phase of a pod group at the current time.
PredicateFn is the func declaration used to predicate node for task.
QueueID is UID type, serves as unique ID for each queue.
TaskID is UID type for Task.
TaskStatus defines the status of a task/pod.
ValidateExFn is the func declaration used to validate the result.
ValidateFn is the func declaration used to check object's status.