日期：2025年 08月 09日

標籤： Jenkins Continuous Integration(CI) Ubuntu Linux Jenkins

摘要：Jenkins

第一部分：為何需要配置

Step 1：未配置 - 不安全

如果我們用 sshpass 的語法在 Jenkins 的 Pipeline 中訪問遠端，雖然可正常訪問，但密碼會透漏在 Console Log 中
這是必須避免的

第二部分：前置準備作業 - 設定 Jenkins 憑證

Step 1：Jenkins 主機 - 產生 Key

首先要於 Jenkins 主機內產生一對新的 SSH 金鑰，目的是為了可以 SSH 訪問用
登入 Jenkins Server -> 然後輸入以下指令

ssh-keygen -t rsa -b 4096 -C "louistest@sshconnect" -f ~/.ssh/jenkins_key

以下是參數與說明

並且會要求輸入 passphrase ，可以選擇不輸入，便於 Jenkins 有關係的主機訪問用。

Step 2：Jenkins 主機 - 確認 Key

接著可進入 Jenkins Server 的 root/.ssh/ 目錄下，確認是否有產生私鑰、公鑰

Step 3：Jenkins 主機 - 公開金鑰複製到訪問機器

假設我們現在要訪問的機器是 192.168.51.93 ，我們可以從 Jenkins Server 下輸入：

ssh-copy-id -i ~/.ssh/jenkins_key.pub root@192.168.51.93

如果成功將公開金鑰複製到遠端機器，可以看到關鍵字：Number of key(s) added: 1，表示複製成功

Step 4：Jenkins 主機 - 確認遠端機器

更安全的確認方式是直接訪問該目錄 ~/.ssh/jenkins_key ，可輸入以下：

ssh -i ~/.ssh/jenkins_key root@192.168.51.93 "hostname -I && whoami"

如果正確可以看到類似如下的訊息

Step 5：Jenkins 主機 - 設定權限-1

接著要在 Jenkins 設定 Credentials ，將剛剛產生的金鑰匯入
登入 Jenkins Web-UI -> System -> Global credentials (unrestricted) -> 選擇 Add Credentials

Step 6：Jenkins 主機 - 設定權限-2

依序將 ID , UserName , Passphrase , Private Key
※如果再 Step 1. 沒有輸入 Passphrase 這裡可以空白
※範例這邊的 ID 用 ssh-remote
至於 Private Key 的來源可看 Step 7.

Step 7：Jenkins 主機 - 取得私鑰

私鑰就是 Jenkins Server 我們 Step 1. 產生的，檔案位置在 root/.ssh/jenkins.key
開啟後，將所有的內容複製，並且貼上於 Step 6. Private Key 的位置

第三部分：方法1 - 執行 SSH

Step 1：新建 Pipeline Job

我們新建一個 Pipeline Job ，並且貼上以下範例代碼
關鍵在於使用憑證 withCredentials ，模式為 sshUserPrivateKey，並且用剛剛設定的 ID : ssh-remote
此 Pipeline 的目的有 2 點：

pipeline {
    agent any
    stages {
        stage('SSH to remote host') {
            steps {
                withCredentials([
                    sshUserPrivateKey(
                        credentialsId: 'ssh-remote',
                        keyFileVariable: 'SSH_KEY',
                        usernameVariable: 'SSH_USER'
                    )
                ]) {
                    sh """
                        ssh -i "\$SSH_KEY" -o StrictHostKeyChecking=no "\$SSH_USER@192.168.51.93" hostname && \
                        ls -al /var/log
                    """
                }
            }
        }
    }
}

Step 2：建置 Job - DEMO 成功

接著進行建置，可以從 Console Log 確認，密碼資訊都變為星號 ，成功避免外洩密碼的問題，並達到成功訪問遠端主機的效果
建置成功 :

隱藏密碼：

第四部分：方法2 - 安裝 SShAgent

Step 1：安裝 Pluging SSH Agent

另一種訪問 SSH 的方法是安裝 Jenkins Plugings 的 SSH Agent，使用此插件可以讓 Pipeline 腳本更精簡
登入 Jenkins Web-UI -> 管理 Jenkins -> Plugings -> 安裝 SSH Agent 這個插件

Step 2：SSH Agent - 說明

訪問此插件可以知道用途為 SSH 訪問
並且提供如何設定的教學，此教學與上述我們設定 Jenkins 憑證是相同的

Step 3：編輯 Pipeline Job

我們新建 Pipeline Job ，並且貼上以下範例代碼，增加了第 2 個 Stage
關鍵在於 sshagent(credentials: [‘ssh-remote’])，完成了大部分憑證的設定，更精簡了我們的代碼

pipeline {
    agent any
    stages {
        stage('SSH to remote host') {
            steps {
                withCredentials([
                    sshUserPrivateKey(
                        credentialsId: 'ssh-remote',
                        keyFileVariable: 'SSH_KEY',
                        usernameVariable: 'SSH_USER'
                    )
                ]) {
                    sh """
                        ssh -i "\$SSH_KEY" -o StrictHostKeyChecking=no "\$SSH_USER@192.168.51.93" hostname && \
                        ls -al /var/log
                    """
                }
            }
        }
        
        stage("SSH Agent to remote host") {
             steps {
                sshagent(credentials: ['ssh-remote']) {
                    sh '''
                      ssh -o StrictHostKeyChecking=no 192.168.51.93 hostname && \
                      ls -al /var/log
                    '''
                }
            }
        }       
    }
}

Step 4：建置 Jenkins Job - DEMO 成功

接著進行建置，可以從 Console Log 確認，密碼資訊直接消失，也避免外洩密碼的問題，並達到成功訪問遠端主機的效果
建置成功 :

Console Log 密碼資訊不存在：