jenkins.plugins.openstack.compute

Class JCloudsCloud

java.lang.Object

hudson.model.AbstractModelObject

hudson.slaves.Cloud

jenkins.plugins.openstack.compute.JCloudsCloud

All Implemented Interfaces:

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

public class JCloudsCloud
extends hudson.slaves.Cloud

The JClouds version of the Jenkins Cloud.

Author:

Vijay Kiran

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	JCloudsCloud.DescriptorImpl
static class	JCloudsCloud.SlaveType

Nested classes/interfaces inherited from interface hudson.ExtensionPoint

hudson.ExtensionPoint.LegacyInstancesAreScopedToHudson

Field Summary

Fields

Modifier and Type	Field and Description
hudson.util.Secret	credential
String	endPointUrl
String	identity
int	instanceCap
String	profile
int	startTimeout
String	zone

Fields inherited from class hudson.slaves.Cloud

ALL, name, PROVISION

Constructor Summary

Constructors

Constructor and Description
JCloudsCloud(String profile, String identity, String credential, String endPointUrl, int instanceCap, int retentionTime, int startTimeout, String zone, List<JCloudsSlaveTemplate> templates, boolean floatingIps)

Method Summary

Methods

Modifier and Type	Method and Description
boolean	canProvision(hudson.model.Label label)
void	doProvision(org.kohsuke.stapler.StaplerRequest req, org.kohsuke.stapler.StaplerResponse rsp, String name) Provisions a new node manually (by clicking a button in the computer list)
static JCloudsCloud	getByName(String name)
static List<String>	getCloudNames()
Openstack	getOpenstack() Get connected OpenStack client wrapper.
static Openstack	getOpenstack(String endPointUrl, String identity, String credential, String region)
int	getRetentionTime() Get the retention time in minutes or default value from CloudInstanceDefaults if not set.
int	getRunningNodesCount() Determine how many nodes are currently running for this cloud.
JCloudsSlaveTemplate	getTemplate(String name)
List<JCloudsSlaveTemplate>	getTemplates()
boolean	isFloatingIps()
Collection<hudson.slaves.NodeProvisioner.PlannedNode>	provision(hudson.model.Label label, int excessWorkload)

Methods inherited from class hudson.slaves.Cloud

all, checkPermission, getACL, getDescriptor, getDisplayName, getSearchUrl, hasPermission

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

Field Detail

identity

public final String identity

credential

public final hudson.util.Secret credential

endPointUrl

public final String endPointUrl

profile

public final String profile

instanceCap

public final int instanceCap

startTimeout

public final int startTimeout

zone

public final String zone

Constructor Detail

JCloudsCloud

@DataBoundConstructor
@Restricted(value=org.kohsuke.accmod.restrictions.DoNotUse.class)
public JCloudsCloud(String profile,
                                                                                          String identity,
                                                                                          String credential,
                                                                                          String endPointUrl,
                                                                                          int instanceCap,
                                                                                          int retentionTime,
                                                                                          int startTimeout,
                                                                                          String zone,
                                                                                          List<JCloudsSlaveTemplate> templates,
                                                                                          boolean floatingIps)

Method Detail

getCloudNames

public static List<String> getCloudNames()

getByName

@Nonnull
public static JCloudsCloud getByName(@Nonnull
                             String name)

getRetentionTime

public int getRetentionTime()

Get the retention time in minutes or default value from CloudInstanceDefaults if not set.

See Also:

CloudInstanceDefaults.DEFAULT_INSTANCE_RETENTION_TIME_IN_MINUTES

isFloatingIps

public boolean isFloatingIps()

getOpenstack

@Restricted(value=org.kohsuke.accmod.restrictions.NoExternalUse.class)
@Nonnull
public static Openstack getOpenstack(String endPointUrl,
                                                                                           String identity,
                                                                                           String credential,
                                                                                           @CheckForNull
                                                                                           String region)
                              throws hudson.util.FormValidation

Throws:

hudson.util.FormValidation

getTemplates

@Nonnull
public List<JCloudsSlaveTemplate> getTemplates()

provision

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

Specified by:

provision in class hudson.slaves.Cloud

canProvision

public boolean canProvision(hudson.model.Label label)

Specified by:

canProvision in class hudson.slaves.Cloud

getTemplate

@CheckForNull
public JCloudsSlaveTemplate getTemplate(String name)

doProvision

public void doProvision(org.kohsuke.stapler.StaplerRequest req,
               org.kohsuke.stapler.StaplerResponse rsp,
               @QueryParameter
               String name)
                 throws javax.servlet.ServletException,
                        IOException,
                        hudson.model.Descriptor.FormException

Provisions a new node manually (by clicking a button in the computer list)

Parameters:

req - StaplerRequest

rsp - StaplerResponse

name - Name of the template to provision

Throws:

javax.servlet.ServletException

IOException

Descriptor.FormException

getRunningNodesCount

public int getRunningNodesCount()

Determine how many nodes are currently running for this cloud.

getOpenstack

@Restricted(value=org.kohsuke.accmod.restrictions.DoNotUse.class)
@Nonnull
public Openstack getOpenstack()

Get connected OpenStack client wrapper.