Hacktoberfest 2026: le issue che i maintainer hanno segnato per ottobre, aperte e adatte ai principianti. Sfoglia le issue Hacktoberfest

Document silverback:api-components:warm-http-cache (warming the API cache before a pod takes traffic)

Aperta
  • Qualcosa non va?
#229 0 commenti 0 reazioni 0 assegnatari Vedi su GitHub

Nessuno ha ancora preso questa issue.

Valutazione

Difficoltà
3/5
Tempo stimato
Mezza giornata
Idoneità per principianti
58/100
Tipo di issue
Documentazione
Chiarezza
Abbastanza chiara
Stato di attività
Attiva
Stack tecnologico
kubernetes, php
Ambito
documentation

Direzione di ricerca

Start with the command's source and options in the linked bundle PR (components-web-app/api-components-bundle#443, issue #442) and the existing API deployment / HTTP cache docs. Add a section for silverback:api-components:warm-http-cache covering purpose, each option with its default, the skip rules, the exit codes, and the note that --base-url must reach Caddy rather than PHP. Done when the section matches the command's actual flags and behaviour in that PR and the Kubernetes postStart example is included.

Scritto dal modello di indicizzazione a partire dal testo della issue.

Descrizione

Bundle: components-web-app/api-components-bundle#442, PR components-web-app/api-components-bundle#443.

New console command silverback:api-components:warm-http-cache to document in the API section (deployment / HTTP cache):

  • Purpose: a new API pod starts with an empty Souin cache and cold PHP. The command requests, through the cache, what SSR fetches for each live public route (route lookup, resource_manifest, every resource in the manifest; only the lookup for a redirect), so the first visitors hit a warm cache. Intended for a time-limited Kubernetes postStart hook (components-web-app/components-web-app#160), e.g. bin/console silverback:api-components:warm-http-cache --max-time=240 || true.
  • Options: --base-url (default http://localhost, the Caddy in the pod), --path (repeatable), --limit (shortest paths first), --concurrency (default 2), --max-time (stops starting requests, still exit 0), --timeout (per request, default 30s), --accept-encoding (default gzip, or none).
  • Behaviour: anonymous requests only; draft, scheduled, ancestor-gated and route_security routes are skipped. Exits 0 whatever the responses; invalid options exit 2. Prints requests, cache hits/misses, failures and the slowest requests; -v lists failures.
  • Why the headers matter: entries are only useful under SSR's exact cache key, so the command sends the module's Accept, preload and path headers and gzip encoding, and uses a dotless host so it maps to BROWSER_SERVER_NAME. Worth a note that --base-url must reach Caddy, not PHP directly, or nothing is cached.
Lingua principale
Vue
Stelle
0
Fork
0
Nessuna PR unita negli ultimi 30g

Preparare l'ambiente

Questo progetto non fornisce container di sviluppo, Dockerfile né guida per i contributori, quindi l'ambiente è a tuo carico: parti dal suo README e consulta la nostra guida al primo contributo per i passaggi generali.

Come iniziare

  1. Leggi tutta la issue e poi la guida ai contributi del progetto.
  2. Commenta sulla issue per dire che te ne occupi tu — evita che due persone facciano lo stesso lavoro.
  3. Fai un fork del repository e lavora su un branch.
  4. Apri una pull request che faccia riferimento al numero della issue.

Altre issue di components-web-app/docs

Tutte le issue di components-web-app/docs

Issue simili

Altre issue su Documentation

Ricevi le nuove issue nella tua casella

Un breve riepilogo di issue GitHub adatte ai principianti.