org.apache.flink.kubernetes.kubeclient.parameters.AbstractKubernetesParameters Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of flink-kubernetes_2.11 Show documentation
The newest version!
/*
 * Licensed to the Apache Software Foundation (ASF) under one
 * or more contributor license agreements.  See the NOTICE file
 * distributed with this work for additional information
 * regarding copyright ownership.  The ASF licenses this file
 * to you under the Apache License, Version 2.0 (the
 * "License"); you may not use this file except in compliance
 * with the License.  You may obtain a copy of the License at
 *
 *     http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 */

package org.apache.flink.kubernetes.kubeclient.parameters;

import org.apache.flink.client.cli.CliFrontend;
import org.apache.flink.configuration.Configuration;
import org.apache.flink.kubernetes.configuration.KubernetesConfigOptions;
import org.apache.flink.kubernetes.configuration.KubernetesConfigOptionsInternal;
import org.apache.flink.kubernetes.utils.Constants;
import org.apache.flink.util.Preconditions;

import io.fabric8.kubernetes.api.model.LocalObjectReference;
import org.apache.commons.lang3.StringUtils;

import java.io.File;
import java.util.HashMap;
import java.util.List;
import java.util.Map;
import java.util.Optional;

import static org.apache.flink.kubernetes.configuration.KubernetesConfigOptions.CONTAINER_IMAGE_PULL_SECRETS;
import static org.apache.flink.kubernetes.utils.Constants.CONFIG_FILE_LOG4J_NAME;
import static org.apache.flink.kubernetes.utils.Constants.CONFIG_FILE_LOGBACK_NAME;
import static org.apache.flink.util.Preconditions.checkArgument;
import static org.apache.flink.util.Preconditions.checkNotNull;

/**
 * Abstract class for the {@link KubernetesParameters}.
 */
public abstract class AbstractKubernetesParameters implements KubernetesParameters {

	public static final String INIT_CONTAINER_NAME = "flink-initializer";

	protected final Configuration flinkConfig;

	public AbstractKubernetesParameters(Configuration flinkConfig) {
		this.flinkConfig = checkNotNull(flinkConfig);
	}

	public Configuration getFlinkConfiguration() {
		return flinkConfig;
	}

	@Override
	public String getClusterId() {
		final String clusterId = flinkConfig.getString(KubernetesConfigOptions.CLUSTER_ID);
		checkNotNull(clusterId, "ClusterId must be specified.");

		return clusterId;
	}

	@Override
	public String getNamespace() {
		final String namespace = flinkConfig.getString(KubernetesConfigOptions.NAMESPACE);
		checkArgument(!namespace.trim().isEmpty(), "Invalid " + KubernetesConfigOptions.NAMESPACE + ".");

		return namespace;
	}

	@Override
	public String getImage() {
		final String containerImage = flinkConfig.getString(KubernetesConfigOptions.CONTAINER_IMAGE);
		checkArgument(!containerImage.trim().isEmpty(),
			"Invalid " + KubernetesConfigOptions.CONTAINER_IMAGE + ".");
		return containerImage;
	}

	@Override
	public KubernetesConfigOptions.ImagePullPolicy getImagePullPolicy() {
		return flinkConfig.get(KubernetesConfigOptions.CONTAINER_IMAGE_PULL_POLICY);
	}

	@Override
	public LocalObjectReference[] getImagePullSecrets() {
		final List imagePullSecrets = flinkConfig.get(CONTAINER_IMAGE_PULL_SECRETS);

		if (imagePullSecrets == null) {
			return new LocalObjectReference[0];
		} else {
			return imagePullSecrets.stream()
				.map(String::trim)
				.filter(secret -> !secret.isEmpty())
				.map(LocalObjectReference::new)
				.toArray(LocalObjectReference[]::new);
		}
	}

	@Override
	public Map getCommonLabels() {
		Map commonLabels = new HashMap<>();
		commonLabels.put(Constants.LABEL_TYPE_KEY, Constants.LABEL_TYPE_NATIVE_TYPE);
		commonLabels.put(Constants.LABEL_APP_KEY, getClusterId());

		return commonLabels;
	}

	@Override
	public String getFlinkConfDirInPod() {
		return flinkConfig.getString(KubernetesConfigOptions.FLINK_CONF_DIR);
	}

	@Override
	public String getFlinkLogDirInPod() {
		return flinkConfig.getString(KubernetesConfigOptions.FLINK_LOG_DIR);
	}

	@Override
	public String getContainerEntrypoint() {
		return flinkConfig.getString(KubernetesConfigOptions.KUBERNETES_ENTRY_PATH);
	}

	@Override
	public boolean hasLogback() {
		final String confDir = CliFrontend.getConfigurationDirectoryFromEnv();
		final File logbackFile = new File(confDir, CONFIG_FILE_LOGBACK_NAME);
		return logbackFile.exists();
	}

	@Override
	public boolean hasLog4j() {
		final String confDir = CliFrontend.getConfigurationDirectoryFromEnv();
		final File log4jFile = new File(confDir, CONFIG_FILE_LOG4J_NAME);
		return log4jFile.exists();
	}

	@Override
	public Optional getExistingHadoopConfigurationConfigMap() {
		final String existingHadoopConfigMap = flinkConfig.getString(KubernetesConfigOptions.HADOOP_CONF_CONFIG_MAP);
		if (StringUtils.isBlank(existingHadoopConfigMap)) {
			return Optional.empty();
		} else {
			return Optional.of(existingHadoopConfigMap.trim());
		}
	}

	@Override
	public Optional getLocalHadoopConfigurationDirectory() {
		final String[] possibleHadoopConfPaths = new String[] {
			System.getenv(Constants.ENV_HADOOP_CONF_DIR),
			System.getenv(Constants.ENV_HADOOP_HOME) + "/etc/hadoop", // hadoop 2.2
			System.getenv(Constants.ENV_HADOOP_HOME) + "/conf"
		};

		for (String hadoopConfPath: possibleHadoopConfPaths) {
			if (StringUtils.isNotBlank(hadoopConfPath)) {
				return Optional.of(hadoopConfPath);
			}
		}

		return Optional.empty();
	}

	@Override
	public Boolean enableInitContainer() {
		return flinkConfig.getBoolean(KubernetesConfigOptionsInternal.ENABLE_INIT_CONTAINER);
	}

	@Override
	public String getInitContainerName() {
		return INIT_CONTAINER_NAME;
	}

	@Override
	public String getJarsDownloadDirInPod() {
		final String jarsDownloadDirInPod = flinkConfig.get(KubernetesConfigOptions.JARS_DOWNLOAD_DIR);
		Preconditions.checkArgument(StringUtils.isNotBlank(jarsDownloadDirInPod),
			"Invalid value of " + KubernetesConfigOptions.JARS_DOWNLOAD_DIR.key());
		return jarsDownloadDirInPod;
	}

	@Override
	public String getFilesDownloadDirInPod() {
		final String filesDownloadDirInPod = flinkConfig.get(KubernetesConfigOptions.FILES_DOWNLOAD_DIR);
		Preconditions.checkArgument(StringUtils.isNotBlank(filesDownloadDirInPod),
			"Invalid value of " + KubernetesConfigOptions.FILES_DOWNLOAD_DIR.key());
		return filesDownloadDirInPod;
	}
}