Use ssh with jenkinsfile as scripted pipeline

ssh 명령을 jenkins 상에서 사용할일이 다수 있는 상황에서 ssh 를 pipeline을 통해 어떻게 사용할수 있는지에 대하여 알아보도록 하자.

 

ssh plugin을 사용하기 위해서는 다음과 같은 plugin 설치가 필요하다.
(이름은 ssh pipeline steps로 검색된다.)

• https://plugins.jenkins.io/ssh-steps

plugin 설치가 완료된후 ssh key를 등록한다.

배포되어질 서버에 ssh key를 ssh-copy-id 명령을 이용하던지 아니면 기존에 가지고 있던 key파일이 있다면 해당 파일을 이용하여 등록한다.

개인적으로 Passphrase(비밀번호)를 지정하지 않았기에 Passpharse는 빈칸으로 생성하였다.

이후 생성된 credential(ID : ec2-user-server)을 사용하여 pipeline을 작성해보자.

제목에서 언급되었듯이 pipeline은 scripted 방식으로 작성한다.

podTemplate() {
    node() {
        stage('clone the source codes') {
            sh 'echo "start"'
            checkout([$class: 'GitSCM', 
                    branches: [[name: '*/master']],
                    doGenerateSubmoduleConfigurations: false,
                    extensions: [],
                    submoduleCfg: [],
                    userRemoteConfigs: [[credentialsId: 'jacobbaek', refspec: '+refs/pull/*:refs/remotes/origin/pr/*', url: 'https://gitlab.com/JacobBaek/springtemplateprj.git']]])
        }
        stage('run the commands') {
            sh 'echo "done"'
        }
        withCredentials([sshUserPrivateKey(credentialsId: 'ec2-user-server', keyFileVariable: 'identity', passphraseVariable: 'passphrase', usernameVariable: 'userName')]) {
            def remote = [:]
            remote.name = "test-ssh-vm"
            remote.host = "ec2-xxx-xxx-xxx-xxx.ap-northeast-x.compute.amazonaws.com"
            remote.allowAnyHosts = true
            remote.user = userName
            remote.identityFile = identity
            //remote.passphrase = passphrase
            stage("SSH Steps Rocks!") {
                writeFile file: 'test.sh', text: 'ls'
                sshCommand remote: remote, command: 'for i in {1..5}; do echo -n \"Loop \$i \"; date ; sleep 1; done'
                sshScript remote: remote, script: 'test.sh'
                sshPut remote: remote, from: 'test.sh', into: '.'
                sshGet remote: remote, from: 'test.sh', into: 'test_new.sh', override: true
                sshRemove remote: remote, path: 'test.sh'
            }
        }
    }
}

• https://jenkins.io/blog/2019/02/06/ssh-steps-for-jenkins-pipeline/

sshUserPrivatekey 를 사용하여 remote(https://github.com/jenkinsci/ssh-steps-plugin#remote)라는 groovy 변수에 관련 정보를 추가하여 인증을 수행하게 한다.

위는 sshUserPrivatekey를 활용한 방법이며 그외에 usernamePassword, file, certificate, dockerCert등 다양한

• https://jenkins.io/doc/pipeline/steps/credentials-binding/
• https://emilwypych.com/2019/06/15/how-to-pass-credentials-to-jenkins-pipeline/
  해당 링크는 credential을 사용하는 다양한 방법에 대하여 기술되어 있는 blog이다. 참고하면 좋을듯 하다.

아래는 credential을 사용하는 다양한 방법에 대하여 설명된 blog이다

sshCommand, sshScript, sshPut, sshGet 등 다양한 action을 module을 이용하여 지정할 수 있다.

• https://jenkins.io/doc/pipeline/steps/ssh-steps/