BlueGit

timfa bluegit

Files

bluegit / docs / AUR.md

AUR.md

feat: self-update via een root-unit achter een token
timfa project_87923614_bot_3aff574f6f98414b945a8799374f9092 · pushed by timfa · 3 weeks ago
ad7bf26a History
AUR.md 6.9 KiB Download Raw

AUR

Elke push naar master werkt packaging/aur/PKGBUILD bij en pusht die naar ssh://aur@aur.archlinux.org/bluegit.git (branch master; AUR accepteert niets anders). De aanpak en de geheimnamen zijn dezelfde als in Posprint. Posprint publiceert bij een tag; BlueGit doet het bij elke commit op master, omdat er geen vaste versietag is.

Package

Er is één source-package, bluegit. Geen -bin. De PKGBUILD haalt de GitLab-archieven op:

https://gitlab.com/Timfa/bluegit/-/archive/<commit>/bluegit-<commit>.tar.gz

Die map heet bluegit-<commit>. pkgver is YYYYMMDDHHMMSS. De CI-job neemt CI_COMMIT_TIMESTAMP, of anders de klok van de job. Het lokale script neemt de UTC-committertijd van de commit, zodat dezelfde sha dezelfde pkgver houdt. pkgrel gaat terug naar 1. _commit is de volledige sha. Het CI-script vult sha256sums met de hash van dat archief. Het lokale script doet hetzelfde met updpkgsums. Beide maken .SRCINFO opnieuw met makepkg --printsrcinfo. Draait de CI-job als root, dan doet gebruiker aurbuild dat (AUR_MAKEPKG_USER overschrijft de naam). De gedeelde functies staan in scripts/aur-common.sh.

De lokale packaging/arch/PKGBUILD blijft voor een build uit de werkboom. Die gaat niet naar de AUR.

Unit en install-hook

De unit is de bestaande system-unit: User=bluegit, ExecStart met /etc/bluegit/config.yml, StateDirectory=bluegit voor /var/lib/bluegit. Geen systemd --user-unit.

packaging/aur/bluegit.install maakt bij installatie en upgrade de systeemgebruiker en de state-map aan. post_install doet systemctl daemon-reload en daarna systemctl enable --now bluegit.service, maar alleen als /etc/bluegit/config.yml er al is én het clientgeheim in /etc/bluegit/client_secret of als BLUEGIT_AUTH_CLIENT_SECRET in /etc/bluegit/secret.env staat. Een lege client_secret: "" telt niet. Ontbreekt een van beide, dan print de hook de vervolgstappen en start hij niets. post_upgrade herlaadt systemd en doet systemctl try-restart bluegit.service. pre_remove doet systemctl disable --now bluegit.service. Draait systemd niet (chroot of container), dan slaat de hook die stappen over zonder fout. backup=('etc/bluegit/config.yml') laat een aangepaste config staan.

De huidige user-unit (/home/timfa/bluegit/config.yml, /home/timfa/bluegit/state, datadisk /home/timfa/temp-bluegit) gaat over naar deze system-service volgens MIGRATIE.md. De datadisk verhuist naar /srv/bluegit; een pad onder /home blijft met ProtectHome=true onbereikbaar.

Geheimen

De namen zijn 1-op-1 dezelfde als in Posprint. De publieke sleutel hoort op aur.archlinux.org, nooit de private sleutel in de repository.

NaamSoortInhoud
AUR_SSH_PRIVATE_KEYFile, mask uit, protected magruwe OpenSSH-sleutel (BEGIN … PRIVATE KEY). Een File met base64 wordt ook herkend.
AUR_SSH_PRIVATE_KEY_B64Variable, één regel, Masked+Protectedbase64 van die sleutel. GitLab maskeert geen meerregelige waarde, daarom base64 of een File.
AUR_GIT_AUTHOR_NAMEVariablenaam in de AUR-commit
AUR_GIT_AUTHOR_EMAILVariablee-mail in de AUR-commit

Eén van de twee sleutelvariabelen is genoeg. scripts/aur-ssh-setup.sh haalt CRLF weg en controleert de sleutel met ssh-keygen -y zonder hem te printen.

De job heet publish:aur in .gitlab-ci.yml en publish_aur in blue-ci-cd.yml. Beide draaien alleen op master (BlueGit ook op main) en hebben allow_failure: true, zodat een storing bij de AUR de rest van de pipeline niet rood maakt.

