You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: docs/configuration/directors/management.mdx
-105Lines changed: 0 additions & 105 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -308,111 +308,6 @@ Directors with connected devices or agents cannot be deleted. The error modal li
308
308
3. Reassign agents to different Director or delete
309
309
4. Retry Director deletion after dependencies removed
310
310
311
-
## Auto Update
312
-
313
-
Auto Update enables Directors to automatically update themselves when new versions become available. The feature supports immediate and scheduled update methods with built-in rollback capability and cryptographic signature verification.
314
-
315
-
### Configuration
316
-
317
-
Auto Update is configured through the `update` section in the Director configuration:
318
-
319
-
| Property | Type | Required | Description |
320
-
|---------:|:-----|:--------:|:------------|
321
-
| mode | string | Y | Set to `auto` to enable automatic updates |
322
-
| method | string | Y | Update trigger method: `immediate` or `schedule`|
323
-
| version | string | Y | Target version to update to |
324
-
| cron | string | N | Cron expression for scheduled updates (schedule method only, minimum 30 seconds) |
325
-
| interval | duration | N | Fallback polling interval if no cron specified (default: 30s minimum) |
326
-
327
-
**Example Configuration:**
328
-
329
-
```yaml
330
-
update:
331
-
mode: auto
332
-
method: schedule
333
-
version: "2.5.0"
334
-
cron: "0 2 * * 0"# Every Sunday at 2:00 AM
335
-
```
336
-
337
-
### Update Methods
338
-
339
-
**Immediate Method:**
340
-
341
-
Triggers the update as soon as possible after configuration is applied. A 10-minute cooldown prevents rapid retry attempts if the update fails.
342
-
343
-
```yaml
344
-
update:
345
-
mode: auto
346
-
method: immediate
347
-
version: "2.5.0"
348
-
```
349
-
350
-
**Schedule Method:**
351
-
352
-
Updates occur according to a cron schedule or interval-based polling:
353
-
354
-
- **Cron Expression**: Use standard cron syntax for precise scheduling (e.g., `0 2 * * 0` for Sunday at 2:00 AM)
355
-
- **Interval Fallback**: If no cron is specified, updates check on the configured interval
356
-
357
-
```yaml
358
-
update:
359
-
mode: auto
360
-
method: schedule
361
-
version: "2.5.0"
362
-
interval: 1h # Check hourly
363
-
```
364
-
365
-
### Update Process
366
-
367
-
When an update triggers, the Director performs these steps:
368
-
369
-
1. **Version Check** - Compares current version against configured target version
370
-
2. **Service Stop** - Gracefully stops the running Director service
371
-
3. **Backup** - Creates timestamped backup of current binary and configuration
372
-
4. **Download** - Retrieves new binary from Fleet management instance
373
-
5. **Signature Verification** - Verifies Ed25519 signature of downloaded binary
374
-
6. **Deployment** - Replaces current binary with new version
8. **Service Start** - Restarts the Director service
377
-
378
-
If any step fails, the rollback system automatically restores the previous binary and configuration.
379
-
380
-
### Health Reporting
381
-
382
-
During an update, the Director reports additional health information:
383
-
384
-
| Field | Description |
385
-
|------:|:------------|
386
-
| version | Currently running Director version |
387
-
| scheduled_version | Target version pending update |
388
-
| architecture | System architecture (amd64, arm64, etc.) |
389
-
| os | Operating system (windows, linux, darwin) |
390
-
391
-
The scheduled version field appears in health reports after an update is triggered but before it completes, allowing monitoring systems to track pending updates.
392
-
393
-
### Update Logs
394
-
395
-
Update progress is logged to the Director activity stream. Log entries include:
396
-
397
-
- Update triggered timestamp
398
-
- Download progress and completion
399
-
- Signature verification result
400
-
- Deployment success or failure
401
-
- Rollback actions (if update fails)
402
-
403
-
### Security
404
-
405
-
Auto Update includes multiple security measures:
406
-
407
-
- **Ed25519 Signature Verification**: All downloaded binaries are verified against cryptographic signatures before deployment
408
-
- **Secure Download**: Binaries are downloaded over HTTPS from the Fleet management instance
409
-
- **Rollback Protection**: Failed updates automatically restore the previous working version
Auto Update requires network connectivity to the Fleet management instance. Ensure firewall rules allow outbound HTTPS connections to the configured Fleet instance URL.
414
-
:::
415
-
416
311
## Agent Pre-Processing
417
312
418
313
Directors can configure Agents to perform pipeline-based pre-processing of logs before transmission. This distributed processing model reduces Director workload, decreases network bandwidth consumption, and enables edge-based data transformation such as compliance masking.
0 commit comments