com.amazon.jenkins.ec2fleet

Class EC2FleetCloud

java.lang.Object

hudson.model.AbstractModelObject

hudson.model.Actionable

hudson.slaves.Cloud

com.amazon.jenkins.ec2fleet.AbstractEC2FleetCloud

com.amazon.jenkins.ec2fleet.EC2FleetCloud

All Implemented Interfaces:

hudson.ExtensionPoint, hudson.model.Describable<hudson.slaves.Cloud>, hudson.model.ModelObject, hudson.search.SearchableModelObject, hudson.search.SearchItem, hudson.security.AccessControlled, jenkins.model.ModelObjectWithContextMenu

public class EC2FleetCloud
extends AbstractEC2FleetCloud

See Also:

CloudNanny

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	EC2FleetCloud.DescriptorImpl

Nested classes/interfaces inherited from interface hudson.ExtensionPoint

hudson.ExtensionPoint.LegacyInstancesAreScopedToHudson

Nested classes/interfaces inherited from interface jenkins.model.ModelObjectWithContextMenu

jenkins.model.ModelObjectWithContextMenu.ContextMenu, jenkins.model.ModelObjectWithContextMenu.ContextMenuVisibility, jenkins.model.ModelObjectWithContextMenu.MenuItem

Field Summary

Fields

Modifier and Type	Field and Description
static int	DEFAULT_CLOUD_STATUS_INTERVAL_SEC
static String	EC2_INSTANCE_CLOUD_NAME_TAG
static String	EC2_INSTANCE_TAG_NAMESPACE
static String	FLEET_CLOUD_ID

Fields inherited from class hudson.slaves.Cloud

ALL, name, PROVISION

Constructor Summary

Constructors

Constructor and Description

EC2FleetCloud(String name, String oldId, String awsCredentialsId, String credentialsId, String region, String endpoint, String fleet, String labelString, String fsRoot, hudson.slaves.ComputerConnector computerConnector, boolean privateIpUsed, boolean alwaysReconnect, Integer idleMinutes, int minSize, int maxSize, int numExecutors, boolean addNodeOnlyIfRunning, boolean restrictUsage, boolean disableTaskResubmit, Integer initOnlineTimeoutSec, Integer initOnlineCheckIntervalSec, boolean scaleExecutorsByWeight, Integer cloudStatusIntervalSec, boolean noDelayProvision)

Method Summary

Modifier and Type	Method and Description
boolean	canProvision(hudson.model.Label label)
String	getAwsCredentialsId() See awsCredentialsId documentation.
int	getCloudStatusIntervalSec()
hudson.slaves.ComputerConnector	getComputerConnector()
String	getEndpoint()
String	getFleet()
String	getFsRoot()
int	getIdleMinutes()
int	getInitOnlineCheckIntervalSec()
int	getInitOnlineTimeoutSec()
String	getJvmSettings()
String	getLabelString()
int	getMaxSize()
int	getMinSize()
int	getNumExecutors()
String	getOldId() Called old as will be used by new instance of cloud, for which this id is old (not current)
String	getRegion()
boolean	isAddNodeOnlyIfRunning()
boolean	isAlwaysReconnect()
boolean	isDisableTaskResubmit()
boolean	isNoDelayProvision()
boolean	isPrivateIpUsed()
boolean	isRestrictUsage()
boolean	isScaleExecutorsByWeight()
Collection<hudson.slaves.NodeProvisioner.PlannedNode>	provision(hudson.model.Label label, int excessWorkload)
boolean	scheduleToTerminate(String instanceId) Schedule Jenkins Node and EC2 instance to termination.
FleetStateStats	update() Perform sync of plugin data with EC2 Spot Fleet state.

Methods inherited from class hudson.slaves.Cloud

all, getACL, getDescriptor, getDisplayName, getSearchUrl, getUrl

Methods inherited from class hudson.model.Actionable

addAction, addOrReplaceAction, doContextMenu, getAction, getAction, getActions, getActions, getAllActions, getDynamic, removeAction, removeActions, replaceAction, replaceActions

Methods inherited from class hudson.model.AbstractModelObject

getSearch, getSearchIndex, getSearchName, makeSearchIndex, requirePOST, sendError, sendError, sendError, sendError, sendError

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface hudson.security.AccessControlled

checkPermission, hasPermission, hasPermission

Field Detail

EC2_INSTANCE_TAG_NAMESPACE

public static final String EC2_INSTANCE_TAG_NAMESPACE

See Also:

Constant Field Values

