Skip to content

Commit 0dfc0f3

Browse files
Mention system requirements in quick-start and single-cluster installation guides
1 parent d9838bd commit 0dfc0f3

File tree

2 files changed

+55
-5
lines changed

2 files changed

+55
-5
lines changed

docs/getting-started/quick-start-guide.mdx

Lines changed: 24 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -15,10 +15,33 @@ When you're done, you can fully clean up the setup, leaving your machine clutter
1515

1616
### Prerequisites
1717

18-
To get started, youll need:
18+
To get started, you'll need:
1919

2020
- **Docker** – Just have it installed on your machine, and you're good to go.
2121
- We recommend using [Docker Engine version 26.0+](https://docs.docker.com/engine/release-notes/26.0/).
22+
- **System Requirements** (for your Docker environment or VM running Docker):
23+
- **Minimum**: 4GB memory & 2 CPU cores.
24+
- **Recommended**: 8GB memory & 4 CPU cores.
25+
26+
:::tip
27+
You can check the available memory and allocated CPU cores in your docker environment using the following command.
28+
```bash
29+
docker run --pull=always --rm alpine:latest sh -c "echo 'Memory:'; free -h; echo; echo 'CPU Cores:'; nproc"
30+
```
31+
Sample output:
32+
```text
33+
Memory:
34+
total used free shared buff/cache available
35+
Mem: 3.8G 2.3G 78.6M 632.0M 1.5G 790.0M
36+
Swap: 0 0 0
37+
38+
CPU Cores:
39+
2
40+
```
41+
:::important
42+
You must have at least 2GB memory available (see the `available` column in the command output above) to install OpenChoreo.
43+
:::
44+
2245
- **5–10 minutes of your time** – Setup is quick and depends on your internet connection speed.
2346

2447
## Start the Dev Container

docs/getting-started/single-cluster.mdx

Lines changed: 31 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -13,10 +13,37 @@ This guide provides step-by-step instructions for setting up a local development
1313

1414
## Prerequisites
1515

16-
- [Docker](https://docs.docker.com/get-docker/) v20.10+ installed and running
17-
- [Kind](https://kind.sigs.k8s.io/docs/user/quick-start/#installation) v0.20+ installed
18-
- [kubectl](https://kubernetes.io/docs/tasks/tools/) v1.32+ installed
19-
- [Helm](https://helm.sh/docs/intro/install/) v3.12+ installed
16+
- **Docker** – Just have it installed on your machine, and you're good to go.
17+
- We recommend using [Docker Engine version 26.0+](https://docs.docker.com/engine/release-notes/26.0/).
18+
- **[Kind](https://kind.sigs.k8s.io/docs/user/quick-start/#installation)** v0.20+ installed
19+
- **[kubectl](https://kubernetes.io/docs/tasks/tools/)** v1.32+ installed
20+
- **[Helm](https://helm.sh/docs/intro/install/)** v3.12+ installed
21+
- **System Requirements** (for your Docker environment or VM running Docker):
22+
- **Minimum**: 4GB memory & 2 CPU cores.
23+
- **Recommended**: 8GB memory & 4 CPU cores.
24+
25+
:::note
26+
If you are installing [observability plane](#7-install-openchoreo-observability-plane-optional) you would need at least 8GB memory & 4 CPU cores.
27+
:::
28+
29+
:::tip
30+
You can check the available memory and allocated CPU cores in your docker environment using the following command.
31+
```bash
32+
docker run --pull=always --rm alpine:latest sh -c "echo 'Memory:'; free -h; echo; echo 'CPU Cores:'; nproc"
33+
```
34+
Sample output:
35+
```text
36+
Memory:
37+
total used free shared buff/cache available
38+
Mem: 3.8G 2.3G 78.6M 632.0M 1.5G 790.0M
39+
Swap: 0 0 0
40+
41+
CPU Cores:
42+
2
43+
```
44+
:::important
45+
You must have at least 2GB memory available (see the `available` column in the command output above) to install OpenChoreo.
46+
:::
2047

2148
### Verify Prerequisites
2249

0 commit comments

Comments
 (0)