org.apache.flink.kubernetes.configuration

Class KubernetesConfigOptions

java.lang.Object

org.apache.flink.kubernetes.configuration.KubernetesConfigOptions

@PublicEvolving
public class KubernetesConfigOptions
extends Object

This class holds configuration constants used by Flink's kubernetes runners.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	KubernetesConfigOptions.ImagePullPolicy The container image pull policy.
static class	KubernetesConfigOptions.NodePortAddressType The flink rest service exposed type.
static class	KubernetesConfigOptions.ServiceExposedType The flink rest service exposed type.

Field Summary

Fields

Modifier and Type	Field and Description
static ConfigOption<String>	CLUSTER_ID
static ConfigOption<String>	CONTAINER_IMAGE
static ConfigOption<KubernetesConfigOptions.ImagePullPolicy>	CONTAINER_IMAGE_PULL_POLICY
static ConfigOption<List<String>>	CONTAINER_IMAGE_PULL_SECRETS
static ConfigOption<String>	CONTEXT
static ConfigOption<String>	EXTERNAL_RESOURCE_KUBERNETES_CONFIG_KEY If configured, Flink will add "resources.limits.
static String	EXTERNAL_RESOURCE_KUBERNETES_CONFIG_KEY_SUFFIX Defines the configuration key of that external resource in Kubernetes.
static ConfigOption<String>	FLINK_CONF_DIR
static ConfigOption<String>	FLINK_LOG_DIR
static ConfigOption<String>	HADOOP_CONF_CONFIG_MAP
static ConfigOption<Map<String,String>>	INTERNAL_SERVICE_ANNOTATIONS
static ConfigOption<Map<String,String>>	JOB_MANAGER_ANNOTATIONS
static ConfigOption<Double>	JOB_MANAGER_CPU
static ConfigOption<Double>	JOB_MANAGER_CPU_LIMIT_FACTOR
static ConfigOption<Map<String,String>>	JOB_MANAGER_LABELS
static ConfigOption<Double>	JOB_MANAGER_MEMORY_LIMIT_FACTOR
static ConfigOption<Map<String,String>>	JOB_MANAGER_NODE_SELECTOR
static ConfigOption<List<Map<String,String>>>	JOB_MANAGER_OWNER_REFERENCE
static ConfigOption<String>	JOB_MANAGER_POD_TEMPLATE
static ConfigOption<String>	JOB_MANAGER_SERVICE_ACCOUNT
static ConfigOption<List<Map<String,String>>>	JOB_MANAGER_TOLERATIONS
static ConfigOption<String>	KUBE_CONFIG_FILE
static ConfigOption<Integer>	KUBERNETES_CLIENT_IO_EXECUTOR_POOL_SIZE
static ConfigOption<String>	KUBERNETES_CLIENT_USER_AGENT
static ConfigOption<String>	KUBERNETES_ENTRY_PATH The following config options need to be set according to the image.
static ConfigOption<List<Map<String,String>>>	KUBERNETES_ENV_SECRET_KEY_REF
static ConfigOption<Boolean>	KUBERNETES_HADOOP_CONF_MOUNT_DECORATOR_ENABLED
static ConfigOption<Boolean>	KUBERNETES_HOSTNETWORK_ENABLED
static ConfigOption<String>	KUBERNETES_JOBMANAGER_ENTRYPOINT_ARGS
static ConfigOption<Integer>	KUBERNETES_JOBMANAGER_REPLICAS
static ConfigOption<Boolean>	KUBERNETES_KERBEROS_MOUNT_DECORATOR_ENABLED
static ConfigOption<String>	KUBERNETES_NODE_NAME_LABEL This will only be used to support blocklist mechanism, which is experimental currently, so we do not want to expose this option in the documentation.
static ConfigOption<String>	KUBERNETES_POD_TEMPLATE This option is here only for documentation generation, it is the fallback key of JOB_MANAGER_POD_TEMPLATE and TASK_MANAGER_POD_TEMPLATE.
static ConfigOption<Map<String,String>>	KUBERNETES_SECRETS
static ConfigOption<String>	KUBERNETES_SERVICE_ACCOUNT
static ConfigOption<String>	KUBERNETES_TASKMANAGER_ENTRYPOINT_ARGS
static ConfigOption<Duration>	KUBERNETES_TRANSACTIONAL_OPERATION_INITIAL_RETRY_DEALY
static ConfigOption<Integer>	KUBERNETES_TRANSACTIONAL_OPERATION_MAX_RETRIES
static ConfigOption<Duration>	KUBERNETES_TRANSACTIONAL_OPERATION_MAX_RETRY_DEALY
static ConfigOption<Boolean>	LOCAL_UPLOAD_ENABLED
static ConfigOption<Boolean>	LOCAL_UPLOAD_OVERWRITE
static ConfigOption<String>	LOCAL_UPLOAD_TARGET
static ConfigOption<String>	NAMESPACE
static ConfigOption<Map<String,String>>	REST_SERVICE_ANNOTATIONS
static ConfigOption<KubernetesConfigOptions.NodePortAddressType>	REST_SERVICE_EXPOSED_NODE_PORT_ADDRESS_TYPE
static ConfigOption<KubernetesConfigOptions.ServiceExposedType>	REST_SERVICE_EXPOSED_TYPE
static ConfigOption<Map<String,String>>	TASK_MANAGER_ANNOTATIONS
static ConfigOption<Double>	TASK_MANAGER_CPU
static ConfigOption<Double>	TASK_MANAGER_CPU_LIMIT_FACTOR
static ConfigOption<Map<String,String>>	TASK_MANAGER_LABELS
static ConfigOption<Double>	TASK_MANAGER_MEMORY_LIMIT_FACTOR
static ConfigOption<Map<String,String>>	TASK_MANAGER_NODE_SELECTOR
static ConfigOption<String>	TASK_MANAGER_POD_TEMPLATE
static ConfigOption<String>	TASK_MANAGER_SERVICE_ACCOUNT
static ConfigOption<List<Map<String,String>>>	TASK_MANAGER_TOLERATIONS

