com.yahoo.config.provision.Deployer Maven / Gradle / Ivy
// Copyright Vespa.ai. Licensed under the terms of the Apache 2.0 license. See LICENSE in the project root.
package com.yahoo.config.provision;
import java.time.Duration;
import java.time.Instant;
import java.util.Optional;
/**
* A deployer is used to deploy applications.
*
* @author bratseth
*/
public interface Deployer {
/**
* Creates a new deployment from the active application, if available. Will use the default timeout for deployment.
*
* @param application the active application to be redeployed
* @return a new deployment from the active application, or empty if application does not exist
*/
default Optional deployFromLocalActive(ApplicationId application) {
return deployFromLocalActive(application, false);
}
/**
* Creates a new deployment from the active application, if available. Will use the default timeout for deployment.
*
* @param application the active application to be redeployed
* @param bootstrap the deployment is done when bootstrapping
* @return a new deployment from the active application, or empty if application does not exist
*/
Optional deployFromLocalActive(ApplicationId application, boolean bootstrap);
/**
* Creates a new deployment from the active application, if available. Prefer {@link #deployFromLocalActive(ApplicationId)}
* if possible, this method is for testing and will override the default timeout for deployment.
*
* @param application the active application to be redeployed
* @param timeout the timeout to use for each individual deployment operation
* @return a new deployment from the active application, or empty if application does not exist
*/
default Optional deployFromLocalActive(ApplicationId application, Duration timeout) {
return deployFromLocalActive(application, timeout, false);
}
/**
* Creates a new deployment from the active application, if available. Prefer {@link #deployFromLocalActive(ApplicationId)}
* if possible, this method is for testing and will override the default timeout for deployment.
*
* @param application the active application to be redeployed
* @param timeout the timeout to use for each individual deployment operation
* @param bootstrap the deployment is done when bootstrapping
* @return a new deployment from the active application, or empty if application does not exist
*/
Optional deployFromLocalActive(ApplicationId application, Duration timeout, boolean bootstrap);
/** Returns the time the active session was activated, or empty if there is no active session */
Optional activationTime(ApplicationId application);
/** Returns the time of last deployed session for this application or empty if there are no deployments */
Optional deployTime(ApplicationId application);
/** Returns whether the application has reindexing ready to go, which was readied after the given instant. */
boolean readiedReindexingAfter(ApplicationId application, Instant instant);
/** Whether the deployer is bootstrapping, some users of the deployer will want to hold off with deployments in that case. */
default boolean bootstrapping() { return false; }
/** Timeout for deploy in server, clients can use this to set correct client timeout */
Duration serverDeployTimeout();
}