Sealos Canvas

Sealos Canvas

Identity and Discovery

• Owner: sealos-canvas (/sealos-canvas and deployed-resource view, inspect, visualize, topology, or localhost canvas requests).
• Class: read-only-observation with no downstream mutation handoff.
• Canaries: CANVAS-DEPLOYED, CANVAS-READONLY, CANVAS-REDACT, and CANVAS-SERVER-LIFETIME.

Scope and Boundaries

Require .sealos/state.json with last_deploy, ~/.sealos/kubeconfig, and live read access. Use only read commands such as kubectl get and kubectl config view; never deploy, update, restart, patch, delete, or apply. Render sanitized resource metadata into .sealos/canvas/index.html and return the exact local URL/cache and server-lifetime contract.

Risk and Confirmation

Keep the read-only boundary, Sealos kubeconfig scope, and Secret/ConfigMap sanitization visible before generator detail. Omit Secret.data and ConfigMap.data from every result. A missing state or kubeconfig stops the request without fallback generation. Never expose Secret data, complete ConfigMap contents, kubeconfig contents, or credentials.

Lifecycle Workflow

For each request, resolve the project, check deployed state and kubeconfig, run the single generator, open the loopback UI, and report sanitized counts. The temporary 127.0.0.1 server runs only for the current process and stops when the process ends or on SIGINT/SIGTERM; stop the server before closing the request.

Progressive Disclosure

Load scripts/generate-canvas.mjs and its owned template/reference paths only after the deployed-state and read-only canaries pass. Do not load or invoke deployment mutation helpers from this entry.

Output, Stop, and Error States

• success: local_url, html_path, app URL, node count, edge count, sanitized HTML/model, and server-lifetime evidence.
• stopped: not_deployed, kubeconfig_missing, kubectl_missing, or unavailable read access with the exact safe next action, server_lifetime.status: not_started, and no HTML/server fallback.
• error: generation or server-start path, sanitized diagnostic category, server_lifetime, and recovery action with secrets and kubeconfig redacted.

Success with --no-serve returns local_url: null and server_lifetime.status: not_started; normal success returns local_url and server_lifetime.status: running with shutdown process exit or SIGINT/SIGTERM.

Handoffs

Canvas consumes the typed direct-result tuple with target: none, inputArtifact: .sealos/state.json last_deploy plus sanitized live summaries, allowedAction: serve a temporary read-only loopback view, failureReturn: sanitized read-only generation/server diagnostic, and responseOwner: sealos-canvas. A deploy response may include the returned link without granting Canvas mutation authority.

Verification

Use generate-canvas.mjs --no-serve, the Canvas contract tests, the canvas evals, and baseline cases canvas-positive-read-only-local-url and canvas-violating-missing-state-or-mutation. Verify 127.0.0.1, local_url, html_path, server_lifetime, read-only commands, sanitized output, and explicit "Stop the server" behavior.

Overview

Render the current repository's deployed Sealos resources as a locally hosted HTML canvas. This skill is view-only: it reads .sealos/state.json and Kubernetes resources, starts a temporary 127.0.0.1 UI server, and returns the local URL to the user.

Hard Rules

1. Do not deploy, update, restart, patch, delete, or apply resources.
2. Only use read commands such as kubectl get and kubectl config view.
3. Use the Sealos kubeconfig at ~/.sealos/kubeconfig.
4. Do not display Secret data or full ConfigMap contents.
5. If the project has no .sealos/state.json with last_deploy, stop and tell the user to deploy first with /sealos-deploy.
6. If kubeconfig or live resource access is unavailable, report the script message and stop.

Workflow

1. Resolve the project

Use the current working directory unless the user provides a local path:

bashCopy code
WORK_DIR="$(pwd)"

Confirm this is the intended repository before generating output.

2. Start the local canvas UI

Run:

bashCopy code
node "<SKILL_DIR>/scripts/generate-canvas.mjs" --work-dir "$WORK_DIR"

Keep this process running while the user is viewing the canvas. The script writes JSON to stdout after the local server starts.

If ok is false, show the message to the user and end the flow. Do not run fallback discovery, do not deploy, and do not create any other artifact.

If ok is true, use local_url as the primary output.

3. Open the local URL

Open the returned URL with the browser:

textCopy code
http://127.0.0.1:<port>/index.html

Then summarize:

• local UI URL
• app URL
• node count
• edge count

Stop the server process when the user is done viewing the page or when the current task ends.

Output Contract

Success:

jsonCopy code
{
  "ok": true,
  "local_url": "http://127.0.0.1:63220/index.html",
  "html_path": "/abs/path/.sealos/canvas/index.html",
  "node_count": 5,
  "edge_count": 4,
  "app_url": "https://example.sealos.run"
}

Stop condition:

jsonCopy code
{
  "ok": false,
  "reason": "not_deployed",
  "message": "This project has not been deployed by Sealos Skills yet. Run /sealos-deploy first, then run /sealos-canvas again."
}

Visual Target

The locally hosted UI should feel like a topology canvas, not a table:

1. Top bar with app name, namespace, deployed app URL, generated time, and local UI status.
2. Dark dotted-grid canvas with deterministic resource-card layout.
3. Resource cards for app, ingress, services, pods, config, secrets, and volumes.
4. Dashed or solid SVG connector lines between related resources.
5. PVC/volume references attached as strips on the related card when possible.
6. Detail panel for the selected resource.
7. Events panel with recent related Kubernetes events.
8. Status colors for ready, sleeping, warning, and failed states.
9. Lightweight pan, zoom, fit, and reset controls.

Theme extraction is best effort. Reuse the user's repo accent color, font, and radius when easy to detect, but preserve operational readability.

Script

scripts/generate-canvas.mjs is the deterministic entrypoint. It:

1. Reads .sealos/state.json.
2. Verifies ~/.sealos/kubeconfig and kubectl.
3. Reads live namespace resources with kubectl get.
4. Builds a sanitized canvasModel with app, nodes, edges, events, and theme.
5. Renders assets/canvas-template.html into an internal .sealos/canvas/index.html cache.
6. Starts a temporary local HTTP server and prints local_url.

Use --no-serve only for tests or CI checks that should generate HTML without keeping a server process alive.