Method Summary

Methods inherited from class java.lang.Object

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

Field Detail

CONTEXT

public static final ConfigOption<String> CONTEXT

REST_SERVICE_EXPOSED_TYPE

public static final ConfigOption<KubernetesConfigOptions.ServiceExposedType> REST_SERVICE_EXPOSED_TYPE

REST_SERVICE_EXPOSED_NODE_PORT_ADDRESS_TYPE

public static final ConfigOption<KubernetesConfigOptions.NodePortAddressType> REST_SERVICE_EXPOSED_NODE_PORT_ADDRESS_TYPE

JOB_MANAGER_SERVICE_ACCOUNT

public static final ConfigOption<String> JOB_MANAGER_SERVICE_ACCOUNT

TASK_MANAGER_SERVICE_ACCOUNT

public static final ConfigOption<String> TASK_MANAGER_SERVICE_ACCOUNT

KUBERNETES_SERVICE_ACCOUNT

public static final ConfigOption<String> KUBERNETES_SERVICE_ACCOUNT

JOB_MANAGER_OWNER_REFERENCE

public static final ConfigOption<List<Map<String,String>>> JOB_MANAGER_OWNER_REFERENCE

JOB_MANAGER_CPU

public static final ConfigOption<Double> JOB_MANAGER_CPU

JOB_MANAGER_CPU_LIMIT_FACTOR

public static final ConfigOption<Double> JOB_MANAGER_CPU_LIMIT_FACTOR

JOB_MANAGER_MEMORY_LIMIT_FACTOR

public static final ConfigOption<Double> JOB_MANAGER_MEMORY_LIMIT_FACTOR

TASK_MANAGER_CPU

public static final ConfigOption<Double> TASK_MANAGER_CPU

TASK_MANAGER_CPU_LIMIT_FACTOR

public static final ConfigOption<Double> TASK_MANAGER_CPU_LIMIT_FACTOR

TASK_MANAGER_MEMORY_LIMIT_FACTOR

public static final ConfigOption<Double> TASK_MANAGER_MEMORY_LIMIT_FACTOR

CONTAINER_IMAGE_PULL_POLICY

public static final ConfigOption<KubernetesConfigOptions.ImagePullPolicy> CONTAINER_IMAGE_PULL_POLICY

CONTAINER_IMAGE_PULL_SECRETS

public static final ConfigOption<List<String>> CONTAINER_IMAGE_PULL_SECRETS

KUBE_CONFIG_FILE

public static final ConfigOption<String> KUBE_CONFIG_FILE

NAMESPACE

public static final ConfigOption<String> NAMESPACE

JOB_MANAGER_LABELS

public static final ConfigOption<Map<String,String>> JOB_MANAGER_LABELS

TASK_MANAGER_LABELS

public static final ConfigOption<Map<String,String>> TASK_MANAGER_LABELS

JOB_MANAGER_NODE_SELECTOR

public static final ConfigOption<Map<String,String>> JOB_MANAGER_NODE_SELECTOR

TASK_MANAGER_NODE_SELECTOR

public static final ConfigOption<Map<String,String>> TASK_MANAGER_NODE_SELECTOR

CLUSTER_ID

public static final ConfigOption<String> CLUSTER_ID

CONTAINER_IMAGE

public static final ConfigOption<String> CONTAINER_IMAGE

KUBERNETES_ENTRY_PATH

public static final ConfigOption<String> KUBERNETES_ENTRY_PATH

The following config options need to be set according to the image.

FLINK_CONF_DIR

public static final ConfigOption<String> FLINK_CONF_DIR

FLINK_LOG_DIR

public static final ConfigOption<String> FLINK_LOG_DIR

HADOOP_CONF_CONFIG_MAP

public static final ConfigOption<String> HADOOP_CONF_CONFIG_MAP

JOB_MANAGER_ANNOTATIONS

public static final ConfigOption<Map<String,String>> JOB_MANAGER_ANNOTATIONS

TASK_MANAGER_ANNOTATIONS

public static final ConfigOption<Map<String,String>> TASK_MANAGER_ANNOTATIONS

