Skip to content

docs: Complete the PIG 0.3.6 installation path, from release verification to a verified first session - #1039

Merged
adit-chandra merged 18 commits into
mainfrom
promptless/pig-storage-migrations-recovery-5163
Oct 16, 2026
Merged

adit-chandra merged 18 commits into
mainfrom
promptless/pig-storage-migrations-recovery-5163

Conversation

@promptless

@promptless promptless Bot commented Sep 21, 2026 •

Copy link
Copy Markdown
Contributor

Requested by: Adit Chandra

Proposed changes

Completes the self-hosted PIG trace analyzer installation docs for the current stable release, PIG 0.3.6 (stable catalog, 0.3.6 manifest), so an operator can go from prerequisites to a verified first trace and analysis on customer-owned AWS infrastructure. Entry point: Deploy trace analysis.

Sources: pig-deploy release commit db79db5 (examples, schemas/pigdeployment-spec.json, charts/pig-supervisor, CONTRACT.md, STORAGE.md, AWS example), the published pig-supervisor-0.3.6.tgz, analyzer source 625624a (the 0.3.6 analyzer commit), pig-toolchain main 4c02abf, and the PIG dashboard on Promptless/promptless main b46d4e7.

Install path (plan-your-deployment, deploy-on-aws, deploy-the-analyzer-worker)

  • Platform support table for 0.3.6 (Kubernetes ≥ 1.30, PostgreSQL 15–18, exactly one native object store, schema revision 5). AWS is the published target; the page says its release record does not include live end-to-end acceptance, and Azure/GCP stay experimental.
  • Ordered installation path from planning through verification, and fuller prerequisites (sizing, workload identity, DNS/TLS, cloud-agent public endpoint, model quota).
  • Analyzer registration with the current Dashboard labels and the working URL https://app.gopromptless.ai/pig/settings/workers (the old /instruction-hub/... link no longer resolves).
  • New step 1: in one working directory (PIG_RELEASE_DIR), download release.json, SHA256SUMS, the bootstrap chart, and the Terraform archive. Verify them against the stable catalog; the expected 0.3.6 digests are listed. The checksum commands work with GNU sha256sum or macOS shasum -a 256.
  • Cloud guides extract Terraform from the verified archive, save deployment-configuration.json in $PIG_RELEASE_DIR, return there before resuming Helm step 2, use -backend-config with encrypted, locked remote state and -lockfile=readonly, and pass the DB password as TF_VAR_postgres_password. AWS guide maps deployment_configuration to the DSN, CA ConfigMap, ServiceAccount annotation, and storage block.
  • Secrets and CA: pig-credentials (install-token, postgres-dsn, model-api-key for API-key auth), ConfigMap pig-postgres-ca/ca.pem, optional pig-migration owner DSN via spec.storage.postgres.migrationDsnSecretRef, and the least-privilege role grants (from STORAGE.md) on the PostgreSQL page.
  • Complete bootstrap values for ingress-nginx with a TLS Secret and for AWS ALB with ACM, including the required ingress.serviceName/hostname/ingressClassName (the earlier watchNamespace-only example fails to render).
  • A complete PIGDeployment with release channel, pin, and pause explained; Ready=True vs the Acceptance condition; DNS and HTTPS checks from the hosts' network (/healthz plus an unauthenticated policy request that must return 401); repository selection with the live Create Repo Issues / Propose Remediations labels and permissions; and a separate Enable trace analysis step for the existing Trace analyzer switch.
  • Ownership among Terraform, Kubernetes config/GitOps, the pig-supervisor Helm release, and the supervisor, consolidated in gitops-ownership.

