Document how to connect a remote BMC in the Tilt dev environment

[xkonni]

Proposed Changes

• adds documentation to connect a remote bmc to the local development cluster

Fixes

• no issue for this, it's a general enhancement of the docs

Summary by CodeRabbit

• Documentation
  • Added a "Connecting a Remote BMC in the Tilt environment" walkthrough with step‑by‑step instructions to swap the default Redfish mock server for real hardware, prepare and apply base64‑encoded BMC credentials to a local Kind cluster, and verify BMC/Server resources.
  • Added guidance for HTTPS BMCs (set manager connection to use HTTPS) and an optional debug build including curl and CA certificates.
  • Minor formatting and whitespace fixes.

[coderabbitai]

Walkthrough

Added "Connecting a Remote BMC in the Tilt Environment" to docs/development/dev_setup.md explaining how to swap the Redfish mock server for a real BMC, create/apply a base64 BMCSecret, set HTTPS flags in Tilt, verify BMC/Server resources, and optionally use a manager-debug build stage.

Changes

Cohort / File(s)

Summary

Development Documentation docs/development/dev_setup.md

Added "Connecting a Remote BMC in the Tilt Environment" section: replace config/redfish-mockup/redfish_mockup_endpoint.yaml with a real BMC resource, create and apply a base64-encoded BMCSecret to the Kind cluster, set --insecure=false in the Tiltfile for HTTPS BMCs, verify BMC/Server resources and controller-manager logs, provide teardown (make kind-delete), and document an optional manager-debug Docker build stage with curl and ca-certificates.

Estimated code review effort

🎯 1 (Trivial) | ⏱️ ~3 minutes

🚥 Pre-merge checks | ✅ 3

✅ Passed checks (3 passed)

Check name	Status	Explanation
Title check	✅ Passed	The title accurately and concisely describes the main change: adding documentation for connecting a remote BMC in the Tilt development environment.
Description check	✅ Passed	The description addresses the main change but is minimal. It lists one proposed change and notes no linked issue, covering the basic template structure.
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
• Commit unit tests in branch doc/dev_remote_bmc

---

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

🤖 Prompt for all review comments with AI agents

Verify each finding against the current code and only fix it if needed.

Inline comments:
In `@docs/development/dev_setup.md`:
- Around line 116-129: The title and explanation are backwards: the Tiltfile
manager arg `--insecure=false` actually enables TLS/HTTPS (insecure=true
disables TLS and uses HTTP). Update the section title and explanatory sentence
to state that `--insecure=false` enables TLS/HTTPS (or conversely that
`--insecure=true` disables TLS), and clarify that when connecting to a real BMC
on port 443 you should use `--insecure=false`; keep the `new_args -> metal`
entry with the `--insecure` flag as shown.
- Around line 83-100: The example BMC resource should explicitly include the
optional scheme field to indicate HTTPS when using port 443: update the BMC
example (kind: BMC) to add scheme: https alongside protocol.name: Redfish and
port: 443 so the InlineEndpoint/scheme is clear; reference the scheme field in
the same block where port: 443 is declared to make the intent explicit (e.g.,
under the protocol/endpoint section that currently contains protocol.name and
port).

🪄 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: 16f30b11-66d0-45a3-9277-927f1f96dd5d

📥 Commits

Reviewing files that changed from the base of the PR and between 52d7860 and 8d92bde.

📒 Files selected for processing (1)

• docs/development/dev_setup.md

[coderabbitai]

🧹 Nitpick comments (1)

docs/development/dev_setup.md (1)

145-157: Consolidate duplicated BMCSecret manifest example.

The same manifest is documented twice. Keep one canonical block and reference it later to reduce drift and keep this guide tighter.

Also applies to: 182-194

🤖 Prompt for AI Agents

Verify each finding against the current code and only fix it if needed.

In `@docs/development/dev_setup.md` around lines 145 - 157, There are two
identical examples of the BMCSecret manifest (the YAML showing apiVersion:
metal.ironcore.dev/v1alpha1, kind: BMCSecret, metadata: name, data:
username/password) duplicated in the doc; remove the second duplicate and keep a
single canonical BMCSecret YAML block (the one with apiVersion/ kind/ metadata/
data fields) and replace the removed copy with a short cross-reference comment
or link to the canonical section so later steps refer to that single manifest
example.

🤖 Prompt for all review comments with AI agents

Verify each finding against the current code and only fix it if needed.

Nitpick comments:
In `@docs/development/dev_setup.md`:
- Around line 145-157: There are two identical examples of the BMCSecret
manifest (the YAML showing apiVersion: metal.ironcore.dev/v1alpha1, kind:
BMCSecret, metadata: name, data: username/password) duplicated in the doc;
remove the second duplicate and keep a single canonical BMCSecret YAML block
(the one with apiVersion/ kind/ metadata/ data fields) and replace the removed
copy with a short cross-reference comment or link to the canonical section so
later steps refer to that single manifest example.

---

ℹ️ Review info

⚙️ Run configuration

Configuration used: Organization UI

Review profile: CHILL

Plan: Pro

Run ID: f51e4165-bb62-43f5-9f3f-ec5f337e5976

📥 Commits

Reviewing files that changed from the base of the PR and between f428390 and 95bb6c8.

📒 Files selected for processing (1)

• docs/development/dev_setup.md