🥇Kogume oma Nginx'i paarist käskudest

Tere!
Minu nimi on Sergei, ma töötan infrastruktuuriinsenerina tinkoff.ru API platvormi meeskonnas.

Selles artiklis räägin probleemidest, millega meie meeskond silmitsi seisis tasakaalustajate seadistamisel, mis põhinevad Nginx erinevate projektide jaoks. Räägin ka tööriistast, mis aitas enamik probleeme ületada.

Nginx on multifunktsionaalne ja aktiivselt arenev pöördusserver. Sellel on palju mooduleid, siin on vaid mittetäielik nimekiri. Igal projektijal on teatud nõuded tasakaalustaja funktsionaalsusele ja Nginx-i versioonile (näiteks http/2 toe ja grpc edastamine) ning selle moodulite komplektile.

Soovime näha uut versiooni vajaliku moodulite komplektiga, töötamas kindlal Linuxi distributsioonil. Meie puhul on need deb- ja rpm-põhised süsteemid. Konteinerite varianti ei käsitleta käesolevas artiklis.

Soovime kiiresti muuta oma tasakaalustajate funktsionaalsust. Ja siin kerkib kohe küsimus — kuidas seda saavutada, kasutades võimalikult vähe ressursse? Ja veel parem, kui saaksime organiseerida protsessi nii, et saaksime sisendparameetreid määratleda ja väljundina saada artefakti deb/rpm paketi kujul vajaliku operatsioonisüsteemi jaoks.

Seetõttu saame sõnastada mitmed probleemid:

Ei ole alati saadaval pakette uue Nginx-i versiooniga.
Ei ole pakette vajalike moodulitega.
Paketi käsitsi kompileerimine ja koostamine võtab palju aega ning on lihtsalt väsitav.
Ei ole kirjeldust selle kohta, kuidas on kokku pandud teatud Nginx-i instants.

Nende probleemide lahendamiseks tuleb leida tööriist, mis võtaks vastu spetsifitseeringu inimloetavas vormingus ja koostaks selle põhjal vajalikku funktsionaalsust pakkuva Nginx-i paketi.

Leides GitHubist sobivat varianti ei õnnestunud, otsustasime luua oma tööriista — nginx-builder.

Spetsifikatsioonid

Meie tööriistas soovisime luua spetsifikatsiooni kirjelduse koodi kujul, mille seejärel võiks panna Git-repositooriumisse. Selleks valisime selliste asjade jaoks tuttava formaadi — yaml. Spetsifikatsiooni näide:

nginx_version: 1.14.1
output_package: deb
modules:
  - module:
      name: nginx-auth-ldap
      git_url: https://github.com/kvspb/nginx-auth-ldap.git
      git_branch: master
      dependencies:
        - libldap2-dev
  - module:
      name: ngx_http_substitutions_filter_module
      git_url: https://github.com/yaoweibin/ngx_http_substitutions_filter_module.git
  - module:
      name: headers-more-nginx-module
      web_url: https://github.com/openresty/headers-more-nginx-module/archive/v0.261.zip
  - module:
      name: nginx-module-vts
      git_url: https://github.com/vozlt/nginx-module-vts.git
      git_tag: v0.1.18
  - module:
      name: ngx_devel_kit
      git_url: https://github.com/simplresty/ngx_devel_kit.git
      git_tag: v0.3.0
  - module:
      name: ngx_cache_purge
      git_url: https://github.com/FRiCKLE/ngx_cache_purge.git
  - module:
      name: ngx_http_dyups_module
      git_url: https://github.com/yzprofile/ngx_http_dyups_module.git
  - module:
      name: nginx-brotli
      git_url: https://github.com/eustas/ngx_brotli.git
      git_tag: v0.1.2
  - module:
      name: nginx_upstream_check_module
      git_url: https://github.com/yaoweibin/nginx_upstream_check_module.git
  - module:
      name: njs
      git_url: https://github.com/nginx/njs.git
      git_tag: 0.2.5
      config_folder_path: nginx

Siin määrame, et tahame näha deb-paketti versiooniga Nginx 1.14.2 ja soovitud moodulite kogum. Moodulite sektsioon on valikuline. Igaühe jaoks saab määrata:

Nimi.
Aadress, kus see saadaval on:
- Git-repositoorium. Samuti saab määrata haru või sildi.
- Veebiviide arhiivile.
- Kohalik link arhiivile.

Mõned moodulid vajavad täiendavate sõltuvuste installimist, näiteks nginx-auth-ldap jaoks on vajalik libldap2-dev. Vajalikud sõltuvused saab samuti määrata mooduli kirjelduses.

