Skip to content

docs: update README and Metal Agent guide for remote K8s architecture#156

Merged
Defilan merged 1 commit intomainfrom
docs/remote-k8s-metal-agent
Feb 20, 2026
Merged

docs: update README and Metal Agent guide for remote K8s architecture#156
Defilan merged 1 commit intomainfrom
docs/remote-k8s-metal-agent

Conversation

@Defilan
Copy link
Member

@Defilan Defilan commented Feb 20, 2026

Summary

  • Update Apple Silicon section in README with two paths: Option A (remote cluster, recommended) and Option B (local minikube)
  • Add remote architecture diagram showing Linux server + Mac inference node split
  • Update FAQ to mention --host-ip and no local K8s requirement
  • Add --host-ip configuration docs and remote cluster troubleshooting to Metal Agent guide
  • Add remote architecture diagram to Metal Agent guide

Test plan

  • README renders correctly on GitHub (ASCII diagrams, code blocks)
  • All internal links still work

Lead with remote cluster setup as recommended path for Apple Silicon.
Add --host-ip flag documentation, remote architecture diagrams, and
troubleshooting for remote cluster connectivity.

Signed-off-by: Christopher Maher <chris@mahercode.io>
@Defilan Defilan force-pushed the docs/remote-k8s-metal-agent branch from 2d7d502 to da9c166 Compare February 20, 2026 10:02
@Defilan Defilan merged commit 79145b2 into main Feb 20, 2026
4 checks passed
@Defilan Defilan deleted the docs/remote-k8s-metal-agent branch February 20, 2026 19:09
@github-actions github-actions bot mentioned this pull request Feb 20, 2026
@github-actions github-actions bot mentioned this pull request Mar 4, 2026
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.

1 participant