Как да изграждате проекти в Jenkins, ако са ви нужни много различни среди

В Хабр има много статии за Jenkins, но малко къде се описва пример за работа с Jenkins и Docker агенти. Всички популярни инструменти за изграждане на проекти, като Drone.io, Bitbucket Pipeline, GitLab, GitHub действия и други, могат да събират всичко в контейнери. Но как е с Jenkins?

Днес има решение на проблема: Jenkins 2 прекрасно работи с Docker агенти. В статията искам да споделя опит и да покажа как можете да го направите сами.

Защо започнах да решавам този проблем?

Тъй като ние в компанията Citronium използваме множество различни технологии, на строителната машина трябва да имаме различни версии на Node.JS, Gradle, Ruby, JDK и други. Но често не може да се избегнат конфликти между версиите. Да, прави сте, ако кажете, че има различни мениджъри на версии, като nvm, rvm, но не всичко е толкова гладко с тях и тези решения имат свои проблеми:

• голям обем рантайми, които разработчиците забравят да чистят;
• има конфликти между различни версии на един и същ рантайм;
• на всеки разработчик му е нужен различен набор от компоненти.

Има и други проблеми, но нека да ви разкажа за решението.

Jenkins в Docker

Тъй като Docker вече се утвърди в сектора на разработката, почти всичко може да се стартира с помощта на Docker. Моето решение е, че Jenkins е в Docker и може да стартира други Docker контейнери. Този въпрос започна да се обсъжда още през 2013 година в статията „Docker can now run within Docker«.

Кратко казано, просто е необходимо да инсталирате самия Docker в работния контейнер и да монтирате файла /var/run/docker.sock.

Ето пример за Dockerfile, който получихме за Jenkins.

FROM jenkins/jenkins:lts

USER root

RUN apt-get update && 

apt-get -y install apt-transport-https 
     ca-certificates 
     curl 
     gnupg2 
     git 
     software-properties-common && 
curl -fsSL https://download.docker.com/linux/$(. /etc/os-release; echo "$ID")/gpg > /tmp/dkey; apt-key add /tmp/dkey && 
add-apt-repository 
   "deb [arch=amd64] https://download.docker.com/linux/$(. /etc/os-release; echo "$ID") 
   $(lsb_release -cs) 
   stable" && 
apt-get update && 
apt-get -y install docker-ce && 
usermod -aG docker jenkins

RUN curl -L https://github.com/docker/compose/releases/download/1.25.0/docker-compose-`uname -s`-`uname -m` -o /usr/local/bin/docker-compose && chmod +x /usr/local/bin/docker-compose 

RUN apt-get clean autoclean && apt-get autoremove —yes && rm -rf /var/lib/{apt,dpkg,cache,log}/

USER jenkins

Така получихме Docker контейнер, който може да изпълнява Docker команди на хост машината.

Настройване на изграждането

Неотдавна Jenkins получи възможност да описва своите правила с помощта на Pipeline синтаксис, който позволява лесна промяна на скрипта за изграждане и съхранението му в репозиторий.

Нека да поставим в самия репозиторий специален Dockerfile, който ще съдържа всички нужни библиотеки за изграждане. По този начин самият разработчик може да подготви повтаряема среда и не е необходимо да моли OPS да постави на хост определена версия на Node.JS.

FROM node:12.10.0-alpine

RUN npm install yarn -g

Този образ за изграждане е подходящ за повечето приложения на Node.JS. А ако, например, нуждата ви е образ за JVM проект с вграден Sonar скенер? Сами избирате необходимите компоненти за изграждане.

FROM adoptopenjdk/openjdk12:latest

RUN apt update 
    && apt install -y 
        bash unzip wget

RUN mkdir -p /usr/local/sonarscanner 
    && cd /usr/local/sonarscanner 
    && wget https://binaries.sonarsource.com/Distribution/sonar-scanner-cli/sonar-scanner-cli-3.3.0.1492-linux.zip 
    && unzip sonar-scanner-cli-3.3.0.1492-linux.zip 
    && mv sonar-scanner-3.3.0.1492-linux/* ./ 
    && rm sonar-scanner-cli-3.3.0.1492-linux.zip 
    && rm -rf sonar-scanner-3.3.0.1492-linux 
    && ln -s /usr/local/sonarscanner/bin/sonar-scanner /usr/local/bin/sonar-scanner

ENV PATH $PATH:/usr/local/sonarscanner/bin/
ENV SONAR_RUNNER_HOME /usr/local/sonarscanner/bin/

Описание на изградната среда е направено, но каква е връзката с Jenkins? Агенти на Jenkins могат да работят с такива Docker образи и да извършват изграждане в тях.

stage("Build project") {
    agent {
        docker {
            image "project-build:${DOCKER_IMAGE_BRANCH}"
            args "-v ${PWD}:/usr/src/app -w /usr/src/app"
            reuseNode true
            label "build-image"
        }
    }
    steps {
        sh "yarn"
        sh "yarn build"
    }
}

запроси agent използва свойството docker, където можете да посочите:

• името на изградния контейнер съгласно вашата политика за именуване;
• аргументите, нужни за стартиране на изградния контейнер, където в нашия случай монтираме текущата директория като директория вътре в контейнера.

А в стъпките за изграждане посочваме какви команди да изпълним вътре в изградния Docker агент. Това може да бъде всичко, затова аз също стартирам внедряването на приложения с помощта на ansible.

По-долу искам да покажа общ Jenkinsfile, който може да изгради просто приложение на Node.JS.

def DOCKER_IMAGE_BRANCH = ""
def GIT_COMMIT_HASH = ""

pipeline { 
    options {
        buildDiscarder(
            logRotator(
                artifactDaysToKeepStr: "",
                artifactNumToKeepStr: "",
                daysToKeepStr: "",
                numToKeepStr: "10"
            )
        )
        disableConcurrentBuilds()
    }

    agent any

    stages {

        stage("Подготовка на образа за сборка") {
            steps {
                sh "docker build -f Dockerfile.build . -t project-build:${DOCKER_IMAGE_BRANCH}"
            }
        }

        stage("Сборка на проекта") {
            agent {
                docker {
                    image "project-build:${DOCKER_IMAGE_BRANCH}"
                    args "-v ${PWD}:\usr\src\app -w \usr\src\app"
                    reuseNode true
                    label "build-image"
                }
            }
            steps {
                sh "yarn"
                sh "yarn build"
            }
        }

    post {
        always {
            step([$class: "WsCleanup"])
            cleanWs()
        }
    }

}

Какво се получи?

Благодарение на този метод решихме следните проблеми:

• Времето за конфигурация на средата за сборка е сведено до 10 – 15 минути за проект;
• Напълно повтаряща се среда за сборка на приложението, тъй като може да се строи и на локалния компютър;
• Няма проблеми с конфликти на различни версии на сборъчни инструменти;
• Винаги чист работен пространствен, който не се запълва.

Самото решение е просто и очевидно и позволява да получим само предимства. Да, прага на входа малко се увеличи в сравнение с простите команди за сборки, но сега има гаранция, че ще се сглобява винаги и разработчикът сам може да избере всичко необходимо за неговия процес на сборка.

Можете също така да се възползвате от образа, който съм създал Jenkins + Docker. Всички източници са отворени и се намират на rmuhamedgaliev/jenkins_docker.

По време на написването на статията възникна дискусия относно използването на агенти на отдалечени сървъри, за да не се натоварва основния възел чрез плъгина docker-plugin. Но за това ще разкажа в бъдеще.

Източник: habr.com