Skip to content

Commit e1992d2

Browse files
committed
Move release version to a shared file
1 parent 9b49561 commit e1992d2

File tree

8 files changed

+150
-115
lines changed

8 files changed

+150
-115
lines changed

docs/_constants.mdx

Lines changed: 8 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,8 @@
1+
[//] # (This file stores the constants used across the documentation.)
2+
3+
export const versions = {
4+
dockerTag: 'v0.3.0',
5+
// TODO: Update this to the latest release version after v0.3.1 is released.
6+
githubRef: 'release-v0.3', // Used for the GitHub Raw URL references. Example: main, latest, v0.1.0
7+
helmChart: '0.3.0',
8+
};

docs/getting-started/deploy-first-component.md renamed to docs/getting-started/deploy-first-component.mdx

Lines changed: 14 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -2,6 +2,9 @@
22
title: Deploy Your First Component
33
---
44

5+
import CodeBlock from '@theme/CodeBlock';
6+
import {versions} from '../_constants.mdx';
7+
58
# Deploy Your First Component
69

710
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
1013

1114
Before you begin, ensure you have:
1215

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))
1417
-**kubectl** configured to access your cluster
1518
-**OpenChoreo context** set to your cluster (should be `kind-openchoreo` if following the setup guide)
1619

1720
## Step 1: Verify Your Setup
1821

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)
2023

2124
You should see all OpenChoreo components running with the control plane and data plane pods in `Running` status.
2225

2326
## Step 2: Deploy the Go Greeter Service
2427

2528
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.
2629

27-
```bash
28-
# Deploy the greeter service (Component, Workload, Service)
29-
kubectl apply -f https://raw.githubusercontent.com/openchoreo/openchoreo/main/samples/from-image/go-greeter-service/greeter-service.yaml
30-
```
30+
<CodeBlock language="bash">
31+
{`# Deploy the greeter service (Component, Workload, Service)
32+
kubectl apply -f https://raw.githubusercontent.com/openchoreo/openchoreo/${versions.githubRef}/samples/from-image/go-greeter-service/greeter-service.yaml`}
33+
</CodeBlock>
3134

3235
This single command creates:
3336
- **Component**: Defines the application and its requirements
@@ -128,10 +131,10 @@ Your application is now running in a production-ready environment with enterpris
128131

129132
To remove the sample application:
130133

131-
```bash
132-
# Remove the greeter service
133-
kubectl delete -f https://raw.githubusercontent.com/openchoreo/openchoreo/main/samples/from-image/go-greeter-service/greeter-service.yaml
134+
<CodeBlock language="bash">
135+
{`# Remove the greeter service
136+
kubectl delete -f https://raw.githubusercontent.com/openchoreo/openchoreo/${versions.githubRef}/samples/from-image/go-greeter-service/greeter-service.yaml
134137
135138
# Remove the build sample (if deployed)
136-
kubectl delete -f https://raw.githubusercontent.com/openchoreo/openchoreo/main/samples/from-source/services/go-google-buildpack-reading-list/reading-list-service.yaml
137-
```
139+
kubectl delete -f https://raw.githubusercontent.com/openchoreo/openchoreo/${versions.githubRef}/samples/from-source/services/go-google-buildpack-reading-list/reading-list-service.yaml`}
140+
</CodeBlock>

docs/getting-started/quick-start-guide.md renamed to docs/getting-started/quick-start-guide.mdx

Lines changed: 27 additions & 24 deletions
Original file line numberDiff line numberDiff line change
@@ -2,6 +2,11 @@
22
title: Quick Start Guide
33
---
44

5+
6+
import CodeBlock from '@theme/CodeBlock';
7+
import Link from '@docusaurus/Link';
8+
import {versions} from '../_constants.mdx';
9+
510
# Quick Start Guide
611

712
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
1318
To get started, you’ll need:
1419

1520
- **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/).
1722
- **5–10 minutes of your time** – Setup is quick and depends on your internet connection speed.
1823

1924
## Start the Dev Container
2025

2126
Run the following command to start the dev container and launch a terminal session within it:
2227

23-
```shell
24-
docker run --rm -it --name openchoreo-quick-start \
28+
<CodeBlock language="bash">
29+
{String.raw`docker run --rm -it --name openchoreo-quick-start \
2530
--pull always \
2631
-v /var/run/docker.sock:/var/run/docker.sock \
2732
--network bridge \
2833
-p 8443:8443 \
2934
-p 7007:7007 \
30-
ghcr.io/openchoreo/quick-start:latest-dev
35+
ghcr.io/openchoreo/quick-start:`}{versions.dockerTag}
36+
</CodeBlock>
3137

32-
```
3338

