Using Jenkins to run remote deployment scripts over SSH

We use Jenkins to deploy code to multiple servers, so that we can manage builds and deployments from the same (even better if you’re using the Jenkins IRC plugin).

The deployment is done by a parameterized build job, where the parameter is the version of the project that we want to deploy. The job will run remote commands over ssh on servers that you’ve defined in the Jenkins configuration. Those commands will pull down a version of our code, unpack it, and run the rest of the install steps.

 

First you’ll need to install the Publish over SSH Plugin, which will allow files to be transferred to your servers and remote commands to be run.

Set up the SSH key for remote access of your target servers, in the Manage Jenkins page:

and setup the definitions for each of the servers that you want to deploy to:

Then in the configuration for the new deployment job you’ve set up, you’ll use the “Send files or execute commands over SSH before the build starts” settings in the “Build Environment” section to remotely execute a script to carry out the install steps on each remote server:

Notice that the build parameter “$version” is available to the Exec command that gets remotely executed – other Jenkins environment variables will also be available (e.g. $BUILD_NUMBER, $JOB_NAME etc).

Use the “Add Server” button to add more target servers, with the same Exec command.

Now you can deploy your project (or run any other remote scripts) by running the build job and specifying a version number.

 

9 Comments

  1. Pingback: Using Jenkins to run remote deployment scripts over SSH ยป Julian Higman’s Blog | tksystem

  2. Anonymous

    Hi,

    I have tried using multiple commands separated by space and newline in Exec text area but its not working.. can you give the exact syntax in the form of text rather than image.

  3. jhigman

    I don’t have that build server any more, so I can’t pull the exact text out – but there wasn’t anything special about it, as fas as I can remember.

    What’s the error when you try text in the Exec section?

  4. David

    Hey Anonymous…usually you need to separate multiple commands with a semicolon. For example cd foo; run.sh. Try that out.

  5. Cathy

    Hi,

    Does anyone know why the connection is keep failing?
    I entered hostnames, login name and user password, or path to key/key then click Test Configuration tab, the errors occur as below for 2 different servers in the Build environment section:
    Errors:
    “Connected, but failed to setup SFTP – check the SSH server. Exec commands should work, but transferring files will fail
    jenkins.plugins.publish_over_ssh.BapSshSftpSetupException: Failed to connect SFTP channel. Message [failed to send channel request]”

    or
    Failed to connect or change directory
    jenkins.plugins.publish_over.BapPublisherException: Failed to connect session for config [QA-Weblogic-server]. Message [Auth fail]

    Any idea how to connect?

  6. MHEcwIBAAKCAQEAjqQo2ITgkVOMKdCC

    I hope you changed your private key… Next time, blank out more, or generate an extra one?

  7. lawrence

    I’m confused about which key to fulfill in the key box.
    I’ll deploy a zip file to multiple servers ,
    Shall I generate the SSH key from each computer (Linux ) and then paste the private key in the jenkins key box?

Leave a Reply

Your email address will not be published.

You may use these HTML tags and attributes: <a href="" title=""> <abbr title=""> <acronym title=""> <b> <blockquote cite=""> <cite> <code> <del datetime=""> <em> <i> <q cite=""> <strike> <strong>