KUBERNETES_JOBMANAGER_ENTRYPOINT_ARGS

public static final ConfigOption<String> KUBERNETES_JOBMANAGER_ENTRYPOINT_ARGS

KUBERNETES_TASKMANAGER_ENTRYPOINT_ARGS

public static final ConfigOption<String> KUBERNETES_TASKMANAGER_ENTRYPOINT_ARGS

JOB_MANAGER_TOLERATIONS

public static final ConfigOption<List<Map<String,String>>> JOB_MANAGER_TOLERATIONS

TASK_MANAGER_TOLERATIONS

public static final ConfigOption<List<Map<String,String>>> TASK_MANAGER_TOLERATIONS

REST_SERVICE_ANNOTATIONS

public static final ConfigOption<Map<String,String>> REST_SERVICE_ANNOTATIONS

INTERNAL_SERVICE_ANNOTATIONS

public static final ConfigOption<Map<String,String>> INTERNAL_SERVICE_ANNOTATIONS

EXTERNAL_RESOURCE_KUBERNETES_CONFIG_KEY_SUFFIX

public static final String EXTERNAL_RESOURCE_KUBERNETES_CONFIG_KEY_SUFFIX

Defines the configuration key of that external resource in Kubernetes. This is used as a suffix in an actual config.

See Also:

Constant Field Values

KUBERNETES_SECRETS

public static final ConfigOption<Map<String,String>> KUBERNETES_SECRETS

KUBERNETES_ENV_SECRET_KEY_REF

public static final ConfigOption<List<Map<String,String>>> KUBERNETES_ENV_SECRET_KEY_REF

EXTERNAL_RESOURCE_KUBERNETES_CONFIG_KEY

public static final ConfigOption<String> EXTERNAL_RESOURCE_KUBERNETES_CONFIG_KEY

If configured, Flink will add "resources.limits.>config-key<" and "resources.requests.>config-key<" to the main container of TaskExecutor and set the value to ExternalResourceOptions.EXTERNAL_RESOURCE_AMOUNT.

It is intentionally included into user docs while unused.

KUBERNETES_TRANSACTIONAL_OPERATION_MAX_RETRIES

public static final ConfigOption<Integer> KUBERNETES_TRANSACTIONAL_OPERATION_MAX_RETRIES

KUBERNETES_TRANSACTIONAL_OPERATION_INITIAL_RETRY_DEALY

public static final ConfigOption<Duration> KUBERNETES_TRANSACTIONAL_OPERATION_INITIAL_RETRY_DEALY

KUBERNETES_TRANSACTIONAL_OPERATION_MAX_RETRY_DEALY

public static final ConfigOption<Duration> KUBERNETES_TRANSACTIONAL_OPERATION_MAX_RETRY_DEALY

JOB_MANAGER_POD_TEMPLATE

public static final ConfigOption<String> JOB_MANAGER_POD_TEMPLATE

TASK_MANAGER_POD_TEMPLATE

public static final ConfigOption<String> TASK_MANAGER_POD_TEMPLATE

KUBERNETES_POD_TEMPLATE

public static final ConfigOption<String> KUBERNETES_POD_TEMPLATE

This option is here only for documentation generation, it is the fallback key of JOB_MANAGER_POD_TEMPLATE and TASK_MANAGER_POD_TEMPLATE.

KUBERNETES_CLIENT_IO_EXECUTOR_POOL_SIZE

public static final ConfigOption<Integer> KUBERNETES_CLIENT_IO_EXECUTOR_POOL_SIZE

KUBERNETES_JOBMANAGER_REPLICAS

public static final ConfigOption<Integer> KUBERNETES_JOBMANAGER_REPLICAS

KUBERNETES_HOSTNETWORK_ENABLED

public static final ConfigOption<Boolean> KUBERNETES_HOSTNETWORK_ENABLED

KUBERNETES_CLIENT_USER_AGENT

public static final ConfigOption<String> KUBERNETES_CLIENT_USER_AGENT

KUBERNETES_HADOOP_CONF_MOUNT_DECORATOR_ENABLED

public static final ConfigOption<Boolean> KUBERNETES_HADOOP_CONF_MOUNT_DECORATOR_ENABLED

KUBERNETES_KERBEROS_MOUNT_DECORATOR_ENABLED

public static final ConfigOption<Boolean> KUBERNETES_KERBEROS_MOUNT_DECORATOR_ENABLED

LOCAL_UPLOAD_ENABLED

public static final ConfigOption<Boolean> LOCAL_UPLOAD_ENABLED

LOCAL_UPLOAD_OVERWRITE

public static final ConfigOption<Boolean> LOCAL_UPLOAD_OVERWRITE

LOCAL_UPLOAD_TARGET

public static final ConfigOption<String> LOCAL_UPLOAD_TARGET

KUBERNETES_NODE_NAME_LABEL

public static final ConfigOption<String> KUBERNETES_NODE_NAME_LABEL

This will only be used to support blocklist mechanism, which is experimental currently, so we do not want to expose this option in the documentation.