@@ -12,10 +12,10 @@ ots-containers <topic> <command> [identifiers] [flags]
1212
1313Three container types, each with explicit naming:
1414
15- | Type | Systemd Unit | Identifier | Use |
16- | ------| --------------| ------------| -----|
17- | ` web ` | ` onetime-web@{port} ` | Port number | HTTP servers |
18- | ` worker ` | ` onetime-worker@{id} ` | Name or number | Background jobs |
15+ | Type | Systemd Unit | Identifier | Use |
16+ | ----------- | ------------------------ | -------------- | --------------- |
17+ | ` web ` | ` onetime-web@{port} ` | Port number | HTTP servers |
18+ | ` worker ` | ` onetime-worker@{id} ` | Name or number | Background jobs |
1919| ` scheduler ` | ` onetime-scheduler@{id} ` | Name or number | Scheduled tasks |
2020
2121## Command Syntax
@@ -39,14 +39,14 @@ ots instances logs --scheduler -f # only scheduler logs
3939
4040Each topic is a separate module with its own ` cyclopts.App ` :
4141
42- | Topic | Purpose |
43- | -------| ---------|
44- | ` instance ` | Container lifecycle and runtime control |
45- | ` service ` | Native systemd services (Valkey, Redis) |
46- | ` image ` | Container image management |
47- | ` assets ` | Static asset management |
48- | ` cloudinit ` | Cloud-init configuration generation |
49- | ` env ` | Environment file management |
42+ | Topic | Purpose |
43+ | ----------- | --------------------------------------- |
44+ | ` instance ` | Container lifecycle and runtime control |
45+ | ` service ` | Native systemd services (Valkey, Redis) |
46+ | ` image ` | Container image management |
47+ | ` assets ` | Static asset management |
48+ | ` cloudinit ` | Cloud-init configuration generation |
49+ | ` env ` | Environment file management |
5050
5151To add a new topic, create a module and register it in ` cli.py ` .
5252
@@ -55,24 +55,28 @@ To add a new topic, create a module and register it in `cli.py`.
5555Commands are categorized by their impact:
5656
5757### High-level (affects config + state)
58+
5859Commands that modify quadlet templates, database records, or both:
60+
5961- ` deploy ` , ` redeploy ` , ` undeploy `
6062
6163These commands should document their config impact in the docstring.
6264
6365### Low-level (runtime control only)
66+
6467Commands that only interact with systemd, no config changes:
68+
6569- ` start ` , ` stop ` , ` restart ` , ` status ` , ` logs ` , ` enable ` , ` disable ` , ` exec `
6670
6771These commands should explicitly state they do NOT refresh config.
6872
6973## Naming Conventions
7074
71- | Pattern | Example | Use for |
72- | ---------| ---------| ---------|
73- | Verb | ` deploy ` , ` sync ` | Actions |
74- | ` --flag ` | ` --force ` , ` --yes ` | Boolean options |
75- | ` --option VALUE ` | ` --delay 5 ` , ` --lines 50 ` | Value options |
75+ | Pattern | Example | Use for |
76+ | ------------------ | ---------------------------------- | ----------------------- |
77+ | Verb | ` deploy ` , ` sync ` | Actions |
78+ | ` --flag ` | ` --force ` , ` --yes ` | Boolean options |
79+ | ` --option VALUE ` | ` --delay 5 ` , ` --lines 50 ` | Value options |
7680| ` --type ` shortcuts | ` --web ` , ` --worker ` , ` --scheduler ` | Instance type selection |
7781
7882## Default Commands
0 commit comments