From 9dcae5c691d0eb5e1bbc97c96e8c5bf099282ca8 Mon Sep 17 00:00:00 2001 From: Miraj Abeysekara Date: Thu, 18 Sep 2025 16:41:55 +0530 Subject: [PATCH 1/3] Update the v0.3.x docs to v0.3.2 --- docusaurus.config.ts | 2 +- versioned_docs/version-v0.3.x/_constants.mdx | 4 ++-- .../version-v0.3.x/getting-started/quick-start-guide.mdx | 2 +- 3 files changed, 4 insertions(+), 4 deletions(-) diff --git a/docusaurus.config.ts b/docusaurus.config.ts index 97bf162..e221b61 100644 --- a/docusaurus.config.ts +++ b/docusaurus.config.ts @@ -77,7 +77,7 @@ const config: Config = { announcementBar: { id: 'release_v0_3_1', content: - '🎉️ OpenChoreo v0.3.1 is released! 🎉️', + '🎉️ OpenChoreo v0.3.2 is released! 🎉️', isCloseable: true, }, algolia: { diff --git a/versioned_docs/version-v0.3.x/_constants.mdx b/versioned_docs/version-v0.3.x/_constants.mdx index 19e1724..f6c34d7 100644 --- a/versioned_docs/version-v0.3.x/_constants.mdx +++ b/versioned_docs/version-v0.3.x/_constants.mdx @@ -1,7 +1,7 @@ [//] # (This file stores the constants used across the documentation.) export const versions = { - dockerTag: 'v0.3.1', + dockerTag: 'v0.3.2', githubRef: 'release-v0.3', // Used for the GitHub Raw URL references. Example: main, latest, v0.1.0 - helmChart: '0.3.1', + helmChart: '0.3.2', }; diff --git a/versioned_docs/version-v0.3.x/getting-started/quick-start-guide.mdx b/versioned_docs/version-v0.3.x/getting-started/quick-start-guide.mdx index 4614fea..5da1fae 100644 --- a/versioned_docs/version-v0.3.x/getting-started/quick-start-guide.mdx +++ b/versioned_docs/version-v0.3.x/getting-started/quick-start-guide.mdx @@ -138,7 +138,7 @@ Once the deployment is complete, you will receive the following message together ```text ✅ Endpoint is ready! -🌍 You can now access the Sample Web Application at: https://react-starter-image-development.choreoapps.localhost:8443 +🌍 You can now access the Sample Web Application at: https://react-starter-development.choreoapps.localhost:8443 ``` ### Understanding What Happens Behind the Scenes From 94e645bb4f6a5db6586e38b0251425195b4cdb97 Mon Sep 17 00:00:00 2001 From: Chalindu Kodikara Date: Tue, 23 Sep 2025 14:40:45 +0530 Subject: [PATCH 2/3] Remove api cr from the doc --- docs/getting-started/deploy-first-component.mdx | 8 ++------ 1 file changed, 2 insertions(+), 6 deletions(-) diff --git a/docs/getting-started/deploy-first-component.mdx b/docs/getting-started/deploy-first-component.mdx index 4e7de4f..02a8420 100644 --- a/docs/getting-started/deploy-first-component.mdx +++ b/docs/getting-started/deploy-first-component.mdx @@ -43,7 +43,7 @@ Track your component's deployment progress: ```bash # Check that all resources are created -kubectl get component,workload,service,api -A +kubectl get component,workload,service -A # Check the component status kubectl get component greeter-service @@ -95,23 +95,19 @@ Let's examine what OpenChoreo automatically created for your component: ```bash # View the OpenChoreo resources -kubectl get component,workload,service,api -n default +kubectl get component,workload,service -n default # Check the underlying Kubernetes resources kubectl get deployment,pod,svc -A | grep greeter # View the HTTP routing configuration kubectl describe httproute -A | grep -A 20 greeter - -# Check the API definition -kubectl get api greeter-service -n default -o yaml ``` OpenChoreo automatically created: - **Component** - High-level application definition - **Workload** - Container deployment specification - **Service** - API service configuration -- **API** - OpenAPI specification and routing - **Deployment** - Kubernetes deployment managing pods - **Service** - Kubernetes service for networking - **HTTPRoute** - Gateway API routing configuration From c25ca7af4edc1b6efe2da8586ab7116cd9d715f5 Mon Sep 17 00:00:00 2001 From: Chalindu Kodikara Date: Tue, 23 Sep 2025 15:07:41 +0530 Subject: [PATCH 3/3] Add service binding information to doc --- docs/getting-started/deploy-first-component.mdx | 5 +++-- docusaurus.config.ts | 2 +- versioned_docs/version-v0.3.x/_constants.mdx | 4 ++-- .../getting-started/deploy-first-component.mdx | 6 +++--- .../version-v0.3.x/getting-started/quick-start-guide.mdx | 2 +- 5 files changed, 10 insertions(+), 9 deletions(-) diff --git a/docs/getting-started/deploy-first-component.mdx b/docs/getting-started/deploy-first-component.mdx index 02a8420..832caf4 100644 --- a/docs/getting-started/deploy-first-component.mdx +++ b/docs/getting-started/deploy-first-component.mdx @@ -43,7 +43,7 @@ Track your component's deployment progress: ```bash # Check that all resources are created -kubectl get component,workload,service -A +kubectl get component,workload,service,servicebinding -A # Check the component status kubectl get component greeter-service @@ -95,7 +95,7 @@ Let's examine what OpenChoreo automatically created for your component: ```bash # View the OpenChoreo resources -kubectl get component,workload,service -n default +kubectl get component,workload,service,servicebinding -n default # Check the underlying Kubernetes resources kubectl get deployment,pod,svc -A | grep greeter @@ -108,6 +108,7 @@ OpenChoreo automatically created: - **Component** - High-level application definition - **Workload** - Container deployment specification - **Service** - API service configuration +- **Service Binding** - Environment-specific snapshot of Service and Workload configurations - **Deployment** - Kubernetes deployment managing pods - **Service** - Kubernetes service for networking - **HTTPRoute** - Gateway API routing configuration diff --git a/docusaurus.config.ts b/docusaurus.config.ts index e221b61..97bf162 100644 --- a/docusaurus.config.ts +++ b/docusaurus.config.ts @@ -77,7 +77,7 @@ const config: Config = { announcementBar: { id: 'release_v0_3_1', content: - '🎉️ OpenChoreo v0.3.2 is released! 🎉️', + '🎉️ OpenChoreo v0.3.1 is released! 🎉️', isCloseable: true, }, algolia: { diff --git a/versioned_docs/version-v0.3.x/_constants.mdx b/versioned_docs/version-v0.3.x/_constants.mdx index f6c34d7..19e1724 100644 --- a/versioned_docs/version-v0.3.x/_constants.mdx +++ b/versioned_docs/version-v0.3.x/_constants.mdx @@ -1,7 +1,7 @@ [//] # (This file stores the constants used across the documentation.) export const versions = { - dockerTag: 'v0.3.2', + dockerTag: 'v0.3.1', githubRef: 'release-v0.3', // Used for the GitHub Raw URL references. Example: main, latest, v0.1.0 - helmChart: '0.3.2', + helmChart: '0.3.1', }; diff --git a/versioned_docs/version-v0.3.x/getting-started/deploy-first-component.mdx b/versioned_docs/version-v0.3.x/getting-started/deploy-first-component.mdx index 4e7de4f..b79fde5 100644 --- a/versioned_docs/version-v0.3.x/getting-started/deploy-first-component.mdx +++ b/versioned_docs/version-v0.3.x/getting-started/deploy-first-component.mdx @@ -43,7 +43,7 @@ Track your component's deployment progress: ```bash # Check that all resources are created -kubectl get component,workload,service,api -A +kubectl get component,workload,service,servicebinding -A # Check the component status kubectl get component greeter-service @@ -95,7 +95,7 @@ Let's examine what OpenChoreo automatically created for your component: ```bash # View the OpenChoreo resources -kubectl get component,workload,service,api -n default +kubectl get component,workload,service,servicebinding -n default # Check the underlying Kubernetes resources kubectl get deployment,pod,svc -A | grep greeter @@ -111,7 +111,7 @@ OpenChoreo automatically created: - **Component** - High-level application definition - **Workload** - Container deployment specification - **Service** - API service configuration -- **API** - OpenAPI specification and routing +- **Service Binding** - Environment-specific snapshot of Service and Workload configurations - **Deployment** - Kubernetes deployment managing pods - **Service** - Kubernetes service for networking - **HTTPRoute** - Gateway API routing configuration diff --git a/versioned_docs/version-v0.3.x/getting-started/quick-start-guide.mdx b/versioned_docs/version-v0.3.x/getting-started/quick-start-guide.mdx index 5da1fae..4614fea 100644 --- a/versioned_docs/version-v0.3.x/getting-started/quick-start-guide.mdx +++ b/versioned_docs/version-v0.3.x/getting-started/quick-start-guide.mdx @@ -138,7 +138,7 @@ Once the deployment is complete, you will receive the following message together ```text ✅ Endpoint is ready! -🌍 You can now access the Sample Web Application at: https://react-starter-development.choreoapps.localhost:8443 +🌍 You can now access the Sample Web Application at: https://react-starter-image-development.choreoapps.localhost:8443 ``` ### Understanding What Happens Behind the Scenes