Buildbotin asentaminen ja määrittäminen CentOS 7:ssä

Buildbot on avoimen lähdekoodin Python-pohjainen jatkuva integrointityökalu ohjelmistojen rakentamisen, testauksen ja käyttöönoton automatisoimiseksi. Buildbot koostuu yhdestä tai useammasta Buildbot-päälliköstä ja useista työntekijöistä. Buildbot master tai Buildmaster hallitsee järjestelmää keskitetysti. Se vastaa rakennusympäristön, työntekijöiden hallinnasta ja tekee kaikki päätökset työpaikkojen lähettämisestä työntekijöille. Buildmaster havaitsee muutokset koodivarastossa ja lähettää komennot tai työt työntekijöille suoritettaviksi. Työntekijät suorittavat työt ja palauttavat tuloksen Buildmasterille. Buildmaster ilmoittaa sitten kehittäjille useiden tuettujen kanavien kautta. Tässä opetusohjelmassa asennamme Buildbot masterin ja workerin CentOS 7:ään. Määritämme myös todennuksen ja Nginxin suojatuksi käänteiseksi välityspalvelimeksi.

Edellytykset

• Vultr CentOS 7 -palvelinesiintymä, jossa on vähintään 1 Gt RAM-muistia.
• Sudo käyttäjä .
• Rekisteröity verkkotunnus osoitti palvelimeen.

Tässä opetusohjelmassa käytämme 192.168.1.1julkisena IP-osoitteena ja ci.example.comVultr-instanssiin osoittavana toimialueen nimenä. Muista korvata kaikki esimerkin verkkotunnuksen nimen ja IP-osoitteen esiintymät todellisella.

Päivitä perusjärjestelmäsi CentOS 7:n päivittäminen -oppaan avulla . Kun järjestelmäsi on päivitetty, jatka PostgreSQL:n asentamista.

Asenna Python-riippuvuudet

Asenna Pip, joka on Pythonin paketinhallinta.

sudo yum -y install epel-release
sudo yum -y install python-pip gcc python-devel git
sudo pip install --upgrade pip

Asenna PostgreSQL

Buildbot tukee useita tietokantapalvelimia, kuten MySQL, PostgreSQL ja SQLite. Tässä opetusohjelmassa käytämme PostgreSQL:ää Buildbot-tietokantapalvelimen isännöimiseen.

PostgreSQL on oliorelaatiotietokantajärjestelmä, joka tunnetaan vakaudestaan ​​ja nopeudestaan. Oletusarkisto yumsisältää vanhan PostgreSQL-version, joten lisää PostgreSQL-arkisto.

sudo yum -y install https://download.postgresql.org/pub/repos/yum/10/redhat/rhel-7-x86_64/pgdg-centos10-10-1.noarch.rpm

Asenna PostgreSQL-tietokantapalvelin.

sudo yum -y install postgresql10-server postgresql10-contrib postgresql10 

Alusta tietokanta.

sudo /usr/pgsql-10/bin/postgresql-10-setup initdb

Käynnistä PostgreSQL-palvelin ja ota se käyttöön automaattisesti käynnistyksen yhteydessä.

sudo systemctl start postgresql-10
sudo systemctl enable postgresql-10

Vaihda PostgreSQL-oletuskäyttäjän salasana.

sudo passwd postgres

Kirjaudu sisään PostgreSQL-käyttäjänä.

sudo su - postgres

Luo uusi PostgreSQL-käyttäjä Buildbotille.

createuser bb_user

Voit halutessasi käyttää mitä tahansa käyttäjätunnusta bb_user. PostgreSQL tarjoaa psqlkomentotulkin kyselyjen suorittamiseen tietokannassa. Vaihda PostgreSQL-kuoreen.

psql

Aseta salasana äskettäin luodulle käyttäjälle.

ALTER USER bb_user WITH ENCRYPTED password 'DBPassword';

Vaihda DBPasswordsuojatulla salasanalla.

Luo uusi tietokanta Buildbot-asennusta varten.

CREATE DATABASE buildbot OWNER bb_user;

Poistu psqlkuoresta.

\q

Vaihda sudokäyttäjäksi.

exit

Muokkaa pg_hba.conftiedostoa ottaaksesi MD5-pohjaisen todennuksen käyttöön.

sudo nano /var/lib/pgsql/10/data/pg_hba.conf

Etsi seuraavat rivit ja muuttaa arvoja peerja identsiinä METHODsarakkeessa, jotta trustja md5vastaavasti.

