Puppet je sustav za upravljanje konfiguracijom. Koristi se za vraćanje hostova u željeno stanje i održavanje tog stanja.
Radim s Puppetom više od pet godina. Ovaj tekst je u suštini prevedena i reorganizirana kompilacija ključnih točaka iz službene dokumentacije, koja će novacima omogućiti brzo snalaženje u suštini Puppeta.

Osnovne informacije
Shema rada Puppeta je klijent-server, iako postoji i opcija rada bez servera s ograničenom funkcionalnošću.
Koristi se pull-model rada: prema zadanim postavkama klijenti svakih pola sata dolaze do servera po konfiguraciju i primjenjuju je. Ako ste radili s Ansibleom, tamo se koristi drugačiji, push-model: administrator inicira proces primjene konfiguracije, klijenti sami po sebi ništa ne primjenjuju.
Pri mrežnoj komunikaciji koristi se dvosmjerno TLS-enkripcija: server i klijent imaju svoje privatne ključeve i odgovarajuće certifikate. Obično server izdaje certifikate za klijente, ali u načelu je moguće korištenje i vanjskog CA.
Upoznavanje s manifestima
U terminologiji Puppeta k puppetskom serveru priključuju se nodi (nodes). Konfiguracija za nodove piše se u manifestima na posebnom programskom jeziku - Puppet DSL.
Puppet DSL je deklarativni jezik. Na njemu se opisuje željeno stanje nodova u vidu deklaracije pojedinih resursa, na primjer:
- Datoteka postoji i ima određeni sadržaj.
- Paket je instaliran.
- Servis je pokrenut.
Resursi mogu biti međusobno povezani:
- Postoje ovisnosti, one utječu na redoslijed primjene resursa.
Na primjer, "prvo instaliraj paket, zatim ispravi konfiguracijsku datoteku, nakon toga pokreni servis." - Postoje obavijesti - ako se resurs promijeni, šalje obavijesti resursima koji su na njega pretplaćeni.
Na primjer, ako se mijenja konfiguracijska datoteka, može se automatski ponovno pokrenuti servis.
Osim toga, u Puppet DSL postoje funkcije i varijable, kao i uvjetni operatori i selektori. Također se podržavaju različiti mehanizmi predložaka - EPP i ERB.
Puppet je napisan na Rubyju, pa su mnoge konstrukcije i termini preuzeti odatle. Ruby omogućuje proširivanje Puppeta - dodavanje složene logike, novih tipova resursa, funkcija.
Tijekom rada Puppet-a manifesti za svaku specifičnu nodu na serveru se kompajliraju u katalog. Katalog — je lista resursa i njihovih međusobnih odnosa nakon izračunavanja vrijednosti funkcija, varijabli i razotkrivanja uvjetnih operatora.
Sintaksa i stil kodiranja
Ovdje su odjeljci službene dokumentacije koji će pomoći u razumijevanju sintakse, ako navedeni primjeri budu nedovoljni:
Evo primjera kako izgleda manifest:
# Комментарии пишутся, как и много где, после решётки.
#
# Описание конфигурации ноды начинается с ключевого слова node,
# за которым следует селектор ноды — хостнейм (с доменом или без)
# или регулярное выражение для хостнеймов, или ключевое слово default.
#
# После этого в фигурных скобках описывается собственно конфигурация ноды.
#
# Одна и та же нода может попасть под несколько селекторов. Про приоритет
# селекторов написано в статье про синтаксис описания нод.
node 'hostname', 'f.q.d.n', /regexp/ {
# Конфигурация по сути является перечислением ресурсов и их параметров.
#
# У каждого ресурса есть тип и название.
#
# Внимание: не может быть двух ресурсов одного типа с одинаковыми названиями!
#
# Описание ресурса начинается с его типа. Тип пишется в нижнем регистре.
# Про разные типы ресурсов написано ниже.
#
# После типа в фигурных скобках пишется название ресурса, потом двоеточие,
# дальше идёт опциональное перечисление параметров ресурса и их значений.
# Значения параметров указываются через т.н. hash rocket (=>).
resource { 'title':
param1 => value1,
param2 => value2,
param3 => value3,
}
}Udaljenosti i prijelomi redaka nisu obavezni dijelovi manifesta, međutim postoji preporučeni . Kratak pregled:
- Dva razmaka se koriste za udubine, tabovi se ne koriste.
- Vitičaste zagrade odvajaju se razmakom, a dvotočka se ne odvaja razmakom.
- Zarezi nakon svakog parametra, uključujući posljednji. Svaki parametar je na zasebnoj liniji. Izuzetak se pravi za slučaj bez parametara i jedan parametar: može se pisati u istoj liniji i bez zareza (tj.
resource { 'title': }iresource { 'title': param => value }). - Strelice kod parametara trebaju biti na istoj razini.
- Strelice međusobnih odnosa resursa pišu se ispred njih.
Lokacija datoteka na puppets serveru
Za daljnja objašnjenja uvest ću pojam 'korijenska direktorija'. Korijenska direktorija je direktorija u kojoj se nalazi Puppet konfiguracija za specifičnu nodu.
Korijenska direktorija se razlikuje ovisno o verziji Puppet-a i korištenju okruženja. Okruženja su neovisni setovi konfiguracije koji se čuvaju u zasebnim direktorijima. Obično se koriste u kombinaciji s gitom, u tom slučaju se okruženja stvaraju iz git grana. Prema tome, svaka nod se nalazi u nekom okruženju. To se postavlja na samoj nod, ili u ENC-u, o čemu ću pričati u sljedećem članku.
- U trećoj verziji ('stari Puppet') osnovna direktorija bila je
/etc/puppet. Korištenje okruženja je opcionalno — mi, na primjer, ih ne koristimo sa starim Puppet-om. Ako se okruženja koriste, obično se čuvaju u/etc/puppet/environments, osnovna direktorija će biti direktorija okruženja. Ako se okruženja ne koriste, osnovna direktorija će biti osnovna. - Počevši od četvrte verzije ('novi Puppet') korištenje okruženja postalo je obavezno, a osnovna direktorija je premještena u
/etc/puppetlabs/code. Okruženja se stoga čuvaju u/etc/puppetlabs/code/environments, korijenska direktorij - direktorij okruženja.
U korijenskoj direktoriji treba biti poddirektorij manifests, u kojoj se nalaze jedan ili više manifestacija s opisom čvorova. Osim toga, tu bi trebala biti poddirektorij modules, u kojoj se nalaze moduli. O modulima ću pričati malo kasnije. Također, u starom Pappetu može biti poddirektorij files, u kojoj se nalaze razni datoteke koje kopiramo na čvorove. U novom Pappetu svi su datoteke premješteni u module.
Datoteke manifestacija imaju ekstenziju .pp.
Primjeri u praksi
Opis čvora i resursa na njemu
Na čvoru server1.testdomain treba biti stvorena datoteka /etc/issue s sadržajem Debian GNU/Linux n l. Datoteka mora pripadati korisniku i grupi root, prava pristupa trebaju biti 644.
Pišemo manifest:
node 'server1.testdomain' { # konfiguracijski blok koji se odnosi na čvor server1.testdomain
file { ' /etc/issue': # opisujući datoteku /etc/issue
ensure => present, # ova datoteka mora postojati
content => 'Debian GNU/Linux n l', # trebala bi imati ovakav sadržaj
owner => root, # korisnik-vlasnik
group => root, # grupa-vlasnik
mode => '0644', # prava na datoteku. Postavljena su kao string (u navodnicima), jer bi inače broj s 0 na početku bio tretiran kao napisan u osmičnom sustavu, i sve bi otišlo naopako
}
}Međusobni odnosi resursa na čvoru
Na čvoru server2.testdomain treba pokrenuti nginx s unaprijed pripremljenom konfiguracijom.
Dekomponeiramo zadatak:
- Potreban je instaliran paket
nginx. - Potreban je kopiranje konfiguracijskih datoteka s poslužitelja.
- Potreban je pokrenut servis
nginx. - U slučaju ažuriranja konfiguracije, potrebno je ponovo pokrenuti servis.
Pišemo manifest:
čvor 'server2.testdomain' { # konfiguracijska blok koji se odnosi na čvor server2.testdomain
paket { 'nginx': # opisujemo paket nginx
osiguraj => instaliran, # mora biti instaliran
}
# Izravna strelica (->) ukazuje da resurs ispod mora
# biti stvoren nakon resursa opisanog iznad.
# Takve zavisnosti su tranzitivne.
-> datoteka { '/etc/nginx': # opisujemo datoteku /etc/nginx
osiguraj => direktorij, # to treba biti direktorij
izvor => 'puppet:///modules/example/nginx-conf', # sadržaj treba uzeti s puppet servera na navedenu adresu
rekurzivno => true, # kopira datoteke rekurzivno
pročišćavanje => true, # treba ukloniti nepotrebne datoteke (one koje nisu u izvoru)
prisili => true, # ukloniti nepotrebne direktorije
}
# Valovita strelica (~>) ukazuje da resurs ispod mora
# prijaviti se na promjene resursa opisanog iznad.
# Valovita strelica uključuje izravnu (->).
~> usluga { 'nginx': # opisujemo uslugu nginx
osiguraj => radi, # mora biti pokrenut
omogućiti => true, # treba ga automatski pokretati prilikom pokretanja sustava
}
# Kada resurs tipa usluga primi obavijest,
# odgovarajuća usluga se ponovno pokreće.
}Da bi to radilo, potrebna je otprilike takva struktura datoteka na puppet serveru:
/etc/puppetlabs/code/environments/production/ # (это для нового Паппета, для старого корневой директорией будет /etc/puppet)
├── manifests/
│ └── site.pp
└── modules/
└── example/
└── files/
└── nginx-conf/
├── nginx.conf
├── mime.types
└── conf.d/
└── some.confTipovi resursa
Puni popis podržanih tipova resursa nalazi se , ovdje ću opisati pet osnovnih tipova koji su mi u praksi dovoljni za rješavanje većine zadataka.
datoteka
Upravlja datotekama, direktorijima, simboličkim linkovima, njihovim sadržajem, pravima pristupa.
Parametri:
- naziv resursa — put do datoteke (opcionalno)
- path — put do datoteke (ako nije zadano u nazivu)
- osiguraj — tip datoteke:
odsutan— ukloni datotekuprisutna— mora biti datoteka bilo kojeg tipa (ako datoteka ne postoji — bit će kreirana obična datoteka)datoteka— obična datotekadirektorij— direktorijlink— simbolički link
- sadržaj — sadržaj datoteke (prikladno samo za obične datoteke, ne može se koristiti zajedno sa source ili cilj)
- source — referenca na put iz kojeg treba kopirati sadržaj datoteke (ne može se koristiti zajedno sa sadržaj ili cilj). Može biti zadano i u obliku URI sa shemom
puppet:(tada će se koristiti datoteke s puppet servera), kao i sa shemomhttp:(nadam se da je jasno što će biti u tom slučaju), pa čak i sa shemomfile:ili u obliku apsolutnog puta bez sheme (tada će se koristiti datoteka s lokalnog FS na čvoru) - cilj — gdje treba usmjeravati simboličku vezu (ne može se koristiti zajedno s sadržaj ili source)
- vlasnik — korisnik kojem datoteka treba pripadati
- grupa — grupa kojoj datoteka treba pripadati
- način — prava za datoteku (u obliku niza)
- rekurzivno — uključuje rekurzivnu obradu direktorija
- ukloni — uključuje brisanje datoteka koje nisu opisane u Puppet-u
- primijeni — uključuje brisanje direktorija koji nisu opisani u Puppet-u
paket
Instalira i uklanja pakete. Može obraditi obavijesti — ponovo instalira paket ako je postavljen parametar ponovno_instaliraj_prilikom_osvježavanja.
Parametri:
- naziv resursa — naziv paketa (opcionalno)
- ime — naziv paketa (ako nije postavljen u nazivu)
- dobavljač — upravitelj paketa koji treba koristiti
- osiguraj — željeno stanje paketa:
prisutna,instalirano— instalirana bilo koja verzijanajnovije— instalirana najnovija verzijaodsutan— uklonjena (apt-get remove)uklonjeno— uklonjeno zajedno s konfiguracijskim datotekama (apt-get purge)zadržano— verzija paketa je blokirana (apt-mark hold)bilo koja druga niza— instalirana specificirana verzija
- ponovno_instaliraj_prilikom_osvježavanja — ako
true, tada će se paket ponovno instalirati prilikom primanja obavijesti. Korisno za distribucije temeljene na izvoru gdje ponovna izgradnja paketa može biti potrebna kada se promijene parametri izgradnje. Zadanofalse.
usluga
Upravlja uslugama. Može obraditi obavijesti — ponovno pokreće uslugu.
Parametri:
- naziv resursa — usluga kojom treba upravljati (opcionalno)
- ime — usluga kojom treba upravljati (ako nije postavljena u nazivu)
- osiguraj — željeno stanje usluge:
pokrenuto— pokrenutozaustavljeno— zaustavljeno
- omogućiti — upravlja mogućnošću pokretanja usluge:
true— uključeno automatsko pokretanje (systemctl enable)maskirati— maskirano (systemctl mask)false— isključeno automatsko pokretanje (systemctl disable)
- ponovno pokreni — naredba za ponovno pokretanje usluge
- status — naredba za provjeru statusa usluge
- ima_ponovno_pokretanje — odrediti podržava li init skripta usluge ponovno pokretanje. Ako
falsei je postavljen parametar ponovno pokreni — koristi se vrijednost tog parametra. Akofalsei parametar ponovno pokreni nije postavljen — usluga se zaustavlja i pokreće radi ponovnog pokretanja (ali u systemd se koristi naredbasystemctl restart). - ima_status — odrediti podržava li init skripta usluge naredbu
status. Akofalse, tada se koristi vrijednost parametra status. Zadanotrue.
exec
Pokreće vanjske naredbe. Ako se ne postave parametri stvara, samo_ako, osim ili samo_osvježi, naredba će se pokrenuti pri svakoj iteraciji Pappa. Može obraditi obavijesti — pokreće naredbu.
Parametri:
- naziv resursa — naredba koja se treba izvršiti (opcionalno)
- naredba — naredba koja se treba izvršiti (ako nije navedena u imenu)
- path — putevi u kojima tražiti izvršni fajl
- samo_ako — ako je navedena naredba u ovom parametru završila s nul-kodom vraćanja, osnovna naredba će se izvršiti
- osim — ako je navedena naredba u ovom parametru završila s nenul-kodom vraćanja, osnovna naredba će se izvršiti
- stvara — ako navedeni fajl u ovom parametru ne postoji, osnovna naredba će se izvršiti
- samo_osvježi — ako
true, tada će se naredba pokrenuti samo ako ovaj exec primi obaveštenje od drugih resursa - cwd — direktorij iz kojeg se izvršava naredba
- korisnik — korisnik koji pokreće naredbu
- dobavljač — pomoću čega pokrenuti naredbu:
- posix — samo se kreira podproces, obavezno navesti path
- shell — naredba se pokreće u shellu
/bin/sh, neobavezno path, može se koristiti globbing, cevi i druge mogućnosti shella. Obično se određuje automatski, ako postoje specijalni simboli (|,;,&&,||i tako dalje).
cron
Upravlja cron poslovima.
Parametri:
- naziv resursa — jednostavno neki identifikator
- osiguraj — stanje cron posla:
prisutna— kreirati, ako ne postojiodsutan— ukloniti, ako postoji
- naredba — koju naredbu izvršiti
- okruženje — u kojem okruženju se pokreće naredba (lista promenljivih okruženja i njihovih vrednosti kroz
=) - korisnik — od kojeg korisnika se pokreće naredba
- minut, sat, dan u nedelji, mesec, dan u mesecu — kada pokrenuti cron. Ako neki od ovih atributa nije naveden, njegova vrednost u crontabu će biti
*.
U Puppet 6.0 cron na neki način u puppetserveru, stoga nema dokumentacije na opštem sajtu. Ali on u puppet-agentu, stoga ga ne treba instalirati posebno. Dokumentaciju o njemu možete pogledati , ili .
O resursima uopšte
Zahtevi za jedinstvenost resursa
Najčešća greška sa kojom se susrećemo — Duplicate declaration. Ova greška se javlja kada u katalog dođu dva ili više resursa istog tipa sa istim imenom.
Zato ću još jednom napisati: u manifestima za jednu nodu ne bi trebalo biti resursa istog tipa s istim imenom (title)!
Ponekad postoji potreba da se instaliraju paketi istog imena, ali različitim menadžerima paketa. U tom slučaju treba koristiti parametar ime, kako biste izbjegli pogrešku:
package { 'ruby-mysql':
ensure => installed,
name => 'mysql',
provider => 'gem',
}
package { 'python-mysql':
ensure => installed,
name => 'mysql',
provider => 'pip',
}U drugim tipovima resursa postoje slični parametri koji pomažu u izbjegavanju dupliciranja — ime u usluga, naredba u exec, i tako dalje.
Metaparametri
Neki posebni parametri postoje za svaki tip resursa, neovisno o njegovoj suštini.
Potpuni popis metaparametara .
Kratki popis:
- require — u ovom parametru navodi se od kojih resursa ovisi ovaj resurs.
- before — u ovom parametru navodi se koji resursi ovise o ovom resursu.
- subscribe — u ovom parametru navodi se od kojih resursa prima obavijesti ovaj resurs.
- notify — u ovom parametru navodi se koji resursi primaju obavijesti od ovog resursa.
Svi navedeni metaparametri prihvaćaju ili jednu referencu na resurs, ili niz referenci u kvadratnim zagradama.
Reference na resurse
Referenca na resurs je samo spominjanje resursa. Koriste se uglavnom za navođenje zavisnosti. Referenca na nepostojeći resurs izazvat će pogrešku pri kompilaciji.
Sintaksa reference je sljedeća: tip resursa s velikim početnim slovom (ako u nazivu tipa postoje dvostruke dvotočke, svaka se komponenta između dvotočaka piše s velikim slovom), zatim u kvadratnim zagradama ime resursa (veličina slova u nazivu ostaje nepromijenjena!). Ne smije biti razmaka, kvadratne zagrade se pišu odmah nakon naziva tipa.
Primjer:
file { '/file1': ensure => present }
file { '/file2':
ensure => directory,
before => File['/file1'],
}
file { '/file3': ensure => absent }
File['/file1'] -> File['/file3']Zavisnosti i obavijesti
Kao što je već rečeno, jednostavne zavisnosti između resursa su tranzitivne. Usput, budite oprezni prilikom postavljanja zavisnosti — moguće je napraviti ciklične zavisnosti, što će izazvati pogrešku pri kompilaciji.
Za razliku od zavisnosti, obavijesti nisu tranzitivne. Za obavijesti važe sljedeća pravila:
- Ako resurs primi obavijest, ažurira se. Radnje pri ažuriranju ovise o vrsti resursa — exec pokreće komandnu uputu, usluga ponovno pokreće servis, paket ponovno instalira paket. Ako za resurs nije definirana radnja prilikom ažuriranja, tada se ništa ne događa.
- Tijekom jednog prolaza, Puppet će ažurirati resurs najviše jednom. To je moguće jer obavijesti uključuju ovisnosti, a graf ovisnosti ne sadrži cikluse.
- Ako Puppet promijeni stanje resursa, resurs šalje obavijesti svim resursima koji su na njega pretplaćeni.
- Ako se resurs ažurira, šalje obavijesti svim resursima koji su na njega pretplaćeni.
Obrada neodređenih parametara
U pravilu, ako neki parametar resursa nema zadanu vrijednost i taj parametar nije naveden u manifestu, Puppet neće mijenjati tu osobinu odgovarajućeg resursa na čvoru. Na primjer, ako resurs tipa datoteka nema navedeni parametar vlasnik, Puppet neće mijenjati vlasnika odgovarajuće datoteke.
Upoznavanje s klasama, varijablama i definicijama
Pretpostavimo da imamo nekoliko čvorova na kojima postoji isti dio konfiguracije, ali i razlike – inače bismo sve to mogli opisati u jednom bloku. node {}. Naravno, možemo jednostavno kopirati iste dijelove konfiguracije, ali općenito je to loše rješenje – konfiguracija se povećava, i pri promjeni zajedničkog dijela konfiguracije, morat ćemo mijenjati isto na mnogo mjesta. U isto vrijeme, lako se možemo prevariti, a princip DRY (ne ponavljaj se) nije slučajno izmišljen.
Za rješavanje takvog problema postoji konstrukcija koja se zove klasa.
Klasama
je imenovani blok Puppet koda. Klase su potrebne za ponovnu upotrebu koda.
Prvo je potrebno opisati klasu. Samo opisivanje ne dodaje nikakve resurse. Klasa se opisuje u manifestima:
# Описание класса начинается с ключевого слова class и его названия.
# Дальше идёт тело класса в фигурных скобках.
class example_class {
...
}Nakon toga klasu možemo koristiti:
# первый вариант использования — в стиле ресурса с типом class
class { 'example_class': }
# второй вариант использования — с помощью функции include
include example_class
# про отличие этих двух вариантов будет рассказано дальшеPrimjer iz prethodnog zadatka – izdvojimo instalaciju i konfiguraciju nginx-a u klasu:
class nginx_example {
package { 'nginx':
ensure => installed,
}
-> file { '/etc/nginx':
ensure => directory,
source => 'puppet:///modules/example/nginx-conf',
recurse => true,
purge => true,
force => true,
}
~> service { 'nginx':
ensure => running,
enable => true,
}
}
node 'server2.testdomain' {
include nginx_example
}Varijable
Klasa iz prethodnog primjera nije fleksibilna, jer uvijek donosi istu konfiguraciju nginx-a. Učnimo da put do konfiguracije postane varijablom, tada će se ova klasa moći koristiti za instalaciju nginx-a s bilo kojom konfiguracijom.
To se može učiniti .
Pozor: varijable u Puppet-u su nepromjenjive!
Osim toga, varijablu možete koristiti samo nakon što je deklarirana, inače će vrijednost varijable biti undef.
Primjer rada s varijablama:
# создание переменных
$variable = 'value'
$var2 = 1
$var3 = true
$var4 = undef
# использование переменных
$var5 = $var6
file { '/tmp/text': content => $variable }
# интерполяция переменных — раскрытие значения переменных в строках. Работает только в двойных кавычках!
$var6 = "Variable with name variable has value ${variable}"U Puppet-u postoje imenska prostora, a varijable imaju opseg vidljivosti: varijabla s istim imenom može biti definirana u različitim imenskim prostorima. Tijekom rješavanja vrijednosti varijable, ona se traži u trenutnom prostoru imena, zatim u obuhvatnom, i tako dalje.
Primjeri imenskih prostora:
- globalno — ovdje se nalaze varijable izvan opisa klase ili nod-a;
- prostor imena nod-a u opisu nod-a;
- prostor imena klase u opisu klase.
Da biste izbjegli dvosmislenost prilikom pristupanja varijabli, možete odrediti prostor imena u imenu varijable:
# переменная без пространства имён
$var
# переменная в глобальном пространстве имён
$::var
# переменная в пространстве имён класса
$classname::var
$::classname::varDogovorimo se da putanja do konfiguracije nginx leži u varijabli $nginx_conf_source. Tada će klasa izgledati ovako:
class nginx_example {
package { 'nginx':
ensure => installed,
}
-> file { '/etc/nginx':
ensure => directory,
source => $nginx_conf_source, # ovdje koristimo varijablu umjesto fiksnog niza
recurse => true,
purge => true,
force => true,
}
~> service { 'nginx':
ensure => running,
enable => true,
}
}
node 'server2.testdomain' {
$nginx_conf_source = 'puppet:////modules/example/nginx-conf'
include nginx_example
}Međutim, navedeni primjer nije dobar jer postoji neko "tajno znanje" o tome da se unutar klase koristi varijabla s određenim imenom. Daleko je ispravnije učiniti to znanje javnim — klase mogu imati parametre.
Parametri klase — to su varijable u prostoru imena klase, definiraju se u zaglavlju klase i mogu se koristiti kao obične varijable unutar tijela klase. Vrijednosti parametara se definiraju pri korištenju klase u manifestu.
Parametru se može dodijeliti vrijednost prema zadanim postavkama. Ako parametar nema vrijednost prema zadanim postavkama i vrijednost nije određena prilikom korištenja, doći će do pogreške u kompilaciji.
Parametrizirajmo klasu iz gornjeg primjera i dodajmo dva parametra: prvi, obavezan — put do konfiguracije, i drugi, neobavezan — naziv paketa s nginxom (u Debianu, na primjer, postoje paketi nginx, nginx-light, nginx-full).
# переменные описываются сразу после имени класса в круглых скобках
class nginx_example (
$conf_source,
$package_name = 'nginx-light', # параметр со значением по умолчанию
) {
package { $package_name:
ensure => installed,
}
-> file { '/etc/nginx':
ensure => directory,
source => $conf_source,
recurse => true,
purge => true,
force => true,
}
~> service { 'nginx':
ensure => running,
enable => true,
}
}
node 'server2.testdomain' {
# если мы хотим задать параметры класса, функция include не подойдёт* — нужно использовать resource-style declaration
# *на самом деле подойдёт, но про это расскажу в следующей серии. Ключевое слово "Hiera".
class { 'nginx_example':
conf_source => 'puppet:///modules/example/nginx-conf', # задаём параметры класса точно так же, как параметры для других ресурсов
}
}U Puppet-u su varijable tipizirane. Postoji . Tipovi podataka se obično koriste za validaciju vrijednosti parametara koji se prosljeđuju u klase i definicije. Ako proslijeđeni parametar ne odgovara navedenom tipu, doći će do greške prilikom kompajliranja.
Tip se piše neposredno ispred imena parametra:
class example (
String $param1,
Integer $param2,
Array $param3,
Hash $param4,
Hash[String, String] $param5,
) {
...
}Klase: include classname vs class{‘classname’:}
Svaka klasa je resursnog tipa class. Kao i kod bilo kojih drugih tipova resursa, na jednoj nodi ne može postojati dva instance iste klase.
Ako pokušaš dodati klasu na istu nodu dva puta pomoću class { 'classname':} (bez obzira na to jesu li parametri različiti ili identični), doći će do greške prilikom kompajliranja. Međutim, u slučaju korištenja klase u stilu resursa, možeš odmah u manifestu jasno dodati sve njene parametre.
Međutim, ako se koristi include, tada se klasa može dodavati koliko god puta hoćeš. Naime, include je idempotentna funkcija koja provjerava da li je klasa dodana u direktorij. Ako klasa nije u direktoriju – dodaje je, a ako već postoji, ne radi ništa. Ali u slučaju korištenja include ne mogu se odrediti parametri klase tijekom njenog deklariranja – svi obavezni parametri moraju biti navedeni u vanjskom izvoru podataka – Hiera ili ENC. O njima ćemo razgovarati u sljedećem članku.
Definisi
Kao što je rečeno u prethodnom bloku, ista klasa ne može biti prisutna na nodi više od jednom. Međutim, u nekim slučajevima treba imati mogućnost primijeniti isti blok koda s različitim parametrima na jednoj nodi. Drugim riječima, postoji potreba za vlastitim tipom resursa.
Na primjer, da bismo instalirali PHP modul, u Avitu radimo sljedeće:
- Instaliramo paket sa ovim modulom.
- Stvaramo konfiguracijski fajl za ovaj modul.
- Stvaramo simboličku poveznicu na konfiguraciju za php-fpm.
- Stvaramo simboličku poveznicu na konfiguraciju za php cli.
U takvim slučajevima koristi se konstrukcija poput (define, defined type, defined resource type). Defini je sličan klasi, ali postoje razlike: prvo, svaki defini je tip resursa, a ne resurs; drugo, svaki defini ima neimplicitni parametar $title, gdje se ime resursa pohranjuje tijekom njegove deklaracije. Kao i kod klasa, defini prvo treba opisati, a nakon toga ga možeš koristiti.
Jednostavan primjer s modulom za PHP:
define php74::module (
$php_module_name = $title,
$php_package_name = "php7.4-${title}",
$version = 'installed',
$priority = '20',
$data = "extension=${title}.son",
$php_module_path = '\/etc\/php\/7.4\/mods-available',
) {
package { $php_package_name:
ensure => $version,
install_options => ['-o', 'DPkg::NoTriggers=true'], # debian php paketi sami kreiraju simlinkove i restartaju php-fpm servis - to nam nije potrebno jer upravljamo i simlinkovima i servisom putem Puppeta
}
-> file { "${php_module_path}\/${php_module_name}.ini":
ensure => $ensure,
content => $data,
}
file { "\/etc\/php\/7.4\/cli\/conf.d\/${priority}-${php_module_name}.ini":
ensure => link,
target => "${php_module_path}\/${php_module_name}.ini",
}
file { "\/etc\/php\/7.4\/fpm\/conf.d\/${priority}-${php_module_name}.ini":
ensure => link,
target => "${php_module_path}\/${php_module_name}.ini",
}
}
node server3.testdomain {
php74::module { 'sqlite3': }
php74::module { 'amqp': php_package_name => 'php-amqp' }
php74::module { 'msgpack': priority => '10' }
}U definiciji je najlakše uhvatiti grešku Duplicate declaration. To se događa ako u definiciji postoji resurs s konstantnim imenom, a na nekoj nodi dva ili više instanci te definicije.
Zaštita od toga je jednostavna: svi resursi unutar definicije trebaju imati ime koje ovisi o $title. Kao alternativu — idempotentno dodavanje resursa, u najjednostavnijem slučaju dovoljno je iznijeti zajedničke resurse za sve instance definicije u zasebnu klasu i uključiti tu klasu u definiciju — funkcija include je idempotentna.
Postoje i drugi načini za postizanje idempotentnosti prilikom dodavanja resursa, posebno korištenjem funkcija defined i ensure_resources, ali o tome ću govoriti u sljedećoj seriji.
Zavisnosti i obavijesti za klase i definicije
Klase i definicije dodaju sljedeća pravila za obradu zavisnosti i obavijesti:
- zavisnost od klase/definicije dodaje zavisnosti od svih resursa klase/definicije;
- zavisnost klase/definicije dodaje zavisnosti svim resursima klase/definicije;
- obavijest klase/definicije obavještava sve resurse klase/definicije;
- pretplata na klasu/definiciju pretplaćuje na sve resurse klase/definicije.
Uslovni operatori i selektori
if
Ovdje je sve jednostavno:
if UVJET1 {
...
} elsif UVJET2 {
...
} else {
...
}osim
unless — to je if obrnuto: blok koda će se izvršiti ako je izraz lažan.
unless UVJET {
...
}case
Ovdje također nema ničega složenog. Kao vrijednosti mogu se koristiti obične vrijednosti (stringovi, brojevi itd.), regularni izrazi, kao i tipovi podataka.
case IZRAZ {
VRIJEDNOST1: { ... }
VRIJEDNOST2, VRIJEDNOST3: { ... }
default: { ... }
}Selektori
Selektor je jezična konstrukcija slična case, samo što umjesto izvršavanja bloka koda vraća vrijednost.
$var = $othervar ? { 'val1' => 1, 'val2' => 2, default => 3 }Moduli
Kada je konfiguracija mala, lako ju je zadržati u jednom manifestu. No što više konfiguracija opisujemo, to se više klasa i nodova pojavljuje u manifestu, raste, i postaje nezgodno raditi s njom.
Osim toga, postoji problem ponovne upotrebe koda — kada je sav kod u jednom manifestu, teško je dijeliti taj kod s drugima. Za rješavanje ova dva problema u Puppet-u postoji entitet zvan modul.
Moduli — to su skupovi klasa, definicija i drugih Puppet entiteta, premještenih u zasebnu direktoriju. Drugim riječima, modul je neovisan dio Puppet logike. Na primjer, može postojati modul za rad s nginx-om, i u njemu će biti samo ono što je potrebno za rad s nginx-om, može postojati modul za rad s PHP-om, i tako dalje.
Moduli se verzioniraju, a također se podržavaju zavisnosti modula jedni od drugih. Postoji javni repozitorij modula — .
Na puppet serveru moduli se nalaze u poddirektoriju modules korijenske direktorije. Unutar svakog modula postoji standardna shema direktorija — manifests, files, templates, lib i tako dalje.
Struktura datoteka u modulu
U korijenu modula mogu se nalaziti sljedeće direktorije s opisnim nazivima:
manifests— u njoj se nalaze manifestifiles— u njoj se nalaze datoteketemplates— u njoj se nalaze predlošcilib— u njoj se nalazi Ruby kod
Ovo nije potpuni popis direktorija i datoteka, ali za ovaj članak trenutno je dovoljno.
Nazivi resursa i imena datoteka u modulu
Resursi (klasice, definicije) u modulu ne mogu se nazivati proizvoljno. Osim toga, postoji izravna povezanost između naziva resursa i imena datoteke u kojoj će Puppet tražiti opis tog resursa. Ako se krše pravila imenovanja, Puppet jednostavno neće pronaći opis resursa, i doći će do greške pri kompajliranju.
Pravila su jednostavna:
- Svi resursi u modulu moraju biti u imenskom području modula. Ako se modul zove
foo, svi resursi u njemu moraju se zvatifoo::, ili jednostavnofoo. - Resurs s nazivom modula mora biti u datoteci
init.pp. - Za ostale resurse shema imenovanja datoteka je sljedeća:
- prefiks s imenom modula se odbacuje
- sva dvostruka dvojna sličica, ako ih ima, zamjenjuju se s kosim crticama
- dodaje se ekstenzija
.pp
Prikazat ću na primjeru. Pretpostavimo da pišem modul nginx. U njemu su sljedeći resursi:
- klasa
nginxopisano u manifestuinit.pp; - klasa
nginx::serviceopisano u manifestuservice.pp; - defini
nginx::serveropisano u manifestuserver.pp; - defini
nginx::server::locationopisano u manifestuserver/location.pp.
Predlošci
Sigurno znate što su predlošci, neću ih detaljno opisivati ovdje. Ali za svaki slučaj ostavljam .
Kako koristiti predloške: vrijednost predloška može se otkriti pomoću funkcije predložak, kojoj se proslijedi put do predloška. Za resurse tipa datoteka koristimo zajedno s parametrima sadržaj. Na primjer, ovako:
file { '/tmp/example': content => template('modulename/templatename.erb')Put kao / podrazumijeva datoteku /modules//templates/.
Osim toga, postoji funkcija inline_template — u nju se proslijedi tekst predloška, a ne naziv datoteke.
Unutar predložaka možete koristiti sve varijable Puppet u trenutnoj vidljivosti.
Puppet podržava predloške u ERB i EPP formatu:
Kratko o ERB
Kontrolne strukture:
<%= ВЫРАЖЕНИЕ %>— umetnite vrijednost izraza<% ВЫРАЖЕНИЕ %>— izračunajte vrijednost izraza (ne umetajući ga). Ovdje obično idu uvjetni operatori (if), petlje (each).<%# КОММЕНТАРИЙ %>
Izrazi u ERB se pišu na Rubyju (zapravo, ERB je Embedded Ruby).
Za pristup varijablama iz manifesta potrebno je dodati @ ime varijable. Da biste uklonili prijelom retka koji se pojavljuje nakon kontrolne strukture, potrebno je koristiti završni tag -%>.
Primjer korištenja predloška
Pretpostavimo da pišem modul za upravljanje ZooKeeperom. Klasa koja odgovara za kreiranje konfiguracije izgleda otprilike ovako:
class zookeeper::configure (
Array[String] $nodes,
Integer $port_client,
Integer $port_quorum,
Integer $port_leader,
Hash[String, Any] $properties,
String $datadir,
) {
file { '/etc/zookeeper/conf/zoo.cfg':
ensure => present,
content => template('zookeeper/zoo.cfg.erb'),
}
}A odgovarajući mu predložak zoo.cfg.erb — ovako:
0 -%>
server.=:::
dataDir=
=Fakti i ugrađene varijable
Često specifični deo konfiguracije zavisi od onoga što se trenutno dešava na nodu. Na primer, u zavisnosti od toga koja verzija Debiana je instalirana, potrebno je instalirati odgovarajuću verziju paketa. Može se sve to pratiti ručno, prepisujući manifeste u slučaju promene nodova. No, to nije ozbiljan pristup, automatizacija je mnogo bolja.
Za dobijanje informacija o nodovima u Puppet-u postoji mehanizam koji se zove faktori. Faktori su informacije o nodu dostupne u manifestima kao obične promenljive u globalnom prostoru imena. Na primer, ime hosta, verzija operativnog sistema, arhitektura procesora, lista korisnika, lista mrežnih interfejsa i njihovih adresa, i mnogo, mnogo više. Fakti su dostupni u manifestima i šablonima kao obične promenljive.
Primer rada s faktorima:
notify { "Pokreće se OS ${facts['os']['name']} verzija ${facts['os']['release']['full']}" : }
# resurs tipa notify jednostavno prikazuje poruku u loguAko govorimo formalno, faktor ima ime (niz) i vrednost (različiti tipovi su dostupni: stringovi, nizovi, rečnici). Postoji . Takođe, možete pisati svoje. Sakupljači faktora opisuju se , ili kao . Takođe, faktori mogu biti predstavljeni u obliku na nodovima.
Tokom rada puppet agenta, prvo kopira sa puppet servera na nod sve dostupne sakupljače faktora, zatim ih pokreće i šalje na server prikupljene faktore; tek nakon toga server započinje kompjilaciju kataloga.
Faktori u obliku izvršnih fajlova
Ovi faktori se smeštaju u module u direktorijumu facts.d. Naravno, fajlovi moraju biti izvršni. Kada se pokrenu, treba da ispisuju na standardni izlaz u formatu YAML ili u formatu "ključ=vrednost".
Ne zaboravite da se faktori šire na sve nodove koji su pod upravom puppet servera na koji se postavlja vaš modul. Stoga, u skripti obavezno proverite da u sistemu postoje svi potrebni programi i fajlovi za rad vašeg faktora.
#!/bin/sh
echo "testfact=success"#!/bin/sh
echo '{"testyamlfact":"success"}'Faktori na Ruby-ju
Ovi faktori se smeštaju u module u direktorijumu lib/facter.
# всё начинается с вызова функции Facter.add с именем факта и блоком кода
Facter.add('ladvd') do
# в блоках confine описываются условия применимости факта — код внутри блока должен вернуть true, иначе значение факта не вычисляется и не возвращается
confine do
Facter::Core::Execution.which('ladvdc') # проверим, что в PATH есть такой исполняемый файл
end
confine do
File.socket?('/var/run/ladvd.sock') # проверим, что есть такой UNIX-domain socket
end
# в блоке setcode происходит собственно вычисление значения факта
setcode do
hash = {}
if (out = Facter::Core::Execution.execute('ladvdc -b'))
out.split.each do |l|
line = l.split('=')
next if line.length != 2
name, value = line
hash[name.strip.downcase.tr(' ', '_')] = value.strip.chomp(''').reverse.chomp(''').reverse
end
end
hash # значение последнего выражения в блоке setcode является значением факта
end
endTekstualni faktori
Ovi faktori se smeštaju na nodove u direktorijumu /etc/facter/facts.d u starom Puppet-u ili /etc/puppetlabs/facts.d u novom Puppet-u.
examplefact=examplevalue---
examplefact2: examplevalue2
anotherfact: anothervaluePristupanje faktorima
Možete se obratiti činjenicama na dva načina:
- putem rječnika
$facts:$facts['fqdn']; - koristeći ime činjenice kao ime varijable:
$fqdn.
Najbolje je koristiti rječnik $facts, a još bolje je navesti globalni naziv prostora ($::facts).
Ugrađene varijable
Osim činjenica, postoje i , dostupne u globalnom prostoru imena.
- trusted facts — varijable koje dolaze iz certifikata klijenta (budući da se certifikat obično izdaje na serveru sa Puppetom, agent ne može jednostavno promijeniti svoj certifikat, stoga su varijable 'pouzdane': naziv certifikata, ime hosta i domena, proširenja iz certifikata.
- server facts — varijable koje se odnose na informacije o serveru — verzija, ime, IP adresa servera, okruženje.
- agent facts — varijable koje izravno dodaje puppet-agent, a ne facter — naziv certifikata, verzija agenta, verzija puppeta.
- master variables — varijable puppeta (sic!). Tu je otprilike isto kao u server facts, plus dostupne su vrijednosti konfiguracijskih parametara.
- compiler variables — varijable kompajlera koje se razlikuju u svakoj domeni vidljivosti: ime trenutačnog modula i ime modula iz kojeg je pozvan trenutačni objekt. Mogu se koristiti, na primjer, za provjeru da vaši privatni klasa ne koriste izravno iz drugih modula.
Dopuna 1: kako sve to pokrenuti i debagovati?
U članku je bilo puno primjera puppet koda, ali nije bilo riječi o tome kako taj kod pokrenuti. E, pa, ispravljam se.
Za rad s Puppetom dostatan je agent, ali za većinu slučajeva trebat će vam i server.
Agent
Minimalno s petom verzijom paketi puppet-agent iz sadrže sve ovisnosti (ruby i odgovarajući gemovi), stoga nema poteškoća s instalacijom (govorim o Debian-based distribucijama — RPM-based distribucijama ne koristimo).
U najjednostavnijem slučaju, za primjenu puppet konfiguracije dovoljno je pokrenuti agenta u beservernom modu: pod uvjetom da je puppet kod kopiran na nodu, pokrenite puppet apply:
atikhonov@atikhonov ~/puppet-test $ cat helloworld.pp
node default {
notify { 'Hello world!': }
}
atikhonov@atikhonov ~/puppet-test $ puppet apply helloworld.pp
Notice: Compiled catalog for atikhonov.localdomain in environment production in 0.01 seconds
Notice: Hello world!
Notice: /Stage[main]/Main/Node[default]/Notify[Hello world!]/message: defined 'message' as 'Hello world!'
Notice: Applied catalog in 0.01 secondsBolje je, naravno, podići server i pokrenuti agente na nodovima u režimu demona — tada će svako pola sata primenjivati konfiguraciju preuzetu sa servera.
Možete imitirati push-model rada — ući na nod koji vas zanima i pokrenuti sudo puppet agent -t. Ključ -t (--test) zapravo uključuje nekoliko opcija koje se mogu uključiti i zasebno. Među tim opcijama su sledeće:
- ne raditi u režimu demona (podrazumevano agent se pokreće u režimu demona);
- završiti rad nakon primene kataloga (podrazumevano agent će nastaviti rad i primenjivati konfiguraciju svako pola sata);
- pisati detaljan log rada;
- prikazivati promene u fajlovima.
Agent ima režim rada bez promena — može se koristiti kada niste sigurni da ste napisali ispravnu konfiguraciju i želite da proverite šta će agent promeniti tokom rada. Ovaj režim se uključuje parametrom --noop u komandnoj liniji: sudo puppet agent -t --noop.
Pored toga, može se uključiti debug log rada — u njemu puppet beleži sve radnje koje obavlja: o resursu koji u ovom trenutku obrađuje, o parametrima tog resursa, o tome koje programe pokreće. Naravno, ovo je parametar --debug.
Server
Detaljnu konfiguraciju puppetservera i deploy koda na njega u ovom članku neću razmatrati, reći ću samo da iz kutije dolazi sasvim funkcionalna verzija servera, koja ne zahteva dodatnu konfiguraciju za rad u uslovima malog broja nodova (recimo, do sto). Veći broj nodova već će zahtevati tuning — podrazumevano puppetserver pokreće ne više od četiri radnika, za veću performansu potrebno je povećati njihov broj i ne zaboraviti povećati limite memorije, inače će veći deo vremena server raditi garbage collect.
Deploy koda — ako treba brzo i jednostavno, onda pogledajte (na r10k)[], za manje instalacije biće sasvim dovoljno.
Dodavanje 2: preporuke za pisanje koda
- Iznesite svu logiku u klase i definicije.
- Držite klase i definicije u modulima, a ne u manifestima s opisom nodova.
- Koristite činjenice.
- Ne radite if-ove prema hostnim imenima.
- Ne bojte se dodavati parametre za klase i definicije — to je bolje od nejasne logike skrivena unutar tijela klase/definicije.
A zašto preporučujem to — objasnit ću u sljedećem članku.
Zaključak
Time završavamo s uvodom. U sljedećem članku ću govoriti o Hiera, ENC i PuppetDB.
Samo registrirani korisnici mogu sudjelovati u anketi. , molimo.
U stvari, materijala ima mnogo više — mogu napisati članke na sljedeće teme, glasujte o čemu biste voljeli čitati:
- 59,1%Napredne konstrukcije puppeta — neka sljedeća razina: ciklusi, mapiranje i druga lambda izražavanja, kolektori resursa, izvozni resursi i međuhost interakcija putem Puppea, oznake, pružatelji, apstraktni tipovi podataka.
- 31,8%«Ja sam admin od mame» ili kako smo u Avitu spojili nekoliko puppet poslužitelja različitih verzija, a dio o administraciji puppet poslužitelja.
- 81,8%Kako pišemo puppet kod: alatna obrnuta, dokumentacija, testiranje, CI/CD.
Glasalo je 22 korisnika. Uzdržalo se 9 korisnika.
Izvor: habr.com
