123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382 |
- package hudson.plugins.ec2;
- import hudson.Extension;
- import hudson.Util;
- import hudson.model.Computer;
- import hudson.model.Descriptor.FormException;
- import hudson.model.Hudson;
- import hudson.model.Slave;
- import hudson.model.Node;
- import hudson.plugins.ec2.ssh.EC2UnixLauncher;
- import hudson.slaves.NodeProperty;
- import hudson.util.ListBoxModel;
- import java.io.IOException;
- import java.util.Collections;
- import java.util.List;
- import java.util.LinkedList;
- import java.util.HashSet;
- import java.util.logging.Level;
- import java.util.logging.Logger;
- import javax.servlet.ServletException;
- import org.apache.commons.lang.StringUtils;
- import org.kohsuke.stapler.DataBoundConstructor;
- import org.kohsuke.stapler.QueryParameter;
- import org.kohsuke.stapler.StaplerRequest;
- import com.amazonaws.AmazonClientException;
- import com.amazonaws.services.ec2.AmazonEC2;
- import com.amazonaws.services.ec2.model.*;
- import net.sf.json.JSONObject;
- /**
- * Slave running on EC2.
- *
- * @author Kohsuke Kawaguchi
- */
- public final class EC2Slave extends Slave {
- /**
- * Comes from {@link SlaveTemplate#initScript}.
- */
- public final String initScript;
- public final String remoteAdmin; // e.g. 'ubuntu'
- public final String rootCommandPrefix; // e.g. 'sudo'
- public final String jvmopts; //e.g. -Xmx1g
- public final boolean stopOnTerminate;
- public final String idleTerminationMinutes;
- public final boolean usePrivateDnsName;
- public List<EC2Tag> tags;
- // Temporary stuff that is obtained live from EC2
- public String publicDNS;
- public String privateDNS;
- /* The last instance data to be fetched for the slave */
- private Instance lastFetchInstance = null;
- /* The time at which we fetched the last instance data */
- private long lastFetchTime = 0;
- /* The time (in milliseconds) after which we will always re-fetch externally changeable EC2 data when we are asked for it */
- private static final long MIN_FETCH_TIME = 20 * 1000;
- /**
- * For data read from old Hudson, this is 0, so we use that to indicate 22.
- */
- private final int sshPort;
- public static final String TEST_ZONE = "testZone";
-
- public EC2Slave(String instanceId, String description, String remoteFS, int sshPort, int numExecutors, String labelString, String initScript, String remoteAdmin, String rootCommandPrefix, String jvmopts, boolean stopOnTerminate, String idleTerminationMinutes, String publicDNS, String privateDNS, List<EC2Tag> tags) throws FormException, IOException {
- this(instanceId, description, remoteFS, sshPort, numExecutors, Mode.NORMAL, labelString, initScript, Collections.<NodeProperty<?>>emptyList(), remoteAdmin, rootCommandPrefix, jvmopts, stopOnTerminate, idleTerminationMinutes, publicDNS, privateDNS, tags, false);
- }
- public EC2Slave(String instanceId, String description, String remoteFS, int sshPort, int numExecutors, String labelString, String initScript, String remoteAdmin, String rootCommandPrefix, String jvmopts, boolean stopOnTerminate, String idleTerminationMinutes, String publicDNS, String privateDNS, List<EC2Tag> tags, boolean usePrivateDnsName) throws FormException, IOException {
- this(instanceId, description, remoteFS, sshPort, numExecutors, Mode.NORMAL, labelString, initScript, Collections.<NodeProperty<?>>emptyList(), remoteAdmin, rootCommandPrefix, jvmopts, stopOnTerminate, idleTerminationMinutes, publicDNS, privateDNS, tags, usePrivateDnsName);
- }
- @DataBoundConstructor
- public EC2Slave(String instanceId, String description, String remoteFS, int sshPort, int numExecutors, Mode mode, String labelString, String initScript, List<? extends NodeProperty<?>> nodeProperties, String remoteAdmin, String rootCommandPrefix, String jvmopts, boolean stopOnTerminate, String idleTerminationMinutes, String publicDNS, String privateDNS, List<EC2Tag> tags, boolean usePrivateDnsName) throws FormException, IOException {
- super(instanceId, description, remoteFS, numExecutors, mode, labelString, new EC2UnixLauncher(), new EC2RetentionStrategy(idleTerminationMinutes), nodeProperties);
- this.initScript = initScript;
- this.remoteAdmin = remoteAdmin;
- this.rootCommandPrefix = rootCommandPrefix;
- this.jvmopts = jvmopts;
- this.sshPort = sshPort;
- this.stopOnTerminate = stopOnTerminate;
- this.idleTerminationMinutes = idleTerminationMinutes;
- this.publicDNS = publicDNS;
- this.privateDNS = privateDNS;
- this.tags = tags;
- this.usePrivateDnsName = usePrivateDnsName;
- }
- /**
- * Constructor for debugging.
- */
- public EC2Slave(String instanceId) throws FormException, IOException {
- this(instanceId,"debug", "/tmp/hudson", 22, 1, Mode.NORMAL, "debug", "", Collections.<NodeProperty<?>>emptyList(), null, null, null, false, null, "Fake public", "Fake private", null, false);
- }
- /**
- * See http://aws.amazon.com/ec2/instance-types/
- */
- /*package*/ static int toNumExecutors(InstanceType it) {
- switch (it) {
- case T1Micro: return 1;
- case M1Small: return 1;
- case M1Medium: return 2;
- case M1Large: return 4;
- case C1Medium: return 5;
- case M2Xlarge: return 6;
- case M1Xlarge: return 8;
- case M22xlarge: return 13;
- case C1Xlarge: return 20;
- case M24xlarge: return 26;
- case Cc14xlarge: return 33;
- case Cg14xlarge: return 33;
- default: throw new AssertionError();
- }
- }
- /**
- * EC2 instance ID.
- */
- public String getInstanceId() {
- return getNodeName();
- }
- @Override
- public Computer createComputer() {
- return new EC2Computer(this);
- }
- public static Instance getInstance(String instanceId) {
- DescribeInstancesRequest request = new DescribeInstancesRequest();
- request.setInstanceIds(Collections.<String>singletonList(instanceId));
- EC2Cloud cloudInstance = EC2Cloud.get();
- if (cloudInstance == null)
- return null;
- AmazonEC2 ec2 = cloudInstance.connect();
- List<Reservation> reservations = ec2.describeInstances(request).getReservations();
- Instance i = null;
- if (reservations.size() > 0) {
- List<Instance> instances = reservations.get(0).getInstances();
- if (instances.size() > 0)
- i = instances.get(0);
- }
- return i;
- }
-
- /**
- * Terminates the instance in EC2.
- */
- public void terminate() {
- try {
- if (!isAlive(true)) {
- /* The node has been killed externally, so we've nothing to do here */
- LOGGER.info("EC2 instance already terminated: "+getInstanceId());
- } else {
- AmazonEC2 ec2 = EC2Cloud.get().connect();
- TerminateInstancesRequest request = new TerminateInstancesRequest(Collections.singletonList(getInstanceId()));
- ec2.terminateInstances(request);
- LOGGER.info("Terminated EC2 instance (terminated): "+getInstanceId());
- }
- Hudson.getInstance().removeNode(this);
- } catch (AmazonClientException e) {
- LOGGER.log(Level.WARNING,"Failed to terminate EC2 instance: "+getInstanceId(),e);
- } catch (IOException e) {
- LOGGER.log(Level.WARNING,"Failed to terminate EC2 instance: "+getInstanceId(),e);
- }
- }
- void idleTimeout() {
- LOGGER.info("EC2 instance idle time expired: "+getInstanceId());
- if (!stopOnTerminate) {
- terminate();
- return;
- }
- try {
- AmazonEC2 ec2 = EC2Cloud.get().connect();
- StopInstancesRequest request = new StopInstancesRequest(
- Collections.singletonList(getInstanceId()));
- ec2.stopInstances(request);
- toComputer().disconnect(null);
- } catch (AmazonClientException e) {
- Instance i = getInstance(getNodeName());
- LOGGER.log(Level.WARNING, "Failed to terminate EC2 instance: "+getInstanceId() + " info: "+((i != null)?i:"") , e);
- }
- LOGGER.info("EC2 instance stopped: " + getInstanceId());
- }
- String getRemoteAdmin() {
- if (remoteAdmin == null || remoteAdmin.length() == 0)
- return "root";
- return remoteAdmin;
- }
- String getRootCommandPrefix() {
- if (rootCommandPrefix == null || rootCommandPrefix.length() == 0)
- return "";
- return rootCommandPrefix + " ";
- }
- String getJvmopts() {
- return Util.fixNull(jvmopts);
- }
- public int getSshPort() {
- return sshPort!=0 ? sshPort : 22;
- }
- public boolean getStopOnTerminate() {
- return stopOnTerminate;
- }
- private boolean isAlive(boolean force) {
- fetchLiveInstanceData(force);
- if (lastFetchInstance == null) return false;
- if (lastFetchInstance.getState().getName().equals(InstanceStateName.Terminated.toString())) return false;
- return true;
- }
- /* Much of the EC2 data is beyond our direct control, therefore we need to refresh it from time to
- time to ensure we reflect the reality of the instances. */
- private void fetchLiveInstanceData( boolean force ) throws AmazonClientException {
- /* If we've grabbed the data recently, don't bother getting it again unless we are forced */
- long now = System.currentTimeMillis();
- if ((lastFetchTime > 0) && (now - lastFetchTime < MIN_FETCH_TIME) && !force) {
- return;
- }
- Instance i = getInstance(getNodeName());
- lastFetchTime = now;
- lastFetchInstance = i;
- if (i == null)
- return;
- publicDNS = i.getPublicDnsName();
- privateDNS = i.getPrivateIpAddress();
- tags = new LinkedList<EC2Tag>();
- for (Tag t : i.getTags()) {
- tags.add(new EC2Tag(t.getKey(), t.getValue()));
- }
- }
- /* Clears all existing tag data so that we can force the instance into a known state */
- private void clearLiveInstancedata() throws AmazonClientException {
- Instance inst = getInstance(getNodeName());
- /* Now that we have our instance, we can clear the tags on it */
- if (!tags.isEmpty()) {
- HashSet<Tag> inst_tags = new HashSet<Tag>();
- for(EC2Tag t : tags) {
- inst_tags.add(new Tag(t.getName(), t.getValue()));
- }
- DeleteTagsRequest tag_request = new DeleteTagsRequest();
- tag_request.withResources(inst.getInstanceId()).setTags(inst_tags);
- EC2Cloud.get().connect().deleteTags(tag_request);
- }
- }
- /* Sets tags on an instance. This will not clear existing tag data, so call clearLiveInstancedata if needed */
- private void pushLiveInstancedata() throws AmazonClientException {
- Instance inst = getInstance(getNodeName());
- /* Now that we have our instance, we can set tags on it */
- if (tags != null && !tags.isEmpty()) {
- HashSet<Tag> inst_tags = new HashSet<Tag>();
- for(EC2Tag t : tags) {
- inst_tags.add(new Tag(t.getName(), t.getValue()));
- }
- CreateTagsRequest tag_request = new CreateTagsRequest();
- tag_request.withResources(inst.getInstanceId()).setTags(inst_tags);
- EC2Cloud.get().connect().createTags(tag_request);
- }
- }
- public String getPublicDNS() {
- fetchLiveInstanceData(false);
- return publicDNS;
- }
- public String getPrivateDNS() {
- fetchLiveInstanceData(false);
- return privateDNS;
- }
- public List<EC2Tag> getTags() {
- fetchLiveInstanceData(false);
- return Collections.unmodifiableList(tags);
- }
- @Override
- public Node reconfigure(final StaplerRequest req, JSONObject form) throws FormException {
- if (form == null) {
- return null;
- }
- if (!isAlive(true)) {
- LOGGER.info("EC2 instance terminated externally: " + getInstanceId());
- try {
- Hudson.getInstance().removeNode(this);
- } catch (IOException ioe) {
- LOGGER.log(Level.WARNING, "Attempt to reconfigure EC2 instance which has been externally terminated: " + getInstanceId(), ioe);
- }
- return null;
- }
- Node result = super.reconfigure(req, form);
- /* Get rid of the old tags, as represented by ourselves. */
- clearLiveInstancedata();
- /* Set the new tags, as represented by our successor */
- ((EC2Slave) result).pushLiveInstancedata();
- return result;
- }
- public boolean getUsePrivateDnsName() {
- return usePrivateDnsName;
- }
-
- public static ListBoxModel fillZoneItems(String accessId, String secretKey, String region) throws IOException, ServletException {
- ListBoxModel model = new ListBoxModel();
- if (AmazonEC2Cloud.testMode) {
- model.add(TEST_ZONE);
- return model;
- }
-
- if (!StringUtils.isEmpty(accessId) && !StringUtils.isEmpty(secretKey) && !StringUtils.isEmpty(region)) {
- AmazonEC2 client = EC2Cloud.connect(accessId, secretKey, AmazonEC2Cloud.getEc2EndpointUrl(region));
- DescribeAvailabilityZonesResult zones = client.describeAvailabilityZones();
- List<AvailabilityZone> zoneList = zones.getAvailabilityZones();
- model.add("<not specified>", "");
- for (AvailabilityZone z : zoneList) {
- model.add(z.getZoneName(), z.getZoneName());
- }
- }
- return model;
- }
-
-
- @Extension
- public static final class DescriptorImpl extends SlaveDescriptor {
- @Override
- public String getDisplayName() {
- return "Amazon EC2";
- }
- @Override
- public boolean isInstantiable() {
- return false;
- }
- public ListBoxModel doFillZoneItems(@QueryParameter String accessId,
- @QueryParameter String secretKey, @QueryParameter String region) throws IOException,
- ServletException {
- return fillZoneItems(accessId, secretKey, region);
- }
- }
- private static final Logger LOGGER = Logger.getLogger(EC2Slave.class.getName());
- }
|