Hacktoberfest 2026: những issue maintainer đã đánh dấu cho tháng Mười, đang mở và phù hợp người mới. Xem issue Hacktoberfest

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

Đang mở
  • Có gì không ổn?
#229 0 bình luận 0 reaction 0 người được giao Xem trên GitHub

Chưa có ai nhận issue này.

Đánh giá

Độ khó
3/5
Thời gian dự kiến
Nửa ngày
Mức phù hợp với người mới
58/100
Loại issue
Tài liệu
Độ rõ ràng
Khá rõ ràng
Mức độ hoạt động
Sôi nổi
Công nghệ
kubernetes, php
Lĩnh vực
documentation

Hướng nghiên cứu

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.

Do mô hình lập chỉ mục viết ra từ nội dung của issue.

Mô tả

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.
Ngôn ngữ chính
Vue
Star
0
Fork
0
Không có pull request nào được merge trong 30 ngày

Chuẩn bị môi trường

Dự án này không cung cấp dev container, Dockerfile hay hướng dẫn đóng góp, nên bạn cần tự thiết lập môi trường: hãy bắt đầu từ README và xem hướng dẫn đóng góp lần đầu của chúng tôi để biết các bước chung.

Bắt đầu từ đâu

  1. Đọc hết issue, rồi đọc hướng dẫn đóng góp của dự án.
  2. Bình luận trên issue rằng bạn sẽ nhận — tránh hai người làm cùng một việc.
  3. Fork repository và làm thay đổi trên một nhánh.
  4. Mở pull request có tham chiếu số hiệu của issue.

Issue khác của components-web-app/docs

Tất cả issue của components-web-app/docs

Issue tương tự

Thêm issue về Documentation

Nhận issue mới trong hộp thư của bạn

Bản tóm tắt ngắn những issue GitHub phù hợp với người mới.