Skip to content

Commit 3154594

Browse files
Add system requirements to quick-start and single-cluster guides
1 parent d9838bd commit 3154594

2 files changed

Lines changed: 39 additions & 6 deletions

File tree

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

Lines changed: 33 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -13,12 +13,13 @@ Setting up OpenChoreo in a Kubernetes cluster involves multiple steps and tools.
1313
This dev container has all the necessary tools installed for setting up OpenChoreo and is ready to be used. Once the installation is complete, you can explore the underlying setup to understand how it works.
1414
When you're done, you can fully clean up the setup, leaving your machine clutter-free.
1515

16-
### Prerequisites
16+
## 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+
- Allocate at least **4 GB RAM** and **2 CPU** cores to Docker (or the VM running Docker).
2223
- **5–10 minutes of your time** – Setup is quick and depends on your internet connection speed.
2324

2425
## Start the Dev Container
@@ -199,3 +200,33 @@ After finishing your work, you have two options:
199200
That's it!
200201

201202
Now you understand how OpenChoreo simplifies the deployment and management of cloud-native applications.
203+
204+
## Troubleshooting
205+
206+
### Docker Environment Resource Issues
207+
208+
If you encounter issues during installation, first check if your Docker environment has sufficient memory and CPU resources:
209+
210+
```bash
211+
docker run --rm alpine:latest sh -c "echo 'Memory:'; free -h; echo; echo 'CPU Cores:'; nproc"
212+
```
213+
214+
Ensure you have at least 2GB of available memory and 2 CPU cores as outlined in the [Prerequisites](#prerequisites) section.
215+
216+
### Port Access Issues (Backstage and External Gateway)
217+
218+
If you're unable to access:
219+
- **Backstage** at `localhost:7007`
220+
- **External Gateway** at port `8443`
221+
222+
Run the following command inside the dev container to verify that the socat processes are running properly:
223+
224+
```bash
225+
ps aux | grep socat
226+
```
227+
228+
The socat processes are responsible for port forwarding between the dev container and your host machine. If these processes are not running, try running the install command again.
229+
230+
<CodeBlock language="bash">
231+
{`./install.sh --openchoreo-version ${versions.helmChart}`}
232+
</CodeBlock>

docs/getting-started/single-cluster.mdx

Lines changed: 6 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -13,10 +13,12 @@ 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+
- Allocate at least **8 GB RAM** and **4 CPU** cores to Docker (or the VM running Docker).
19+
- **[Kind](https://kind.sigs.k8s.io/docs/user/quick-start/#installation)** v0.20+ installed
20+
- **[kubectl](https://kubernetes.io/docs/tasks/tools/)** v1.32+ installed
21+
- **[Helm](https://helm.sh/docs/intro/install/)** v3.12+ installed
2022

2123
### Verify Prerequisites
2224

0 commit comments

Comments
 (0)