| 1 | /** |
| 2 | * |
| 3 | * Copyright (C) 2011 Cloud Conscious, LLC. <info@cloudconscious.com> |
| 4 | * |
| 5 | * ==================================================================== |
| 6 | * Licensed under the Apache License, Version 2.0 (the "License"); |
| 7 | * you may not use this file except in compliance with the License. |
| 8 | * You may obtain a copy of the License at |
| 9 | * |
| 10 | * http://www.apache.org/licenses/LICENSE-2.0 |
| 11 | * |
| 12 | * Unless required by applicable law or agreed to in writing, software |
| 13 | * distributed under the License is distributed on an "AS IS" BASIS, |
| 14 | * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. |
| 15 | * See the License for the specific language governing permissions and |
| 16 | * limitations under the License. |
| 17 | * ==================================================================== |
| 18 | */ |
| 19 | package org.jclouds.ec2.compute; |
| 20 | |
| 21 | import static com.google.common.collect.Iterables.concat; |
| 22 | import static com.google.common.collect.Iterables.filter; |
| 23 | import static com.google.common.collect.Iterables.transform; |
| 24 | import static org.jclouds.util.Preconditions2.checkNotEmpty; |
| 25 | |
| 26 | import java.util.Map; |
| 27 | import java.util.Map.Entry; |
| 28 | import java.util.Set; |
| 29 | import java.util.concurrent.ExecutorService; |
| 30 | |
| 31 | import javax.inject.Inject; |
| 32 | import javax.inject.Named; |
| 33 | import javax.inject.Provider; |
| 34 | import javax.inject.Singleton; |
| 35 | |
| 36 | import org.jclouds.Constants; |
| 37 | import org.jclouds.aws.util.AWSUtils; |
| 38 | import org.jclouds.collect.Memoized; |
| 39 | import org.jclouds.compute.ComputeServiceContext; |
| 40 | import org.jclouds.compute.callables.RunScriptOnNode; |
| 41 | import org.jclouds.compute.domain.Hardware; |
| 42 | import org.jclouds.compute.domain.Image; |
| 43 | import org.jclouds.compute.domain.NodeMetadata; |
| 44 | import org.jclouds.compute.domain.TemplateBuilder; |
| 45 | import org.jclouds.compute.internal.BaseComputeService; |
| 46 | import org.jclouds.compute.internal.PersistNodeCredentials; |
| 47 | import org.jclouds.compute.options.TemplateOptions; |
| 48 | import org.jclouds.compute.reference.ComputeServiceConstants.Timeouts; |
| 49 | import org.jclouds.compute.strategy.CreateNodesInGroupThenAddToSet; |
| 50 | import org.jclouds.compute.strategy.DestroyNodeStrategy; |
| 51 | import org.jclouds.compute.strategy.GetNodeMetadataStrategy; |
| 52 | import org.jclouds.compute.strategy.InitializeRunScriptOnNodeOrPlaceInBadMap; |
| 53 | import org.jclouds.compute.strategy.ListNodesStrategy; |
| 54 | import org.jclouds.compute.strategy.RebootNodeStrategy; |
| 55 | import org.jclouds.compute.strategy.ResumeNodeStrategy; |
| 56 | import org.jclouds.compute.strategy.SuspendNodeStrategy; |
| 57 | import org.jclouds.domain.Credentials; |
| 58 | import org.jclouds.domain.Location; |
| 59 | import org.jclouds.ec2.EC2Client; |
| 60 | import org.jclouds.ec2.compute.domain.RegionAndName; |
| 61 | import org.jclouds.ec2.compute.domain.RegionNameAndIngressRules; |
| 62 | import org.jclouds.ec2.compute.options.EC2TemplateOptions; |
| 63 | import org.jclouds.ec2.domain.KeyPair; |
| 64 | import org.jclouds.ec2.domain.RunningInstance; |
| 65 | import org.jclouds.scriptbuilder.functions.InitAdminAccess; |
| 66 | |
| 67 | import com.google.common.annotations.VisibleForTesting; |
| 68 | import com.google.common.base.Function; |
| 69 | import com.google.common.base.Predicate; |
| 70 | import com.google.common.base.Supplier; |
| 71 | import com.google.common.collect.ImmutableMultimap; |
| 72 | import com.google.common.collect.ImmutableMultimap.Builder; |
| 73 | import com.google.common.collect.ImmutableSet; |
| 74 | |
| 75 | /** |
| 76 | * @author Adrian Cole |
| 77 | */ |
| 78 | @Singleton |
| 79 | public class EC2ComputeService extends BaseComputeService { |
| 80 | private final EC2Client ec2Client; |
| 81 | private final Map<RegionAndName, KeyPair> credentialsMap; |
| 82 | private final Map<RegionAndName, String> securityGroupMap; |
| 83 | |
| 84 | @Inject |
| 85 | protected EC2ComputeService(ComputeServiceContext context, Map<String, Credentials> credentialStore, |
| 86 | @Memoized Supplier<Set<? extends Image>> images, @Memoized Supplier<Set<? extends Hardware>> sizes, |
| 87 | @Memoized Supplier<Set<? extends Location>> locations, ListNodesStrategy listNodesStrategy, |
| 88 | GetNodeMetadataStrategy getNodeMetadataStrategy, CreateNodesInGroupThenAddToSet runNodesAndAddToSetStrategy, |
| 89 | RebootNodeStrategy rebootNodeStrategy, DestroyNodeStrategy destroyNodeStrategy, |
| 90 | ResumeNodeStrategy startNodeStrategy, SuspendNodeStrategy stopNodeStrategy, |
| 91 | Provider<TemplateBuilder> templateBuilderProvider, Provider<TemplateOptions> templateOptionsProvider, |
| 92 | @Named("NODE_RUNNING") Predicate<NodeMetadata> nodeRunning, |
| 93 | @Named("NODE_TERMINATED") Predicate<NodeMetadata> nodeTerminated, |
| 94 | @Named("NODE_SUSPENDED") Predicate<NodeMetadata> nodeSuspended, |
| 95 | InitializeRunScriptOnNodeOrPlaceInBadMap.Factory initScriptRunnerFactory, |
| 96 | RunScriptOnNode.Factory runScriptOnNodeFactory, InitAdminAccess initAdminAccess, |
| 97 | PersistNodeCredentials persistNodeCredentials, Timeouts timeouts, |
| 98 | @Named(Constants.PROPERTY_USER_THREADS) ExecutorService executor, EC2Client ec2Client, |
| 99 | Map<RegionAndName, KeyPair> credentialsMap, @Named("SECURITY") Map<RegionAndName, String> securityGroupMap) { |
| 100 | super(context, credentialStore, images, sizes, locations, listNodesStrategy, getNodeMetadataStrategy, |
| 101 | runNodesAndAddToSetStrategy, rebootNodeStrategy, destroyNodeStrategy, startNodeStrategy, stopNodeStrategy, |
| 102 | templateBuilderProvider, templateOptionsProvider, nodeRunning, nodeTerminated, nodeSuspended, |
| 103 | initScriptRunnerFactory, initAdminAccess, runScriptOnNodeFactory, persistNodeCredentials, timeouts, |
| 104 | executor); |
| 105 | this.ec2Client = ec2Client; |
| 106 | this.credentialsMap = credentialsMap; |
| 107 | this.securityGroupMap = securityGroupMap; |
| 108 | } |
| 109 | |
| 110 | @VisibleForTesting |
| 111 | void deleteSecurityGroup(String region, String group) { |
| 112 | checkNotEmpty(group, "group"); |
| 113 | String groupName = String.format("jclouds#%s#%s", group, region); |
| 114 | if (ec2Client.getSecurityGroupServices().describeSecurityGroupsInRegion(region, groupName).size() > 0) { |
| 115 | logger.debug(">> deleting securityGroup(%s)", groupName); |
| 116 | try { |
| 117 | ec2Client.getSecurityGroupServices().deleteSecurityGroupInRegion(region, groupName); |
| 118 | // TODO: test this clear happens |
| 119 | securityGroupMap.remove(new RegionNameAndIngressRules(region, groupName, null, false)); |
| 120 | logger.debug("<< deleted securityGroup(%s)", groupName); |
| 121 | } catch (IllegalStateException e) { |
| 122 | logger.debug("<< inUse securityGroup(%s)", groupName); |
| 123 | } |
| 124 | } |
| 125 | } |
| 126 | |
| 127 | @VisibleForTesting |
| 128 | void deleteKeyPair(String region, String group) { |
| 129 | for (KeyPair keyPair : ec2Client.getKeyPairServices().describeKeyPairsInRegion(region)) { |
| 130 | if ( |
| 131 | // when the keypair is unique per group |
| 132 | keyPair.getKeyName().equals("jclouds#" + group) |
| 133 | || keyPair.getKeyName().matches(String.format("jclouds#%s#%s", group, "[0-9a-f]+")) |
| 134 | // old keypair pattern too verbose as it has an unnecessary |
| 135 | // region qualifier |
| 136 | || keyPair.getKeyName().matches(String.format("jclouds#%s#%s#%s", group, region, "[0-9a-f]+"))) { |
| 137 | Set<String> instancesUsingKeyPair = extractIdsFromInstances(filter(concat(ec2Client.getInstanceServices() |
| 138 | .describeInstancesInRegion(region)), usingKeyPairAndNotDead(keyPair))); |
| 139 | if (instancesUsingKeyPair.size() > 0) { |
| 140 | logger.debug("<< inUse keyPair(%s), by (%s)", keyPair.getKeyName(), instancesUsingKeyPair); |
| 141 | } else { |
| 142 | logger.debug(">> deleting keyPair(%s)", keyPair.getKeyName()); |
| 143 | ec2Client.getKeyPairServices().deleteKeyPairInRegion(region, keyPair.getKeyName()); |
| 144 | // TODO: test this clear happens |
| 145 | credentialsMap.remove(new RegionAndName(region, keyPair.getKeyName())); |
| 146 | logger.debug("<< deleted keyPair(%s)", keyPair.getKeyName()); |
| 147 | } |
| 148 | } |
| 149 | } |
| 150 | } |
| 151 | |
| 152 | protected ImmutableSet<String> extractIdsFromInstances(Iterable<? extends RunningInstance> deadOnes) { |
| 153 | return ImmutableSet.copyOf(transform(deadOnes, new Function<RunningInstance, String>() { |
| 154 | |
| 155 | @Override |
| 156 | public String apply(RunningInstance input) { |
| 157 | return input.getId(); |
| 158 | } |
| 159 | |
| 160 | })); |
| 161 | } |
| 162 | |
| 163 | protected Predicate<RunningInstance> usingKeyPairAndNotDead(final KeyPair keyPair) { |
| 164 | return new Predicate<RunningInstance>() { |
| 165 | |
| 166 | @Override |
| 167 | public boolean apply(RunningInstance input) { |
| 168 | switch (input.getInstanceState()) { |
| 169 | case TERMINATED: |
| 170 | case SHUTTING_DOWN: |
| 171 | return false; |
| 172 | } |
| 173 | return keyPair.getKeyName().equals(input.getKeyName()); |
| 174 | } |
| 175 | |
| 176 | }; |
| 177 | } |
| 178 | |
| 179 | /** |
| 180 | * like {@link BaseComputeService#destroyNodesMatching} except that this will |
| 181 | * clean implicit keypairs and security groups. |
| 182 | */ |
| 183 | @Override |
| 184 | public Set<? extends NodeMetadata> destroyNodesMatching(Predicate<NodeMetadata> filter) { |
| 185 | Set<? extends NodeMetadata> deadOnes = super.destroyNodesMatching(filter); |
| 186 | Builder<String, String> regionGroups = ImmutableMultimap.<String, String> builder(); |
| 187 | for (NodeMetadata nodeMetadata : deadOnes) { |
| 188 | if (nodeMetadata.getGroup() != null) |
| 189 | regionGroups.put(AWSUtils.parseHandle(nodeMetadata.getId())[0], nodeMetadata.getGroup()); |
| 190 | } |
| 191 | for (Entry<String, String> regionGroup : regionGroups.build().entries()) { |
| 192 | cleanUpIncidentalResources(regionGroup); |
| 193 | } |
| 194 | return deadOnes; |
| 195 | } |
| 196 | |
| 197 | protected void cleanUpIncidentalResources(Entry<String, String> regionGroup) { |
| 198 | deleteKeyPair(regionGroup.getKey(), regionGroup.getValue()); |
| 199 | deleteSecurityGroup(regionGroup.getKey(), regionGroup.getValue()); |
| 200 | } |
| 201 | |
| 202 | /** |
| 203 | * returns template options, except of type {@link EC2TemplateOptions}. |
| 204 | */ |
| 205 | @Override |
| 206 | public EC2TemplateOptions templateOptions() { |
| 207 | return EC2TemplateOptions.class.cast(super.templateOptions()); |
| 208 | } |
| 209 | |
| 210 | } |