com.netflix.genie.web.properties.LocalAgentLauncherProperties Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of genie-web Show documentation
genie-web
The newest version!
/*
 *
 *  Copyright 2019 Netflix, Inc.
 *
 *     Licensed 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 com.netflix.genie.web.properties;

import com.google.common.collect.Lists;
import com.google.common.collect.Maps;
import lombok.Getter;
import lombok.Setter;
import org.springframework.boot.context.properties.ConfigurationProperties;
import org.springframework.validation.annotation.Validated;

import javax.validation.constraints.Min;
import javax.validation.constraints.NotBlank;
import javax.validation.constraints.NotEmpty;
import java.time.Duration;
import java.util.List;
import java.util.Map;

/**
 * Properties related to launching Agent processes locally.
 *
 * @author tgianos
 * @since 4.0.0
 */
@ConfigurationProperties(prefix = LocalAgentLauncherProperties.PROPERTY_PREFIX)
@Getter
@Setter
@Validated
public class LocalAgentLauncherProperties {

    /**
     * Prefix for all properties related to the local agent launcher.
     */
    public static final String PROPERTY_PREFIX = "genie.agent.launcher.local";

    /**
     * Name of the property that enables/disables the launcher.
     */
    public static final String ENABLE_PROPERTY = PROPERTY_PREFIX + ".enabled";

    /**
     * Placeholder for server hostname in command-line-template.
     */
    public static final String SERVER_HOST_PLACEHOLDER = "";

    /**
     * Placeholder for server port in command-line-template.
     */
    public static final String SERVER_PORT_PLACEHOLDER = "";

    /**
     * Placeholder for job id in command-line-template.
     */
    public static final String JOB_ID_PLACEHOLDER = "";

    /**
     * Placeholder for agent jar path in command-line-template.
     */
    public static final String AGENT_JAR_PLACEHOLDER = "";

    /**
     * Property that enables or disables the launcher.
     */
    private boolean enabled = true;

    /**
     * The command that should be run to execute the Genie agent. Required.
     */
    @SuppressWarnings("PMD.AvoidUsingHardCodedIP")
    @NotEmpty(message = "The command-line launch template cannot be empty")
    private List<@NotBlank String> launchCommandTemplate = Lists.newArrayList(
        "java",
        "-jar", AGENT_JAR_PLACEHOLDER,
        "exec",
        "--server-host", SERVER_HOST_PLACEHOLDER,
        "--server-port", SERVER_PORT_PLACEHOLDER,
        "--api-job",
        "--job-id", JOB_ID_PLACEHOLDER
    );

    /**
     * The path to the agent jar.
     */
    @NotEmpty(message = "The agent jar path cannot be empty")
    private String agentJarPath = "/tmp/genie-agent.jar";

    /**
     * Additional environment variables set for the agent.
     */
    private Map<@NotEmpty String, String> additionalEnvironment = Maps.newHashMap();

    /**
     * Capturing the agent stdout and stderr streams to file for debugging purposes.
     */
    private boolean processOutputCaptureEnabled;

    /**
     * Defaults to 10 GB (10,240 MB).
     */
    @Min(value = 1, message = "The minimum value is 1MB but the value should likely be much higher")
    private long maxJobMemory = 10_240;

    /**
     * Default to 30 GB (30,720 MB).
     */
    @Min(value = 1L, message = "The minimum value is 1MB but the value should likely be set much higher")
    private long maxTotalJobMemory = 30_720L;

    /**
     * Launch agent as the user in the job request (launches as the server user if false).
     */
    private boolean runAsUserEnabled;

    /**
     * How long after the job information for this host is written into a local cache is it evicted.
     * 
     * Should be higher than {@link #getHostInfoRefreshAfter()}.
     */
    private Duration hostInfoExpireAfter = Duration.ofMinutes(1L);

    /**
     * How long after the job information for this host is written should it be automatically refreshed from
     * the underlying data source.
     * 
     * Should be lower than {@link #getHostInfoExpireAfter()}.
     */
    private Duration hostInfoRefreshAfter = Duration.ofSeconds(30L);

    /**
     * Genie server hostname to connect to. Only used if the command-line template references a placeholder for this
     * value.
     */
    private String serverHostname = "127.0.0.1";
}