Skip to content

feat(docs): executing integrations added to design docs#224

Merged
lordrip merged 1 commit into
KaotoIO:mainfrom
PVinaches:executing-nodes
Apr 3, 2026
Merged

feat(docs): executing integrations added to design docs#224
lordrip merged 1 commit into
KaotoIO:mainfrom
PVinaches:executing-nodes

Conversation

@PVinaches

@PVinaches PVinaches commented Apr 3, 2026

Copy link
Copy Markdown
Member

Added executing nodes doc to designer docs

Summary by CodeRabbit

  • Documentation
    • Added a comprehensive "Executing Integrations" guide with step-by-step run/stop instructions for single integrations, folders, and full-workspace execution
    • Expanded troubleshooting with multiple problem/solution sections, expected terminal output examples, and guidance for common failures (startup, port conflicts, integration conflicts)
    • Added best practices for execution patterns, project organization, and configuration/property-file management
    • Updated Designer landing page with a callout linking to the new execution guide
    • Removed an earlier draft placeholder for route execution documentation

@PVinaches PVinaches requested a review from a team April 3, 2026 11:13
@coderabbitai

coderabbitai Bot commented Apr 3, 2026

Copy link
Copy Markdown

Warning

Rate limit exceeded

@PVinaches has exceeded the limit for the number of commits that can be reviewed per hour. Please wait 24 minutes and 50 seconds before requesting another review.

Your organization is not enrolled in usage-based pricing. Contact your admin to enable usage-based pricing to continue reviews beyond the rate limit, or try again in 24 minutes and 50 seconds.

⌛ How to resolve this issue?

After the wait time has elapsed, a review can be triggered using the @coderabbitai review command as a PR comment. Alternatively, push new commits to this PR.

We recommend that you space out your commits to avoid hitting the rate limit.

🚦 How do rate limits work?

CodeRabbit enforces hourly rate limits for each developer per organization.

Our paid plans have higher rate limits than the trial, open-source and free plans. In all cases, we re-allow further reviews after a brief timeout.

Please see our FAQ for further information.

ℹ️ Review info
⚙️ Run configuration

Configuration used: Organization UI

Review profile: CHILL

Plan: Pro

Run ID: 7b83a114-17d5-4104-a8b8-275d19270e59

📥 Commits

Reviewing files that changed from the base of the PR and between b7c73bd and cf1b4f8.

⛔ Files ignored due to path filters (4)
  • content/docs/designer/05-executing-integrations/play-folder.png is excluded by !**/*.png
  • content/docs/designer/05-executing-integrations/play-single-route.png is excluded by !**/*.png
  • content/docs/designer/05-executing-integrations/play-workspace.png is excluded by !**/*.png
  • content/docs/designer/05-executing-integrations/stop-route.png is excluded by !**/*.png
📒 Files selected for processing (3)
  • content/docs/designer/05-executing-integrations/_index.md
  • content/docs/designer/05-executing-routes/_index.md
  • content/docs/designer/_index.md
📝 Walkthrough

Walkthrough

Removed a draft "Executing Routes" doc, added a new "Executing Integrations" page with detailed run/stop scopes, troubleshooting, and best practices, and added a Designer landing callout linking to the new execution guide.

Changes

Cohort / File(s) Summary
Removed draft page
content/docs/designer/05-executing-routes/_index.md
Deleted the draft frontmatter and placeholder content for an "Executing Routes" page (entire file removal).
New Executing Integrations guide
content/docs/designer/05-executing-integrations/_index.md
Added a full "Executing Integrations" document covering single-file, folder, and workspace execution scopes, step-by-step run/stop instructions, expected terminal output, troubleshooting scenarios, examples, images, and best practices.
Designer landing update
content/docs/designer/_index.md
Inserted a callout on the Designer index linking to the new execution guide with brief execution/testing workflow notes.

Estimated code review effort

🎯 2 (Simple) | ⏱️ ~10 minutes

Possibly related PRs

Poem

🐰 I hop through pages, tidy and spry,
I start a route and watch logs fly,
Single files, folders, whole-workspace song,
Debugging carrots help me along,
Hooray — integrations hum all day long!

🚥 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 accurately reflects the main change: adding documentation for executing integrations to the designer docs section.
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.

✨ Finishing Touches
🧪 Generate unit tests (beta)
  • Create PR with unit tests

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

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

@coderabbitai coderabbitai Bot left a comment

Copy link
Copy Markdown

Choose a reason for hiding this comment

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

Actionable comments posted: 1

🧹 Nitpick comments (1)
content/docs/designer/05-executing-routes/_index.md (1)

173-173: Make port-conflict remediation safer and OS-complete.

kill -9 is an aggressive default and the section currently excludes Windows remediation. Consider a safer first-step command and add a Windows equivalent.

Suggested doc tweak
-- Kill the process using the port: `lsof -ti:8080 | xargs kill -9` (macOS/Linux)
+- Stop the process using the port (macOS/Linux): `lsof -ti:8080 | xargs kill`
+- If the process does not stop, force kill as a last resort: `lsof -ti:8080 | xargs kill -9`
+- Windows (PowerShell): `Stop-Process -Id (Get-NetTCPConnection -LocalPort 8080).OwningProcess`
🤖 Prompt for AI Agents
Verify each finding against the current code and only fix it if needed.

