Skip to content

Commit 72550e5

Browse files
committed
docs: run generate with new ignition import
1 parent e37ee9c commit 72550e5

File tree

6 files changed

+9
-7
lines changed

6 files changed

+9
-7
lines changed

docs/config-fcos-v1_6-exp.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -15,7 +15,7 @@ The Fedora CoreOS configuration is a YAML document conforming to the following s
1515
<div id="spec-docs"></div>
1616

1717
* **variant** (string): used to differentiate configs for different operating systems. Must be `fcos` for this specification.
18-
* **version** (string): the semantic version of the spec for this document. This document is for version `1.6.0-experimental` and generates Ignition configs with version `3.5.0-experimental`.
18+
* **version** (string): the semantic version of the spec for this document. This document is for version `1.6.0-experimental` and generates Ignition configs with version `3.5.0`.
1919
* **_ignition_** (object): metadata about the configuration itself.
2020
* **_config_** (object): options related to the configuration.
2121
* **_merge_** (list of objects): a list of the configs to be merged to the current config.
@@ -169,7 +169,7 @@ The Fedora CoreOS configuration is a YAML document conforming to the following s
169169
* **config** (string): the clevis configuration JSON.
170170
* **_needs_network_** (boolean): whether or not the device requires networking.
171171
* **_cex_** (object): describes the IBM Crypto Express (CEX) card configuration for the luks device.
172-
* **_enabled_** (boolean): whether or not to use a CEX secure key to encrypt the luks device.
172+
* **_enabled_** (boolean): whether or not to enable cex compatibility for luks. If omitted, defaults to false.
173173
* **_trees_** (list of objects): a list of local directory trees to be embedded in the config. Ownership is not preserved. File modes are set to 0755 if the local file is executable or 0644 otherwise. Attributes of files, directories, and symlinks can be overridden by creating a corresponding entry in the `files`, `directories`, or `links` section; such `files` entries must omit `contents` and such `links` entries must omit `target`.
174174
* **local** (string): the base of the local directory tree, relative to the directory specified by the `--files-dir` command-line argument.
175175
* **_path_** (string): the path of the tree within the target system. Defaults to `/`.

docs/config-fiot-v1_1-exp.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -15,7 +15,7 @@ The Fedora IoT configuration is a YAML document conforming to the following spec
1515
<div id="spec-docs"></div>
1616

1717
* **variant** (string): used to differentiate configs for different operating systems. Must be `%VARIANT%` for this specification.
18-
* **version** (string): the semantic version of the spec for this document. This document is for version `%VERSION%` and generates Ignition configs with version `3.5.0-experimental`.
18+
* **version** (string): the semantic version of the spec for this document. This document is for version `%VERSION%` and generates Ignition configs with version `3.5.0`.
1919
* **_ignition_** (object): metadata about the configuration itself.
2020
* **_config_** (object): options related to the configuration.
2121
* **_merge_** (list of objects): a list of the configs to be merged to the current config.

docs/config-flatcar-v1_2-exp.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -15,7 +15,7 @@ The Flatcar configuration is a YAML document conforming to the following specifi
1515
<div id="spec-docs"></div>
1616

1717
* **variant** (string): used to differentiate configs for different operating systems. Must be `flatcar` for this specification.
18-
* **version** (string): the semantic version of the spec for this document. This document is for version `1.2.0-experimental` and generates Ignition configs with version `3.5.0-experimental`.
18+
* **version** (string): the semantic version of the spec for this document. This document is for version `1.2.0-experimental` and generates Ignition configs with version `3.5.0`.
1919
* **_ignition_** (object): metadata about the configuration itself.
2020
* **_config_** (object): options related to the configuration.
2121
* **_merge_** (list of objects): a list of the configs to be merged to the current config.

docs/config-openshift-v4_18-exp.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -15,7 +15,7 @@ The OpenShift configuration is a YAML document conforming to the following speci
1515
<div id="spec-docs"></div>
1616

1717
* **variant** (string): used to differentiate configs for different operating systems. Must be `openshift` for this specification.
18-
* **version** (string): the semantic version of the spec for this document. This document is for version `4.18.0-experimental` and generates Ignition configs with version `3.5.0-experimental`.
18+
* **version** (string): the semantic version of the spec for this document. This document is for version `4.18.0-experimental` and generates Ignition configs with version `3.5.0`.
1919
* **metadata** (object): metadata about the generated MachineConfig resource. Respected when rendering to a MachineConfig, ignored when rendering directly to an Ignition config.
2020
* **name** (string): a unique [name](https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names) for this MachineConfig resource.
2121
* **labels** (object): string key/value pairs to apply as [Kubernetes labels](https://kubernetes.io/docs/concepts/overview/working-with-objects/labels/) to this MachineConfig resource. `machineconfiguration.openshift.io/role` is required.
@@ -138,7 +138,7 @@ The OpenShift configuration is a YAML document conforming to the following speci
138138
* **config** (string): the clevis configuration JSON.
139139
* **_needs_network_** (boolean): whether or not the device requires networking.
140140
* **_cex_** (object): describes the IBM Crypto Express (CEX) card configuration for the luks device.
141-
* **_enabled_** (boolean): whether or not to use a CEX secure key to encrypt the luks device.
141+
* **_enabled_** (boolean): whether or not to enable cex compatibility for luks. If omitted, defaults to false.
142142
* **_trees_** (list of objects): a list of local directory trees to be embedded in the config. Symlinks must not be present. Ownership is not preserved. File modes are set to 0755 if the local file is executable or 0644 otherwise. File attributes can be overridden by creating a corresponding entry in the `files` section; such entries must omit `contents`.
143143
* **local** (string): the base of the local directory tree, relative to the directory specified by the `--files-dir` command-line argument.
144144
* **_path_** (string): the path of the tree within the target system. Defaults to `/`.

docs/config-r4e-v1_2-exp.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -15,7 +15,7 @@ The RHEL for Edge configuration is a YAML document conforming to the following s
1515
<div id="spec-docs"></div>
1616

1717
* **variant** (string): used to differentiate configs for different operating systems. Must be `r4e` for this specification.
18-
* **version** (string): the semantic version of the spec for this document. This document is for version `1.2.0-experimental` and generates Ignition configs with version `3.5.0-experimental`.
18+
* **version** (string): the semantic version of the spec for this document. This document is for version `1.2.0-experimental` and generates Ignition configs with version `3.5.0`.
1919
* **_ignition_** (object): metadata about the configuration itself.
2020
* **_config_** (object): options related to the configuration.
2121
* **_merge_** (list of objects): a list of the configs to be merged to the current config.

docs/release-notes.md

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -16,6 +16,8 @@ nav_order: 9
1616

1717
### Docs changes
1818

19+
- Re-vendor latest ignition release; 3.5.0-experimental becomes 3.5.0
20+
1921

2022
## Butane 0.22.0 (2024-09-20)
2123

0 commit comments

Comments
 (0)