Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
51 changes: 45 additions & 6 deletions docs/getting-started/quick-start-guide.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -13,12 +13,13 @@ Setting up OpenChoreo in a Kubernetes cluster involves multiple steps and tools.
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.
When you're done, you can fully clean up the setup, leaving your machine clutter-free.

### Prerequisites
## Prerequisites

To get started, youll need:
To get started, you'll need:

- **Docker** – Just have it installed on your machine, and you're good to go.
- We recommend using [Docker Engine version 26.0+](https://docs.docker.com/engine/release-notes/26.0/).
- Allocate at least **4 GB RAM** and **2 CPU** cores to Docker (or the VM running Docker).
- **5–10 minutes of your time** – Setup is quick and depends on your internet connection speed.

## Start the Dev Container
Expand All @@ -45,7 +46,9 @@ To begin the installation, run:
{`./install.sh --openchoreo-version ${versions.helmChart}`}
</CodeBlock>

**💡 Tip:** If you previously used this setup and encounter errors during installation, ensure you perform the proper cleanup as outlined in the [Cleaning up](#cleaning-up) section before starting again.
:::tip
This installation script is idempotent - you can safely run it multiple times without issues. If you exit the dev container or stop the process at any point, simply restart the container and re-run the script to continue where you left off.
:::

Once the installation is complete, you will see the following confirmation message:
```text
Expand Down Expand Up @@ -94,10 +97,12 @@ Once the installation is complete, you will see the following confirmation messa
======================================================================
```

**📝 Note:** If you see any components are still in the `pending` state, you can check the status again in few minutes. Run the following command to check the installation status of components:
:::note
If you see any components are still in the `pending` state, you can check the status again in few minutes. Run the following command to check the installation status of components:
```bash
./check-status.sh
```
:::

#### Accessing the Backstage Developer Portal

Expand Down Expand Up @@ -179,9 +184,13 @@ To inspect these resources in more detail, run the following commands:
kubectl get components
```

**💡 Tip:** You can try out more samples on this setup. Check out our <Link to={`https://github.com/openchoreo/openchoreo/tree/${versions.githubRef}/samples`}>Samples</Link> for more details. The samples are also available in the dev container at `/samples`.
:::tip
You can try out more samples on this setup. Check out our <Link to={`https://github.com/openchoreo/openchoreo/tree/${versions.githubRef}/samples`}>Samples</Link> for more details. The samples are also available in the dev container at `/samples`.
:::

**⚠️ Important:** If you try out samples in the dev container, you don't need to expose the OpenChoreo Gateway to your host machine. The OpenChoreo gateway is already exposed to host machine via dev container port 8443.
:::important
If you try out samples in the dev container, you don't need to expose the OpenChoreo Gateway to your host machine. The OpenChoreo gateway is already exposed to host machine via dev container port 8443.
:::

### Cleaning up
After finishing your work, you have two options:
Expand All @@ -199,3 +208,33 @@ After finishing your work, you have two options:
That's it!

Now you understand how OpenChoreo simplifies the deployment and management of cloud-native applications.

## Troubleshooting

### Docker Environment Resource Issues

If you encounter issues during installation, first check if your Docker environment has sufficient memory and CPU resources:

```bash
docker run --rm alpine:latest sh -c "echo 'Memory:'; free -h; echo; echo 'CPU Cores:'; nproc"
```

Ensure you have at least 2GB of available memory and 2 CPU cores as outlined in the [Prerequisites](#prerequisites) section.

### Port Access Issues (Backstage and External Gateway)

If you're unable to access:
- **Backstage** at `localhost:7007`
- **External Gateway** at port `8443`

Run the following command inside the dev container to verify that the socat processes are running properly:

```bash
ps aux | grep socat
```

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.

<CodeBlock language="bash">
{`./install.sh --openchoreo-version ${versions.helmChart}`}
</CodeBlock>
10 changes: 6 additions & 4 deletions docs/getting-started/single-cluster.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -13,10 +13,12 @@ This guide provides step-by-step instructions for setting up a local development

## Prerequisites

- [Docker](https://docs.docker.com/get-docker/) v20.10+ installed and running
- [Kind](https://kind.sigs.k8s.io/docs/user/quick-start/#installation) v0.20+ installed
- [kubectl](https://kubernetes.io/docs/tasks/tools/) v1.32+ installed
- [Helm](https://helm.sh/docs/intro/install/) v3.12+ installed
- **Docker** – Just have it installed on your machine, and you're good to go.
- We recommend using [Docker Engine version 26.0+](https://docs.docker.com/engine/release-notes/26.0/).
- Allocate at least **8 GB RAM** and **4 CPU** cores to Docker (or the VM running Docker).
- **[Kind](https://kind.sigs.k8s.io/docs/user/quick-start/#installation)** v0.20+ installed
- **[kubectl](https://kubernetes.io/docs/tasks/tools/)** v1.32+ installed
- **[Helm](https://helm.sh/docs/intro/install/)** v3.12+ installed

### Verify Prerequisites

Expand Down