Skip to content
Open
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Original file line number Diff line number Diff line change
Expand Up @@ -23,7 +23,7 @@ To get started:
```bash
git clone https://github.com/wso2-enterprise/helm-mi.git
cd helm-mi
git checkout 4.4.x
git checkout 4.6.x
Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

⚠️ Potential issue | 🔴 Critical

🧩 Analysis chain

🏁 Script executed:

#!/bin/bash
# Description: Verify that the 4.6.x branch exists in the helm-mi repository

# Check if the branch exists
git ls-remote --heads https://github.com/wso2-enterprise/helm-mi.git 4.6.x

Repository: wso2/docs-mi

Length of output: 38


The 4.6.x branch does not exist in the helm-mi repository.

The git checkout 4.6.x command at line 26 references a branch that cannot be found in the wso2-enterprise/helm-mi repository. Verify the correct branch name or ensure the branch is created before this documentation is published.

🤖 Prompt for AI Agents
Verify each finding against the current code and only fix it if needed.

In `@en/docs/install-and-setup/setup/deployment/configuring-helm-charts.md` at
line 26, Replace the invalid branch reference "git checkout 4.6.x" in the
documentation with the correct branch name (or remove the checkout step) after
verifying the actual branch present in the helm-mi repository; locate the
literal "git checkout 4.6.x" in the document and update it to the repository's
correct branch (e.g., main, master, or the specific release branch) or add a
note instructing readers to use the appropriate branch name if it varies.

```

Let's refer to the root folder of the local copy as `<HELM_HOME>`.
Expand Down Expand Up @@ -53,13 +53,13 @@ There may be scenarios where you need to create a customized base WSO2 Integrato
The example below shows how to copy custom JARs into the MI runtime's `lib` directory:

```docker
FROM registry.wso2.com/wso2-integrator/mi:4.4.0
FROM registry.wso2.com/wso2-integrator/mi:4.6.0

USER wso2carbon

ARG USER_HOME=/home/${USER}
ARG WSO2_SERVER_NAME=wso2mi
ARG WSO2_SERVER_VERSION=4.4.0
ARG WSO2_SERVER_VERSION=4.6.0
ARG WSO2_SERVER=${WSO2_SERVER_NAME}-${WSO2_SERVER_VERSION}
ARG WSO2_SERVER_HOME=${USER_HOME}/${WSO2_SERVER}

Expand Down Expand Up @@ -227,7 +227,7 @@ Follow the steps below to secure the TOML configurations:
```

