Add Konveyor deployment and usage guide

[chideat]

Summary by CodeRabbit

• Documentation
  • Added a comprehensive user guide for deploying and operating Konveyor: overview, prerequisites, operator installation, deploying Konveyor Hub, verification steps, configuration options, UI access and admin initialization, production TLS/Ingress setup with certificate guidance, enabling Konveyor AI (supported providers/models and credential setup), forcing reconciliation, component overview, and references.

_{✏️ Tip: You can customize this high-level summary in your review settings.}

[coderabbitai]

Note

Other AI code review bot(s) detected

CodeRabbit has detected other AI code review bot(s) in this pull request and will avoid duplicating their findings in the review comments. This may lead to a less comprehensive review.

Walkthrough

Adds a new documentation guide describing how to deploy and operate Konveyor (Hub/Tackle), covering prerequisites, operator installation, Tackle CR deployment, verification, access (port‑forward and Ingress/TLS), Konveyor AI enablement, credential management, reconciliation, component overview, and references.

Changes

Cohort / File(s)	Summary
Documentation docs/en/solutions/How_to_Use_Konveyor.md	New ~266-line guide providing end-to-end Konveyor deployment and operation instructions: prerequisites, operator install, Tackle CR examples, verification, port‑forward and Ingress/TLS access, Keycloak/admin initialization, KAI provider/model enablement, credential secret examples, reconcile command, component overview, and references.

Estimated code review effort

🎯 1 (Trivial) | ⏱️ ~2 minutes

Suggested reviewers

• typhoonzero
• fanzy618
• sinbadonline

Poem

🐰 I hopped through docs with a careful paw,

Placed CRs and secrets in tidy rows,
Port‑forwards, TLS, and KAI to awe,
Admin keys tucked where the cluster grows,
Hop in—your Konveyor garden glows. 🥕

🚥 Pre-merge checks | ✅ 3

✅ Passed checks (3 passed)

Check name	Status	Explanation
Description Check	✅ Passed	Check skipped - CodeRabbit’s high-level summary is enabled.
Title check	✅ Passed	The title 'Add Konveyor deployment and usage guide' accurately and concisely describes the main change: adding new documentation about deploying and using Konveyor.
Docstring Coverage	✅ Passed	No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check.

_{✏️ Tip: You can configure your own custom pre-merge checks in the settings.}

---

🧹 Recent nitpick comments

docs/en/solutions/How_to_Use_Konveyor.md (2)

31-31: Clarify the required namespace name.

The statement requires deploying Tackle in the same namespace as the konveyor-operator but doesn't specify what that namespace is. The example at line 39 uses konveyor-tackle, implying that's where the operator runs, but this should be stated explicitly.

📝 Proposed clarification

-Deploy the Tackle platform by creating a Tackle CR. The Tackle instance must be deployed in the same namespace as the konveyor-operator.
+Deploy the Tackle platform by creating a Tackle CR. The Tackle instance must be deployed in the same namespace as the konveyor-operator (typically `konveyor-tackle`).

---

134-134: Update ALB deployment guide link to match documentation version.

The ALB deployment guide link references version 4.1, but the document frontmatter specifies 4.x and line 25 references 4.2 for the Upload Packages documentation. For consistency, update the ALB link to version 4.2 or use a version-agnostic URL if available.

🔗 Proposed fix

