org.apache.samza.config

Class YarnConfig

java.lang.Object

org.apache.samza.config.Config

org.apache.samza.config.MapConfig

org.apache.samza.config.YarnConfig

All Implemented Interfaces:

java.util.Map<java.lang.String,java.lang.String>

public class YarnConfig
extends org.apache.samza.config.MapConfig

Nested Class Summary

Nested classes/interfaces inherited from interface java.util.Map

java.util.Map.Entry<K,V>

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	ALLOCATOR_SLEEP_MS Sleep interval for the allocator thread in milliseconds
static java.lang.String	AM_CONTAINER_LABEL Label to request from YARN for running the AM
static java.lang.String	AM_CONTAINER_MAX_CPU_CORES Number of CPU cores to request from YARN for running the AM
static java.lang.String	AM_CONTAINER_MAX_MEMORY_MB Memory, in megabytes, to request from YARN for running the AM
static java.lang.String	AM_JAVA_HOME (Optional) JAVA_HOME path for Samza AM
static java.lang.String	AM_JMX_ENABLED Determines whether a JMX server should be started on the AM Default: true
static java.lang.String	AM_JVM_OPTIONS (Optional) JVM options to include in the command line when executing the AM
static java.lang.String	AM_POLL_INTERVAL_MS Determines the interval for the Heartbeat between the AM and the Yarn RM
static java.lang.String	CONTAINER_LABEL Label to request from YARN for containers
static java.lang.String	CONTAINER_REQUEST_TIMEOUT_MS Number of milliseconds before a container request is considered to have to expired
static java.lang.String	HOST_AFFINITY_ENABLED Flag to indicate if host-affinity is enabled for the job or not
static java.lang.String	PACKAGE_PATH (Required) URL from which the job package can be downloaded
static java.lang.String	QUEUE_NAME Name of YARN queue to run jobs on
static java.lang.String	YARN_CREDENTIALS_FILE The location on HDFS to store the credentials file
static java.lang.String	YARN_JOB_STAGING_DIRECTORY The staging directory on HDFS for the job
static java.lang.String	YARN_KERBEROS_KEYTAB Key tab used to log in on a Kerberized secure cluster
static java.lang.String	YARN_KERBEROS_PRINCIPAL Principal used to log in on a Kerberized secure cluster
static java.lang.String	YARN_TOKEN_RENEWAL_INTERVAL_SECONDS Interval in seconds to renew a delegation token in Kerberized secure cluster

Fields inherited from class org.apache.samza.config.Config

SENSITIVE_MASK, SENSITIVE_PREFIX

Constructor Summary

Constructors

Constructor and Description
YarnConfig(org.apache.samza.config.Config config)

Method Summary

Modifier and Type	Method and Description
int	getAllocatorSleepTime()
java.lang.String	getAMContainerLabel()
int	getAMContainerMaxCpuCores()
int	getAMContainerMaxMemoryMb()
java.lang.String	getAMJavaHome()
java.lang.String	getAmOpts()
int	getAMPollIntervalMs()
java.lang.String	getContainerLabel()
int	getContainerRequestTimeout()
boolean	getHostAffinityEnabled()
boolean	getJmxServerEnabled()
java.lang.String	getPackagePath()
java.lang.String	getQueueName()
java.lang.String	getYarnCredentialsFile()
java.lang.String	getYarnJobStagingDirectory()
java.lang.String	getYarnKerberosKeytab()
java.lang.String	getYarnKerberosPrincipal()
long	getYarnTokenRenewalIntervalSeconds()

Methods inherited from class org.apache.samza.config.MapConfig

containsKey, containsValue, entrySet, equals, get, hashCode, isEmpty, keySet, sanitize, size, toString, values

Methods inherited from class org.apache.samza.config.Config

clear, get, getBoolean, getBoolean, getClass, getDate, getDate, getDate, getDate, getDate, getDate, getDouble, getDouble, getInt, getInt, getList, getList, getLong, getLong, getNewInstance, getShort, getShort, put, putAll, regexSubset, remove, subset, subset

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface java.util.Map

compute, computeIfAbsent, computeIfPresent, forEach, getOrDefault, merge, putIfAbsent, remove, replace, replace, replaceAll

Field Detail

PACKAGE_PATH

public static final java.lang.String PACKAGE_PATH

(Required) URL from which the job package can be downloaded

See Also:

Constant Field Values

QUEUE_NAME

public static final java.lang.String QUEUE_NAME

Name of YARN queue to run jobs on

See Also:

Constant Field Values

CONTAINER_LABEL

