Skip to content

Repository navigation

docs: update deploy docs for EGG_HOST_REPO_MAP auto-discovery [doc-updater] #1992

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
jwbron merged 2 commits into from
Apr 24, 2026
Merged

docs: update deploy docs for EGG_HOST_REPO_MAP auto-discovery [doc-updater] #1992

Show file tree
Hide file tree
Changes from 1 commit
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
200847f
docs: update deploy docs for EGG_HOST_REPO_MAP auto-discovery
jwbron Apr 24, 2026
daecfbd
docs: move make deploy details from table cell to subsection
egg-reviewer[bot] Apr 24, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion docs/guides/deployment.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -118,7 +118,7 @@ make build
| Command | Description |
|---------|-------------|
| `make k3s-setup` | Install k3s + Calico CNI (idempotent) |
| `make deploy` | Deploy all k8s resources (`kubectl apply -k k8s/overlays/local/`) |
| `make deploy` | Deploy all k8s resources; runs `envsubst` to expand `EGG_HOST_HOME` (default: `$HOME`) and `EGG_HOST_REPO_MAP` (auto-derived from `~/.config/egg/repositories.yaml` via `scripts/build-host-repo-map.py`) into the Kustomize output before applying. Requires `envsubst` from GNU gettext (`dnf install gettext` / `brew install gettext`). Override at deploy time: `make deploy EGG_HOST_HOME=/data/egg` or `EGG_HOST_REPO_MAP='{"owner/repo":"/path"}' make deploy`. |
| `make build` | Build images and import into k3s |
| `make k3s-teardown` | Remove k3s installation |

Expand Down
2 changes: 2 additions & 0 deletions docs/guides/local-quickstart.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -63,6 +63,8 @@ local_repos:
- /path/to/your-repo # absolute path on host
```

`make deploy` reads `local_repos.paths` and queries each repo's `origin` remote URL to auto-derive `EGG_HOST_REPO_MAP` (the JSON map the orchestrator uses for hostPath mounts). No manual editing of Kubernetes overlays is required. `envsubst` (from GNU gettext: `dnf install gettext` / `brew install gettext`) must be installed for `make deploy` to work.

Setting `auth_mode: user` tells the gateway to use `GITHUB_USER_TOKEN` for git/gh operations, attributing commits and PRs to your personal GitHub account.

## 3. Build and deploy
Expand Down
Loading