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, software
013* distributed under the License is distributed on an "AS IS" BASIS,
014* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
015* See the License for the specific language governing permissions and
016* limitations under the License.
017*/
018
019package org.apache.hadoop.yarn.conf;
020
021import java.net.InetSocketAddress;
022import java.util.Arrays;
023import java.util.Collections;
024import java.util.List;
025
026import org.apache.hadoop.HadoopIllegalArgumentException;
027import org.apache.hadoop.classification.InterfaceAudience.Private;
028import org.apache.hadoop.classification.InterfaceAudience.Public;
029import org.apache.hadoop.classification.InterfaceStability.Evolving;
030import org.apache.hadoop.classification.InterfaceStability.Unstable;
031import org.apache.hadoop.conf.Configuration;
032import org.apache.hadoop.http.HttpConfig;
033import org.apache.hadoop.net.NetUtils;
034import org.apache.hadoop.util.StringUtils;
035import org.apache.hadoop.yarn.api.ApplicationConstants;
036
037@Public
038@Evolving
039public class YarnConfiguration extends Configuration {
040
041  @Private
042  public static final String DR_CONFIGURATION_FILE= "dynamic-resources.xml";
043
044  @Private
045  public static final String CS_CONFIGURATION_FILE= "capacity-scheduler.xml";
046
047  @Private
048  public static final String HADOOP_POLICY_CONFIGURATION_FILE =
049      "hadoop-policy.xml";
050
051  @Private
052  public static final String YARN_SITE_CONFIGURATION_FILE = "yarn-site.xml";
053
054  private static final String YARN_DEFAULT_CONFIGURATION_FILE =
055      "yarn-default.xml";
056
057  @Private
058  public static final String CORE_SITE_CONFIGURATION_FILE = "core-site.xml";
059
060  @Private
061  public static final List<String> RM_CONFIGURATION_FILES =
062      Collections.unmodifiableList(Arrays.asList(
063          DR_CONFIGURATION_FILE,
064          CS_CONFIGURATION_FILE,
065          HADOOP_POLICY_CONFIGURATION_FILE,
066          YARN_SITE_CONFIGURATION_FILE,
067          CORE_SITE_CONFIGURATION_FILE));
068
069  @Evolving
070  public static final int APPLICATION_MAX_TAGS = 10;
071
072  @Evolving
073  public static final int APPLICATION_MAX_TAG_LENGTH = 100;
074
075  static {
076    addDeprecatedKeys();
077    Configuration.addDefaultResource(YARN_DEFAULT_CONFIGURATION_FILE);
078    Configuration.addDefaultResource(YARN_SITE_CONFIGURATION_FILE);
079  }
080
081  private static void addDeprecatedKeys() {
082    Configuration.addDeprecations(new DeprecationDelta[] {
083        new DeprecationDelta("yarn.client.max-nodemanagers-proxies",
084            NM_CLIENT_MAX_NM_PROXIES)
085    });
086  }
087
088  //Configurations
089
090  public static final String YARN_PREFIX = "yarn.";
091
092  /** Delay before deleting resource to ease debugging of NM issues */
093  public static final String DEBUG_NM_DELETE_DELAY_SEC =
094    YarnConfiguration.NM_PREFIX + "delete.debug-delay-sec";
095
096  public static final String NM_LOG_CONTAINER_DEBUG_INFO =
097      YarnConfiguration.NM_PREFIX + "log-container-debug-info.enabled";
098
099  public static final boolean DEFAULT_NM_LOG_CONTAINER_DEBUG_INFO = false;
100  
101  ////////////////////////////////
102  // IPC Configs
103  ////////////////////////////////
104  public static final String IPC_PREFIX = YARN_PREFIX + "ipc.";
105
106  /** Factory to create client IPC classes.*/
107  public static final String IPC_CLIENT_FACTORY_CLASS =
108    IPC_PREFIX + "client.factory.class";
109  public static final String DEFAULT_IPC_CLIENT_FACTORY_CLASS = 
110      "org.apache.hadoop.yarn.factories.impl.pb.RpcClientFactoryPBImpl";
111
112  /** Factory to create server IPC classes.*/
113  public static final String IPC_SERVER_FACTORY_CLASS = 
114    IPC_PREFIX + "server.factory.class";
115  public static final String DEFAULT_IPC_SERVER_FACTORY_CLASS = 
116      "org.apache.hadoop.yarn.factories.impl.pb.RpcServerFactoryPBImpl";
117
118  /** Factory to create serializeable records.*/
119  public static final String IPC_RECORD_FACTORY_CLASS = 
120    IPC_PREFIX + "record.factory.class";
121  public static final String DEFAULT_IPC_RECORD_FACTORY_CLASS = 
122      "org.apache.hadoop.yarn.factories.impl.pb.RecordFactoryPBImpl";
123
124  /** RPC class implementation*/
125  public static final String IPC_RPC_IMPL =
126    IPC_PREFIX + "rpc.class";
127  public static final String DEFAULT_IPC_RPC_IMPL = 
128    "org.apache.hadoop.yarn.ipc.HadoopYarnProtoRPC";
129  
130  ////////////////////////////////
131  // Resource Manager Configs
132  ////////////////////////////////
133  public static final String RM_PREFIX = "yarn.resourcemanager.";
134
135  public static final String RM_CLUSTER_ID = RM_PREFIX + "cluster-id";
136
137  public static final String RM_HOSTNAME = RM_PREFIX + "hostname";
138
139  /** The address of the applications manager interface in the RM.*/
140  public static final String RM_ADDRESS = 
141    RM_PREFIX + "address";
142  public static final int DEFAULT_RM_PORT = 8032;
143  public static final String DEFAULT_RM_ADDRESS =
144    "0.0.0.0:" + DEFAULT_RM_PORT;
145
146  /** The actual bind address for the RM.*/
147  public static final String RM_BIND_HOST =
148    RM_PREFIX + "bind-host";
149
150  /** The number of threads used to handle applications manager requests.*/
151  public static final String RM_CLIENT_THREAD_COUNT =
152    RM_PREFIX + "client.thread-count";
153  public static final int DEFAULT_RM_CLIENT_THREAD_COUNT = 50;
154
155  /** Number of threads used to launch/cleanup AM.*/
156  public static final String RM_AMLAUNCHER_THREAD_COUNT =
157      RM_PREFIX + "amlauncher.thread-count";
158  public static final int DEFAULT_RM_AMLAUNCHER_THREAD_COUNT = 50;
159
160  /** Retry times to connect with NM.*/
161  public static final String RM_NODEMANAGER_CONNECT_RETRIES =
162      RM_PREFIX + "nodemanager-connect-retries";
163  public static final int DEFAULT_RM_NODEMANAGER_CONNECT_RETRIES = 10;
164
165  /** The Kerberos principal for the resource manager.*/
166  public static final String RM_PRINCIPAL =
167    RM_PREFIX + "principal";
168  
169  /** The address of the scheduler interface.*/
170  public static final String RM_SCHEDULER_ADDRESS = 
171    RM_PREFIX + "scheduler.address";
172  public static final int DEFAULT_RM_SCHEDULER_PORT = 8030;
173  public static final String DEFAULT_RM_SCHEDULER_ADDRESS = "0.0.0.0:" +
174    DEFAULT_RM_SCHEDULER_PORT;
175
176  /** Miniumum request grant-able by the RM scheduler. */
177  public static final String RM_SCHEDULER_MINIMUM_ALLOCATION_MB =
178    YARN_PREFIX + "scheduler.minimum-allocation-mb";
179  public static final int DEFAULT_RM_SCHEDULER_MINIMUM_ALLOCATION_MB = 1024;
180  public static final String RM_SCHEDULER_MINIMUM_ALLOCATION_VCORES =
181      YARN_PREFIX + "scheduler.minimum-allocation-vcores";
182    public static final int DEFAULT_RM_SCHEDULER_MINIMUM_ALLOCATION_VCORES = 1;
183
184  /** Maximum request grant-able by the RM scheduler. */
185  public static final String RM_SCHEDULER_MAXIMUM_ALLOCATION_MB =
186    YARN_PREFIX + "scheduler.maximum-allocation-mb";
187  public static final int DEFAULT_RM_SCHEDULER_MAXIMUM_ALLOCATION_MB = 8192;
188  public static final String RM_SCHEDULER_MAXIMUM_ALLOCATION_VCORES =
189      YARN_PREFIX + "scheduler.maximum-allocation-vcores";
190  public static final int DEFAULT_RM_SCHEDULER_MAXIMUM_ALLOCATION_VCORES = 4;
191
192  /** Number of threads to handle scheduler interface.*/
193  public static final String RM_SCHEDULER_CLIENT_THREAD_COUNT =
194    RM_PREFIX + "scheduler.client.thread-count";
195  public static final int DEFAULT_RM_SCHEDULER_CLIENT_THREAD_COUNT = 50;
196
197  /** If the port should be included or not in the node name. The node name
198   * is used by the scheduler for resource requests allocation location 
199   * matching. Typically this is just the hostname, using the port is needed
200   * when using minicluster and specific NM are required.*/
201  public static final String RM_SCHEDULER_INCLUDE_PORT_IN_NODE_NAME =
202      YARN_PREFIX + "scheduler.include-port-in-node-name";
203  public static final boolean DEFAULT_RM_SCHEDULER_USE_PORT_FOR_NODE_NAME = 
204      false;
205
206  /** Enable Resource Manager webapp ui actions */
207  public static final String RM_WEBAPP_UI_ACTIONS_ENABLED =
208    RM_PREFIX + "webapp.ui-actions.enabled";
209  public static final boolean DEFAULT_RM_WEBAPP_UI_ACTIONS_ENABLED =
210    true;
211
212  /** Whether the RM should enable Reservation System */
213  public static final String RM_RESERVATION_SYSTEM_ENABLE = RM_PREFIX
214      + "reservation-system.enable";
215  public static final boolean DEFAULT_RM_RESERVATION_SYSTEM_ENABLE = false;
216
217  /** The class to use as the Reservation System. */
218  public static final String RM_RESERVATION_SYSTEM_CLASS = RM_PREFIX
219      + "reservation-system.class";
220
221  /** The PlanFollower for the Reservation System. */
222  public static final String RM_RESERVATION_SYSTEM_PLAN_FOLLOWER = RM_PREFIX
223      + "reservation-system.plan.follower";
224
225  /** The step size of the Reservation System. */
226  public static final String RM_RESERVATION_SYSTEM_PLAN_FOLLOWER_TIME_STEP =
227      RM_PREFIX + "reservation-system.planfollower.time-step";
228  public static final long DEFAULT_RM_RESERVATION_SYSTEM_PLAN_FOLLOWER_TIME_STEP =
229      1000L;
230
231  /**
232   * Enable periodic monitor threads.
233   * @see #RM_SCHEDULER_MONITOR_POLICIES
234   */
235  public static final String RM_SCHEDULER_ENABLE_MONITORS =
236    RM_PREFIX + "scheduler.monitor.enable";
237  public static final boolean DEFAULT_RM_SCHEDULER_ENABLE_MONITORS = false;
238
239  /** List of SchedulingEditPolicy classes affecting the scheduler. */
240  public static final String RM_SCHEDULER_MONITOR_POLICIES =
241    RM_PREFIX + "scheduler.monitor.policies";
242
243  /** The address of the RM web application.*/
244  public static final String RM_WEBAPP_ADDRESS = 
245    RM_PREFIX + "webapp.address";
246
247  public static final int DEFAULT_RM_WEBAPP_PORT = 8088;
248  public static final String DEFAULT_RM_WEBAPP_ADDRESS = "0.0.0.0:" +
249    DEFAULT_RM_WEBAPP_PORT;
250  
251  /** The https address of the RM web application.*/
252  public static final String RM_WEBAPP_HTTPS_ADDRESS =
253      RM_PREFIX + "webapp.https.address";
254  public static final boolean YARN_SSL_CLIENT_HTTPS_NEED_AUTH_DEFAULT = false;
255  public static final String YARN_SSL_SERVER_RESOURCE_DEFAULT = "ssl-server.xml";
256  
257  public static final int DEFAULT_RM_WEBAPP_HTTPS_PORT = 8090;
258  public static final String DEFAULT_RM_WEBAPP_HTTPS_ADDRESS = "0.0.0.0:"
259      + DEFAULT_RM_WEBAPP_HTTPS_PORT;
260  
261  public static final String RM_RESOURCE_TRACKER_ADDRESS =
262    RM_PREFIX + "resource-tracker.address";
263  public static final int DEFAULT_RM_RESOURCE_TRACKER_PORT = 8031;
264  public static final String DEFAULT_RM_RESOURCE_TRACKER_ADDRESS =
265    "0.0.0.0:" + DEFAULT_RM_RESOURCE_TRACKER_PORT;
266
267  /** The expiry interval for application master reporting.*/
268  public static final String RM_AM_EXPIRY_INTERVAL_MS = 
269    YARN_PREFIX  + "am.liveness-monitor.expiry-interval-ms";
270  public static final int DEFAULT_RM_AM_EXPIRY_INTERVAL_MS = 600000;
271
272  /** How long to wait until a node manager is considered dead.*/
273  public static final String RM_NM_EXPIRY_INTERVAL_MS = 
274    YARN_PREFIX + "nm.liveness-monitor.expiry-interval-ms";
275  public static final int DEFAULT_RM_NM_EXPIRY_INTERVAL_MS = 600000;
276
277  /** Are acls enabled.*/
278  public static final String YARN_ACL_ENABLE = 
279    YARN_PREFIX + "acl.enable";
280  public static final boolean DEFAULT_YARN_ACL_ENABLE = false;
281
282  /** Are reservation acls enabled.*/
283  public static final String YARN_RESERVATION_ACL_ENABLE =
284          YARN_PREFIX + "acl.reservation-enable";
285  public static final boolean DEFAULT_YARN_RESERVATION_ACL_ENABLE = false;
286
287  public static boolean isAclEnabled(Configuration conf) {
288    return conf.getBoolean(YARN_ACL_ENABLE, DEFAULT_YARN_ACL_ENABLE);
289  }
290
291  /** ACL of who can be admin of YARN cluster.*/
292  public static final String YARN_ADMIN_ACL = 
293    YARN_PREFIX + "admin.acl";
294  public static final String DEFAULT_YARN_ADMIN_ACL = "*";
295  
296  /** ACL used in case none is found. Allows nothing. */
297  public static final String DEFAULT_YARN_APP_ACL = " ";
298
299  /**
300   * Enable/disable intermediate-data encryption at YARN level. For now, this
301   * only is used by the FileSystemRMStateStore to setup right file-system
302   * security attributes.
303   */
304  @Private
305  public static final String YARN_INTERMEDIATE_DATA_ENCRYPTION = YARN_PREFIX
306      + "intermediate-data-encryption.enable";
307
308  @Private
309  public static final boolean DEFAULT_YARN_INTERMEDIATE_DATA_ENCRYPTION = false;
310
311  /** The address of the RM admin interface.*/
312  public static final String RM_ADMIN_ADDRESS = 
313    RM_PREFIX + "admin.address";
314  public static final int DEFAULT_RM_ADMIN_PORT = 8033;
315  public static final String DEFAULT_RM_ADMIN_ADDRESS = "0.0.0.0:" +
316      DEFAULT_RM_ADMIN_PORT;
317  
318  /**Number of threads used to handle RM admin interface.*/
319  public static final String RM_ADMIN_CLIENT_THREAD_COUNT =
320    RM_PREFIX + "admin.client.thread-count";
321  public static final int DEFAULT_RM_ADMIN_CLIENT_THREAD_COUNT = 1;
322  
323  /**
324   * The maximum number of application attempts.
325   * It's a global setting for all application masters.
326   */
327  public static final String RM_AM_MAX_ATTEMPTS =
328    RM_PREFIX + "am.max-attempts";
329  public static final int DEFAULT_RM_AM_MAX_ATTEMPTS = 2;
330  
331  /** The keytab for the resource manager.*/
332  public static final String RM_KEYTAB = 
333    RM_PREFIX + "keytab";
334
335  /**The kerberos principal to be used for spnego filter for RM.*/
336  public static final String RM_WEBAPP_SPNEGO_USER_NAME_KEY =
337      RM_PREFIX + "webapp.spnego-principal";
338  
339  /**The kerberos keytab to be used for spnego filter for RM.*/
340  public static final String RM_WEBAPP_SPNEGO_KEYTAB_FILE_KEY =
341      RM_PREFIX + "webapp.spnego-keytab-file";
342
343  /**
344   * Flag to enable override of the default kerberos authentication filter with
345   * the RM authentication filter to allow authentication using delegation
346   * tokens(fallback to kerberos if the tokens are missing). Only applicable
347   * when the http authentication type is kerberos.
348   */
349  public static final String RM_WEBAPP_DELEGATION_TOKEN_AUTH_FILTER = RM_PREFIX
350      + "webapp.delegation-token-auth-filter.enabled";
351  public static final boolean DEFAULT_RM_WEBAPP_DELEGATION_TOKEN_AUTH_FILTER =
352      true;
353
354  /** Enable cross origin (CORS) support. **/
355  public static final String RM_WEBAPP_ENABLE_CORS_FILTER =
356      RM_PREFIX + "webapp.cross-origin.enabled";
357  public static final boolean DEFAULT_RM_WEBAPP_ENABLE_CORS_FILTER = false;
358
359  /** How long to wait until a container is considered dead.*/
360  public static final String RM_CONTAINER_ALLOC_EXPIRY_INTERVAL_MS = 
361    RM_PREFIX + "rm.container-allocation.expiry-interval-ms";
362  public static final int DEFAULT_RM_CONTAINER_ALLOC_EXPIRY_INTERVAL_MS = 600000;
363  
364  /** Path to file with nodes to include.*/
365  public static final String RM_NODES_INCLUDE_FILE_PATH = 
366    RM_PREFIX + "nodes.include-path";
367  public static final String DEFAULT_RM_NODES_INCLUDE_FILE_PATH = "";
368  
369  /** Path to file with nodes to exclude.*/
370  public static final String RM_NODES_EXCLUDE_FILE_PATH = 
371    RM_PREFIX + "nodes.exclude-path";
372  public static final String DEFAULT_RM_NODES_EXCLUDE_FILE_PATH = "";
373  
374  /** Number of threads to handle resource tracker calls.*/
375  public static final String RM_RESOURCE_TRACKER_CLIENT_THREAD_COUNT =
376    RM_PREFIX + "resource-tracker.client.thread-count";
377  public static final int DEFAULT_RM_RESOURCE_TRACKER_CLIENT_THREAD_COUNT = 50;
378  
379  /** The class to use as the resource scheduler.*/
380  public static final String RM_SCHEDULER = 
381    RM_PREFIX + "scheduler.class";
382 
383  public static final String DEFAULT_RM_SCHEDULER = 
384      "org.apache.hadoop.yarn.server.resourcemanager.scheduler.capacity.CapacityScheduler";
385
386  /** RM set next Heartbeat interval for NM */
387  public static final String RM_NM_HEARTBEAT_INTERVAL_MS =
388      RM_PREFIX + "nodemanagers.heartbeat-interval-ms";
389  public static final long DEFAULT_RM_NM_HEARTBEAT_INTERVAL_MS = 1000;
390
391  /** Number of worker threads that write the history data. */
392  public static final String RM_HISTORY_WRITER_MULTI_THREADED_DISPATCHER_POOL_SIZE =
393      RM_PREFIX + "history-writer.multi-threaded-dispatcher.pool-size";
394  public static final int DEFAULT_RM_HISTORY_WRITER_MULTI_THREADED_DISPATCHER_POOL_SIZE =
395      10;
396
397  /**
398   *  The setting that controls whether yarn system metrics is published on the
399   *  timeline server or not by RM.
400   */
401  public static final String RM_SYSTEM_METRICS_PUBLISHER_ENABLED =
402      RM_PREFIX + "system-metrics-publisher.enabled";
403  public static final boolean DEFAULT_RM_SYSTEM_METRICS_PUBLISHER_ENABLED = false;
404
405  public static final String RM_SYSTEM_METRICS_PUBLISHER_DISPATCHER_POOL_SIZE =
406      RM_PREFIX + "system-metrics-publisher.dispatcher.pool-size";
407  public static final int DEFAULT_RM_SYSTEM_METRICS_PUBLISHER_DISPATCHER_POOL_SIZE =
408      10;
409
410  //RM delegation token related keys
411  public static final String RM_DELEGATION_KEY_UPDATE_INTERVAL_KEY =
412    RM_PREFIX + "delegation.key.update-interval";
413  public static final long RM_DELEGATION_KEY_UPDATE_INTERVAL_DEFAULT =
414    24*60*60*1000; // 1 day
415  public static final String RM_DELEGATION_TOKEN_RENEW_INTERVAL_KEY =
416    RM_PREFIX + "delegation.token.renew-interval";
417  public static final long RM_DELEGATION_TOKEN_RENEW_INTERVAL_DEFAULT =
418    24*60*60*1000;  // 1 day
419  public static final String RM_DELEGATION_TOKEN_MAX_LIFETIME_KEY =
420     RM_PREFIX + "delegation.token.max-lifetime";
421  public static final long RM_DELEGATION_TOKEN_MAX_LIFETIME_DEFAULT =
422    7*24*60*60*1000; // 7 days
423  
424  public static final String RECOVERY_ENABLED = RM_PREFIX + "recovery.enabled";
425  public static final boolean DEFAULT_RM_RECOVERY_ENABLED = false;
426
427  public static final String YARN_FAIL_FAST = YARN_PREFIX + "fail-fast";
428  public static final boolean DEFAULT_YARN_FAIL_FAST = false;
429
430  public static final String RM_FAIL_FAST = RM_PREFIX + "fail-fast";
431
432  @Private
433  public static final String RM_WORK_PRESERVING_RECOVERY_ENABLED = RM_PREFIX
434      + "work-preserving-recovery.enabled";
435  @Private
436  public static final boolean DEFAULT_RM_WORK_PRESERVING_RECOVERY_ENABLED =
437      true;
438
439  public static final String RM_WORK_PRESERVING_RECOVERY_SCHEDULING_WAIT_MS =
440      RM_PREFIX + "work-preserving-recovery.scheduling-wait-ms";
441  public static final long DEFAULT_RM_WORK_PRESERVING_RECOVERY_SCHEDULING_WAIT_MS =
442      10000;
443
444  /** Zookeeper interaction configs */
445  public static final String RM_ZK_PREFIX = RM_PREFIX + "zk-";
446
447  public static final String RM_ZK_ADDRESS = RM_ZK_PREFIX + "address";
448
449  public static final String RM_ZK_NUM_RETRIES = RM_ZK_PREFIX + "num-retries";
450  public static final int DEFAULT_ZK_RM_NUM_RETRIES = 1000;
451
452  public static final String RM_ZK_RETRY_INTERVAL_MS =
453      RM_ZK_PREFIX + "retry-interval-ms";
454  public static final int DEFAULT_RM_ZK_RETRY_INTERVAL_MS = 1000;
455
456  public static final String RM_ZK_TIMEOUT_MS = RM_ZK_PREFIX + "timeout-ms";
457  public static final int DEFAULT_RM_ZK_TIMEOUT_MS = 10000;
458
459  public static final String RM_ZK_ACL = RM_ZK_PREFIX + "acl";
460  public static final String DEFAULT_RM_ZK_ACL = "world:anyone:rwcda";
461
462  public static final String RM_ZK_AUTH = RM_ZK_PREFIX + "auth";
463
464  public static final String ZK_STATE_STORE_PREFIX =
465      RM_PREFIX + "zk-state-store.";
466
467  /** Parent znode path under which ZKRMStateStore will create znodes */
468  public static final String ZK_RM_STATE_STORE_PARENT_PATH =
469      ZK_STATE_STORE_PREFIX + "parent-path";
470  public static final String DEFAULT_ZK_RM_STATE_STORE_PARENT_PATH = "/rmstore";
471
472  /** Root node ACLs for fencing */
473  public static final String ZK_RM_STATE_STORE_ROOT_NODE_ACL =
474      ZK_STATE_STORE_PREFIX + "root-node.acl";
475
476  /** HA related configs */
477  public static final String RM_HA_PREFIX = RM_PREFIX + "ha.";
478  public static final String RM_HA_ENABLED = RM_HA_PREFIX + "enabled";
479  public static final boolean DEFAULT_RM_HA_ENABLED = false;
480
481  public static final String RM_HA_IDS = RM_HA_PREFIX + "rm-ids";
482  public static final String RM_HA_ID = RM_HA_PREFIX + "id";
483
484  /** Store the related configuration files in File System */
485  public static final String FS_BASED_RM_CONF_STORE = RM_PREFIX
486      + "configuration.file-system-based-store";
487  public static final String DEFAULT_FS_BASED_RM_CONF_STORE = "/yarn/conf";
488
489  public static final String RM_CONFIGURATION_PROVIDER_CLASS = RM_PREFIX
490      + "configuration.provider-class";
491  public static final String DEFAULT_RM_CONFIGURATION_PROVIDER_CLASS =
492      "org.apache.hadoop.yarn.LocalConfigurationProvider";
493
494  public static final String YARN_AUTHORIZATION_PROVIDER = YARN_PREFIX
495      + "authorization-provider";
496  private static final List<String> RM_SERVICES_ADDRESS_CONF_KEYS_HTTP =
497      Collections.unmodifiableList(Arrays.asList(
498          RM_ADDRESS,
499          RM_SCHEDULER_ADDRESS,
500          RM_ADMIN_ADDRESS,
501          RM_RESOURCE_TRACKER_ADDRESS,
502          RM_WEBAPP_ADDRESS));
503
504  private static final List<String> RM_SERVICES_ADDRESS_CONF_KEYS_HTTPS =
505      Collections.unmodifiableList(Arrays.asList(
506          RM_ADDRESS,
507          RM_SCHEDULER_ADDRESS,
508          RM_ADMIN_ADDRESS,
509          RM_RESOURCE_TRACKER_ADDRESS,
510          RM_WEBAPP_HTTPS_ADDRESS));
511
512  public static final String AUTO_FAILOVER_PREFIX =
513      RM_HA_PREFIX + "automatic-failover.";
514
515  public static final String AUTO_FAILOVER_ENABLED =
516      AUTO_FAILOVER_PREFIX + "enabled";
517  public static final boolean DEFAULT_AUTO_FAILOVER_ENABLED = true;
518
519  public static final String AUTO_FAILOVER_EMBEDDED =
520      AUTO_FAILOVER_PREFIX + "embedded";
521  public static final boolean DEFAULT_AUTO_FAILOVER_EMBEDDED = true;
522
523  public static final String AUTO_FAILOVER_ZK_BASE_PATH =
524      AUTO_FAILOVER_PREFIX + "zk-base-path";
525  public static final String DEFAULT_AUTO_FAILOVER_ZK_BASE_PATH =
526      "/yarn-leader-election";
527
528  public static final String CLIENT_FAILOVER_PREFIX =
529      YARN_PREFIX + "client.failover-";
530  public static final String CLIENT_FAILOVER_PROXY_PROVIDER =
531      CLIENT_FAILOVER_PREFIX + "proxy-provider";
532  public static final String DEFAULT_CLIENT_FAILOVER_PROXY_PROVIDER =
533      "org.apache.hadoop.yarn.client.ConfiguredRMFailoverProxyProvider";
534
535  public static final String CLIENT_FAILOVER_MAX_ATTEMPTS =
536      CLIENT_FAILOVER_PREFIX + "max-attempts";
537
538  public static final String CLIENT_FAILOVER_SLEEPTIME_BASE_MS =
539      CLIENT_FAILOVER_PREFIX + "sleep-base-ms";
540
541  public static final String CLIENT_FAILOVER_SLEEPTIME_MAX_MS =
542      CLIENT_FAILOVER_PREFIX + "sleep-max-ms";
543
544  public static final String CLIENT_FAILOVER_RETRIES =
545      CLIENT_FAILOVER_PREFIX + "retries";
546  public static final int DEFAULT_CLIENT_FAILOVER_RETRIES = 0;
547
548  public static final String CLIENT_FAILOVER_RETRIES_ON_SOCKET_TIMEOUTS =
549      CLIENT_FAILOVER_PREFIX + "retries-on-socket-timeouts";
550  public static final int
551      DEFAULT_CLIENT_FAILOVER_RETRIES_ON_SOCKET_TIMEOUTS = 0;
552
553  /** number of zookeeper operation retry times in ActiveStandbyElector */
554  public static final String RM_HA_FC_ELECTOR_ZK_RETRIES_KEY = RM_HA_PREFIX
555      + "failover-controller.active-standby-elector.zk.retries";
556
557  @Private
558  public static final String CURATOR_LEADER_ELECTOR =
559      RM_HA_PREFIX + "curator-leader-elector.enabled";
560  public static final boolean DEFAULT_CURATOR_LEADER_ELECTOR_ENABLED = false;
561
562  ////////////////////////////////
563  // RM state store configs
564  ////////////////////////////////
565  /** The class to use as the persistent store.*/
566  public static final String RM_STORE = RM_PREFIX + "store.class";
567  
568  /** URI for FileSystemRMStateStore */
569  public static final String FS_RM_STATE_STORE_URI = RM_PREFIX
570      + "fs.state-store.uri";
571  public static final String FS_RM_STATE_STORE_RETRY_POLICY_SPEC = RM_PREFIX
572      + "fs.state-store.retry-policy-spec";
573  public static final String DEFAULT_FS_RM_STATE_STORE_RETRY_POLICY_SPEC =
574      "2000, 500";
575
576  public static final String FS_RM_STATE_STORE_NUM_RETRIES =
577      RM_PREFIX + "fs.state-store.num-retries";
578  public static final int DEFAULT_FS_RM_STATE_STORE_NUM_RETRIES = 0;
579
580  public static final String FS_RM_STATE_STORE_RETRY_INTERVAL_MS =
581      RM_PREFIX + "fs.state-store.retry-interval-ms";
582  public static final long DEFAULT_FS_RM_STATE_STORE_RETRY_INTERVAL_MS =
583      1000L;
584
585  public static final String RM_LEVELDB_STORE_PATH = RM_PREFIX
586      + "leveldb-state-store.path";
587
588  /** The maximum number of completed applications RM keeps. */ 
589  public static final String RM_MAX_COMPLETED_APPLICATIONS =
590    RM_PREFIX + "max-completed-applications";
591  public static final int DEFAULT_RM_MAX_COMPLETED_APPLICATIONS = 10000;
592
593  /**
594   * The maximum number of completed applications RM state store keeps, by
595   * default equals to DEFAULT_RM_MAX_COMPLETED_APPLICATIONS
596   */
597  public static final String RM_STATE_STORE_MAX_COMPLETED_APPLICATIONS =
598      RM_PREFIX + "state-store.max-completed-applications";
599  public static final int DEFAULT_RM_STATE_STORE_MAX_COMPLETED_APPLICATIONS =
600      DEFAULT_RM_MAX_COMPLETED_APPLICATIONS;
601
602  /** Default application name */
603  public static final String DEFAULT_APPLICATION_NAME = "N/A";
604
605  /** Default application type */
606  public static final String DEFAULT_APPLICATION_TYPE = "YARN";
607
608  /** Default application type length */
609  public static final int APPLICATION_TYPE_LENGTH = 20;
610  
611  /** Default queue name */
612  public static final String DEFAULT_QUEUE_NAME = "default";
613
614  /**
615   * Buckets (in minutes) for the number of apps running in each queue.
616   */
617  public static final String RM_METRICS_RUNTIME_BUCKETS =
618    RM_PREFIX + "metrics.runtime.buckets";
619
620  /**
621   * Default sizes of the runtime metric buckets in minutes.
622   */
623  public static final String DEFAULT_RM_METRICS_RUNTIME_BUCKETS = 
624    "60,300,1440";
625
626  public static final String RM_AMRM_TOKEN_MASTER_KEY_ROLLING_INTERVAL_SECS = RM_PREFIX
627      + "am-rm-tokens.master-key-rolling-interval-secs";
628
629  public static final long DEFAULT_RM_AMRM_TOKEN_MASTER_KEY_ROLLING_INTERVAL_SECS =
630      24 * 60 * 60;
631
632  public static final String RM_CONTAINER_TOKEN_MASTER_KEY_ROLLING_INTERVAL_SECS =
633      RM_PREFIX + "container-tokens.master-key-rolling-interval-secs";
634
635  public static final long DEFAULT_RM_CONTAINER_TOKEN_MASTER_KEY_ROLLING_INTERVAL_SECS =
636      24 * 60 * 60;
637
638  public static final String RM_NMTOKEN_MASTER_KEY_ROLLING_INTERVAL_SECS =
639      RM_PREFIX + "nm-tokens.master-key-rolling-interval-secs";
640  
641  public static final long DEFAULT_RM_NMTOKEN_MASTER_KEY_ROLLING_INTERVAL_SECS =
642      24 * 60 * 60;
643
644  public static final String RM_NODEMANAGER_MINIMUM_VERSION =
645      RM_PREFIX + "nodemanager.minimum.version";
646
647  public static final String DEFAULT_RM_NODEMANAGER_MINIMUM_VERSION =
648      "NONE";
649
650  /**
651   * RM proxy users' prefix
652   */
653  public static final String RM_PROXY_USER_PREFIX = RM_PREFIX + "proxyuser.";
654
655  ////////////////////////////////
656  // Node Manager Configs
657  ////////////////////////////////
658  
659  /** Prefix for all node manager configs.*/
660  public static final String NM_PREFIX = "yarn.nodemanager.";
661
662  /** Environment variables that will be sent to containers.*/
663  public static final String NM_ADMIN_USER_ENV = NM_PREFIX + "admin-env";
664  public static final String DEFAULT_NM_ADMIN_USER_ENV = "MALLOC_ARENA_MAX=$MALLOC_ARENA_MAX";
665
666  /** Environment variables that containers may override rather than use NodeManager's default.*/
667  public static final String NM_ENV_WHITELIST = NM_PREFIX + "env-whitelist";
668  public static final String DEFAULT_NM_ENV_WHITELIST = StringUtils.join(",",
669    Arrays.asList(ApplicationConstants.Environment.JAVA_HOME.key(),
670      ApplicationConstants.Environment.HADOOP_COMMON_HOME.key(),
671      ApplicationConstants.Environment.HADOOP_HDFS_HOME.key(),
672      ApplicationConstants.Environment.HADOOP_CONF_DIR.key(),
673      ApplicationConstants.Environment.CLASSPATH_PREPEND_DISTCACHE.key(),
674      ApplicationConstants.Environment.HADOOP_YARN_HOME.key()));
675  
676  /** address of node manager IPC.*/
677  public static final String NM_ADDRESS = NM_PREFIX + "address";
678  public static final int DEFAULT_NM_PORT = 0;
679  public static final String DEFAULT_NM_ADDRESS = "0.0.0.0:"
680      + DEFAULT_NM_PORT;
681  
682  /** The actual bind address or the NM.*/
683  public static final String NM_BIND_HOST =
684    NM_PREFIX + "bind-host";
685
686  /** who will execute(launch) the containers.*/
687  public static final String NM_CONTAINER_EXECUTOR = 
688    NM_PREFIX + "container-executor.class";
689
690  /**  
691   * Adjustment to make to the container os scheduling priority.
692   * The valid values for this could vary depending on the platform.
693   * On Linux, higher values mean run the containers at a less 
694   * favorable priority than the NM. 
695   * The value specified is an int.
696   */
697  public static final String NM_CONTAINER_EXECUTOR_SCHED_PRIORITY = 
698    NM_PREFIX + "container-executor.os.sched.priority.adjustment";
699  public static final int DEFAULT_NM_CONTAINER_EXECUTOR_SCHED_PRIORITY = 0;
700  
701  /** Number of threads container manager uses.*/
702  public static final String NM_CONTAINER_MGR_THREAD_COUNT =
703    NM_PREFIX + "container-manager.thread-count";
704  public static final int DEFAULT_NM_CONTAINER_MGR_THREAD_COUNT = 20;
705  
706  /** Number of threads used in cleanup.*/
707  public static final String NM_DELETE_THREAD_COUNT = 
708    NM_PREFIX +  "delete.thread-count";
709  public static final int DEFAULT_NM_DELETE_THREAD_COUNT = 4;
710  
711  /** Keytab for NM.*/
712  public static final String NM_KEYTAB = NM_PREFIX + "keytab";
713  
714  /**List of directories to store localized files in.*/
715  public static final String NM_LOCAL_DIRS = NM_PREFIX + "local-dirs";
716  public static final String DEFAULT_NM_LOCAL_DIRS = "/tmp/nm-local-dir";
717
718  /**
719   * Number of files in each localized directories
720   * Avoid tuning this too low. 
721   */
722  public static final String NM_LOCAL_CACHE_MAX_FILES_PER_DIRECTORY =
723    NM_PREFIX + "local-cache.max-files-per-directory";
724  public static final int DEFAULT_NM_LOCAL_CACHE_MAX_FILES_PER_DIRECTORY = 8192;
725
726  /** Address where the localizer IPC is.*/
727  public static final String NM_LOCALIZER_ADDRESS =
728    NM_PREFIX + "localizer.address";
729  public static final int DEFAULT_NM_LOCALIZER_PORT = 8040;
730  public static final String DEFAULT_NM_LOCALIZER_ADDRESS = "0.0.0.0:" +
731    DEFAULT_NM_LOCALIZER_PORT;
732  
733  /** Interval in between cache cleanups.*/
734  public static final String NM_LOCALIZER_CACHE_CLEANUP_INTERVAL_MS =
735    NM_PREFIX + "localizer.cache.cleanup.interval-ms";
736  public static final long DEFAULT_NM_LOCALIZER_CACHE_CLEANUP_INTERVAL_MS = 
737    10 * 60 * 1000;
738  
739  /**
740   * Target size of localizer cache in MB, per nodemanager. It is a target
741   * retention size that only includes resources with PUBLIC and PRIVATE
742   * visibility and excludes resources with APPLICATION visibility
743   */
744  public static final String NM_LOCALIZER_CACHE_TARGET_SIZE_MB =
745    NM_PREFIX + "localizer.cache.target-size-mb";
746  public static final long DEFAULT_NM_LOCALIZER_CACHE_TARGET_SIZE_MB = 10 * 1024;
747  
748  /** Number of threads to handle localization requests.*/
749  public static final String NM_LOCALIZER_CLIENT_THREAD_COUNT =
750    NM_PREFIX + "localizer.client.thread-count";
751  public static final int DEFAULT_NM_LOCALIZER_CLIENT_THREAD_COUNT = 5;
752  
753  /** Number of threads to use for localization fetching.*/
754  public static final String NM_LOCALIZER_FETCH_THREAD_COUNT = 
755    NM_PREFIX + "localizer.fetch.thread-count";
756  public static final int DEFAULT_NM_LOCALIZER_FETCH_THREAD_COUNT = 4;
757
758  /** Where to store container logs.*/
759  public static final String NM_LOG_DIRS = NM_PREFIX + "log-dirs";
760  public static final String DEFAULT_NM_LOG_DIRS = "/tmp/logs";
761
762  /** The number of threads to handle log aggregation in node manager. */
763  public static final String NM_LOG_AGGREGATION_THREAD_POOL_SIZE =
764      NM_PREFIX + "logaggregation.threadpool-size-max";
765  public static final int DEFAULT_NM_LOG_AGGREGATION_THREAD_POOL_SIZE = 100;
766
767  /** Default permissions for container logs. */
768  public static final String NM_DEFAULT_CONTAINER_EXECUTOR_PREFIX =
769      NM_PREFIX + "default-container-executor.";
770  public static final String NM_DEFAULT_CONTAINER_EXECUTOR_LOG_DIRS_PERMISSIONS =
771      NM_DEFAULT_CONTAINER_EXECUTOR_PREFIX + "log-dirs.permissions";
772  public static final String NM_DEFAULT_CONTAINER_EXECUTOR_LOG_DIRS_PERMISSIONS_DEFAULT = "710";
773
774  public static final String NM_RESOURCEMANAGER_MINIMUM_VERSION =
775      NM_PREFIX + "resourcemanager.minimum.version";
776  public static final String DEFAULT_NM_RESOURCEMANAGER_MINIMUM_VERSION = "NONE";
777
778  /** Interval at which the delayed token removal thread runs */
779  public static final String RM_DELAYED_DELEGATION_TOKEN_REMOVAL_INTERVAL_MS =
780      RM_PREFIX + "delayed.delegation-token.removal-interval-ms";
781  public static final long DEFAULT_RM_DELAYED_DELEGATION_TOKEN_REMOVAL_INTERVAL_MS =
782      30000l;
783  
784  /** Delegation Token renewer thread count */
785  public static final String RM_DELEGATION_TOKEN_RENEWER_THREAD_COUNT =
786      RM_PREFIX + "delegation-token-renewer.thread-count";
787  public static final int DEFAULT_RM_DELEGATION_TOKEN_RENEWER_THREAD_COUNT = 50;
788
789  public static final String RM_PROXY_USER_PRIVILEGES_ENABLED = RM_PREFIX
790      + "proxy-user-privileges.enabled";
791  public static final boolean DEFAULT_RM_PROXY_USER_PRIVILEGES_ENABLED = false;
792
793  /** The expiry interval for node IP caching. -1 disables the caching */
794  public static final String RM_NODE_IP_CACHE_EXPIRY_INTERVAL_SECS = RM_PREFIX
795      + "node-ip-cache.expiry-interval-secs";
796  public static final int DEFAULT_RM_NODE_IP_CACHE_EXPIRY_INTERVAL_SECS = -1;
797
798  /**
799   * How many diagnostics/failure messages can be saved in RM for
800   * log aggregation. It also defines the number of diagnostics/failure
801   * messages can be shown in log aggregation web ui.
802   */
803  public static final String RM_MAX_LOG_AGGREGATION_DIAGNOSTICS_IN_MEMORY =
804      RM_PREFIX + "max-log-aggregation-diagnostics-in-memory";
805  public static final int DEFAULT_RM_MAX_LOG_AGGREGATION_DIAGNOSTICS_IN_MEMORY =
806      10;
807
808  /** Whether to enable log aggregation */
809  public static final String LOG_AGGREGATION_ENABLED = YARN_PREFIX
810      + "log-aggregation-enable";
811  public static final boolean DEFAULT_LOG_AGGREGATION_ENABLED = false;
812  
813  /** 
814   * How long to wait before deleting aggregated logs, -1 disables.
815   * Be careful set this too small and you will spam the name node.
816   */
817  public static final String LOG_AGGREGATION_RETAIN_SECONDS = YARN_PREFIX
818      + "log-aggregation.retain-seconds";
819  public static final long DEFAULT_LOG_AGGREGATION_RETAIN_SECONDS = -1;
820  
821  /**
822   * How long to wait between aggregated log retention checks. If set to
823   * a value {@literal <=} 0 then the value is computed as one-tenth of the
824   * log retention setting. Be careful set this too small and you will spam
825   * the name node.
826   */
827  public static final String LOG_AGGREGATION_RETAIN_CHECK_INTERVAL_SECONDS =
828      YARN_PREFIX + "log-aggregation.retain-check-interval-seconds";
829  public static final long DEFAULT_LOG_AGGREGATION_RETAIN_CHECK_INTERVAL_SECONDS = -1;
830
831  /**
832   * How long for ResourceManager to wait for NodeManager to report its
833   * log aggregation status. If waiting time of which the log aggregation status
834   * is reported from NodeManager exceeds the configured value, RM will report
835   * log aggregation status for this NodeManager as TIME_OUT
836   */
837  public static final String LOG_AGGREGATION_STATUS_TIME_OUT_MS =
838      YARN_PREFIX + "log-aggregation-status.time-out.ms";
839  public static final long DEFAULT_LOG_AGGREGATION_STATUS_TIME_OUT_MS
840      = 10 * 60 * 1000;
841
842  /**
843   * Number of seconds to retain logs on the NodeManager. Only applicable if Log
844   * aggregation is disabled
845   */
846  public static final String NM_LOG_RETAIN_SECONDS = NM_PREFIX
847      + "log.retain-seconds";
848  public static final long DEFAULT_NM_LOG_RETAIN_SECONDS = 3 * 60 * 60;
849
850  /**
851   * Define how often NMs wake up and upload log files
852   */
853  public static final String NM_LOG_AGGREGATION_ROLL_MONITORING_INTERVAL_SECONDS =
854      NM_PREFIX + "log-aggregation.roll-monitoring-interval-seconds";
855  public static final long
856      DEFAULT_NM_LOG_AGGREGATION_ROLL_MONITORING_INTERVAL_SECONDS = -1;
857  /**
858   * Number of threads used in log cleanup. Only applicable if Log aggregation
859   * is disabled
860   */
861  public static final String NM_LOG_DELETION_THREADS_COUNT = 
862    NM_PREFIX +  "log.deletion-threads-count";
863  public static final int DEFAULT_NM_LOG_DELETE_THREAD_COUNT = 4;
864
865  /** Where to aggregate logs to.*/
866  public static final String NM_REMOTE_APP_LOG_DIR = 
867    NM_PREFIX + "remote-app-log-dir";
868  public static final String DEFAULT_NM_REMOTE_APP_LOG_DIR = "/tmp/logs";
869
870  /**
871   * The remote log dir will be created at
872   * NM_REMOTE_APP_LOG_DIR/${user}/NM_REMOTE_APP_LOG_DIR_SUFFIX/${appId}
873   */
874  public static final String NM_REMOTE_APP_LOG_DIR_SUFFIX = 
875    NM_PREFIX + "remote-app-log-dir-suffix";
876  public static final String DEFAULT_NM_REMOTE_APP_LOG_DIR_SUFFIX="logs";
877
878  public static final String YARN_LOG_SERVER_URL =
879    YARN_PREFIX + "log.server.url";
880  
881  public static final String YARN_TRACKING_URL_GENERATOR = 
882      YARN_PREFIX + "tracking.url.generator";
883
884  /** Amount of memory in MB that can be allocated for containers.*/
885  public static final String NM_PMEM_MB = NM_PREFIX + "resource.memory-mb";
886  public static final int DEFAULT_NM_PMEM_MB = 8 * 1024;
887
888  /** Amount of memory in MB that has been reserved for non-yarn use. */
889  public static final String NM_SYSTEM_RESERVED_PMEM_MB = NM_PREFIX
890      + "resource.system-reserved-memory-mb";
891
892  /** Specifies whether physical memory check is enabled. */
893  public static final String NM_PMEM_CHECK_ENABLED = NM_PREFIX
894      + "pmem-check-enabled";
895  public static final boolean DEFAULT_NM_PMEM_CHECK_ENABLED = true;
896
897  /** Specifies whether physical memory check is enabled. */
898  public static final String NM_VMEM_CHECK_ENABLED = NM_PREFIX
899      + "vmem-check-enabled";
900  public static final boolean DEFAULT_NM_VMEM_CHECK_ENABLED = true;
901
902  /** Conversion ratio for physical memory to virtual memory. */
903  public static final String NM_VMEM_PMEM_RATIO =
904    NM_PREFIX + "vmem-pmem-ratio";
905  public static final float DEFAULT_NM_VMEM_PMEM_RATIO = 2.1f;
906  
907  /** Number of Virtual CPU Cores which can be allocated for containers.*/
908  public static final String NM_VCORES = NM_PREFIX + "resource.cpu-vcores";
909  public static final int DEFAULT_NM_VCORES = 8;
910
911  /** Count logical processors(like hyperthreads) as cores. */
912  public static final String NM_COUNT_LOGICAL_PROCESSORS_AS_CORES = NM_PREFIX
913      + "resource.count-logical-processors-as-cores";
914  public static final boolean DEFAULT_NM_COUNT_LOGICAL_PROCESSORS_AS_CORES =
915      false;
916
917  /** Multiplier to convert physical cores to vcores. */
918  public static final String NM_PCORES_VCORES_MULTIPLIER = NM_PREFIX
919      + "resource.pcores-vcores-multiplier";
920  public static final float DEFAULT_NM_PCORES_VCORES_MULTIPLIER = 1.0f;
921
922  /** Percentage of overall CPU which can be allocated for containers. */
923  public static final String NM_RESOURCE_PERCENTAGE_PHYSICAL_CPU_LIMIT =
924      NM_PREFIX + "resource.percentage-physical-cpu-limit";
925  public static final int DEFAULT_NM_RESOURCE_PERCENTAGE_PHYSICAL_CPU_LIMIT =
926      100;
927
928  /** Enable or disable node hardware capability detection. */
929  public static final String NM_ENABLE_HARDWARE_CAPABILITY_DETECTION =
930      NM_PREFIX + "resource.detect-hardware-capabilities";
931  public static final boolean DEFAULT_NM_ENABLE_HARDWARE_CAPABILITY_DETECTION =
932      false;
933
934  @Private
935  public static final String NM_MEMORY_RESOURCE_PREFIX = NM_PREFIX
936      + "resource.memory.";
937
938  @Private
939  public static final String NM_MEMORY_RESOURCE_ENABLED =
940      NM_MEMORY_RESOURCE_PREFIX + "enabled";
941  @Private
942  public static final boolean DEFAULT_NM_MEMORY_RESOURCE_ENABLED = false;
943
944  @Private
945  public static final String NM_MEMORY_RESOURCE_CGROUPS_SWAPPINESS =
946      NM_MEMORY_RESOURCE_PREFIX + "cgroups.swappiness";
947  @Private
948  public static final int DEFAULT_NM_MEMORY_RESOURCE_CGROUPS_SWAPPINESS = 0;
949
950  @Private
951  public static final String NM_MEMORY_RESOURCE_CGROUPS_SOFT_LIMIT_PERCENTAGE =
952      NM_MEMORY_RESOURCE_PREFIX + "cgroups.soft-limit-percentage";
953  @Private
954  public static final float
955      DEFAULT_NM_MEMORY_RESOURCE_CGROUPS_SOFT_LIMIT_PERCENTAGE =
956      90.0f;
957
958  @Private
959  public static final String NM_CPU_RESOURCE_PREFIX = NM_PREFIX
960      + "resource.cpu.";
961
962  /** Enable cpu isolation. */
963  @Private
964  public static final String NM_CPU_RESOURCE_ENABLED =
965      NM_CPU_RESOURCE_PREFIX + "enabled";
966
967  @Private
968  public static final boolean DEFAULT_NM_CPU_RESOURCE_ENABLED = false;
969
970  /**
971   * Prefix for disk configurations. Work in progress: This configuration
972   * parameter may be changed/removed in the future.
973   */
974  @Private
975  public static final String NM_DISK_RESOURCE_PREFIX = NM_PREFIX
976      + "resource.disk.";
977  /**
978   * This setting controls if resource handling for disk operations is enabled.
979   * Work in progress: This configuration parameter may be changed/removed in
980   * the future
981   */
982  @Private
983  public static final String NM_DISK_RESOURCE_ENABLED = NM_DISK_RESOURCE_PREFIX
984      + "enabled";
985  /** Disk as a resource is disabled by default. **/
986  @Private
987  public static final boolean DEFAULT_NM_DISK_RESOURCE_ENABLED = false;
988
989  public static final String NM_NETWORK_RESOURCE_PREFIX = NM_PREFIX
990      + "resource.network.";
991
992  /**
993   * This setting controls if resource handling for network bandwidth is
994   * enabled. Work in progress: This configuration parameter may be
995   * changed/removed in the future
996   */
997  @Private
998  public static final String NM_NETWORK_RESOURCE_ENABLED =
999      NM_NETWORK_RESOURCE_PREFIX + "enabled";
1000  /** Network as a resource is disabled by default. **/
1001  @Private
1002  public static final boolean DEFAULT_NM_NETWORK_RESOURCE_ENABLED = false;
1003
1004  /**
1005   * Specifies the interface to be used for applying network throttling rules.
1006   * Work in progress: This configuration parameter may be changed/removed in
1007   * the future
1008   */
1009  @Private
1010  public static final String NM_NETWORK_RESOURCE_INTERFACE =
1011      NM_NETWORK_RESOURCE_PREFIX + "interface";
1012  @Private
1013  public static final String DEFAULT_NM_NETWORK_RESOURCE_INTERFACE = "eth0";
1014
1015  /**
1016   * Specifies the total available outbound bandwidth on the node. Work in
1017   * progress: This configuration parameter may be changed/removed in the future
1018   */
1019  @Private
1020  public static final String NM_NETWORK_RESOURCE_OUTBOUND_BANDWIDTH_MBIT =
1021      NM_NETWORK_RESOURCE_PREFIX + "outbound-bandwidth-mbit";
1022  @Private
1023  public static final int DEFAULT_NM_NETWORK_RESOURCE_OUTBOUND_BANDWIDTH_MBIT =
1024      1000;
1025
1026  /**
1027   * Specifies the total outbound bandwidth available to YARN containers.
1028   * defaults to NM_NETWORK_RESOURCE_OUTBOUND_BANDWIDTH_MBIT if not specified.
1029   * Work in progress: This configuration parameter may be changed/removed in
1030   * the future
1031   */
1032  @Private
1033  public static final String NM_NETWORK_RESOURCE_OUTBOUND_BANDWIDTH_YARN_MBIT =
1034      NM_NETWORK_RESOURCE_PREFIX + "outbound-bandwidth-yarn-mbit";
1035
1036  /** NM Webapp address.**/
1037  public static final String NM_WEBAPP_ADDRESS = NM_PREFIX + "webapp.address";
1038  public static final int DEFAULT_NM_WEBAPP_PORT = 8042;
1039  public static final String DEFAULT_NM_WEBAPP_ADDRESS = "0.0.0.0:" +
1040    DEFAULT_NM_WEBAPP_PORT;
1041  
1042  /** NM Webapp https address.**/
1043  public static final String NM_WEBAPP_HTTPS_ADDRESS = NM_PREFIX
1044      + "webapp.https.address";
1045  public static final int DEFAULT_NM_WEBAPP_HTTPS_PORT = 8044;
1046  public static final String DEFAULT_NM_WEBAPP_HTTPS_ADDRESS = "0.0.0.0:"
1047      + DEFAULT_NM_WEBAPP_HTTPS_PORT; 
1048
1049  /** Enable/disable CORS filter. */
1050  public static final String NM_WEBAPP_ENABLE_CORS_FILTER =
1051      NM_PREFIX + "webapp.cross-origin.enabled";
1052  public static final boolean DEFAULT_NM_WEBAPP_ENABLE_CORS_FILTER = false;
1053
1054  /** How often to monitor resource in a node.*/
1055  public static final String NM_RESOURCE_MON_INTERVAL_MS =
1056      NM_PREFIX + "resource-monitor.interval-ms";
1057  public static final int DEFAULT_NM_RESOURCE_MON_INTERVAL_MS = 3000;
1058
1059  /** How often to monitor containers.*/
1060  public final static String NM_CONTAINER_MON_INTERVAL_MS =
1061    NM_PREFIX + "container-monitor.interval-ms";
1062  @Deprecated
1063  public final static int DEFAULT_NM_CONTAINER_MON_INTERVAL_MS = 3000;
1064
1065  /** Class that calculates current resource utilization.*/
1066  public static final String NM_MON_RESOURCE_CALCULATOR =
1067      NM_PREFIX + "resource-calculator.class";
1068  /** Class that calculates containers current resource utilization.*/
1069  public static final String NM_CONTAINER_MON_RESOURCE_CALCULATOR =
1070    NM_PREFIX + "container-monitor.resource-calculator.class";
1071  /** Class that calculates process tree resource utilization.*/
1072  public static final String NM_CONTAINER_MON_PROCESS_TREE =
1073    NM_PREFIX + "container-monitor.process-tree.class";
1074  public static final String PROCFS_USE_SMAPS_BASED_RSS_ENABLED = NM_PREFIX +
1075      "container-monitor.procfs-tree.smaps-based-rss.enabled";
1076  public static final boolean DEFAULT_PROCFS_USE_SMAPS_BASED_RSS_ENABLED =
1077      false;
1078
1079  /** Enable/disable container metrics. */
1080  @Private
1081  public static final String NM_CONTAINER_METRICS_ENABLE =
1082      NM_PREFIX + "container-metrics.enable";
1083  @Private
1084  public static final boolean DEFAULT_NM_CONTAINER_METRICS_ENABLE = true;
1085
1086  /** Container metrics flush period. -1 for flush on completion. */
1087  @Private
1088  public static final String NM_CONTAINER_METRICS_PERIOD_MS =
1089      NM_PREFIX + "container-metrics.period-ms";
1090  @Private
1091  public static final int DEFAULT_NM_CONTAINER_METRICS_PERIOD_MS = -1;
1092
1093  /** The delay time ms to unregister container metrics after completion. */
1094  @Private
1095  public static final String NM_CONTAINER_METRICS_UNREGISTER_DELAY_MS =
1096      NM_PREFIX + "container-metrics.unregister-delay-ms";
1097  @Private
1098  public static final int DEFAULT_NM_CONTAINER_METRICS_UNREGISTER_DELAY_MS =
1099      10000;
1100
1101  /** Prefix for all node manager disk health checker configs. */
1102  private static final String NM_DISK_HEALTH_CHECK_PREFIX =
1103      "yarn.nodemanager.disk-health-checker.";
1104  /**
1105   * Enable/Disable disks' health checker. Default is true. An expert level
1106   * configuration property.
1107   */
1108  public static final String NM_DISK_HEALTH_CHECK_ENABLE =
1109      NM_DISK_HEALTH_CHECK_PREFIX + "enable";
1110  /** Frequency of running disks' health checker. */
1111  public static final String NM_DISK_HEALTH_CHECK_INTERVAL_MS =
1112      NM_DISK_HEALTH_CHECK_PREFIX + "interval-ms";
1113  /** By default, disks' health is checked every 2 minutes. */
1114  public static final long DEFAULT_NM_DISK_HEALTH_CHECK_INTERVAL_MS =
1115      2 * 60 * 1000;
1116
1117  /**
1118   * The minimum fraction of number of disks to be healthy for the nodemanager
1119   * to launch new containers. This applies to nm-local-dirs and nm-log-dirs.
1120   */
1121  public static final String NM_MIN_HEALTHY_DISKS_FRACTION =
1122      NM_DISK_HEALTH_CHECK_PREFIX + "min-healthy-disks";
1123  /**
1124   * By default, at least 25% of disks are to be healthy to say that the node is
1125   * healthy in terms of disks.
1126   */
1127  public static final float DEFAULT_NM_MIN_HEALTHY_DISKS_FRACTION = 0.25F;
1128
1129  /**
1130   * The maximum percentage of disk space that can be used after which a disk is
1131   * marked as offline. Values can range from 0.0 to 100.0. If the value is
1132   * greater than or equal to 100, NM will check for full disk. This applies to
1133   * nm-local-dirs and nm-log-dirs.
1134   */
1135  public static final String NM_MAX_PER_DISK_UTILIZATION_PERCENTAGE =
1136      NM_DISK_HEALTH_CHECK_PREFIX + "max-disk-utilization-per-disk-percentage";
1137  /**
1138   * By default, 90% of the disk can be used before it is marked as offline.
1139   */
1140  public static final float DEFAULT_NM_MAX_PER_DISK_UTILIZATION_PERCENTAGE =
1141      90.0F;
1142
1143  /**
1144   * The low threshold percentage of disk space used when an offline disk is
1145   * marked as online. Values can range from 0.0 to 100.0. The value shouldn't
1146   * be more than NM_MAX_PER_DISK_UTILIZATION_PERCENTAGE. If its value is
1147   * more than NM_MAX_PER_DISK_UTILIZATION_PERCENTAGE or not set, it will be
1148   * set to the same value as NM_MAX_PER_DISK_UTILIZATION_PERCENTAGE.
1149   * This applies to nm-local-dirs and nm-log-dirs.
1150   */
1151  public static final String NM_WM_LOW_PER_DISK_UTILIZATION_PERCENTAGE =
1152      NM_DISK_HEALTH_CHECK_PREFIX +
1153      "disk-utilization-watermark-low-per-disk-percentage";
1154
1155  /**
1156   * The minimum space that must be available on a local dir for it to be used.
1157   * This applies to nm-local-dirs and nm-log-dirs.
1158   */
1159  public static final String NM_MIN_PER_DISK_FREE_SPACE_MB =
1160      NM_DISK_HEALTH_CHECK_PREFIX + "min-free-space-per-disk-mb";
1161  /**
1162   * By default, all of the disk can be used before it is marked as offline.
1163   */
1164  public static final long DEFAULT_NM_MIN_PER_DISK_FREE_SPACE_MB = 0;
1165
1166  /** Frequency of running node health script.*/
1167  public static final String NM_HEALTH_CHECK_INTERVAL_MS = 
1168    NM_PREFIX + "health-checker.interval-ms";
1169  public static final long DEFAULT_NM_HEALTH_CHECK_INTERVAL_MS = 10 * 60 * 1000;
1170
1171  /** Health check script time out period.*/  
1172  public static final String NM_HEALTH_CHECK_SCRIPT_TIMEOUT_MS = 
1173    NM_PREFIX + "health-checker.script.timeout-ms";
1174  public static final long DEFAULT_NM_HEALTH_CHECK_SCRIPT_TIMEOUT_MS = 
1175    2 * DEFAULT_NM_HEALTH_CHECK_INTERVAL_MS;
1176  
1177  /** The health check script to run.*/
1178  public static final String NM_HEALTH_CHECK_SCRIPT_PATH = 
1179    NM_PREFIX + "health-checker.script.path";
1180  
1181  /** The arguments to pass to the health check script.*/
1182  public static final String NM_HEALTH_CHECK_SCRIPT_OPTS = 
1183    NM_PREFIX + "health-checker.script.opts";
1184
1185  /** The JVM options used on forking ContainerLocalizer process
1186      by container executor. */
1187  public static final String NM_CONTAINER_LOCALIZER_JAVA_OPTS_KEY =
1188      NM_PREFIX + "container-localizer.java.opts";
1189  public static final String NM_CONTAINER_LOCALIZER_JAVA_OPTS_DEFAULT =
1190      "-Xmx256m";
1191
1192  /** The Docker image name(For DockerContainerExecutor).*/
1193  public static final String NM_DOCKER_CONTAINER_EXECUTOR_IMAGE_NAME =
1194    NM_PREFIX + "docker-container-executor.image-name";
1195
1196  /** The name of the docker executor (For DockerContainerExecutor).*/
1197  public static final String NM_DOCKER_CONTAINER_EXECUTOR_EXEC_NAME =
1198    NM_PREFIX + "docker-container-executor.exec-name";
1199
1200  /** The default docker executor (For DockerContainerExecutor).*/
1201  public static final String NM_DEFAULT_DOCKER_CONTAINER_EXECUTOR_EXEC_NAME =
1202          "/usr/bin/docker";
1203
1204  /** Prefix for runtime configuration constants. */
1205  public static final String LINUX_CONTAINER_RUNTIME_PREFIX = NM_PREFIX +
1206      "runtime.linux.";
1207  public static final String DOCKER_CONTAINER_RUNTIME_PREFIX =
1208      LINUX_CONTAINER_RUNTIME_PREFIX + "docker.";
1209
1210  /** Capabilities allowed (and added by default) for docker containers. **/
1211  public static final String NM_DOCKER_CONTAINER_CAPABILITIES =
1212      DOCKER_CONTAINER_RUNTIME_PREFIX + "capabilities";
1213
1214  /** These are the default capabilities added by docker. We'll use the same
1215   * set here. While these may not be case-sensitive from a docker
1216   * perspective, it is best to keep these uppercase.
1217   */
1218  public static final String[] DEFAULT_NM_DOCKER_CONTAINER_CAPABILITIES = {
1219      "CHOWN",
1220      "DAC_OVERRIDE",
1221      "FSETID",
1222      "FOWNER",
1223      "MKNOD",
1224      "NET_RAW",
1225      "SETGID",
1226      "SETUID",
1227      "SETFCAP",
1228      "SETPCAP",
1229      "NET_BIND_SERVICE",
1230      "SYS_CHROOT",
1231      "KILL",
1232      "AUDIT_WRITE" };
1233
1234  /** Allow privileged containers. Use with extreme care. */
1235  public static final String NM_DOCKER_ALLOW_PRIVILEGED_CONTAINERS =
1236      DOCKER_CONTAINER_RUNTIME_PREFIX + "privileged-containers.allowed";
1237
1238  /** Privileged containers are disabled by default. */
1239  public static final boolean DEFAULT_NM_DOCKER_ALLOW_PRIVILEGED_CONTAINERS =
1240      false;
1241
1242  /** ACL list for users allowed to run privileged containers. */
1243  public static final String NM_DOCKER_PRIVILEGED_CONTAINERS_ACL =
1244      DOCKER_CONTAINER_RUNTIME_PREFIX + "privileged-containers.acl";
1245
1246  /** Default list for users allowed to run privileged containers is empty. */
1247  public static final String DEFAULT_NM_DOCKER_PRIVILEGED_CONTAINERS_ACL = "";
1248
1249  /** The path to the Linux container executor.*/
1250  public static final String NM_LINUX_CONTAINER_EXECUTOR_PATH =
1251    NM_PREFIX + "linux-container-executor.path";
1252  
1253  /** 
1254   * The UNIX group that the linux-container-executor should run as.
1255   * This is intended to be set as part of container-executor.cfg. 
1256   */
1257  public static final String NM_LINUX_CONTAINER_GROUP =
1258    NM_PREFIX + "linux-container-executor.group";
1259
1260  /**
1261   * True if linux-container-executor should limit itself to one user
1262   * when running in non-secure mode.
1263   */
1264  public static final String NM_NONSECURE_MODE_LIMIT_USERS = NM_PREFIX +
1265     "linux-container-executor.nonsecure-mode.limit-users";
1266
1267  public static final boolean DEFAULT_NM_NONSECURE_MODE_LIMIT_USERS = true;
1268
1269  /**
1270   * The UNIX user that containers will run as when Linux-container-executor
1271   * is used in nonsecure mode (a use case for this is using cgroups).
1272   */
1273  public static final String NM_NONSECURE_MODE_LOCAL_USER_KEY = NM_PREFIX +
1274      "linux-container-executor.nonsecure-mode.local-user";
1275
1276  public static final String DEFAULT_NM_NONSECURE_MODE_LOCAL_USER = "nobody";
1277
1278  /**
1279   * The allowed pattern for UNIX user names enforced by 
1280   * Linux-container-executor when used in nonsecure mode (use case for this 
1281   * is using cgroups). The default value is taken from /usr/sbin/adduser
1282   */
1283  public static final String NM_NONSECURE_MODE_USER_PATTERN_KEY = NM_PREFIX +
1284      "linux-container-executor.nonsecure-mode.user-pattern";
1285
1286  public static final String DEFAULT_NM_NONSECURE_MODE_USER_PATTERN = 
1287      "^[_.A-Za-z0-9][-@_.A-Za-z0-9]{0,255}?[$]?$";
1288
1289  /** The type of resource enforcement to use with the
1290   *  linux container executor.
1291   */
1292  public static final String NM_LINUX_CONTAINER_RESOURCES_HANDLER = 
1293  NM_PREFIX + "linux-container-executor.resources-handler.class";
1294  
1295  /** The path the linux container executor should use for cgroups */
1296  public static final String NM_LINUX_CONTAINER_CGROUPS_HIERARCHY =
1297    NM_PREFIX + "linux-container-executor.cgroups.hierarchy";
1298  
1299  /** Whether the linux container executor should mount cgroups if not found */
1300  public static final String NM_LINUX_CONTAINER_CGROUPS_MOUNT =
1301    NM_PREFIX + "linux-container-executor.cgroups.mount";
1302  
1303  /** Where the linux container executor should mount cgroups if not found */
1304  public static final String NM_LINUX_CONTAINER_CGROUPS_MOUNT_PATH =
1305    NM_PREFIX + "linux-container-executor.cgroups.mount-path";
1306
1307  /**
1308   * Whether the apps should run in strict resource usage mode(not allowed to
1309   * use spare CPU)
1310   */
1311  public static final String NM_LINUX_CONTAINER_CGROUPS_STRICT_RESOURCE_USAGE =
1312      NM_PREFIX + "linux-container-executor.cgroups.strict-resource-usage";
1313  public static final boolean DEFAULT_NM_LINUX_CONTAINER_CGROUPS_STRICT_RESOURCE_USAGE =
1314      false;
1315
1316
1317
1318  /**
1319   * Interval of time the linux container executor should try cleaning up
1320   * cgroups entry when cleaning up a container. This is required due to what 
1321   * it seems a race condition because the SIGTERM/SIGKILL is asynch.
1322   */
1323  public static final String NM_LINUX_CONTAINER_CGROUPS_DELETE_TIMEOUT =
1324   NM_PREFIX + "linux-container-executor.cgroups.delete-timeout-ms";
1325
1326  public static final long DEFAULT_NM_LINUX_CONTAINER_CGROUPS_DELETE_TIMEOUT =
1327      1000;
1328
1329  /**
1330   * Delay between attempts to remove linux cgroup.
1331   */
1332  public static final String NM_LINUX_CONTAINER_CGROUPS_DELETE_DELAY =
1333      NM_PREFIX + "linux-container-executor.cgroups.delete-delay-ms";
1334
1335  public static final long DEFAULT_NM_LINUX_CONTAINER_CGROUPS_DELETE_DELAY =
1336      20;
1337
1338  /**
1339   * Indicates if memory and CPU limits will be set for the Windows Job
1340   * Object for the containers launched by the default container executor.
1341   */
1342  public static final String NM_WINDOWS_CONTAINER_MEMORY_LIMIT_ENABLED =
1343      NM_PREFIX + "windows-container.memory-limit.enabled";
1344  public static final boolean DEFAULT_NM_WINDOWS_CONTAINER_MEMORY_LIMIT_ENABLED = false;
1345
1346  public static final String NM_WINDOWS_CONTAINER_CPU_LIMIT_ENABLED =
1347      NM_PREFIX + "windows-container.cpu-limit.enabled";
1348  public static final boolean DEFAULT_NM_WINDOWS_CONTAINER_CPU_LIMIT_ENABLED = false;
1349
1350  /** 
1351  /* The Windows group that the windows-secure-container-executor should run as.
1352  */
1353  public static final String NM_WINDOWS_SECURE_CONTAINER_GROUP =
1354      NM_PREFIX + "windows-secure-container-executor.group";
1355
1356  /** T-file compression types used to compress aggregated logs.*/
1357  public static final String NM_LOG_AGG_COMPRESSION_TYPE = 
1358    NM_PREFIX + "log-aggregation.compression-type";
1359  public static final String DEFAULT_NM_LOG_AGG_COMPRESSION_TYPE = "none";
1360  
1361  /** The kerberos principal for the node manager.*/
1362  public static final String NM_PRINCIPAL =
1363    NM_PREFIX + "principal";
1364  
1365  public static final String NM_AUX_SERVICES = 
1366    NM_PREFIX + "aux-services";
1367  
1368  public static final String NM_AUX_SERVICE_FMT =
1369    NM_PREFIX + "aux-services.%s.class";
1370
1371  public static final String NM_USER_HOME_DIR =
1372      NM_PREFIX + "user-home-dir";
1373
1374  public static final String NM_CONTAINER_STDERR_PATTERN =
1375      NM_PREFIX + "container.stderr.pattern";
1376
1377  public static final String DEFAULT_NM_CONTAINER_STDERR_PATTERN =
1378      "{*stderr*,*STDERR*}";
1379
1380  public static final String NM_CONTAINER_STDERR_BYTES =
1381      NM_PREFIX + "container.stderr.tail.bytes";
1382
1383  public static final long DEFAULT_NM_CONTAINER_STDERR_BYTES = 4 * 1024;
1384
1385  /**The kerberos principal to be used for spnego filter for NM.*/
1386  public static final String NM_WEBAPP_SPNEGO_USER_NAME_KEY =
1387      NM_PREFIX + "webapp.spnego-principal";
1388  
1389  /**The kerberos keytab to be used for spnego filter for NM.*/
1390  public static final String NM_WEBAPP_SPNEGO_KEYTAB_FILE_KEY =
1391      NM_PREFIX + "webapp.spnego-keytab-file";
1392  
1393  public static final String DEFAULT_NM_USER_HOME_DIR= "/home/";
1394
1395  public static final String NM_RECOVERY_PREFIX = NM_PREFIX + "recovery.";
1396  public static final String NM_RECOVERY_ENABLED =
1397      NM_RECOVERY_PREFIX + "enabled";
1398  public static final boolean DEFAULT_NM_RECOVERY_ENABLED = false;
1399
1400  public static final String NM_RECOVERY_DIR = NM_RECOVERY_PREFIX + "dir";
1401
1402  public static final String NM_RECOVERY_SUPERVISED =
1403      NM_RECOVERY_PREFIX + "supervised";
1404  public static final boolean DEFAULT_NM_RECOVERY_SUPERVISED = false;
1405
1406  public static final String NM_LOG_AGG_POLICY_CLASS =
1407      NM_PREFIX + "log-aggregation.policy.class";
1408
1409  public static final String NM_LOG_AGG_POLICY_CLASS_PARAMETERS = NM_PREFIX
1410      + "log-aggregation.policy.parameters";
1411
1412  ////////////////////////////////
1413  // Web Proxy Configs
1414  ////////////////////////////////
1415  public static final String PROXY_PREFIX = "yarn.web-proxy.";
1416  
1417  /** The kerberos principal for the proxy.*/
1418  public static final String PROXY_PRINCIPAL =
1419    PROXY_PREFIX + "principal";
1420  
1421  /** Keytab for Proxy.*/
1422  public static final String PROXY_KEYTAB = PROXY_PREFIX + "keytab";
1423  
1424  /** The address for the web proxy.*/
1425  public static final String PROXY_ADDRESS =
1426    PROXY_PREFIX + "address";
1427  public static final int DEFAULT_PROXY_PORT = 9099;
1428  public static final String DEFAULT_PROXY_ADDRESS =
1429    "0.0.0.0:" + DEFAULT_PROXY_PORT;
1430  
1431  /**
1432   * YARN Service Level Authorization
1433   */
1434  public static final String 
1435  YARN_SECURITY_SERVICE_AUTHORIZATION_RESOURCETRACKER_PROTOCOL =
1436      "security.resourcetracker.protocol.acl";
1437  public static final String 
1438  YARN_SECURITY_SERVICE_AUTHORIZATION_APPLICATIONCLIENT_PROTOCOL =
1439      "security.applicationclient.protocol.acl";
1440  public static final String 
1441  YARN_SECURITY_SERVICE_AUTHORIZATION_RESOURCEMANAGER_ADMINISTRATION_PROTOCOL =
1442      "security.resourcemanager-administration.protocol.acl";
1443  public static final String 
1444  YARN_SECURITY_SERVICE_AUTHORIZATION_APPLICATIONMASTER_PROTOCOL =
1445      "security.applicationmaster.protocol.acl";
1446
1447  public static final String 
1448  YARN_SECURITY_SERVICE_AUTHORIZATION_CONTAINER_MANAGEMENT_PROTOCOL =
1449      "security.containermanagement.protocol.acl";
1450  public static final String 
1451  YARN_SECURITY_SERVICE_AUTHORIZATION_RESOURCE_LOCALIZER =
1452      "security.resourcelocalizer.protocol.acl";
1453
1454  public static final String
1455  YARN_SECURITY_SERVICE_AUTHORIZATION_APPLICATIONHISTORY_PROTOCOL =
1456      "security.applicationhistory.protocol.acl";
1457
1458  /** No. of milliseconds to wait between sending a SIGTERM and SIGKILL
1459   * to a running container */
1460  public static final String NM_SLEEP_DELAY_BEFORE_SIGKILL_MS =
1461      NM_PREFIX + "sleep-delay-before-sigkill.ms";
1462  public static final long DEFAULT_NM_SLEEP_DELAY_BEFORE_SIGKILL_MS =
1463      250;
1464
1465  /** Max time to wait for a process to come up when trying to cleanup
1466   * container resources */
1467  public static final String NM_PROCESS_KILL_WAIT_MS =
1468      NM_PREFIX + "process-kill-wait.ms";
1469  public static final long DEFAULT_NM_PROCESS_KILL_WAIT_MS =
1470      2000;
1471
1472  /** Max time to wait to establish a connection to RM */
1473  public static final String RESOURCEMANAGER_CONNECT_MAX_WAIT_MS =
1474      RM_PREFIX + "connect.max-wait.ms";
1475  public static final long DEFAULT_RESOURCEMANAGER_CONNECT_MAX_WAIT_MS =
1476      15 * 60 * 1000;
1477
1478  /** Time interval between each attempt to connect to RM */
1479  public static final String RESOURCEMANAGER_CONNECT_RETRY_INTERVAL_MS =
1480      RM_PREFIX + "connect.retry-interval.ms";
1481  public static final long DEFAULT_RESOURCEMANAGER_CONNECT_RETRY_INTERVAL_MS
1482      = 30 * 1000;
1483
1484  public static final String DISPATCHER_DRAIN_EVENTS_TIMEOUT =
1485      YARN_PREFIX + "dispatcher.drain-events.timeout";
1486
1487  public static final long DEFAULT_DISPATCHER_DRAIN_EVENTS_TIMEOUT = 300000;
1488
1489  /**
1490   * CLASSPATH for YARN applications. A comma-separated list of CLASSPATH
1491   * entries
1492   */
1493  public static final String YARN_APPLICATION_CLASSPATH = YARN_PREFIX
1494      + "application.classpath";
1495
1496  public static final String AMRM_PROXY_ENABLED = NM_PREFIX
1497      + "amrmproxy.enable";
1498  public static final boolean DEFAULT_AMRM_PROXY_ENABLED = false;
1499  public static final String AMRM_PROXY_ADDRESS = NM_PREFIX
1500      + "amrmproxy.address";
1501  public static final int DEFAULT_AMRM_PROXY_PORT = 8048;
1502  public static final String DEFAULT_AMRM_PROXY_ADDRESS = "0.0.0.0:"
1503      + DEFAULT_AMRM_PROXY_PORT;
1504  public static final String AMRM_PROXY_CLIENT_THREAD_COUNT = NM_PREFIX
1505      + "amrmproxy.client.thread-count";
1506  public static final int DEFAULT_AMRM_PROXY_CLIENT_THREAD_COUNT = 25;
1507  public static final String AMRM_PROXY_INTERCEPTOR_CLASS_PIPELINE =
1508      NM_PREFIX + "amrmproxy.interceptor-class.pipeline";
1509  public static final String DEFAULT_AMRM_PROXY_INTERCEPTOR_CLASS_PIPELINE =
1510      "org.apache.hadoop.yarn.server.nodemanager.amrmproxy."
1511          + "DefaultRequestInterceptor";
1512
1513  /**
1514   * Default platform-agnostic CLASSPATH for YARN applications. A
1515   * comma-separated list of CLASSPATH entries. The parameter expansion marker
1516   * will be replaced with real parameter expansion marker ('%' for Windows and
1517   * '$' for Linux) by NodeManager on container launch. For example: {{VAR}}
1518   * will be replaced as $VAR on Linux, and %VAR% on Windows.
1519   */
1520  @Public
1521  @Unstable
1522  public static final String[] DEFAULT_YARN_CROSS_PLATFORM_APPLICATION_CLASSPATH= {
1523      ApplicationConstants.Environment.HADOOP_CONF_DIR.$$(),
1524      ApplicationConstants.Environment.HADOOP_COMMON_HOME.$$()
1525          + "/share/hadoop/common/*",
1526      ApplicationConstants.Environment.HADOOP_COMMON_HOME.$$()
1527          + "/share/hadoop/common/lib/*",
1528      ApplicationConstants.Environment.HADOOP_HDFS_HOME.$$()
1529          + "/share/hadoop/hdfs/*",
1530      ApplicationConstants.Environment.HADOOP_HDFS_HOME.$$()
1531          + "/share/hadoop/hdfs/lib/*",
1532      ApplicationConstants.Environment.HADOOP_YARN_HOME.$$()
1533          + "/share/hadoop/yarn/*",
1534      ApplicationConstants.Environment.HADOOP_YARN_HOME.$$()
1535          + "/share/hadoop/yarn/lib/*" };
1536  /**
1537   * <p>
1538   * Default platform-specific CLASSPATH for YARN applications. A
1539   * comma-separated list of CLASSPATH entries constructed based on the client
1540   * OS environment expansion syntax.
1541   * </p>
1542   * <p>
1543   * Note: Use {@link #DEFAULT_YARN_CROSS_PLATFORM_APPLICATION_CLASSPATH} for
1544   * cross-platform practice i.e. submit an application from a Windows client to
1545   * a Linux/Unix server or vice versa.
1546   * </p>
1547   */
1548  public static final String[] DEFAULT_YARN_APPLICATION_CLASSPATH = {
1549      ApplicationConstants.Environment.HADOOP_CONF_DIR.$(),
1550      ApplicationConstants.Environment.HADOOP_COMMON_HOME.$()
1551          + "/share/hadoop/common/*",
1552      ApplicationConstants.Environment.HADOOP_COMMON_HOME.$()
1553          + "/share/hadoop/common/lib/*",
1554      ApplicationConstants.Environment.HADOOP_HDFS_HOME.$()
1555          + "/share/hadoop/hdfs/*",
1556      ApplicationConstants.Environment.HADOOP_HDFS_HOME.$()
1557          + "/share/hadoop/hdfs/lib/*",
1558      ApplicationConstants.Environment.HADOOP_YARN_HOME.$()
1559          + "/share/hadoop/yarn/*",
1560      ApplicationConstants.Environment.HADOOP_YARN_HOME.$()
1561          + "/share/hadoop/yarn/lib/*" };
1562
1563  /** Container temp directory */
1564  public static final String DEFAULT_CONTAINER_TEMP_DIR = "./tmp";
1565
1566  public static final String IS_MINI_YARN_CLUSTER = YARN_PREFIX
1567      + "is.minicluster";
1568
1569  public static final String YARN_MC_PREFIX = YARN_PREFIX + "minicluster.";
1570
1571  /** Whether to use fixed ports with the minicluster. */
1572  public static final String YARN_MINICLUSTER_FIXED_PORTS =
1573      YARN_MC_PREFIX + "fixed.ports";
1574
1575  /**
1576   * Default is false to be able to run tests concurrently without port
1577   * conflicts.
1578   */
1579  public static final boolean DEFAULT_YARN_MINICLUSTER_FIXED_PORTS = false;
1580
1581  /**
1582   * Whether the NM should use RPC to connect to the RM. Default is false.
1583   * Can be set to true only when using fixed ports.
1584   */
1585  public static final String YARN_MINICLUSTER_USE_RPC = YARN_MC_PREFIX + "use-rpc";
1586  public static final boolean DEFAULT_YARN_MINICLUSTER_USE_RPC = false;
1587
1588  /**
1589   * Whether users are explicitly trying to control resource monitoring
1590   * configuration for the MiniYARNCluster. Disabled by default.
1591   */
1592  public static final String YARN_MINICLUSTER_CONTROL_RESOURCE_MONITORING =
1593      YARN_MC_PREFIX + "control-resource-monitoring";
1594  public static final boolean
1595      DEFAULT_YARN_MINICLUSTER_CONTROL_RESOURCE_MONITORING = false;
1596
1597  /** Allow changing the memory for the NodeManager in the MiniYARNCluster */
1598  public static final String YARN_MINICLUSTER_NM_PMEM_MB =
1599      YARN_MC_PREFIX + YarnConfiguration.NM_PMEM_MB;
1600  public static final int DEFAULT_YARN_MINICLUSTER_NM_PMEM_MB = 4 * 1024;
1601
1602  /** The log directory for the containers */
1603  public static final String YARN_APP_CONTAINER_LOG_DIR =
1604      YARN_PREFIX + "app.container.log.dir";
1605
1606  public static final String YARN_APP_CONTAINER_LOG_SIZE =
1607      YARN_PREFIX + "app.container.log.filesize";
1608
1609  public static final String YARN_APP_CONTAINER_LOG_BACKUPS =
1610      YARN_PREFIX + "app.container.log.backups";
1611
1612  ////////////////////////////////
1613  // Timeline Service Configs
1614  ////////////////////////////////
1615
1616  public static final String TIMELINE_SERVICE_PREFIX =
1617      YARN_PREFIX + "timeline-service.";
1618
1619  public static final String TIMELINE_SERVICE_VERSION = TIMELINE_SERVICE_PREFIX
1620      + "version";
1621  public static final float DEFAULT_TIMELINE_SERVICE_VERSION = 1.0f;
1622
1623  /**
1624   * Comma seperated list of names for UIs hosted in the timeline server
1625   * (For pluggable UIs).
1626   */
1627  public static final String TIMELINE_SERVICE_UI_NAMES =
1628      TIMELINE_SERVICE_PREFIX + "ui-names";
1629
1630  /** Relative web path that will serve up this UI (For pluggable UIs). */
1631  public static final String TIMELINE_SERVICE_UI_WEB_PATH_PREFIX =
1632      TIMELINE_SERVICE_PREFIX + "ui-web-path.";
1633
1634  /** Timeline client settings */
1635  public static final String TIMELINE_SERVICE_CLIENT_PREFIX =
1636      TIMELINE_SERVICE_PREFIX + "client.";
1637
1638  /**
1639   * Path to war file or static content directory for this UI
1640   * (For pluggable UIs).
1641   */
1642  public static final String TIMELINE_SERVICE_UI_ON_DISK_PATH_PREFIX =
1643      TIMELINE_SERVICE_PREFIX + "ui-on-disk-path.";
1644
1645  /**
1646   * The setting for timeline service v1.5
1647   */
1648  public static final String TIMELINE_SERVICE_ENTITYGROUP_FS_STORE_PREFIX =
1649      TIMELINE_SERVICE_PREFIX + "entity-group-fs-store.";
1650
1651  public static final String TIMELINE_SERVICE_ENTITYGROUP_FS_STORE_ACTIVE_DIR =
1652      TIMELINE_SERVICE_ENTITYGROUP_FS_STORE_PREFIX + "active-dir";
1653
1654  public static final String
1655      TIMELINE_SERVICE_ENTITYGROUP_FS_STORE_ACTIVE_DIR_DEFAULT =
1656      "/tmp/entity-file-history/active";
1657
1658  public static final String TIMELINE_SERVICE_ENTITYGROUP_FS_STORE_DONE_DIR =
1659      TIMELINE_SERVICE_ENTITYGROUP_FS_STORE_PREFIX + "done-dir";
1660  public static final String
1661      TIMELINE_SERVICE_ENTITYGROUP_FS_STORE_DONE_DIR_DEFAULT =
1662      "/tmp/entity-file-history/done";
1663
1664  public static final String TIMELINE_SERVICE_ENTITY_GROUP_PLUGIN_CLASSES =
1665      TIMELINE_SERVICE_ENTITYGROUP_FS_STORE_PREFIX + "group-id-plugin-classes";
1666
1667  public static final String
1668      TIMELINE_SERVICE_ENTITYGROUP_FS_STORE_SUMMARY_STORE =
1669      TIMELINE_SERVICE_ENTITYGROUP_FS_STORE_PREFIX + "summary-store";
1670
1671  public static final String
1672      TIMELINE_SERVICE_ENTITYGROUP_FS_STORE_SUMMARY_ENTITY_TYPES =
1673      TIMELINE_SERVICE_ENTITYGROUP_FS_STORE_PREFIX + "summary-entity-types";
1674
1675  public static final String
1676      TIMELINE_SERVICE_ENTITYGROUP_FS_STORE_SCAN_INTERVAL_SECONDS =
1677      TIMELINE_SERVICE_ENTITYGROUP_FS_STORE_PREFIX + "scan-interval-seconds";
1678  public static final long
1679      TIMELINE_SERVICE_ENTITYGROUP_FS_STORE_SCAN_INTERVAL_SECONDS_DEFAULT = 60;
1680
1681  public static final String TIMELINE_SERVICE_ENTITYGROUP_FS_STORE_THREADS =
1682      TIMELINE_SERVICE_ENTITYGROUP_FS_STORE_PREFIX + "threads";
1683  public static final int
1684      TIMELINE_SERVICE_ENTITYGROUP_FS_STORE_THREADS_DEFAULT = 16;
1685
1686  public static final String
1687      TIMELINE_SERVICE_ENTITYGROUP_FS_STORE_APP_CACHE_SIZE
1688      = TIMELINE_SERVICE_ENTITYGROUP_FS_STORE_PREFIX + "app-cache-size";
1689  public static final int
1690      TIMELINE_SERVICE_ENTITYGROUP_FS_STORE_APP_CACHE_SIZE_DEFAULT = 10;
1691
1692  public static final String
1693      TIMELINE_SERVICE_ENTITYGROUP_FS_STORE_CLEANER_INTERVAL_SECONDS =
1694      TIMELINE_SERVICE_ENTITYGROUP_FS_STORE_PREFIX + "cleaner-interval-seconds";
1695  public static final int
1696      TIMELINE_SERVICE_ENTITYGROUP_FS_STORE_CLEANER_INTERVAL_SECONDS_DEFAULT =
1697        60 * 60;
1698
1699  public static final String
1700      TIMELINE_SERVICE_ENTITYGROUP_FS_STORE_RETAIN_SECONDS
1701      = TIMELINE_SERVICE_ENTITYGROUP_FS_STORE_PREFIX + "retain-seconds";
1702  public static final int
1703      TIMELINE_SERVICE_ENTITYGROUP_FS_STORE_RETAIN_SECONDS_DEFAULT =
1704        7 * 24 * 60 * 60;
1705
1706  // how old the most recent log of an UNKNOWN app needs to be in the active
1707  // directory before we treat it as COMPLETED
1708  public static final String
1709      TIMELINE_SERVICE_ENTITYGROUP_FS_STORE_UNKNOWN_ACTIVE_SECONDS =
1710      TIMELINE_SERVICE_ENTITYGROUP_FS_STORE_PREFIX + "unknown-active-seconds";
1711  public static final int
1712      TIMELINE_SERVICE_ENTITYGROUP_FS_STORE_UNKNOWN_ACTIVE_SECONDS_DEFAULT
1713      = 24 * 60 * 60;
1714
1715  public static final String
1716      TIMELINE_SERVICE_ENTITYGROUP_FS_STORE_RETRY_POLICY_SPEC =
1717      TIMELINE_SERVICE_ENTITYGROUP_FS_STORE_PREFIX + "retry-policy-spec";
1718  public static final String
1719      DEFAULT_TIMELINE_SERVICE_ENTITYGROUP_FS_STORE_RETRY_POLICY_SPEC =
1720      "2000, 500";
1721
1722  public static final String TIMELINE_SERVICE_LEVELDB_CACHE_READ_CACHE_SIZE =
1723      TIMELINE_SERVICE_ENTITYGROUP_FS_STORE_PREFIX
1724          + "leveldb-cache-read-cache-size";
1725
1726  public static final long
1727      DEFAULT_TIMELINE_SERVICE_LEVELDB_CACHE_READ_CACHE_SIZE = 10 * 1024 * 1024;
1728
1729  public static final String TIMELINE_SERVICE_CLIENT_FD_FLUSH_INTERVAL_SECS =
1730      TIMELINE_SERVICE_CLIENT_PREFIX + "fd-flush-interval-secs";
1731  public static final long
1732      TIMELINE_SERVICE_CLIENT_FD_FLUSH_INTERVAL_SECS_DEFAULT = 10;
1733
1734  public static final String TIMELINE_SERVICE_CLIENT_FD_CLEAN_INTERVAL_SECS =
1735      TIMELINE_SERVICE_CLIENT_PREFIX + "fd-clean-interval-secs";
1736  public static final long
1737      TIMELINE_SERVICE_CLIENT_FD_CLEAN_INTERVAL_SECS_DEFAULT = 60;
1738
1739  public static final String TIMELINE_SERVICE_CLIENT_FD_RETAIN_SECS =
1740      TIMELINE_SERVICE_CLIENT_PREFIX + "fd-retain-secs";
1741  public static final long TIMELINE_SERVICE_CLIENT_FD_RETAIN_SECS_DEFAULT =
1742      5*60;
1743
1744  public static final String
1745      TIMELINE_SERVICE_CLIENT_INTERNAL_TIMERS_TTL_SECS =
1746      TIMELINE_SERVICE_CLIENT_PREFIX + "internal-timers-ttl-secs";
1747  public static final long
1748      TIMELINE_SERVICE_CLIENT_INTERNAL_TIMERS_TTL_SECS_DEFAULT = 7 * 60;
1749
1750  // mark app-history related configs @Private as application history is going
1751  // to be integrated into the timeline service
1752  @Private
1753  public static final String APPLICATION_HISTORY_PREFIX =
1754      TIMELINE_SERVICE_PREFIX + "generic-application-history.";
1755
1756  /**
1757   *  The setting that controls whether application history service is
1758   *  enabled or not.
1759   */
1760  @Private
1761  public static final String APPLICATION_HISTORY_ENABLED =
1762      APPLICATION_HISTORY_PREFIX + "enabled";
1763  @Private
1764  public static final boolean DEFAULT_APPLICATION_HISTORY_ENABLED = false;
1765
1766  /** Application history store class */
1767  @Private
1768  public static final String APPLICATION_HISTORY_STORE =
1769      APPLICATION_HISTORY_PREFIX + "store-class";
1770
1771  /** Save container meta-info in the application history store. */
1772  @Private
1773  public static final String
1774      APPLICATION_HISTORY_SAVE_NON_AM_CONTAINER_META_INFO =
1775        APPLICATION_HISTORY_PREFIX + "save-non-am-container-meta-info";
1776  @Private
1777  public static final boolean
1778            DEFAULT_APPLICATION_HISTORY_SAVE_NON_AM_CONTAINER_META_INFO = true;
1779
1780  /** URI for FileSystemApplicationHistoryStore */
1781  @Private
1782  public static final String FS_APPLICATION_HISTORY_STORE_URI =
1783      APPLICATION_HISTORY_PREFIX + "fs-history-store.uri";
1784
1785  /** T-file compression types used to compress history data.*/
1786  @Private
1787  public static final String FS_APPLICATION_HISTORY_STORE_COMPRESSION_TYPE =
1788      APPLICATION_HISTORY_PREFIX + "fs-history-store.compression-type";
1789  @Private
1790  public static final String
1791      DEFAULT_FS_APPLICATION_HISTORY_STORE_COMPRESSION_TYPE = "none";
1792
1793  /** The setting that controls whether timeline service is enabled or not. */
1794  public static final String TIMELINE_SERVICE_ENABLED =
1795      TIMELINE_SERVICE_PREFIX + "enabled";
1796  public static final boolean DEFAULT_TIMELINE_SERVICE_ENABLED = false;
1797
1798  /** host:port address for timeline service RPC APIs. */
1799  public static final String TIMELINE_SERVICE_ADDRESS =
1800      TIMELINE_SERVICE_PREFIX + "address";
1801  public static final int DEFAULT_TIMELINE_SERVICE_PORT = 10200;
1802  public static final String DEFAULT_TIMELINE_SERVICE_ADDRESS = "0.0.0.0:"
1803      + DEFAULT_TIMELINE_SERVICE_PORT;
1804
1805  /** The listening endpoint for the timeline service application.*/
1806  public static final String TIMELINE_SERVICE_BIND_HOST =
1807      TIMELINE_SERVICE_PREFIX + "bind-host";
1808
1809  /** The number of threads to handle client RPC API requests. */
1810  public static final String TIMELINE_SERVICE_HANDLER_THREAD_COUNT =
1811      TIMELINE_SERVICE_PREFIX + "handler-thread-count";
1812  public static final int DEFAULT_TIMELINE_SERVICE_CLIENT_THREAD_COUNT = 10;
1813  
1814
1815  /** The address of the timeline service web application.*/
1816  public static final String TIMELINE_SERVICE_WEBAPP_ADDRESS =
1817      TIMELINE_SERVICE_PREFIX  + "webapp.address";
1818
1819  public static final int DEFAULT_TIMELINE_SERVICE_WEBAPP_PORT = 8188;
1820  public static final String DEFAULT_TIMELINE_SERVICE_WEBAPP_ADDRESS =
1821      "0.0.0.0:" + DEFAULT_TIMELINE_SERVICE_WEBAPP_PORT;
1822
1823  /** The https address of the timeline service web application.*/
1824  public static final String TIMELINE_SERVICE_WEBAPP_HTTPS_ADDRESS =
1825      TIMELINE_SERVICE_PREFIX + "webapp.https.address";
1826
1827  public static final int DEFAULT_TIMELINE_SERVICE_WEBAPP_HTTPS_PORT = 8190;
1828  public static final String DEFAULT_TIMELINE_SERVICE_WEBAPP_HTTPS_ADDRESS =
1829      "0.0.0.0:" + DEFAULT_TIMELINE_SERVICE_WEBAPP_HTTPS_PORT;
1830
1831  /**
1832   * Defines the max number of applications could be fetched using
1833   * REST API or application history protocol and shown in timeline
1834   * server web ui.
1835   */
1836  public static final String APPLICATION_HISTORY_MAX_APPS =
1837      APPLICATION_HISTORY_PREFIX + "max-applications";
1838  public static final long DEFAULT_APPLICATION_HISTORY_MAX_APPS = 10000;
1839
1840  /** Timeline service store class. */
1841  public static final String TIMELINE_SERVICE_STORE =
1842      TIMELINE_SERVICE_PREFIX + "store-class";
1843
1844  /** Timeline service enable data age off */
1845  public static final String TIMELINE_SERVICE_TTL_ENABLE =
1846      TIMELINE_SERVICE_PREFIX + "ttl-enable";
1847
1848  /** Timeline service length of time to retain data */
1849  public static final String TIMELINE_SERVICE_TTL_MS =
1850      TIMELINE_SERVICE_PREFIX + "ttl-ms";
1851
1852  public static final long DEFAULT_TIMELINE_SERVICE_TTL_MS =
1853      1000 * 60 * 60 * 24 * 7;
1854
1855  /** Timeline service rolling period. Valid values are daily, half_daily,
1856   * quarter_daily, and hourly. */
1857  public static final String TIMELINE_SERVICE_ROLLING_PERIOD =
1858      TIMELINE_SERVICE_PREFIX + "rolling-period";
1859
1860  /** Roll a new database each hour. */
1861  public static final String DEFAULT_TIMELINE_SERVICE_ROLLING_PERIOD =
1862      "hourly";
1863
1864  /** Implementation specific configuration prefix for Timeline Service
1865   * leveldb.
1866   */
1867  public static final String TIMELINE_SERVICE_LEVELDB_PREFIX =
1868      TIMELINE_SERVICE_PREFIX + "leveldb-timeline-store.";
1869
1870  /** Timeline service leveldb path */
1871  public static final String TIMELINE_SERVICE_LEVELDB_PATH =
1872      TIMELINE_SERVICE_LEVELDB_PREFIX + "path";
1873
1874  /** Timeline service leveldb read cache (uncompressed blocks). This is
1875   * per rolling instance so should be tuned if using rolling leveldb
1876   * timeline store */
1877  public static final String TIMELINE_SERVICE_LEVELDB_READ_CACHE_SIZE =
1878      TIMELINE_SERVICE_LEVELDB_PREFIX + "read-cache-size";
1879
1880  /** Default leveldb read cache size if no configuration is specified. */
1881  public static final long DEFAULT_TIMELINE_SERVICE_LEVELDB_READ_CACHE_SIZE =
1882      100 * 1024 * 1024;
1883
1884  /** Timeline service leveldb write buffer size. */
1885  public static final String TIMELINE_SERVICE_LEVELDB_WRITE_BUFFER_SIZE =
1886      TIMELINE_SERVICE_LEVELDB_PREFIX + "write-buffer-size";
1887
1888  /** Default leveldb write buffer size if no configuration is specified. This
1889   * is per rolling instance so should be tuned if using rolling leveldb
1890   * timeline store. */
1891  public static final int DEFAULT_TIMELINE_SERVICE_LEVELDB_WRITE_BUFFER_SIZE =
1892      16 * 1024 * 1024;
1893
1894  /** Timeline service leveldb write batch size. This value can be tuned down
1895   * to reduce lock time for ttl eviction. */
1896  public static final String
1897      TIMELINE_SERVICE_LEVELDB_WRITE_BATCH_SIZE =
1898      TIMELINE_SERVICE_LEVELDB_PREFIX + "write-batch-size";
1899
1900  /** Default leveldb write batch size is no configuration is specified */
1901  public static final int
1902      DEFAULT_TIMELINE_SERVICE_LEVELDB_WRITE_BATCH_SIZE = 10000;
1903
1904  /** Timeline service leveldb start time read cache (number of entities) */
1905  public static final String
1906      TIMELINE_SERVICE_LEVELDB_START_TIME_READ_CACHE_SIZE =
1907      TIMELINE_SERVICE_LEVELDB_PREFIX + "start-time-read-cache-size";
1908
1909  public static final int
1910      DEFAULT_TIMELINE_SERVICE_LEVELDB_START_TIME_READ_CACHE_SIZE = 10000;
1911
1912  /** Timeline service leveldb start time write cache (number of entities) */
1913  public static final String
1914      TIMELINE_SERVICE_LEVELDB_START_TIME_WRITE_CACHE_SIZE =
1915      TIMELINE_SERVICE_LEVELDB_PREFIX + "start-time-write-cache-size";
1916
1917  public static final int
1918      DEFAULT_TIMELINE_SERVICE_LEVELDB_START_TIME_WRITE_CACHE_SIZE = 10000;
1919
1920  /** Timeline service leveldb interval to wait between deletion rounds */
1921  public static final String TIMELINE_SERVICE_LEVELDB_TTL_INTERVAL_MS =
1922      TIMELINE_SERVICE_LEVELDB_PREFIX + "ttl-interval-ms";
1923
1924  public static final long DEFAULT_TIMELINE_SERVICE_LEVELDB_TTL_INTERVAL_MS =
1925      1000 * 60 * 5;
1926
1927  /** Timeline service leveldb number of concurrent open files. Tuned this
1928   * configuration to stay within system limits. This is per rolling instance
1929   * so should be tuned if using rolling leveldb timeline store. */
1930  public static final String TIMELINE_SERVICE_LEVELDB_MAX_OPEN_FILES =
1931      TIMELINE_SERVICE_LEVELDB_PREFIX + "max-open-files";
1932
1933  /** Default leveldb max open files if no configuration is specified. */
1934  public static final int DEFAULT_TIMELINE_SERVICE_LEVELDB_MAX_OPEN_FILES =
1935      1000;
1936
1937  /** The Kerberos principal for the timeline server.*/
1938  public static final String TIMELINE_SERVICE_PRINCIPAL =
1939      TIMELINE_SERVICE_PREFIX + "principal";
1940
1941  /** The Kerberos keytab for the timeline server.*/
1942  public static final String TIMELINE_SERVICE_KEYTAB =
1943      TIMELINE_SERVICE_PREFIX + "keytab";
1944
1945  /** Enables cross origin support for timeline server.*/
1946  public static final String TIMELINE_SERVICE_HTTP_CROSS_ORIGIN_ENABLED =
1947      TIMELINE_SERVICE_PREFIX + "http-cross-origin.enabled";
1948
1949  /** Default value for cross origin support for timeline server.*/
1950  public static final boolean
1951      TIMELINE_SERVICE_HTTP_CROSS_ORIGIN_ENABLED_DEFAULT = false;
1952
1953  /** Timeline client call, max retries (-1 means no limit) */
1954  public static final String TIMELINE_SERVICE_CLIENT_MAX_RETRIES =
1955      TIMELINE_SERVICE_CLIENT_PREFIX + "max-retries";
1956
1957  public static final int DEFAULT_TIMELINE_SERVICE_CLIENT_MAX_RETRIES = 30;
1958
1959  /** Timeline client call, retry interval */
1960  public static final String TIMELINE_SERVICE_CLIENT_RETRY_INTERVAL_MS =
1961      TIMELINE_SERVICE_CLIENT_PREFIX + "retry-interval-ms";
1962
1963  public static final long
1964      DEFAULT_TIMELINE_SERVICE_CLIENT_RETRY_INTERVAL_MS = 1000;
1965
1966  /** Timeline client policy for whether connections are fatal */
1967  public static final String TIMELINE_SERVICE_CLIENT_BEST_EFFORT =
1968      TIMELINE_SERVICE_CLIENT_PREFIX + "best-effort";
1969
1970  public static final boolean
1971      DEFAULT_TIMELINE_SERVICE_CLIENT_BEST_EFFORT = false;
1972
1973  /** Flag to enable recovery of timeline service */
1974  public static final String TIMELINE_SERVICE_RECOVERY_ENABLED =
1975      TIMELINE_SERVICE_PREFIX + "recovery.enabled";
1976  public static final boolean DEFAULT_TIMELINE_SERVICE_RECOVERY_ENABLED = false;
1977
1978  /** Timeline service state store class */
1979  public static final String TIMELINE_SERVICE_STATE_STORE_CLASS =
1980      TIMELINE_SERVICE_PREFIX + "state-store-class";
1981
1982  public static final String TIMELINE_SERVICE_LEVELDB_STATE_STORE_PREFIX =
1983      TIMELINE_SERVICE_PREFIX + "leveldb-state-store.";
1984
1985  /** Timeline service state store leveldb path */
1986  public static final String TIMELINE_SERVICE_LEVELDB_STATE_STORE_PATH =
1987      TIMELINE_SERVICE_LEVELDB_STATE_STORE_PREFIX + "path";
1988
1989  // Timeline delegation token related keys
1990  public static final String  TIMELINE_DELEGATION_KEY_UPDATE_INTERVAL =
1991      TIMELINE_SERVICE_PREFIX + "delegation.key.update-interval";
1992  public static final long    DEFAULT_TIMELINE_DELEGATION_KEY_UPDATE_INTERVAL =
1993      24*60*60*1000; // 1 day
1994  public static final String  TIMELINE_DELEGATION_TOKEN_RENEW_INTERVAL =
1995      TIMELINE_SERVICE_PREFIX + "delegation.token.renew-interval";
1996  public static final long    DEFAULT_TIMELINE_DELEGATION_TOKEN_RENEW_INTERVAL =
1997      24*60*60*1000;  // 1 day
1998  public static final String  TIMELINE_DELEGATION_TOKEN_MAX_LIFETIME =
1999      TIMELINE_SERVICE_PREFIX + "delegation.token.max-lifetime";
2000  public static final long    DEFAULT_TIMELINE_DELEGATION_TOKEN_MAX_LIFETIME =
2001      7*24*60*60*1000; // 7 days
2002
2003  // ///////////////////////////////
2004  // Shared Cache Configs
2005  // ///////////////////////////////
2006  public static final String SHARED_CACHE_PREFIX = "yarn.sharedcache.";
2007
2008  // common configs
2009  /** whether the shared cache is enabled/disabled */
2010  public static final String SHARED_CACHE_ENABLED =
2011      SHARED_CACHE_PREFIX + "enabled";
2012  public static final boolean DEFAULT_SHARED_CACHE_ENABLED = false;
2013
2014  /** The config key for the shared cache root directory. */
2015  public static final String SHARED_CACHE_ROOT =
2016      SHARED_CACHE_PREFIX + "root-dir";
2017  public static final String DEFAULT_SHARED_CACHE_ROOT = "/sharedcache";
2018
2019  /** The config key for the level of nested directories before getting to the
2020   * checksum directory. */
2021  public static final String SHARED_CACHE_NESTED_LEVEL =
2022      SHARED_CACHE_PREFIX + "nested-level";
2023  public static final int DEFAULT_SHARED_CACHE_NESTED_LEVEL = 3;
2024  
2025  // Shared Cache Manager Configs
2026
2027  public static final String SCM_STORE_PREFIX = SHARED_CACHE_PREFIX + "store.";
2028
2029  public static final String SCM_STORE_CLASS = SCM_STORE_PREFIX + "class";
2030  public static final String DEFAULT_SCM_STORE_CLASS =
2031      "org.apache.hadoop.yarn.server.sharedcachemanager.store.InMemorySCMStore";
2032
2033  public static final String SCM_APP_CHECKER_CLASS = SHARED_CACHE_PREFIX
2034      + "app-checker.class";
2035  public static final String DEFAULT_SCM_APP_CHECKER_CLASS =
2036      "org.apache.hadoop.yarn.server.sharedcachemanager.RemoteAppChecker";
2037
2038  /** The address of the SCM admin interface. */
2039  public static final String SCM_ADMIN_ADDRESS =
2040      SHARED_CACHE_PREFIX + "admin.address";
2041  public static final int DEFAULT_SCM_ADMIN_PORT = 8047;
2042  public static final String DEFAULT_SCM_ADMIN_ADDRESS =
2043      "0.0.0.0:" + DEFAULT_SCM_ADMIN_PORT;
2044
2045  /** Number of threads used to handle SCM admin interface. */
2046  public static final String SCM_ADMIN_CLIENT_THREAD_COUNT =
2047      SHARED_CACHE_PREFIX + "admin.thread-count";
2048  public static final int DEFAULT_SCM_ADMIN_CLIENT_THREAD_COUNT = 1;
2049
2050  /** The address of the SCM web application. */
2051  public static final String SCM_WEBAPP_ADDRESS =
2052      SHARED_CACHE_PREFIX + "webapp.address";
2053  public static final int DEFAULT_SCM_WEBAPP_PORT = 8788;
2054  public static final String DEFAULT_SCM_WEBAPP_ADDRESS =
2055      "0.0.0.0:" + DEFAULT_SCM_WEBAPP_PORT;
2056
2057  // In-memory SCM store configuration
2058  
2059  public static final String IN_MEMORY_STORE_PREFIX =
2060      SCM_STORE_PREFIX + "in-memory.";
2061
2062  /**
2063   * A resource in the InMemorySCMStore is considered stale if the time since
2064   * the last reference exceeds the staleness period. This value is specified in
2065   * minutes.
2066   */
2067  public static final String IN_MEMORY_STALENESS_PERIOD_MINS =
2068      IN_MEMORY_STORE_PREFIX + "staleness-period-mins";
2069  public static final int DEFAULT_IN_MEMORY_STALENESS_PERIOD_MINS =
2070      7 * 24 * 60;
2071
2072  /**
2073   * Initial delay before the in-memory store runs its first check to remove
2074   * dead initial applications. Specified in minutes.
2075   */
2076  public static final String IN_MEMORY_INITIAL_DELAY_MINS =
2077      IN_MEMORY_STORE_PREFIX + "initial-delay-mins";
2078  public static final int DEFAULT_IN_MEMORY_INITIAL_DELAY_MINS = 10;
2079  
2080  /**
2081   * The frequency at which the in-memory store checks to remove dead initial
2082   * applications. Specified in minutes.
2083   */
2084  public static final String IN_MEMORY_CHECK_PERIOD_MINS =
2085      IN_MEMORY_STORE_PREFIX + "check-period-mins";
2086  public static final int DEFAULT_IN_MEMORY_CHECK_PERIOD_MINS = 12 * 60;
2087
2088  // SCM Cleaner service configuration
2089
2090  private static final String SCM_CLEANER_PREFIX = SHARED_CACHE_PREFIX
2091      + "cleaner.";
2092
2093  /**
2094   * The frequency at which a cleaner task runs. Specified in minutes.
2095   */
2096  public static final String SCM_CLEANER_PERIOD_MINS =
2097      SCM_CLEANER_PREFIX + "period-mins";
2098  public static final int DEFAULT_SCM_CLEANER_PERIOD_MINS = 24 * 60;
2099
2100  /**
2101   * Initial delay before the first cleaner task is scheduled. Specified in
2102   * minutes.
2103   */
2104  public static final String SCM_CLEANER_INITIAL_DELAY_MINS =
2105      SCM_CLEANER_PREFIX + "initial-delay-mins";
2106  public static final int DEFAULT_SCM_CLEANER_INITIAL_DELAY_MINS = 10;
2107
2108  /**
2109   * The time to sleep between processing each shared cache resource. Specified
2110   * in milliseconds.
2111   */
2112  public static final String SCM_CLEANER_RESOURCE_SLEEP_MS =
2113      SCM_CLEANER_PREFIX + "resource-sleep-ms";
2114  public static final long DEFAULT_SCM_CLEANER_RESOURCE_SLEEP_MS = 0L;
2115
2116  /** The address of the node manager interface in the SCM. */
2117  public static final String SCM_UPLOADER_SERVER_ADDRESS = SHARED_CACHE_PREFIX
2118      + "uploader.server.address";
2119  public static final int DEFAULT_SCM_UPLOADER_SERVER_PORT = 8046;
2120  public static final String DEFAULT_SCM_UPLOADER_SERVER_ADDRESS = "0.0.0.0:"
2121      + DEFAULT_SCM_UPLOADER_SERVER_PORT;
2122
2123  /**
2124   * The number of SCM threads used to handle notify requests from the node
2125   * manager.
2126   */
2127  public static final String SCM_UPLOADER_SERVER_THREAD_COUNT =
2128      SHARED_CACHE_PREFIX + "uploader.server.thread-count";
2129  public static final int DEFAULT_SCM_UPLOADER_SERVER_THREAD_COUNT = 50;
2130
2131  /** The address of the client interface in the SCM. */
2132  public static final String SCM_CLIENT_SERVER_ADDRESS =
2133      SHARED_CACHE_PREFIX + "client-server.address";
2134  public static final int DEFAULT_SCM_CLIENT_SERVER_PORT = 8045;
2135  public static final String DEFAULT_SCM_CLIENT_SERVER_ADDRESS = "0.0.0.0:"
2136      + DEFAULT_SCM_CLIENT_SERVER_PORT;
2137
2138  /** The number of threads used to handle shared cache manager requests. */
2139  public static final String SCM_CLIENT_SERVER_THREAD_COUNT =
2140      SHARED_CACHE_PREFIX + "client-server.thread-count";
2141  public static final int DEFAULT_SCM_CLIENT_SERVER_THREAD_COUNT = 50;
2142
2143  /** the checksum algorithm implementation **/
2144  public static final String SHARED_CACHE_CHECKSUM_ALGO_IMPL =
2145      SHARED_CACHE_PREFIX + "checksum.algo.impl";
2146  public static final String DEFAULT_SHARED_CACHE_CHECKSUM_ALGO_IMPL =
2147      "org.apache.hadoop.yarn.sharedcache.ChecksumSHA256Impl";
2148
2149  // node manager (uploader) configs
2150  /**
2151   * The replication factor for the node manager uploader for the shared cache.
2152   */
2153  public static final String SHARED_CACHE_NM_UPLOADER_REPLICATION_FACTOR =
2154      SHARED_CACHE_PREFIX + "nm.uploader.replication.factor";
2155  public static final int DEFAULT_SHARED_CACHE_NM_UPLOADER_REPLICATION_FACTOR =
2156      10;
2157
2158  public static final String SHARED_CACHE_NM_UPLOADER_THREAD_COUNT =
2159      SHARED_CACHE_PREFIX + "nm.uploader.thread-count";
2160  public static final int DEFAULT_SHARED_CACHE_NM_UPLOADER_THREAD_COUNT = 20;
2161
2162  ////////////////////////////////
2163  // Other Configs
2164  ////////////////////////////////
2165
2166  /**
2167   * Use YARN_CLIENT_APPLICATION_CLIENT_PROTOCOL_POLL_INTERVAL_MS instead.
2168   * The interval of the yarn client's querying application state after
2169   * application submission. The unit is millisecond.
2170   */
2171  @Deprecated
2172  public static final String YARN_CLIENT_APP_SUBMISSION_POLL_INTERVAL_MS =
2173      YARN_PREFIX + "client.app-submission.poll-interval";
2174
2175  /**
2176   * The interval that the yarn client library uses to poll the completion
2177   * status of the asynchronous API of application client protocol.
2178   */
2179  public static final String YARN_CLIENT_APPLICATION_CLIENT_PROTOCOL_POLL_INTERVAL_MS =
2180      YARN_PREFIX + "client.application-client-protocol.poll-interval-ms";
2181  public static final long DEFAULT_YARN_CLIENT_APPLICATION_CLIENT_PROTOCOL_POLL_INTERVAL_MS =
2182      200;
2183
2184  /**
2185   * The duration that the yarn client library waits, cumulatively across polls,
2186   * for an expected state change to occur. Defaults to -1, which indicates no
2187   * limit.
2188   */
2189  public static final String YARN_CLIENT_APPLICATION_CLIENT_PROTOCOL_POLL_TIMEOUT_MS =
2190      YARN_PREFIX + "client.application-client-protocol.poll-timeout-ms";
2191  public static final long DEFAULT_YARN_CLIENT_APPLICATION_CLIENT_PROTOCOL_POLL_TIMEOUT_MS =
2192      -1;
2193
2194  /**
2195   * Max number of threads in NMClientAsync to process container management
2196   * events
2197   */
2198  public static final String NM_CLIENT_ASYNC_THREAD_POOL_MAX_SIZE =
2199      YARN_PREFIX + "client.nodemanager-client-async.thread-pool-max-size";
2200  public static final int DEFAULT_NM_CLIENT_ASYNC_THREAD_POOL_MAX_SIZE = 500;
2201
2202  /**
2203   * Maximum number of proxy connections to cache for node managers. If set
2204   * to a value greater than zero then the cache is enabled and the NMClient
2205   * and MRAppMaster will cache the specified number of node manager proxies.
2206   * There will be at max one proxy per node manager. Ex. configuring it to a
2207   * value of 5 will make sure that client will at max have 5 proxies cached
2208   * with 5 different node managers. These connections for these proxies will
2209   * be timed out if idle for more than the system wide idle timeout period.
2210   * Note that this could cause issues on large clusters as many connections
2211   * could linger simultaneously and lead to a large number of connection
2212   * threads. The token used for authentication will be used only at
2213   * connection creation time. If a new token is received then the earlier
2214   * connection should be closed in order to use the new token. This and
2215   * {@link YarnConfiguration#NM_CLIENT_ASYNC_THREAD_POOL_MAX_SIZE} are related
2216   * and should be in sync (no need for them to be equal).
2217   * If the value of this property is zero then the connection cache is
2218   * disabled and connections will use a zero idle timeout to prevent too
2219   * many connection threads on large clusters.
2220   */
2221  public static final String NM_CLIENT_MAX_NM_PROXIES =
2222      YARN_PREFIX + "client.max-cached-nodemanagers-proxies";
2223  public static final int DEFAULT_NM_CLIENT_MAX_NM_PROXIES = 0;
2224
2225  /** Max time to wait to establish a connection to NM */
2226  public static final String CLIENT_NM_CONNECT_MAX_WAIT_MS =
2227      YARN_PREFIX + "client.nodemanager-connect.max-wait-ms";
2228  public static final long DEFAULT_CLIENT_NM_CONNECT_MAX_WAIT_MS =
2229      3 * 60 * 1000;
2230
2231  /** Time interval between each attempt to connect to NM */
2232  public static final String CLIENT_NM_CONNECT_RETRY_INTERVAL_MS =
2233      YARN_PREFIX + "client.nodemanager-connect.retry-interval-ms";
2234  public static final long DEFAULT_CLIENT_NM_CONNECT_RETRY_INTERVAL_MS
2235      = 10 * 1000;
2236
2237  public static final String YARN_HTTP_POLICY_KEY = YARN_PREFIX + "http.policy";
2238  public static final String YARN_HTTP_POLICY_DEFAULT = HttpConfig.Policy.HTTP_ONLY
2239      .name();
2240
2241  /**
2242   * Max time to wait for NM to connection to RM.
2243   * When not set, proxy will fall back to use value of
2244   * RESOURCEMANAGER_CONNECT_MAX_WAIT_MS.
2245   */
2246  public static final String NM_RESOURCEMANAGER_CONNECT_MAX_WAIT_MS =
2247      YARN_PREFIX + "nodemanager.resourcemanager.connect.max-wait.ms";
2248
2249  /**
2250   * Time interval between each NM attempt to connection to RM.
2251   * When not set, proxy will fall back to use value of
2252   * RESOURCEMANAGER_CONNECT_RETRY_INTERVAL_MS.
2253   */
2254  public static final String NM_RESOURCEMANAGER_CONNECT_RETRY_INTERVAL_MS =
2255      YARN_PREFIX + "nodemanager.resourcemanager.connect.retry-interval.ms";
2256
2257  /**
2258   * Node-labels configurations
2259   */
2260  public static final String NODE_LABELS_PREFIX = YARN_PREFIX + "node-labels.";
2261  
2262  /** Node label store implementation class */
2263  public static final String FS_NODE_LABELS_STORE_IMPL_CLASS = NODE_LABELS_PREFIX
2264      + "fs-store.impl.class";
2265  public static final String DEFAULT_FS_NODE_LABELS_STORE_IMPL_CLASS =
2266      "org.apache.hadoop.yarn.nodelabels.FileSystemNodeLabelsStore";
2267  
2268  /** URI for NodeLabelManager */
2269  public static final String FS_NODE_LABELS_STORE_ROOT_DIR = NODE_LABELS_PREFIX
2270      + "fs-store.root-dir";
2271  public static final String FS_NODE_LABELS_STORE_RETRY_POLICY_SPEC =
2272      NODE_LABELS_PREFIX + "fs-store.retry-policy-spec";
2273  public static final String DEFAULT_FS_NODE_LABELS_STORE_RETRY_POLICY_SPEC =
2274      "2000, 500";
2275  
2276  /**
2277   * Flag to indicate if the node labels feature enabled, by default it's
2278   * disabled
2279   */
2280  public static final String NODE_LABELS_ENABLED = NODE_LABELS_PREFIX
2281      + "enabled";
2282  public static final boolean DEFAULT_NODE_LABELS_ENABLED = false;
2283  
2284  public static final String NODELABEL_CONFIGURATION_TYPE =
2285      NODE_LABELS_PREFIX + "configuration-type";
2286  
2287  public static final String CENTRALIZED_NODELABEL_CONFIGURATION_TYPE =
2288      "centralized";
2289
2290  public static final String DELEGATED_CENTALIZED_NODELABEL_CONFIGURATION_TYPE =
2291      "delegated-centralized";
2292
2293  public static final String DISTRIBUTED_NODELABEL_CONFIGURATION_TYPE =
2294      "distributed";
2295  
2296  public static final String DEFAULT_NODELABEL_CONFIGURATION_TYPE =
2297      CENTRALIZED_NODELABEL_CONFIGURATION_TYPE;
2298
2299  public static final String MAX_CLUSTER_LEVEL_APPLICATION_PRIORITY =
2300      YARN_PREFIX + "cluster.max-application-priority";
2301
2302  public static final int DEFAULT_CLUSTER_LEVEL_APPLICATION_PRIORITY = 0;
2303
2304  @Private
2305  public static boolean isDistributedNodeLabelConfiguration(Configuration conf) {
2306    return DISTRIBUTED_NODELABEL_CONFIGURATION_TYPE.equals(conf.get(
2307        NODELABEL_CONFIGURATION_TYPE, DEFAULT_NODELABEL_CONFIGURATION_TYPE));
2308  }
2309
2310  @Private
2311  public static boolean isCentralizedNodeLabelConfiguration(
2312      Configuration conf) {
2313    return CENTRALIZED_NODELABEL_CONFIGURATION_TYPE.equals(conf.get(
2314        NODELABEL_CONFIGURATION_TYPE, DEFAULT_NODELABEL_CONFIGURATION_TYPE));
2315  }
2316
2317  @Private
2318  public static boolean isDelegatedCentralizedNodeLabelConfiguration(
2319      Configuration conf) {
2320    return DELEGATED_CENTALIZED_NODELABEL_CONFIGURATION_TYPE.equals(conf.get(
2321        NODELABEL_CONFIGURATION_TYPE, DEFAULT_NODELABEL_CONFIGURATION_TYPE));
2322  }
2323
2324  @Private
2325  public static boolean areNodeLabelsEnabled(
2326      Configuration conf) {
2327    return conf.getBoolean(NODE_LABELS_ENABLED, DEFAULT_NODE_LABELS_ENABLED);
2328  }
2329
2330  private static final String NM_NODE_LABELS_PREFIX = NM_PREFIX
2331      + "node-labels.";
2332
2333  public static final String NM_NODE_LABELS_PROVIDER_CONFIG =
2334      NM_NODE_LABELS_PREFIX + "provider";
2335
2336  // whitelist names for the yarn.nodemanager.node-labels.provider
2337  public static final String CONFIG_NODE_LABELS_PROVIDER = "config";
2338  public static final String SCRIPT_NODE_LABELS_PROVIDER = "script";
2339
2340  private static final String NM_NODE_LABELS_PROVIDER_PREFIX =
2341      NM_NODE_LABELS_PREFIX + "provider.";
2342
2343  public static final String NM_NODE_LABELS_RESYNC_INTERVAL =
2344      NM_NODE_LABELS_PREFIX + "resync-interval-ms";
2345
2346  public static final long DEFAULT_NM_NODE_LABELS_RESYNC_INTERVAL =
2347      2 * 60 * 1000;
2348
2349  // If -1 is configured then no timer task should be created
2350  public static final String NM_NODE_LABELS_PROVIDER_FETCH_INTERVAL_MS =
2351      NM_NODE_LABELS_PROVIDER_PREFIX + "fetch-interval-ms";
2352
2353  public static final String NM_NODE_LABELS_PROVIDER_FETCH_TIMEOUT_MS =
2354      NM_NODE_LABELS_PROVIDER_PREFIX + "fetch-timeout-ms";
2355
2356  // once in 10 mins
2357  public static final long DEFAULT_NM_NODE_LABELS_PROVIDER_FETCH_INTERVAL_MS =
2358      10 * 60 * 1000;
2359
2360  // Twice of default interval time
2361  public static final long DEFAULT_NM_NODE_LABELS_PROVIDER_FETCH_TIMEOUT_MS =
2362      DEFAULT_NM_NODE_LABELS_PROVIDER_FETCH_INTERVAL_MS * 2;
2363
2364  public static final String NM_PROVIDER_CONFIGURED_NODE_PARTITION =
2365      NM_NODE_LABELS_PROVIDER_PREFIX + "configured-node-partition";
2366
2367  private static final String RM_NODE_LABELS_PREFIX = RM_PREFIX
2368      + "node-labels.";
2369
2370  public static final String RM_NODE_LABELS_PROVIDER_CONFIG =
2371      RM_NODE_LABELS_PREFIX + "provider";
2372
2373  private static final String RM_NODE_LABELS_PROVIDER_PREFIX =
2374      RM_NODE_LABELS_PREFIX + "provider.";
2375
2376  //If -1 is configured then no timer task should be created
2377  public static final String RM_NODE_LABELS_PROVIDER_FETCH_INTERVAL_MS =
2378      RM_NODE_LABELS_PROVIDER_PREFIX + "fetch-interval-ms";
2379
2380  //once in 30 mins
2381  public static final long DEFAULT_RM_NODE_LABELS_PROVIDER_FETCH_INTERVAL_MS =
2382      30 * 60 * 1000;
2383
2384  public static final String AM_BLACKLISTING_ENABLED =
2385      YARN_PREFIX + "am.blacklisting.enabled";
2386  public static final boolean DEFAULT_AM_BLACKLISTING_ENABLED = true;
2387
2388  public static final String AM_BLACKLISTING_DISABLE_THRESHOLD =
2389      YARN_PREFIX + "am.blacklisting.disable-failure-threshold";
2390  public static final float DEFAULT_AM_BLACKLISTING_DISABLE_THRESHOLD = 0.8f;
2391
2392
2393  private static final String NM_SCRIPT_BASED_NODE_LABELS_PROVIDER_PREFIX =
2394      NM_NODE_LABELS_PROVIDER_PREFIX + "script.";
2395
2396  public static final String NM_SCRIPT_BASED_NODE_LABELS_PROVIDER_PATH =
2397      NM_SCRIPT_BASED_NODE_LABELS_PROVIDER_PREFIX + "path";
2398
2399  public static final String NM_SCRIPT_BASED_NODE_LABELS_PROVIDER_SCRIPT_OPTS =
2400      NM_SCRIPT_BASED_NODE_LABELS_PROVIDER_PREFIX + "opts";
2401
2402  public YarnConfiguration() {
2403    super();
2404  }
2405  
2406  public YarnConfiguration(Configuration conf) {
2407    super(conf);
2408    if (! (conf instanceof YarnConfiguration)) {
2409      this.reloadConfiguration();
2410    }
2411  }
2412
2413  @Private
2414  public static List<String> getServiceAddressConfKeys(Configuration conf) {
2415    return useHttps(conf) ? RM_SERVICES_ADDRESS_CONF_KEYS_HTTPS
2416        : RM_SERVICES_ADDRESS_CONF_KEYS_HTTP;
2417  }
2418
2419  /**
2420   * Get the socket address for <code>name</code> property as a
2421   * <code>InetSocketAddress</code>. On a HA cluster,
2422   * this fetches the address corresponding to the RM identified by
2423   * {@link #RM_HA_ID}.
2424   * @param name property name.
2425   * @param defaultAddress the default value
2426   * @param defaultPort the default port
2427   * @return InetSocketAddress
2428   */
2429  @Override
2430  public InetSocketAddress getSocketAddr(
2431      String name, String defaultAddress, int defaultPort) {
2432    String address;
2433    if (HAUtil.isHAEnabled(this) && getServiceAddressConfKeys(this).contains(name)) {
2434      address = HAUtil.getConfValueForRMInstance(name, defaultAddress, this);
2435    } else {
2436      address = get(name, defaultAddress);
2437    }
2438    return NetUtils.createSocketAddr(address, defaultPort, name);
2439  }
2440
2441  @Override
2442  public InetSocketAddress updateConnectAddr(String name,
2443                                             InetSocketAddress addr) {
2444    String prefix = name;
2445    if (HAUtil.isHAEnabled(this) && getServiceAddressConfKeys(this).contains(name)) {
2446      prefix = HAUtil.addSuffix(prefix, HAUtil.getRMHAId(this));
2447    }
2448    return super.updateConnectAddr(prefix, addr);
2449  }
2450
2451  @Private
2452  public static int getRMDefaultPortNumber(String addressPrefix,
2453      Configuration conf) {
2454    if (addressPrefix.equals(YarnConfiguration.RM_ADDRESS)) {
2455      return YarnConfiguration.DEFAULT_RM_PORT;
2456    } else if (addressPrefix.equals(YarnConfiguration.RM_SCHEDULER_ADDRESS)) {
2457      return YarnConfiguration.DEFAULT_RM_SCHEDULER_PORT;
2458    } else if (addressPrefix.equals(YarnConfiguration.RM_WEBAPP_ADDRESS)) {
2459      return YarnConfiguration.DEFAULT_RM_WEBAPP_PORT;
2460    } else if (addressPrefix.equals(YarnConfiguration.RM_WEBAPP_HTTPS_ADDRESS)) {
2461      return YarnConfiguration.DEFAULT_RM_WEBAPP_HTTPS_PORT;
2462    } else if (addressPrefix
2463        .equals(YarnConfiguration.RM_RESOURCE_TRACKER_ADDRESS)) {
2464      return YarnConfiguration.DEFAULT_RM_RESOURCE_TRACKER_PORT;
2465    } else if (addressPrefix.equals(YarnConfiguration.RM_ADMIN_ADDRESS)) {
2466      return YarnConfiguration.DEFAULT_RM_ADMIN_PORT;
2467    } else {
2468      throw new HadoopIllegalArgumentException(
2469          "Invalid RM RPC address Prefix: " + addressPrefix
2470              + ". The valid value should be one of "
2471              + getServiceAddressConfKeys(conf));
2472    }
2473  }
2474
2475  public static boolean useHttps(Configuration conf) {
2476    return HttpConfig.Policy.HTTPS_ONLY == HttpConfig.Policy.fromString(conf
2477        .get(YARN_HTTP_POLICY_KEY,
2478            YARN_HTTP_POLICY_DEFAULT));
2479  }
2480
2481  public static boolean shouldRMFailFast(Configuration conf) {
2482    return conf.getBoolean(YarnConfiguration.RM_FAIL_FAST,
2483        conf.getBoolean(YarnConfiguration.YARN_FAIL_FAST,
2484            YarnConfiguration.DEFAULT_YARN_FAIL_FAST));
2485  }
2486
2487  @Private
2488  public static String getClusterId(Configuration conf) {
2489    String clusterId = conf.get(YarnConfiguration.RM_CLUSTER_ID);
2490    if (clusterId == null) {
2491      throw new HadoopIllegalArgumentException("Configuration doesn't specify " +
2492          YarnConfiguration.RM_CLUSTER_ID);
2493    }
2494    return clusterId;
2495  }
2496
2497  /* For debugging. mp configurations to system output as XML format. */
2498  public static void main(String[] args) throws Exception {
2499    new YarnConfiguration(new Configuration()).writeXml(System.out);
2500  }
2501}