From d11012bd5f85c6d818b9b9086c63d5d67e6791a5 Mon Sep 17 00:00:00 2001 From: Madhu Pillai Date: Fri, 30 Aug 2024 10:01:04 +0200 Subject: [PATCH] config/doc/ignition.yaml: correction in description Docs rephrase in luks.cex.enabled description. https://github.com/coreos/butane/pull/536#discussion_r1678449662 --- config/doc/ignition.yaml | 2 +- docs/configuration-v3_5_experimental.md | 2 +- 2 files changed, 2 insertions(+), 2 deletions(-) diff --git a/config/doc/ignition.yaml b/config/doc/ignition.yaml index 6f39c2554..8c2841c23 100644 --- a/config/doc/ignition.yaml +++ b/config/doc/ignition.yaml @@ -384,7 +384,7 @@ root: desc: describes the IBM Crypto Express (CEX) card configuration for the luks device. children: - name: enabled - desc: whether or not to use a CEX secure key to encrypt the luks device. + desc: whether or not to enable cex compatibility for luks. If omitted, defaults to false. - name: systemd desc: describes the desired state of the systemd units. children: diff --git a/docs/configuration-v3_5_experimental.md b/docs/configuration-v3_5_experimental.md index 9c526a20d..02f595554 100644 --- a/docs/configuration-v3_5_experimental.md +++ b/docs/configuration-v3_5_experimental.md @@ -155,7 +155,7 @@ The Ignition configuration is a JSON document conforming to the following specif * **config** (string): the clevis configuration JSON. * **_needsNetwork_** (boolean): whether or not the device requires networking. * **_cex_** (object): describes the IBM Crypto Express (CEX) card configuration for the luks device. - * **_enabled_** (boolean): whether or not to use a CEX secure key to encrypt the luks device. + * **_enabled_** (boolean): whether or not to enable cex compatibility for luks. If omitted, defaults to false. * **_systemd_** (object): describes the desired state of the systemd units. * **_units_** (list of objects): the list of systemd units. Every unit must have a unique `name`. * **name** (string): the name of the unit. This must be suffixed with a valid unit type (e.g. "thing.service").