Hacktoberfest 2026: the issues maintainers tagged for October, open and beginner-friendly. Browse Hacktoberfest issues

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

Open
  • Is something wrong?
#229 0 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

Assessment

Difficulty
3/5
Estimated time
Half a day
Newbie friendliness
58/100
Issue type
Documentation
Clarity
Mostly clear
Activity status
Active
Tech stack
kubernetes, php
Domain
documentation

Research direction

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.

Written by the indexing model from the issue text.

Description

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.
Dominant language
Vue
Stars
0
Forks
0
No merged PRs in 30d

Getting set up

This project ships no dev container, Dockerfile or contributing guide, so setting up is up to you: start from its README, and see our first-contribution guide for the general steps.

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

More from components-web-app/docs

All issues in components-web-app/docs

Similar issues

More Documentation issues

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.