Keskkond

Meie tööriist võimaldab kiiresti hankida keskkonna koos installitud utiliitidega paketi kompileerimiseks, ehitamiseks ja muuks abitarkvaraks. Siin sobib kõige paremini docker-konteiner, milles on kõik vajalik (repositooriumis on juba paar docker-faili näidet ubuntu ja centos jaoks).

Pärast spetsifikatsiooni koostamist ja keskkonna ettevalmistamist käivitame meie kogujat, eelnevalt installides selle sõltuvused:

pip3 install -r requirements.txt
./main.py build -f [konfig_fail].yaml -r [reviseerimise_numbriga]

Reviseerimisnumber on siia valikuline ja teenib versioonide haldamise eesmärki. See kantakse paketi meta-informatsiooni, mis võimaldab seda serverites hõlpsasti uuendada.
Logide kaudu saab jälgida, mis toimub. Siin on näide peamistest hetkedest:

builder - INFO - Yaml faili parsimine: example.config.yaml
builder - INFO - Skriptide allalaadimine deb paketi ehitamiseks
builder - INFO - Allalaadimine nginx src...
builder - INFO - --> http://nginx.org/download/nginx-1.14.1.tar.gz
builder - INFO - Allalaadimine 3d-party mooduleid...
builder - INFO - Moodul nginx-auth-ldap laaditakse alla harult
builder - INFO - -- Tehtud: nginx-auth-ldap
builder - INFO - -- Tehtud: ngx_http_substitutions_filter_module
builder - INFO - Moodul headers-more-nginx-module laaditakse alla
builder - INFO - Moodul nginx-module-vts laaditakse alla sildi järgi
builder - INFO - -- Tehtud: nginx-module-vts
builder - INFO - Moodul ngx_devel_kit laaditakse alla sildi järgi
builder - INFO - -- Tehtud: ngx_devel_kit
builder - INFO - -- Tehtud: ngx_cache_purge
builder - INFO - -- Tehtud: ngx_http_dyups_module
builder - INFO - Allalaadimine sõltuvustest
builder - INFO - .deb paketi ehitamine
builder - INFO - Käivitamine 'dh_make'...
builder - INFO - Käivitamine 'dpkg-buildpackage'...
dpkg-deb: ehitamine pakett 'nginx' asukohas '..\/nginx_1.14.1-1_amd64.deb'.

Nii, paarikaupa käsuga loome keskkonna ja vajaliku Nginx'i ehituse, ning pakett ilmub katalooge, millest skript käivitatakse.

Sisseehitamine

Samuti saame oma tööriista integreerida CI/CD protsessidesse. Seda saab aidata üks paljusid tänapäeval olemasolevaid CI süsteeme, näiteks Teamcity või Gitlab CI.

Lõppkokkuvõttes käivitatakse artefakti koostamine automaatselt iga muudatuse korral spetsifikatsioonis Git-i repos.
Veidi rohkem aega investeerides on võimalik seadistada artefakti saatmine kohalikku pakettide hoidlasse, Nexus, Artifactory jne.

Lisaeelisena on see, et konfigureerimise yaml-faili saab integreerida Ansible'i või muusse automaatse konfigureerimise süsteemi, ning võtta sealt versiooni ja paketi tüübi numbrid, mida soovime juurutada.

Mis edasi

Projekt ei ole veel lõpetatud. Siin on, millega me praegu töötame:

Kohandamise võimaluste laiendamine, säilitades samal ajal selle võimalikult lihtsana. Ei taha määrata tuhandet parameetrit, kui vajame vaid kahte, samas kui ülejäänud sobib vaikimisi. See hõlmab kompileerimise lippe (praegu saab neid muuta sisemises konfigureerimise failis src/config.py), installimise teed, kasutajat käivitamiseks.
Lisame võimalused paketi automaatseks saatmiseks erinevatesse artefaktide hoidlatesse.
Kasutaja käsu täitmine mooduli laadimisel (nt kasutamiseks github.com/nginx-modules/nginx_upstream_check_module peab esmalt rakendama teatud versiooni paranduse)
Lisame testide teostamise:
- Pakett installitakse õigesti.
- Nginx'il on vajalik versioon ja see on koostatud vajalike lippude ja moodulitega.
- Loodud on vajalikud teed, kontod jne.

Kuid saate seda tööriista juba praegu kasutada ning pakkuda täiustusi — github.com/TinkoffCreditSystems/Nginx-builder teretulemast!

Allikas: habr.com

Kogume oma Nginx-i paari käsuga

Spetsifikatsioonid

Keskkond

Sisseehitamine

Mis edasi