org.apache.flink.runtime.clusterframework.ContaineredTaskManagerParameters Maven / Gradle / Ivy

Go to download
/*
 * 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.runtime.clusterframework;

import org.apache.flink.configuration.Configuration;
import org.apache.flink.configuration.ResourceManagerOptions;

import java.util.HashMap;
import java.util.Map;

/** This class describes the basic parameters for launching a TaskManager process. */
public class ContaineredTaskManagerParameters implements java.io.Serializable {

    private static final long serialVersionUID = -3096987654278064670L;

    /** Environment variables to add to the Java process. */
    private final HashMap taskManagerEnv;

    private final TaskExecutorProcessSpec taskExecutorProcessSpec;

    public ContaineredTaskManagerParameters(
            TaskExecutorProcessSpec taskExecutorProcessSpec,
            HashMap taskManagerEnv) {

        this.taskExecutorProcessSpec = taskExecutorProcessSpec;
        this.taskManagerEnv = taskManagerEnv;
    }

    // ------------------------------------------------------------------------

    public TaskExecutorProcessSpec getTaskExecutorProcessSpec() {
        return taskExecutorProcessSpec;
    }

    public Map taskManagerEnv() {
        return taskManagerEnv;
    }

    // ------------------------------------------------------------------------

    @Override
    public String toString() {
        return "TaskManagerParameters {"
                + "taskExecutorProcessSpec="
                + taskExecutorProcessSpec
                + ", taskManagerEnv="
                + taskManagerEnv
                + '}';
    }

    // ------------------------------------------------------------------------
    //  Factory
    // ------------------------------------------------------------------------

    /**
     * Computes the parameters to be used to start a TaskManager Java process.
     *
     * @param config The Flink configuration.
     * @param taskExecutorProcessSpec The resource specifics of the task executor.
     * @return The parameters to start the TaskManager processes with.
     */
    public static ContaineredTaskManagerParameters create(
            Configuration config, TaskExecutorProcessSpec taskExecutorProcessSpec) {

        // obtain the additional environment variables from the configuration
        final HashMap envVars = new HashMap<>();
        final String prefix = ResourceManagerOptions.CONTAINERIZED_TASK_MANAGER_ENV_PREFIX;

        for (String key : config.keySet()) {
            if (key.startsWith(prefix) && key.length() > prefix.length()) {
                // remove prefix
                String envVarKey = key.substring(prefix.length());
                envVars.put(envVarKey, config.getString(key, null));
            }
        }

        // done
        return new ContaineredTaskManagerParameters(taskExecutorProcessSpec, envVars);
    }
}