com.atlassian.bamboo.agent.elastic.server

Interface ElasticFunctionalityFacade

All Known Implementing Classes:

ElasticFunctionalityFacadeImpl

public interface ElasticFunctionalityFacade

Facade that orchestrates EC2 related functionalities

Nested Class Summary

Nested Classes

Modifier and Type	Interface and Description
static class	ElasticFunctionalityFacade.Ec2PrivateKeyValidationStatus

Field Summary

Fields

Modifier and Type	Field and Description
static int	DEFAULT_ALLOWED_AGENTS

Method Summary

Modifier and Type	Method and Description
void	addElasticLogEntry(org.apache.log4j.Logger log, String logEntry)
void	adjustElasticInstanceNumbers(ElasticInstanceSchedule instanceSchedule) Given the ElasticInstanceSchedule startup or bring down the correct number of agents
String	getKeyPairName()
int	getMaxConcurrentInstances()
com.atlassian.fugue.Either<ElasticFunctionalityFacade.Ec2PrivateKeyValidationStatus,com.atlassian.fugue.Option<String>>	getPassword(RemoteElasticInstance instance) Deprecated. since 6.2 use getPassword2(RemoteElasticInstance) instead
io.atlassian.fugue.Either<ElasticFunctionalityFacade.Ec2PrivateKeyValidationStatus,Optional<String>>	getPassword2(RemoteElasticInstance instance)
String	getPkFileLocation()
com.atlassian.fugue.Either<ElasticFunctionalityFacade.Ec2PrivateKeyValidationStatus,File>	getPrivateKeyLocation() Returns the location of the AWS private key
boolean	isElasticSupportEnabled()
boolean	isElasticSupportPossible(ErrorCollection errorCollection)
void	recheckElasticSupportEnabledFlag()
void	restoreAgent(ElasticAgentDefinition elasticAgentDefinition, com.amazonaws.services.ec2.model.Instance instance, com.atlassian.aws.AWSAccount awsAccount)
void	setElasticSupportEnabled(boolean elasticSupportEnabled) Enable/disable Elastic Bamboo functionality
void	shutdownAllInstances()
void	shutdownInstance(RemoteElasticInstance elasticInstance)
void	shutdownInstance(String instanceId)
void	startupAgents(Collection<ElasticImageConfiguration> elasticImageConfigurations)
void	updateAgentPendingStatus(String instanceId) Set the agent pending status to true for the given instance id
boolean	validateAgentCreation(int numAgentsRequired, ErrorCollection errorCollection) Validates whether the requested number of agents can be created and adds any errors to the error collection.

Field Detail

DEFAULT_ALLOWED_AGENTS

static final int DEFAULT_ALLOWED_AGENTS

See Also:

Constant Field Values

Method Detail

getKeyPairName

@NotNull
String getKeyPairName()

recheckElasticSupportEnabledFlag

void recheckElasticSupportEnabledFlag()

shutdownInstance

void shutdownInstance(@NotNull
                      RemoteElasticInstance elasticInstance)

shutdownInstance

void shutdownInstance(String instanceId)
               throws com.atlassian.aws.AWSException

Throws:

com.atlassian.aws.AWSException

shutdownAllInstances

void shutdownAllInstances()

startupAgents

void startupAgents(@NotNull
                   Collection<ElasticImageConfiguration> elasticImageConfigurations)
            throws com.atlassian.aws.AWSException

Throws:

com.atlassian.aws.AWSException

validateAgentCreation

boolean validateAgentCreation(int numAgentsRequired,
                              ErrorCollection errorCollection)

Validates whether the requested number of agents can be created and adds any errors to the error collection.

Parameters:

numAgentsRequired - - number of agents to be created

errorCollection - - error collection to add any validation errors to.

restoreAgent

void restoreAgent(@NotNull
                  ElasticAgentDefinition elasticAgentDefinition,
                  @NotNull
                  com.amazonaws.services.ec2.model.Instance instance,
                  @NotNull
                  com.atlassian.aws.AWSAccount awsAccount)

isElasticSupportEnabled

boolean isElasticSupportEnabled()

Returns:

true, if elastic support is turned on

setElasticSupportEnabled

void setElasticSupportEnabled(boolean elasticSupportEnabled)

Enable/disable Elastic Bamboo functionality

Parameters:

elasticSupportEnabled - Specifies if Elastc Baboo shall be enabled or disabled.

isElasticSupportPossible

boolean isElasticSupportPossible(@NotNull
                                 ErrorCollection errorCollection)

Returns:

true, if all preconditions for turning elastic support on are met

getPkFileLocation

@NotNull
String getPkFileLocation()

getPrivateKeyLocation

@NotNull
com.atlassian.fugue.Either<ElasticFunctionalityFacade.Ec2PrivateKeyValidationStatus,File> getPrivateKeyLocation()

Returns the location of the AWS private key

Returns:

getMaxConcurrentInstances

int getMaxConcurrentInstances()

Returns:

max number of elastic instances allowed for this instance. It's based on license restrictions.

updateAgentPendingStatus

void updateAgentPendingStatus(String instanceId)

Set the agent pending status to true for the given instance id

Parameters:

instanceId -

addElasticLogEntry

void addElasticLogEntry(org.apache.log4j.Logger log,
                        String logEntry)

adjustElasticInstanceNumbers

void adjustElasticInstanceNumbers(@NotNull
                                  ElasticInstanceSchedule instanceSchedule)
                           throws com.atlassian.aws.AWSException

Given the ElasticInstanceSchedule startup or bring down the correct number of agents

Parameters:

instanceSchedule -

Throws:

com.atlassian.aws.AWSException

getPassword

@Deprecated
 @NotNull
com.atlassian.fugue.Either<ElasticFunctionalityFacade.Ec2PrivateKeyValidationStatus,com.atlassian.fugue.Option<String>> getPassword(RemoteElasticInstance instance)

Deprecated. since 6.2 use getPassword2(RemoteElasticInstance) instead

getPassword2

@NotNull
io.atlassian.fugue.Either<ElasticFunctionalityFacade.Ec2PrivateKeyValidationStatus,Optional<String>> getPassword2(RemoteElasticInstance instance)