com.mesosphere.sdk.offer.evaluate.placement

Class RoundRobinByAttributeRule

java.lang.Object

com.mesosphere.sdk.offer.evaluate.placement.AbstractRoundRobinRule

com.mesosphere.sdk.offer.evaluate.placement.RoundRobinByAttributeRule

All Implemented Interfaces:

PlacementRule

public class RoundRobinByAttributeRule
extends AbstractRoundRobinRule

Implements logic for Marathon's GROUP_BY operator for attribute values. Ensures that tasks are evenly distributed across distinct attribute values in the system as they are rolled out. Example: attribute | tasks -----------+--------------- rack:1 | a-1, b-1, c-1 rack:2 | a-2, c-2, c-3 rack:3 | b-2, c-4 Result: allow rack:3 only, unless we know that there's >3 racks via the attribute-count parameter Example: attribute | tasks -----------+--------------- rack:1 | a-1, b-1, c-1 rack:2 | a-2, c-2, c-3 rack:3 | b-2, c-4, b-3 Result: allow any of rack:1/rack:2/rack:3, unless we know that there's >3 racks via the attribute-count parameter. This enforcement is applied by task name. By default the rule will only count e.g. tasks named 'index-.*'. This allows us to only enforce the rule against certain task types or task instances within the service.

Field Summary

Fields inherited from class com.mesosphere.sdk.offer.evaluate.placement.AbstractRoundRobinRule

distinctKeyCount, taskFilter

Constructor Summary

Constructors

Constructor and Description
RoundRobinByAttributeRule(java.lang.String attribute, java.util.Optional<java.lang.Integer> attributeValueCount)
RoundRobinByAttributeRule(java.lang.String attributeName, java.util.Optional<java.lang.Integer> attributeValueCount, StringMatcher taskFilter)

Method Summary

Modifier and Type	Method and Description
protected java.lang.String	getKey(Offer offer) Returns a key to round robin against from the provided TaskInfo, or null if none was found.
protected java.lang.String	getKey(TaskInfo task) Returns a key to round robin against from the provided TaskInfo, or null if none was found.
java.util.Collection<PlacementField>	getPlacementFields() Returns the PlacementFields to which this rule applies.
java.lang.String	toString()

Methods inherited from class com.mesosphere.sdk.offer.evaluate.placement.AbstractRoundRobinRule

equals, filter, hashCode

Methods inherited from class java.lang.Object

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

Constructor Detail

RoundRobinByAttributeRule

public RoundRobinByAttributeRule(java.lang.String attribute,
                                 java.util.Optional<java.lang.Integer> attributeValueCount)

RoundRobinByAttributeRule

public RoundRobinByAttributeRule(java.lang.String attributeName,
                                 java.util.Optional<java.lang.Integer> attributeValueCount,
                                 StringMatcher taskFilter)

Method Detail

getKey

protected java.lang.String getKey(Offer offer)

Description copied from class: AbstractRoundRobinRule

Returns a key to round robin against from the provided TaskInfo, or null if none was found.

Specified by:

getKey in class AbstractRoundRobinRule

getKey

protected java.lang.String getKey(TaskInfo task)

Description copied from class: AbstractRoundRobinRule

Returns a key to round robin against from the provided TaskInfo, or null if none was found.

Specified by:

getKey in class AbstractRoundRobinRule

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object

getPlacementFields

public java.util.Collection<PlacementField> getPlacementFields()

Description copied from interface: PlacementRule

Returns the PlacementFields to which this rule applies.