Package jenkins.plugins.jclouds.compute

Class JCloudsSlaveTemplate

java.lang.Object

hudson.model.AbstractDescribableImpl<JCloudsSlaveTemplate>

jenkins.plugins.jclouds.compute.JCloudsSlaveTemplate

All Implemented Interfaces:

com.google.common.base.Supplier<JCloudsNodeMetadata>, Describable<JCloudsSlaveTemplate>, Supplier<JCloudsNodeMetadata>

public class JCloudsSlaveTemplate
extends AbstractDescribableImpl<JCloudsSlaveTemplate>
implements com.google.common.base.Supplier<JCloudsNodeMetadata>

Author:

Vijay Kiran

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static final class	JCloudsSlaveTemplate.DescriptorImpl

Field Summary

Fields

Modifier and Type	Field	Description
final boolean	allowSudo
final boolean	assignPublicIp
final double	cores
final String	description
final String	hardwareId
final String	imageId
final String	imageNameRegex
final boolean	installPrivateKey
final boolean	isPreemptible
final String	keyPairName
final String	labelString
final String	locationId
final Node.Mode	mode
final String	name
final String	networks
final int	numExecutors
final String	osFamily
final String	osVersion
final Integer	overrideRetentionTime
final boolean	preExistingJenkinsUser
final int	ram
final String	securityGroups
final int	spoolDelayMs
final boolean	stopOnTerminate
final boolean	useConfigDrive
final boolean	waitPhoneHome
final int	waitPhoneHomeTimeout

Constructor Summary

Constructors

Constructor

Description

JCloudsSlaveTemplate(String name, String imageId, String imageNameRegex, String hardwareId, double cores, int ram, String osFamily, String osVersion, String locationId, String labelString, String description, String initScriptId, int numExecutors, boolean stopOnTerminate, String jvmOptions, boolean preExistingJenkinsUser, String fsRoot, boolean allowSudo, boolean installPrivateKey, Integer overrideRetentionTime, boolean hasOverrideRetentionTime, int spoolDelayMs, boolean assignFloatingIp, boolean waitPhoneHome, int waitPhoneHomeTimeout, String keyPairName, boolean assignPublicIp, String networks, String securityGroups, String credentialsId, String adminCredentialsId, String mode, boolean useConfigDrive, boolean isPreemptible, List<UserData> userDataEntries, String preferredAddress, boolean useJnlp, boolean jnlpProvision)

Method Summary

Modifier and Type	Method	Description
HttpResponse	doConfigSubmit(StaplerRequest2 req, JCloudsCloud c)
HttpResponse	doDoDelete(JCloudsCloud c)	Deletes the template.
JCloudsNodeMetadata	get()	This is where the actual provisioning (accessing the cloud provider) happens.
String	getAdminCredentialsId()
String	getAdminUser()
JCloudsCloud	getCloud()
String	getCredentialsId()
String	getFsRoot()
String	getInitScriptId()
String	getJenkinsPrivateKey()
String	getJenkinsPublicKey()
String	getJenkinsUser()
boolean	getJnlpProvision()
String	getJvmOptions()
Set<LabelAtom>	getLabelSet()
int	getNumExecutors()
String	getPreferredAddress()
String	getShortDescription()
String	getUrl()
boolean	getUseJnlp()
List<UserData>	getUserDataEntries()
List<String>	getUserDataIds()
boolean	hasOverrideRetentionTime()
JCloudsSlave	provisionSlave(TaskListener listener, org.jenkinsci.plugins.cloudstats.ProvisioningActivity.Id provisioningId)
protected Object	readResolve()	Initializes data structure that we don't persist.
void	setCloud(JCloudsCloud c)

Methods inherited from class hudson.model.AbstractDescribableImpl

getDescriptor

Methods inherited from class java.lang.Object

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

Field Details

name

public final String name

imageId

public final String imageId

imageNameRegex

public final String imageNameRegex

hardwareId

public final String hardwareId

cores

public final double cores

ram

public final int ram

osFamily

public final String osFamily

labelString

public final String labelString

description

public final String description

osVersion

public final String osVersion

locationId

public final String locationId

numExecutors

public final int numExecutors

