Skip to content

Commit c22cbb9

Browse files
Merge pull request #21725 from rhatdan/docs6
[CI:DOCS] Fix up example description of podman-farm commands
2 parents 80b1e95 + 537490c commit c22cbb9

5 files changed

Lines changed: 38 additions & 3 deletions

File tree

docs/source/markdown/podman-farm-build.1.md.in

Lines changed: 11 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -239,14 +239,24 @@ Build only on farm nodes that match the given platforms.
239239

240240
## EXAMPLES
241241

242+
Build named image and manifest list using specified Containerfile with default farm:
242243
```
243244
$ podman farm build --local -t name -f /path/to/containerfile .
245+
```
244246

247+
Build named image and manifest list using the specified farm:
248+
```
245249
$ podman farm build --farm myfarm -t name .
250+
```
246251

252+
Build named image and manifest list using the specified farm, removing all images from farm nodes, after they are pushed to registry:
253+
```
247254
$ podman farm build --farm myfarm --cleanup -t name .
255+
```
248256

249-
$ podman farm build --platforms arm64,amd64 --cleanup -t name .
257+
Build named images and manifest list for specified platforms using default farm:
258+
```
259+
$ podman farm build --platforms arm64,amd64 -t name .
250260
```
251261

252262
## SEE ALSO

docs/source/markdown/podman-farm-create.1.md

Lines changed: 9 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -15,11 +15,18 @@ connections from a farm via the *podman farm update* command.
1515

1616
## EXAMPLE
1717

18+
19+
20+
Create the specified farm:
21+
```
22+
$ podman farm create farm2
1823
```
19-
$ podman farm create farm1 f37 f38
2024

21-
$ podman farm farm2
25+
Create multiple farms:
2226
```
27+
$ podman farm create farm1 f37 f38
28+
```
29+
2330
## SEE ALSO
2431
**[podman(1)](podman.1.md)**, **[podman-farm(1)](podman-farm.1.md)**, **[podman-system-connection(1)](podman-system-connection.1.md)**, **[podman-system-connection-add(1)](podman-system-connection-add.1.md)**
2532

docs/source/markdown/podman-farm-list.1.md

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -26,12 +26,15 @@ Valid placeholders for the Go template listed below:
2626
| .ReadWrite | Indicates if this farm can be modified using the podman farm commands |
2727

2828
## EXAMPLE
29+
30+
List all farms:
2931
```
3032
$ podman farm list
3133
Name Connections Default ReadWrite
3234
farm1 [f38 f37] false true
3335
farm2 [f37] true true
3436
```
37+
3538
## SEE ALSO
3639
**[podman(1)](podman.1.md)**, **[podman-farm(1)](podman-farm.1.md)**
3740

docs/source/markdown/podman-farm-remove.1.md

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -18,11 +18,17 @@ Delete one or more farms.
1818
Remove all farms.
1919

2020
## EXAMPLE
21+
22+
Remove specified farm:
2123
```
2224
$ podman farm remove farm1
25+
```
2326

27+
Remove all farms:
28+
```
2429
$ podman farm rm --all
2530
```
31+
2632
## SEE ALSO
2733
**[podman(1)](podman.1.md)**, **[podman-farm(1)](podman-farm.1.md)**
2834

docs/source/markdown/podman-farm-update.1.md

Lines changed: 9 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -25,13 +25,22 @@ Set the current farm as the default.
2525
Remove one or more connections from an existing farm.
2626

2727
## EXAMPLE
28+
29+
Add two connections to specified farm:
2830
```
2931
$ podman farm update --add f35,f38 farm1
32+
```
3033

34+
Add connection to specified farm:
35+
```
3136
$ podman farm update --remove f35 farm1
37+
```
3238

39+
Change specified farm to be default:
40+
```
3341
$ podman farm update --default farm2
3442
```
43+
3544
## SEE ALSO
3645
**[podman(1)](podman.1.md)**, **[podman-farm(1)](podman-farm.1.md)**
3746

0 commit comments

Comments
 (0)