3439
### Install OpenChoreo
3540
This process sets up a [KinD](https://kind.sigs.k8s.io/) (Kubernetes-in-Docker) cluster in your Docker environment and installs OpenChoreo along with its dependencies.
3641

3742
To begin the installation, run:
3843

39-
```shell
40-
./install.sh --openchoreo-version 0.0.0-latest-dev
41-
```
44+
<CodeBlock language="bash">
45+
{`./install.sh --openchoreo-version ${versions.helmChart}`}
46+
</CodeBlock>
4247

4348
**💡 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.
4449

@@ -90,7 +95,7 @@ Once the installation is complete, you will see the following confirmation messa
9095
```
9196

9297
**📝 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:
93-
```shell
98+
```bash
9499
./check-status.sh
95100
```
96101

@@ -113,7 +118,7 @@ The portal will automatically discover and display any components you deploy thr
113118
You now have OpenChoreo fully setup in your docker environment.
114119
Next, lets deploy a sample Web Application by running the following command:
115120

116-
```shell
121+
```bash
117122
./deploy_web_application.sh
118123
```
119124

@@ -147,21 +152,21 @@ To access the artifacts created in OpenChoreo you can use choreoctl as shown in
147152

148153
You can check each resource type
149154

150-
```shell
155+
```bash
151156
kubectl get organizations
152157
```
153-
```shell
158+
```bash
154159
kubectl get dataplanes
155160
```
156-
```shell
161+
```bash
157162
kubectl get environments
158163
```
159-
```shell
164+
```bash
160165
kubectl get projects
161166
```
162167
To get more details on any of these abstractions, you can use a similar command to the following command:
163168

164-
```shell
169+
```bash
165170
kubectl get project default -oyaml
166171
```
167172

@@ -170,27 +175,25 @@ The deploy script creates a sample Web Application Component, along with a Deplo
170175

171176
To inspect these resources in more detail, run the following commands:
172177

173-
```shell
178+
```bash
174179
kubectl get components
175180
```
176181

177-
**💡 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`.
182+
**💡 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`.
178183

179184
**⚠️ 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.
180185

181186
### Cleaning up
182187
After finishing your work, you have two options:
183188

184189
1. **Exit and return later**: If you plan to return, simply exit the dev container by running:
185-
```shell
186-
exit
190+
```bash
191+
exit
187192
```
188193
2. **Full cleanup**: To remove all resources and clean up the environment completely, run:
189-
```shell
190-
./uninstall.sh
191-
```
192-
```shell
193-
exit
194+
```bash
195+
./uninstall.sh
196+
exit
194197
```
195198

196199
That's it!

docs/getting-started/single-cluster.md renamed to docs/getting-started/single-cluster.mdx

Lines changed: 49 additions & 40 deletions
Original file line numberDiff line numberDiff line change
@@ -3,6 +3,10 @@ title: Single Cluster
33
description: Try OpenChoreo locally with a single Kind cluster setup.
44
---
55

6+
import CodeBlock from '@theme/CodeBlock';
7+
import Link from '@docusaurus/Link';
8+
import {versions} from '../_constants.mdx';
9+
610
# Single Cluster Setup
711

812
This guide provides step-by-step instructions for setting up a local development environment for OpenChoreo using Kind (Kubernetes in Docker).
@@ -47,9 +51,9 @@ This setup uses pre-built images and Helm charts from the OpenChoreo registry.
4751

4852
Create a new Kind cluster using the provided configuration:
4953

50-
```bash
51-
curl -s https://raw.githubusercontent.com/openchoreo/openchoreo/main/install/kind/kind-config.yaml | kind create cluster --config=-
52-
```
54+
<CodeBlock language="bash">
55+
{`curl -s https://raw.githubusercontent.com/openchoreo/openchoreo/${versions.githubRef}/install/kind/kind-config.yaml | kind create cluster --config=-`}
56+
</CodeBlock>
5357

5458
This will:
5559
- Create a cluster named "openchoreo"
@@ -61,9 +65,9 @@ This will:
6165

6266
Install Cilium as the Container Network Interface (CNI). This will create the `cilium` namespace automatically:
6367

64-
```bash
65-
helm install cilium oci://ghcr.io/openchoreo/helm-charts/cilium --create-namespace --namespace cilium --wait
66-
```
68+
<CodeBlock language="bash">
69+
{`helm install cilium oci://ghcr.io/openchoreo/helm-charts/cilium --version ${versions.helmChart} --create-namespace --namespace cilium --wait`}
70+
</CodeBlock>
6771

6872
Wait for Cilium pods to be ready:
6973

@@ -83,11 +87,12 @@ You should see both nodes in `Ready` status.
8387

8488
Install the OpenChoreo control plane using the following helm install command. This will create the `openchoreo-control-plane` namespace automatically:
8589

86-
```bash
87-
helm install control-plane oci://ghcr.io/openchoreo/helm-charts/openchoreo-control-plane \
88-
--create-namespace --namespace openchoreo-control-plane \
89-
--timeout=10m
90-
```
90+
<CodeBlock language="bash">
91+
{`helm install control-plane oci://ghcr.io/openchoreo/helm-charts/openchoreo-control-plane \\
92+
--version ${versions.helmChart} \\
93+
--create-namespace --namespace openchoreo-control-plane \\
94+
--timeout=10m`}
95+
</CodeBlock>
9196

9297
Wait for the installation to complete and verify all pods are running:
9398

@@ -104,13 +109,14 @@ You should see pods for:
104109

105110
Install the OpenChoreo data plane using the following helm install command. This will create the `openchoreo-data-plane` namespace automatically:
106111

107-
```bash
108-
helm install data-plane oci://ghcr.io/openchoreo/helm-charts/openchoreo-data-plane \
109-
--create-namespace --namespace openchoreo-data-plane \
110-
--timeout=10m \
111-
--set cert-manager.enabled=false \
112-
--set cert-manager.crds.enabled=false
113-
```
112+
<CodeBlock language="bash">
113+
{`helm install data-plane oci://ghcr.io/openchoreo/helm-charts/openchoreo-data-plane \\
114+
--version ${versions.helmChart} \\
115+
--create-namespace --namespace openchoreo-data-plane \\
116+
--timeout=10m \\
117+
--set cert-manager.enabled=false \\
118+
--set cert-manager.crds.enabled=false`}
119+
</CodeBlock>
114120

115121
Note: We disable cert-manager since it's already installed by the control plane.
116122

@@ -136,10 +142,11 @@ The Build Plane is required if you plan to use OpenChoreo’s internal CI capabi
136142

137143
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:
138144

139-
```bash
140-
helm install build-plane oci://ghcr.io/openchoreo/helm-charts/openchoreo-build-plane \
141-
--create-namespace --namespace openchoreo-build-plane --timeout=10m
142-
```
145+
<CodeBlock language="bash">
146+
{`helm install build-plane oci://ghcr.io/openchoreo/helm-charts/openchoreo-build-plane \\
147+
--version ${versions.helmChart} \\
148+
--create-namespace --namespace openchoreo-build-plane --timeout=10m`}
149+
</CodeBlock>
143150

144151
Wait for the build plane components to be ready:
145152

@@ -154,9 +161,9 @@ You should see pods for:
154161

155162
Register the build plane with the control plane by running:
156163

157-
```bash
158-
curl -s https://raw.githubusercontent.com/openchoreo/openchoreo/main/install/add-build-plane.sh | bash
159-
```
164+
<CodeBlock language="bash">
165+
{`curl -s https://raw.githubusercontent.com/openchoreo/openchoreo/${versions.githubRef}/install/add-build-plane.sh | bash`}
166+
</CodeBlock>
160167

161168
This script will:
162169
- Detect single-cluster mode automatically
@@ -174,9 +181,9 @@ kubectl get buildplane -n default
174181

175182
Register the data plane with the control plane by running:
176183

177-
```bash
178-
curl -s https://raw.githubusercontent.com/openchoreo/openchoreo/main/install/add-default-dataplane.sh | bash
179-
```
184+
<CodeBlock language="bash">
185+
{`curl -s https://raw.githubusercontent.com/openchoreo/openchoreo/${versions.githubRef}/install/add-default-dataplane.sh | bash`}
186+
</CodeBlock>
180187

181188
This script will:
182189
- Detect single-cluster mode automatically
@@ -194,11 +201,12 @@ kubectl get dataplane -n default
194201

195202
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:
196203

197-
```bash
198-
helm install observability-plane oci://ghcr.io/openchoreo/helm-charts/openchoreo-observability-plane \
199-
--create-namespace --namespace openchoreo-observability-plane \
200-
--timeout=10m
201-
```
204+
<CodeBlock language="bash">
205+
{`helm install observability-plane oci://ghcr.io/openchoreo/helm-charts/openchoreo-observability-plane \\
206+
--version ${versions.helmChart} \\
207+
--create-namespace --namespace openchoreo-observability-plane \\
208+
--timeout=10m`}
209+
</CodeBlock>
202210

203211
Wait for the observability plane components to be ready:
204212

@@ -270,10 +278,11 @@ The Backstage portal provides:
270278
- **Logs**: View runtime logs and build logs of each component
271279
- **Configure and Deploy**: Configure, deploy and promote web applications and services through environments
272280

273-
```bash
274-
helm install openchoreo-backstage-demo oci://ghcr.io/openchoreo/helm-charts/backstage-demo \
275-
--namespace openchoreo-control-plane
276-
```
281+
<CodeBlock language="bash">
282+
{`helm install openchoreo-backstage-demo oci://ghcr.io/openchoreo/helm-charts/backstage-demo \\
283+
--version ${versions.helmChart} \\
284+
--namespace openchoreo-control-plane`}
285+
</CodeBlock>
277286

278287
Wait for the Backstage pod to be ready:
279288

@@ -377,9 +386,9 @@ kubectl get nodes
377386
After completing this setup you can:
378387

379388
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 <Link to={`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 <Link to={`https://github.com/openchoreo/openchoreo/tree/${versions.githubRef}/samples`}>OpenChoreo samples</Link>
383392
5. Use Backstage to monitor component health, view logs, and manage your application portfolio
384393
6. Develop and test new OpenChoreo features
385394

0 commit comments

Comments
 (0)