stopOnTerminate

public final boolean stopOnTerminate

preExistingJenkinsUser

public final boolean preExistingJenkinsUser

allowSudo

public final boolean allowSudo

installPrivateKey

public final boolean installPrivateKey

overrideRetentionTime

public final Integer overrideRetentionTime

spoolDelayMs

public final int spoolDelayMs

waitPhoneHome

public final boolean waitPhoneHome

waitPhoneHomeTimeout

public final int waitPhoneHomeTimeout

keyPairName

public final String keyPairName

assignPublicIp

public final boolean assignPublicIp

networks

public final String networks

securityGroups

public final String securityGroups

mode

public final Node.Mode mode

useConfigDrive

public final boolean useConfigDrive

isPreemptible

public final boolean isPreemptible

Constructor Details

JCloudsSlaveTemplate

@DataBoundConstructor
public JCloudsSlaveTemplate(String name,
 String imageId,
 String imageNameRegex,
 String hardwareId,
 double cores,
 int ram,
 String osFamily,
 String osVersion,
 String locationId,
 String labelString,
 String description,
 String initScriptId,
 int numExecutors,
 boolean stopOnTerminate,
 String jvmOptions,
 boolean preExistingJenkinsUser,
 String fsRoot,
 boolean allowSudo,
 boolean installPrivateKey,
 Integer overrideRetentionTime,
 boolean hasOverrideRetentionTime,
 int spoolDelayMs,
 boolean assignFloatingIp,
 boolean waitPhoneHome,
 int waitPhoneHomeTimeout,
 String keyPairName,
 boolean assignPublicIp,
 String networks,
 String securityGroups,
 String credentialsId,
 String adminCredentialsId,
 String mode,
 boolean useConfigDrive,
 boolean isPreemptible,
 List<UserData> userDataEntries,
 String preferredAddress,
 boolean useJnlp,
 boolean jnlpProvision)

Method Details

getCredentialsId

public String getCredentialsId()

getAdminCredentialsId

public String getAdminCredentialsId()

getUserDataEntries

public List<UserData> getUserDataEntries()

getInitScriptId

public String getInitScriptId()

getPreferredAddress

public String getPreferredAddress()

getShortDescription

public String getShortDescription()

getUseJnlp

public boolean getUseJnlp()

getJnlpProvision

public boolean getJnlpProvision()

getUrl

@NonNull
public String getUrl()

getCloud

public JCloudsCloud getCloud()

setCloud

public void setCloud(JCloudsCloud c)

readResolve

protected Object readResolve()

Initializes data structure that we don't persist.

Returns:

The initialized object.

getJenkinsUser

public String getJenkinsUser()

getJenkinsPrivateKey

public String getJenkinsPrivateKey()

getJenkinsPublicKey

public String getJenkinsPublicKey()

getAdminUser

public String getAdminUser()

getJvmOptions

public String getJvmOptions()

getNumExecutors

public int getNumExecutors()

getFsRoot

public String getFsRoot()

getLabelSet

public Set<LabelAtom> getLabelSet()

provisionSlave

public JCloudsSlave provisionSlave(TaskListener listener,
 org.jenkinsci.plugins.cloudstats.ProvisioningActivity.Id provisioningId)
                            throws IOException

Throws:

IOException

getUserDataIds

public List<String> getUserDataIds()

get

public JCloudsNodeMetadata get()

This is where the actual provisioning (accessing the cloud provider) happens.

Specified by:

get in interface com.google.common.base.Supplier<JCloudsNodeMetadata>

Specified by:

get in interface Supplier<JCloudsNodeMetadata>

hasOverrideRetentionTime

public boolean hasOverrideRetentionTime()

doDoDelete

@POST
public HttpResponse doDoDelete(@AncestorInPath
 JCloudsCloud c)
                        throws IOException

Deletes the template.

Throws:

IOException

doConfigSubmit

@POST
public HttpResponse doConfigSubmit(StaplerRequest2 req,
 @AncestorInPath
 JCloudsCloud c)
                            throws IOException,
jakarta.servlet.ServletException,
Descriptor.FormException

Throws:

IOException

jakarta.servlet.ServletException

Descriptor.FormException