Skip to content

Conversation

@agents-git-bot
Copy link
Contributor

@agents-git-bot agents-git-bot bot commented Nov 27, 2025

Summary

Document the new Docker image variants introduced in cloudflare/sandbox-sdk#259.

Key changes:

  • Two image variants: default (lean, ~600-800MB) and -python (~1.3GB)
  • Breaking change: Default image no longer includes Python starting v0.6.0
  • Python execution requires explicit -python variant
  • New PYTHON_NOT_AVAILABLE error code when Python is attempted on lean image

Documentation updates

Configuration: Dockerfile reference

  • Document two image variants with size comparisons
  • Add breaking change notice with migration guide (v0.5.x → v0.6.0+)
  • Provide guidance on choosing the appropriate image variant
  • Update all examples to show correct image selection

API: Code Interpreter

  • Add prominent notice about Python image requirement
  • Document PYTHON_NOT_AVAILABLE error behavior
  • Link to Dockerfile reference for image variant details

Concepts: Container runtime

  • Update description to reflect two available variants
  • Add note about Python package installation requirements
  • Clarify which features require which image variant

Migration guide for users

Users running Python code must update their Dockerfile:

# Before (v0.5.x)
FROM docker.io/cloudflare/sandbox:0.5.6

# After (v0.6.0+)
FROM docker.io/cloudflare/sandbox:0.6.0-python

Related PR

@github-actions
Copy link
Contributor

github-actions bot commented Nov 27, 2025

This pull request requires reviews from CODEOWNERS as it changes files that match the following patterns:

Pattern Owners
/src/content/docs/sandbox/ @whoiskatrin, @ghostwriternr, @cloudflare/pcx-technical-writing, @cloudflare/ai-agents

@agents-git-bot agents-git-bot bot requested a review from a team as a code owner November 27, 2025 17:14
@agents-git-bot
Copy link
Contributor Author

Additional Documentation Added

I've added the following documentation to complete the sync for PR #259:

Changelog Entry

Created 2025-11-27-sandbox-lean-python-image-variants.mdx with:

  • Overview of lean and Python image variants
  • Migration guide for Python users
  • Benefits explanation (faster cold starts, lower storage costs)

Code Interpreter API Warning

Added a caution callout to /sandbox/api/interpreter/ explaining:

  • Python execution requires the -python image variant
  • JavaScript/TypeScript work with the default image
  • Link to Dockerfile reference for details

All documentation now references version 0.6.0 consistently with the existing Dockerfile updates on this branch.

🤖 Generated with Claude Code

@agents-git-bot
Copy link
Contributor Author

Updated documentation to reflect image variants introduced in cloudflare/sandbox-sdk#259:

Changes:

  • Updated Dockerfile reference with lean and Python image variants
  • Added error handling documentation for PYTHON_NOT_AVAILABLE error in Code Interpreter API
  • Aligned version numbers to 0.5.6
  • Maintained existing migration guide

The documentation now clearly explains when to use each image variant and how to handle Python availability errors.

Sync documentation for PR #259: Optimize Docker image size with lean and Python variants

Changes:
- Add documentation for two image variants (default and -python)
- Include breaking change notice for Python users
- Add migration guide from v0.5.x to v0.6.0+
- Document PYTHON_NOT_AVAILABLE error behavior
- Update all examples to show appropriate image selection
- Clarify Python availability requirements in Code Interpreter API

Related upstream PR: cloudflare/sandbox-sdk#259
@agents-git-bot
Copy link
Contributor Author

Documentation sync updated

Updated documentation based on latest changes in sandbox-sdk#259.

Changes in this update:

  • ✅ Comprehensive migration guide for v0.5.x → v0.6.0+ users
  • ✅ Clear breaking change notice for Python users
  • ✅ Image variant selection guidance
  • PYTHON_NOT_AVAILABLE error documentation
  • ✅ Updated all relevant examples and cross-references

Files modified:

  • src/content/docs/sandbox/configuration/dockerfile.mdx - Image variants, migration guide, selection criteria
  • src/content/docs/sandbox/api/interpreter.mdx - Python image requirement notice
  • src/content/docs/sandbox/concepts/containers.mdx - Runtime variant information

Ready for review! 🚀

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

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants