Skip to content

feat: add ZPan template#701

Open
saltbo wants to merge 2 commits into
labring-actions:kb-0.9from
saltbo:template/zpan
Open

feat: add ZPan template#701
saltbo wants to merge 2 commits into
labring-actions:kb-0.9from
saltbo:template/zpan

Conversation

@saltbo

@saltbo saltbo commented Jun 7, 2026

Copy link
Copy Markdown

Summary

  • Add a Sealos template for ZPan.
  • Deploy both the ZPan web service and downloader container in one StatefulSet.
  • Include the updated ZPan logo, English/Chinese README files, screenshot asset, persistent storage inputs, Service, and Ingress.

Validation

  • Parsed template/zpan/index.yaml with yq.
  • Checked generated logo and screenshot assets locally.

Note: the template pins ghcr.io/saltbo/zpan:2.7.1 and ghcr.io/saltbo/zpan:2.7.1-cli because the current latest tag resolves to the downloader image config, while 2.7.1 resolves to the web service image.

@yangchuansheng

Copy link
Copy Markdown
Collaborator

Thanks for adding the ZPan template. I reviewed it against the Sealos template rules, the README standard, and the screenshot SOP. I think this PR needs changes before merge.

Blocking / high-priority items:

  1. BETTER_AUTH_SECRET is missing, so the web container will fail at startup.

    • template/zpan/index.yaml:72-78 only sets PORT, BETTER_AUTH_URL, and DATABASE_URL.
    • Upstream ZPan requires BETTER_AUTH_SECRET; server/bootstrap.ts throws when it is empty.
    • Please generate this as a Sealos default secret value and pass it to the zpan container.
  2. The template is missing the final Sealos App resource.

    • template/zpan/index.yaml ends at the Ingress.
    • Please add apiVersion: app.sealos.io/v1, kind: App, spec.data.url, displayType, type: link, icon, and the usual cloud.sealos.io/app-deploy-manager label so the deployed app has the expected Canvas/App entry.
  3. The README files do not follow the Sealos README standard yet.

    • template/zpan/README.md and template/zpan/README_zh.md are only short post-deployment notes.
    • Please expand them with the standard structure: Deploy and Host ZPan on Sealos, About Hosting, Common Use Cases, Dependencies, Implementation Details, Why Deploy on Sealos, Deployment Guide, Configuration, Troubleshooting, and License.
    • The deployment guide should start from the App Store template page and Deploy Now, then describe first user creation, S3 storage setup, and downloader authorization.
  4. The Sealos quality gate currently fails on the template manifest.
    Main failures I saw:

    • missing spec.locale
    • duplicate i18n.zh.title matching spec.title
    • managed container names do not match workload metadata.name
    • PVC storage uses input variables instead of concrete quantities
    • Service is missing metadata.labels.app
    • Ingress is missing standard nginx annotations, and ssl-redirect is set to 'false'

    Command used:

    DOCKER_TO_SEALOS_ARTIFACTS=/Users/longnv/.codex/worktrees/f170/templates/template/zpan/index.yaml /usr/bin/python3 scripts/quality_gate.py
  5. website-screenshot.webp is currently a 630x630 logo image, not a product screenshot.

    • The screenshot SOP expects a real first-screen website/app capture for spec.screenshots.
    • GitHub repo metadata points to https://zpan.space as the homepage, while the current spec.url points to GitHub. The homepage redirects to a login page, so please either provide an acceptable public product/UI screenshot source or document the fallback choice clearly.

Additional checks run:

git diff --check upstream/kb-0.9...HEAD
sips -g pixelWidth -g pixelHeight template/zpan/website-screenshot.webp template/zpan/logo.png

git diff --check passed. The screenshot asset measured 630x630; the logo measured 1024x1024.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants