Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Add support for EC2 Placement Host Resource Group Arn parameter [JENKINS-66901] #784

Closed
Closed
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Jump to
Jump to file
Failed to load files.
Diff view
Diff view
2 changes: 2 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -347,6 +347,7 @@ def slaveTemplateUsEast1Parameters = [
connectionStrategy: ConnectionStrategy.valueOf('PRIVATE_IP'),
hostKeyVerificationStrategy: HostKeyVerificationStrategyEnum.valueOf('CHECK_NEW_HARD'),
tenancy: Tenancy.valueOf('Default'),
hostResourceGroupArn: null,
ebsEncryptRootVolume: EbsEncryptRootVolume.valueOf('ENCRYPTED'),
nodeProperties: null
]
Expand Down Expand Up @@ -443,6 +444,7 @@ SlaveTemplate slaveTemplateUsEast1 = new SlaveTemplate(
slaveTemplateUsEast1Parameters.nodeProperties,
slaveTemplateUsEast1Parameters.hostKeyVerificationStrategy,
slaveTemplateUsEast1Parameters.tenancy,
slaveTemplateUsEast1Parameters.hostResourceGroupArn,
slaveTemplateUsEast1Parameters.ebsEncryptRootVolume,
slaveTemplateUsEast1Parameters.metadataEndpointEnabled,
slaveTemplateUsEast1Parameters.metadataTokensRequired,
Expand Down
10 changes: 9 additions & 1 deletion src/main/java/hudson/plugins/ec2/EC2AbstractSlave.java
Original file line number Diff line number Diff line change
Expand Up @@ -109,6 +109,7 @@ public abstract class EC2AbstractSlave extends Slave {
public AMITypeData amiType;
public int maxTotalUses;
public final Tenancy tenancy;
public final String hostResourceGroupArn;
private String instanceType;

private Boolean metadataEndpointEnabled;
Expand Down Expand Up @@ -156,7 +157,7 @@ public abstract class EC2AbstractSlave extends Slave {
public static final String TEST_ZONE = "testZone";

public EC2AbstractSlave(String name, String instanceId, String templateDescription, String remoteFS, int numExecutors, Mode mode, String labelString, ComputerLauncher launcher, RetentionStrategy<EC2Computer> retentionStrategy, String initScript, String tmpDir, List<? extends NodeProperty<?>> nodeProperties, String remoteAdmin, String javaPath, String jvmopts, boolean stopOnTerminate, String idleTerminationMinutes, List<EC2Tag> tags, String cloudName, int launchTimeout, AMITypeData amiType, ConnectionStrategy connectionStrategy, int maxTotalUses, Tenancy tenancy,
Boolean metadataEndpointEnabled, Boolean metadataTokensRequired, Integer metadataHopsLimit)
String hostResourceGroupArn, Boolean metadataEndpointEnabled, Boolean metadataTokensRequired, Integer metadataHopsLimit)
throws FormException, IOException {
super(name, remoteFS, launcher);
setNumExecutors(numExecutors);
Expand All @@ -182,12 +183,19 @@ public EC2AbstractSlave(String name, String instanceId, String templateDescripti
this.amiType = amiType;
this.maxTotalUses = maxTotalUses;
this.tenancy = tenancy != null ? tenancy : Tenancy.Default;
this.hostResourceGroupArn = hostResourceGroupArn;
this.metadataEndpointEnabled = metadataEndpointEnabled;
this.metadataTokensRequired = metadataTokensRequired;
this.metadataHopsLimit = metadataHopsLimit;
readResolve();
}

@Deprecated
public EC2AbstractSlave(String name, String instanceId, String templateDescription, String remoteFS, int numExecutors, Mode mode, String labelString, ComputerLauncher launcher, RetentionStrategy<EC2Computer> retentionStrategy, String initScript, String tmpDir, List<? extends NodeProperty<?>> nodeProperties, String remoteAdmin, String javaPath, String jvmopts, boolean stopOnTerminate, String idleTerminationMinutes, List<EC2Tag> tags, String cloudName, int launchTimeout, AMITypeData amiType, ConnectionStrategy connectionStrategy, int maxTotalUses, Tenancy tenancy, Boolean metadataEndpointEnabled, Boolean metadataTokensRequired, Integer metadataHopsLimit)
throws FormException, IOException {
this(name, instanceId, templateDescription, remoteFS, numExecutors, mode, labelString, launcher, retentionStrategy, initScript, tmpDir, nodeProperties, remoteAdmin, javaPath, jvmopts, stopOnTerminate, idleTerminationMinutes, tags, cloudName, launchTimeout, amiType, connectionStrategy, maxTotalUses, tenancy, null, metadataEndpointEnabled, metadataTokensRequired, metadataHopsLimit);
}

@Deprecated
public EC2AbstractSlave(String name, String instanceId, String templateDescription, String remoteFS, int numExecutors, Mode mode, String labelString, ComputerLauncher launcher, RetentionStrategy<EC2Computer> retentionStrategy, String initScript, String tmpDir, List<? extends NodeProperty<?>> nodeProperties, String remoteAdmin, String jvmopts, boolean stopOnTerminate, String idleTerminationMinutes, List<EC2Tag> tags, String cloudName, int launchTimeout, AMITypeData amiType, ConnectionStrategy connectionStrategy, int maxTotalUses, Tenancy tenancy)
throws FormException, IOException {
Expand Down
11 changes: 9 additions & 2 deletions src/main/java/hudson/plugins/ec2/EC2OndemandSlave.java
Original file line number Diff line number Diff line change
Expand Up @@ -65,13 +65,20 @@ public EC2OndemandSlave(String name, String instanceId, String templateDescripti
this(name, instanceId, templateDescription, remoteFS, numExecutors, labelString, mode, initScript, tmpDir, nodeProperties, remoteAdmin, DEFAULT_JAVA_PATH, jvmopts, stopOnTerminate, idleTerminationMinutes, publicDNS, privateDNS, tags, cloudName, launchTimeout, amiType, connectionStrategy, maxTotalUses, tenancy, DEFAULT_METADATA_ENDPOINT_ENABLED, DEFAULT_METADATA_TOKENS_REQUIRED, DEFAULT_METADATA_HOPS_LIMIT);
}

@DataBoundConstructor
@Deprecated
public EC2OndemandSlave(String name, String instanceId, String templateDescription, String remoteFS, int numExecutors, String labelString, Mode mode, String initScript, String tmpDir, List<? extends NodeProperty<?>> nodeProperties, String remoteAdmin, String javaPath, String jvmopts, boolean stopOnTerminate, String idleTerminationMinutes, String publicDNS, String privateDNS, List<EC2Tag> tags, String cloudName, int launchTimeout, AMITypeData amiType, ConnectionStrategy connectionStrategy, int maxTotalUses, Tenancy tenancy,
Boolean metadataEndpointEnabled, Boolean metadataTokensRequired, Integer metadataHopsLimit)
throws FormException, IOException {
this(name, instanceId, templateDescription, remoteFS, numExecutors, labelString, mode, initScript, tmpDir, nodeProperties, remoteAdmin, javaPath, jvmopts, stopOnTerminate, idleTerminationMinutes, publicDNS, privateDNS, tags, cloudName, launchTimeout, amiType, connectionStrategy, maxTotalUses, tenancy, null, metadataEndpointEnabled, metadataTokensRequired, metadataHopsLimit);
}

@DataBoundConstructor
public EC2OndemandSlave(String name, String instanceId, String templateDescription, String remoteFS, int numExecutors, String labelString, Mode mode, String initScript, String tmpDir, List<? extends NodeProperty<?>> nodeProperties, String remoteAdmin, String javaPath, String jvmopts, boolean stopOnTerminate, String idleTerminationMinutes, String publicDNS, String privateDNS, List<EC2Tag> tags, String cloudName, int launchTimeout, AMITypeData amiType, ConnectionStrategy connectionStrategy, int maxTotalUses, Tenancy tenancy,
String hostResourceGroupArn, Boolean metadataEndpointEnabled, Boolean metadataTokensRequired, Integer metadataHopsLimit)
throws FormException, IOException {

super(name, instanceId, templateDescription, remoteFS, numExecutors, mode, labelString, (amiType.isWindows() ? new EC2WindowsLauncher() : (amiType.isMac() ? new EC2MacLauncher():
new EC2UnixLauncher())), new EC2RetentionStrategy(idleTerminationMinutes), initScript, tmpDir, nodeProperties, remoteAdmin, javaPath, jvmopts, stopOnTerminate, idleTerminationMinutes, tags, cloudName, launchTimeout, amiType, connectionStrategy, maxTotalUses, tenancy, metadataEndpointEnabled, metadataTokensRequired, metadataHopsLimit);
new EC2UnixLauncher())), new EC2RetentionStrategy(idleTerminationMinutes), initScript, tmpDir, nodeProperties, remoteAdmin, javaPath, jvmopts, stopOnTerminate, idleTerminationMinutes, tags, cloudName, launchTimeout, amiType, connectionStrategy, maxTotalUses, tenancy, hostResourceGroupArn, metadataEndpointEnabled, metadataTokensRequired, metadataHopsLimit);

this.publicDNS = publicDNS;
this.privateDNS = privateDNS;
Expand Down
41 changes: 37 additions & 4 deletions src/main/java/hudson/plugins/ec2/SlaveTemplate.java
Original file line number Diff line number Diff line change
Expand Up @@ -232,6 +232,8 @@ public class SlaveTemplate implements Describable<SlaveTemplate> {

public Tenancy tenancy;

public String hostResourceGroupArn;

public EbsEncryptRootVolume ebsEncryptRootVolume;

private Boolean metadataEndpointEnabled;
Expand Down Expand Up @@ -292,8 +294,9 @@ public SlaveTemplate(String ami, String zone, SpotConfiguration spotConfig, Stri
boolean useEphemeralDevices, String launchTimeoutStr, boolean associatePublicIp,
String customDeviceMapping, boolean connectBySSHProcess, boolean monitoring,
boolean t2Unlimited, ConnectionStrategy connectionStrategy, int maxTotalUses,
List<? extends NodeProperty<?>> nodeProperties, HostKeyVerificationStrategyEnum hostKeyVerificationStrategy, Tenancy tenancy, EbsEncryptRootVolume ebsEncryptRootVolume,
Boolean metadataEndpointEnabled, Boolean metadataTokensRequired, Integer metadataHopsLimit) {
List<? extends NodeProperty<?>> nodeProperties, HostKeyVerificationStrategyEnum hostKeyVerificationStrategy, Tenancy tenancy,
String hostResourceGroupArn, EbsEncryptRootVolume ebsEncryptRootVolume, Boolean metadataEndpointEnabled,
Boolean metadataTokensRequired, Integer metadataHopsLimit) {

if(StringUtils.isNotBlank(remoteAdmin) || StringUtils.isNotBlank(jvmopts) || StringUtils.isNotBlank(tmpDir)){
LOGGER.log(Level.FINE, "As remoteAdmin, jvmopts or tmpDir is not blank, we must ensure the user has ADMINISTER rights.");
Expand Down Expand Up @@ -366,13 +369,37 @@ public SlaveTemplate(String ami, String zone, SpotConfiguration spotConfig, Stri

this.hostKeyVerificationStrategy = hostKeyVerificationStrategy != null ? hostKeyVerificationStrategy : HostKeyVerificationStrategyEnum.CHECK_NEW_SOFT;
this.tenancy = tenancy != null ? tenancy : Tenancy.Default;
this.hostResourceGroupArn = hostResourceGroupArn;
this.ebsEncryptRootVolume = ebsEncryptRootVolume != null ? ebsEncryptRootVolume : EbsEncryptRootVolume.DEFAULT;
this.metadataEndpointEnabled = metadataEndpointEnabled != null ? metadataEndpointEnabled : DEFAULT_METADATA_ENDPOINT_ENABLED;
this.metadataTokensRequired = metadataTokensRequired != null ? metadataTokensRequired : DEFAULT_METADATA_TOKENS_REQUIRED;
this.metadataHopsLimit = metadataHopsLimit != null ? metadataHopsLimit : DEFAULT_METADATA_HOPS_LIMIT;
readResolve(); // initialize
}

@Deprecated
public SlaveTemplate(String ami, String zone, SpotConfiguration spotConfig, String securityGroups, String remoteFS,
InstanceType type, boolean ebsOptimized, String labelString, Node.Mode mode, String description, String initScript,
String tmpDir, String userData, String numExecutors, String remoteAdmin, AMITypeData amiType, String javaPath, String jvmopts,
boolean stopOnTerminate, String subnetId, List<EC2Tag> tags, String idleTerminationMinutes, int minimumNumberOfInstances,
int minimumNumberOfSpareInstances, String instanceCapStr, String iamInstanceProfile, boolean deleteRootOnTermination,
boolean useEphemeralDevices, String launchTimeoutStr, boolean associatePublicIp,
String customDeviceMapping, boolean connectBySSHProcess, boolean monitoring,
boolean t2Unlimited, ConnectionStrategy connectionStrategy, int maxTotalUses,
List<? extends NodeProperty<?>> nodeProperties, HostKeyVerificationStrategyEnum hostKeyVerificationStrategy, Tenancy tenancy, EbsEncryptRootVolume ebsEncryptRootVolume,
Boolean metadataEndpointEnabled, Boolean metadataTokensRequired, Integer metadataHopsLimit) {
this(ami, zone, spotConfig, securityGroups, remoteFS,
type, ebsOptimized, labelString, mode, description, initScript,
tmpDir, userData, numExecutors, remoteAdmin, amiType, DEFAULT_JAVA_PATH, jvmopts,
stopOnTerminate, subnetId, tags, idleTerminationMinutes, minimumNumberOfInstances,
minimumNumberOfSpareInstances, instanceCapStr, iamInstanceProfile, deleteRootOnTermination,
useEphemeralDevices, launchTimeoutStr, associatePublicIp,
customDeviceMapping, connectBySSHProcess, monitoring,
t2Unlimited, connectionStrategy, maxTotalUses,
nodeProperties, hostKeyVerificationStrategy, tenancy, null, ebsEncryptRootVolume,
metadataEndpointEnabled, metadataTokensRequired, metadataHopsLimit);
}

@Deprecated
public SlaveTemplate(String ami, String zone, SpotConfiguration spotConfig, String securityGroups, String remoteFS,
InstanceType type, boolean ebsOptimized, String labelString, Node.Mode mode, String description, String initScript,
Expand Down Expand Up @@ -885,6 +912,10 @@ public Tenancy getTenancyAttribute() {
return tenancy;
}

public String getHostResourceGroupArn() {
return hostResourceGroupArn;
}

public DescribableList<NodeProperty<?>, NodePropertyDescriptor> getNodeProperties() {
return Objects.requireNonNull(nodeProperties);
}
Expand Down Expand Up @@ -1001,6 +1032,7 @@ HashMap<RunInstancesRequest, List<Filter>> makeRunInstancesRequestAndFilters(Ima
if(getTenancyAttribute().equals(Tenancy.Host)){
Placement placement = new Placement();
placement.setTenancy("host");
placement.setHostResourceGroupArn(getHostResourceGroupArn());
riRequest.setPlacement(placement);
diFilters.add(new Filter("tenancy").withValues(placement.getTenancy()));
}else if(getTenancyAttribute().equals(Tenancy.Default)){
Expand Down Expand Up @@ -1575,6 +1607,7 @@ protected EC2OndemandSlave newOndemandSlave(Instance inst) throws FormException,
.withConnectionStrategy(connectionStrategy)
.withMaxTotalUses(maxTotalUses)
.withTenancyAttribute(tenancy)
.withHostResourceGroupArn(hostResourceGroupArn)
.withMetadataEndpointEnabled(metadataEndpointEnabled)
.withMetadataTokensRequired(metadataTokensRequired)
.withMetadataHopsLimit(metadataHopsLimit)
Expand Down Expand Up @@ -1753,7 +1786,7 @@ protected Object readResolve() {
if (nodeProperties == null) {
nodeProperties = new DescribableList<>(Saveable.NOOP);
}

if (tenancy == null) {
tenancy = Tenancy.Default;
}
Expand All @@ -1762,7 +1795,7 @@ protected Object readResolve() {
if (useDedicatedTenancy) {
tenancy = Tenancy.Dedicated;
}

if (ebsEncryptRootVolume == null) {
ebsEncryptRootVolume = EbsEncryptRootVolume.DEFAULT;
}
Expand Down
12 changes: 12 additions & 0 deletions src/main/java/hudson/plugins/ec2/util/EC2AgentConfig.java
Original file line number Diff line number Diff line change
Expand Up @@ -60,6 +60,7 @@ public static class OnDemand extends EC2AgentConfig {
final String publicDNS;
final String privateDNS;
final Tenancy tenancy;
final String hostResourceGroupArn;
@Deprecated
final boolean useDedicatedTenancy;
final Boolean metadataEndpointEnabled;
Expand All @@ -73,6 +74,7 @@ private OnDemand(OnDemandBuilder builder) {
this.publicDNS = builder.getPublicDNS();
this.privateDNS = builder.getPrivateDNS();
this.tenancy = builder.getTenancyAttribute();
this.hostResourceGroupArn = builder.getHostResourceGroupArn();
this.useDedicatedTenancy = builder.isUseDedicatedTenancy();
this.metadataHopsLimit = builder.metadataHopsLimit;
this.metadataEndpointEnabled = builder.metadataEndpointEnabled;
Expand Down Expand Up @@ -223,6 +225,7 @@ public static class OnDemandBuilder extends Builder<OnDemandBuilder, OnDemand> {
private String publicDNS;
private String privateDNS;
private Tenancy tenancy;
private String hostResourceGroupArn;
@Deprecated
private boolean useDedicatedTenancy;
private Boolean metadataEndpointEnabled;
Expand Down Expand Up @@ -283,6 +286,15 @@ public OnDemandBuilder withTenancyAttribute( Tenancy tenancy){

public Tenancy getTenancyAttribute(){ return tenancy;}

public OnDemandBuilder withHostResourceGroupArn(String hostResourceGroupArn) {
this.hostResourceGroupArn = hostResourceGroupArn;
return this;
}

public String getHostResourceGroupArn() {
return this.hostResourceGroupArn;
}

public OnDemandBuilder withMetadataEndpointEnabled(Boolean metadataEndpointEnabled) {
this.metadataEndpointEnabled = metadataEndpointEnabled;
return this;
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -12,7 +12,7 @@ public class EC2AgentFactoryImpl implements EC2AgentFactory {
@Override
public EC2OndemandSlave createOnDemandAgent(EC2AgentConfig.OnDemand config)
throws Descriptor.FormException, IOException {
return new EC2OndemandSlave(config.name, config.instanceId, config.description, config.remoteFS, config.numExecutors, config.labelString, config.mode, config.initScript, config.tmpDir, config.nodeProperties, config.remoteAdmin, config.javaPath, config.jvmopts, config.stopOnTerminate, config.idleTerminationMinutes, config.publicDNS, config.privateDNS, config.tags, config.cloudName, config.launchTimeout, config.amiType, config.connectionStrategy, config.maxTotalUses, config.tenancy, config.metadataEndpointEnabled, config.metadataTokensRequired, config.metadataHopsLimit);
return new EC2OndemandSlave(config.name, config.instanceId, config.description, config.remoteFS, config.numExecutors, config.labelString, config.mode, config.initScript, config.tmpDir, config.nodeProperties, config.remoteAdmin, config.javaPath, config.jvmopts, config.stopOnTerminate, config.idleTerminationMinutes, config.publicDNS, config.privateDNS, config.tags, config.cloudName, config.launchTimeout, config.amiType, config.connectionStrategy, config.maxTotalUses, config.tenancy, config.hostResourceGroupArn, config.metadataEndpointEnabled, config.metadataTokensRequired, config.metadataHopsLimit);
}

@Override
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -54,11 +54,11 @@ THE SOFTWARE.
<f:entry title="${%Instance ID}" field="instanceId">
<f:readOnlyTextbox />
</f:entry>

<f:entry title="${%EC2 Type}" field="ec2Type">
<f:readOnlyTextbox />
</f:entry>

<f:entry title="${%Uptime}">
<f:readOnlyTextbox value="${it.uptimeString}"/>
</f:entry>
Expand All @@ -78,7 +78,7 @@ THE SOFTWARE.
<f:entry title="${%# of executors}" field="numExecutors">
<f:textbox />
</f:entry>

<f:entry title="${%Labels}" field="labelString">
<f:textbox />
</f:entry>
Expand All @@ -96,7 +96,7 @@ THE SOFTWARE.
<f:entry title="${%Remote user}" field="remoteAdmin">
<f:textbox />
</f:entry>

<f:entry title="${%Stop/Disconnect on Idle Timeout}" field="stopOnTerminate">
<f:checkbox />
</f:entry>
Expand All @@ -115,11 +115,15 @@ THE SOFTWARE.
<f:entry title="${%Use private DNS}" field="usePrivateDnsName">
<f:checkbox />
</f:entry>

<f:entry title="${%Tenancy}" field="tenancy">
<f:enum>${it.name()}</f:enum>
</f:entry>

<f:entry title="${%Host Resource Group ARN}" field="hostResourceGroupArn">
<f:textbox />
</f:entry>

<f:dropdownList name="amiType" title="${%AMI Type}">
<f:dropdownListBlock value="0" title="${instance.amiType.descriptor.displayName}" staplerClass="${instance.amiType.descriptor.clazz.name}" selected="true">
<j:set var="instance" value="${instance.amiType}" />
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -209,6 +209,10 @@ THE SOFTWARE.
<f:enum>${it.name()}</f:enum>
</f:entry>

<f:entry title="${%Host Resource Group ARN}" field="hostResourceGroupArn">
<f:textbox />
</f:entry>

<f:entry title="${%Connection Strategy}" field="connectionStrategy">
<f:select default="${descriptor.getDefaultConnectionStrategy()}"/>
</f:entry>
Expand Down