EC2_INSTANCE_CLOUD_NAME_TAG

public static final String EC2_INSTANCE_CLOUD_NAME_TAG

See Also:

Constant Field Values

FLEET_CLOUD_ID

public static final String FLEET_CLOUD_ID

See Also:

Constant Field Values

DEFAULT_CLOUD_STATUS_INTERVAL_SEC

public static final int DEFAULT_CLOUD_STATUS_INTERVAL_SEC

See Also:

Constant Field Values

Constructor Detail

EC2FleetCloud

@DataBoundConstructor
public EC2FleetCloud(String name,
                                           String oldId,
                                           String awsCredentialsId,
                                           @Deprecated
                                           String credentialsId,
                                           String region,
                                           String endpoint,
                                           String fleet,
                                           String labelString,
                                           String fsRoot,
                                           hudson.slaves.ComputerConnector computerConnector,
                                           boolean privateIpUsed,
                                           boolean alwaysReconnect,
                                           Integer idleMinutes,
                                           int minSize,
                                           int maxSize,
                                           int numExecutors,
                                           boolean addNodeOnlyIfRunning,
                                           boolean restrictUsage,
                                           boolean disableTaskResubmit,
                                           Integer initOnlineTimeoutSec,
                                           Integer initOnlineCheckIntervalSec,
                                           boolean scaleExecutorsByWeight,
                                           Integer cloudStatusIntervalSec,
                                           boolean noDelayProvision)

Method Detail

isNoDelayProvision

public boolean isNoDelayProvision()

getAwsCredentialsId

public String getAwsCredentialsId()

See awsCredentialsId documentation. Don't use fields directly to be able get old version of plugin and for new.

Returns:

credentials ID

getOldId

public String getOldId()

Called old as will be used by new instance of cloud, for which this id is old (not current)

Specified by:

getOldId in class AbstractEC2FleetCloud

Returns:

id of current cloud

isDisableTaskResubmit

public boolean isDisableTaskResubmit()

Specified by:

isDisableTaskResubmit in class AbstractEC2FleetCloud

getInitOnlineTimeoutSec

public int getInitOnlineTimeoutSec()

getCloudStatusIntervalSec

public int getCloudStatusIntervalSec()

getInitOnlineCheckIntervalSec

public int getInitOnlineCheckIntervalSec()

getRegion

public String getRegion()

getEndpoint

public String getEndpoint()

getFleet

public String getFleet()

getFsRoot

public String getFsRoot()

isAddNodeOnlyIfRunning

public boolean isAddNodeOnlyIfRunning()

getComputerConnector

public hudson.slaves.ComputerConnector getComputerConnector()

isPrivateIpUsed

public boolean isPrivateIpUsed()

isAlwaysReconnect

public boolean isAlwaysReconnect()

Specified by:

isAlwaysReconnect in class AbstractEC2FleetCloud

getLabelString

public String getLabelString()

getIdleMinutes

public int getIdleMinutes()

Specified by:

getIdleMinutes in class AbstractEC2FleetCloud

getMaxSize

public int getMaxSize()

getMinSize

public int getMinSize()

getNumExecutors

public int getNumExecutors()

isScaleExecutorsByWeight

public boolean isScaleExecutorsByWeight()

getJvmSettings

public String getJvmSettings()

isRestrictUsage

public boolean isRestrictUsage()

provision

public Collection<hudson.slaves.NodeProvisioner.PlannedNode> provision(hudson.model.Label label,
                                                                       int excessWorkload)

Specified by:

provision in class hudson.slaves.Cloud

update

public FleetStateStats update()

Perform sync of plugin data with EC2 Spot Fleet state.

Returns:

current state

scheduleToTerminate

public boolean scheduleToTerminate(String instanceId)

Schedule Jenkins Node and EC2 instance to termination. Check first if target capacity more then minSize otherwise reject termination.

Real termination will happens in update() which periodically called by CloudNanny. So it could be some lag between decision that node should be terminated and actual termination, you can find max lag size in CloudNanny.getRecurrencePeriod()

This method doesn't do real termination to reduce load for Jenkins in case when multiple nodes should be terminated in short time, without schedule process and batch termination, multiple calls should be raised to AWS EC2 API which takes some time and block cloud class.

Specified by:

scheduleToTerminate in class AbstractEC2FleetCloud

Parameters:

instanceId - node name or instance ID

Returns:

true if node scheduled to delete, otherwise false

canProvision

public boolean canProvision(hudson.model.Label label)

Specified by:

canProvision in class hudson.slaves.Cloud