public static final java.lang.String CONTAINER_LABEL

Label to request from YARN for containers

See Also:

Constant Field Values

AM_JVM_OPTIONS

public static final java.lang.String AM_JVM_OPTIONS

(Optional) JVM options to include in the command line when executing the AM

See Also:

Constant Field Values

AM_JMX_ENABLED

public static final java.lang.String AM_JMX_ENABLED

Determines whether a JMX server should be started on the AM Default: true

See Also:

Constant Field Values

AM_CONTAINER_MAX_MEMORY_MB

public static final java.lang.String AM_CONTAINER_MAX_MEMORY_MB

Memory, in megabytes, to request from YARN for running the AM

See Also:

Constant Field Values

AM_CONTAINER_LABEL

public static final java.lang.String AM_CONTAINER_LABEL

Label to request from YARN for running the AM

See Also:

Constant Field Values

AM_CONTAINER_MAX_CPU_CORES

public static final java.lang.String AM_CONTAINER_MAX_CPU_CORES

Number of CPU cores to request from YARN for running the AM

See Also:

Constant Field Values

AM_POLL_INTERVAL_MS

public static final java.lang.String AM_POLL_INTERVAL_MS

Determines the interval for the Heartbeat between the AM and the Yarn RM

See Also:

Constant Field Values

AM_JAVA_HOME

public static final java.lang.String AM_JAVA_HOME

(Optional) JAVA_HOME path for Samza AM

See Also:

Constant Field Values

ALLOCATOR_SLEEP_MS

public static final java.lang.String ALLOCATOR_SLEEP_MS

Sleep interval for the allocator thread in milliseconds

See Also:

Constant Field Values

CONTAINER_REQUEST_TIMEOUT_MS

public static final java.lang.String CONTAINER_REQUEST_TIMEOUT_MS

Number of milliseconds before a container request is considered to have to expired

See Also:

Constant Field Values

HOST_AFFINITY_ENABLED

public static final java.lang.String HOST_AFFINITY_ENABLED

Flag to indicate if host-affinity is enabled for the job or not

See Also:

Constant Field Values

YARN_KERBEROS_PRINCIPAL

public static final java.lang.String YARN_KERBEROS_PRINCIPAL

Principal used to log in on a Kerberized secure cluster

See Also:

Constant Field Values

YARN_KERBEROS_KEYTAB

public static final java.lang.String YARN_KERBEROS_KEYTAB

Key tab used to log in on a Kerberized secure cluster

See Also:

Constant Field Values

YARN_TOKEN_RENEWAL_INTERVAL_SECONDS

public static final java.lang.String YARN_TOKEN_RENEWAL_INTERVAL_SECONDS

Interval in seconds to renew a delegation token in Kerberized secure cluster

See Also:

Constant Field Values

YARN_CREDENTIALS_FILE

public static final java.lang.String YARN_CREDENTIALS_FILE

The location on HDFS to store the credentials file

See Also:

Constant Field Values

YARN_JOB_STAGING_DIRECTORY

public static final java.lang.String YARN_JOB_STAGING_DIRECTORY

The staging directory on HDFS for the job

See Also:

Constant Field Values

Constructor Detail

YarnConfig

public YarnConfig(org.apache.samza.config.Config config)

Method Detail

getAMPollIntervalMs

public int getAMPollIntervalMs()

getContainerLabel

public java.lang.String getContainerLabel()

getJmxServerEnabled

public boolean getJmxServerEnabled()

getPackagePath

public java.lang.String getPackagePath()

getAMContainerMaxMemoryMb

public int getAMContainerMaxMemoryMb()

getAMContainerLabel

public java.lang.String getAMContainerLabel()

getAMContainerMaxCpuCores

public int getAMContainerMaxCpuCores()

getAmOpts

public java.lang.String getAmOpts()

getQueueName

public java.lang.String getQueueName()

getAMJavaHome

public java.lang.String getAMJavaHome()

getAllocatorSleepTime

public int getAllocatorSleepTime()

getContainerRequestTimeout

public int getContainerRequestTimeout()

getHostAffinityEnabled

public boolean getHostAffinityEnabled()

getYarnKerberosPrincipal

public java.lang.String getYarnKerberosPrincipal()

getYarnKerberosKeytab

public java.lang.String getYarnKerberosKeytab()

getYarnTokenRenewalIntervalSeconds

public long getYarnTokenRenewalIntervalSeconds()

getYarnCredentialsFile

public java.lang.String getYarnCredentialsFile()

getYarnJobStagingDirectory

public java.lang.String getYarnJobStagingDirectory()