You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
@@ -9,20 +9,22 @@ import {versions} from '../_constants.mdx';
9
9
10
10
# Single Cluster Setup
11
11
12
-
This guide provides step-by-step instructions for setting up a local development environment for OpenChoreo using k3d (k3s in Docker).
12
+
This guide describes how to set up a local OpenChoreo development environment using k3d (k3s in Docker) with pre-built images and Helm charts from the OpenChoreo registry.
Before proceeding, verify that all tools are installed and meet the minimum version requirements:
27
+
Run the following commands to confirm that all prerequisites are available:
26
28
27
29
```bash
28
30
# Check Docker (should be v20.10+)
@@ -36,56 +38,58 @@ kubectl version --client
36
38
37
39
# Check Helm (should be v3.12+)
38
40
helm version --short
39
-
```
40
-
41
-
Make sure Docker is running:
42
41
43
-
```bash
42
+
# Confirm Docker is running
44
43
docker info
45
44
```
45
+
</div>
46
46
47
47
:::note
48
-
If you're using **Colima**, set the `K3D_FIX_DNS=0` environment variable when creating clusters to avoid DNS issues. See [k3d-io/k3d#1449](https://github.com/k3d-io/k3d/issues/1449) for more details.
48
+
If you're using **Colima**, set the `K3D_FIX_DNS=0` environment variable when creating clusters to avoid DNS issues. See [k3d-io/k3d#1449](https://github.com/k3d-io/k3d/issues/1449) for details.
49
49
:::
50
+
</div>
50
51
51
-
## Quick Setup
52
-
53
-
This setup uses pre-built images and Helm charts from the OpenChoreo registry.
54
-
55
-
56
-
### 1. Create OpenChoreo k3d Cluster
52
+
<divclassName="step-card">
53
+
<divclassName="step-header">
54
+
<divclassName="step-header-icon">1</div>
55
+
<divclassName="step-header-text">Create the OpenChoreo k3d Cluster</div>
56
+
</div>
57
57
58
58
Create a new k3d cluster using the provided configuration:
-Sets the active `kubectl` context to **k3d-openchoreo**
73
73
74
74
:::tip
75
-
For faster setup or if you have slow network, consider preloading images after creating the cluster. See the [Image Preloading section](#image-preloading-optional)at the end of this guide.
75
+
For faster setup or slow networks, preload images after creating the cluster. See the [Image Preloading](#image-preloading-optional)section.
76
76
:::
77
77
78
78
Verify the cluster is running:
79
79
80
80
```bash
81
81
kubectl get nodes
82
82
```
83
+
All nodes should report a `Ready` status.
84
+
</div>
83
85
84
-
You should see nodes in `Ready` status.
86
+
<divclassName="step-card">
87
+
<divclassName="step-header">
88
+
<divclassName="step-header-icon">2</div>
89
+
<divclassName="step-header-text">Install the OpenChoreo Control Plane</div>
90
+
</div>
85
91
86
-
### 2. Install OpenChoreo Control Plane
87
-
88
-
Install the OpenChoreo control plane using the following helm install command. This will create the `openchoreo-control-plane` namespace automatically:
92
+
Install the control plane components. The `openchoreo-control-plane` namespace is created automatically:
Wait for the installation to complete, then verify that all pods are running:
123
132
124
133
```bash
125
134
kubectl get pods -n openchoreo-data-plane
126
135
```
127
136
128
-
You should see pods for:
129
-
-`envoy-gateway-*`(Running)
130
-
-`external-secrets-*` (3 pods, all Running)
137
+
You should see running pods for:
138
+
-`envoy-gateway-*`
139
+
-`external-secrets-*` (3 pods)
131
140
-`fluent-bit-*` (Running on each node)
132
-
-`gateway-external-*` (Running)
133
-
134
-
### 4. Install OpenChoreo Build Plane (Optional)
141
+
-`gateway-external-*`
142
+
</div>
135
143
136
-
The Build Plane is required if you plan to use OpenChoreo's internal CI capabilities. If you're only deploying pre-built container images, you can skip this step.
144
+
<divclassName="step-card">
145
+
<divclassName="step-header">
146
+
<divclassName="step-header-icon">4</div>
147
+
<divclassName="step-header-text">Install the OpenChoreo Build Plane (Optional)</div>
148
+
</div>
137
149
138
-
Install the OpenChoreo build plane using the following helm install command for CI/CD capabilities. This will create the `openchoreo-build-plane` namespace automatically:
150
+
Install this plane if you plan to use OpenChoreo’s internal CI capabilities. The `openchoreo-build-plane` namespace is created automatically. If you're only deploying pre-built container images, you can skip this step.
<divclassName="step-header-text">Install the OpenChoreo Observability Plane (Optional)</div>
210
+
</div>
193
211
194
-
Install the OpenChoreo observability plane using the following helm install command for monitoring and logging capabilities. This will create the `openchoreo-observability-plane` namespace automatically:
212
+
Install the observability plane components. The `openchoreo-observability-plane` namespace is created automatically:
If the indices exist and the count is greater than 0, FluentBit is successfully collecting and storing logs.
256
+
</div>
238
257
239
-
### 7. Verify OpenChoreo Installation
258
+
<divclassName="step-card">
259
+
<divclassName="step-header">
260
+
<divclassName="step-header-icon">7</div>
261
+
<divclassName="step-header-text">Verify the OpenChoreo Installation</div>
262
+
</div>
240
263
241
-
#### Check that default OpenChoreo resources were created:
264
+
Verify that default OpenChoreo resources were created:
242
265
243
266
```bash
244
-
# Check default organization and project
267
+
# Check default organizations, projects, and environments
245
268
kubectl get organizations,projects,environments -A
246
269
247
270
# Check default component types
@@ -254,7 +277,7 @@ kubectl get crds | grep openchoreo
254
277
kubectl get gateway,httproute -n openchoreo-data-plane
255
278
```
256
279
257
-
#### Check that all components are running:
280
+
Confirm all workloads are running:
258
281
259
282
```bash
260
283
# Check cluster info
@@ -275,22 +298,25 @@ kubectl get pods -n openchoreo-observability-plane
275
298
# Check nodes (should be Ready)
276
299
kubectl get nodes
277
300
```
301
+
</div>
278
302
279
303
## Next Steps
280
304
281
-
After completing this setup you can:
305
+
After completing this setup, you can:
282
306
283
-
1.[Deploy your first component](./deploy-first-component.mdx) to get started with OpenChoreo
284
-
2.Test the <Linkto={`https://github.com/openchoreo/openchoreo/tree/${versions.githubRef}/samples/gcp-microservices-demo`}>GCP microservices demo</Link> to see multi-component applications in action
285
-
3. Deploy additional sample applications from the <Linkto={`https://github.com/openchoreo/openchoreo/tree/${versions.githubRef}/samples`}>OpenChoreo samples</Link>
286
-
4. Develop and test new OpenChoreo features
307
+
1.[Deploy your first component](./deploy-first-component.mdx) to get started with OpenChoreo.
308
+
2.Explore the <Linkto={`https://github.com/openchoreo/openchoreo/tree/${versions.githubRef}/samples/gcp-microservices-demo`}>GCP microservices demo</Link> to see multi-component applications in action.
309
+
3. Deploy additional sample applications from <Linkto={`https://github.com/openchoreo/openchoreo/tree/${versions.githubRef}/samples`}>OpenChoreo samples</Link>.
310
+
4. Develop and test new OpenChoreo features.
287
311
312
+
<divclassName="content-section-highlight">
288
313
## Image Preloading (Optional)
289
314
290
-
If you have slow network or want to save bandwidth when re-creating clusters, you can preload images before installing components. This pulls images to your host machine first, then imports them to the k3d cluster.
291
-
292
-
Run this after creating the cluster (Step 1) but before installing components (Step 2). See the <Linkto={`https://github.com/openchoreo/openchoreo/tree/${versions.githubRef}/install/k3d/single-cluster#image-preloading-optional`}>k3d single-cluster README</Link> for detailed preloading instructions.
315
+
If you have a slow network or want to save bandwidth when recreating clusters, preload images before installing components. This pulls the images to your host machine and then imports them into the k3d cluster.
293
316
317
+
Run this after creating the cluster (Step 1) and before installing components (Step 2). Refer to the <Linkto={`https://github.com/openchoreo/openchoreo/tree/${versions.githubRef}/install/k3d/single-cluster#image-preloading-optional`}>k3d single-cluster README</Link> for detailed preloading instructions.
318
+
</div>
319
+
<divclassName="content-section-highlight">
294
320
## Cleaning Up
295
321
296
322
To completely remove the development environment:
@@ -299,3 +325,4 @@ To completely remove the development environment:
0 commit comments