{jenkins-plugin-info:pluginId=swarm|adopt-message=The maintainer is looking for a co-maintainer}


This plugin enables slaves to auto-discover nearby Jenkins master and join it automatically, thereby forming an ad-hoc cluster.


This plugin consists of two pieces:


  1. A self-contained CLI client that discovers a nearby Jenkins (via a UDP broadcast) and joins it
  2. A plugin that needs to be installed on Jenkins master to accept swarm clients

The primary use case of this came from "Jenkins slave appliance" — a virtual machine pre-packaged with the swarm client CLI — that someone can just grab and run.

With the swarm client, a person who's willing to contribute some of his computing power to the cluster just needs to run this virtual machine, and the cluster automatically gets additional resources. Because it's packaged as a VM, there is no need not worry about the builds/tests interfering with the host system or altering its settings unexpectedly.

Usage                       

  1. Install the swarm plugin from the update center
  2. Download the CLI agent from here.
  3. Run the CLI agent like java -jar path/to/swarm-client.jar. There's no required command option, but run with the -help option to see the available options.

Available Options

% java -jar swarm-client.jar --help
 -autoDiscoveryAddress VAL              : Use this address for udp-based
                                          auto-discovery (default
                                          255.255.255.255)
 -candidateTag VAL                      : Show swarm candidate with tag only
 -deleteExistingClients                 : Deletes any existing slave with the
                                          same name.
 -description VAL                       : Description to be put on the slave
 -disableClientsUniqueId                : Disables Clients unique ID.
 -disableSslVerification                : Disables SSL verification in the
                                          HttpClient.
 -executors N                           : Number of executors
 -fsroot FILE                           : Directory where Jenkins places files
 -help (--help)                         : Show the help screen
 -labels VAL                            : Whitespace-separated list of labels
                                          to be assigned for this slave.
                                          Multiple options are allowed.
 -labelsFile VAL                        : File location with space delimited
                                          list of labels.  If the file changes,
                                          restarts this client.
 -logFile VAL                           : File to write STDOUT and STDERR to.
                                          (Deprecated, use -Djava.util.logging.c
                                          onfig.file={path}logging.properties
                                          instead)
 -master VAL                            : The complete target Jenkins URL like
                                          'http://server:8080/jenkins/'. If
                                          this option is specified,
                                          auto-discovery will be skipped
 -maxRetryInterval N                    : Max time to wait before retry in
                                          seconds. Default is 60 seconds.
 -mode MODE                             : The mode controlling how Jenkins
                                          allocates jobs to slaves. Can be
                                          either 'normal' (utilize this slave
                                          as much as possible) or 'exclusive'
                                          (leave this machine for tied jobs
                                          only). Default is normal.
 -name VAL                              : Name of the slave
 -noRetryAfterConnected                 : Do not retry if a successful
                                          connection gets closed.
 -password VAL                          : The Jenkins user password
 -passwordEnvVariable VAL               : Environment variable that the
                                          password is stored in
 -passwordFile VAL                      : Path to the file which contains the password 
 -retry N                               : Number of retries before giving up.
                                          Unlimited if not specified.
 -retryBackOffStrategy RETRY_BACK_OFF_S : The mode controlling retry wait time.
 TRATEGY                                  Can be either none (use same interval
                                          between retires)or 'linear' (increase
                                          wait time before each retry up to
                                          maxRetryInterval) or 'exponential'
                                          (double wait interval on each retry
                                          up to maxRetryInterval). Default is
                                          none.
 -retryInterval N                       : Time to wait before retry in seconds.
                                          Default is 10 seconds.
 -showHostName (--showHostName)         : Show hostnames instead of IP address
 -sslFingerprints VAL                   : Whitespace-separated list of accepted
                                          certificate fingerprints
                                          (SHA-256/Hex), otherwise system
                                          truststore will be used. No
                                          revocation, expiration or not yet
                                          valid check will be performed for
                                          custom fingerprints! Multiple options
                                          are allowed.
 -t (--toolLocation)                    : A tool location to be defined on this
                                          slave. It is specified as
                                          'toolName=location'
 -tunnel VAL                            : Connect to the specified host and
                                          port, instead of connecting directly
                                          to Jenkins. Useful when connection to
                                          Hudson needs to be tunneled. Can be
                                          also HOST: or :PORT, in which case
                                          the missing portion will be
                                          auto-configured like the default
                                          behavior
 -username VAL                          : The Jenkins username for
                                          authentication

FAQ

Error configuration : "xxx.xxx.xxx.xxx doesn't have the URL configuration yet"

This error indicates that the Jenkins master running at the given URL has never configured, and therefore the swarm client cannot determine its HTTP URL. To fix this problem, please go to the system configuration screen of this Jenkins, and click "submit".

Changelog

Version 3.14 (2018 Sep 04)
Version 3.13 (2018 Jun 08)
Version 3.12 (2018 Mar 22)
Version 3.11 (2018 Mar 19)
Version 3.10 (2018 Feb 21)
Version 3.9 (2018 Feb 07)
Version 3.8 (2018 Jan 10)
Version 3.7 (2017 Dec 22)
Version 3.6 (2017 Oct 18)
Version 3.5 (2017 Oct 11)
Version 3.4 (2017 Apr 10)
Version 3.3 (2017 Feb 10)
Version 3.2 (2017 Feb 8)
Version 3.1 (2017 Feb 8)
Version 3.0 (2016 Dec 27)
Version 2.3 (2016 Nov 28)
Version 2.2 (2016 July 26)
Version 2.1 (2016 May 20)
Version 2.0 (2015 Aug 3)
Version 1.26 (2015 Jul 21)
Version 1.25 (2015 Jul 21)
Version 1.24 (2015 Apr 28)
Version 1.23 (2015 Apr 27)
Version 1.22 (2014 Nov 28)
Version 1.21 (2014 Nov 6)
Version 1.20 (2014 Oct 8)
Version 1.19 (2014 Oct 6)
Version 1.18 (2014 Oct 2)
Version 1.17 (2014 Sep 30)
Version 1.16 (2014 Jul 1)
Version 1.15
Version 1.12, 1.11 (2014 Jan 15)
Version 1.10 (2013 Oct 21)
Version 1.9 (2013 May 18))
Version 1.8 (2012 Nov 21)
Version 1.6 (2012 Mar 18)
Version 1.5 (2011 Aug 11)
Version 1.4 (2010 Aug 14)
Version 1.3 (2010 Jan 14)
Version 1.2 (2009 Dec 30)
Version 1.1 (2009 Jul 15)
Version 1.0 (2009 May 23)