Add docs for quadlet syntax

angelcerveraroldan · angelcerveraroldan · commit 339567f4bbcc · 2026-03-27T16:38:59.000Z
diff --git a/docs/config-fcos-v1_8-exp.md b/docs/config-fcos-v1_8-exp.md
@@ -192,6 +192,15 @@ The Fedora CoreOS configuration is a YAML document conforming to the following s
       * **name** (string): the name of the drop-in. This must be suffixed with ".conf".
       * **_contents_** (string): the contents of the drop-in. Mutually exclusive with `contents_local`.
       * **_contents_local_** (string): a local path to the contents of the drop-in, relative to the directory specified by the `--files-dir` command-line argument. Mutually exclusive with `contents`.
+  * **_quadlets_** (list of objects): a list of Podman Quadlet files.
+    * **name** (string): the name of the quadlet file.
+    * **rootful** (boolean): whether the quadlet runs as rootful. If true, the file is placed in `/etc/containers/systemd`. If false, it is placed in `/etc/containers/systemd/users`. Defaults to false.
+    * **_contents_** (string): the contents of the quadlet file. Mutually exclusive with `contents_local`.
+    * **_contents_local_** (string): a local path to the contents of the quadlet file, relative to the directory specified by the `--files-dir` command-line argument. Mutually exclusive with `contents`.
+    * **_dropins_** (list of objects): drop-ins to override settings in the quadlet.
+      * **name** (string): the name of the drop-in file.
+      * **_contents_** (string): the contents of the drop-in. Mutually exclusive with `contents_local`.
+      * **_contents_local_** (string): a local path to the contents of the drop-in, relative to the directory specified by the `--files-dir` command-line argument. Mutually exclusive with `contents`.
 * **_passwd_** (object): describes the desired additions to the passwd database.
   * **_users_** (list of objects): the list of accounts that shall exist. All users must have a unique `name`.
     * **name** (string): the username for the account.
diff --git a/docs/config-fiot-v1_1-exp.md b/docs/config-fiot-v1_1-exp.md
@@ -131,6 +131,15 @@ The Fedora IoT configuration is a YAML document conforming to the following spec
       * **name** (string): the name of the drop-in. This must be suffixed with ".conf".
       * **_contents_** (string): the contents of the drop-in. Mutually exclusive with `contents_local`.
       * **_contents_local_** (string): a local path to the contents of the drop-in, relative to the directory specified by the `--files-dir` command-line argument. Mutually exclusive with `contents`.
+  * **_quadlets_** (list of objects): a list of Podman Quadlet files.
+    * **name** (string): the name of the quadlet file.
+    * **rootful** (boolean): whether the quadlet runs as rootful. If true, the file is placed in `/etc/containers/systemd`. If false, it is placed in `/etc/containers/systemd/users`. Defaults to false.
+    * **_contents_** (string): the contents of the quadlet file. Mutually exclusive with `contents_local`.
+    * **_contents_local_** (string): a local path to the contents of the quadlet file, relative to the directory specified by the `--files-dir` command-line argument. Mutually exclusive with `contents`.
+    * **_dropins_** (list of objects): drop-ins to override settings in the quadlet.
+      * **name** (string): the name of the drop-in file.
+      * **_contents_** (string): the contents of the drop-in. Mutually exclusive with `contents_local`.
+      * **_contents_local_** (string): a local path to the contents of the drop-in, relative to the directory specified by the `--files-dir` command-line argument. Mutually exclusive with `contents`.
 * **_passwd_** (object): describes the desired additions to the passwd database.
   * **_users_** (list of objects): the list of accounts that shall exist. All users must have a unique `name`.
     * **name** (string): the username for the account.
diff --git a/docs/config-flatcar-v1_2-exp.md b/docs/config-flatcar-v1_2-exp.md
@@ -190,6 +190,15 @@ The Flatcar configuration is a YAML document conforming to the following specifi
       * **name** (string): the name of the drop-in. This must be suffixed with ".conf".
       * **_contents_** (string): the contents of the drop-in. Mutually exclusive with `contents_local`.
       * **_contents_local_** (string): a local path to the contents of the drop-in, relative to the directory specified by the `--files-dir` command-line argument. Mutually exclusive with `contents`.
+  * **_quadlets_** (list of objects): a list of Podman Quadlet files.
+    * **name** (string): the name of the quadlet file.
+    * **rootful** (boolean): whether the quadlet runs as rootful. If true, the file is placed in `/etc/containers/systemd`. If false, it is placed in `/etc/containers/systemd/users`. Defaults to false.
+    * **_contents_** (string): the contents of the quadlet file. Mutually exclusive with `contents_local`.
+    * **_contents_local_** (string): a local path to the contents of the quadlet file, relative to the directory specified by the `--files-dir` command-line argument. Mutually exclusive with `contents`.
+    * **_dropins_** (list of objects): drop-ins to override settings in the quadlet.
+      * **name** (string): the name of the drop-in file.
+      * **_contents_** (string): the contents of the drop-in. Mutually exclusive with `contents_local`.
+      * **_contents_local_** (string): a local path to the contents of the drop-in, relative to the directory specified by the `--files-dir` command-line argument. Mutually exclusive with `contents`.
 * **_passwd_** (object): describes the desired additions to the passwd database.
   * **_users_** (list of objects): the list of accounts that shall exist. All users must have a unique `name`.
     * **name** (string): the username for the account.