In `@content/docs/designer/05-executing-routes/_index.md` at line 173, Replace the
single aggressive, macOS/Linux-only remediation line "Kill the process using the
port: `lsof -ti:8080 | xargs kill -9`" with a safer, OS-complete set of steps:
for macOS/Linux show a gentler first attempt using `lsof -ti:8080 | xargs kill`
(or `kill -TERM <pid>`) and optionally escalate to `kill -9` only if needed;
include Windows equivalents to find and stop the process such as `netstat -ano |
findstr :8080` then `taskkill /PID <pid>` (or `taskkill /PID <pid> /F` to force)
and a PowerShell option `Get-Process -Id <pid> | Stop-Process`; keep the example
port (8080) and show how to obtain the pid before killing so readers can confirm
the target process.
🤖 Prompt for all review comments with AI agents
Verify each finding against the current code and only fix it if needed.

Inline comments:
In `@content/docs/designer/05-executing-routes/_index.md`:
- Around line 146-147: Update the wording that tells users to "Add log
processors to track message flow" so it clarifies that a Log processor is
included by default in new Kaoto routes; change it to something like "Add
additional log processors if needed" or "Reuse/update the existing Log step" and
similarly update other repeated instances that instruct manually adding a Log
component (mentions of timer, SetBody step, and Log processor), ensuring the
text explains new routes already include a timer, SetBody, and Log and that
users only need to add or modify log processors when required.

---

Nitpick comments:
In `@content/docs/designer/05-executing-routes/_index.md`:
- Line 173: Replace the single aggressive, macOS/Linux-only remediation line
"Kill the process using the port: `lsof -ti:8080 | xargs kill -9`" with a safer,
OS-complete set of steps: for macOS/Linux show a gentler first attempt using
`lsof -ti:8080 | xargs kill` (or `kill -TERM <pid>`) and optionally escalate to
`kill -9` only if needed; include Windows equivalents to find and stop the
process such as `netstat -ano | findstr :8080` then `taskkill /PID <pid>` (or
`taskkill /PID <pid> /F` to force) and a PowerShell option `Get-Process -Id
<pid> | Stop-Process`; keep the example port (8080) and show how to obtain the
pid before killing so readers can confirm the target process.
🪄 Autofix (Beta)

Fix all unresolved CodeRabbit comments on this PR:

  • Push a commit to this branch (recommended)
  • Create a new PR with the fixes

ℹ️ Review info
⚙️ Run configuration

Configuration used: Organization UI

Review profile: CHILL

Plan: Pro

Run ID: 52c77833-c714-4d29-a054-2f2c34abdc2f

📥 Commits

Reviewing files that changed from the base of the PR and between 12ef338 and d6c7afa.

⛔ Files ignored due to path filters (4)
  • content/docs/designer/05-executing-routes/play-folder.png is excluded by !**/*.png
  • content/docs/designer/05-executing-routes/play-single-route.png is excluded by !**/*.png
  • content/docs/designer/05-executing-routes/play-workspace.png is excluded by !**/*.png
  • content/docs/designer/05-executing-routes/stop-route.png is excluded by !**/*.png
📒 Files selected for processing (2)
  • content/docs/designer/05-executing-routes/_index.md
  • content/docs/designer/_index.md

Comment on lines +146 to +147
2. Add log processors to track message flow
3. Use the terminal output to identify problems

Copy link
Copy Markdown

Choose a reason for hiding this comment

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

⚠️ Potential issue | 🟡 Minor

Clarify log-processor guidance to avoid redundant steps for new routes.

These instructions imply users must add log processors, but newly created Kaoto routes already include one by default. Please reword to “add additional log processors if needed” or “reuse/update existing log steps.”

Based on learnings: When creating a new Camel route in Kaoto VSCode extension, the default route structure automatically includes a timer component, SetBody step, and Log processor. Users don't need to add the Log component manually.

Also applies to: 182-183, 213-214

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

In `@content/docs/designer/05-executing-routes/_index.md` around lines 146 - 147,
Update the wording that tells users to "Add log processors to track message
flow" so it clarifies that a Log processor is included by default in new Kaoto
routes; change it to something like "Add additional log processors if needed" or
"Reuse/update the existing Log step" and similarly update other repeated
instances that instruct manually adding a Log component (mentions of timer,
SetBody step, and Log processor), ensuring the text explains new routes already
include a timer, SetBody, and Log and that users only need to add or modify log
processors when required.

@PVinaches PVinaches force-pushed the executing-nodes branch 2 times, most recently from 9d576bd to cbb49e3 Compare April 3, 2026 13:54
@lordrip lordrip changed the title feat(docs): executing nodes added to design docs feat(docs): executing integrations added to design docs Apr 3, 2026
lordrip
lordrip previously approved these changes Apr 3, 2026
lordrip
lordrip previously approved these changes Apr 3, 2026
Comment thread content/docs/designer/_index.md Outdated
@lordrip lordrip merged commit 437212e into KaotoIO:main Apr 3, 2026
2 checks passed
@PVinaches PVinaches deleted the executing-nodes branch April 7, 2026 08:55
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants