Skip to content
This repository has been archived by the owner on Mar 3, 2023. It is now read-only.

Change YarnKeys to enum #1707

Merged
merged 4 commits into from
Feb 16, 2017
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Original file line number Diff line number Diff line change
Expand Up @@ -18,19 +18,17 @@
import com.twitter.heron.spi.common.Context;

public final class YarnContext extends Context {
private static final String PREFIX = "heron.scheduler.yarn.";

public static final String HERON_SCHEDULER_YARN_QUEUE = PREFIX + "queue";
public static final String YARN_SCHEDULER_DRIVER_MEMORY_MB = PREFIX + "driver.memory.mb";

private YarnContext() {
}

public static String heronYarnQueue(Config cfg) {
return cfg.getStringValue(HERON_SCHEDULER_YARN_QUEUE, "default");
return cfg.getStringValue(YarnKey.HERON_SCHEDULER_YARN_QUEUE.value(),
YarnKey.HERON_SCHEDULER_YARN_QUEUE.getDefaultString());
}

public static int heronDriverMemoryMb(Config cfg) {
return cfg.getIntegerValue(YARN_SCHEDULER_DRIVER_MEMORY_MB, 2048);
return cfg.getIntegerValue(YarnKey.YARN_SCHEDULER_DRIVER_MEMORY_MB.value(),
YarnKey.YARN_SCHEDULER_DRIVER_MEMORY_MB.getDefaultInt());
}
}
Original file line number Diff line number Diff line change
@@ -0,0 +1,67 @@
// Copyright 2017 Twitter. All rights reserved.
//
// Licensed under the Apache License, Version 2.0 (the "License");
// you may not use this file except in compliance with the License.
// You may obtain a copy of the License at
//
// http://www.apache.org/licenses/LICENSE-2.0
//
// Unless required by applicable law or agreed to in writing, software
// distributed under the License is distributed on an "AS IS" BASIS,
// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
// See the License for the specific language governing permissions and
// limitations under the License.

package com.twitter.heron.scheduler.yarn;

import com.twitter.heron.spi.common.Key;

/**
* Keys specific to the YARN scheduler
*/
public enum YarnKey {
// yarn queue for submitting and launching the topology
HERON_SCHEDULER_YARN_QUEUE("heron.scheduler.yarn.queue", "default"),
// the amount of memory topology's driver (yarn application master) needs
YARN_SCHEDULER_DRIVER_MEMORY_MB("heron.scheduler.yarn.driver.memory.mb", 2048);
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Instead of using int, can we change this to ByteAmount and drop '.mb' from the key value (see https://github.com/twitter/heron/blob/master/heron/spi/src/java/com/twitter/heron/spi/common/Key.java#L104)? We could then use ByteAmount everywhere and then call asMegabytes before adding it to the yarn config, which I suspect requires MBs.

If this would trigger a large refactor, I'm fine with shipping this as-is and following up with the ByteAmount change in it's own PR.

Copy link
Contributor Author

@mycFelix mycFelix Feb 14, 2017

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@billonahill - Thanks for reviewing. It will be great if we change driver.memory.mb from int to ByteAmount. I would like to send another PR for this. BTW, dropping '.mb' might be not good for users cause they need to know the unit of this parameter.


private final String value;
private final Key.Type type;
private final Object defaultValue;

YarnKey(String value, String defaultValue) {
this.value = value;
this.type = Key.Type.STRING;
this.defaultValue = defaultValue;
}

YarnKey(String value, Integer defaultValue) {
this.value = value;
this.type = Key.Type.INTEGER;
this.defaultValue = defaultValue;
}

public String value() {
return value;
}

public Object getDefault() {
return defaultValue;
}

public String getDefaultString() {
if (type != Key.Type.STRING) {
throw new IllegalAccessError(String.format(
"Config Key %s is type %s, getDefaultString() not supported", this.name(), this.type));
}
return (String) this.defaultValue;
}

public int getDefaultInt() {
if (type != Key.Type.INTEGER) {
throw new IllegalAccessError(String.format(
"Config Key %s is type %s, getDefaultInt() not supported", this.name(), this.type));
}
return (Integer) this.defaultValue;
}
}
Original file line number Diff line number Diff line change
Expand Up @@ -67,8 +67,9 @@ public void getHMDriverConfConstructsReefConfig() throws Exception {
setConfigs(inputConf, expected, Key.CLUSTER, "cluster", Cluster.class);
setConfigs(inputConf, expected, Key.ROLE, "role", Role.class);
setConfigs(inputConf, expected, Key.ENVIRON, "env", Environ.class);
setConfigs(inputConf, expected, YarnContext.HERON_SCHEDULER_YARN_QUEUE, "q", JobQueue.class);
setConfigs(inputConf, expected, YarnContext.YARN_SCHEDULER_DRIVER_MEMORY_MB,
setConfigs(inputConf, expected, YarnKey.HERON_SCHEDULER_YARN_QUEUE.value(),
"q", JobQueue.class);
setConfigs(inputConf, expected, YarnKey.YARN_SCHEDULER_DRIVER_MEMORY_MB.value(),
"123", DriverMemory.class);
setConfigs(inputConf, expected, Key.CORE_PACKAGE_URI,
new File(".").getName(), HeronCorePackageName.class);
Expand Down