-- LoadBalancer service deployed (see [ALB deployment guide](https://docs.alauda.io/container_platform/4.1/configure/networking/how_to/alb/deploy_alb.html))
+- LoadBalancer service deployed (see [ALB deployment guide](https://docs.alauda.io/container_platform/4.2/configure/networking/how_to/alb/deploy_alb.html))

---

📜 Recent review details

Configuration used: Organization UI

Review profile: CHILL

Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between 519209a and 4b7558c.

📒 Files selected for processing (1)

• docs/en/solutions/How_to_Use_Konveyor.md

🧰 Additional context used

🧠 Learnings (1)

📚 Learning: 2026-01-13T11:25:34.596Z

Learnt from: jing2uo
Repo: alauda/knowledge PR: 104
File: docs/en/solutions/How_to_Migrate_VirtualMachine_From_VMware.md:131-172
Timestamp: 2026-01-13T11:25:34.596Z
Learning: In VMware migration documentation (docs/en/solutions), when describing the Forklift Operator workflow for VMware, specify that the VMware provider secret should set insecureSkipVerify=true to accommodate self-signed certificates commonly used in enterprise vCenter/ESXi environments. Include a note on the security trade-offs and ensure readers understand this is for internal, controlled environments.

Applied to files:

• docs/en/solutions/How_to_Use_Konveyor.md

🔇 Additional comments (1)

docs/en/solutions/How_to_Use_Konveyor.md (1)

262-266: Reference URLs are valid and accessible. All three links return HTTP 200 status and point to current Konveyor documentation and the official operator repository.

_{✏️ Tip: You can disable this entire section by setting review_details to false in your review settings.}

---

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.

❤️ Share

• X
• Mastodon
• Reddit
• LinkedIn

_{Comment @coderabbitai help to get the list of available commands and usage tips.}

[coderabbitai]

Actionable comments posted: 5

🤖 Fix all issues with AI agents

In `@docs/en/solutions/How_to_Use_Konveyor.md`:
- Line 114: The example password "Enter a new password (e.g., `admin@123`)" is
weak; update that text to show a stronger example (for instance:
`Str0ng!Admin#2026`) and/or replace with a password pattern recommendation like
"use a 12+ character password with upper and lower case letters, numbers, and
symbols" so the line referencing the example password is replaced with a
stronger example or a pattern recommendation.
- Around line 218-233: The docs currently recommend using kubectl create secret
... --from-literal which exposes secrets in shell history; update the examples
that reference the kubectl create secret generic kai-api-keys commands to use a
secure method such as piping a YAML Secret manifest to kubectl apply (using
stringData in the manifest) or using --from-env-file and removing the temp file,
and replace the inline --from-literal OpenAI/GOOGLE examples with the cat <<EOF
| kubectl apply -f - YAML snippets or the --from-env-file workflow described in
the comment so credentials are not passed on the command line.
- Line 253: Update the Crane description line to remove the inaccurate
"Community version is currently inactive" claim and instead state its current
status (e.g., "actively maintained as a community project in the migtools
organization with recent releases and ongoing development"); modify the table
entry containing "**Crane**" to reflect this wording so documentation accurately
represents Crane's active maintenance and development.
- Line 25: The documentation link in the sentence "Download the Konveyor
Operator plugin from Alauda Cloud Console Marketplace..." is incorrect (it
points to a backup install page); update the URL referenced for the violet tool
to the correct Alauda documentation for operator package upload/installation or
the violet CLI tool (replace the current
https://docs.alauda.io/container_platform/4.1/configure/backup/install.html link
with the appropriate Marketplace/OperatorHub or violet CLI docs URL), and ensure
the anchor text still mentions the violet tool and installation method.
- Around line 190-201: The "Supported Providers and Models" table is static and
can become outdated; add a short clarifying sentence under the "Supported
Providers and Models" heading stating that the table is illustrative (not
exhaustive) and directing readers to the Konveyor Official Documentation
(https://konveyor.io/docs/konveyor/) for the most current provider and model
support; include the link text and ensure the note is visible immediately after
the table so readers know where to check for updates.

📜 Review details

Configuration used: Organization UI

Review profile: CHILL

Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between b739efb and 2b4a107.

📒 Files selected for processing (1)

• docs/en/solutions/How_to_Use_Konveyor.md

🧰 Additional context used

🧠 Learnings (1)

📚 Learning: 2026-01-13T11:25:34.596Z

Learnt from: jing2uo
Repo: alauda/knowledge PR: 104
File: docs/en/solutions/How_to_Migrate_VirtualMachine_From_VMware.md:131-172
Timestamp: 2026-01-13T11:25:34.596Z
Learning: In VMware migration documentation (docs/en/solutions), when describing the Forklift Operator workflow for VMware, specify that the VMware provider secret should set insecureSkipVerify=true to accommodate self-signed certificates commonly used in enterprise vCenter/ESXi environments. Include a note on the security trade-offs and ensure readers understand this is for internal, controlled environments.

Applied to files:

• docs/en/solutions/How_to_Use_Konveyor.md

⏰ Context from checks skipped due to timeout of 90000ms. You can increase the timeout in your CodeRabbit configuration to a maximum of 15 minutes (900000ms). (1)

• GitHub Check: Agent

🔇 Additional comments (3)

docs/en/solutions/How_to_Use_Konveyor.md (3)

27-80: LGTM!

The Tackle deployment configuration is well-documented with clear placeholder comments for user-specific values. The warning about namespace requirements and the comprehensive configuration table are helpful.

---

120-184: LGTM!

The Ingress and TLS certificate configurations are correctly structured with appropriate placeholders and clear instructions for production deployment.

---

255-259: Reference links are current and accessible.

The documentation links provided in the references section are valid.

_{✏️ Tip: You can disable this entire section by setting review_details to false in your review settings.}

[Copilot]

Pull request overview

This PR adds comprehensive documentation for deploying and using Konveyor, a CNCF application modernization platform. The guide provides step-by-step instructions for installation, configuration, and accessing the platform.

Changes:

• Added complete deployment guide covering operator installation, Tackle instance creation, and UI access methods
• Documented KAI (Konveyor AI) configuration with multiple LLM provider options
• Included component overview describing the Konveyor ecosystem architecture

---

💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.