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

Merge pull request #14951 from eriksjolund/add_socket_activation_entry_to_tutorial_list

Browse Source 
[CI:DOCS] Tutorials.rst: add socket activation
This commit is contained in:
openshift-ci[bot]
2022-07-17 10:18:24 +00:00
committed by GitHub
parent 20a3c9969f c9722c0b16
commit b680e117ba
2 changed files with 7 additions and 6 deletions
Download Patch File Download Diff File Expand all files Collapse all files

1
docs/source/Tutorials.rst
View File

@ -13,3 +13,4 @@ Here are a number of useful tutorials to get you up and running with Podman. If
* `How to use libpod for custom/derivative projects <https://github.com/containers/podman/blob/main/docs/tutorials/podman-derivative-api.md>`_: How the libpod API can be used within your own project.
* `How to use Podman's Go RESTful bindings <https://github.com/containers/podman/tree/main/pkg/bindings>`_: An introduction to using our RESTful Golang bindings in an external application.
* `Common network setups <https://github.com/containers/podman/blob/main/docs/tutorials/basic_networking.md>`_: A basic guide to common network setups for Podman.
* `Socket activation <https://github.com/containers/podman/blob/main/docs/tutorials/socket_activation.md>`_: Learn how to run containers that support socket activation.

12
docs/tutorials/socket_activation.md
View File

@ -1,4 +1,4 @@
## Podman socket activation
# Podman socket activation
Socket activation conceptually works by having systemd create a socket (e.g. TCP, UDP or Unix
socket). As soon as a client connects to the socket, systemd will start the systemd service that is
@ -13,7 +13,7 @@ Podman supports two forms of socket activation:
* Socket activation of the API service
* Socket activation of containers
### Socket activation of the API service
## Socket activation of the API service
The architecture looks like this
@ -55,7 +55,7 @@ $ export DOCKER_HOST=unix://$XDG_RUNTIME_DIR/podman/podman.sock
$ docker-compose up
```
### Socket activation of containers
## Socket activation of containers
Since version 3.4.0 Podman supports socket activation of containers, i.e., passing
a socket-activated socket to the container. Thanks to the fork/exec model of Podman, the socket will be first
@ -79,7 +79,7 @@ The container must also support socket activation. Not all software daemons supp
but it's getting more popular. For instance Apache HTTP server, MariaDB, DBUS, PipeWire, Gunicorn, CUPS
all have socket activation support.
#### Example: socket-activated echo server container in a systemd service
### Example: socket-activated echo server container in a systemd service
Let's try out [socket-activate-echo](https://github.com/eriksjolund/socket-activate-echo/pkgs/container/socket-activate-echo), a simple echo server container that supports socket activation.
@ -121,7 +121,7 @@ WantedBy=default.target
`%h` is a systemd specifier that expands to the user's home directory.
After editing the unit files, systemd needs to reload it's configuration
After editing the unit files, systemd needs to reload its configuration
```
$ systemctl --user daemon-reload
@ -152,7 +152,7 @@ hello
The echo server works as expected. It replies _"hello"_ after receiving the text _"hello"_.
### Socket activate an Apache HTTP server with systemd-socket-activate
### Example: socket activate an Apache HTTP server with systemd-socket-activate
Instead of setting up a systemd service to test out socket activation, an alternative is to use the command-line
tool [__systemd-socket-activate__](https://www.freedesktop.org/software/systemd/man/systemd-socket-activate.html#).