Skip to content

Commit 2f480cf

Browse files
committed
Add Backstage UI access and improve multi-cluster setup
1 parent 9f2447e commit 2f480cf

File tree

3 files changed

+74
-8
lines changed

3 files changed

+74
-8
lines changed

docs/getting-started/multi-cluster.mdx

Lines changed: 31 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -16,6 +16,7 @@ This guide walks you through step-by-step instructions for deploying OpenChoreo
1616
- **Docker** – Just have it installed on your machine, and you're good to go.
1717
- We recommend using [Docker Engine version 26.0+](https://docs.docker.com/engine/release-notes/26.0/).
1818
- Allocate at least **8 GB RAM** and **4 CPU** cores to Docker (or the VM running Docker).
19+
- **Important**: Ensure your Docker VM has sufficient inotify limits. Set `fs.inotify.max_user_watches=524288` and `fs.inotify.max_user_instances=512` to prevent k3d cluster creation from hanging.
1920
- **[k3d](https://k3d.io/stable/#installation)** v5.8+ installed
2021
- **[kubectl](https://kubernetes.io/docs/tasks/tools/)** v1.32+ installed
2122
- **[Helm](https://helm.sh/docs/intro/install/)** v3.12+ installed
@@ -288,28 +289,53 @@ If the indices exist and the count is greater than 0, FluentBit is successfully
288289

289290
## Verification
290291

292+
### Switch to Control Plane Context
293+
294+
Set your default kubectl context to the control plane for easier management:
295+
296+
```bash
297+
kubectl config use-context k3d-openchoreo-cp
298+
```
299+
291300
### Check that default OpenChoreo resources were created:
292301

293302
```bash
294303
# Check default organization and project (on control plane)
295-
kubectl get organizations,projects,environments -A --context k3d-openchoreo-cp
304+
kubectl get organizations,projects,environments -A
296305

297306
# Check default component types (on control plane)
298-
kubectl get componenttypes -n default --context k3d-openchoreo-cp
307+
kubectl get componenttypes -n default
299308

300309
# Check all OpenChoreo CRDs (on control plane)
301-
kubectl get crds --context k3d-openchoreo-cp | grep openchoreo
310+
kubectl get crds | grep openchoreo
302311

303312
# Check gateway resources (on data plane)
304313
kubectl get gateway,httproute -n openchoreo-data-plane --context k3d-openchoreo-dp
305314
```
306315

316+
### Verify Data Plane and Build Plane Registration
317+
318+
```bash
319+
# Verify DataPlane is registered and ready
320+
kubectl get dataplane -n default
321+
kubectl describe dataplane -n default | grep -A 5 "Status:"
322+
323+
# Verify BuildPlane is registered and ready (if installed)
324+
if kubectl get buildplane -n default &>/dev/null; then
325+
echo "BuildPlane found:"
326+
kubectl get buildplane -n default
327+
kubectl describe buildplane -n default | grep -A 5 "Status:"
328+
else
329+
echo "BuildPlane not installed - skipping verification"
330+
fi
331+
```
332+
307333
#### Check that all components are running:
308334

309335
```bash
310336
# Check control plane cluster
311-
kubectl cluster-info --context k3d-openchoreo-cp
312-
kubectl get pods -n openchoreo-control-plane --context k3d-openchoreo-cp
337+
kubectl cluster-info
338+
kubectl get pods -n openchoreo-control-plane
313339

314340
# Check data plane cluster
315341
kubectl cluster-info --context k3d-openchoreo-dp
605 KB
Loading

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

Lines changed: 43 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -56,7 +56,7 @@ The setup uses a preconfigured Dev Container that includes all required dependen
5656
Inside the container, run the installation command:
5757

5858
<CodeBlock language="bash">
59-
{`./install.sh --version ${versions.helmChart}`}
59+
{`./install.sh --version ${versions.dockerTag}`}
6060
</CodeBlock>
6161

6262
This command performs the following:
@@ -110,6 +110,42 @@ The setup uses a preconfigured Dev Container that includes all required dependen
110110
```
111111
</div>
112112

113+
<div className="step-card">
114+
<div className="step-header">
115+
<div className="step-header-icon">4</div>
116+
<div className="step-header-text">Access the Backstage UI</div>
117+
</div>
118+
119+
Now that your web application is deployed, access the OpenChoreo Backstage UI to explore and manage your components:
120+
121+
Access the UI at: http://openchoreo.localhost:8080/
122+
123+
Default login credentials:
124+
- Username: `[email protected]`
125+
- Password: `Admin@123`
126+
127+
<img
128+
src={require('./qsg-backstage-ui.png').default}
129+
alt="Backstage UI Screenshot"
130+
width="80%"
131+
/>
132+
133+
134+
Take some time to explore the interface where you can:
135+
- View your deployed components
136+
- Monitor application status
137+
- Access component catalogs
138+
- Manage deployment pipelines
139+
140+
:::note
141+
To access advanced features like **CI/CD pipelines** (Build Plane) and **Observability** (Observability Plane) within the UI, you can enable them by including the following flags during installation:
142+
<CodeBlock language="bash">
143+
{`./install.sh --version ${versions.dockerTag} --with-build --with-observability`}
144+
</CodeBlock>
145+
:::
146+
147+
</div>
148+
113149
<div className="content-section-highlight">
114150

115151
### Understanding the Setup
@@ -167,6 +203,10 @@ The setup uses a preconfigured Dev Container that includes all required dependen
167203
kubectl get components
168204
```
169205

206+
#### 3. UI Architecture
207+
208+
The Backstage UI is powered by the OpenChoreo Backstage plugin, providing a unified interface for managing your components and deployments. The authentication and user management is handled by Asgardio, a lightweight identity management platform that secures access to your OpenChoreo environment.
209+
170210
:::tip
171211
Explore more examples in the <Link
172212
to={`https://github.com/openchoreo/openchoreo/tree/${versions.githubRef}/samples`}>Samples</Link> directory or in
@@ -207,7 +247,7 @@ The setup uses a preconfigured Dev Container that includes all required dependen
207247
This example requires the Build Plane. If you didn't install it initially, reinstall with:
208248

209249
<CodeBlock language="bash">
210-
{`./install.sh --version ${versions.helmChart} --with-build`}
250+
{`./install.sh --version ${versions.dockerTag} --with-build`}
211251
</CodeBlock>
212252
:::
213253

@@ -220,7 +260,7 @@ The setup uses a preconfigured Dev Container that includes all required dependen
220260

221261
<div className="step-card">
222262
<div className="step-header">
223-
<div className="step-header-icon">4</div>
263+
<div className="step-header-icon">5</div>
224264
<div className="step-header-text">Cleaning up</div>
225265
</div>
226266

0 commit comments

Comments
 (0)