docker2podman: add documentation/header

this adds a small documentation in the header of the playbook in order
to explain what is the goal of this playbook.

Signed-off-by: Guillaume Abrioux <gabrioux@redhat.com>
(cherry picked from commit 36b4227dcd79c2525102f8c3102771cfab7fe693)

diff --git a/infrastructure-playbooks/docker-to-podman.yml b/infrastructure-playbooks/docker-to-podman.yml
index fac7899d38c5b130bcb2356666f2dc1877f03a5e..16bde3e63d35f06c1684f14767eb9f099680dea6 100644 (file)
--- a/infrastructure-playbooks/docker-to-podman.yml
+++ b/infrastructure-playbooks/docker-to-podman.yml
@@ -1,3 +1,10 @@
+---
+# This playbook is intended to be used as part of the el7 to el8 OS upgrade.
+# It modifies the systemd unit files so containers are launched with podman
+# instead of docker after the OS reboot once it is upgraded.
+# It is *not* intended to restart services since we don't want multiple services
+# restarts.
+
 - hosts:
   - mons
   - osds