Add self hosted k8s and managed k8s docs #274
Conversation
📝 WalkthroughWalkthroughThis PR restructures installation documentation by replacing a single-cluster guide with two separate, comprehensive guides for managed Kubernetes clusters and self-hosted clusters. The quick-start guide is updated to reference the new documentation structure. Changes
Estimated code review effort🎯 3 (Moderate) | ⏱️ ~20 minutes Poem
🚥 Pre-merge checks | ✅ 4 | ❌ 1❌ Failed checks (1 warning)
✅ Passed checks (4 passed)
✏️ Tip: You can configure your own custom pre-merge checks in the settings. ✨ Finishing touches🧪 Generate unit tests (beta)
Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out. Comment |
![coderabbitai[bot]](https://avatars.githubusercontent.com/in/347564?s=60&v=4){kind=small}
There was a problem hiding this comment.
Actionable comments posted: 10
🤖 Fix all issues with AI agents
In `@docs/install/managed-cluster.md`:
- Line 545: The docs contain inconsistent version tags in the deployment URLs
(e.g., the URL string
"https://raw.githubusercontent.com/wso2/ai-agent-management-platform/amp/v0.0.0-dev/deployments/values/oc-collector-configmap.yaml"
at the reported location versus other occurrences using "amp/v0.3.0"); update
all deployment URL references so they use a single agreed version tag (e.g.,
change "amp/v0.0.0-dev" to "amp/v0.3.0" or vice versa) across this file and
coordinate the same replacement in the self-hosted-cluster.md file, or add a
short inline note explaining why different tags are required if intentional,
ensuring the exact URL strings mentioned are modified or annotated accordingly.
- Line 285: Replace the bolded section titles "**Option 1: Use OpenChoreo's
Built-in Registry (Exploration/Development)**" and "**Option 2: ...**" with
proper Markdown headings (e.g., "## Option 1: Use OpenChoreo's Built-in Registry
(Exploration/Development)" and "## Option 2: ...") so they become real section
headers; update the instances containing the exact text "**Option 1: Use
OpenChoreo's Built-in Registry (Exploration/Development)**" and the
corresponding "**Option 2:**" occurrence to use the appropriate heading level
(## or ###) to satisfy markdownlint and improve document structure.
- Line 907: Replace the phrase "**AWS EKS specific issues:**" with the
hyphenated compound adjective "**AWS-EKS-specific issues:**" (locate the heading
string "**AWS EKS specific issues:**" in the document and update it to the
hyphenated form) so the compound adjective correctly modifies "issues."
- Line 918: The See Also entry currently references the removed file
"./single-cluster.md"; update the See Also section to remove or replace that
broken link (the string "./single-cluster.md") with the correct target (e.g.,
the consolidated self-hosted-cluster doc or another existing page) so the link
no longer points to a deleted file; ensure the update is applied in the See Also
section where the line "- [Single Cluster Installation](./single-cluster.md) -
Installation on self-hosted Kubernetes" appears.
In `@docs/install/self-hosted-cluster.md`:
- Line 581: The docs contain inconsistent Helm chart names:
`wso2-ai-agent-management-platform` (line 581) vs `wso2-agent-manager` (line
275); pick the correct chart name and make it consistent across the document by
replacing the incorrect occurrence(s). Update all references to the chosen chart
name (e.g., occurrences of `wso2-ai-agent-management-platform` or
`wso2-agent-manager`) so every helm install/registry URI and example uses the
same identifier.
- Line 368: The docs contain inconsistent version strings (e.g. URLs with
"amp/v0.3.0" and others using "amp/v0.0.0-dev") which will confuse users; search
for occurrences of the GitHub raw URLs and version tokens (for example the URL
"https://raw.githubusercontent.com/wso2/ai-agent-management-platform/amp/v0.3.0/deployments/values/api-platform-operator-full-config.yaml"
and any references to "amp/v0.0.0-dev") and standardize them to a single agreed
version (or replace with a variable/placeholder like "amp/<RELEASE>" and
document the intended value), updating every reference (including the other two
affected lines) so all links and version mentions match or add a short note
explaining why differing versions are required for specific components.
- Line 1: The document title "Install on Self Hosted Kubernetes Cluster" should
use the hyphenated compound adjective; update the markdown heading text from
"Install on Self Hosted Kubernetes Cluster" to "Install on Self-Hosted
Kubernetes Cluster" (edit the heading string at the top of
docs/install/self-hosted-cluster.md).
- Line 435: Replace the unhyphenated phrase "Node IP based" with the hyphenated
compound adjective "Node-IP-based" in the docs line that currently reads "-
**Node IP based:** `<node-ip>:10082` (update the bold text portion "Node IP
based" to "Node-IP-based" so the compound adjective is correct).
- Line 645: The See Also entry referencing "./single-cluster.md" in the
docs/install/self-hosted-cluster.md file is now broken because that file was
removed; remove that link (or replace it) by updating the "See Also" section to
either delete the "./single-cluster.md" bullet or replace it with links to the
current alternatives (for example the managed-cluster guide and this self-hosted
guide). Locate the "See Also" section and the exact link text
"./single-cluster.md" to make the change, ensuring link formatting matches the
surrounding entries.
In `@docs/quick-start.md`:
- Line 72: Update the link text in docs/quick-start.md: change the label
"[Installation on self hosted kubernetes cluster]" to the hyphenated and
capitalized form "[Installation on self-hosted Kubernetes cluster]" so it
matches the file name and documentation style; locate the link text string in
the file and update the hyphenation for "self-hosted" and capitalization of
"Kubernetes" accordingly.
|
|
||
| For managed Kubernetes, you have two options for the container registry: | ||
|
|
||
| **Option 1: Use OpenChoreo's Built-in Registry (Exploration/Development)** |
There was a problem hiding this comment.
Use proper Markdown heading syntax instead of bold text.
Lines 285 and 314 use bold emphasis (**Option 1:**, **Option 2:**) to create section headers, which is flagged by markdownlint. Proper Markdown headings improve document structure and navigation.
📝 Proposed fix
-**Option 1: Use OpenChoreo's Built-in Registry (Exploration/Development)**
+#### Option 1: Use OpenChoreo's Built-in Registry (Exploration/Development)-**Option 2: Use External Cloud Registry (Recommended for Production)**
+#### Option 2: Use External Cloud Registry (Recommended for Production)Also applies to: 314-314
🧰 Tools
🪛 markdownlint-cli2 (0.20.0)
[warning] 285-285: Emphasis used instead of a heading
(MD036, no-emphasis-as-heading)
🤖 Prompt for AI Agents
In `@docs/install/managed-cluster.md` at line 285, Replace the bolded section
titles "**Option 1: Use OpenChoreo's Built-in Registry
(Exploration/Development)**" and "**Option 2: ...**" with proper Markdown
headings (e.g., "## Option 1: Use OpenChoreo's Built-in Registry
(Exploration/Development)" and "## Option 2: ...") so they become real section
headers; update the instances containing the exact text "**Option 1: Use
OpenChoreo's Built-in Registry (Exploration/Development)**" and the
corresponding "**Option 2:**" occurrence to use the appropriate heading level
(## or ###) to satisfy markdownlint and improve document structure.
|
|
||
| ```bash | ||
| # Create the OpenTelemetry collector config map | ||
| kubectl apply -f https://raw.githubusercontent.com/wso2/ai-agent-management-platform/amp/v0.0.0-dev/deployments/values/oc-collector-configmap.yaml |
There was a problem hiding this comment.
Inconsistent version references across documentation.
The documentation uses amp/v0.3.0 in lines 589, 596, and 603, but uses amp/v0.0.0-dev in line 545. This is the same version inconsistency issue present in the self-hosted-cluster.md file.
Please standardize on a single version reference throughout the documentation, or clearly explain why different versions are needed for different components. This should be coordinated with the fix for the self-hosted-cluster.md file to ensure consistency across both installation guides.
Also applies to: 589-589, 596-596, 603-603
🤖 Prompt for AI Agents
In `@docs/install/managed-cluster.md` at line 545, The docs contain inconsistent
version tags in the deployment URLs (e.g., the URL string
"https://raw.githubusercontent.com/wso2/ai-agent-management-platform/amp/v0.0.0-dev/deployments/values/oc-collector-configmap.yaml"
at the reported location versus other occurrences using "amp/v0.3.0"); update
all deployment URL references so they use a single agreed version tag (e.g.,
change "amp/v0.0.0-dev" to "amp/v0.3.0" or vice versa) across this file and
coordinate the same replacement in the self-hosted-cluster.md file, or add a
short inline note explaining why different tags are required if intentional,
ensuring the exact URL strings mentioned are modified or annotated accordingly.
| curl -v http://opensearch.openchoreo-observability-plane.svc.cluster.local:9200 | ||
| ``` | ||
|
|
||
| **AWS EKS specific issues:** |
There was a problem hiding this comment.
Use hyphenated form "AWS-EKS-specific".
The phrase "AWS EKS specific" should be hyphenated as "AWS-EKS-specific" when used as a compound adjective modifying "issues".
📝 Proposed fix
-**AWS EKS specific issues:**
+**AWS-EKS-specific issues:**📝 Committable suggestion
‼️ IMPORTANT
Carefully review the code before committing. Ensure that it accurately replaces the highlighted code, contains no missing lines, and has no issues with indentation. Thoroughly test & benchmark the code to ensure it meets the requirements.
| **AWS EKS specific issues:** | |
| **AWS-EKS-specific issues:** |
🧰 Tools
🪛 LanguageTool
[grammar] ~907-~907: Use a hyphen to join words.
Context: ...ne.svc.cluster.local:9200 **AWS EKS specific issues:**bash # Check LoadB...
(QB_NEW_EN_HYPHEN)
🤖 Prompt for AI Agents
In `@docs/install/managed-cluster.md` at line 907, Replace the phrase "**AWS EKS
specific issues:**" with the hyphenated compound adjective "**AWS-EKS-specific
issues:**" (locate the heading string "**AWS EKS specific issues:**" in the
document and update it to the hyphenated form) so the compound adjective
correctly modifies "issues."
|
|
||
| ## See Also | ||
|
|
||
| - [Single Cluster Installation](./single-cluster.md) - Installation on self-hosted Kubernetes |
There was a problem hiding this comment.
Broken link to removed documentation file.
The See Also section references ./single-cluster.md, but this file was removed in the current PR. This is a duplicate of the same critical issue in self-hosted-cluster.md.
🔧 Proposed fix
## See Also
-- [Single Cluster Installation](./single-cluster.md) - Installation on self-hosted Kubernetes
+- [Installation on Self-Hosted Kubernetes](./self-hosted-cluster.md) - Installation guide for self-hosted Kubernetes clusters
- [Quick Start Guide](../quick-start.md) - Complete automated setup with k3d and OpenChoreo
- [Main README](../../README.md) - Project overview and architecture
- [OpenChoreo Documentation](https://openchoreo.dev/docs/v0.9.x/) - Official OpenChoreo setup and configuration📝 Committable suggestion
‼️ IMPORTANT
Carefully review the code before committing. Ensure that it accurately replaces the highlighted code, contains no missing lines, and has no issues with indentation. Thoroughly test & benchmark the code to ensure it meets the requirements.
| - [Single Cluster Installation](./single-cluster.md) - Installation on self-hosted Kubernetes | |
| ## See Also | |
| - [Installation on Self-Hosted Kubernetes](./self-hosted-cluster.md) - Installation guide for self-hosted Kubernetes clusters | |
| - [Quick Start Guide](../quick-start.md) - Complete automated setup with k3d and OpenChoreo | |
| - [Main README](../../README.md) - Project overview and architecture | |
| - [OpenChoreo Documentation](https://openchoreo.dev/docs/v0.9.x/) - Official OpenChoreo setup and configuration |
🤖 Prompt for AI Agents
In `@docs/install/managed-cluster.md` at line 918, The See Also entry currently
references the removed file "./single-cluster.md"; update the See Also section
to remove or replace that broken link (the string "./single-cluster.md") with
the correct target (e.g., the consolidated self-hosted-cluster doc or another
existing page) so the link no longer points to a deleted file; ensure the update
is applied in the See Also section where the line "- [Single Cluster
Installation](./single-cluster.md) - Installation on self-hosted Kubernetes"
appears.
| @@ -0,0 +1,648 @@ | |||
| # Install on Self Hosted Kubernetes Cluster | |||
There was a problem hiding this comment.
Use hyphenated form "Self-Hosted" in title.
The title should use "Self-Hosted" (hyphenated) rather than "Self Hosted" for proper compound adjective formatting.
📝 Proposed fix
-# Install on Self Hosted Kubernetes Cluster
+# Install on Self-Hosted Kubernetes Cluster📝 Committable suggestion
‼️ IMPORTANT
Carefully review the code before committing. Ensure that it accurately replaces the highlighted code, contains no missing lines, and has no issues with indentation. Thoroughly test & benchmark the code to ensure it meets the requirements.
| # Install on Self Hosted Kubernetes Cluster | |
| # Install on Self-Hosted Kubernetes Cluster |
🧰 Tools
🪛 LanguageTool
[grammar] ~1-~1: Use a hyphen to join words.
Context: # Install on Self Hosted Kubernetes Cluster Install the A...
(QB_NEW_EN_HYPHEN)
🤖 Prompt for AI Agents
In `@docs/install/self-hosted-cluster.md` at line 1, The document title "Install
on Self Hosted Kubernetes Cluster" should use the hyphenated compound adjective;
update the markdown heading text from "Install on Self Hosted Kubernetes
Cluster" to "Install on Self-Hosted Kubernetes Cluster" (edit the heading string
at the top of docs/install/self-hosted-cluster.md).
| -n ${DATA_PLANE_NS} --timeout=300s | ||
|
|
||
| # Apply the Gateway Operator configuration for API authentication and rate limiting | ||
| kubectl apply -f https://raw.githubusercontent.com/wso2/ai-agent-management-platform/amp/v0.3.0/deployments/values/api-platform-operator-full-config.yaml |
There was a problem hiding this comment.
Inconsistent version references across documentation.
The documentation uses amp/v0.3.0 in lines 368, 377, and 384, but uses amp/v0.0.0-dev elsewhere (lines 83, 102, 129, 179, 244, 270). This version inconsistency will confuse users about which version to use.
Please standardize on a single version reference throughout the documentation, or clearly explain why different versions are needed for different components.
Also applies to: 377-377, 384-384
🤖 Prompt for AI Agents
In `@docs/install/self-hosted-cluster.md` at line 368, The docs contain
inconsistent version strings (e.g. URLs with "amp/v0.3.0" and others using
"amp/v0.0.0-dev") which will confuse users; search for occurrences of the GitHub
raw URLs and version tokens (for example the URL
"https://raw.githubusercontent.com/wso2/ai-agent-management-platform/amp/v0.3.0/deployments/values/api-platform-operator-full-config.yaml"
and any references to "amp/v0.0.0-dev") and standardize them to a single agreed
version (or replace with a variable/placeholder like "amp/<RELEASE>" and
document the intended value), updating every reference (including the other two
affected lines) so all links and version mentions match or add a short note
explaining why differing versions are required for specific components.
|
|
||
| Common alternative endpoints: | ||
| - **Docker Desktop / Colima:** `host.docker.internal:10082` | ||
| - **Node IP based:** `<node-ip>:10082` |
There was a problem hiding this comment.
Use hyphenated form "Node-IP-based".
The phrase "Node IP based" should be hyphenated as "Node-IP-based" when used as a compound adjective.
📝 Proposed fix
-- **Node IP based:** `<node-ip>:10082`
+- **Node-IP-based:** `<node-ip>:10082`📝 Committable suggestion
‼️ IMPORTANT
Carefully review the code before committing. Ensure that it accurately replaces the highlighted code, contains no missing lines, and has no issues with indentation. Thoroughly test & benchmark the code to ensure it meets the requirements.
| - **Node IP based:** `<node-ip>:10082` | |
| - **Node-IP-based:** `<node-ip>:10082` |
🧰 Tools
🪛 LanguageTool
[grammar] ~435-~435: Use a hyphen to join words.
Context: ...host.docker.internal:10082 - Node IP based: <node-ip>:10082 - **In-cluste...
(QB_NEW_EN_HYPHEN)
🤖 Prompt for AI Agents
In `@docs/install/self-hosted-cluster.md` at line 435, Replace the unhyphenated
phrase "Node IP based" with the hyphenated compound adjective "Node-IP-based" in
the docs line that currently reads "- **Node IP based:** `<node-ip>:10082`
(update the bold text portion "Node IP based" to "Node-IP-based" so the compound
adjective is correct).
|
|
||
| ```bash | ||
| helm install amp \ | ||
| oci://${HELM_CHART_REGISTRY}/wso2-ai-agent-management-platform \ |
There was a problem hiding this comment.
Inconsistent Helm chart name.
Line 581 references wso2-ai-agent-management-platform as the chart name, but elsewhere in the documentation (line 275) it's wso2-agent-manager. This inconsistency could cause user confusion.
Please verify the correct chart name and use it consistently throughout the documentation.
🤖 Prompt for AI Agents
In `@docs/install/self-hosted-cluster.md` at line 581, The docs contain
inconsistent Helm chart names: `wso2-ai-agent-management-platform` (line 581) vs
`wso2-agent-manager` (line 275); pick the correct chart name and make it
consistent across the document by replacing the incorrect occurrence(s). Update
all references to the chosen chart name (e.g., occurrences of
`wso2-ai-agent-management-platform` or `wso2-agent-manager`) so every helm
install/registry URI and example uses the same identifier.
|
|
||
| ## See Also | ||
|
|
||
| - [Quick Start Guide](../quick-start.md) - Complete automated setup with k3d and OpenChoreo |
There was a problem hiding this comment.
Broken link to removed documentation file.
The See Also section references ./single-cluster.md, but this file was removed in the current PR (as indicated by the AI summary that notes "the existing single-cluster documentation (docs/install/single-cluster.md) is removed").
🔧 Proposed fix
Since the single-cluster documentation no longer exists and has been replaced by this self-hosted guide and the managed-cluster guide, this link should be removed or replaced:
## See Also
-- [Quick Start Guide](../quick-start.md) - Complete automated setup with k3d and OpenChoreo
+- [Installation on Managed Kubernetes](./managed-cluster.md) - Installation guide for managed Kubernetes clusters
+- [Quick Start Guide](../quick-start.md) - Complete automated setup with k3d and OpenChoreo
- [Main README](../../README.md) - Project overview and architecture
- [OpenChoreo Documentation](https://openchoreo.dev/docs/v0.9.x/) - Official OpenChoreo setup and configuration
- [OpenChoreo Self-Hosted Kubernetes Guide](https://openchoreo.dev/docs/v0.9.x/getting-started/try-it-out/on-self-hosted-kubernetes/) - Detailed OpenChoreo deployment guide
-- [Single Cluster Installation](./single-cluster.md) - Installation on self-hosted Kubernetes🤖 Prompt for AI Agents
In `@docs/install/self-hosted-cluster.md` at line 645, The See Also entry
referencing "./single-cluster.md" in the docs/install/self-hosted-cluster.md
file is now broken because that file was removed; remove that link (or replace
it) by updating the "See Also" section to either delete the
"./single-cluster.md" bullet or replace it with links to the current
alternatives (for example the managed-cluster guide and this self-hosted guide).
Locate the "See Also" section and the exact link text "./single-cluster.md" to
make the change, ensuring link formatting matches the surrounding entries.
| ## See Also | ||
|
|
||
| - [Single Cluster Installation](./install/single-cluster.md) - Install on existing OpenChoreo cluster | ||
| - [Installation on self hosted kubernetes cluster](./install/self-hosted-cluster.md) |
There was a problem hiding this comment.
Use hyphenated form "self-hosted" in link text.
The link text should use "self-hosted" (hyphenated) rather than "self hosted" for proper compound adjective formatting, consistent with the file name and documentation standards.
📝 Proposed fix
-- [Installation on self hosted kubernetes cluster](./install/self-hosted-cluster.md)
+- [Installation on self-hosted Kubernetes cluster](./install/self-hosted-cluster.md)Note: Also capitalize "Kubernetes" for consistency with line 73.
📝 Committable suggestion
‼️ IMPORTANT
Carefully review the code before committing. Ensure that it accurately replaces the highlighted code, contains no missing lines, and has no issues with indentation. Thoroughly test & benchmark the code to ensure it meets the requirements.
| - [Installation on self hosted kubernetes cluster](./install/self-hosted-cluster.md) | |
| - [Installation on self-hosted Kubernetes cluster](./install/self-hosted-cluster.md) |
🧰 Tools
🪛 LanguageTool
[grammar] ~72-~72: Use a hyphen to join words.
Context: ...`` ## See Also - [Installation on self hosted kubernetes cluster](./install/sel...
(QB_NEW_EN_HYPHEN)
🤖 Prompt for AI Agents
In `@docs/quick-start.md` at line 72, Update the link text in docs/quick-start.md:
change the label "[Installation on self hosted kubernetes cluster]" to the
hyphenated and capitalized form "[Installation on self-hosted Kubernetes
cluster]" so it matches the file name and documentation style; locate the link
text string in the file and update the hyphenation for "self-hosted" and
capitalization of "Kubernetes" accordingly.
1 participant
Purpose
Add self hosted k8s docs and managed k8s docs.
Fixes #247
Goals
Approach
User stories
Release note
Documentation
Training
Certification
Marketing
Automation tests
Security checks
Samples
Related PRs
Migrations (if applicable)
Test environment
Learning
Summary by CodeRabbit
✏️ Tip: You can customize this high-level summary in your review settings.