Lokaal publiceren

Zolang de CI-runner er niet is, publiceert scripts/aur-publish-local.sh met de hand vanuit een lokale checkout. Het gebruikt de AUR-sleutel in ~/.ssh of ssh-agent, en geen CI-variabelen.

De checkout moet op master staan, schoon zijn en gelijk aan origin/master. Het script publiceert de sha van origin/master. Staat die sha al als _commit in de AUR-PKGBUILD, dan stopt het zonder iets te wijzigen.

Het clonet of werkt ssh://aur@aur.archlinux.org/bluegit.git bij in ~/.cache/bluegit-aur (BLUEGIT_AUR_CACHE wijzigt die map), kopieert packaging/aur/*, zet _commit en pkgver, en draait updpkgsums en makepkg --printsrcinfo. Daarna commit het upstream <pkgver> en pusht het naar master. updpkgsums komt uit pacman-contrib.

Self-update

Een push naar master hoeft niet op de AUR te wachten. publish_aur publiceert parallel (needs: [], allow_failure: true). De laatste job, self_update, wacht alleen op test en doet dan:

curl -fsS -X POST "$CI_API_URL/admin/self-update" \
  -H "Authorization: Bearer $BLUEGIT_UPDATE_TOKEN" \
  -H "Content-Type: application/json" \
  -d "{\"ref\":\"${CI_COMMIT_SHA}\"}"

BLUEGIT_UPDATE_TOKEN is een gemaskeerde, beschermde CI-variabele. Dezelfde waarde staat op de mini-PC in /etc/bluegit/env (EnvironmentFile, optioneel). Zonder die variabele antwoordt POST /api/v1/admin/self-update met 404. De vergelijking is constant-time, en een burst krijgt 429. De body mag leeg zijn of ref / sha bevatten. Het endpoint schrijft die ref naar /var/lib/bluegit/update-request en start alleen bluegit-update.service (systemctl start --no-block). Het wacht de oneshot niet af: anders blijft de CI-job running en wacht de updater op de job die hem aanriep.

De polkit-regel packaging/bluegit-update.rules laat gebruiker bluegit uitsluitend start van die ene unit toe. Geen stop, geen restart, geen andere unit. De unit is een oneshot als root.

/usr/lib/bluegit/update (uit packaging/bluegit-update.sh) wacht tot GET /api/v1/admin/self-update "running":0 meldt, ook na de bouw en vóór pacman -U. Hij cloont niet van GitLab: BLUEGIT_UPDATE_REPO in /etc/bluegit/env wijst naar de lokale bare repo, bijvoorbeeld /srv/bluegit/tim/bluegit.git. pkgver is de UTC-committertijd van die commit (YYYYMMDDHHMMSS), dezelfde regel als het lokale AUR-script, zodat yay later geen downgrade of upgrade verzint voor dezelfde sha. makepkg draait als bluegit-build. Die gebruiker maakt de install-hook aan via systemd-sysusers (packaging/sysusers.conf). pacman -U --noconfirm installeert het pakket. post_upgrade in bluegit.install doet systemctl try-restart bluegit.service.

Mislukt de bouw of de installatie, dan blijft de oude versie staan. De uitvoer staat in het journal van bluegit-update.service. Het script schrijft /var/lib/bluegit/update-status.json met tijd, sha en resultaat (running, ok, failed). Een installatiebeheerder ziet dat op de Info-pagina en op de setup-pagina.

De mini-PC heeft base-devel, go en pacman-contrib niet als package-dependency. Die moeten geïnstalleerd zijn, anders stopt het script vóór pacman -U.

Archief

Het archief is anoniem te downloaden:

https://gitlab.com/Timfa/bluegit/-/archive/<commit>/bluegit-<commit>.tar.gz

De publish-job haalt die tarball zonder token op en zet de sha256 in de PKGBUILD. makepkg gebruikt dezelfde URL.