Once enabled, all the password values provided via the Helm chart must be in encrypted format.
Refer to the [`[secrets]` section](https://github.com/wso2/helm-mi/blob/4.4.x/mi/confs/deployment.toml#L204) of the `deployment.toml` to identify which values require encryption.
Refer to the [`[secrets]` section](https://github.com/wso2/helm-mi/blob/4.6.x/mi/confs/deployment.toml#L204) of the `deployment.toml` to identify which values require encryption.
Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

⚠️ Potential issue | 🔴 Critical

🧩 Analysis chain

🏁 Script executed:

#!/bin/bash
# Description: Verify the deployment.toml link and check if [secrets] section is at line 204

# Fetch the file and check line 204
curl -s "https://raw.githubusercontent.com/wso2/helm-mi/4.6.x/mi/confs/deployment.toml" > /tmp/deployment.toml

# Check what's at line 204
echo "Content at line 204:"
sed -n '204p' /tmp/deployment.toml

# Find the actual line number of [secrets] section
echo -e "\nActual location of [secrets] section:"
grep -n "^\[secrets\]" /tmp/deployment.toml

Repository: wso2/docs-mi

Length of output: 115


🏁 Script executed:

#!/bin/bash
# Test if the file exists and can be accessed
echo "Testing GitHub URL accessibility..."
http_code=$(curl -s -o /dev/null -w "%{http_code}" "https://raw.githubusercontent.com/wso2/helm-mi/4.6.x/mi/confs/deployment.toml")
echo "HTTP status code: $http_code"

# Try to fetch and display initial content
echo -e "\n--- Fetching file ---"
curl -s "https://raw.githubusercontent.com/wso2/helm-mi/4.6.x/mi/confs/deployment.toml" | head -20

# Check if file exists in 4.4.x for comparison
echo -e "\n--- Checking 4.4.x branch ---"
http_code_44=$(curl -s -o /dev/null -w "%{http_code}" "https://raw.githubusercontent.com/wso2/helm-mi/4.4.x/mi/confs/deployment.toml")
echo "4.4.x HTTP status code: $http_code_44"

# Try alternative paths
echo -e "\n--- Checking alternative paths in 4.6.x ---"
for path in "helm-mi/tree/4.6.x" "helm-mi/blob/4.6.x" "helm-mi/4.6.x"; do
  echo "Testing path pattern: $path"
done

# Try to access the repository listing
echo -e "\n--- Testing direct repo access ---"
curl -s -I "https://api.github.com/repos/wso2/helm-mi/branches" | head -5

Repository: wso2/docs-mi

Length of output: 608


🏁 Script executed:

#!/bin/bash
# Check available branches in wso2/helm-mi
echo "Available branches in wso2/helm-mi:"
curl -s "https://api.github.com/repos/wso2/helm-mi/branches" | grep -o '"name": "[^"]*"' | head -20

# Check if 4.6.x exists
echo -e "\n--- Checking if 4.6.x branch exists ---"
curl -s "https://api.github.com/repos/wso2/helm-mi/branches/4.6.x" | grep -o '"name": "[^"]*"'

# List all tags to see version releases
echo -e "\n--- Recent tags/releases ---"
curl -s "https://api.github.com/repos/wso2/helm-mi/tags" | grep -o '"name": "[^"]*"' | head -10

# Try to fetch the file from different branch variations
echo -e "\n--- Testing main/master branches ---"
for branch in "main" "master" "4.5.x" "4.7.x"; do
  http_code=$(curl -s -o /dev/null -w "%{http_code}" "https://raw.githubusercontent.com/wso2/helm-mi/$branch/mi/confs/deployment.toml")
  echo "$branch: HTTP $http_code"
done

Repository: wso2/docs-mi

Length of output: 343


🏁 Script executed:

#!/bin/bash
# The 4.6.x branch doesn't exist. Check the file in existing branches
echo "Fetching deployment.toml from 4.5.x (latest stable branch):"
curl -s "https://raw.githubusercontent.com/wso2/helm-mi/4.5.x/mi/confs/deployment.toml" > /tmp/deployment_45.toml

echo "Line count: $(wc -l < /tmp/deployment_45.toml)"
echo -e "\nContent around line 204:"
sed -n '200,210p' /tmp/deployment_45.toml

echo -e "\n--- Locating [secrets] section ---"
grep -n "^\[secrets\]" /tmp/deployment_45.toml

# Also check in main branch
echo -e "\n--- Checking main branch ---"
curl -s "https://raw.githubusercontent.com/wso2/helm-mi/main/mi/confs/deployment.toml" > /tmp/deployment_main.toml
echo "Line count (main): $(wc -l < /tmp/deployment_main.toml)"
grep -n "^\[secrets\]" /tmp/deployment_main.toml

# Show context around [secrets] in 4.5.x
echo -e "\n--- Context around [secrets] in 4.5.x ---"
line_num=$(grep -n "^\[secrets\]" /tmp/deployment_45.toml | cut -d: -f1)
if [ ! -z "$line_num" ]; then
  echo "Line $line_num and context:"
  sed -n "$((line_num-2)),$((line_num+2))p" /tmp/deployment_45.toml
fi

Repository: wso2/docs-mi

Length of output: 1177


Update the branch reference — 4.6.x does not exist.

The link references 4.6.x branch which does not exist in the wso2/helm-mi repository. Available branches are: 4.2.x, 4.3.x, 4.4.x, 4.5.x, and main. The [secrets] section is correctly at line 204 in both 4.5.x and main branches. Update the link to reference 4.5.x (latest stable) or main as appropriate for the documentation's target version.

🤖 Prompt for AI Agents
Verify each finding against the current code and only fix it if needed.

In `@en/docs/install-and-setup/setup/deployment/configuring-helm-charts.md` at
line 230, The documentation link points to the non-existent branch "4.6.x";
update the URL in the sentence that currently links
`https://github.com/wso2/helm-mi/blob/4.6.x/mi/confs/deployment.toml#L204` (the
"Refer to the [`[secrets]` section]" link) to reference a valid branch such as
`4.5.x` or `main` (e.g., replace `4.6.x` with `4.5.x`), ensuring the anchor
`#L204` remains so the link still targets the `[secrets]` section.


2. Encrypt secret values.

Expand All @@ -249,9 +249,9 @@ Follow the steps below to secure the TOML configurations:

Refer to the following guides based on your cloud environment for detailed instructions:

- <a target="_blank" href="https://github.com/wso2/helm-mi/blob/4.4.x/mi/EXAMPLES.md#amazon-elastic-kubernetes-service-eks">Amazon Elastic Kubernetes Service (EKS)</a>
- <a target="_blank" href="https://github.com/wso2/helm-mi/blob/4.4.x/mi/EXAMPLES.md#azure-kubernetes-service-aks">Azure Kubernetes Service (AKS)</a>
- <a target="_blank" href="https://github.com/wso2/helm-mi/blob/4.4.x/mi/EXAMPLES.md#google-kubernetes-engine-gke">Google Kubernetes Engine (GKE)</a>
- <a target="_blank" href="https://github.com/wso2/helm-mi/blob/4.6.x/mi/EXAMPLES.md#amazon-elastic-kubernetes-service-eks">Amazon Elastic Kubernetes Service (EKS)</a>
- <a target="_blank" href="https://github.com/wso2/helm-mi/blob/4.6.x/mi/EXAMPLES.md#azure-kubernetes-service-aks">Azure Kubernetes Service (AKS)</a>
- <a target="_blank" href="https://github.com/wso2/helm-mi/blob/4.6.x/mi/EXAMPLES.md#google-kubernetes-engine-gke">Google Kubernetes Engine (GKE)</a>
Comment on lines +252 to +254
Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

⚠️ Potential issue | 🔴 Critical

🧩 Analysis chain

🏁 Script executed:

#!/bin/bash
# Description: Verify EXAMPLES.md exists and contains the expected anchors

# Fetch the EXAMPLES.md file
curl -s "https://raw.githubusercontent.com/wso2/helm-mi/4.6.x/mi/EXAMPLES.md" > /tmp/examples.md

# Check if file exists and has content
if [ ! -s /tmp/examples.md ]; then
  echo "ERROR: EXAMPLES.md not found or empty"
  exit 1
fi

# Search for the expected sections
echo "Checking for cloud provider sections:"
grep -i "amazon elastic kubernetes service\|eks" /tmp/examples.md | head -3
echo "---"
grep -i "azure kubernetes service\|aks" /tmp/examples.md | head -3
echo "---"
grep -i "google kubernetes engine\|gke" /tmp/examples.md | head -3

Repository: wso2/docs-mi

Length of output: 101


🏁 Script executed:

#!/bin/bash
# Fetch the EXAMPLES.md file and examine its structure
curl -s "https://raw.githubusercontent.com/wso2/helm-mi/4.6.x/mi/EXAMPLES.md" | head -200
echo "---SEARCHING FOR HEADINGS---"
curl -s "https://raw.githubusercontent.com/wso2/helm-mi/4.6.x/mi/EXAMPLES.md" | grep -E "^#+\s" | head -20

Repository: wso2/docs-mi

Length of output: 98


🏁 Script executed:

#!/bin/bash
# Check if the repository exists and what branches are available
curl -s "https://api.github.com/repos/wso2/helm-mi/branches" | jq -r '.[].name' | head -20
echo "---"
# Try to find EXAMPLES.md in the main/master branch
curl -s "https://raw.githubusercontent.com/wso2/helm-mi/main/mi/EXAMPLES.md" | head -50

Repository: wso2/docs-mi

Length of output: 1753


🏁 Script executed:

#!/bin/bash
# Double-check all available branches using git API with pagination
curl -s "https://api.github.com/repos/wso2/helm-mi/branches?per_page=100" | jq -r '.[].name'

Repository: wso2/docs-mi

Length of output: 84


Fix broken documentation links: 4.6.x branch does not exist in wso2/helm-mi repository.

The links at lines 252-254 point to the 4.6.x branch, but this branch does not exist. Available branches are 4.2.x, 4.3.x, 4.4.x, 4.5.x, and main. Update these links to point to the 4.5.x branch (the latest stable release) or the main branch:

  • Replace blob/4.6.x with blob/4.5.x in all three links (EKS, AKS, GKE)
🤖 Prompt for AI Agents
Verify each finding against the current code and only fix it if needed.

In `@en/docs/install-and-setup/setup/deployment/configuring-helm-charts.md` around
lines 252 - 254, The three external links referencing the non-existent branch
should be updated: locate the anchor tags with link texts "Amazon Elastic
Kubernetes Service (EKS)", "Azure Kubernetes Service (AKS)", and "Google
Kubernetes Engine (GKE)" and replace "blob/4.6.x" with "blob/4.5.x" in their
href attributes so the links point to the 4.5.x branch instead of 4.6.x.


## User store configurations

Expand Down Expand Up @@ -467,6 +467,6 @@ This ensures that all generated resources follow the naming convention for easie

## What's next?

- To explore advanced configurations and vendor–specific cluster settings, refer to the <a target="_blank" href="https://github.com/wso2/helm-mi/blob/4.4.x/mi/EXAMPLES.md">Examples documentation</a> and the <a target="_blank" href="https://github.com/wso2/helm-mi/blob/4.4.x/mi/CONFIG.md">Config documentation</a> in the WSO2 Integrator: MI Helm Chart repository.
- To explore advanced configurations and vendor–specific cluster settings, refer to the <a target="_blank" href="https://github.com/wso2/helm-mi/blob/4.6.x/mi/EXAMPLES.md">Examples documentation</a> and the <a target="_blank" href="https://github.com/wso2/helm-mi/blob/4.6.x/mi/CONFIG.md">Config documentation</a> in the WSO2 Integrator: MI Helm Chart repository.
Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

⚠️ Potential issue | 🔴 Critical

🧩 Analysis chain

🏁 Script executed:

#!/bin/bash
# Description: Verify EXAMPLES.md and CONFIG.md exist in the 4.6.x branch

echo "Checking EXAMPLES.md:"
curl -s -o /dev/null -w "HTTP Status: %{http_code}\n" "https://raw.githubusercontent.com/wso2/helm-mi/4.6.x/mi/EXAMPLES.md"

echo "Checking CONFIG.md:"
curl -s -o /dev/null -w "HTTP Status: %{http_code}\n" "https://raw.githubusercontent.com/wso2/helm-mi/4.6.x/mi/CONFIG.md"

Repository: wso2/docs-mi

Length of output: 131


Fix broken documentation links pointing to non-existent files.

The links to EXAMPLES.md and CONFIG.md on the 4.6.x branch are broken (both return HTTP 404). These files do not exist in the referenced repository branch. Update the links to point to the correct locations where these files actually exist, or remove the references if they are no longer maintained.

🤖 Prompt for AI Agents
Verify each finding against the current code and only fix it if needed.

In `@en/docs/install-and-setup/setup/deployment/configuring-helm-charts.md` at
line 470, The two anchor links referencing EXAMPLES.md and CONFIG.md (the
"Examples documentation" and "Config documentation" links) point to non-existent
files on the 4.6.x branch and must be fixed; update the hrefs to the correct
URLs where those documents actually live (for example the matching files on the
main branch or their new locations in the repo) or remove the sentence if those
docs were removed, ensuring the anchor text and filenames EXAMPLES.md and
CONFIG.md are updated accordingly so the links no longer return 404.


- For a hands-on experience deploying WSO2 Integrator: MI and the Integration Control Plane (ICP) in a local Kubernetes cluster using commonly used configurations, see the [Sample Deployment]({{base_path}}/install-and-setup/setup/deployment/sample-k8s-deployment/) guide.