Skip to content

Commit 89002c6

Browse files
committed
docx: complete administration.md
Signed-off-by: Kevin Bimonte <kbimonte@gmail.com>
1 parent c62a228 commit 89002c6

File tree

1 file changed

+71
-1
lines changed

1 file changed

+71
-1
lines changed

docs/docs/operation/administration.md

Lines changed: 71 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -4,12 +4,82 @@ title: Administration
44

55
## `fly workers`
66

7+
To list the currently registered workers, including additional metadata, run:
8+
9+
```shell
10+
fly -t example workers
11+
```
12+
13+
This can be useful for monitoring the status of your workers, if you suspect that one keeps dropping out of the pool or
14+
getting tasked with too many containers, etc.
15+
716
## `fly prune-worker`
817

18+
To remove a stalled, landing, landed, or retiring worker, run:
19+
20+
```shell
21+
fly -t example prune-worker --worker worker-name
22+
```
23+
24+
To prune _all_ stalled workers, run:
25+
26+
```shell
27+
fly -t example prune-worker --all-stalled
28+
```
29+
30+
This is for those cases where you know a worker is not coming back.
31+
32+
!!! note
33+
34+
Running workers cannot be pruned, since they'll just re-register themselves anyway.
35+
936
## `fly land-worker`
1037

38+
To initiate landing of a worker and eventually (after draining) cause it to exit, run:
39+
40+
```shell
41+
fly -t example land-worker --worker worker-name
42+
```
43+
1144
## `fly containers`
1245

46+
To list the active containers across all your workers, run:
47+
48+
```shell
49+
fly -t example containers
50+
```
51+
52+
This can be useful when discovering the containers available for [`fly intercept`](../builds.md#fly-intercept)ing.
53+
1354
## `fly volumes`
1455

15-
## `fly curl`
56+
To list the active volumes across all your workers, run:
57+
58+
```shell
59+
fly -t example volumes
60+
```
61+
62+
This can be useful to observe the caches warming across your cluster, and could be a good indicator of disk use.
63+
64+
## `fly curl`
65+
66+
To execute an arbitrary API request, you can run something like the following:
67+
68+
```shell
69+
fly -t example curl /api/v1/info
70+
```
71+
72+
This command is just a shim that runs `curl` under the hood. To pass flags to `curl`, pass a `--` argument after the
73+
path so that `fly` can distinguish them from its own flags:
74+
75+
```shell
76+
fly -t example curl /api/v1/builds -- \
77+
-X PUT \
78+
-H "Content-type: application/json" \
79+
-d @plan.json
80+
```
81+
82+
!!! note
83+
84+
If you use this command the assumption is that you know what you're doing. If you find yourself using this command
85+
often, let us know - perhaps there's a missing command!

0 commit comments

Comments
 (0)