github/OpenHands
1
0
Fork 0
mirror of https://github.com/OpenHands/OpenHands.git synced 2025-12-26 05:48:36 +08:00
Code Issues Packages Projects Releases Wiki Activity

[docs] Update README.md for new OpenDevin Runtime (#3142)

Browse Source 
* Update README.md

* address comment

* remove DEBUG flag
This commit is contained in:
Xingyao Wang 2024-07-27 23:45:09 +08:00 committed by GitHub
parent a29c795418
commit b5d3fcaba8
No known key found for this signature in database
GPG Key ID: B5690EEEBB952194
1 changed files with 43 additions and 43 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

86
opendevin/runtime/client/README.md
View File

@ -7,6 +7,38 @@ This README provides an overview of the OpenDevin Runtime, a crucial component o
The following sections dive deeper into these topics, providing a comprehensive understanding of the OpenDevin Runtime system.
## Architecture Diagram
```
+-------------------+ +-------------------+
| OpenDevin | | Docker Host |
| Backend | | |
| | | +-------------+ |
| +-------------+ | | | Runtime | |
| | EventStream | | | | Container | |
| | Runtime |<-|-----|->| | |
| +-------------+ | | | +-------+ | |
| | | | |Runtime| | |
| | | | |Client | | |
| | | | +-------+ | |
| | | | | | |
| | | | +-------+ | |
| | | | |Plugins| | |
| | | | +-------+ | |
| | | +-------------+ |
+-------------------+ +-------------------+
```
This diagram illustrates the high-level architecture of the OpenDevin Runtime system:
1. The OpenDevin Backend communicates with the Docker Host through the EventStreamRuntime.
2. The Docker Host runs a Runtime Container, which includes:
- The Runtime Client: Handles incoming actions and generates observations.
- Plugins: Extend the functionality of the Runtime Client.
3. The Runtime Client executes actions within the sandboxed environment of the Docker container.
This architecture ensures a secure and flexible environment for executing AI-driven development tasks, allowing OpenDevin to execute a wide range of actions safely and efficiently.
## How the Runtime Image is Built
The OpenDevin runtime uses a layered approach for building Docker images:
@ -14,25 +46,27 @@ The OpenDevin runtime uses a layered approach for building Docker images:
1. **Original Image**: `ubuntu:22.04`
- This is the base image used for all subsequent layers.
2. **Runtime Image**: `od_runtime:ubuntu__22.04`
2. **Runtime Image**: `od_runtime:od_v{OPENDEVIN_VERSION}_image_ubuntu__22.04`
Example image name: `od_runtime:od_v0.8.1_image_ubuntu__22.04`
- Built from the stable release of OpenDevin.
- This is the primary runtime image that users will interact with.
- Created by copying all OpenDevin code into the original image and installing dependencies using Poetry.
3. **Dev Runtime Image**: `od_runtime_dev:ubuntu__22.04`
1. **Dev Runtime Image**: `od_runtime_dev:od_v{OPENDEVIN_VERSION}_image_ubuntu__22.04`
- Built from local source code for development purposes.
### Build Process
#### Production Build (DEBUG=false)
By default, when DEBUG is set to false, the build process only needs to run once:
- The Runtime Image (`od_runtime:ubuntu__22.04`) is created by copying OpenDevin code into the original Ubuntu image and installing all dependencies.
#### Production Build (if environment variable `SANDBOX_UPDATE_SOURCE_CODE` is not set)
By default, when `SANDBOX_UPDATE_SOURCE_CODE` is unset OR set to false, the build process only needs to run once:
- The Runtime Image (`od_runtime:od_v{OPENDEVIN_VERSION}_image_ubuntu__22.04`) is created by copying OpenDevin code into the original Ubuntu image and installing all dependencies.
- This pre-built image is then used for running the OpenDevin environment.
#### Development Build (DEBUG=true)
When developing or modifying code that runs inside the container, you can set DEBUG=true to enable a more dynamic build process:
#### Development Build (env var `SANDBOX_UPDATE_SOURCE_CODE=True`)
When developing or modifying code that runs inside the container, you can set env var `SANDBOX_UPDATE_SOURCE_CODE=True` to enable a more dynamic build process:
- Every time you run the code, the existing image will be updated with the latest changes.
- The Dev Runtime Image (`od_runtime_dev:ubuntu__22.04`) is rebuilt from the Runtime Image (`od_runtime:ubuntu__22.04`).
- The Dev Runtime Image (`od_runtime_dev:od_v{OPENDEVIN_VERSION}_image_ubuntu__22.04`) is rebuilt from the Runtime Image (`od_runtime:od_v{OPENDEVIN_VERSION}_image_ubuntu__22.04`).
- Most dependencies are already installed in the Runtime Image, so this process mainly updates the code and any new dependencies.
- The rebuild process typically takes around 10 seconds, allowing for quick iterations during development.
@ -72,39 +106,5 @@ The Runtime Client is a crucial component of the OpenDevin system, responsible f
- All actions are executed within the confined Docker environment, providing a sandbox for safe execution.
8. **Flexibility**:
- The system supports both production (DEBUG=false) and development (DEBUG=true) modes.
- The system supports both production (`SANDBOX_UPDATE_SOURCE_CODE=False`) and development (`SANDBOX_UPDATE_SOURCE_CODE=True`) modes.
- In development mode, the runtime image can be updated with the latest code changes for testing and debugging.
## Architecture Diagram
```
+-------------------+ +-------------------+
| OpenDevin | | Docker Host |
| Backend | | |
| | | +-------------+ |
| +-------------+ | | | Runtime | |
| | EventStream | | | | Container | |
| | Runtime |<-|-----|->| | |
| +-------------+ | | | +-------+ | |
| | | | |Runtime| | |
| | | | |Client | | |
| | | | +-------+ | |
| | | | | | |
| | | | +-------+ | |
| | | | |Plugins| | |
| | | | +-------+ | |
| | | +-------------+ |
+-------------------+ +-------------------+
```
This diagram illustrates the high-level architecture of the OpenDevin Runtime system:
1. The OpenDevin Backend communicates with the Docker Host through the EventStreamRuntime.
2. The Docker Host runs a Runtime Container, which includes:
- The Runtime Client: Handles incoming actions and generates observations.
- Plugins: Extend the functionality of the Runtime Client.
3. The Runtime Client executes actions within the sandboxed environment of the Docker container.
This architecture ensures a secure and flexible environment for executing AI-driven development tasks, allowing OpenDevin to execute a wide range of actions safely and efficiently.