Package io.jenkins.plugins.swarmcloud.pipeline

Class SwarmAgentStep

java.lang.Object
hudson.model.AbstractDescribableImpl<org.jenkinsci.plugins.workflow.steps.Step>
org.jenkinsci.plugins.workflow.steps.Step
io.jenkins.plugins.swarmcloud.pipeline.SwarmAgentStep
All Implemented Interfaces:
ExtensionPoint, Describable<org.jenkinsci.plugins.workflow.steps.Step>, Serializable
public class SwarmAgentStep extends org.jenkinsci.plugins.workflow.steps.Step implements Serializable
Pipeline step to provision a Docker Swarm agent and execute a closure.

Usage in Jenkinsfile:

 swarmAgent(cloud: 'my-cloud', template: 'maven') {
     sh 'mvn clean package'
 }

Or with inline template configuration:

 swarmAgent(cloud: 'my-cloud', image: 'jenkins/inbound-agent:alpine', label: 'build') {
     sh 'npm install && npm test'
 }

The agent is automatically terminated when the block completes.

See Also:

  • Constructor Details

    • SwarmAgentStep

      @DataBoundConstructor public SwarmAgentStep(@NonNull String cloud)

  • Method Details

    • getCloud

      @NonNull public String getCloud()

    • getTemplate

      @Nullable public String getTemplate()

    • setTemplate

      @DataBoundSetter public void setTemplate(String template)

    • getImage

      @Nullable public String getImage()

    • setImage

      @DataBoundSetter public void setImage(String image)

    • getLabel

      @Nullable public String getLabel()

    • setLabel

      @DataBoundSetter public void setLabel(String label)

    • getNumExecutors

      public int getNumExecutors()

    • setNumExecutors

      @DataBoundSetter public void setNumExecutors(int numExecutors)

    • getCpuLimit

      @Nullable public String getCpuLimit()

    • setCpuLimit

      @DataBoundSetter public void setCpuLimit(String cpuLimit)

    • getMemoryLimit

      @Nullable public String getMemoryLimit()

    • setMemoryLimit

      @DataBoundSetter public void setMemoryLimit(String memoryLimit)

    • getIdleTimeout

      public int getIdleTimeout()

    • setIdleTimeout

      @DataBoundSetter public void setIdleTimeout(int idleTimeout)

    • getConnectionTimeout

      public int getConnectionTimeout()

    • setConnectionTimeout

      @DataBoundSetter public void setConnectionTimeout(int connectionTimeout)

    • start

      public org.jenkinsci.plugins.workflow.steps.StepExecution start(org.jenkinsci.plugins.workflow.steps.StepContext context) throws Exception
      Specified by:
      start in class org.jenkinsci.plugins.workflow.steps.Step
      Throws:
      Exception