Skip to content

Commit d50cf33

Browse files
docs: virtiofs added to docs and release-notes
1 parent 241690c commit d50cf33

3 files changed

Lines changed: 16 additions & 4 deletions

File tree

config/doc/ignition.yaml

Lines changed: 13 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -172,12 +172,23 @@ root:
172172
desc: the list of filesystems to be configured. `device` and `format` need to be specified. Every filesystem must have a unique `device`.
173173
children:
174174
- name: device
175-
desc: the absolute path to the device. Devices are typically referenced by the `/dev/disk/by-*` symlinks.
175+
desc: the absolute path to the device. Devices are typically referenced by the `/dev/disk/by-*` symlinks. For virtiofs, this is the tag name.
176+
transforms:
177+
- regex: " For virtiofs, this is the tag name."
178+
replacement: ""
179+
if:
180+
- variant: ignition
181+
max: 3.6.0
176182
- name: format
177-
desc: the filesystem format (ext4, btrfs, xfs, vfat, swap, or none).
183+
desc: the filesystem format (ext4, btrfs, xfs, vfat, virtiofs, swap, or none).
178184
# not part of the primary key, but required by validation
179185
required: true
180186
transforms:
187+
- regex: "virtiofs, "
188+
replacement: ""
189+
if:
190+
- variant: ignition
191+
max: 3.6.0
181192
- regex: "swap, or none"
182193
replacement: "or swap"
183194
if:

docs/configuration-v3_7_experimental.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -71,8 +71,8 @@ The Ignition configuration is a JSON document conforming to the following specif
7171
* **_spares_** (integer): the number of spares (if applicable) in the array.
7272
* **_options_** (list of strings): any additional options to be passed to mdadm.
7373
* **_filesystems_** (list of objects): the list of filesystems to be configured. `device` and `format` need to be specified. Every filesystem must have a unique `device`.
74-
* **device** (string): the absolute path to the device. Devices are typically referenced by the `/dev/disk/by-*` symlinks.
75-
* **format** (string): the filesystem format (ext4, btrfs, xfs, vfat, swap, or none).
74+
* **device** (string): the absolute path to the device. Devices are typically referenced by the `/dev/disk/by-*` symlinks. For virtiofs, this is the tag name.
75+
* **format** (string): the filesystem format (ext4, btrfs, xfs, vfat, virtiofs, swap, or none).
7676
* **_path_** (string): the mount-point of the filesystem while Ignition is running relative to where the root filesystem will be mounted. This is not necessarily the same as where it should be mounted in the real root, but it is encouraged to make it the same.
7777
* **_wipeFilesystem_** (boolean): whether or not to wipe the device before filesystem creation, see [Ignition's documentation on filesystems](https://coreos.github.io/ignition/operator-notes/#filesystem-reuse-semantics) for more information. Defaults to false.
7878
* **_label_** (string): the label of the filesystem.

docs/release-notes.md

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -11,6 +11,7 @@ nav_order: 9
1111
### Features
1212

1313
- Support reading configs from `/run/ignition` and `/etc/ignition/` in addition to `/usr/lib/ignition/`, searched in descending priority order ([#2221](https://github.com/coreos/ignition/pull/2221))
14+
- Add support for `virtiofs`
1415

1516
### Changes
1617

0 commit comments

Comments
 (0)