Skip to content

Commit 8cf12e2

Browse files
Add docs for quadlet syntax
1 parent 44a785a commit 8cf12e2

File tree

7 files changed

+70
-0
lines changed

7 files changed

+70
-0
lines changed

docs/config-fcos-v1_8-exp.md

Lines changed: 9 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -192,6 +192,15 @@ The Fedora CoreOS configuration is a YAML document conforming to the following s
192192
* **name** (string): the name of the drop-in. This must be suffixed with ".conf".
193193
* **_contents_** (string): the contents of the drop-in. Mutually exclusive with `contents_local`.
194194
* **_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`.
195+
* **_quadlets_** (list of objects): a list of Podman Quadlet files.
196+
* **name** (string): the name of the quadlet file.
197+
* **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.
198+
* **_contents_** (string): the contents of the quadlet file. Mutually exclusive with `contents_local`.
199+
* **_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`.
200+
* **_dropins_** (list of objects): drop-ins to override settings in the quadlet.
201+
* **name** (string): the name of the drop-in file.
202+
* **_contents_** (string): the contents of the drop-in. Mutually exclusive with `contents_local`.
203+
* **_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`.
195204
* **_passwd_** (object): describes the desired additions to the passwd database.
196205
* **_users_** (list of objects): the list of accounts that shall exist. All users must have a unique `name`.
197206
* **name** (string): the username for the account.

docs/config-fiot-v1_1-exp.md

Lines changed: 9 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -131,6 +131,15 @@ The Fedora IoT configuration is a YAML document conforming to the following spec
131131
* **name** (string): the name of the drop-in. This must be suffixed with ".conf".
132132
* **_contents_** (string): the contents of the drop-in. Mutually exclusive with `contents_local`.
133133
* **_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`.
134+
* **_quadlets_** (list of objects): a list of Podman Quadlet files.
135+
* **name** (string): the name of the quadlet file.
136+
* **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.
137+
* **_contents_** (string): the contents of the quadlet file. Mutually exclusive with `contents_local`.
138+
* **_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`.
139+
* **_dropins_** (list of objects): drop-ins to override settings in the quadlet.
140+
* **name** (string): the name of the drop-in file.
141+
* **_contents_** (string): the contents of the drop-in. Mutually exclusive with `contents_local`.
142+
* **_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`.
134143
* **_passwd_** (object): describes the desired additions to the passwd database.
135144
* **_users_** (list of objects): the list of accounts that shall exist. All users must have a unique `name`.
136145
* **name** (string): the username for the account.

docs/config-flatcar-v1_2-exp.md

Lines changed: 9 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -190,6 +190,15 @@ The Flatcar configuration is a YAML document conforming to the following specifi
190190
* **name** (string): the name of the drop-in. This must be suffixed with ".conf".
191191
* **_contents_** (string): the contents of the drop-in. Mutually exclusive with `contents_local`.
192192
* **_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`.
193+
* **_quadlets_** (list of objects): a list of Podman Quadlet files.
194+
* **name** (string): the name of the quadlet file.
195+
* **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.
196+
* **_contents_** (string): the contents of the quadlet file. Mutually exclusive with `contents_local`.
197+
* **_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`.
198+
* **_dropins_** (list of objects): drop-ins to override settings in the quadlet.
199+
* **name** (string): the name of the drop-in file.
200+
* **_contents_** (string): the contents of the drop-in. Mutually exclusive with `contents_local`.
201+
* **_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`.
193202
* **_passwd_** (object): describes the desired additions to the passwd database.
194203
* **_users_** (list of objects): the list of accounts that shall exist. All users must have a unique `name`.
195204
* **name** (string): the username for the account.

docs/config-openshift-v4_22-exp.md

Lines changed: 9 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -161,6 +161,15 @@ The OpenShift configuration is a YAML document conforming to the following speci
161161
* **name** (string): the name of the drop-in. This must be suffixed with ".conf".
162162
* **_contents_** (string): the contents of the drop-in. Mutually exclusive with `contents_local`.
163163
* **_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`.
164+
* **_quadlets_** (list of objects): a list of Podman Quadlet files.
165+
* **name** (string): the name of the quadlet file.
166+
* **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.
167+
* **_contents_** (string): the contents of the quadlet file. Mutually exclusive with `contents_local`.
168+
* **_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`.
169+
* **_dropins_** (list of objects): drop-ins to override settings in the quadlet.
170+
* **name** (string): the name of the drop-in file.
171+
* **_contents_** (string): the contents of the drop-in. Mutually exclusive with `contents_local`.
172+
* **_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`.
164173
* **_passwd_** (object): describes the desired additions to the passwd database.
165174
* **_users_** (list of objects): the list of accounts that shall exist. All users must have a unique `name`.
166175
* **name** (string): the username for the account. Must be `core`.

docs/config-r4e-v1_2-exp.md

Lines changed: 9 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -131,6 +131,15 @@ The RHEL for Edge configuration is a YAML document conforming to the following s
131131
* **name** (string): the name of the drop-in. This must be suffixed with ".conf".
132132
* **_contents_** (string): the contents of the drop-in. Mutually exclusive with `contents_local`.
133133
* **_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`.
134+
* **_quadlets_** (list of objects): a list of Podman Quadlet files.
135+
* **name** (string): the name of the quadlet file.
136+
* **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.
137+
* **_contents_** (string): the contents of the quadlet file. Mutually exclusive with `contents_local`.
138+
* **_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`.
139+
* **_dropins_** (list of objects): drop-ins to override settings in the quadlet.
140+
* **name** (string): the name of the drop-in file.
141+
* **_contents_** (string): the contents of the drop-in. Mutually exclusive with `contents_local`.
142+
* **_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`.
134143
* **_passwd_** (object): describes the desired additions to the passwd database.
135144
* **_users_** (list of objects): the list of accounts that shall exist. All users must have a unique `name`.
136145
* **name** (string): the username for the account.

docs/release-notes.md

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -10,6 +10,10 @@ nav_order: 9
1010

1111
### Features
1212

13+
- Add `systemd.quadlets` section for embedding Podman Quadlet files
14+
_(fcos 1.8.0-exp, fiot 1.1.0-exp, flatcar 1.2.0-exp, openshift
15+
4.22.0-exp, r4e 1.2.0-exp)_
16+
1317
### Bug fixes
1418

1519
### Misc. changes

internal/doc/butane.yaml

Lines changed: 21 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -340,6 +340,27 @@ root:
340340
- name: contents_local
341341
after: contents
342342
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`.
343+
- name: quadlets
344+
after: units
345+
desc: a list of Podman Quadlet files.
346+
children:
347+
- name: name
348+
desc: the name of the quadlet file.
349+
- name: rootful
350+
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.
351+
- name: contents
352+
desc: the contents of the quadlet file. Mutually exclusive with `contents_local`.
353+
- name: contents_local
354+
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`.
355+
- name: dropins
356+
desc: drop-ins to override settings in the quadlet.
357+
children:
358+
- name: name
359+
desc: the name of the drop-in file.
360+
- name: contents
361+
desc: the contents of the drop-in. Mutually exclusive with `contents_local`.
362+
- name: contents_local
363+
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`.
343364
- name: passwd
344365
children:
345366
- name: users

0 commit comments

Comments
 (0)