Source code

001/*
002 * Licensed to the Apache Software Foundation (ASF) under one
003 * or more contributor license agreements.  See the NOTICE file
004 * distributed with this work for additional information
005 * regarding copyright ownership.  The ASF licenses this file
006 * to you under the Apache License, Version 2.0 (the
007 * "License"); you may not use this file except in compliance
008 * with the License.  You may obtain a copy of the License at
009 *
010 *   http://www.apache.org/licenses/LICENSE-2.0
011 *
012 * Unless required by applicable law or agreed to in writing,
013 * software distributed under the License is distributed on an
014 * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
015 * KIND, either express or implied.  See the License for the
016 * specific language governing permissions and limitations
017 * under the License.
018 */
019package org.apache.reef.runtime.yarn.driver;
020
021import org.apache.hadoop.yarn.conf.YarnConfiguration;
022import org.apache.reef.io.TempFileCreator;
023import org.apache.reef.io.WorkingDirectoryTempFileCreator;
024import org.apache.reef.runtime.common.driver.api.*;
025import org.apache.reef.runtime.common.driver.parameters.ClientRemoteIdentifier;
026import org.apache.reef.runtime.common.driver.parameters.EvaluatorTimeout;
027import org.apache.reef.runtime.common.driver.parameters.JobIdentifier;
028import org.apache.reef.runtime.common.files.RuntimeClasspathProvider;
029import org.apache.reef.runtime.common.launch.parameters.ErrorHandlerRID;
030import org.apache.reef.runtime.common.launch.parameters.LaunchID;
031import org.apache.reef.runtime.common.parameters.JVMHeapSlack;
032import org.apache.reef.runtime.yarn.YarnClasspathProvider;
033import org.apache.reef.runtime.yarn.driver.parameters.JobSubmissionDirectory;
034import org.apache.reef.runtime.yarn.driver.parameters.YarnHeartbeatPeriod;
035import org.apache.reef.runtime.yarn.util.YarnConfigurationConstructor;
036import org.apache.reef.tang.formats.*;
037
038/**
039 * ConfigurationModule to create YARN Driver configurations.
040 */
041public class YarnDriverConfiguration extends ConfigurationModuleBuilder {
042  /**
043   * @see org.apache.reef.driver.parameters.JobSubmissionDirectory
044   */
045  public static final RequiredParameter<String> JOB_SUBMISSION_DIRECTORY = new RequiredParameter<>();
046
047  /**
048   * @see org.apache.reef.runtime.yarn.driver.parameters.YarnHeartbeatPeriod
049   */
050  public static final OptionalParameter<Integer> YARN_HEARTBEAT_INTERVAL = new OptionalParameter<>();
051
052  /**
053   * @see JobIdentifier
054   */
055  public static final RequiredParameter<String> JOB_IDENTIFIER = new RequiredParameter<>();
056
057  /**
058   * @see RackNameFormatter
059   */
060  public static final OptionalImpl<RackNameFormatter> RACK_NAME_FORMATTER = new OptionalImpl<>();
061
062  /**
063   * @see EvaluatorTimeout
064   */
065  public static final OptionalParameter<Long> EVALUATOR_TIMEOUT = new OptionalParameter<>();
066
067  /**
068   * The client remote identifier.
069   */
070  public static final OptionalParameter<String> CLIENT_REMOTE_IDENTIFIER = new OptionalParameter<>();
071
072  /**
073   * The fraction of the container memory NOT to use for the Java Heap.
074   */
075  public static final OptionalParameter<Double> JVM_HEAP_SLACK = new OptionalParameter<>();
076
077
078  public static final ConfigurationModule CONF = new YarnDriverConfiguration()
079      // Bind the YARN runtime for the resource manager.
080      .bindImplementation(ResourceLaunchHandler.class, YARNResourceLaunchHandler.class)
081      .bindImplementation(ResourceReleaseHandler.class, YARNResourceReleaseHandler.class)
082      .bindImplementation(ResourceRequestHandler.class, YarnResourceRequestHandler.class)
083      .bindImplementation(ResourceManagerStartHandler.class, YARNRuntimeStartHandler.class)
084      .bindImplementation(ResourceManagerStopHandler.class, YARNRuntimeStopHandler.class)
085      .bindConstructor(YarnConfiguration.class, YarnConfigurationConstructor.class)
086      .bindImplementation(TempFileCreator.class, WorkingDirectoryTempFileCreator.class)
087
088      // Bind the YARN Configuration parameters
089      // TODO[JIRA REEF-904]: Act on deprecated JobSubmissionDirectory and JOB_SUBMISSION_DIRECTORY
090      .bindNamedParameter(org.apache.reef.driver.parameters.JobSubmissionDirectory.class, JOB_SUBMISSION_DIRECTORY)
091      .bindNamedParameter(JobSubmissionDirectory.class, JOB_SUBMISSION_DIRECTORY)
092      .bindNamedParameter(YarnHeartbeatPeriod.class, YARN_HEARTBEAT_INTERVAL)
093
094      // Bind the fields bound in AbstractDriverRuntimeConfiguration
095      .bindNamedParameter(JobIdentifier.class, JOB_IDENTIFIER)
096      .bindNamedParameter(LaunchID.class, JOB_IDENTIFIER)
097      .bindNamedParameter(EvaluatorTimeout.class, EVALUATOR_TIMEOUT)
098      .bindNamedParameter(ClientRemoteIdentifier.class, CLIENT_REMOTE_IDENTIFIER)
099      .bindNamedParameter(ErrorHandlerRID.class, CLIENT_REMOTE_IDENTIFIER)
100      .bindNamedParameter(JVMHeapSlack.class, JVM_HEAP_SLACK)
101      .bindImplementation(RackNameFormatter.class, RACK_NAME_FORMATTER)
102      .bindImplementation(RuntimeClasspathProvider.class, YarnClasspathProvider.class)
103      .build();
104}