com.mesosphere.sdk.config

Class TaskEnvRouter

java.lang.Object

com.mesosphere.sdk.config.TaskEnvRouter

public class TaskEnvRouter
extends java.lang.Object

Default implementation of a TaskEnvRouter which handles forwarding environment variables from two sources:

• Scheduler's system environment: searches for environment variables that start with "TASKCFG_<TASKTYPE>_" and/or "TASKCFG_ALL_", and returns appropriate Maps for task types based on that environment.
• Manually-provided values: The service developer may provide custom values which will then be forwarded to tasks as needed.

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	TASKCFG_GLOBAL_ENV_PREFIX

Constructor Summary

Constructors

Constructor and Description
TaskEnvRouter() Creates a new config router which uses the current system environment for its configuration.
TaskEnvRouter(java.util.Map<java.lang.String,java.lang.String> envConfig) Creates a new config router which uses the provided environment variables, which should have TASKCFG_* prefixes.

Method Summary

Modifier and Type	Method and Description
java.util.Map<java.lang.String,java.lang.String>	getConfig(java.lang.String podType) Returns the config to be injected into tasks with the provided podType.
TaskEnvRouter	setAllPodsEnv(java.lang.String key, java.lang.String value) Adds a custom environment value to be included in all pods.
TaskEnvRouter	setPodEnv(java.lang.String podType, java.lang.String key, java.lang.String value) Adds a custom environment variable to be only included in the specified pod type.
java.lang.String	toString()

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Field Detail

TASKCFG_GLOBAL_ENV_PREFIX

public static final java.lang.String TASKCFG_GLOBAL_ENV_PREFIX

See Also:

Constant Field Values

Constructor Detail

TaskEnvRouter

public TaskEnvRouter()

Creates a new config router which uses the current system environment for its configuration.

See Also:

System.getenv()

TaskEnvRouter

public TaskEnvRouter(java.util.Map<java.lang.String,java.lang.String> envConfig)

Creates a new config router which uses the provided environment variables, which should have TASKCFG_* prefixes.

Method Detail

setAllPodsEnv

public TaskEnvRouter setAllPodsEnv(java.lang.String key,
                                   java.lang.String value)

Adds a custom environment value to be included in all pods. This may be overridden by the Scheduler environment via TASKCFG_ALL_* or TASKCFG_<POD_TYPE>_* envvars, and by any per-pod types added via setPodEnv(String, String, String).

setPodEnv

public TaskEnvRouter setPodEnv(java.lang.String podType,
                               java.lang.String key,
                               java.lang.String value)

Adds a custom environment variable to be only included in the specified pod type. This may be overridden by the Scheduler environment via TASKCFG_ALL_* or TASKCFG_<POD_TYPE>_* envvars. This takes precedence over values specified via setAllPodsEnv(String, String) for pods with this type.

getConfig

public java.util.Map<java.lang.String,java.lang.String> getConfig(java.lang.String podType)

Returns the config to be injected into tasks with the provided podType. For example, given a task with type "index", this would match scheduler environment variables starting with "TASKCFG_ALL_" and "TASKCFG_INDEX_" (with those prefixes removed), as well as any appropriate envvars which were passed in via the Java API (with no modification). The prior takes priority over the latter.

Parameters:

podType - the pod type to be matched against

Returns:

any environment variables to include in tasks of type podType, or an empty map otherwise

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object