diff --git a/docs/config-openshift-v4_22-exp.md b/docs/config-openshift-v4_22-exp.md
@@ -161,6 +161,15 @@ The OpenShift configuration is a YAML document conforming to the following speci
       * **name** (string): the name of the drop-in. This must be suffixed with ".conf".
       * **_contents_** (string): the contents of the drop-in. Mutually exclusive with `contents_local`.
       * **_contents_local_** (string): a local path to the contents of the drop-in, relative to the directory specified by the `--files-dir` command-line argument. Mutually exclusive with `contents`.
+  * **_quadlets_** (list of objects): a list of Podman Quadlet files.
+    * **name** (string): the name of the quadlet file.
+    * **rootful** (boolean): whether the quadlet runs as rootful. If true, the file is placed in `/etc/containers/systemd`. If false, it is placed in `/etc/containers/systemd/users`. Defaults to false.
+    * **_contents_** (string): the contents of the quadlet file. Mutually exclusive with `contents_local`.
+    * **_contents_local_** (string): a local path to the contents of the quadlet file, relative to the directory specified by the `--files-dir` command-line argument. Mutually exclusive with `contents`.
+    * **_dropins_** (list of objects): drop-ins to override settings in the quadlet.
+      * **name** (string): the name of the drop-in file.
+      * **_contents_** (string): the contents of the drop-in. Mutually exclusive with `contents_local`.
+      * **_contents_local_** (string): a local path to the contents of the drop-in, relative to the directory specified by the `--files-dir` command-line argument. Mutually exclusive with `contents`.
 * **_passwd_** (object): describes the desired additions to the passwd database.
   * **_users_** (list of objects): the list of accounts that shall exist. All users must have a unique `name`.
     * **name** (string): the username for the account. Must be `core`.
diff --git a/docs/config-r4e-v1_2-exp.md b/docs/config-r4e-v1_2-exp.md
@@ -131,6 +131,15 @@ The RHEL for Edge configuration is a YAML document conforming to the following s
       * **name** (string): the name of the drop-in. This must be suffixed with ".conf".
       * **_contents_** (string): the contents of the drop-in. Mutually exclusive with `contents_local`.
       * **_contents_local_** (string): a local path to the contents of the drop-in, relative to the directory specified by the `--files-dir` command-line argument. Mutually exclusive with `contents`.
+  * **_quadlets_** (list of objects): a list of Podman Quadlet files.
+    * **name** (string): the name of the quadlet file.
+    * **rootful** (boolean): whether the quadlet runs as rootful. If true, the file is placed in `/etc/containers/systemd`. If false, it is placed in `/etc/containers/systemd/users`. Defaults to false.
+    * **_contents_** (string): the contents of the quadlet file. Mutually exclusive with `contents_local`.
+    * **_contents_local_** (string): a local path to the contents of the quadlet file, relative to the directory specified by the `--files-dir` command-line argument. Mutually exclusive with `contents`.
+    * **_dropins_** (list of objects): drop-ins to override settings in the quadlet.
+      * **name** (string): the name of the drop-in file.
+      * **_contents_** (string): the contents of the drop-in. Mutually exclusive with `contents_local`.
+      * **_contents_local_** (string): a local path to the contents of the drop-in, relative to the directory specified by the `--files-dir` command-line argument. Mutually exclusive with `contents`.
 * **_passwd_** (object): describes the desired additions to the passwd database.
   * **_users_** (list of objects): the list of accounts that shall exist. All users must have a unique `name`.
     * **name** (string): the username for the account.
diff --git a/docs/release-notes.md b/docs/release-notes.md
@@ -10,6 +10,10 @@ nav_order: 9
 
 ### Features
 
+- Add `systemd.quadlets` section for embedding Podman Quadlet files
+  _(fcos 1.8.0-exp, fiot 1.1.0-exp, flatcar 1.2.0-exp, openshift
+  4.22.0-exp, r4e 1.2.0-exp)_
+
 ### Bug fixes
 
 ### Misc. changes
diff --git a/internal/doc/butane.yaml b/internal/doc/butane.yaml
@@ -340,6 +340,27 @@ root:
                 - name: contents_local
                   after: contents
                   desc: a local path to the contents of the drop-in, relative to the directory specified by the `--files-dir` command-line argument. Mutually exclusive with `contents`.
+        - name: quadlets
+          after: units
+          desc: a list of Podman Quadlet files.
+          children:
+            - name: name
+              desc: the name of the quadlet file.
+            - name: rootful
+              desc: whether the quadlet runs as rootful. If true, the file is placed in `/etc/containers/systemd`. If false, it is placed in `/etc/containers/systemd/users`. Defaults to false.
+            - name: contents
+              desc: the contents of the quadlet file. Mutually exclusive with `contents_local`.
+            - name: contents_local
+              desc: a local path to the contents of the quadlet file, relative to the directory specified by the `--files-dir` command-line argument. Mutually exclusive with `contents`.
+            - name: dropins
+              desc: drop-ins to override settings in the quadlet.
+              children:
+                - name: name
+                  desc: the name of the drop-in file.
+                - name: contents
+                  desc: the contents of the drop-in. Mutually exclusive with `contents_local`.
+                - name: contents_local
+                  desc: a local path to the contents of the drop-in, relative to the directory specified by the `--files-dir` command-line argument. Mutually exclusive with `contents`.
     - name: passwd
       children:
         - name: users
