opensource/podman
1
0
Fork 0
mirror of https://github.com/containers/podman.git synced 2025-08-06 11:32:07 +08:00
Code Issues Packages Projects Releases Wiki Activity

[WIP] Refactor podman system connection

Browse Source 
* Add support to manage multiple connections
  * Add connection
  * Remove connection
  * Rename connection
  * Set connection as default
  * Add markdown/man pages
* Fix recursion in hack/xref-helpmsgs-manpages

Signed-off-by: Jhon Honce <jhonce@redhat.com>
This commit is contained in:
Jhon Honce
2020-07-21 10:36:44 -07:00
parent 1aac197f79
commit 964d3300c6
17 changed files with 836 additions and 234 deletions
Download Patch File Download Diff File Expand all files Collapse all files

46
docs/source/markdown/podman-system-connection-add.1.md Normal file
View File

@ -0,0 +1,46 @@
% podman-system-connection-add(1)
## NAME
podman\-system\-connection\-add - Record destination for the Podman service
## SYNOPSIS
**podman system connection add** [*options*] *name* *destination*
## DESCRIPTION
Record ssh destination for remote podman service(s). The ssh destination is given as one of:
- [user@]hostname[:port]
- ssh://[user@]hostname[:port]
The user will be prompted for the remote ssh login password or key file pass phrase as required. The `ssh-agent` is supported if it is running.
## OPTIONS
**-d**, **--default**=*false*
Make the new destination the default for this user.
**--identity**=*path*
Path to ssh identity file. If the identity file has been encrypted, Podman prompts the user for the passphrase.
If no identity file is provided and no user is given, Podman defaults to the user running the podman command.
Podman prompts for the login password on the remote server.
**-p**, **--port**=*port*
Port for ssh destination. The default value is `22`.
**--socket-path**=*path*
Path to the Podman service unix domain socket on the ssh destination host
## EXAMPLE
```
$ podman system connection add QA podman.example.com
$ podman system connection add --identity ~/.ssh/dev_rsa production ssh://root@server.example.com:2222
```
## SEE ALSO
podman-system(1) , podman-system-connection(1) , containers.conf(5)
## HISTORY
June 2020, Originally compiled by Jhon Honce (jhonce at redhat dot com)

20
docs/source/markdown/podman-system-connection-default.1.md Normal file
View File

@ -0,0 +1,20 @@
% podman-system-connection-default(1)
## NAME
podman\-system\-connection\-default - Set named destination as default for the Podman service
## SYNOPSIS
**podman system connection default** *name*
## DESCRIPTION
Set named ssh destination as default destination for the Podman service.
## EXAMPLE
```
$ podman system connection default production
```
## SEE ALSO
podman-system(1) , podman-system-connection(1) , containers.conf(5)
## HISTORY
July 2020, Originally compiled by Jhon Honce (jhonce at redhat dot com)

24
docs/source/markdown/podman-system-connection-list.1.md Normal file
View File

@ -0,0 +1,24 @@
% podman-system-connection-list(1)
## NAME
podman\-system\-connection\-list - List the destination for the Podman service(s)
## SYNOPSIS
**podman system connection list**
**podman system connection ls**
## DESCRIPTION
List ssh destination(s) for podman service(s).
## EXAMPLE
```
$ podman system connection list
Name URI Identity
devl ssh://root@example.com/run/podman/podman.sock ~/.ssh/id_rsa
```
## SEE ALSO
podman-system(1) , containers.conf(5)
## HISTORY
July 2020, Originally compiled by Jhon Honce (jhonce at redhat dot com)

20
docs/source/markdown/podman-system-connection-remove.1.md Normal file
View File

@ -0,0 +1,20 @@
% podman-system-connection-remove(1)
## NAME
podman\-system\-connection\-remove - Delete named destination
## SYNOPSIS
**podman system connection remove** *name*
## DESCRIPTION
Delete named ssh destination.
## EXAMPLE
```
$ podman system connection remove production
```
## SEE ALSO
podman-system(1) , podman-system-connection(1) , containers.conf(5)
## HISTORY
July 2020, Originally compiled by Jhon Honce (jhonce at redhat dot com)

20
docs/source/markdown/podman-system-connection-rename.1.md Normal file
View File

@ -0,0 +1,20 @@
% podman-system-connection-rename(1)
## NAME
podman\-system\-connection\-rename - Rename the destination for Podman service
## SYNOPSIS
**podman system connection rename** *old* *new*
## DESCRIPTION
Rename ssh destination from *old* to *new*.
## EXAMPLE
```
$ podman system connection rename laptop devel
```
## SEE ALSO
podman-system(1) , podman-system-connection(1) , containers.conf(5)
## HISTORY
July 2020, Originally compiled by Jhon Honce (jhonce at redhat dot com)

