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
Copy file name to clipboardExpand all lines: docs/getting-started/deploy-first-component.mdx
+14-11Lines changed: 14 additions & 11 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -2,6 +2,9 @@
2
2
title: Deploy Your First Component
3
3
---
4
4
5
+
importCodeBlockfrom'@theme/CodeBlock';
6
+
import {versions} from'../_constants.mdx';
7
+
5
8
# Deploy Your First Component
6
9
7
10
This guide walks you through deploying your first component on OpenChoreo. By the end of this tutorial, you'll have a running web service accessible through the platform, complete with monitoring and security configured automatically.
@@ -10,24 +13,24 @@ This guide walks you through deploying your first component on OpenChoreo. By th
10
13
11
14
Before you begin, ensure you have:
12
15
13
-
- ✅ **OpenChoreo installed** in your Kubernetes cluster ([Single Cluster Setup](./single-cluster.md))
16
+
- ✅ **OpenChoreo installed** in your Kubernetes cluster ([Single Cluster Setup](single-cluster.mdx))
14
17
- ✅ **kubectl** configured to access your cluster
15
18
- ✅ **OpenChoreo context** set to your cluster (should be `kind-openchoreo` if following the setup guide)
16
19
17
20
## Step 1: Verify Your Setup
18
21
19
-
First, make sure you have setup choreo on your local cluster following the [guide](./single-cluster.md)
22
+
First, make sure you have setup choreo on your local cluster following the [guide](single-cluster.mdx)
20
23
21
24
You should see all OpenChoreo components running with the control plane and data plane pods in `Running` status.
22
25
23
26
## Step 2: Deploy the Go Greeter Service
24
27
25
28
For this tutorial, we'll use the Go Greeter Service sample that comes with OpenChoreo. This is a simple web service that demonstrates OpenChoreo's core capabilities.
26
29
27
-
```bash
28
-
# Deploy the greeter service (Component, Workload, Service)
Copy file name to clipboardExpand all lines: docs/getting-started/quick-start-guide.mdx
+27-24Lines changed: 27 additions & 24 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -2,6 +2,11 @@
2
2
title: Quick Start Guide
3
3
---
4
4
5
+
6
+
importCodeBlockfrom'@theme/CodeBlock';
7
+
importLinkfrom'@docusaurus/Link';
8
+
import {versions} from'../_constants.mdx';
9
+
5
10
# Quick Start Guide
6
11
7
12
Setting up OpenChoreo in a Kubernetes cluster involves multiple steps and tools. This guide provides a fast and simple way to install a fully functional OpenChoreo instance on your local machine with minimal prerequisites and effort by using a pre-configured dev container.
@@ -13,32 +18,32 @@ When you're done, you can fully clean up the setup, leaving your machine clutter
13
18
To get started, you’ll need:
14
19
15
20
-**Docker** – Just have it installed on your machine, and you're good to go.
16
-
- We recommend using [Docker Engine version 26.0+](https://docs.docker.com/engine/release-notes/26.0/).
21
+
- We recommend using [Docker Engine version 26.0+](https://docs.docker.com/engine/release-notes/26.0/).
17
22
-**5–10 minutes of your time** – Setup is quick and depends on your internet connection speed.
18
23
19
24
## Start the Dev Container
20
25
21
26
Run the following command to start the dev container and launch a terminal session within it:
22
27
23
-
```shell
24
-
docker run --rm -it --name openchoreo-quick-start \
28
+
<CodeBlocklanguage="bash">
29
+
{String.raw`docker run --rm -it --name openchoreo-quick-start \
Thisprocesssetsupa [KinD](https://kind.sigs.k8s.io/) (Kubernetes-in-Docker) cluster in your Docker environment and installs OpenChoreo along with its dependencies.
**💡 Tip:** You can try out more samples on this setup. Check out our [Samples](https://github.com/openchoreo/openchoreo/tree/main/samples) for more details. The samples are also available in the dev container at `/samples`.
**⚠️ Important:**Ifyoutryoutsamplesinthedevcontainer, youdon'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.
@@ -83,11 +87,12 @@ You should see both nodes in `Ready` status.
83
87
84
88
Install the OpenChoreo control plane using the following helm install command. This will create the `openchoreo-control-plane` namespace automatically:
Note: We disable cert-manager since it's already installed by the control plane.
116
122
@@ -136,10 +142,11 @@ The Build Plane is required if you plan to use OpenChoreo’s internal CI capabi
136
142
137
143
Install the OpenChoreo build plane using the following helm install command for CI/CD capabilities using Argo Workflows. This will create the `openchoreo-build-plane` namespace automatically:
@@ -194,11 +201,12 @@ kubectl get dataplane -n default
194
201
195
202
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:
1.**Explore the Backstage portal** (if instal- Direct links to source code and documentationled) at `http://localhost:7007` to get familiar with the developer interface
380
-
2.[Deploy your first component](./deploy-first-component.md) and see it appear automatically in Backstage
381
-
3. Test the [GCP microservices demo](https://github.com/openchoreo/openchoreo/tree/main/samples/gcp-microservices-demo) to see multi-component applications in action
382
-
4. Deploy additional sample applications from the [OpenChoreo samples](https://github.com/openchoreo/openchoreo/tree/main/samples)
389
+
2.[Deploy your first component](./deploy-first-component.mdx) and see it appear automatically in Backstage
390
+
3. 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
391
+
4. Deploy additional sample applications from the <Linkto={`https://github.com/openchoreo/openchoreo/tree/${versions.githubRef}/samples`}>OpenChoreo samples</Link>
383
392
5. Use Backstage to monitor component health, view logs, and manage your application portfolio
0 commit comments