0
0

Delete article

Deleted articles cannot be recovered.

Draft of this article would be also deleted.

Are you sure you want to delete this article?

More than 3 years have passed since last update.

【Jenkins】リモートホストのスクリプトを定期実行させたい

0
Last updated at Posted at 2023-10-21

やりたいこと

リモートホストに置いてあるシェルをJenkinsを使って毎時00分に実行させたい。
cronでできることだがあえてJenkinsを用いる。

設定

設定画面でチェックアウトさせたいリポジトリURLとブランチ、Script Pathを指定。
Jenkinsサーバから対象リポジトリにチェックアウトするために認証の設定を済ませておく。
リポジトリ側の設定でグループまたは個人にReadパーミッションを付与しておく。
スクリーンショット 2023-10-22 14.24.05.png

Jenkinsfile

以下Jenkinsfileをリポジトリに配置

Jenkinsfile
pipeline {
    agent any
    
    triggers {
        cron('0 * * * *')
    }
 
    environment {
        USERNAME = 'リモートホストにおけるユーザ名'
        HOSTNAME = 'リモートホスト名'
    }
  
    stages { 
        stage('SSH and run shell') {
            steps {
                sshagent(credentials: ['Credentialに登録済みのID']) {
                    sh '''
                        ssh ${USERNAME}@${HOSTNAME} "cd /ディレクトリへのパス/ && bash シェル名"
                    '''
                  }
            }
        }
        
        stage('Clean Workspace') {
            steps {
                cleanWs()
            }
        }
    }
}

ちょっとだけ解説

triggers {
        cron('0 * * * *')
}

毎時00分に実行させる

environment {
        USERNAME = 'リモートホストにおけるユーザ名'
        HOSTNAME = 'リモートホスト名'
}

リモートホスト名とどのユーザを用いるかをここで指定

stage('SSH and run shell')

何でもいい。どんな内容を実行中なのかが分かれば

sshagent(credentials: ['Credentialに登録済みのIDを指定']) {
    sh '''実行させたい内容'''
}

実行させたい内容にリモートホストで叩かせたいコマンドを記載。
今回私はSSHしてcdしてシェルを実行させるコマンドを叩いた。
ちなみにCredentialに登録済みのIDにはあらかじめJenkinsの認証情報で設定したIDを埋め込む。これによりJenkinsサーバとリモートホスト間のノンパス設定が完了するのでパスワードを聞かれることがない。認証情報の設定は認証情報->認証情報の追加から行う。
スクリーンショット 2023-10-21 13.36.20.png

種類:SSHユーザー名と秘密鍵
ID:何でもいい("ユーザ名-ホスト名"とかにすれば分かり易い)
説明:何でもいい
ユーザー名:リモートホストのユーザ名
秘密鍵:リモートホストから鍵をコピってペースト
パスフレーズ:指定なし

stage('Clean Workspace') {
            steps {
                cleanWs()
            }
}

最後に使ったJenkinsサーバ内のワークスペースをクリーンに

※おまけ

triggers {
        cron('0 * * * *')
}

の代わりに
スクリーンショット 2023-10-22 14.39.57.png
で設定する方が簡単で運用が楽です。

他にもhttps://qiita.com/miyasakura_/items/9d9a8873c333cb9e9f43
にいろんなこと載ってたので参考になりそうです。

0
0
0

Register as a new user and use Qiita more conveniently

  1. You get articles that match your needs
  2. You can efficiently read back useful information
  3. You can use dark theme
What you can do with signing up
0
0

Delete article

Deleted articles cannot be recovered.

Draft of this article would be also deleted.

Are you sure you want to delete this article?