From dc0d07c71f46edc0b3c5af6f4e246818fb4d43cd Mon Sep 17 00:00:00 2001 From: Paul Holzinger Date: Tue, 6 Feb 2024 15:45:16 +0100 Subject: [PATCH] document new connection/farm storage location The new file was not really documented, so leave some pointers on how it works and that the new file should not be edited manually. Signed-off-by: Paul Holzinger --- docs/source/markdown/podman-farm.1.md | 11 +++++++++++ .../source/markdown/podman-system-connection.1.md | 15 +++++++++++++-- docs/source/markdown/podman.1.md | 2 +- 3 files changed, 25 insertions(+), 3 deletions(-) diff --git a/docs/source/markdown/podman-farm.1.md b/docs/source/markdown/podman-farm.1.md index 60c8cdeb09..8dae288dda 100644 --- a/docs/source/markdown/podman-farm.1.md +++ b/docs/source/markdown/podman-farm.1.md @@ -13,6 +13,17 @@ Manage farms by creating, updating, and removing them. Note: All farm machines must have a minimum podman version of v4.9.0. +Podman manages the farms by writing and reading the `podman-connections.json` file located under +`$XDG_CONFIG_HOME/containers` or if the env is not set it defaults to `$HOME/.config/containers`. +Or the `PODMAN_CONNECTIONS_CONF` environment variable can be set to a full file path which podman +will use instead. +This file is managed by the podman commands and should never be edited by users directly. To manually +configure the farms use the `[farm]` section in containers.conf. + +If the ReadWrite column in the **podman farm list** output is set to true the farm is stored in the +`podman-connections.json` file otherwise it is stored in containers.conf and can therefore not be +edited with the **podman farm remove/update** commands. It can still be used with **podman farm build**. + ## COMMANDS | Command | Man Page | Description | diff --git a/docs/source/markdown/podman-system-connection.1.md b/docs/source/markdown/podman-system-connection.1.md index 085b20a3d7..f126d3b116 100644 --- a/docs/source/markdown/podman-system-connection.1.md +++ b/docs/source/markdown/podman-system-connection.1.md @@ -11,6 +11,17 @@ Manage the destination(s) for Podman service(s). The user is prompted for the ssh login password or key file passphrase as required. The `ssh-agent` is supported if it is running. +Podman manages the system connection by writing and reading the `podman-connections.json` file located under +`$XDG_CONFIG_HOME/containers` or if the env is not set it defaults to `$HOME/.config/containers`. +Or the `PODMAN_CONNECTIONS_CONF` environment variable can be set to a full file path which podman +will use instead. +This file is managed by the podman commands and should never be edited by users directly. To manually +configure the connections use `service_destinations` in containers.conf. + +If the ReadWrite column in the **podman system connection list** output is set to true the connection is +stored in the `podman-connections.json` file otherwise it is stored in containers.conf and can therefore +not be edited with the **podman system connection** commands. + ## COMMANDS | Command | Man Page | Description | @@ -24,8 +35,8 @@ The user is prompted for the ssh login password or key file passphrase as requir ## EXAMPLE ``` $ podman system connection list -Name URI Identity Default -devl ssh://root@example.com/run/podman/podman.sock ~/.ssh/id_rsa true +Name URI Identity Default ReadWrite +devl ssh://root@example.com/run/podman/podman.sock ~/.ssh/id_rsa true true ``` ## SEE ALSO **[podman(1)](podman.1.md)**, **[podman-system(1)](podman-system.1.md)** diff --git a/docs/source/markdown/podman.1.md b/docs/source/markdown/podman.1.md index cf908cdcb1..b94afd9687 100644 --- a/docs/source/markdown/podman.1.md +++ b/docs/source/markdown/podman.1.md @@ -255,7 +255,7 @@ Set default `--identity` path to ssh key file value used to access Podman servic #### **PODMAN_CONNECTIONS_CONF** The path to the file where the system connections and farms created with `podman system connection add` -and `podman farm add` are stored, by default it uses `~/.config/containers/podman-connections.conf`. +and `podman farm add` are stored, by default it uses `~/.config/containers/podman-connections.json`. #### **STORAGE_DRIVER**