You are viewing a plain text version of this content. The canonical link for it is here.
Posted to common-commits@hadoop.apache.org by sn...@apache.org on 2022/03/09 18:30:39 UTC
[hadoop] branch trunk updated: YARN-10945. Add javadoc to all methods of AbstractCSQueue. Contributed by Andras Gyori
This is an automated email from the ASF dual-hosted git repository.
snemeth pushed a commit to branch trunk
in repository https://gitbox.apache.org/repos/asf/hadoop.git
The following commit(s) were added to refs/heads/trunk by this push:
new 2ece950 YARN-10945. Add javadoc to all methods of AbstractCSQueue. Contributed by Andras Gyori
2ece950 is described below
commit 2ece95064b9bf11ec6a165baf6de7ced4986747f
Author: Szilard Nemeth <sn...@apache.org>
AuthorDate: Wed Mar 9 19:29:53 2022 +0100
YARN-10945. Add javadoc to all methods of AbstractCSQueue. Contributed by Andras Gyori
---
.../scheduler/capacity/AbstractCSQueue.java | 85 +++++++++++++++++++++-
1 file changed, 81 insertions(+), 4 deletions(-)
diff --git a/hadoop-yarn-project/hadoop-yarn/hadoop-yarn-server/hadoop-yarn-server-resourcemanager/src/main/java/org/apache/hadoop/yarn/server/resourcemanager/scheduler/capacity/AbstractCSQueue.java b/hadoop-yarn-project/hadoop-yarn/hadoop-yarn-server/hadoop-yarn-server-resourcemanager/src/main/java/org/apache/hadoop/yarn/server/resourcemanager/scheduler/capacity/AbstractCSQueue.java
index b0ab336..87fa9da 100644
--- a/hadoop-yarn-project/hadoop-yarn/hadoop-yarn-server/hadoop-yarn-server-resourcemanager/src/main/java/org/apache/hadoop/yarn/server/resourcemanager/scheduler/capacity/AbstractCSQueue.java
+++ b/hadoop-yarn-project/hadoop-yarn/hadoop-yarn-server/hadoop-yarn-server-resourcemanager/src/main/java/org/apache/hadoop/yarn/server/resourcemanager/scheduler/capacity/AbstractCSQueue.java
@@ -77,6 +77,10 @@ import java.util.concurrent.locks.ReentrantReadWriteLock;
import static org.apache.hadoop.yarn.nodelabels.CommonNodeLabelsManager.NO_LABEL;
import static org.apache.hadoop.yarn.server.resourcemanager.scheduler.capacity.CapacitySchedulerConfiguration.DOT;
+/**
+ * Provides implementation of {@code CSQueue} methods common for every queue class in Capacity
+ * Scheduler.
+ */
public abstract class AbstractCSQueue implements CSQueue {
private static final Logger LOG =
LoggerFactory.getLogger(AbstractCSQueue.class);
@@ -106,11 +110,9 @@ public abstract class AbstractCSQueue implements CSQueue {
CSQueueUsageTracker usageTracker;
public enum CapacityConfigType {
- // FIXME, from what I can see, Percentage mode can almost apply to weighted
- // and percentage mode at the same time, there's only small area need to be
- // changed, we need to rename "PERCENTAGE" to "PERCENTAGE" and "WEIGHT"
NONE, PERCENTAGE, ABSOLUTE_RESOURCE
};
+
protected CapacityConfigType capacityConfigType =
CapacityConfigType.NONE;
@@ -175,6 +177,9 @@ public abstract class AbstractCSQueue implements CSQueue {
return new QueuePath(parent.getQueuePath(), queueName);
}
+ /**
+ * Sets up capacity and weight values from configuration.
+ */
protected void setupConfigurableCapacities() {
CSQueueUtils.loadCapacitiesByLabelsFromConf(queuePath, queueCapacities,
queueContext.getConfiguration(), this.queueNodeLabelsSettings.getConfiguredNodeLabels());
@@ -272,6 +277,12 @@ public abstract class AbstractCSQueue implements CSQueue {
return queueNodeLabelsSettings.getAccessibleNodeLabels();
}
+ /**
+ * Checks whether the user has the required permission to execute the action of {@code QueueACL}.
+ * @param acl the access type the user is checked for
+ * @param user UGI of the user
+ * @return true, if the user has permission, false otherwise
+ */
@Override
public boolean hasAccess(QueueACL acl, UserGroupInformation user) {
return authorizer.checkPermission(
@@ -319,6 +330,11 @@ public abstract class AbstractCSQueue implements CSQueue {
return this.queueNodeLabelsSettings.getDefaultLabelExpression();
}
+ /**
+ * Initialize queue properties that are based on configuration.
+ * @param clusterResource overall resource of the cluster
+ * @throws IOException if configuration is set in a way that is inconsistent
+ */
protected void setupQueueConfigs(Resource clusterResource) throws
IOException {
@@ -460,6 +476,11 @@ public abstract class AbstractCSQueue implements CSQueue {
}
}
+ /**
+ * Initializes configured minimum and maximum capacity from configuration, if capacity is defined
+ * in ABSOLUTE node.
+ * @param clusterResource overall resource of the cluster
+ */
protected void updateConfigurableResourceLimits(Resource clusterResource) {
for (String label : queueNodeLabelsSettings.getConfiguredNodeLabels()) {
final Resource minResource = getMinimumAbsoluteResource(getQueuePath(), label);
@@ -647,6 +668,13 @@ public abstract class AbstractCSQueue implements CSQueue {
return queueAllocationSettings.getMinimumAllocation();
}
+ /**
+ * Increments resource usage of the queue and all related statistics and metrics that depends on
+ * it.
+ * @param clusterResource overall cluster resource
+ * @param resource resource amount to increment
+ * @param nodePartition node label
+ */
void allocateResource(Resource clusterResource,
Resource resource, String nodePartition) {
writeLock.lock();
@@ -660,6 +688,13 @@ public abstract class AbstractCSQueue implements CSQueue {
}
}
+ /**
+ * Decrements resource usage of the queue and all related statistics and metrics that depends on
+ * it.
+ * @param clusterResource overall cluster resource
+ * @param resource resource amount to decrement
+ * @param nodePartition node label
+ */
protected void releaseResource(Resource clusterResource,
Resource resource, String nodePartition) {
writeLock.lock();
@@ -675,6 +710,10 @@ public abstract class AbstractCSQueue implements CSQueue {
}
}
+ /**
+ * Returns whether we should continue to look at all heart beating nodes even
+ * after the reservation limit was hit.
+ */
@Private
public boolean isReservationsContinueLooking() {
return reservationsContinueLooking;
@@ -759,6 +798,15 @@ public abstract class AbstractCSQueue implements CSQueue {
return childQueues != null && !childQueues.isEmpty();
}
+ /**
+ * Checks whether this queue has remaining resources left for further container assigment.
+ * @param clusterResource overall cluster resource
+ * @param nodePartition node label
+ * @param currentResourceLimits limit of the queue imposed by its maximum capacity
+ * @param resourceCouldBeUnreserved reserved resource that could potentially be unreserved
+ * @param schedulingMode scheduling strategy to handle node labels
+ * @return true if queue has remaining free resource, false otherwise
+ */
boolean canAssignToThisQueue(Resource clusterResource,
String nodePartition, ResourceLimits currentResourceLimits,
Resource resourceCouldBeUnreserved, SchedulingMode schedulingMode) {
@@ -932,10 +980,14 @@ public abstract class AbstractCSQueue implements CSQueue {
@Override
public Priority getDefaultApplicationPriority() {
- // TODO add dummy implementation
return null;
}
+ /**
+ * Returns the union of all node labels that could be accessed by this queue based on accessible
+ * node labels and configured node labels properties.
+ * @return node labels this queue has access to
+ */
@Override
public Set<String> getNodeLabelsForQueue() {
// if queue's label is *, queue can access any labels. Instead of
@@ -978,6 +1030,12 @@ public abstract class AbstractCSQueue implements CSQueue {
resourceLimits, schedulingMode);
}
+ /**
+ * Checks whether this queue could accept the container allocation request.
+ * @param cluster overall cluster resource
+ * @param request container allocation request
+ * @return true if queue could accept the container allocation request, false otherwise
+ */
@Override
public boolean accept(Resource cluster,
ResourceCommitRequest<FiCaSchedulerApp, FiCaSchedulerNode> request) {
@@ -1043,6 +1101,10 @@ public abstract class AbstractCSQueue implements CSQueue {
this.state = queueState;
}
+ /**
+ * Sets the state of this queue to RUNNING.
+ * @throws YarnException if its parent queue is not in RUNNING state
+ */
@Override
public void activateQueue() throws YarnException {
this.writeLock.lock();
@@ -1064,6 +1126,9 @@ public abstract class AbstractCSQueue implements CSQueue {
}
}
+ /**
+ * Stops this queue if no application is currently running on the queue.
+ */
protected void appFinished() {
this.writeLock.lock();
try {
@@ -1087,6 +1152,9 @@ public abstract class AbstractCSQueue implements CSQueue {
return userWeights;
}
+ /**
+ * Recursively sets the state of this queue and the state of its parent to DRAINING.
+ */
public void recoverDrainingState() {
this.writeLock.lock();
try {
@@ -1308,10 +1376,19 @@ public abstract class AbstractCSQueue implements CSQueue {
}
}
+ /**
+ * Checks whether this queue is a dynamic queue and could be deleted.
+ * @return true if the dynamic queue could be deleted, false otherwise
+ */
public boolean isEligibleForAutoDeletion() {
return false;
}
+ /**
+ * Checks whether this queue is a dynamic queue and there has not been an application submission
+ * on it for a configured period of time.
+ * @return true if queue has been idle for a configured period of time, false otherwise
+ */
public boolean isInactiveDynamicQueue() {
long idleDurationSeconds =
(Time.monotonicNow() - getLastSubmittedTimestamp())/1000;
---------------------------------------------------------------------
To unsubscribe, e-mail: common-commits-unsubscribe@hadoop.apache.org
For additional commands, e-mail: common-commits-help@hadoop.apache.org