Cut the comment bloat from the Podman playbooks
Comment blocks now stay within three lines and explain only the non-obvious. Long histories, include examples, and commented-out code are gone. No task, key, or value changed; the only data change is comment text inside the generated unit files.
This commit is contained in:
1 parent
2aab1aec1e
commit
476a6d7cd0
85 files changed
+372
-2433
No files matched your search
@@ -1,33 +1,6 @@
|
||||
---
|
||||
# Register a service's logical network with Caddy.
|
||||
#
|
||||
# Caddy is the *base* unit and knows nothing about its upstreams. Each service
|
||||
# adds itself by writing two files into the Quadlet directory:
|
||||
#
|
||||
# 1. its own <name>.network unit, and
|
||||
# 2. a drop-in next to caddy.container that pulls that network into Caddy.
|
||||
#
|
||||
# Caddy's own playbook never changes when a service is added or removed.
|
||||
#
|
||||
# Include this from a service playbook:
|
||||
#
|
||||
# - name: Register this service with Caddy
|
||||
# ansible.builtin.include_tasks: "{{ playbook_dir }}/../caddy/roles/register/tasks/main.yaml"
|
||||
# vars:
|
||||
# network_name: "{{ container_name }}"
|
||||
#
|
||||
# The including play must also run the `podman` role (for podman_user and
|
||||
# quadlet_dir) and define a "Restart Caddy" handler:
|
||||
#
|
||||
# - name: Restart Caddy
|
||||
# ansible.builtin.systemd_service:
|
||||
# name: caddy.service
|
||||
# scope: user
|
||||
# state: restarted
|
||||
# daemon_reload: true
|
||||
# listen: Restart Caddy
|
||||
#
|
||||
# It runs as the connection user, which must be {{ podman_user }}.
|
||||
# Include from a service playbook with network_name set. The play must define
|
||||
# the "Restart Caddy" handler.
|
||||
|
||||
- name: "Create the {{ network_name }} network unit"
|
||||
ansible.builtin.copy:
|
||||
@@ -36,15 +9,8 @@
|
||||
group: "{{ podman_user }}"
|
||||
mode: '0644'
|
||||
content: |
|
||||
# {{ network_name }} — logical app network.
|
||||
# Managed by Ansible. Do not edit by hand.
|
||||
#
|
||||
# NetworkName pins the Podman network name. Without it Quadlet would
|
||||
# create "systemd-{{ network_name }}".
|
||||
#
|
||||
# isolate blocks traffic between separate Podman networks, so a container
|
||||
# on this network cannot reach one that is only on another. Caddy and any
|
||||
# shared service still reach it, because they are members of it.
|
||||
# Managed by Ansible. NetworkName pins the Podman name; isolate blocks
|
||||
# traffic between separate networks.
|
||||
[Network]
|
||||
NetworkName={{ network_name }}_net
|
||||
Options=isolate=true
|
||||
@@ -57,10 +23,8 @@
|
||||
group: "{{ podman_user }}"
|
||||
mode: '0644'
|
||||
content: |
|
||||
# Added by the {{ network_name }} playbook. Do not edit by hand.
|
||||
#
|
||||
# Quadlet merges this into caddy.container. Deleting this file removes
|
||||
# the network from Caddy on the next daemon-reload.
|
||||
# Added by {{ network_name }}. Deleting it detaches the network from
|
||||
# Caddy on the next daemon-reload.
|
||||
[Container]
|
||||
Network={{ network_name }}.network
|
||||
notify: Restart Caddy
|
||||
Reference in new issue
Block a user