Skip to content

Commit 9cf7f54

Browse files
committed
doc: Small enhancements
1 parent 7cbaeb3 commit 9cf7f54

3 files changed

Lines changed: 13 additions & 12 deletions

File tree

‎docs/architecture.md‎

Lines changed: 9 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -49,20 +49,21 @@ sequenceDiagram
4949
participant GRUB
5050
participant Kernel
5151
participant Initramfs
52-
participant systemd
52+
participant System
5353
participant cuosInit as cuos-init
5454
participant cuosApi as cuos-api
55+
participant DockerD as dockerd
5556
participant cuosApp as cuos-app
5657
57-
FW->>GRUB: Transfer control
58-
GRUB->>Kernel: Load kernel + initramfs (slot @os active)
58+
FW->>GRUB: Boot Host
59+
GRUB->>Kernel: Load kernel + initramfs (active slot)
5960
Kernel->>Initramfs: Basic hardware init
60-
Initramfs->>systemd: Start PID 1
61+
Initramfs->>System: Start Systemd/PID 1 (active @os slot)
6162
systemd->>cuosInit: Apply config (hostname, network, CA, docker)
62-
cuosInit->>cuosApi: Activate API layer (socket)
63-
cuosApi->>cuosApp: Trigger application init
64-
cuosApp->>cuosApi: Optional /api/update hook finished
65-
cuosApi->>systemd: State = running
63+
systemd->>cuosApi: Activate CuoS API (socket)
64+
systemd->>DockerD: Start dockerd
65+
systemd->>cuosApp: Trigger application init
66+
cuosApp->>cuosApp: State = running
6667
```
6768

6869
---

‎docs/common/cuos-api.md‎

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -135,8 +135,8 @@ cuos_api() {
135135

136136
local return_code="$?"
137137
if [[ "${return_code}" != "0" ]]; then
138-
echo "socat exited with return code ${return_code}."
139-
return 1
138+
echo "socat exited with return code ${return_code}." >&2
139+
return "${return_code}"
140140
fi
141141

142142
exec 3>&-
@@ -222,4 +222,4 @@ await cuosApi('patch-network', {
222222
4. **Network Configuration**
223223
- Validate network settings
224224
- Handle network failures
225-
- Keep configurations consistent
225+
- Keep configurations consistent

‎docs/development-guide.md‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -21,7 +21,7 @@ CuOS consistens of multiple services and containers.
2121
|---|---|
2222
| `cuos-init` | Initialize the system. Setup hostname, network, file system, |
2323
| `cuos-api` | API for interaction with the system |
24-
| `cuos-app` | Ensure to start App Init Container container |
24+
| `cuos-app-init` | Ensure to start App Init Container container |
2525
| `cuos-updater` | Helper container to replace/rollback the system, kernel, initrd and boot config. Started by `cuos-api` or your application. |
2626

2727
## Development Variants

0 commit comments

Comments
 (0)