Compare commits
2 Commits
| Author | SHA1 | Date | |
|---|---|---|---|
| 535a5fed0e | |||
| f3abd42f17 |
@@ -8,6 +8,9 @@ on:
|
|||||||
version:
|
version:
|
||||||
required: true
|
required: true
|
||||||
type: string
|
type: string
|
||||||
|
build_args:
|
||||||
|
required: false
|
||||||
|
type: string
|
||||||
secrets:
|
secrets:
|
||||||
GITEA_TOKEN:
|
GITEA_TOKEN:
|
||||||
required: true
|
required: true
|
||||||
@@ -44,6 +47,7 @@ jobs:
|
|||||||
env:
|
env:
|
||||||
DOCKER_USERNAME: ${{ secrets.DOCKER_USERNAME || github.actor }}
|
DOCKER_USERNAME: ${{ secrets.DOCKER_USERNAME || github.actor }}
|
||||||
DOCKER_PASSWORD: ${{ secrets.DOCKER_PASSWORD }}
|
DOCKER_PASSWORD: ${{ secrets.DOCKER_PASSWORD }}
|
||||||
|
BUILD_ARGS_INPUT: ${{ inputs.build_args }}
|
||||||
run: |
|
run: |
|
||||||
if [ -z "${DOCKER_REGISTRY}" ]; then echo "ERROR: DOCKER_REGISTRY not set in env.conf"; exit 1; fi
|
if [ -z "${DOCKER_REGISTRY}" ]; then echo "ERROR: DOCKER_REGISTRY not set in env.conf"; exit 1; fi
|
||||||
if [ -z "${DOCKER_IMAGE_NAME}" ]; then echo "ERROR: DOCKER_IMAGE_NAME not set in env.conf"; exit 1; fi
|
if [ -z "${DOCKER_IMAGE_NAME}" ]; then echo "ERROR: DOCKER_IMAGE_NAME not set in env.conf"; exit 1; fi
|
||||||
@@ -51,9 +55,18 @@ jobs:
|
|||||||
IMAGE="${DOCKER_IMAGE_NAME}"
|
IMAGE="${DOCKER_IMAGE_NAME}"
|
||||||
REGISTRY_HOST="${REGISTRY%%/*}"
|
REGISTRY_HOST="${REGISTRY%%/*}"
|
||||||
|
|
||||||
|
BUILD_ARGS=""
|
||||||
|
if [ -n "$BUILD_ARGS_INPUT" ]; then
|
||||||
|
while IFS= read -r arg; do
|
||||||
|
[ -n "$arg" ] && BUILD_ARGS="$BUILD_ARGS --build-arg $arg"
|
||||||
|
done <<EOF
|
||||||
|
$BUILD_ARGS_INPUT
|
||||||
|
EOF
|
||||||
|
fi
|
||||||
|
|
||||||
NOW=$(date -u +%Y-%m-%dT%H:%M:%SZ)
|
NOW=$(date -u +%Y-%m-%dT%H:%M:%SZ)
|
||||||
CONTEXT_DIR=$(dirname "${DOCKERFILE}")
|
CONTEXT_DIR=$(dirname "${DOCKERFILE}")
|
||||||
docker build \
|
docker build $BUILD_ARGS \
|
||||||
--label "git.commit=${{ github.sha }}" \
|
--label "git.commit=${{ github.sha }}" \
|
||||||
--label "git.commitBy=${{ github.actor }}" \
|
--label "git.commitBy=${{ github.actor }}" \
|
||||||
--label "build.date=${NOW}" \
|
--label "build.date=${NOW}" \
|
||||||
|
|||||||
@@ -48,6 +48,9 @@ jobs:
|
|||||||
with:
|
with:
|
||||||
env_json: ${{ needs.load-config.outputs.env_json }}
|
env_json: ${{ needs.load-config.outputs.env_json }}
|
||||||
version: ${{ needs.check-version.outputs.version }}
|
version: ${{ needs.check-version.outputs.version }}
|
||||||
|
build_args: |
|
||||||
|
VERSION=${{ needs.check-version.outputs.version }}
|
||||||
|
FOO=bar
|
||||||
|
|
||||||
docker-gitops:
|
docker-gitops:
|
||||||
name: GitOps
|
name: GitOps
|
||||||
|
|||||||
@@ -1 +1,4 @@
|
|||||||
FROM alpine:latest
|
FROM alpine:latest
|
||||||
|
ARG VERSION=unknown
|
||||||
|
ARG FOO=unknown
|
||||||
|
RUN mkdir -p /app && echo "$VERSION" > /app/version.txt && echo "$FOO" > /app/foo.txt
|
||||||
|
|||||||
@@ -1,198 +1,90 @@
|
|||||||
# Design Rationale — gitea-reports
|
# Design Rationale — gitea-reports
|
||||||
|
|
||||||
> Miksi gitea-reports on rakennettu näin. Arvot, periaatteet ja reunaehdot.
|
Miksi gitea-reports on rakennettu näin. Periaatteet, jotka pitävät arkkitehtuurin koossa.
|
||||||
>
|
Teknologiavalinnat ovat näiden periaatteiden seurauksia — eivät erillisiä preferenssejä.
|
||||||
> Tämä dokumentti on **normatiivinen** `gitea-reports/`-alikansiolle. Se ei kuvaa juuren
|
|
||||||
> `gitea-ci-library`-kirjastoa eikä sen workfloweja.
|
|
||||||
>
|
|
||||||
> Liittyvät dokumentit: [architecture.md](architecture.md), [tech-stack.md](tech-stack.md), [secrets.md](secrets.md).
|
|
||||||
|
|
||||||
---
|
Tämä dokumentti on normatiivinen. Arkkitehtuurin tulee noudattaa sen periaatteita.
|
||||||
|
Ehdotus, joka on ristiriidassa dokumentin kanssa, on konflikti — ei hiljainen ohitus.
|
||||||
|
|
||||||
## Miksi tämä on olemassa
|
## The problem this solves
|
||||||
|
|
||||||
### Ongelma
|
CI-testiajoista syntyy HTML-raportteja. Gitea ei tarjoa web-selaimella selattavaa arkistoa
|
||||||
|
näille raporteille.
|
||||||
|
|
||||||
CI-testiajoista syntyy HTML-raportteja. Esimerkiksi Cucumber-testiraportti toimii
|
Vaihtoehdot eivät sovi:
|
||||||
elävänä dokumentaationa git commitin tilasta.
|
- **Gitea Actions artifactit**: vain ZIP-lataus — HTML ei renderöidy selaimessa
|
||||||
|
- **Gitea pages-branch**: yksi branch per repo; rinnakkaiset buildit törmäävät
|
||||||
|
- **Gitea Releases**: sotkee julkaisuhistorian sadoilla CI-buildien raporteilla
|
||||||
|
|
||||||
Gitea ei tarjoa web-selaimella selattavaa arkistoa näille HTML-raporteille.
|
## How this is solved
|
||||||
|
|
||||||
gitea-reports ratkaisee tämän ongelman.
|
Yksi klusteri, yksi apex-host, monta Gitea-repoa. URL on suoraan FS-polku:
|
||||||
|
`/{owner}/{repo}/{branch}/{sha8}/{suite}/`. Ei rewritea, ei subdomain-per-owner,
|
||||||
|
ei slugia.
|
||||||
|
|
||||||
| Vaihtoehto | Miksi ei riitä |
|
Palvelu on read/write -jaettu: luku ja julkaisu eri sovelluksilla, eri porteilla,
|
||||||
|---|---|
|
eri Traefik-säännöillä.
|
||||||
| **Gitea Actions -artifactit** | Vain ZIP-lataus — HTML ei renderöidy selaimessa |
|
|
||||||
| **Gitea `pages`-branch** | Yksi branch per repo; rinnakkaiset buildit törmäävät saman branchin pushissa |
|
|
||||||
| **Gitea Releases** | Sotkee julkaisuhistorian satojen CI-buildien raporteilla |
|
|
||||||
|
|
||||||
### Ongelma URL:ssa (hylätty malli)
|
## Why selvä URL + Gitea-yhteensopiva polku
|
||||||
|
|
||||||
Alkuvaiheen malli sitoi hostin repoon: `https://{owner}.{host}/{repo}/...`
|
Repo tunnistetaan polusta `/{owner}/{repo}/...`, ei hostista. Kaikki URL-taso
|
||||||
(subdomain per owner). Julkinen linkki piti sitten “kääntää” Gitea-tyyliseksi poluksi
|
(branch, sha8, suite) on suoraan FS-polku. Tämä mahdollistaa yhden TLS-sertifikaatin,
|
||||||
Traefik-rewritellä (`/{owner}/{repo}/...` → eri `Host` + lyhyempi polku).
|
yhden IngressRouten ja URL:n, joka on suoraan kopioitavissa commit-statusiin ilman
|
||||||
|
rewritea.
|
||||||
|
|
||||||
Tämä oli ongelmallinen:
|
**Hylätty:** subdomain-per-owner (`{owner}.pages...`). Vaati per-owner Traefik-
|
||||||
|
rewritea ja wildcard-TLS:ää. Julkaisu-URL ja luku-URL olivat eri muodossa — kehittäjälle
|
||||||
|
vaikea ymmärtää ja debugata.
|
||||||
|
|
||||||
- per-owner middleware / rewrite kube-resursseina
|
## Why luku ja kirjoitus eri sovelluksilla
|
||||||
- julkaisu-URL ja lukemis-URL eri muodossa
|
|
||||||
- wildcard-TLS tai monimutkainen cert-hallinta
|
|
||||||
- vaikea selittää kehittäjälle mistä host tulee
|
|
||||||
|
|
||||||
### Ratkaisu — `selvä_url` + Gitea-yhteensopiva polku
|
Yksi binary, joka palvelee sekä lukua että kirjoitusta samassa prosessissa, on
|
||||||
|
yksinkertainen mutta yhdistää kaksi eri asiaa. Tässä arkkitehtuurissa nginx palvelee
|
||||||
|
staattisia tiedostoja; Python-skripti purkaa tar.gz-julkaisun PV:lle. Ne eivät tiedä
|
||||||
|
toisistaan.
|
||||||
|
|
||||||
URL rakennetaan kahdesta erillisestä osasta, ei yhdestä sekavasta kaavasta:
|
Luku ei tarvitse julkaisulogiikkaa. Julkaisu ei tarvitse optimoitua staattista
|
||||||
|
palvelua. Erottamalla ne kumpikin voidaan valita parhaaseen tarkoitukseensa.
|
||||||
|
|
||||||
| Osa | Mistä | Esimerkki |
|
## Why security klusterin reunalla — ei sovelluksessa
|
||||||
|-----|-------|-----------|
|
|
||||||
| **Selvä URL** | Organisaation kiinteä pages-host | `https://pages.example.com` |
|
|
||||||
| **Gitea-yhteensopiva polku** | Repo (`{owner}/{repo}`) + commit | `/acme-corp/backend-api/reports/abc12345/index.html` |
|
|
||||||
|
|
||||||
**Julkinen linkki** = selvä URL + polku (yksi merkkijono commit-statusiin, ei rewritea):
|
Sovellus on "tyhmä": se palvelee mitä PV:llä on ja kirjoittaa mitä sille annetaan.
|
||||||
|
Valtuutus tapahtuu yksinomaan Traefik BasicAuth -middlewaressa.
|
||||||
|
|
||||||
`https://pages.example.com/acme-corp/backend-api/reports/abc12345/index.html`
|
Tämä mahdollistaa:
|
||||||
|
- Julkaisu- ja lukuoikeuksien erillisen hallinnan eri Traefik-säännöillä
|
||||||
|
- Sovelluksen vaihtamisen ilman turvallisuusauditointia
|
||||||
|
- Token-rotaation ilman sovelluksen uudelleenkäynnistystä
|
||||||
|
|
||||||
Polku vastaa Gitea Pages -käytäntöä (`/{owner}/{repo}/...`). Host on aina sama —
|
**Hylätty:** sovelluksen sisäinen forge-auth (Gitea PAT, DNS TXT -haaste).
|
||||||
ei `{owner}.pages...`-subdomainia.
|
Sitoo sovelluksen tiettyyn autentikointimekanismiin ja vaatii laajat oikeudet
|
||||||
|
(`write:repository`) pelkkää raporttijulkaisua varten.
|
||||||
|
|
||||||
**Konkreettinen esimerkki (nykyinen ympäristö):**
|
## Why retention erillisenä CronJobina
|
||||||
|
|
||||||
| Elementti | Arvo |
|
Retention ei tarvitse olla aina käynnissä — se ajetaan kerran vuorokaudessa.
|
||||||
|-----------|------|
|
CronJob lukee PV:tä suoraan (find, ls, stat), ei HTTP API:n kautta. Tämä pitää
|
||||||
| **Gitea-instanssi** | `gitea.app.keskikuja.site` |
|
retention poissa podin kriittiseltä polulta (luku/julkaisu).
|
||||||
| **Repo** | `niko/gitea-ci-library` |
|
|
||||||
| **Haara** | `plan/0003-alkaa-käyttämään-itseään-commit-raportti` |
|
|
||||||
| **Commit SHA** | `14cf2eaeed8a4033bc37c52b0b4c29f25b253ceb` |
|
|
||||||
| **Raportin nimi** | `cucumber` (esim.) |
|
|
||||||
| **Gitea commit -URL** | `https://gitea.app.keskikuja.site/niko/gitea-ci-library/commit/14cf2eaeed8a4033bc37c52b0b4c29f25b253ceb` |
|
|
||||||
| **Raportin julkinen URL** | `https://ci-reports.helm-dev.keskikuja.site/niko/gitea-ci-library/commit/14cf2eaeed8a4033bc37c52b0b4c29f25b253ceb/cucumber/index.html` |
|
|
||||||
|
|
||||||
Tämä varmistaa, että CI-statuslinkki on suoraan luettavissa ilman domain-rewriteä: raportin polku peilaa täsmälleen Gitean commit-polun rakennetta (`/{owner}/{repo}/commit/{sha}/{raportin-nimi}/`). Koska yksi ajo tuottaa useita raportteja, raportin nimi erottaa ne toisistaan.
|
**Hylätty:** sidecar samassa podissa. Sidecar kuluttaa resursseja aina, ja
|
||||||
|
retention-logiikka sekoittuu julkaisu- ja lukukoodiin.
|
||||||
|
|
||||||
Julkaisija (CI tai muu asiakas) lähettää tar-arkiston PATCH/PUT:lla. Lukija hakee
|
## Why yksi token, kaksi säilöä
|
||||||
HTML:n GET:llä. Ei Gitea-git-integraatiota eikä `pages`-branchia.
|
|
||||||
|
|
||||||
**Codebergin security-malli ei sovellu tähän käyttöön** — forge-auth (Gitea PAT +
|
Sama plaintext-arvo: htpasswd-hashina K8s Secretissä (Traefik lukee), plaintextina
|
||||||
`write:repository`), DNS TXT -haaste ja muut gitea-reportsin sisäänrakennetut valtuutus-
|
Gitea Actions Secretissä (julkaisija lukee). Yksi rotaatio päivittää molemmat.
|
||||||
mekanismit on ohitettu kokonaan (`PAGES_INSECURE=1`). Niiden sijaan Kubernetes-kerros
|
|
||||||
hoitaa rajauksen: Traefik BasicAuth julkaisuun, cert-manager TLS:ään, erillinen
|
|
||||||
publish-token ([secrets.md](secrets.md)). Sovellus palvelee sisältöä; klusteri päättää
|
|
||||||
kuka saa kirjoittaa.
|
|
||||||
|
|
||||||
---
|
Token antaa vain julkaisuoikeuden tähän palveluun — ei Gitea PAT:ia eikä
|
||||||
|
`write:repository`-oikeutta.
|
||||||
|
|
||||||
## Suunnitteluperiaatteet
|
## Why PVC suoraan FS-muodossa
|
||||||
|
|
||||||
### 1. Selvä URL + Gitea-yhteensopiva polku
|
Ei objektivarastoa, ei HTTP API:a retentionille. Sisältö on suoraan luettavissa
|
||||||
|
kubectl exec + ls/find. Yksinkertaisin mahdollinen tallennusmuoto. Yksi replica,
|
||||||
|
ei synkronointia.
|
||||||
|
|
||||||
Julkinen osoite = kiinteä apex-host + polku `/{owner}/{repo}/reports/{sha8}/...`.
|
## References
|
||||||
Apex-juuri `/` on tyhjä tarkoituksella — ei landing-sivua.
|
|
||||||
|
|
||||||
**Miksi:** Kehittäjä näkee Gitea-tyylisen polun; infra näkee yhden hostin. Ei Traefik-
|
- [architecture.md](architecture.md) — komponentit ja vuokaavio
|
||||||
rewritea, ei per-owner subdomaineja, ei erillistä “julkaisu-URL vs. lukemis-URL” -kaavaa.
|
- [tech-stack.md](tech-stack.md) — teknologiavalinnat listana
|
||||||
Yksi TLS-sertifikaatti, yksi IngressRoute, yksi PVC.
|
- [secrets.md](secrets.md) — secret-arkkitehtuuri ja käyttöönotto
|
||||||
|
|
||||||
### 2. Sovelluksen sisäinen security kytketty pois, Traefik hoitaa rajauksen
|
|
||||||
|
|
||||||
`gitea-reports`-sovelluksen koko sisäinen security-mekanismi on kytketty pois päältä (`PAGES_INSECURE=1`). Kirjoitusoikeuden validointi tapahtuu yksinomaan Kubernetes-reunalla Traefik BasicAuth -middlewaren avulla. Sovellus palvelee sisältöä sokeana; klusteri päättää, kuka saa kirjoittaa.
|
|
||||||
|
|
||||||
### 3. Julkaisu ja luku erotettu
|
|
||||||
|
|
||||||
Julkaisu (PATCH/PUT) vaatii Traefik BasicAuthin. Luku (GET/HEAD) on erillinen reitti — katso [Luku-auth](#luku-auth) alla.
|
|
||||||
|
|
||||||
**Miksi:** Koska sovellus ei validoi julkaisuoikeuksia, kirjoitusoikeus on eksplisiittisesti eriytetty Traefik Middlewaressä (`gitea-reports-publish-auth`).
|
|
||||||
|
|
||||||
### 4. Yksi publish-token, kaksi säilöä
|
|
||||||
|
|
||||||
Sama plaintext-token: klusterin Secretissä htpasswd-hashina, julkaisijan secret-holvissa
|
|
||||||
(esim. CI-alustan Actions-secret).
|
|
||||||
|
|
||||||
**Miksi:** Ei Gitea PAT:ia eikä `write:repository` -oikeutta. Token antaa vain
|
|
||||||
julkaisuoikeuden tähän palveluun. Yksi arvo, kaksi paikkaa — ks. [secrets.md](secrets.md).
|
|
||||||
|
|
||||||
### 5. Secretit erillisessä hallinnassa
|
|
||||||
|
|
||||||
`gitea-reports-publish-auth` luodaan ennen käyttöönottoa — ei osana sovelluksen konfiguraatiotiedostoja.
|
|
||||||
|
|
||||||
**Miksi:** Salaisuudet eivät kulje versionoiduissa arvoissa. Rotaatio ja SealedSecrets
|
|
||||||
pysyvät operaattorin hallussa. Ks. [secrets.md](secrets.md).
|
|
||||||
|
|
||||||
### 6. Minimaalinen parametrisointi
|
|
||||||
|
|
||||||
Instance-arvot (`host`, `issuer`, PVC) `{env}-values.yaml`:ssa. Resurssinimet,
|
|
||||||
secret-nimet ja Traefik-wire kovakoodattu templatessa.
|
|
||||||
|
|
||||||
**Miksi:** Parametrisoi vain se, mikä vaihtelee instanssien välillä (host, TLS-issuer,
|
|
||||||
levy). Vakioidut nimet ja wire pysyvät ennustettavina kaikissa asennuksissa.
|
|
||||||
|
|
||||||
---
|
|
||||||
|
|
||||||
## Puutteet
|
|
||||||
|
|
||||||
Tietoisesti avoimet asiat — eivät estä nykyistä julkaisu- ja lukumallia.
|
|
||||||
|
|
||||||
### Luku-auth
|
|
||||||
|
|
||||||
Julkaisu on suojattu (Traefik BasicAuth). **Luku ei ole:** GET/HEAD on julkinen — kuka
|
|
||||||
tuntee URL:n voi lukea raportin.
|
|
||||||
|
|
||||||
Tavoite: Traefik OIDC GET/HEAD-reitille (Gitea OAuth2 -provider). Session säilyy —
|
|
||||||
commit-statuslinkki toimii kirjautumisen jälkeen ilman uutta julkaisuoikeutta.
|
|
||||||
|
|
||||||
Ei toteutettu. Julkaisu- ja luku-reitit pysyvät erillisinä; OIDC lisätään vain lukupuolelle.
|
|
||||||
|
|
||||||
### Retention
|
|
||||||
|
|
||||||
Sidecar samassa podissa (HTTP localhost:3000), ajaa retention-cleanup.sh
|
|
||||||
24h välein:
|
|
||||||
|
|
||||||
| Sääntö | Konfiguroitavissa? | Kuvaus |
|
|
||||||
|--------|-------------------|--------|
|
|
||||||
| **Poistettu branch** | Ei — aina | Jos `.meta.branch` ei ole Giteassa enää, raportti poistetaan |
|
|
||||||
| **maxAgeDays** | Kyllä (`dev-values`) | Aktiivisen branchin raportit vanhemmat kuin N päivää |
|
|
||||||
| **keepMin** | Kyllä (`dev-values`) | Aktiivisella branchilla pidetään vähintään N uusinta |
|
|
||||||
|
|
||||||
Poistettujen branchien siivous ei tarvitse parametreja. Jäljelle jääneille
|
|
||||||
branchille säännöt tulevat `retention.rules` (`branches.default` +
|
|
||||||
`branches.{name}`).
|
|
||||||
|
|
||||||
Ei PVC-skaalausta — sidecar lukee manifestin HTTP:lla ja poistaa whiteout
|
|
||||||
PATCHilla. Ei K8s API -oikeuksia.
|
|
||||||
|
|
||||||
Secret: `gitea-reports-retention-gitea` — Gitea PAT branch-tarkistukseen.
|
|
||||||
Ks. [secrets.md](secrets.md).
|
|
||||||
|
|
||||||
---
|
|
||||||
|
|
||||||
## Rajat
|
|
||||||
|
|
||||||
- **Ei forge-integraatiota** — ei `pages`-branchia, ei Gitea API -hakua, ei forge-authia
|
|
||||||
- **Ei julkaisijalogiikkaa** — kuka julkaisee ja milloin on julkaisijan vastuulla
|
|
||||||
- **Ei sisäverkon ohitusjulkaisua** — julkaisu kulkee julkisen ingressin kautta (BasicAuth)
|
|
||||||
|
|
||||||
---
|
|
||||||
|
|
||||||
## Teknologiavalinnat
|
|
||||||
|
|
||||||
| Valinta | Miksi |
|
|
||||||
|---------|-------|
|
|
||||||
| **Codeberg gitea-reports** `0.9.1` | Natiivi apex index-site + tar-pohjainen PATCH/PUT -julkaisu |
|
|
||||||
| **Filesystem + PVC** | Yksinkertainen, yksi replica, ei erillistä objektivarastoa |
|
|
||||||
| **Traefik IngressRoute + Middleware** | Julkaisuauth erillään sovelluksesta; GET/HEAD eri säännöllä |
|
|
||||||
| **cert-manager** | TLS automaattisesti (`gitea-reports-tls`) |
|
|
||||||
| **Helm v3** | Toistettava asennus; instanssikohtaiset arvot erillisessä values-tiedostossa |
|
|
||||||
|
|
||||||
---
|
|
||||||
|
|
||||||
## Mitä tietoisesti hylättiin
|
|
||||||
|
|
||||||
| Hylätty | Syy |
|
|
||||||
|---------|-----|
|
|
||||||
| **deadnews/gitea-pages** | Vetää sisällön Gitea API:sta — ei sopinut CI-push-malliin |
|
|
||||||
| **Gitea `pages`-branch** | Race condition rinnakkaisissa buildeissa |
|
|
||||||
| **Per-owner subdomain** (`{owner}.pages...`) | Ongelmallinen URL; vaatii rewrite-middlewarea polun kääntämiseen |
|
|
||||||
| **Traefik path→host -rewrite** | Korvattu apex + Gitea-polulla — yksi selvä URL commit-linkissä |
|
|
||||||
| **Gitea forge-auth / PAT** | `write:repository` liian laaja oikeus vain raporttijulkaisuun |
|
|
||||||
| **DNS TXT -haaste julkaisuun** | Operatiivinen kompleksisuus ilman hyötyä BasicAuthiin verrattuna |
|
|
||||||
| **Helm-managed publish Secret** | Arvot values-tiedostoihin on kielletty; manuaalinen lähde totuudelle |
|
|
||||||
| **Image tag `v0.9.1`** | Oikea tagi on `0.9.1` (ei `v`-etuliitettä) |
|
|
||||||
|
|||||||
@@ -1,43 +0,0 @@
|
|||||||
# Implementation Notes
|
|
||||||
|
|
||||||
Teknisiä huomioita git-pages 0.9.1:n käyttäytymisestä, joita ei ole ilmeistä
|
|
||||||
dokumentaatiosta.
|
|
||||||
|
|
||||||
## Storage v2 (Protobuf manifest)
|
|
||||||
|
|
||||||
Git-pages 0.9.1 käyttää v2-arkkitehtuuria. Kaikki sisältö on pakattu
|
|
||||||
Protobuf-manifestiin (`site/{host}/.index`), ei flat-FS:nä. Tästä seuraa:
|
|
||||||
|
|
||||||
- Tiedostoja ei voi etsiä tai poistaa `find`/`rm`-komennoilla
|
|
||||||
- `.git-pages/manifest.json` listaa kaikki tiedostot (ProtoJSON)
|
|
||||||
- `.git-pages/archive.tar` antaa koko sisällön (saattaa truncata HTTP/2:ssa)
|
|
||||||
|
|
||||||
## Host-header
|
|
||||||
|
|
||||||
Git-pages valitsee sivuston Host-headerin perusteella. Ilman oikeaa Hostia
|
|
||||||
palauttaa 404.
|
|
||||||
|
|
||||||
- Ulkoiset requestit: Traefik välittää alkuperäisen Hostin automaattisesti
|
|
||||||
- Sidecar/localhost: `-H "Host: ci-reports.helm-dev.keskikuja.site"`
|
|
||||||
|
|
||||||
## PATCH ja directory-entryt
|
|
||||||
|
|
||||||
Jos PATCH-tar sisältää directory-entryn (tyyppi directory, tar typeflag '5'),
|
|
||||||
se **korvaa** koko hakemiston dokumentaation mukaan. Tar saa sisältää vain
|
|
||||||
file- ja symlink-entryjä, jotta PATCH toimii odotetusti.
|
|
||||||
|
|
||||||
## Whiteout — tiedostojen poisto
|
|
||||||
|
|
||||||
Ainoa tapa poistaa tiedostoja ilman koko sivuston PUT-korvausta:
|
|
||||||
|
|
||||||
- Tarissa character device entry (`CHRTYPE`, tar typeflag '4')
|
|
||||||
- `devmajor=0`, `devminor=0`
|
|
||||||
- PATCH:ataan sivuston juureen
|
|
||||||
|
|
||||||
## .init — ensimmäinen julkaisu
|
|
||||||
|
|
||||||
Ensimmäinen julkaisu vaatii PUTin, joka luo `.index`-tiedoston. Tämän jälkeen
|
|
||||||
PATCH riittää.
|
|
||||||
|
|
||||||
Helm-chartin post-install -job hoitaa tämän automaattisesti:
|
|
||||||
consumerien publish-scriptien ei tarvitse tuntea asennuksen tilaa.
|
|
||||||
@@ -9,13 +9,9 @@
|
|||||||
|
|
||||||
| Teknologia | Versio | Käyttö |
|
| Teknologia | Versio | Käyttö |
|
||||||
|---|---|---|
|
|---|---|---|
|
||||||
| **gitea-reports** (Codeberg) | `0.9.1` | Staattinen sisältö, apex index-site (`/.index`), HTTP PATCH/PUT -julkaisu |
|
| **nginx** | alpine | Staattinen tiedostopalvelin (GET/HEAD) |
|
||||||
| **Filesystem storage** | — | Sisältö PVC:llä (`/app/data`) |
|
| **Python** | 3-alpine | PUT-vastaanotto + tar.gz-purku PV:lle |
|
||||||
| **TOML** | — | Sovellusconfig ConfigMapissa (`config.toml`) |
|
| **Filesystem storage** | — | Sisältö PVC:llä |
|
||||||
|
|
||||||
Image: `codeberg.org/gitea-reports/gitea-reports:0.9.1` (ei `v`-etuliitettä tagissa).
|
|
||||||
|
|
||||||
Chart ajaa `PAGES_INSECURE=1` — julkaisuvaltuutus Traefik Middlewaressä, ei forge-authia.
|
|
||||||
|
|
||||||
---
|
---
|
||||||
|
|
||||||
|
|||||||
@@ -81,11 +81,10 @@ generate_index() {
|
|||||||
} > "$REPORT_DIR/index.html"
|
} > "$REPORT_DIR/index.html"
|
||||||
}
|
}
|
||||||
|
|
||||||
STAGED="reports/${SHA8}/${SUITE}"
|
mkdir -p "$SUITE"
|
||||||
mkdir -p "$STAGED"
|
|
||||||
|
|
||||||
if [ "$TOTAL" -eq 1 ]; then
|
if [ "$TOTAL" -eq 1 ]; then
|
||||||
cp -a "$REPORT_DIR/." "$STAGED/"
|
cp -a "$REPORT_DIR/." "$SUITE/"
|
||||||
sh .ci/scripts/publish-git-pages.sh "$SUITE"
|
sh .ci/scripts/publish-git-pages.sh "$SUITE"
|
||||||
|
|
||||||
first_entry=$(echo "$ENTRIES" | head -1)
|
first_entry=$(echo "$ENTRIES" | head -1)
|
||||||
@@ -102,9 +101,9 @@ if [ "$TOTAL" -eq 1 ]; then
|
|||||||
sh .ci/scripts/report-status.sh "$STATUS" "$DESCRIPTION" "$CONTEXT" "" "$URL"
|
sh .ci/scripts/report-status.sh "$STATUS" "$DESCRIPTION" "$CONTEXT" "" "$URL"
|
||||||
else
|
else
|
||||||
generate_index
|
generate_index
|
||||||
cp -a "$REPORT_DIR/." "$STAGED/"
|
cp -a "$REPORT_DIR/." "$SUITE/"
|
||||||
sh .ci/scripts/publish-git-pages.sh "$SUITE"
|
sh .ci/scripts/publish-git-pages.sh "$SUITE"
|
||||||
sh .ci/scripts/report-status.sh "$STATUS" "$DESCRIPTION" "$CONTEXT" "$SUITE"
|
sh .ci/scripts/report-status.sh "$STATUS" "$DESCRIPTION" "$CONTEXT" "$SUITE"
|
||||||
fi
|
fi
|
||||||
|
|
||||||
rm -rf "$STAGED"
|
rm -rf "$SUITE"
|
||||||
|
|||||||
@@ -19,6 +19,12 @@ PAGES_USER="${GIT_PAGES_PUBLISH_USER:-publish}"
|
|||||||
|
|
||||||
[ -d "$SUITE" ] || { echo "ERROR: not a directory: $SUITE" >&2; exit 1; }
|
[ -d "$SUITE" ] || { echo "ERROR: not a directory: $SUITE" >&2; exit 1; }
|
||||||
|
|
||||||
|
EMPTY=1
|
||||||
|
for _f in "$SUITE"/* "$SUITE"/.*; do
|
||||||
|
[ -e "$_f" ] && { EMPTY=0; break; }
|
||||||
|
done
|
||||||
|
[ "$EMPTY" -eq 0 ] || { echo "ERROR: no files to publish in $SUITE" >&2; exit 1; }
|
||||||
|
|
||||||
WORK=$(mktemp -d)
|
WORK=$(mktemp -d)
|
||||||
TAR=$(mktemp)
|
TAR=$(mktemp)
|
||||||
trap 'rm -rf "$WORK" "$TAR"' EXIT
|
trap 'rm -rf "$WORK" "$TAR"' EXIT
|
||||||
|
|||||||
@@ -345,6 +345,14 @@ DOCKER_REGISTRY: gitea.app.keskikuja.site/niko
|
|||||||
DOCKER_IMAGE_NAME: my-app
|
DOCKER_IMAGE_NAME: my-app
|
||||||
```
|
```
|
||||||
|
|
||||||
|
**Inputit:**
|
||||||
|
|
||||||
|
| Parametri | Pakollinen | Kuvaus |
|
||||||
|
|-----------|------------|--------|
|
||||||
|
| `env_json` | Kyllä | Konffi `gitea-env.conf`:stä |
|
||||||
|
| `version` | Kyllä | Version string (check-version output) |
|
||||||
|
| `build_args` | Ei | Monirivinen KEY=VALUE-lista välitettynä `--build-arg`-lipuiksi `docker build` -komennolle |
|
||||||
|
|
||||||
**Käyttö reitittimessä:**
|
**Käyttö reitittimessä:**
|
||||||
|
|
||||||
```yaml
|
```yaml
|
||||||
@@ -356,8 +364,19 @@ docker-build-push:
|
|||||||
with:
|
with:
|
||||||
env_json: ${{ needs.load-config.outputs.env_json }}
|
env_json: ${{ needs.load-config.outputs.env_json }}
|
||||||
version: ${{ needs.check-version.outputs.version }}
|
version: ${{ needs.check-version.outputs.version }}
|
||||||
|
build_args: |
|
||||||
|
VERSION=${{ needs.check-version.outputs.version }}
|
||||||
```
|
```
|
||||||
|
|
||||||
|
**Dockerfilessä** ARG otetaan vastaan oletusarvolla ja kirjoitetaan tiedostoksi:
|
||||||
|
|
||||||
|
```dockerfile
|
||||||
|
ARG VERSION=unknown
|
||||||
|
RUN mkdir -p /app && echo "$VERSION" > /app/version.txt
|
||||||
|
```
|
||||||
|
|
||||||
|
Katso referenssi: repon juuren `Dockerfile` (`gitea-ci-library/Dockerfile`).
|
||||||
|
|
||||||
Tarkka input/secret-lista: `docs/workflows.md`.
|
Tarkka input/secret-lista: `docs/workflows.md`.
|
||||||
|
|
||||||
### `helm-build-push.yml` — Helm chart build & push
|
### `helm-build-push.yml` — Helm chart build & push
|
||||||
|
|||||||
@@ -15,7 +15,7 @@ setup() {
|
|||||||
|
|
||||||
teardown() {
|
teardown() {
|
||||||
mock_stop
|
mock_stop
|
||||||
rm -rf "unit-tests" "sub"
|
rm -rf "unit-tests" "sub" "empty-suite"
|
||||||
}
|
}
|
||||||
|
|
||||||
@test "missing suite_path argument → exit 1" {
|
@test "missing suite_path argument → exit 1" {
|
||||||
@@ -58,6 +58,14 @@ teardown() {
|
|||||||
[[ "$output" == *"not a directory"* ]]
|
[[ "$output" == *"not a directory"* ]]
|
||||||
}
|
}
|
||||||
|
|
||||||
|
@test "empty directory → exit 1" {
|
||||||
|
mkdir -p "empty-suite"
|
||||||
|
run bash scripts/publish-git-pages.sh "empty-suite"
|
||||||
|
[ "$status" -eq 1 ]
|
||||||
|
[[ "$output" == *"no files to publish"* ]]
|
||||||
|
rm -rf "empty-suite"
|
||||||
|
}
|
||||||
|
|
||||||
@test "valid publish returns report base URL" {
|
@test "valid publish returns report base URL" {
|
||||||
mock_set_sequence '[
|
mock_set_sequence '[
|
||||||
{"code":200,"body":"published"}
|
{"code":200,"body":"published"}
|
||||||
|
|||||||
Reference in New Issue
Block a user