# TYPE  DATABASE        USER            ADDRESS                 METHOD

# "local" is for Unix domain socket connections only
local   all             all                                     peer
# IPv4 local connections:
host    all             all             127.0.0.1/32            ident
# IPv6 local connections:
host    all             all             ::1/128                 ident

Päivityksen jälkeen kokoonpano näyttää seuraavalta tekstiltä.

# TYPE  DATABASE        USER            ADDRESS                 METHOD

# "local" is for Unix domain socket connections only
local   all             all                                     trust
# IPv4 local connections:
host    all             all             127.0.0.1/32            md5
# IPv6 local connections:
host    all             all             ::1/128                 md5

Tallenna tiedosto ja poistu editorista. Asenna PostgreSQL-tietokantasovitin Pythonille.

sudo pip install psycopg2

Käynnistä PostgreSQL uudelleen, jotta muutokset tulevat voimaan.

sudo systemctl restart postgresql-10

Asenna Buildbot

Asenna Buildbot käyttämällä Pip.

sudo pip install 'buildbot[bundle]' pyopenssl service_identity

Yllä oleva komento asentaa Buildbotin buildbot-www, buildbot-worker, ja useiden verkkolaajennusten, kuten buildbot-waterfall-view.

Varmistaaksesi, että Buildbot on asennettu onnistuneesti, voit varmistaa tarkistamalla Buildbotin version.

buildbot --version

Tulosteen tulee muistuttaa seuraavaa tekstiä.

[user@vultr ~]$ buildbot --version
Buildbot version: 0.9.15.post1
Twisted version: 17.9.0

Muokkaa palomuurisääntöjä sallimaan portti 8010. Buildbot käyttää tätä porttia web-pyyntöjen kuuntelemiseen.

sudo firewall-cmd --zone=public --add-port=8010/tcp --permanent
sudo firewall-cmd --reload

Määritä Buildbot Master

Luo uusi etuoikeutettu käyttäjä suorittamaan Buildbotin pää- ja työprosesseja. Buildbot-pääpalveluiden käyttämistä rootkäyttäjänä ei suositella .

sudo adduser buildbot
sudo passwd buildbot

Kirjaudu sisään äskettäin luotuna buildbotkäyttäjänä.

sudo su - buildbot

Aseta Buildbot-master /home/buildbot/masterhakemistoon. Tämä hakemisto sisältää kunkin koontiversion kokoonpano-, tila- ja lokitiedostot.

buildbot create-master --db 'postgresql://bb_user:DBPassword@localhost/buildbot' ~/master

Muista korvata tietokannan käyttäjän tunnistetiedot yllä olevassa komennossa.

Huomautus: Jos haluat käyttää SQLite-tietokantaa PostgreSQL:n sijaan, jätä --db 'postgresql://bb_user:DBpassword@localhost/buildbot'vaihtoehto pois . SQLite-tietokanta luodaan samaan hakemistoon.

Yllä oleva komento luo ~/masterhakemiston Buildmaster-tiedostoille. Se myös kirjoittaa tiedot PostgreSQL-tietokantaan. Saat seuraavan tulosteen.

