docs: add podman remote tutorial #8457
Conversation
cdrage
requested review from
dgolovin,
deboer-tim and
gastoner
and removed request for
a team
cdrage
force-pushed
the
add-remote-doc
branch
4 times, most recently
from
f16aac5
to
0f643a1
Compare
website/docs/podman/podman-remote.md
Outdated
|
|
||
| **Ed25519** keys, an **SSH** connection, and an enabled **Podman Socket** are required for remote access. | ||
|
|
||
| RSA keys are _not supported_; Ed25519 keys are the recommended and only current method to set up a remote connection. |
There was a problem hiding this comment.
Do we have the upstream issue we could add as a footnote here ?
website/docs/podman/podman-remote.md
Outdated
|
|
||
| **Ed25519** keys, an **SSH** connection, and an enabled **Podman Socket** are required for remote access. | ||
|
|
||
| RSA keys are _not supported_; Ed25519 keys are the recommended and only current method to set up a remote connection. |
There was a problem hiding this comment.
| RSA keys are _not supported_; Ed25519 keys are the recommended and only current method to set up a remote connection. | |
| [RSA keys are not supported](https://github.com/mscdex/ssh2/issues/1375); Ed25519 keys are the recommended and only current method to set up a remote connection. |
There was a problem hiding this comment.
To me, there is a blur line in the documentation.
From Podman Desktop side, I would expect a first part explaining how Podman Deskop will filter/connect and any restriction to connect to all podman system connection
and a different section on how to enable remote access if I have a VM/machine using podman.
Because here it seems we're more advertising how to do the setup of Podman which is more a 'podman feature'
|
|
||
| 1. Enable Podman Remote in the Podman **Settings**: | ||
|
|
||
|  |
There was a problem hiding this comment.
wondering if we should have now both light and dark images so depending on the theme being used I'll see the correct image
https://docusaurus.io/docs/markdown-features/assets
website/docs/podman/podman-remote.md
Outdated
|
|
||
|  | ||
|
|
||
| 2. Generate a local Ed25519 key: |
There was a problem hiding this comment.
| 2. Generate a local Ed25519 key: | |
| 2. Generate a local ed25519 key: |
website/docs/podman/podman-remote.md
Outdated
| $ ssh-keygen -t ed25519 -f ~/.ssh/id_ed25519 | ||
| ``` | ||
|
|
||
| 3. Copy your **public** Ed25519 key to the server: |
There was a problem hiding this comment.
| 3. Copy your **public** Ed25519 key to the server: | |
| 3. Copy your **public** ed25519 key to the server: |
website/docs/podman/podman-remote.md
Outdated
| 4. Enable the Podman socket on the remote connection: | ||
|
|
||
| By default, the podman.socket is **disabled** in Podman installations. Enabling the systemd socket allows remote clients to control Podman. | ||
|
|
||
| ```sh | ||
| $ systemctl enable podman.socket | ||
| $ systemctl start podman.socket | ||
| ``` |
There was a problem hiding this comment.
maybe add a command to check if the socket or the service is there.
website/docs/podman/podman-remote.md
Outdated
|
|
||
| This functionality is enabled by connecting via SSH to the Podman socket on the remote host. | ||
|
|
||
| **Ed25519** keys, an **SSH** connection, and an enabled **Podman Socket** are required for remote access. |
There was a problem hiding this comment.
| **Ed25519** keys, an **SSH** connection, and an enabled **Podman Socket** are required for remote access. | |
| **ed25519** keys, an **SSH** connection, and an enabled **Podman Socket** are required for remote access. |
| Podman Desktop can manage remote Podman connections. This is facilitated through a list of connections using the command `podman system connection ls`. | ||
|
|
||
| Containers can be created, started, stopped, and deleted as if managed locally. | ||
|
|
||
| This functionality is enabled by connecting via SSH to the Podman socket on the remote host. |
There was a problem hiding this comment.
maybe add a section enlightening that it'll work only for ssh connections of podman system connection so if you're using a remote connection being a path to another directory, Podman Desktop won't connect to it.
There was a problem hiding this comment.
Next sentence says that ed key, ssh connection and an enabled podman socket is required, so it implies folder / other directory wont work, only SSH.
Agreed, good if I instead re-order and have basically the first part of the procedure being "Enable Remote connections and you'll see any remote connections propagate on Podman Desktop GUI, etc."? The rest can be the "podman" setup. |
|
@cdrage yes |
cdrage
force-pushed
the
add-remote-doc
branch
2 times, most recently
from
301625f
to
4bec8e8
Compare
### What does this PR do? * Adds a podman remote tutorial to the website so you can learn how to access remote systems. This is taken from PR descriptions / explanations as well as the podman remote tutorial doc: https://github.com/containers/podman/blob/main/docs/tutorials/remote_client.md ### Screenshot / video of UI <!-- If this PR is changing UI, please include screenshots or screencasts showing the difference --> N/A, see markdown ### What issues does this PR fix or reference? <!-- Include any related issues from Podman Desktop repository (or from another issue tracker). --> Closes containers#8280 ### How to test this PR? <!-- Please explain steps to verify the functionality, do not forget to provide unit/component tests --> N/A, docs Signed-off-by: Charlie Drage <[email protected]>
Signed-off-by: Charlie Drage <[email protected]>
Updated 👍 |
docs: add podman remote tutorial
What does this PR do?
access remote systems. This is taken from PR descriptions /
explanations as well as the podman remote tutorial doc: https://github.com/containers/podman/blob/main/docs/tutorials/remote_client.md
Screenshot / video of UI
N/A, see markdown
What issues does this PR fix or reference?
Closes #8280
How to test this PR?
N/A, docs
Signed-off-by: Charlie Drage [email protected]