Co-Authored-By: Claude Sonnet 5.5 <noreply@anthropic.com>
12 KiB
Deploy en testomgevingen
Compact overzicht van hoe code op de testomgevingen en productie komt. Bron: .gitea/workflows/continuous_integration.yaml (hierna ci) en .gitea/workflows/deploy-scp.yaml (hierna deploy), gecontroleerd op 2026-11-15. De installatie van de host zelf staat niet hier maar in aidlc-docs/features/gitea-deployment-workflow/operations/deployment/deployment-instructions.md en aidlc-docs/features/andreaslop-site-hosting/operations/deployment/deployment-instructions.md.
Omgevingen
| Omgeving | Wat | Publieke URL en health | Deploy-job |
|---|---|---|---|
| SlpSoftware test | SlpModularCms.Api.SlpSoftware |
https://test.slpsoftware.nl, health https://test.slpsoftware.nl/health |
deploy-sls-test |
| SlpSoftware productie | SlpModularCms.Api.SlpSoftware |
https://slpsoftware.nl, health https://slpsoftware.nl/health |
deploy-sls-production |
| ASF test (Andrea Slop Fotografie) | SlpModularCms.Api.AndreaSlopFotografie (website + admin met thema asf) |
https://test.andreaslop.nl, health https://test.andreaslop.nl/health |
deploy-asf-test |
De werkelijke health-URL's komen uit de Gitea-variabelen HEALTH_CHECK_URL_TEST, HEALTH_CHECK_URL_PRODUCTION en HEALTH_CHECK_URL_ASF_TEST; de waarden staan niet in de repository. De hostnamen hierboven komen uit de feature-documentatie (deployment-instructions.md van gitea-deployment-workflow en andreaslop-site-hosting) en zijn niet uit de workflows zelf af te leiden. Er is geen productie-deploy voor ASF in deze pipeline (de ASF-productie draait apart op IIS, zie aidlc-docs/active-features.md).
Wanneer draait wat
| Trigger | Wat er gebeurt |
|---|---|
pull_request (opened, synchronize, reopened) |
De poorten voor het master-CMS (SlpModularCms.Api met alle modules, Core, alle testprojecten via SlpModularCms.Ci.slnf; kwetsbaarheidscontrole; frontend build/test/lint) en de niet-verplichte compile-sites (alleen compileren van de dunne site-projecten). Er wordt niet gepubliceerd of gedeployed: een site wordt pas gebouwd bij een deploy. Een nieuwe push naar dezelfde PR annuleert de lopende run. |
push op master |
Dezelfde poorten, daarna automatisch deploy-sls-test (SlpSoftware test) en deploy-asf-test (ASF test). Nooit productie. |
workflow_dispatch (handmatig, op elke gekozen branch) |
Alle poorten draaien altijd volledig (het pad-filter meldt dan backend en frontend als gewijzigd). Deployen gebeurt alleen voor de aangevinkte invoer, zie hieronder. |
Poorten (jobs): changes (pad-filter), backend-build, backend-test (met een MariaDB-servicecontainer op poort 3308), vulnerability-scan, frontend-prepare, frontend-build, frontend-test, frontend-lint. Een poort die overgeslagen is (omdat die kant van de repo niet wijzigde) blokkeert niet; een poort die faalt of wordt geannuleerd blokkeert elke publish. Pad-filter bij push/PR: backend = src/**, tests/**, *.sln, **/*.csproj en de workflowbestanden; frontend = frontend/** en de workflowbestanden. Een run die geen van beide raakt publiceert niets.
Invoer van workflow_dispatch
| Invoer | Standaard | Effect |
|---|---|---|
deploy_sls_test |
uit | Bouwt (publish-sls-test) en deployt naar SlpSoftware test |
deploy_sls_production |
uit | Bouwt (publish-sls-production) en deployt naar SlpSoftware productie, met databaseback-up vooraf |
deploy_asf_test |
uit | Bouwt (publish-asf-test) en deployt naar ASF test |
Zonder een van de drie aangevinkt draaien alleen de poorten (handig als losse CI-run). Meerdere tegelijk aanvinken kan. Let op: deploy_sls_production werkt alleen bij een run op een branch release/* (zelfde regel als ASF; de naam na release/ is vrij, bijvoorbeeld release/2026-11-20). De condities van publish-sls-production en deploy-sls-production controleren de gebeurtenis (workflow_dispatch), de invoer en startsWith(github.ref, 'refs/heads/release/'); een run vanaf master of een featurebranch met deploy_sls_production aangevinkt doet voor productie niets. Een push deployt productie nooit.
Jobnamen en branch protection (merge-checklist)
Jobnamen volgen {actie}-{site}-{omgeving}: config-sls, publish-sls-test, deploy-sls-test, publish-sls-production, deploy-sls-production en voor Andrea config-asf, publish-asf-test, deploy-asf-test. Ook de invoeren van de handmatige run hebben de sitenaam: deploy_sls_test, deploy_sls_production en deploy_asf_test (vroeger deploy_test en deploy_production). De uitvoer van config-sls heet artifact_name_sls_*, deploy_environment_sls_*, deploy_path_sls_*, service_name_sls_* en health_check_url_sls_*, de artefacten app-sls-test en app-sls-production (ASF: app-asf-test). De Gitea-variabelen en -secrets (bijv. DEPLOY_PATH_TEST) zijn niet hernoemd.
Wat de CI per site doet: bij een pull request bouwt en test de CI alleen het master-CMS (alle modules, SlpModularCms.Ci.slnf). De sites (Api.SlpSoftware, Api.AndreaSlopFotografie, Api.Slave) zijn dunne composities zonder eigen logica; hun samenstelling en standaardwaarden worden getest op de master-host (SiteContractTests, AsfVariantPipelineTests, SiteVariantContactTests), compile-sites controleert dat ze nog compileren (niet verplicht) en publish-* bouwt een site pas bij een deploy (push naar master of een aangevinkte invoer). Na elke test-deploy draait een rooktest (scripts/smoke-site.sh, jobs smoke-sls-test en smoke-asf-test: health, modulelijst in /System/capabilities, noindex, beschermde beheerroutes, 404 op een onbekend pad bij ASF); faalt die, dan faalt de run.
Branch protection op master: verplicht zijn alleen Continuous Integration / backend-test (pull_request) en frontend-test (pull_request). De eerdere verplichte check publish-test (pull_request) bestaat niet meer (er wordt bij een pull request niet meer gepubliceerd) en moet vóór de merge uit de vereiste checks worden gehaald (Gitea: repository, Instellingen, Branches, beschermde branch master, vereiste statuschecks), anders wacht de merge op een check die nooit meer draait. Pas dat vlak voor de merge aan, met Bryans go.
Een branch naar test deployen
- Gitea, repository, Actions, workflow "Continuous Integration", "Run workflow".
- Kies de branch (de workflow bouwt en deployt de code van de gekozen ref;
actions/checkoutzonderref). - Vink
deploy_sls_testaan (SlpSoftware test) en/ofdeploy_asf_test(ASF test). Laatdeploy_sls_productionuit. - Na een groene run controleert de deploy zelf
/health; kijk daarna zelf op de testhost.
Aandachtspunten:
- De selectie van een branch in de Gitea-interface en het uitvoeren op een andere branch dan
masteris door mij niet in de interface uitgeprobeerd (niet geverifieerd); de workflow zelf kent geen beperking totmastervoor de testdeploys. - Naar verwachting gebruikt Gitea het workflowbestand van de gekozen branch; dan moet de invoer
deploy_asf_testdaar in de workflow staan (niet geverifieerd). - De testdatabase blijft bestaan. Bij het opstarten past de applicatie migraties toe (
MigrateCoreDatabase()voor Identity/Core, en per moduleDatabase.Migrate(), zie README). Deploy je later weermaster, dan staan de migraties van de branch nog in die database; dat gaat alleen goed als migraties voorwaarts-compatibel zijn (zo beschreven inrollback-plan.md). - Een volgende push naar
masteroverschrijft wat er op test staat. - De testdeploys maken geen databaseback-up (
run_db_backup: false).
Wat deploy doet (per release)
- Controleert dat
host(SLS_TEST,SLS_PRODofASF_TEST),deploy_path,service_nameenhealth_check_urlniet leeg zijn en dat de vier secrets van die host bestaan; anders stopt de deploy voordat de host wordt aangeraakt. - Zet SSH klaar met alleen de sleutel van die host (
<host>_HOST_SSH_KEY, tijdelijk bestand met modus 600,StrictHostKeyChecking=accept-newmet een known_hosts-bestand dat alleen voor deze job bestaat) en controleert de verbinding; er is geen wachtwoordaanmelding meer. - Alleen productie:
bash ~/scripts/backup-slpsoftware-db.sh <omgeving>op de host (het script staat niet in deze repository). - Uploadt het artefact naar
<deploy_path>/releases/<UTC-tijdstempel>. - Koppelt de blijvende websitemap
shared/wwwroot-webalswwwroot/webin de release, en eventueleshared/modules/*.dll. - Zet de symlink
<deploy_path>/currentin één stap om naar de nieuwe release en herstart desystemd --user-service (service_name). - Controleert
health_check_urlmetcurl -f, 10 pogingen met 3 seconden pauze. Slaagt dat niet, dan faalt de job. - Alleen na een geslaagde health-check: verwijdert oude releases, zodat
currenten één vorige release overblijven (ls -1t | tail -n +3). - Verwijdert de tijdelijke sleutel (ook bij falen).
Rollback voor zover in de workflows beschreven
- Er is geen automatische rollback. Faalt de health-check, dan blijft
currentnaar de nieuwe release wijzen en wordt er niet opgeruimd; de vorige release staat dan nog op schijf (opmerkingen indeploy). - Handmatig terug: op de host
currentnaar de vorige release inreleases/zetten en de service herstarten. De exacte stappen staan inaidlc-docs/features/gitea-deployment-workflow/operations/deployment/rollback-plan.md. - Verder terug dan de vorige release: een eerdere commit opnieuw deployen via de pijplijn (push naar
master, of dispatch). Of de databasemigraties dat toelaten hangt af van die migraties (zie hierboven). - Productie heeft een databaseback-up vooraf; terugzetten staat in dezelfde
rollback-plan.md.
Vereiste Gitea-secrets en -variabelen (alleen namen)
Secrets (SSH naar de host; per host dezelfde vier, met als voorvoegsel SLS_TEST, SLS_PROD of ASF_TEST; de drie hosts gebruiken nu één gedeelde deploy-sleutel):
| Naam | Gebruik |
|---|---|
<host>_HOST_ADDRESS, <host>_HOST_PORT, <host>_HOST_USERNAME |
Adres, poort en deploy-account |
<host>_HOST_SSH_KEY |
Privésleutel van het deploy-account (de publieke sleutel staat in authorized_keys van dat account) |
Variabelen (SLS_TEST, SLS_PROD, ASF_TEST; voor ASF productie bestaan ze al maar er is nog geen ASF-productiejob):
| Naam | Voor |
|---|---|
<host>_DEPLOY_PATH, <host>_SERVICE_NAME, <host>_HEALTH_URL |
Release-map, systemd-service en /health-adres van die host. config-sls (SLS test) en config-asf falen als er een leeg is |
<host>_SENTRY_DSN |
Sentry-DSN voor de adminbuild van die site (wordt als VITE_SENTRY_DSN aan de build gegeven) |
SLS_TEST_UMAMI_SCRIPT_URL, SLS_TEST_UMAMI_WEBSITE_ID, SLS_PROD_UMAMI_SCRIPT_URL, SLS_PROD_UMAMI_WEBSITE_ID |
Umami voor de SlpSoftware-adminbuild (ASF gebruikt geen Umami) |
SLS_TEST_SECURITY_ALLOWED_SCRIPT_ORIGINS, SLS_PROD_SECURITY_ALLOWED_SCRIPT_ORIGINS |
Alleen gebruikt als controle in publish-sls-test/publish-sls-production wanneer de Umami-scripturl gevuld is: de Umami-origin moet in deze lijst staan, en de lijst moet overeenkomen met SecurityHeaders__AllowedScriptOrigins__0 op de host |
De VITE_*-namen bestaan alleen nog als omgevingsvariabele binnen de buildstap, niet meer in Gitea.
Runtime-instellingen van de applicatie (verbindingsstring, JWT, mail, Contact__*, Media__Directory, Sentry) zitten niet in de workflow maar in het omgevingsbestand op de host (shared/env, zie README en de hostdocumentatie). Voor de afbeeldingen van de Hero-module hoort daar Media__Directory bij, een map buiten de release (shared/media), die de deploy niet aanraakt; zie hero-module.md.
Runners
Alle jobs draaien op het label linux, zodat elke runner (de Pi en de desktop-runner) ze kan oppakken. Gebouwd wordt voor linux-arm64 (PUBLISH_RID), framework-dependent. Artefacten worden 1 dag bewaard.
Captcha
Het captcha van het contactformulier staat uit (Contact:Captcha:Enabled=false) tot Bryan een aanbieder kiest. De vergelijking van de opties, de gevolgen voor CSP, privacy en werk en de beslisrij staan in captcha-providers.md. Zet het captcha pas aan na dat besluit, met de sleutels alleen via omgevingsvariabelen.