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.reef.annotations.Provided;
022import org.apache.reef.annotations.Unstable;
023import org.apache.reef.annotations.audience.ClientSide;
024import org.apache.reef.annotations.audience.Public;
025import org.apache.reef.driver.restart.DriverRuntimeRestartManager;
026import org.apache.reef.runtime.common.driver.DriverRuntimeRestartConfiguration;
027import org.apache.reef.runtime.common.driver.EvaluatorPreserver;
028import org.apache.reef.runtime.yarn.driver.parameters.YarnEvaluatorPreserver;
029import org.apache.reef.tang.formats.ConfigurationModule;
030import org.apache.reef.tang.formats.ConfigurationModuleBuilder;
031import org.apache.reef.tang.formats.OptionalImpl;
032
033/**
034 * Use this ConfigurationModule to configure YARN-specific Restart options for the driver.
035 * <p>
036 */
037@ClientSide
038@Public
039@Provided
040@Unstable
041public final class YarnDriverRestartConfiguration extends ConfigurationModuleBuilder {
042  /**
043   * The Evaluator Preserver implementation used for YARN. Defaults to DFSEvalutorPreserver.
044   */
045  public static final OptionalImpl<EvaluatorPreserver> EVALUATOR_PRESERVER = new OptionalImpl<>();
046
047  /**
048   * This event is fired in place of the ON_DRIVER_STARTED when the Driver is in fact restarted after failure.
049   */
050  public static final ConfigurationModule CONF = new YarnDriverRestartConfiguration()
051      .bindNamedParameter(YarnEvaluatorPreserver.class, EVALUATOR_PRESERVER)
052      .bindImplementation(DriverRuntimeRestartManager.class, YarnDriverRuntimeRestartManager.class)
053      .merge(DriverRuntimeRestartConfiguration.CONF)
054      .build();
055}