Open-source, secure environment with real-world tools for enterprise-grade agents.
Python agentaiai-agentai-agentscode-interpretercopilotdevelopmentdevtoolsgptgpt-4javascriptllmnextjsopenaipythonreactsoftwaretypescript
BYOC Docs page (#853)
Jiri Sveceny22df213ffbe1
diff --git a/apps/web/src/app/(docs)/docs/byoc/page.mdx b/apps/web/src/app/(docs)/docs/byoc/page.mdxnew file mode 100644index 000000000..c74c3338e--- /dev/null+++ b/apps/web/src/app/(docs)/docs/byoc/page.mdx@@ -0,0 +1,74 @@+import Image from 'next/image'+import imgArchitectureDiagram from '@/images/byoc-architecture-diagram.png'++# BYOC (Bring Your Own Cloud)++BYOC (Bring Your Own Cloud) allows you to deploy E2B sandboxes to your own cloud infrastructure within your VPC.++BYOC is currently only available for AWS. We are working on adding support for Google Cloud and Azure.++<Note>+BYOC is offered to enterprise customers only.+If you’re interested in BYOC offering, please book a call with our team [here](https://e2b.dev/contact) or contact us at [[email protected]](mailto:[email protected]).+</Note>++## Architecture++Sandbox templates, snapshots, and runtime logs are stored within the customer's BYOC VPC.+Anonymized system metrics such as cluster memory and cpu are sent to the E2B Cloud for observability and cluster management purposes.++All potentially sensitive traffic, such as sandbox template build source files,+sandbox traffic, and logs, is transmitted directly from the client to the customer's BYOC VPC without ever touching the E2B Cloud infrastructure.++### Glossary+- **BYOC VPC**: The customer's Virtual Private Network where the E2B sandboxes are deployed. For example your AWS account.+- **E2B Cloud**: The managed service that provides the E2B platform, observability and cluster management.+- **OAuth Provider**: Customer-managed service that provides user and E2B Cloud with access to the cluster.++<Image+ src={imgArchitectureDiagram}+ className="rounded w-full"+ alt="Graphics explaining key BYOC architecture parts"+ unoptimized+/>++### BYOC Cluster Components+- **Orchestrator**: Represents a node that is responsible for managing sandboxes and their lifecycle. Optionally, it can also run the template builder component.+- **Edge Controller**: Routes traffic to sandboxes, exposes API for cluster management, and gRPC proxy used by E2B control plane to communicate with orchestrators.+- **Monitoring**: Collector that receives sandbox and build logs and system metrics from orchestrators and edge controllers. Only anonymized metrics are sent to the E2B Cloud for observability purposes.+- **Storage**: Persistent storage for sandbox templates, snapshots, and runtime logs. Image container repository for template images.++## Onboarding++Customers can initiate the onboarding process by reaching out to us.+Customers need to have a dedicated AWS account and know the region they will use.+After that, we will receive the IAM role needed for managing account resources.+For AWS account quota limits may need to be increased.++Terraform configuration and machine images will be used for provisioning BYOC cluster.+When provisioning is done and running, we will create a new team under your E2B account that can be used by SDK/CLI the same way as it is hosted on E2B Cloud.++## FAQ++### How Is Cluster Monitored?++Cluster is forwarding anonymized metrics such as machine cpu/memory usage to E2B Control plane for advanced observability and alerting.+The whole observability stack is anonymized and does not contain any sensitive information.++### Can cluster automatically scale?++A cluster can be scaled horizontally by adding more orchestrators and edge controllers.+The autoscaler is currently in V1 not capable of automatically scale orchestrator nodes that are needed for sandbox spawning.+This feature is coming in the next versions.++### Are sandboxes accessible only from a customer’s private network?++Yes. Load balancer that is handling all requests coming to sandbox can be configured as internal and VPC peering+with additional customer’s VPC can be configured so sandbox traffic can stay in the private network.++### How control plane secure communication is ensured?++Data sent between the E2B Cloud and your BYOC VPC is encrypted using TLS.++VPC peering can be established to allow direct communication between the E2B Cloud and your BYOC VPC.+When using VPC peering, the load balancer can be configured as private without a public IP address.\ No newline at end of filediff --git a/apps/web/src/components/Navigation/routes.tsx b/apps/web/src/components/Navigation/routes.tsxindex 55a8be8ed..4fb85fc93 100644--- a/apps/web/src/components/Navigation/routes.tsx+++ b/apps/web/src/components/Navigation/routes.tsx@@ -456,6 +456,15 @@ export const docRoutes: NavGroup[] = [},],},+ {+ title: 'Deployment',+ items: [+ {+ title: 'Bring Your Own Cloud',+ href: '/docs/byoc',+ },+ ],+ },{title: 'Troubleshooting',items: [diff --git a/apps/web/src/images/byoc-architecture-diagram.png b/apps/web/src/images/byoc-architecture-diagram.pngnew file mode 100644index 000000000..eb8e3e0ebBinary files /dev/null and b/apps/web/src/images/byoc-architecture-diagram.png differ