Docs: one way in — quick-install starts at the setup screens, quickstart becomes development, install.md no longer says engines are yours to install
Co-Authored-By: Claude Opus 5.5 (1M context) <noreply@anthropic.com>
This commit is contained in:
1 parent
4979e08d64
commit
6abd510628
5 files changed
+103
-72
No files matched your search
@@ -1,8 +1,9 @@
|
||||
# Quickstart: one machine, one model, ten minutes
|
||||
# Development: llmgw from source on one machine
|
||||
|
||||
Written for a developer who wants to see llmgw answer a request on a single
|
||||
workstation, built from source, with no systemd and no `sudo`. **To install
|
||||
llmgw on servers, read [quick-install.md](quick-install.md) instead.**
|
||||
workstation, built from source, with no systemd and no `sudo` — for working on
|
||||
llmgw itself. **To install llmgw on servers, read
|
||||
[quick-install.md](quick-install.md) instead.**
|
||||
|
||||
What you end up with: an OpenAI-compatible endpoint on `localhost:8080` in front
|
||||
of a real model served by llama.cpp.
|
||||
+20
-20
@@ -13,34 +13,32 @@ this page says otherwise, and where it says otherwise it says so plainly.
|
||||
|
||||
Read this first, because it is the difference between an afternoon and a week.
|
||||
|
||||
llmgw runs engines and routes requests. It does **not** install GPU drivers,
|
||||
CUDA, or the inference engines themselves. A node missing any of them still
|
||||
registers, still reports `ready`, and still fails every replica placed on it —
|
||||
so the useful order is to make a node able to serve *before* onboarding it, not
|
||||
after.
|
||||
llmgw installs itself, its engines and its store. It does **not** install the
|
||||
GPU driver or the InfiniBand stack: those are kernel modules with version
|
||||
matrices attached, and a platform decision. A node missing them still
|
||||
registers and reports `ready`, and fails every replica that needs the GPU or
|
||||
the fabric — so make a node able to serve *before* onboarding it.
|
||||
`llmgw doctor` on the node says what is missing and the command that fixes it.
|
||||
|
||||
| You provide | llmgw provides |
|
||||
| --- | --- |
|
||||
| NVIDIA driver and `nvidia-smi` | GPU discovery, classes, health |
|
||||
| InfiniBand stack (`rdma-core`/OFED) | Fabric discovery and the invariant that a replica never spans one |
|
||||
| vLLM, SGLang or llama.cpp | Launching them, the right flags, supervision |
|
||||
| Model weights, from somewhere | Fetching them, placement, routing, accounting |
|
||||
| Nothing — the nodes install them | llama.cpp, vLLM (and SGLang when asked), with the right build for each node's driver and GPU: [Engines](#engines) |
|
||||
| Which models to run | The mirror that fetches them once, placement, routing, accounting |
|
||||
|
||||
The reason is boring and unavoidable: drivers and engines are platform decisions
|
||||
with kernel modules and version matrices attached.
|
||||
|
||||
Weights are the one item on that list llmgw does handle. It includes a mirror —
|
||||
step 3 — which holds the files on your own network and hands them to the nodes,
|
||||
so getting weights onto every machine is not a problem you solve before
|
||||
starting. What llmgw will not do is choose the models for you.
|
||||
Weights are handled too. llmgw includes a mirror — step 3 — which holds the
|
||||
files on your own network and hands them to the nodes, so getting weights onto
|
||||
every machine is not a problem you solve before starting. What llmgw will not do is choose the models for you.
|
||||
|
||||
## 0. Before you begin
|
||||
|
||||
Four machines is a reasonable first cluster: one control plane and three nodes.
|
||||
One of each also works.
|
||||
|
||||
**The control plane** needs no GPU. It is a single process holding a SQLite
|
||||
file; 2 GB of RAM and a few gigabytes of disk is generous. It must be reachable
|
||||
**The control plane** needs no GPU: one machine, holding its store in SQLite
|
||||
or PostgreSQL, or three for high availability, with the store in PostgreSQL replicated under
|
||||
Patroni. 2 GB of RAM and a few gigabytes of disk each is generous. It must be reachable
|
||||
from every node on the agent port, and from your users on the client port.
|
||||
|
||||
**Nodes** need whatever the model needs, plus about 8 GB for the operating
|
||||
@@ -67,9 +65,11 @@ a certificate: the machine's own addresses are found for you, and any other name
|
||||
One static binary, no runtime dependencies, the same on every machine.
|
||||
|
||||
```
|
||||
VERSION=v0.8.0 # check the releases page for the current tag
|
||||
curl -fsSLO https://gitea.mynodes.xyz/ilker/llmgw/releases/download/$VERSION/llmgw-$VERSION-linux-amd64
|
||||
curl -fsSL https://gitea.mynodes.xyz/ilker/llmgw/releases/download/$VERSION/checksums.txt | sha256sum -c --ignore-missing
|
||||
VERSION=$(curl -fsSL https://gitea.mynodes.xyz/api/v1/repos/ilker/llmgw/releases/latest \
|
||||
| grep -o '"tag_name":"[^"]*"' | cut -d'"' -f4)
|
||||
U=https://gitea.mynodes.xyz/ilker/llmgw/releases/download/$VERSION
|
||||
curl -fsSLO $U/llmgw-$VERSION-linux-amd64
|
||||
curl -fsSL $U/checksums.txt | sha256sum -c --ignore-missing
|
||||
sudo install -m0755 llmgw-$VERSION-linux-amd64 /usr/local/bin/llmgw
|
||||
llmgw --version
|
||||
```
|
||||
@@ -1101,7 +1101,7 @@ llmgw keys memory --project default --off
|
||||
|
||||
Without authentication, `threads.store` and `threads.retain_hours` in
|
||||
`server.yaml` keep both conversations and notes in one shared pool. That is for
|
||||
one trusted machine only; see [quickstart.md](quickstart.md).
|
||||
one trusted machine only; see [development.md](development.md).
|
||||
|
||||
## Two control planes
|
||||
|
||||
|
||||
+33
-18
@@ -8,10 +8,10 @@ explains every choice.
|
||||
|
||||
| | |
|
||||
|---|---|
|
||||
| **One control plane machine** | Linux, x86-64 or ARM64. Debian 12, Ubuntu 22.04+ or RHEL 10. No GPU needed; 2 GB RAM, 20 GB disk. |
|
||||
| **GPU nodes** (optional to start) | The same Linux, with the NVIDIA driver installed. vLLM needs driver 580 or newer and a Turing GPU or newer (not V100). |
|
||||
| **root** | on the control plane, and `sudo` without a password on every node. |
|
||||
| **SSH** | from the control plane to each node, as a user with passwordless `sudo` there. |
|
||||
| **A control plane** | One machine, or three for high availability (the store replicated, either one able to take over). Linux, x86-64 or ARM64: Debian 12, Ubuntu 22.04+ or RHEL 10. No GPU needed; 2 GB RAM, 20 GB disk each. |
|
||||
| **GPU nodes** (optional to start) | The same Linux, with the NVIDIA driver installed. vLLM needs driver 525 or newer and a Turing GPU or newer; a V100 gets an older vLLM. |
|
||||
| **root** | on the control plane. On the other two of a three-machine setup, `sudo` (its password is asked for if it needs one); on nodes, `sudo` without a password. |
|
||||
| **SSH** | from the control plane to the other machines. The setup screens take a key, the ssh agent or a password; `node add` uses ssh keys. A machine nothing may log into joins with a code instead (`llmgw join`). |
|
||||
| **Network** | nodes reach the control plane on 7443 and 8081; users reach it on 8080. The machines need internet access to download engines and models. |
|
||||
|
||||
You do not install llama.cpp, vLLM, Python or CUDA. The nodes do that
|
||||
@@ -35,26 +35,38 @@ install it.
|
||||
## 2. Set up the control plane
|
||||
|
||||
```
|
||||
sudo llmgw server init
|
||||
sudo llmgw
|
||||
```
|
||||
|
||||
It asks for your email and a few choices, then sets up everything on this
|
||||
machine, in a few minutes. In a script, give them as flags instead:
|
||||
`sudo llmgw server init --admin you@example.com`.
|
||||
With nothing installed, `llmgw` opens the setup screens. They ask whether
|
||||
this is **one machine or three** (high availability), and for three, the
|
||||
other two: address, user, and an ssh key, the ssh agent or a password. They
|
||||
check every machine before installing anything — system, disk, clock, ports,
|
||||
internet, whether the machines reach one another — show the plan, and
|
||||
install:
|
||||
|
||||
- the service, its certificates and its configuration;
|
||||
- your administrator account. **The password is printed once. Copy it now.**
|
||||
- the service, its certificates and its configuration, and a firewall for
|
||||
its internal ports;
|
||||
- with three machines, the store replicated across them (PostgreSQL under
|
||||
Patroni);
|
||||
- your administrator account. **The password is shown once. Copy it now.**
|
||||
- a model mirror, which downloads model files once for the whole cluster;
|
||||
- this machine as a first node, and a small model (Qwen2.5 0.5B) on it.
|
||||
|
||||
Run again later, `sudo llmgw` is the console: the cluster's state and
|
||||
everything you can do to it ([console.md](console.md)). Every step below is
|
||||
also there, under **Do**.
|
||||
|
||||
**In a script**, the same for one machine:
|
||||
|
||||
```
|
||||
sudo llmgw server init --admin you@example.com
|
||||
```
|
||||
|
||||
If nodes will reach this machine by a name or address it does not know itself
|
||||
(a DNS name, a NAT address), add `--host` for each:
|
||||
|
||||
```
|
||||
sudo llmgw server init --admin you@example.com --host llm.example.com
|
||||
```
|
||||
|
||||
It is safe to run again. It keeps what exists and finishes what is missing.
|
||||
`--host llm.example.com`. It is safe to run again: it keeps what exists and
|
||||
finishes what is missing.
|
||||
|
||||
**The mirror on its own machine**, when it wants a larger disk than the
|
||||
control plane has: first on that machine, with llmgw installed as in step 1,
|
||||
@@ -75,7 +87,7 @@ the account page.
|
||||
|
||||
## 3. Add the GPU nodes
|
||||
|
||||
On the control plane:
|
||||
In the console, **Do → Add a node**. Or on the control plane:
|
||||
|
||||
```
|
||||
sudo llmgw node add ubuntu@10.0.0.21
|
||||
@@ -197,6 +209,9 @@ through the proxy. There is an nginx configuration too:
|
||||
|
||||
## Next
|
||||
|
||||
- [install.md](install.md): the same steps with every option explained.
|
||||
- [install.md](install.md): the same steps with every option explained, and
|
||||
running the cluster after: monitoring, notifications, single sign-on,
|
||||
backups, upgrades.
|
||||
- [console.md](console.md): everything the console does.
|
||||
- [fabrics.md](fabrics.md): InfiniBand and NVLink.
|
||||
- [onboarding.md](onboarding.md): accounts, projects, budgets and keys.
|
||||
Reference in new issue
Block a user