43
docs/source/markdown/podman-system-connection.1.md
View File

@ -1,43 +1,34 @@
% podman-system-connection(1)
## NAME
podman\-system\-connection - Record ssh destination for remote podman service
podman\-system\-connection - Manage the destination(s) for Podman service(s)
## SYNOPSIS
**podman system connection** [*options*] [*ssh destination*]
## SYNOPSISManage the destination(s) for Podman service(s)
**podman system connection** *subcommand*
## DESCRIPTION
Record ssh destination for remote podman service(s). The ssh destination is given as one of:
- [user@]hostname[:port]
- ssh://[user@]hostname[:port]
Manage the destination(s) for Podman service(s).
The user will be prompted for the remote ssh login password or key file pass phrase as required. `ssh-agent` is supported if it is running.
The user will be prompted for the ssh login password or key file pass phrase as required. The `ssh-agent` is supported if it is running.
## OPTIONS
## COMMANDS
**--identity**=*path*
Path to ssh identity file. If the identity file has been encrypted, Podman prompts the user for the passphrase.
If no identity file is provided and no user is given, Podman defaults to the user running the podman command.
Podman prompts for the login password on the remote server.
**-p**, **--port**=*port*
Port for ssh destination. The default value is `22`.
**--socket-path**=*path*
Path to podman service unix domain socket on the ssh destination host
| Command | Man Page | Description |
| ------- | ---------------------------------------------------------------------------- | ---------------------------------------------------------- |
| add | [podman-system-connection-add(1)](podman-system-connection-add.1.md) | Record destination for the Podman service |
| default | [podman-system-connection-default(1)](podman-system-connection-default.1.md) | Set named destination as default for the Podman service |
| list | [podman-system-connection-list(1)](podman-system-connection-list.1.md) | List the destination for the Podman service(s) |
| remove | [podman-system-connection-remove(1)](podman-system-connection-remove.1.md) | Delete named destination |
| rename | [podman-system-connection-rename(1)](podman-system-connection-rename.1.md) | Rename the destination for Podman service |
## EXAMPLE
```
$ podman system connection podman.fubar.com
$ podman system connection --identity ~/.ssh/dev_rsa ssh://root@server.fubar.com:2222
$ podman system connection list
Name URI Identity
devl ssh://root@example.com/run/podman/podman.sock ~/.ssh/id_rsa
```
## SEE ALSO
podman-system(1) , containers.conf(5) , connections.conf(5)
podman-system(1) , containers.conf(5)
## HISTORY
June 2020, Originally compiled by Jhon Honce (jhonce at redhat dot com)

21
docs/source/markdown/podman-system.1.md
View File

@ -11,17 +11,16 @@ The system command allows you to manage the podman systems
## COMMANDS
| Command | Man Page | Description |
| ------- | --------------------------------------------------- | ---------------------------------------------------------------------------- |
| df | [podman-system-df(1)](podman-system-df.1.md) | Show podman disk usage. |
| connection | [podman-system-connection(1)](podman-system-connection.1.md) | Record ssh destination for remote podman service. |
| info | [podman-system-info(1)](podman-info.1.md) | Displays Podman related system information. |
| migrate | [podman-system-migrate(1)](podman-system-migrate.1.md) | Migrate existing containers to a new podman version. |
| prune | [podman-system-prune(1)](podman-system-prune.1.md) | Remove all unused container, image and volume data. |
| renumber | [podman-system-renumber(1)](podman-system-renumber.1.md) | Migrate lock numbers to handle a change in maximum number of locks. |
| reset | [podman-system-reset(1)](podman-system-reset.1.md) | Reset storage back to initial state. |
| service | [podman-service(1)](podman-system-service.1.md) | Run an API service |
| Command | Man Page | Description |
| ------- | ------------------------------------------------------------ | -------------------------------------------------------------------- |
| connection | [podman-system-connection(1)](podman-system-connection.1.md) | Manage the destination(s) for Podman service(s) |
| df | [podman-system-df(1)](podman-system-df.1.md) | Show podman disk usage. |
| info | [podman-system-info(1)](podman-info.1.md) | Displays Podman related system information. |
| migrate | [podman-system-migrate(1)](podman-system-migrate.1.md) | Migrate existing containers to a new podman version. |
| prune | [podman-system-prune(1)](podman-system-prune.1.md) | Remove all unused container, image and volume data. |
| renumber | [podman-system-renumber(1)](podman-system-renumber.1.md) | Migrate lock numbers to handle a change in maximum number of locks. |
| reset | [podman-system-reset(1)](podman-system-reset.1.md) | Reset storage back to initial state. |
| service | [podman-system-service(1)](podman-system-service.1.md) | Run an API service |
## SEE ALSO
podman(1)