Package 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.

  • Field Details

    • CONTEXT

      public static final org.apache.flink.configuration.ConfigOption<String> CONTEXT

    • REST_SERVICE_EXPOSED_TYPE

      public static final org.apache.flink.configuration.ConfigOption<KubernetesConfigOptions.ServiceExposedType> REST_SERVICE_EXPOSED_TYPE

    • REST_SERVICE_EXPOSED_NODE_PORT_ADDRESS_TYPE

      public static final org.apache.flink.configuration.ConfigOption<KubernetesConfigOptions.NodePortAddressType> REST_SERVICE_EXPOSED_NODE_PORT_ADDRESS_TYPE

    • JOB_MANAGER_SERVICE_ACCOUNT

      public static final org.apache.flink.configuration.ConfigOption<String> JOB_MANAGER_SERVICE_ACCOUNT

    • TASK_MANAGER_SERVICE_ACCOUNT

      public static final org.apache.flink.configuration.ConfigOption<String> TASK_MANAGER_SERVICE_ACCOUNT

    • KUBERNETES_SERVICE_ACCOUNT

      public static final org.apache.flink.configuration.ConfigOption<String> KUBERNETES_SERVICE_ACCOUNT

    • JOB_MANAGER_OWNER_REFERENCE

      public static final org.apache.flink.configuration.ConfigOption<List<Map<String,String>>> JOB_MANAGER_OWNER_REFERENCE

    • JOB_MANAGER_CPU

      public static final org.apache.flink.configuration.ConfigOption<Double> JOB_MANAGER_CPU

    • JOB_MANAGER_CPU_LIMIT_FACTOR

      public static final org.apache.flink.configuration.ConfigOption<Double> JOB_MANAGER_CPU_LIMIT_FACTOR

    • JOB_MANAGER_MEMORY_LIMIT_FACTOR

      public static final org.apache.flink.configuration.ConfigOption<Double> JOB_MANAGER_MEMORY_LIMIT_FACTOR

    • TASK_MANAGER_CPU

      public static final org.apache.flink.configuration.ConfigOption<Double> TASK_MANAGER_CPU

    • TASK_MANAGER_CPU_LIMIT_FACTOR

      public static final org.apache.flink.configuration.ConfigOption<Double> TASK_MANAGER_CPU_LIMIT_FACTOR

    • TASK_MANAGER_MEMORY_LIMIT_FACTOR

      public static final org.apache.flink.configuration.ConfigOption<Double> TASK_MANAGER_MEMORY_LIMIT_FACTOR

    • CONTAINER_IMAGE_PULL_POLICY

      public static final org.apache.flink.configuration.ConfigOption<KubernetesConfigOptions.ImagePullPolicy> CONTAINER_IMAGE_PULL_POLICY

    • CONTAINER_IMAGE_PULL_SECRETS

      public static final org.apache.flink.configuration.ConfigOption<List<String>> CONTAINER_IMAGE_PULL_SECRETS

    • KUBE_CONFIG_FILE

      public static final org.apache.flink.configuration.ConfigOption<String> KUBE_CONFIG_FILE

    • NAMESPACE

      public static final org.apache.flink.configuration.ConfigOption<String> NAMESPACE

    • JOB_MANAGER_LABELS

      public static final org.apache.flink.configuration.ConfigOption<Map<String,String>> JOB_MANAGER_LABELS

    • TASK_MANAGER_LABELS

      public static final org.apache.flink.configuration.ConfigOption<Map<String,String>> TASK_MANAGER_LABELS

    • JOB_MANAGER_NODE_SELECTOR

      public static final org.apache.flink.configuration.ConfigOption<Map<String,String>> JOB_MANAGER_NODE_SELECTOR

    • TASK_MANAGER_NODE_SELECTOR

      public static final org.apache.flink.configuration.ConfigOption<Map<String,String>> TASK_MANAGER_NODE_SELECTOR

    • CLUSTER_ID

      public static final org.apache.flink.configuration.ConfigOption<String> CLUSTER_ID

    • CONTAINER_IMAGE

      public static final org.apache.flink.configuration.ConfigOption<String> CONTAINER_IMAGE

    • KUBERNETES_ENTRY_PATH

      public static final org.apache.flink.configuration.ConfigOption<String> KUBERNETES_ENTRY_PATH
      The following config options need to be set according to the image.

    • HADOOP_CONF_CONFIG_MAP

      public static final org.apache.flink.configuration.ConfigOption<String> HADOOP_CONF_CONFIG_MAP

    • JOB_MANAGER_ANNOTATIONS

      public static final org.apache.flink.configuration.ConfigOption<Map<String,String>> JOB_MANAGER_ANNOTATIONS

    • TASK_MANAGER_ANNOTATIONS

      public static final org.apache.flink.configuration.ConfigOption<Map<String,String>> TASK_MANAGER_ANNOTATIONS

    • KUBERNETES_JOBMANAGER_ENTRYPOINT_ARGS

      public static final org.apache.flink.configuration.ConfigOption<String> KUBERNETES_JOBMANAGER_ENTRYPOINT_ARGS

    • KUBERNETES_TASKMANAGER_ENTRYPOINT_ARGS

      public static final org.apache.flink.configuration.ConfigOption<String> KUBERNETES_TASKMANAGER_ENTRYPOINT_ARGS

    • JOB_MANAGER_TOLERATIONS

      public static final org.apache.flink.configuration.ConfigOption<List<Map<String,String>>> JOB_MANAGER_TOLERATIONS

    • TASK_MANAGER_TOLERATIONS

      public static final org.apache.flink.configuration.ConfigOption<List<Map<String,String>>> TASK_MANAGER_TOLERATIONS

    • REST_SERVICE_ANNOTATIONS

      public static final org.apache.flink.configuration.ConfigOption<Map<String,String>> REST_SERVICE_ANNOTATIONS

    • INTERNAL_SERVICE_ANNOTATIONS

      public static final org.apache.flink.configuration.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:

    • KUBERNETES_SECRETS

      public static final org.apache.flink.configuration.ConfigOption<Map<String,String>> KUBERNETES_SECRETS

    • KUBERNETES_ENV_SECRET_KEY_REF

      public static final org.apache.flink.configuration.ConfigOption<List<Map<String,String>>> KUBERNETES_ENV_SECRET_KEY_REF

    • EXTERNAL_RESOURCE_KUBERNETES_CONFIG_KEY

      public static final org.apache.flink.configuration.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 org.apache.flink.configuration.ConfigOption<Integer> KUBERNETES_TRANSACTIONAL_OPERATION_MAX_RETRIES

    • KUBERNETES_TRANSACTIONAL_OPERATION_INITIAL_RETRY_DEALY

      public static final org.apache.flink.configuration.ConfigOption<Duration> KUBERNETES_TRANSACTIONAL_OPERATION_INITIAL_RETRY_DEALY

    • KUBERNETES_TRANSACTIONAL_OPERATION_MAX_RETRY_DEALY

      public static final org.apache.flink.configuration.ConfigOption<Duration> KUBERNETES_TRANSACTIONAL_OPERATION_MAX_RETRY_DEALY

    • JOB_MANAGER_POD_TEMPLATE

      public static final org.apache.flink.configuration.ConfigOption<String> JOB_MANAGER_POD_TEMPLATE

    • TASK_MANAGER_POD_TEMPLATE

      public static final org.apache.flink.configuration.ConfigOption<String> TASK_MANAGER_POD_TEMPLATE

    • KUBERNETES_POD_TEMPLATE

      public static final org.apache.flink.configuration.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 org.apache.flink.configuration.ConfigOption<Integer> KUBERNETES_CLIENT_IO_EXECUTOR_POOL_SIZE

    • KUBERNETES_JOBMANAGER_REPLICAS

      public static final org.apache.flink.configuration.ConfigOption<Integer> KUBERNETES_JOBMANAGER_REPLICAS

    • KUBERNETES_HOSTNETWORK_ENABLED

      public static final org.apache.flink.configuration.ConfigOption<Boolean> KUBERNETES_HOSTNETWORK_ENABLED

    • KUBERNETES_CLIENT_USER_AGENT

      public static final org.apache.flink.configuration.ConfigOption<String> KUBERNETES_CLIENT_USER_AGENT

    • KUBERNETES_HADOOP_CONF_MOUNT_DECORATOR_ENABLED

      public static final org.apache.flink.configuration.ConfigOption<Boolean> KUBERNETES_HADOOP_CONF_MOUNT_DECORATOR_ENABLED

    • KUBERNETES_KERBEROS_MOUNT_DECORATOR_ENABLED

      public static final org.apache.flink.configuration.ConfigOption<Boolean> KUBERNETES_KERBEROS_MOUNT_DECORATOR_ENABLED

    • LOCAL_UPLOAD_ENABLED

      public static final org.apache.flink.configuration.ConfigOption<Boolean> LOCAL_UPLOAD_ENABLED

    • LOCAL_UPLOAD_OVERWRITE

      public static final org.apache.flink.configuration.ConfigOption<Boolean> LOCAL_UPLOAD_OVERWRITE

    • LOCAL_UPLOAD_TARGET

      public static final org.apache.flink.configuration.ConfigOption<String> LOCAL_UPLOAD_TARGET

    • KUBERNETES_NODE_NAME_LABEL

      public static final org.apache.flink.configuration.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.