如何从 Jenkins 将节点应用程序部署到远程主机？

Question

这是节点应用目录根目录下的 Jenkins 文件：

pipeline {
    agent any
    triggers {
        pollSCM('* * * * *')
    }
    stages {
        stage("deploy") {
            steps {
            sh "scp"
            }
        }
    } 
}

我将 Jenkins 配置为连接到远程 gitlab node proj repo 以检查节点项目以及 Jenkinsfile 并运行项目的 Jenkinsfile。这部分工作正常，但是现在要执行什么操作（请注意，Jenkins 服务器和运行节点 js 的服务器以及 gitlab repo 都是相互远程的）：

run these commands on remote server on which node app is running

cd ~/mynodeproj 

pm2 stop mynodeproj 

copy project source files from Jenkins server to remote server where 
node app is running 

npm install 

export NODE_ENV=production 

pm2 start mynodeproj

如何做到这一点？

我是否需要在运行 jenkins 的服务器上设置私钥/公钥对，以便 jenkins 服务器可以执行 scp 将文件复制到运行节点应用程序的远程服务器？

Answer 1

我建议我们可以在这种情况下使用Rocketeer。

这是我的 Jenkins 服务器上用于 NodeJS 应用程序的 Rocketeer 树

$ tree .rocketeer/
.rocketeer/
├── config.php
├── hooks.php
├── logs
│   ├── develop--20170613.log
│   ├── develop--20170614.log
│   ├── develop--20170616.log
│   ├── staging--20180323.log
│   ├── staging--20180324.log
│   ├── staging--20180326.log
│   ├── production--20180223.log
│   ├── production--20180226.log
│   ├── production--20180227.log
│   ├── production--20180227.log
│   └── custom-environment--20180328.log
├── paths.php
├── remote.php
├── scm.php
├── stages.php
└── strategies.php

• 您可以管理 NodeJS 应用程序的远程环境：开发、暂存、生产（config.php 文件）
• 它将在您的 Gitlab 上提取最新的源代码并保留发布版本，如 Capistrano（remote.php 文件）
• 在部署最新的源代码（hooks.php 文件）后，它可以运行你的pm2 command line
• 它已经帮助运行npm install NodeJS 包。

---

这是我的 Jenkins 工作设置：

源代码管理

构建触发器

构建

#!/bin/bash -el
cd $JENKINS_HOME/app-deploy/app-socketio
rocketeer deploy --on="develop"

develop 表示连接到 Develop Remote Server（.rocketeer\config.php 文件）

'connections'      => [
    'develop' => [
        'host'      => '35.xx.xx.xx',
        'username'  => 'ec2-user',
        'password'  => '',
        'key'       => '/var/lib/jenkins/.ssh/foo.pem',
        'keyphrase' => '',
        'agent'     => '',
        'db_role'   => true,
    ],
    'staging' => [
        'host'      => '34.xx.xx.xx',
        'username'  => 'ec2-user',
        'password'  => '',
        'key'       => '/var/lib/jenkins/.ssh/bar.pem',
        'keyphrase' => '',
        'agent'     => '',
        'db_role'   => true,

    ],
    'production' => [
        'host'      => '18.xx.xx.xx:63612',
        'username'  => 'ec2-user',
        'password'  => '',
        'key'       => '/var/lib/jenkins/.ssh/woot.pem',
        'keyphrase' => '',
        'agent'     => '',
        'db_role'   => true,
    ],
    'custom-environment' => [
        'host'      => '13.xx.xx.xx:63612',
        'username'  => 'ec2-user',
        'password'  => '',
        'key'       => '/var/lib/jenkins/.ssh/test.pem',
        'keyphrase' => '',
        'agent'     => '',
        'db_role'   => true,
    ],
],

并在hooks.php文件处运行pm2命令行配置

'after'  => [
    'setup'   => [],
    'deploy'  => [
            "pm2 delete mynodeproj", //Delete old pm2 task
            "pm2 start src/mynodeproj.js", //Start new mynodeproj
    ],
    'cleanup' => [],
],

希望对你有帮助！！

Answer 2

现在要执行的操作（注意Jenkins服务器和运行节点js的服务器以及gitlab repo都是相互远程的）：

这些命令应该在 Git 存储库的文件部分中，这意味着在管道使用的工作区中签出。

从那里，您可以将该脚本 scp 到服务器：

sh 'scp -r script user@server:/path/server'

并通过 ssh 执行，前提是远程用户的私钥/公钥部署在代理上（或通过ssh-agent plugin 传递）：

sh 'ssh user@server /path/server/script'

不过，就像mentioned here 一样，诀窍在于 ssh 会话的 PATH 相当有限，并且可能不包括节点，如果节点 未 安装在像 /usr/bin 这样的标准路径中.
所以你可能想修改你的脚本以便为你的可执行文件使用绝对路径（比如/absolute/path/to/node）

Answer 3

Your question is how to deploy your application to remote host from jenkins

最简单的解决方案

1.使用 Jenkins 文件

如果您使用的是管道项目，那么您会注意到一个管道语法选项，只需选择 ssh Publisher:send artifacts over SSH（您需要插件 Publish over SSH 插件）

添加 SSH 服务器

• 源文件：提及您希望传输的文件（**/*.war 需要 仅限 WAR 文件）
• 删除前缀：目标（WAR 文件通常是 位于目标文件夹中，所以我告诉我不想要目标 文件夹仅复制我的 WAR）
• 远程目录：留空（ 因为你把它从你的项目中拿走了）
• Exec command : 复制文件后要执行的命令（例如启动 tomcat 或解压缩任何属性文件并放置在特定位置 - 在您的情况下是从服务器启动节点的命令）

最后只需单击 Generate Pipeline Script 和 BOOM，您就可以得到脚本（它在内部执行一个 scp），只需将其复制并粘贴到您的 Pipeline 文件中即可完成 :)

)

2.通过 SSH 发布

您可以在 Post Build Action 的普通 Jenkins 项目中执行相同的操作（仅按照上述步骤添加详细信息） 如果您没有流水线项目（如果您没有/不知道流水线项目会有所帮助）

Do I need to setup private/public keypair on server running jenkins so that jenkins server can do scp to copy file to remote server running node app?

是的，它是必需的（推荐），您可以在 Jenkins 的 Manage Jenkins 下添加如下所示的细节，Configure Jenkins 在 Publish over SSH 下，您可以测试您的连接。

希望这有用:)

Answer 4

您可能需要考虑使用 ansible 执行此操作，只需从以下位置调用您的 ansible playbook：Build -> Execute Shell

https://dzone.com/articles/running-ansible-playbooks-from-jenkins

您可以让 ansible 管理您的所有远程环境。