From 537490cb9c20ee5eb1d6729fae6f73e22f8520af Mon Sep 17 00:00:00 2001 From: Daniel J Walsh Date: Sat, 17 Feb 2024 13:36:23 -0500 Subject: [PATCH] Fix up example description of podman-farm commands Signed-off-by: Daniel J Walsh --- docs/source/markdown/podman-farm-build.1.md.in | 12 +++++++++++- docs/source/markdown/podman-farm-create.1.md | 11 +++++++++-- docs/source/markdown/podman-farm-list.1.md | 3 +++ docs/source/markdown/podman-farm-remove.1.md | 6 ++++++ docs/source/markdown/podman-farm-update.1.md | 9 +++++++++ 5 files changed, 38 insertions(+), 3 deletions(-) diff --git a/docs/source/markdown/podman-farm-build.1.md.in b/docs/source/markdown/podman-farm-build.1.md.in index b8b4ef3323..d8cab4ecd2 100644 --- a/docs/source/markdown/podman-farm-build.1.md.in +++ b/docs/source/markdown/podman-farm-build.1.md.in @@ -239,14 +239,24 @@ Build only on farm nodes that match the given platforms. ## EXAMPLES +Build named image and manifest list using specified Containerfile with default farm: ``` $ podman farm build --local -t name -f /path/to/containerfile . +``` +Build named image and manifest list using the specified farm: +``` $ podman farm build --farm myfarm -t name . +``` +Build named image and manifest list using the specified farm, removing all images from farm nodes, after they are pushed to registry: +``` $ podman farm build --farm myfarm --cleanup -t name . +``` -$ podman farm build --platforms arm64,amd64 --cleanup -t name . +Build named images and manifest list for specified platforms using default farm: +``` +$ podman farm build --platforms arm64,amd64 -t name . ``` ## SEE ALSO diff --git a/docs/source/markdown/podman-farm-create.1.md b/docs/source/markdown/podman-farm-create.1.md index 4ba31c18df..4ab7111ddf 100644 --- a/docs/source/markdown/podman-farm-create.1.md +++ b/docs/source/markdown/podman-farm-create.1.md @@ -15,11 +15,18 @@ connections from a farm via the *podman farm update* command. ## EXAMPLE + + +Create the specified farm: +``` +$ podman farm create farm2 +``` + +Create multiple farms: ``` $ podman farm create farm1 f37 f38 - -$ podman farm farm2 ``` + ## SEE ALSO **[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)** diff --git a/docs/source/markdown/podman-farm-list.1.md b/docs/source/markdown/podman-farm-list.1.md index 06a26dbcc4..535bc0caa1 100644 --- a/docs/source/markdown/podman-farm-list.1.md +++ b/docs/source/markdown/podman-farm-list.1.md @@ -26,12 +26,15 @@ Valid placeholders for the Go template listed below: | .ReadWrite | Indicates if this farm can be modified using the podman farm commands | ## EXAMPLE + +List all farms: ``` $ podman farm list Name Connections Default ReadWrite farm1 [f38 f37] false true farm2 [f37] true true ``` + ## SEE ALSO **[podman(1)](podman.1.md)**, **[podman-farm(1)](podman-farm.1.md)** diff --git a/docs/source/markdown/podman-farm-remove.1.md b/docs/source/markdown/podman-farm-remove.1.md index 726787d288..2d2097ca14 100644 --- a/docs/source/markdown/podman-farm-remove.1.md +++ b/docs/source/markdown/podman-farm-remove.1.md @@ -18,11 +18,17 @@ Delete one or more farms. Remove all farms. ## EXAMPLE + +Remove specified farm: ``` $ podman farm remove farm1 +``` +Remove all farms: +``` $ podman farm rm --all ``` + ## SEE ALSO **[podman(1)](podman.1.md)**, **[podman-farm(1)](podman-farm.1.md)** diff --git a/docs/source/markdown/podman-farm-update.1.md b/docs/source/markdown/podman-farm-update.1.md index 32fe19519a..d7f05bf8c0 100644 --- a/docs/source/markdown/podman-farm-update.1.md +++ b/docs/source/markdown/podman-farm-update.1.md @@ -25,13 +25,22 @@ Set the current farm as the default. Remove one or more connections from an existing farm. ## EXAMPLE + +Add two connections to specified farm: ``` $ podman farm update --add f35,f38 farm1 +``` +Add connection to specified farm: +``` $ podman farm update --remove f35 farm1 +``` +Change specified farm to be default: +``` $ podman farm update --default farm2 ``` + ## SEE ALSO **[podman(1)](podman.1.md)**, **[podman-farm(1)](podman-farm.1.md)**