[buildbot@vultr ~]$ buildbot create-master --db 'postgresql://bb_user:DBPassword@localhost/buildbot' ~/master
mkdir /home/buildbot/master
creating /home/buildbot/master/master.cfg.sample
creating database (postgresql://bb_user:DBPassword@localhost/buildbot)
buildmaster configured in /home/buildbot/master

Kopioi mallimääritystiedosto elävään asetustiedostoon.

cp ~/master/master.cfg.sample ~/master/master.cfg

Muokkaa asetustiedostoa.

nano ~/master/master.cfg

Etsi seuraavat rivit.

c['workers'] = [worker.Worker("example-worker", "pass")]
...

c['builders'].append(
    util.BuilderConfig(name="runtests",
      workernames=["example-worker"],
      factory=factory))
...

c['title'] = "Hello World CI"
c['titleURL'] = "https://buildbot.github.io/hello-world/"
...

c['buildbotURL'] = "http://localhost:8010/"
...

c['db'] = {
    'db_url' : "postgresql://bb_user:DBpassword@localhost/buildbot",
}

Yllä olevassa kokoonpanossa on merkintä esimerkkityöntekijälle. Muutamme näytemerkintää työntekijälle, jolla työskentelemme localhost. Muuta työntekijälle example-workersopiva nimi localhostja vaihda passsalasana johonkin muuhun. Kirjoita työntekijän nimi ja salasana muistiin, koska vaadimme niitä myöhemmin opetusohjelmassa. Muuta työntekijän nimi rakentajaluettelossa. Muuta hakemuksen nimeä ja projektin URL-osoitetta tarpeidesi mukaan.

Change the Buildbot URL from localhost to your actual domain name or public IP address. Also, verify that the database information in the configuration file matches your actual database credentials.

At the end of the file, add c['buildbotNetUsageData'] = None. This parameter will disable sending the software version information and plugin usage details to the developers. However, to enable sending the uses information, change the option to Full.

The configuration should look like the following text.

c['workers'] = [worker.Worker("localhost-worker", "Password123")]
...    

c['builders'].append(
    util.BuilderConfig(name="runtests",
      workernames=["localhost-worker"],
      factory=factory))
...

c['title'] = "My Application CI"
c['titleURL'] = "https://example.com/my-app"
...

c['buildbotURL'] = "http://192.168.1.1:8010/"
...

c['db'] = {
    'db_url' : "postgresql://bb_user:DBpassword@localhost/buildbot",
}
...

c['buildbotNetUsageData'] = None

Save the file and exit the editor. Check the configuration file for errors.

buildbot checkconfig ~/master

If the configuration file has no errors, you will see following output.

[buildbot@vultr ~]$ buildbot checkconfig ~/master
Config file is good!

Now that everything is configured correctly, you can start the Buildbot master.

buildbot start ~/master

You will see the following output.

[buildbot@vultr ~]$ buildbot start ~/master
Following twistd.log until startup finished..
The buildmaster appears to have (re)started correctly.

Now that the Buildbot master has started correctly, the web user interface is accessible at http://192.168.1.1:8010. You should see the following Buildbot interface.

Configure Buildbot Worker

Since we have already modified the worker configuration in ~/master/master.cfg, we can proceed to create a new worker.

buildbot-worker create-worker ~/worker localhost localhost-worker Password123

Make sure that you use the exact same worker name and password as mentioned in ~/master/master.cfg file. If there's a mismatch in worker name or password, the worker will not be able to connect to the Buildbot master. You will see the following output upon successful execution.

[buildbot@vultr ~]$ buildbot-worker create-worker ~/worker localhost example-worker pass
mkdir /home/buildbot/worker
mkdir /home/buildbot/worker/info
Creating info/admin, you need to edit it appropriately.
Creating info/host, you need to edit it appropriately.
Not creating info/access_uri - add it if you wish
Please edit the files in /home/buildbot/worker/info appropriately.
worker configured in /home/buildbot/worker

Information about the worker is stored in the /info directory. Edit the administrative information about the developer.

nano ~/worker/info/admin

Replace the example name with your actual name and email.

Your Name <[email protected]>

Now, open the file containing information about the host.

nano ~/worker/info/host

Replace the example instruction with the actual information about the host system.

Localhost, CentOS 7

The worker admin and host information is only used to tell the users about the system. You can also add additional information about the system such as Buildbot version and Twisted version.

Start the worker.

buildbot-worker start ~/worker

The output will look like the following text.

[buildbot@vultr ~]$ buildbot-worker start ~/worker
Following twistd.log until startup finished..
The buildbot-worker appears to have (re)started correctly.

To check if the worker is registered, head to the web interface of Buildbot and navigate to Builds >> Workers from the left navigation. You should see that the worker is up and ready to build.

To run a sample build, to check if the Buildbot worker is running successfully, navigate to Builds >> Builders. Click on the runtests builder name to open the builder interface and click on the Force button to force a build. Provide your name and click on the Start Build button to start the build. Since it is a sample build test to check the Buildbot environment, it will finish in a couple of seconds. You will get a success message and the build result.

Setting up Systemd Service

Although the Buildbot master and worker can be easily started using the commands above, it is recommended to use Systemd units to run and manage the Buildbot services. This will ensure that they are automatically started on system restart and failures.

Note: Switch to the sudo user again by running either exit or su <username>. From now on all the commands need to be executed by the sudo user.

Stop the running Buildbot worker and master service.

sudo su buildbot -c "buildbot stop /home/buildbot/master" 
sudo su buildbot -c "buildbot-worker stop ~/worker"

Create a new Systemd unit file for the Buildbot master.

sudo nano /etc/systemd/system/buildbot.service

Populate the file.

[Unit]
Description=BuildBot master service 
After=network.target

[Service]
Type=forking
User=buildbot 
Group=buildbot 
WorkingDirectory=/home/buildbot/master 
ExecStart=/usr/bin/buildbot start
ExecStop=/usr/bin/buildbot stop
ExecReload=/usr/bin/buildbot restart

[Install]
WantedBy=multi-user.target

Start the Buildbot master and enable it to automatically start at boot time.

sudo systemctl start buildbot
sudo systemctl enable buildbot

Create a new Systemd unit file for the Buildbot worker.

sudo nano /etc/systemd/system/buildbot-worker.service

Populate the file.

[Unit]
Description=BuildBot worker service
After=network.target

[Service]
Type=forking
User=buildbot
Group=buildbot
WorkingDirectory=/home/buildbot/worker
ExecStart=/usr/bin/buildbot-worker start
ExecStop=/usr/bin/buildbot-worker stop
ExecReload=/usr/bin/buildbot-worker restart

[Install]
WantedBy=multi-user.target

Start the Buildbot worker and enable it to automatically start at boot time.

sudo systemctl start buildbot-worker
sudo systemctl enable buildbot-worker

You can check the status of the services.

sudo systemctl status buildbot buildbot-worker

If the services are running smoothly, you will see that in the output.

[user@vultr ~]$ sudo systemctl status buildbot buildbot-worker
● buildbot.service - BuildBot master service
...
Active: active (running) since Fri 2018-01-12 16:00:59 UTC; 1min 25s ago
...
Jan 12 16:00:59 vultr.guest systemd[1]: Started BuildBot master service.

● buildbot-worker.service - BuildBot worker service
...
Active: active (running) since Fri 2018-01-12 16:02:00 UTC; 24s ago
...
Jan 12 16:02:00 vultr.guest systemd[1]: Started BuildBot worker service.

Enabling Authentication

By default, authentication is not enabled in the Buildbot web interface. For internet facing sites, it is strongly recommended to setup authentication so that only the authorized users can have the ability to perform administrative tasks. To set up authentication, reopen the Buildbot master configuration file.

sudo su buildbot -c "nano /home/buildbot/master/master.cfg"

Add the following lines to the end of the file.

c['www']['authz'] = util.Authz(
       allowRules = [
           util.AnyEndpointMatcher(role="admins")
       ],
       roleMatchers = [
           util.RolesFromUsername(roles=['admins'], usernames=['admin_user'])
       ]
)
c['www']['auth'] = util.UserPasswordAuth({'admin_user': 'AdminPassword'})

Replace both occurrences of admin_user with the actual username you want to use and AdminPassword with a strong password.

Check for errors in the configuration file.

sudo su buildbot -c "buildbot checkconfig /home/buildbot/master"

Restart Buildbot master service so that the changes can take effect.

sudo systemctl restart buildbot

Browse the web interface again to see that the anonymous users can only view the basic details about the build server. Now, log in using the credentials set in the master.cfg file and you will see that all other administrative functions are only available to the logged in admin user.

Securing Buildbot with Let's Encrypt SSL

By default, Buildbot listens to the port 8010 on unsecured connections. Securing the web interface with HTTPS is recommended to ensure that the data is safe during transportation from the browser to the server. In this section of the tutorial, we will install and secure Nginx with Let's Encrypt free SSL certificates. The Nginx web server will work as a reverse proxy to forward the incoming requests to Buildbot's HTTP endpoint.

Install Nginx.

sudo yum -y install nginx

Start Nginx and enable it to automatically start at boot time.

sudo systemctl start nginx
sudo systemctl enable nginx

Install Certbot, which is the client application for Let's Encrypt CA.

sudo yum -y install certbot

Before you can request the certificates, you will need to allow ports 80 and 443 or standard HTTP and HTTPS services through the firewall. Also, remove port 8010, which listens to the unsecured connections.

sudo firewall-cmd --zone=public --add-service=http --permanent
sudo firewall-cmd --zone=public --add-service=https --permanent
sudo firewall-cmd --zone=public --remove-port=8010/tcp --permanent
sudo firewall-cmd --reload

Note: To obtain certificates from Let's Encrypt CA, the domain for which the certificates are to be generated must be pointed towards the server. If not, make the necessary changes to the DNS records of the domain and wait for the DNS to propagate before making the certificate request again. Certbot checks the domain authority before providing the certificates.

Generate the SSL certificates.

sudo certbot certonly --webroot -w /usr/share/nginx/html -d ci.example.com

Luodut varmenteet tallennetaan todennäköisesti /etc/letsencrypt/live/ci.example.com/hakemistoon. SSL-varmenne tallennetaan nimellä fullchain.pemja yksityinen avain muodossa privkey.pem.

Let's Encrypt -sertifikaatit vanhenevat 90 päivässä, joten on suositeltavaa määrittää varmenteiden automaattinen uusiminen Cron-töiden avulla.

Avaa käyttäjän cron-työtiedosto root.

sudo crontab -e

Lisää seuraava rivi tiedoston loppuun.

30 5 * * * /usr/bin/certbot renew --quiet

Yllä oleva cron-työ suoritetaan joka päivä klo 5.30. Jos varmenteen voimassaolo päättyy, se uusii ne automaattisesti.

Muuta nyt Nginx-oletusasetustiedosto poistaaksesi default_serverrivin.

sudo sed -i 's/default_server//g' /etc/nginx/nginx.conf

Luo uusi määritystiedosto Buildbot-verkkoliittymälle.

sudo nano /etc/nginx/conf.d/buildbot.conf

Täytä tiedosto.

upstream buildbot {
server 127.0.0.1:8010;
}

server {
    listen 80 default_server;
    server_name ci.example.com;
    return 301 https://$host$request_uri;
}

server {
    listen 443 ssl http2 default_server;
    server_name ci.example.com;

    root html;
    index index.html index.htm;

    ssl on;
    ssl_certificate         /etc/letsencrypt/live/ci.example.com/fullchain.pem;
    ssl_certificate_key     /etc/letsencrypt/live/ci.example.com/privkey.pem;

    ssl_session_cache      shared:SSL:10m;
    ssl_session_timeout  1440m;
    ssl_protocols  TLSv1 TLSv1.1 TLSv1.2;
    ssl_ciphers HIGH:!aNULL:!eNULL:!EXPORT:!CAMELLIA:!DES:!MD5:!PSK:!RC4;
    ssl_prefer_server_ciphers on;

    add_header Strict-Transport-Security "max-age=31536000; includeSubdomains;";

    access_log  /var/log/nginx/buildbot.access.log;

    proxy_set_header HOST $host;
    proxy_set_header X-Real-IP $remote_addr;
    proxy_set_header X-Forwarded-For $proxy_add_x_forwarded_for;
    proxy_set_header X-Forwarded-Proto  $scheme;
    proxy_set_header X-Forwarded-Server  $host;
    proxy_set_header X-Forwarded-Host  $host;

    location / {
        proxy_pass http://buildbot;
    }
    location /sse/ {
        proxy_buffering off;
        proxy_pass http://buildbot/sse/;
    }
    location /ws {
        proxy_http_version 1.1;
        proxy_set_header Upgrade $http_upgrade;
        proxy_set_header Connection "upgrade";
        proxy_pass http://buildbot/ws;
        proxy_read_timeout 6000s;
    }
}

Tarkista, onko uudessa asetustiedostossa virheitä.

sudo nginx -t

Jos näet seuraavan lähdön, kokoonpano on virheetön.

[user@vultr ~]$ sudo nginx -t
nginx: the configuration file /etc/nginx/nginx.conf syntax is ok
nginx: configuration file /etc/nginx/nginx.conf test is successful

Jos olet saanut jonkinlaisen virheilmoituksen, muista tarkistaa SSL-varmenteiden polku. Käynnistä Nginx-verkkopalvelin uudelleen konfiguraatiomuutoksen toteuttamiseksi.

sudo systemctl restart nginx

Avaa Buildmaster-määritystiedosto.

sudo su buildbot -c "nano /home/buildbot/master/master.cfg"

Etsi seuraava rivi.

c['buildbotURL'] = "http://192.168.1.1:8010/"

Muuta URL-osoite käyttämäsi verkkotunnuksen mukaan.

c['buildbotURL'] = "https://ci.example.com/"

Käynnistä Buildbot-pääpalvelu uudelleen.

sudo systemctl restart buildbot

Nyt voit käyttää Buildbot-hallintapaneelia osoitteessa https://ci.example.com. Näet, että yhteydet Buildbotiin on nyt suojattu SSL:llä.

Kirjaudu sisään järjestelmänvalvojan tunnuksilla ja aloita sovelluksesi rakentaminen lisäämällä ensimmäinen putki.