Skip to content

Commit 002ea81

Browse files
jardondiegoDiego Jardon
andauthored
Add documentation for use of Dev Containers (#5181)
Follow-up to #5179 Co-authored-by: Diego Jardon <jardondiego@google.com>
1 parent 5fd88b3 commit 002ea81

File tree

2 files changed

+26
-0
lines changed

2 files changed

+26
-0
lines changed

docs/getting-started/local_instance.md

Lines changed: 24 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -21,6 +21,30 @@ lack of Google Cloud emulators.
2121

2222
---
2323

24+
## Development Containers (Recommended)
25+
26+
Devcontainers provide a consistent and reproducible development environment by containerizing the setup. This eliminates environment-specific issues and significantly simplifies onboarding for new developers.
27+
28+
### Prerequisites
29+
30+
- [Docker Desktop](https://www.docker.com/products/docker-desktop/) or another Docker-compatible engine.
31+
- [Visual Studio Code](https://code.visualstudio.com/).
32+
- [Dev Containers extension for VS Code](https://marketplace.visualstudio.com/items?itemName=ms-vscode-remote.remote-containers).
33+
34+
### Getting Started
35+
36+
1. Open the ClusterFuzz repository in VS Code.
37+
2. VS Code should prompt you to "Reopen in Container". If not, press `F1` (or `Ctrl+Shift+P` / `Cmd+Shift+P`) and select **Dev Containers: Reopen in Container**.
38+
3. The first time you do this, it will build the container image and run `local/install_deps.bash`. This may take several minutes.
39+
4. Once the setup is complete, you will have a fully configured environment with Python 3.11, Java 21, and all necessary dependencies.
40+
41+
**Tip:** Since devcontainers already have all dependencies installed, you can speed up the server startup by using the `--skip-install-deps` flag:
42+
```bash
43+
python butler.py run_server --skip-install-deps
44+
```
45+
46+
You can then run the local server or bot as described in the following sections.
47+
2448
## Running a local server
2549

2650
You can start a local server by running the following command:

docs/getting-started/prerequisites.md

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -47,6 +47,8 @@ where X.Y.Z is the release version (for example, 1.0.1).
4747

4848
## Installing prerequisites
4949

50+
**Note:** If you want a consistent environment without manual setup, we highly recommend using [Development Containers]({{ site.baseurl }}/getting-started/local-instance/#development-containers-recommended).
51+
5052
### Google Cloud SDK
5153

5254
This step is only necessary on the **macOS** platform. For **Linux** user, Google Cloud SDK

0 commit comments

Comments
 (0)