> User Documentation Home

User Handbook
Tutorials
Resources

The following plugin provides functionality available through Pipeline-compatible steps. Read more about how to integrate steps into your Pipeline in the Steps section of the Pipeline Syntax page.

For a list of other such plugins, see the Pipeline Steps Reference page.

JClouds plugin

View this plugin on the Plugins site

withJclouds: Create supplemental nodes

Supplemental nodes are JClouds instances that are temporarily provisioned for the lifetime of this job. Apart from being provisioned and torn down by the JClouds plugin, these instances are not under any control of jenkins. In particular, they do not contribute build agents. They are however subject to the instance cap limitation of the specified JClouds profile. The IP addresses of the instances will be recorded in a comma-separated list, in the environment variable "JCLOUDS_IPS". How these instances are used is at the discretion of the build job.

Blocking behavior

If a template with active phone home-flag is specified, the the build will be blocked until the instance(s) have invoked the phone-home webhook (or the phone-home timeout has been reached). Otherwise, the build will commence immediately after launching the instances.
  • instancesToRun
      Array / List of Nested Object
    • cloudName
      The cloud from which to run your instances.
      • Type: String
    • templateName
      The template, from the list of templates configured for the chosen cloud, to use for the instances.
      • Type: String
    • manualTemplateName
      • Type: String
    • count
      The number of instances of the chosen template to launch.
      • Type: int
    • suspendOrTerminate
      • Type: boolean

jcloudsOneOffAgent: JClouds Single-use agent

If enabled and the build agent has beed provisioned by jclouds, then take this agent offline after the build has finished and subsequently delete it when it becomes idle.

    Was this page helpful?

    Please submit your feedback about this page through this quick form.

    Alternatively, if you don't wish to complete the quick form, you can simply indicate if you found this page helpful?

        


    See existing feedback here.