Source
1# AUR
2
3Elke push naar `master` werkt `packaging/aur/PKGBUILD` bij en pusht die naar `ssh://aur@aur.archlinux.org/bluegit.git` (branch `master`; AUR accepteert niets anders). De aanpak en de geheimnamen zijn dezelfde als in Posprint. Posprint publiceert bij een tag; BlueGit doet het bij elke commit op `master`, omdat er geen vaste versietag is.
4
5## Package
6
7Er is één source-package, `bluegit`. Geen `-bin`. De PKGBUILD haalt de GitLab-archieven op:
8
9```text
10https://gitlab.com/Timfa/bluegit/-/archive/<commit>/bluegit-<commit>.tar.gz
11```
12
13Die map heet `bluegit-<commit>`. `pkgver` is `YYYYMMDDHHMMSS`. De CI-job neemt `CI_COMMIT_TIMESTAMP`, of anders de klok van de job. Het lokale script neemt de UTC-committertijd van de commit, zodat dezelfde sha dezelfde `pkgver` houdt. `pkgrel` gaat terug naar 1. `_commit` is de volledige sha. Het CI-script vult `sha256sums` met de hash van dat archief. Het lokale script doet hetzelfde met `updpkgsums`. Beide maken `.SRCINFO` opnieuw met `makepkg --printsrcinfo`. Draait de CI-job als root, dan doet gebruiker `aurbuild` dat (`AUR_MAKEPKG_USER` overschrijft de naam). De gedeelde functies staan in `scripts/aur-common.sh`.
14
15De lokale `packaging/arch/PKGBUILD` blijft voor een build uit de werkboom. Die gaat niet naar de AUR.
16
17## Unit en install-hook
18
19De unit is de bestaande system-unit: `User=bluegit`, `ExecStart` met `/etc/bluegit/config.yml`, `StateDirectory=bluegit` voor `/var/lib/bluegit`. Geen `systemd --user`-unit.
20
21`packaging/aur/bluegit.install` maakt bij installatie en upgrade de systeemgebruiker en de state-map aan. `post_install` doet `systemctl daemon-reload` en daarna `systemctl enable --now bluegit.service`, maar alleen als `/etc/bluegit/config.yml` er al is én het clientgeheim in `/etc/bluegit/client_secret` of als `BLUEGIT_AUTH_CLIENT_SECRET` in `/etc/bluegit/secret.env` staat. Een lege `client_secret: ""` telt niet. Ontbreekt een van beide, dan print de hook de vervolgstappen en start hij niets. `post_upgrade` herlaadt systemd en doet `systemctl try-restart bluegit.service`. `pre_remove` doet `systemctl disable --now bluegit.service`. Draait systemd niet (chroot of container), dan slaat de hook die stappen over zonder fout. `backup=('etc/bluegit/config.yml')` laat een aangepaste config staan.
22
23De huidige user-unit (`/home/timfa/bluegit/config.yml`, `/home/timfa/bluegit/state`, datadisk `/home/timfa/temp-bluegit`) gaat over naar deze system-service volgens [MIGRATIE.md](MIGRATIE.md). De datadisk verhuist naar `/srv/bluegit`; een pad onder `/home` blijft met `ProtectHome=true` onbereikbaar.
24
25## Geheimen
26
27De namen zijn 1-op-1 dezelfde als in Posprint. De publieke sleutel hoort op aur.archlinux.org, nooit de private sleutel in de repository.
28
29| Naam | Soort | Inhoud |
30| --- | --- | --- |
31| `AUR_SSH_PRIVATE_KEY` | File, mask uit, protected mag | ruwe OpenSSH-sleutel (`BEGIN … PRIVATE KEY`). Een File met base64 wordt ook herkend. |
32| `AUR_SSH_PRIVATE_KEY_B64` | Variable, één regel, Masked+Protected | base64 van die sleutel. GitLab maskeert geen meerregelige waarde, daarom base64 of een File. |
33| `AUR_GIT_AUTHOR_NAME` | Variable | naam in de AUR-commit |
34| `AUR_GIT_AUTHOR_EMAIL` | Variable | e-mail in de AUR-commit |
35
36Eén van de twee sleutelvariabelen is genoeg. `scripts/aur-ssh-setup.sh` haalt CRLF weg en controleert de sleutel met `ssh-keygen -y` zonder hem te printen.
37
38De job heet `publish:aur` in `.gitlab-ci.yml` en `publish_aur` in `blue-ci-cd.yml`. Beide draaien alleen op `master` (BlueGit ook op `main`) en hebben `allow_failure: true`, zodat een storing bij de AUR de rest van de pipeline niet rood maakt.
39
40## Lokaal publiceren
41
42Zolang de CI-runner er niet is, publiceert `scripts/aur-publish-local.sh` met de hand vanuit een lokale checkout. Het gebruikt de AUR-sleutel in `~/.ssh` of ssh-agent, en geen CI-variabelen.
43
44De checkout moet op `master` staan, schoon zijn en gelijk aan `origin/master`. Het script publiceert de sha van `origin/master`. Staat die sha al als `_commit` in de AUR-PKGBUILD, dan stopt het zonder iets te wijzigen.
45
46Het clonet of werkt `ssh://aur@aur.archlinux.org/bluegit.git` bij in `~/.cache/bluegit-aur` (`BLUEGIT_AUR_CACHE` wijzigt die map), kopieert `packaging/aur/*`, zet `_commit` en `pkgver`, en draait `updpkgsums` en `makepkg --printsrcinfo`. Daarna commit het `upstream <pkgver>` en pusht het naar `master`. `updpkgsums` komt uit `pacman-contrib`.
47
48## Self-update
49
50Een push naar `master` hoeft niet op de AUR te wachten. `publish_aur` publiceert parallel (`needs: []`, `allow_failure: true`). De laatste job, `self_update`, wacht alleen op `test` en doet dan:
51
52```yaml
53curl -fsS -X POST "$CI_API_URL/admin/self-update" \
54 -H "Authorization: Bearer $BLUEGIT_UPDATE_TOKEN" \
55 -H "Content-Type: application/json" \
56 -d "{\"ref\":\"${CI_COMMIT_SHA}\"}"
57```
58
59`BLUEGIT_UPDATE_TOKEN` is een gemaskeerde, beschermde CI-variabele. Dezelfde waarde staat op de mini-PC in `/etc/bluegit/env` (EnvironmentFile, optioneel). Zonder die variabele antwoordt `POST /api/v1/admin/self-update` met 404. De vergelijking is constant-time, en een burst krijgt 429. De body mag leeg zijn of `ref` / `sha` bevatten. Het endpoint schrijft die ref naar `/var/lib/bluegit/update-request` en start alleen `bluegit-update.service` (`systemctl start --no-block`). Het wacht de oneshot niet af: anders blijft de CI-job `running` en wacht de updater op de job die hem aanriep.
60
61De polkit-regel `packaging/bluegit-update.rules` laat gebruiker `bluegit` uitsluitend `start` van die ene unit toe. Geen stop, geen restart, geen andere unit. De unit is een oneshot als root.
62
63`/usr/lib/bluegit/update` (uit `packaging/bluegit-update.sh`) wacht tot `GET /api/v1/admin/self-update` `"running":0` meldt, ook na de bouw en vóór `pacman -U`. Hij cloont niet van GitLab: `BLUEGIT_UPDATE_REPO` in `/etc/bluegit/env` wijst naar de lokale bare repo, bijvoorbeeld `/srv/bluegit/tim/bluegit.git`. `pkgver` is de UTC-committertijd van die commit (`YYYYMMDDHHMMSS`), dezelfde regel als het lokale AUR-script, zodat `yay` later geen downgrade of upgrade verzint voor dezelfde sha. `makepkg` draait als `bluegit-build`. Die gebruiker maakt de install-hook aan via `systemd-sysusers` (`packaging/sysusers.conf`). `pacman -U --noconfirm` installeert het pakket. `post_upgrade` in `bluegit.install` doet `systemctl try-restart bluegit.service`.
64
65Mislukt de bouw of de installatie, dan blijft de oude versie staan. De uitvoer staat in het journal van `bluegit-update.service`. Het script schrijft `/var/lib/bluegit/update-status.json` met tijd, sha en resultaat (`running`, `ok`, `failed`). Een installatiebeheerder ziet dat op de Info-pagina en op de setup-pagina.
66
67De mini-PC heeft `base-devel`, `go` en `pacman-contrib` niet als package-dependency. Die moeten geïnstalleerd zijn, anders stopt het script vóór `pacman -U`.
68
69## Archief
70
71Het archief is anoniem te downloaden:
72
73```text
74https://gitlab.com/Timfa/bluegit/-/archive/<commit>/bluegit-<commit>.tar.gz
75```
76
77De publish-job haalt die tarball zonder token op en zet de sha256 in de PKGBUILD. `makepkg` gebruikt dezelfde URL.