olivergondza/jenkins-config-cloner

Remote configuration cloner for jenkins CI

Jenkins configuration cloner

Command line utility to clone stored configuration between instances to facilitate migration. Config cloner invokes CLI commands remotely to get and create/update config.xmls. For this to work source and destination instances are expected to use compatible versions of core and plugins.

Requirements

• Bash and Java to run. GIT and Maven to build.
• This permissions needs to be granted to either anonymous user or the user authenticated using public key.
  • Jenkins.READ as a minimum to call remote CLI commands
  • Item.EXTENDED_READ to read jobs from source instance
  • Item.CREATE to create jobs on target instance
  • Item.CONFIGURE to update existing job on target instance
  • Computer.READ to read node config from source instance
  • Computer.CREATE to create nodes on target instance
  • Computer.CONFIGURE to update nodes on target instance
  • View.READ to read view config from source instance
  • View.CREATE to create views on target instance
  • View.CONFIGURE to update views on target instance

Authentication

The tools supports public key authentization only.

Quoting Jenkins CLI wiki page:

If your Jenkins requires authentication, you should set up public key authentication. Login from the web UI and go to http://yourserver.com/me/configure, then set your public keys in the designated text area. When connecting to the server, the CLI will look for ~/.ssh/identity, ~/.ssh/id_dsa, ~/.ssh/id_rsa and use those to authenticate itself against the server.

Usage

Get and build:

$ git clone git://github.com/olivergondza/jenkins-config-cloner.git
$ mvn package

There is a convenient wrapper called clone.sh to invoke target/config-cloner-${VERSION}-jar-with-dependencies.jar in a comfortable way: ./clone.sh help.

Cloning

General commands have the same pattern

./clone.sh TYPE SRC_ITEM DST_ITEM...

TYPE identifies the type of item to clone (job, node etc.). For the convenience items can be identified with their URLs.

Clone jobs

Clone my-great-job from jnks.old to jnks.new/ci with the same name and tojnks.pub having new name my-great-job-pub:

$ ./clone.sh job http://jnks.old/job/my-great-job http://jnks.new/ci/ http://jnks.pub/job/my-great-job-pub

Clone nodes

$ ./clone.sh node http://jnks.old/computer/my-slave http://jnks.new/ci/ http://jnks.pub/computer/cloned-slave

Clone view

$ ./clone.sh view http://jnks.old/view/my-view http://jnks.new/ci/ http://jnks.pub/view/cloned-view

Options common to all types

• -f|--force Overwrite destination item if already exists.
• -e|--expression Transform XML using sed-like expression.
• -n|--dry-run Simulate actual cloning but avoid any modifications to any instance.

Recipes

Recipes are groovy files describing more complex migration using other clone commands. Recipes are run using:

$ ./clone.sh recipe my-migration.groovy

where my-migration.groovy may look like:

def src = "http://localhost:8080"
def dst = "http://localhost:8081"
def pub = "http://localhost:8082"

clone.job  "$src/job/my-job", "$dst/job/cloned-job/"
clone.node "$src/computer/my-slave/", "$dst/computer/cloned-slave/"
clone.view "$src/view/my-view/", "$dst/view/cloned-view/"

clone.job  "$dst/job/cloned-job", "$pub/job/cloned-cloned-job/"
clone.node "$dst/computer/cloned-slave/", "$pub/computer/cloned-cloned-slave/"
clone.view "$dst/view/cloned-view/", "$pub/view/cloned-cloned-view/"

println "We're done"

Available options (for recipe command)

Clone commands run from recipe can use all available options for given command.

• -n|--dry-run Simulate actual cloning but avoid any modifications to any instance.

jenkins-config-cloner's Issues

Bump JCommander to 1.33 once released

https://groups.google.com/d/topic/jcommander/JAa2blmT6WI/discussion

Add --insecure option not to validate SSL certificates

On a first look it seems that hudson.cli.CLI accepts -noCertificateCheck to do just that.