Hogyan jelentem az élesítéseket a pipeline-ból?

A pipeline két hívással jelent: az élesítés elején egy start, a végén egy finish kérést küld a Topynnak, API-kulccsal. Így nem kell kézzel rögzítened az élesítéseket: az indulás, az eredmény, a verzió, az idő és a „mi ment ki” lista magától bekerül a naplóba. A kulcsot és a kész mintákat a Beállítások > API-kulcsok és CI oldalon találod.

API-kulcs létrehozása

app.topyn.hu/settings/deployments/api-keys

123

1. Nyisd meg a Beállítások > API-kulcsok és CI oldalt. Az oldalhoz az Élesítések kezelésének joga kell.
2. Kattints az Új kulcs gombra.
3. Nevezd el a kulcsot azután, ami használja (például „GitHub Actions”). 1
4. Válassz hatókört. 2 - Jelentés: élesítések indítása és lezárása; - Olvasás: az élesítések visszaolvasása.
5. Ha a kulcs csak bizonyos szolgáltatásokhoz nyúlhat, jelöld ki őket (Kijelölt szolgáltatások); különben bármely szolgáltatást jelenthet. 3
6. Kattints a Kulcs létrehozása gombra.
7. Másold ki a titkot, és tedd a pipeline titkai közé. A titkot csak ekkor látod meg: később nem kérdezhető le. Ha elvész, vond vissza a kulcsot, és hozz létre újat.

A titok rel_ előtaggal kezdődik. A pipeline-ban TOPYN_REL_KEY néven tárold – a minták ebből olvassák, a fájlba soha nem írod be.

A kulcs a listában látszik a nevével, a hatókörével, az érintett szolgáltatásokkal és az utolsó használatával. A Visszavonás gomb azonnal és véglegesen megszünteti: a kulccsal dolgozó pipeline-okat a Topyn ezután elutasítja.

A CI-minták

Ugyanezen az oldalon a CI-minták kész pipeline-lépéseket ad, amelyek az indulást és a végén az eredményt is jelentik; az oldal az API-címet is mutatja (API-cím). Négy minta közül választasz:

• GitHub Actions (.github/workflows/deploy.yml);
• GitLab CI (.gitlab-ci.yml);
• Jenkins (Jenkinsfile);
• shell (deploy-and-report.sh).

Mind ugyanazt a három lépést teszi: elindítja az élesítést, lefuttatja a saját élesítő lépésedet, és mindenképpen lezárja az élesítést a valódi eredménnyel – akkor is, ha az élesítő lépés elbukott. A pipeline azonosítója az Idempotency-Key fejléc, a commit-tartomány és a commit-üzenetek a git log kimenetéből mennek el.

Mit küldhet a pipeline?

A start hívás további mezői: version, commit_from, commit_to, branch, commits (soronként sha, message, author, committed_at), risk (low, medium, high), planned (tervezett élesítéshez, a planned_start_at és a planned_end_at mezővel), source_ref (hivatkozás a pipeline-futásra), started_by_label (az indító neve), idempotency_key. A finish hívás a result mellett finished_at, had_downtime, downtime_minutes és notes mezőt fogad.

Az eredmény írásmódja engedékeny:

Egy minta a hívásra:

curl -fsS -X POST https://api.topyn.hu/api/ext/v1/deployments/start \
  -H "Authorization: Bearer $TOPYN_REL_KEY" \
  -H "Idempotency-Key: $BUILD_ID" \
  -H "Content-Type: application/json" \
  -d '{"service":"web","environment":"production","version":"v1.2.3"}'

A válasz az élesítés adatait adja; a finish hívás ennek azonosítóját használja.

Amit érdemes tudni

• Ismétlés: ha ugyanazzal az Idempotency-Key értékkel küldöd újra a start hívást ugyanarra a szolgáltatásra és környezetre, ugyanaz az élesítés marad, új azonosító nem készül. A finish ugyanazzal az eredménnyel ismételve nem változtat; eltérő eredménnyel egy már lezárt élesítésre a Topyn elutasítja (az első jelentés marad érvényben).
• Ismeretlen kulcs: a Topyn nem hoz létre magától szolgáltatást vagy környezetet. Ha a service vagy az environment kulcsot nem találja, hibát ad; előbb vedd fel a katalógusban. Archivált szolgáltatásra vagy környezetre sem jelenthetsz.
• Szűkített kulcs: ha a kulcsot szolgáltatásokra szűkítetted, más szolgáltatásra nem jelenthet.
• Sebesség: egy kulccsal percenként legfeljebb 300 hívás indítható.
• Forrás: az így érkező élesítések forrása API (a Topyn saját telepítő szkriptjéé Telepítő szkript).
• Jóváhagyás: ha a jóváhagyás be van kapcsolva, a planned jelentés jóváhagyási kérelmet kap; a már futó (start tervezés nélkül) élesítést a kapu nem állítja meg, csak „jóváhagyás nélkül ment ki” jelölést kap.