Skip to content

Update from code changes: document sandbox egress allowlists - #437

Open
mintlify[bot] wants to merge 4 commits into
mainfrom
mintlify/9166e654
Open

Update from code changes: document sandbox egress allowlists#437
mintlify[bot] wants to merge 4 commits into
mainfrom
mintlify/9166e654

Conversation

@mintlify

@mintlify mintlify Bot commented Jul 27, 2026

Copy link
Copy Markdown
Contributor

Summary

Documents the sandbox egress API that restricts a sandbox's outbound traffic to an allowlist of destinations, the cluster-level toggle in the Porter Dashboard that turns enforcement on, and the in-cluster Service entry form that lets a restricted sandbox reach another workload on the same cluster. The allowlist accepts hostnames, wildcards, IP literals, CIDR ranges, and Service DNS names (name.namespace.svc.cluster.local), and is enforced transparently at the network layer so any client and protocol works without proxy configuration. Sandbox networking already documented that outbound traffic to in-cluster services and private address space is denied by default; this shipped adds the ability to further narrow outbound to a specific set of destinations and to selectively grant in-cluster access.

Changes

  • Consolidated egress guidance into a single "Restrict egress with an allowlist" section in sandboxes/networking.mdx covering the cluster-level enforcement toggle, the destination kinds table (including the in-cluster Service form), and Python and TypeScript examples.
  • Softened the "In-cluster services" row of the "What sandboxes can reach" table to point at the allowlist.
  • Updated the egress parameter row in the Python and TypeScript SDK references to mention in-cluster Service DNS names and link to the current section anchor.

Update history

  • Initial: documented the egress API surface (networking page + Python and TypeScript SDK references). Source: https://github.com/porter-dev/code/pull/7215.
  • Follow-up: noted the cluster Enforce egress allowlists toggle under Sandbox > Settings > Egress controls, and clarified that egress on a sandbox isn't enforced until it's turned on. Source: https://github.com/porter-dev/code/pull/7245.
  • Follow-up: after main merged in the consolidated egress section (which already covers in-cluster Service entries), removed the older duplicate section, updated the SDK reference links and blurbs to include the in-cluster Service form, and pointed at the current anchor. Source: https://github.com/porter-dev/code/pull/7265.

@mintlify

mintlify Bot commented Jul 27, 2026

Copy link
Copy Markdown
Contributor Author

Preview deployment for your docs. Learn more about Mintlify Previews.

Project Status Preview Updated (UTC)
porter 🟢 Ready View Preview Jul 27, 2026, 10:10 PM

@mintlify

mintlify Bot commented Jul 28, 2026

Copy link
Copy Markdown
Contributor Author

Update from code changes updated this PR.

Added note about the cluster egress enforcement toggle in Sandbox settings

Source PRs

@mintlify

mintlify Bot commented Jul 28, 2026

Copy link
Copy Markdown
Contributor Author

Update from code changes updated this PR.

Removed duplicate egress section and updated SDK references for Service entries

Source PRs

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.

0 participants