org.springframework.yarn.config.annotation.configurers

Interface MasterContainerAllocatorConfigurer

All Superinterfaces:

AnnotationConfigurerBuilder<YarnAppmasterConfigurer>

All Known Implementing Classes:

DefaultMasterContainerAllocatorConfigurer

public interface MasterContainerAllocatorConfigurer
extends AnnotationConfigurerBuilder<YarnAppmasterConfigurer>

AnnotationConfigurerBuilder for configuring ContainerAllocator.
Typically configuration is shown below.

 @Configuration
 @EnableYarn(enable=Enable.APPMASTER)
 static class Config extends SpringYarnConfigurerAdapter {

   @Override
   public void configure(YarnAppmasterConfigure master) throws Exception {
     master
       .withContainerAllocator();
   }

 }
 

Author:

Janne Valkealahti

Nested Class Summary

Nested Classes

Modifier and Type	Interface and Description
static interface	MasterContainerAllocatorConfigurer.MasterContainerAllocatorCollectionConfigurer MasterContainerAllocatorCollectionConfigurer is an interface for DefaultMasterContainerAllocatorCollectionConfigurer which is used to configure MasterContainerAllocatorConfigurer parameters as an identified collection.

Method Summary

Methods

Modifier and Type	Method and Description
MasterContainerAllocatorConfigurer	locality(boolean locality) Specify a locality relaxing for ContainerAllocator.
MasterContainerAllocatorConfigurer	memory(int memory) Specify a container memory for ContainerAllocator.
MasterContainerAllocatorConfigurer	memory(java.lang.String memory) Specify a container memory for ContainerAllocator.
MasterContainerAllocatorConfigurer	priority(java.lang.Integer priority) Specify a container priority for ContainerAllocator.
MasterContainerAllocatorConfigurer	virtualCores(java.lang.Integer virtualCores) Specify a container virtual cores for ContainerAllocator.
MasterContainerAllocatorConfigurer.MasterContainerAllocatorCollectionConfigurer	withCollection(java.lang.String id) Specify a collection of container allocator attributes.

Methods inherited from interface org.springframework.data.hadoop.config.common.annotation.AnnotationConfigurerBuilder

and

Method Detail

priority

MasterContainerAllocatorConfigurer priority(java.lang.Integer priority)

Specify a container priority for ContainerAllocator.

JavaConfig:

 public void configure(YarnAppmasterConfigure master) throws Exception {
   master
     .withContainerAllocator()
       .priority(0);
 }
 

XML:

 <yarn:master>
   <yarn:container-allocator priority="0"/>
 </yarn:master>
 

Parameters:

priority - the priority

Returns:

MasterContainerAllocatorConfigurer for chaining

virtualCores

MasterContainerAllocatorConfigurer virtualCores(java.lang.Integer virtualCores)

Specify a container virtual cores for ContainerAllocator.

JavaConfig:

 public void configure(YarnAppmasterConfigure master) throws Exception {
   master
     .withContainerAllocator()
       .virtualCores(1);
 }
 

XML:

 <yarn:master>
   <yarn:container-allocator virtualcores="1"/>
 </yarn:master>
 

Parameters:

virtualCores - the virtual cores

Returns:

MasterContainerAllocatorConfigurer for chaining

memory

MasterContainerAllocatorConfigurer memory(java.lang.String memory)

Specify a container memory for ContainerAllocator. The memory argument is given as MegaBytes if value is a plain number. Shortcuts like 1G and 500M can be used which translates to 1024 and 500 respectively.

This method is equivalent to #memory(int) so that argument can be given as a String.

NOTE: be careful not to use a too low settings like 1000K or 1000B because those are rounded down to full MBs and thus becomes a zero. Also too high values may make resource allocation to behave badly.

JavaConfig:

 public void configure(YarnAppmasterConfigure master) throws Exception {
   master
     .withContainerAllocator()
       .memory("1G");
 }
 

XML:

 <yarn:master>
   <yarn:container-allocator memory="1024"/>
 </yarn:master>
 

Parameters:

memory - the memory

Returns:

MasterContainerAllocatorConfigurer for chaining

memory

MasterContainerAllocatorConfigurer memory(int memory)

Specify a container memory for ContainerAllocator.

JavaConfig:

 public void configure(YarnAppmasterConfigure master) throws Exception {
   master
     .withContainerAllocator()
       .memory(1024);
 }
 

XML:

 <yarn:master>
   <yarn:container-allocator memory="1024"/>
 </yarn:master>
 

Parameters:

memory - the memory

Returns:

MasterContainerAllocatorConfigurer for chaining

See Also:

memory(String)

locality

MasterContainerAllocatorConfigurer locality(boolean locality)

Specify a locality relaxing for ContainerAllocator. Setting this flag true means that resource requests will not use locality relaxing. Default for this flag is false.

JavaConfig:

 public void configure(YarnAppmasterConfigure master) throws Exception {
   master
     .withContainerAllocator()
       .locality(false);
 }
 

XML:

 <yarn:master>
   <yarn:container-allocator locality="false"/>
 </yarn:master>
 

Parameters:

locality - the locality flag for resource relaxing

Returns:

MasterContainerAllocatorConfigurer for chaining

withCollection

MasterContainerAllocatorConfigurer.MasterContainerAllocatorCollectionConfigurer withCollection(java.lang.String id)

Specify a collection of container allocator attributes. Applies a new DefaultMasterContainerAllocatorConfigurer.DefaultMasterContainerAllocatorCollectionConfigurer into a current configurer.

JavaConfig:

 public void configure(YarnAppmasterConfigure master) throws Exception {
   master
     .withContainerAllocator()
       .withCollection("id")
         .priority(0);
 }
 

Parameters:

id - the id

Returns:

MasterContainerAllocatorConfigurer.MasterContainerAllocatorCollectionConfigurer for chaining