Skip to content

Add section to access CRC on same LAN#22

Merged
anjannath merged 1 commit into
crc-org:mainfrom
praveenkumar:access-cluster
Jun 8, 2026
Merged

Add section to access CRC on same LAN#22
anjannath merged 1 commit into
crc-org:mainfrom
praveenkumar:access-cluster

Conversation

@praveenkumar

@praveenkumar praveenkumar commented Jun 8, 2026

Copy link
Copy Markdown
Member

Summary by CodeRabbit

  • Documentation
    • Added a guide for accessing the cluster from other machines on the same LAN—covers firewall port configuration, setting up a persistent local-to-LAN API port forward, updating client host DNS mappings, and verifying access with login and node checks.
    • Updated site navigation with a Networking table-of-contents entry linking to the new guide.

@coderabbitai

coderabbitai Bot commented Jun 8, 2026

Copy link
Copy Markdown

Review Change Stack

No actionable comments were generated in the recent review. 🎉

ℹ️ Recent review info
⚙️ Run configuration

Configuration used: Organization UI

Review profile: CHILL

Plan: Pro

Run ID: 22415b02-2490-4c20-a518-0cc7f384dfe6

📥 Commits

Reviewing files that changed from the base of the PR and between 1528702 and 405bd53.

📒 Files selected for processing (2)
  • content/Accessing-cluster-on-same-LAN.md
  • content/SUMMARY.md
✅ Files skipped from review due to trivial changes (2)
  • content/SUMMARY.md
  • content/Accessing-cluster-on-same-LAN.md

Walkthrough

This PR adds a new guide describing how to access a CodeReady Containers OpenShift cluster from another machine on the same LAN and updates the documentation table of contents to include the guide.

Changes

LAN Access Documentation

Layer / File(s) Summary
LAN cluster access guide and TOC update
content/Accessing-cluster-on-same-LAN.md, content/SUMMARY.md
New guide provides step-by-step instructions for opening firewall ports, creating a socat systemd service to forward API port 6443 to the host LAN IP, adding client /etc/hosts entries for CRC DNS names, and verifying connectivity. TOC entry added.

Estimated code review effort

🎯 1 (Trivial) | ⏱️ ~3 minutes

Poem

🐰 A guide for the LAN-connected crew,
Socat bridges the cluster to you,
Firewall doors ajar and bright,
Hosts file set to point it right,
Now oc greets nodes in sight.

🚥 Pre-merge checks | ✅ 5
✅ Passed checks (5 passed)
Check name Status Explanation
Description Check ✅ Passed Check skipped - CodeRabbit’s high-level summary is enabled.
Title check ✅ Passed The title 'Add section to access CRC on same LAN' directly describes the main change: adding a new documentation section explaining how to access CodeReady Containers on the same local network.
Docstring Coverage ✅ Passed No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check.
Linked Issues check ✅ Passed Check skipped because no linked issues were found for this pull request.
Out of Scope Changes check ✅ Passed Check skipped because no linked issues were found for this pull request.

✏️ 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: 2

🤖 Prompt for all review comments with AI agents
Verify each finding against current code. Fix only still-valid issues, skip the
rest with a brief reason, keep changes minimal, and validate.

Inline comments:
In `@content/Accessing-cluster-on-same-LAN.md`:
- Around line 20-40: The guide currently instructs users to create and enable
the systemd service /etc/systemd/system/crc-api-forward.service containing the
placeholder YOUR_LAN_IP before telling them to replace that placeholder, which
results in a broken service; move the line "Replace `YOUR_LAN_IP` with the CRC
host's LAN IP (e.g. `192.168.1.6`)" so it appears before the cat <<'EOF' ... tee
/etc/systemd/system/crc-api-forward.service block (or explicitly tell users to
edit the ExecStart line in crc-api-forward.service to set YOUR_LAN_IP) so the
generated service file contains the actual LAN IP, then proceed with sudo
systemctl daemon-reload and sudo systemctl enable --now crc-api-forward.
- Line 52: Replace the literal PASSWORD placeholder in the oc login example with
a clearer placeholder like <password> in the command shown by the `oc login`
line and add a brief note telling users where to get that value (the kubeadmin
password displayed during `crc start` or retrievable via `crc console
--credentials`); update the `oc login https://api.crc.testing:6443 -u kubeadmin
-p PASSWORD` example to use `-p <password>` and append the single-line
clarification about sourcing the kubeadmin password.
🪄 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: d5545aad-7e97-414b-96b0-3a5280ca625b

📥 Commits

Reviewing files that changed from the base of the PR and between 7e55a2f and 1528702.

📒 Files selected for processing (2)
  • content/Accessing-cluster-on-same-LAN.md
  • content/SUMMARY.md

Comment thread content/Accessing-cluster-on-same-LAN.md Outdated
Comment thread content/Accessing-cluster-on-same-LAN.md Outdated
@anjannath anjannath merged commit a993ab5 into crc-org:main Jun 8, 2026
2 checks passed
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