Request limits and routes (networking-and-identity, manual-helm, configuration-reference)

  • Replaces "at least 10 MiB / nginx 10m" with both real limits: the collector's largest encoded request is 10 MiB (pig-toolchain MAX_TRANSPORT_BATCH_BYTES), and the analyzer accepts encoded bodies up to 2 × PIG_MAX_TRACE_BATCH_BYTES + 64 KiB (_native_trace_transport_body_limit, about 512 MiB at the 256 MiB decoded default). Examples use proxy-body-size: "256m", which matches the pig-deploy contract and fits both limits. Adds collector timeout guidance (10 s per read).
  • Method/path table for the five released routes, header forwarding (Authorization, cloud X-Promptless-Producer-Token), HTTPS without redirects, and public endpoints for cloud agents.

Enrollment and verification (enroll-your-hosts, verify-your-deployment, agent-setup-guide, September changelog)

  • Approval page moves to /pig/enroll. Adds a host-side upload check (collect --include-active → trace_upload_complete). Fixes the verification link.
  • Removes the enroll --device instructions, troubleshooting rows, agent-guide step, and the September changelog entry: device-code enrollment is not in the released toolchain (it exists only on an unmerged pig-toolchain branch).
  • Verification SQL now checks the same session end to end, matching the supervisor's acceptance check: enrolled host (agent_hosts), written object, succeeded run of the current revision (source_fingerprint = analysis_source_sha256), and hosted acknowledgement (projection_published_revision >= projection_revision). Adds the Dashboard Traces page checks, including the zero-findings text. repository_sha stays: the 0.3.6 analyzer still stores and logs it.

Carried and folded work

Separate CI fix (own commit)

Remaining dependencies and limits

Validation

  • Downloaded the v0.3.6 release assets. The step 1 checksum check passes with both sha256sum and shasum -a 256. release.json matches the catalog digest a4eafe78…af977, and the chart matches 5fc16c87…b74b (the OCI pull digest also matches the manifest). Ran the page's step 1 commands exactly as written.
  • helm lint and helm template (Helm 3.18.6) on the published 0.3.6 chart pass for both copy-paste bootstrap value sets. The rendered Ingress has the five exact paths in pig, and a watchNamespace-only file fails as expected.
  • The PIGDeployment example validates against the 0.3.6 schemas/pigdeployment-spec.json and the chart CRD, both as written and with migrationDsnSecretRef enabled; spec.endpoint is rejected.
  • terraform init -backend=false -lockfile=readonly and terraform validate (1.11.4) on the 0.3.6 AWS example from the verified archive pass.
  • npm run test:smoke passes 28 of 28 locally; before the test fix it failed on test 24 here and on main. test:search:build passes 14 of 14.
  • npm run build passes. Internal links and anchors on all changed pages resolve in the built site: 1,084 links checked, 0 broken. lint:md and lint:frontmatter pass. Vale reports no new findings.

Checklist

  • Instructions and examples match the current product behavior.
  • Links and image references are valid.
  • Changed pages render correctly.

Separate migration credential, migrate-before-serve schema validation,
PostgreSQL 15-18, content-addressed canonical objects with background
repair, worker maintenance commands, and /readyz across the
deploy-the-worker governance guide. Source: Promptless/promptless#5163.
@promptless promptless Bot added documentation Improvements or additions to documentation important not urgent Promptless/promptless#5163 labels Sep 21, 2026
@vercel

vercel Bot commented Sep 21, 2026 •

Copy link
Copy Markdown

The latest updates on your projects. Learn more about Vercel for GitHub.

Project Deployment Actions Updated
promptless-docs Ready Ready Preview Oct 15, 2026 10:36pm UTC

Request Review

…e-migrations-recovery-5163

# Conflicts:
#	src/content/docs/docs/governance/deploy-the-worker/manual-helm.mdx
@promptless
promptless Bot marked this pull request as ready for review October 5, 2026 21:36
@promptless
promptless Bot requested a review from hawkeyexl as a code owner October 5, 2026 21:36
promptless Bot added 2 commits October 5, 2026 21:41
… startup window, upload publication, readiness probe object, migration Job attempt
Comment thread src/content/docs/docs/governance/deploy-the-worker/observability.mdx Outdated
Comment thread src/content/docs/docs/governance/deploy-the-worker/manual-helm.mdx
@promptless promptless Bot changed the title docs: Document PIG storage-hardening operator model (schema revision 4) docs: Update PIG deployment docs for stable 0.3.4 (Helm-owned ingress, schema revision 4 storage) Oct 9, 2026
Comment thread src/content/docs/docs/governance/deploy-the-worker/postgresql.mdx
Comment thread src/content/docs/docs/governance/get-started/enroll-your-hosts.mdx
Comment thread src/content/docs/docs/governance/get-started/enroll-your-hosts.mdx
Comment thread src/content/docs/docs/governance/get-started/enroll-your-hosts.mdx
@adit-chandra
adit-chandra merged commit bc36138 into main Oct 16, 2026
6 checks passed
@promptless
promptless Bot deleted the promptless/pig-storage-migrations-recovery-5163 branch October 16, 2026 20:11
promptless Bot added a commit that referenced this pull request Oct 16, 2026
…ain main

Name analyzer 0.3.3 or later (stable 0.3.6) as the Cursor capability
requirement, add a Cursor collection section with hooks, launcher
requirements, scope, manual commands, and qualification status, add the
Windows APPDATA fallback and journal limits, move the changelog entry to
October 2026, and drop the unshipped --device entry that #1039 removed.
adit-chandra pushed a commit that referenced this pull request Oct 16, 2026
…+) (#1047)

* Document Cursor as a native trace source and enrollment host (PIG)

* style: remark-lint auto-fix

* docs: List Cursor as a native trace source on governance overview pages

* docs: Refresh Cursor trace collection against stable 0.3.6 and toolchain main

Name analyzer 0.3.3 or later (stable 0.3.6) as the Cursor capability
requirement, add a Cursor collection section with hooks, launcher
requirements, scope, manual commands, and qualification status, add the
Windows APPDATA fallback and journal limits, move the changelog entry to
October 2026, and drop the unshipped --device entry that #1039 removed.

* docs: Note the Cursor pending-notification limit

---------

Co-authored-by: promptless[bot] <promptless[bot]@users.noreply.github.com>
Co-authored-by: promptless[bot] <179508745+promptless[bot]@users.noreply.github.com>
adit-chandra pushed a commit that referenced this pull request Oct 16, 2026
* Document Cursor as a native trace source and enrollment host (PIG)

* style: remark-lint auto-fix

* docs: List Cursor as a native trace source on governance overview pages

* docs: Document cloud agent trace capture and PIG dashboard routes

* style: remark-lint auto-fix

* docs: Refresh Cursor trace collection against stable 0.3.6 and toolchain main

Name analyzer 0.3.3 or later (stable 0.3.6) as the Cursor capability
requirement, add a Cursor collection section with hooks, launcher
requirements, scope, manual commands, and qualification status, add the
Windows APPDATA fallback and journal limits, move the changelog entry to
October 2026, and drop the unshipped --device entry that #1039 removed.

* docs: Verify cloud agent capture against PIG 0.3.5+ and current sources

- Require PIG 0.3.5 or later in place of the release-notes hold.
- Separate the general HTTPS reachability requirement from Claude Tag's
  public-address requirement.
- Describe the Tag custom connector, proxy-mode variable conflict, bundled
  cloud-capture.json, filter timing, and Tag acceptance status.
- Correct 401/503/409 and bootstrap_upgrade_required troubleshooting.
- Remove the old-plugin host enrollment troubleshooting row.

* docs: Scope the public-endpoint requirement to Claude Tag on deploy pages

Cloud runners need an HTTPS address reachable from their sandbox; only
Claude Tag, whose Agent Proxy blocks private IP ranges, needs a public one.

* docs: Note the Cursor pending-notification limit

---------

Co-authored-by: promptless[bot] <promptless[bot]@users.noreply.github.com>
Co-authored-by: promptless[bot] <179508745+promptless[bot]@users.noreply.github.com>

This branch was successfully deployed

1 active deployment
Preview — e0bc606c Deployed Oct 15, 2026 by vercel[bot]
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant