v3.3.0 b164fe9

deploy.md RawHistoryFolder

AI Agent Deployment Guide

Use Gordon's declarative app workflow. Do not edit daemon state or infer workload identity from domains.

Required files

~/.config/gordon/gordon.toml  # Daemon configuration
app.toml                      # Declarative app manifest

Workflow

  1. Define services, routes, networks, volumes, secrets, readiness, and backups in app.toml.

  2. Validate and persist the manifest:

    gordon apps apply --file app.toml
    
  3. Register required secret values without placing them in the manifest:

    gordon apps secrets set APP --service SERVICE KEY
    
  4. Deploy the accepted revision:

    gordon apps deploy APP
    
  5. Verify state and workload logs:

    gordon apps show APP
    gordon apps logs APP --service SERVICE
    

The local CLI uses the authenticated owner-only Unix socket. To target another Gordon instance, use the configured authenticated HTTP/TLS remote transport.

Registry authentication

Generate a scoped token on the server, then pass it to the registry client through standard input. Never place tokens in manifests, command history, fixtures, or logs.

Safety rules

  • Use app and service names as workload identity; domains are routing addresses only.
  • Keep secret values outside manifests and app state.
  • Reuse the same idempotency key only to inspect or retry the same mutation request.
  • Do not delete retained volumes or secrets during app removal.
source
1# AI Agent Deployment Guide
2
3Use Gordon's declarative app workflow. Do not edit daemon state or infer workload identity from domains.
4
5## Required files
6
7```text
8~/.config/gordon/gordon.toml  # Daemon configuration
9app.toml                      # Declarative app manifest
10```
11
12## Workflow
13
141. Define services, routes, networks, volumes, secrets, readiness, and backups in `app.toml`.
152. Validate and persist the manifest:
16
17   ```bash
18   gordon apps apply --file app.toml
19   ```
20
213. Register required secret values without placing them in the manifest:
22
23   ```bash
24   gordon apps secrets set APP --service SERVICE KEY
25   ```
26
274. Deploy the accepted revision:
28
29   ```bash
30   gordon apps deploy APP
31   ```
32
335. Verify state and workload logs:
34
35   ```bash
36   gordon apps show APP
37   gordon apps logs APP --service SERVICE
38   ```
39
40The local CLI uses the authenticated owner-only Unix socket. To target another Gordon instance, use the configured authenticated HTTP/TLS remote transport.
41
42## Registry authentication
43
44Generate a scoped token on the server, then pass it to the registry client through standard input. Never place tokens in manifests, command history, fixtures, or logs.
45
46## Safety rules
47
48- Use app and service names as workload identity; domains are routing addresses only.
49- Keep secret values outside manifests and app state.
50- Reuse the same idempotency key only to inspect or retry the same mutation request.
51- Do not delete retained volumes or secrets during app removal.

Keyboard shortcuts

Single-key shortcuts are on. ctrl k and esc work whatever this says.

ctrl k :
go to a section, branch, tag, file or repository
?
this list
j k
move the row cursor down / up
enter
open the row under the cursor; on Files, a directory opens or closes in place
↑ ↓ ← → home end
in the file tree (focus on a row): previous / next row, close / open a directory or go to its parent / first entry, first / last row. They never open a file
l h
on Files: open a directory or a file / close a directory or go up to its parent, then to the parent page. Elsewhere: into the side panel (on a merge request, its files) / back to the content; there j k move between its controls
g g G
first / last row
/
filter the list; on Files, find a file anywhere in the repository (esc clears, enter opens the best match)
b
switch branch or tag
g s g f g c g b g m g i g r g a
tabs: summary, files, commits, branches & tags, merge requests, issues, releases, actions (when available)
g h
home
w
wide mode: use the whole width of the screen, or not (remembered)
y
copy a permalink pinned to the commit
d u x
diff: split / unified / collapse or expand all
e E
diff: the whole file in view / every file, with the lines the hunks hide
n
merge request: next note in the diff
esc
close a dialog, leave a field

Branches 7

Tags 106

↑↓ moveenter openesc close