Skip to content

Commit df18924

Browse files
madhu-pillaitravier
authored andcommitted
docs: update for spec stablization
1 parent 4867377 commit df18924

File tree

4 files changed

+35
-2
lines changed

4 files changed

+35
-2
lines changed

docs/migrating-configs.md

Lines changed: 28 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -10,6 +10,34 @@ Occasionally, there are changes made to Ignition's configuration that break back
1010
1. TOC
1111
{:toc}
1212

13+
## From Version 3.4.0 to 3.5.0
14+
15+
### LUKS cex
16+
17+
The `luks` section gained a new `cex` field for s390x. If specified and true, the LUKS volume will issue volume encryption using IBM Crypto Express Card.
18+
19+
<!-- ignition -->
20+
```json
21+
{
22+
"ignition": { "version": "3.5.0" },
23+
"kernelArguments": {
24+
"shouldExist": [
25+
"'rd.luks.key=/etc/luks/cex.key'"
26+
]
27+
},
28+
"storage": {
29+
"luks": [{
30+
"name": "luks-cex",
31+
"device": "/dev/sdb",
32+
"discard": true,
33+
"cex": {
34+
"enabled": true
35+
}
36+
}]
37+
}
38+
}
39+
```
40+
1341
## From Version 3.3.0 to 3.4.0
1442

1543
There are not any breaking changes between versions 3.3.0 and 3.4.0 of the configuration specification. Any valid 3.3.0 configuration can be updated to a 3.4.0 configuration by simply changing the version string in the config.

docs/release-notes.md

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -17,6 +17,9 @@ nav_order: 9
1717
### Changes
1818

1919
- The Dracut module now installs partx
20+
- Mark the 3.5.0 config spec as stable
21+
- No longer accept configs with version 3.5.0-experimental
22+
- Create new 3.6.0-experimental config spec from 3.5.0
2023

2124
### Bug fixes
2225

docs/specs.md

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -19,6 +19,7 @@ We recommend that you always use the latest **stable** specification to benefit
1919
from new features and bug fixes. The following **stable** specification
2020
versions are currently supported in Ignition:
2121

22+
- [v3.5.0](configuration-v3_5.md)
2223
- [v3.4.0](configuration-v3_4.md)
2324
- [v3.3.0](configuration-v3_3.md)
2425
- [v3.2.0](configuration-v3_2.md)
@@ -32,7 +33,7 @@ and testing** as it is subject to change **without warning or announcement**.
3233
The following **experimental** specification version is currently available in
3334
Ignition:
3435

35-
- [v3.5.0-experimental](configuration-v3_5_experimental.md)
36+
- [v3.6.0-experimental](configuration-v3_6_experimental.md)
3637

3738
## Legacy spec 2.x configuration specifications
3839

@@ -54,3 +55,4 @@ recommended to use the latest Ignition release.
5455
| 3.2.0 | 2.7.0 |
5556
| 3.3.0 | 2.11.0 |
5657
| 3.4.0 | 2.15.0 |
58+
| 3.5.0 | 2.20.0 |

generate

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -12,7 +12,7 @@ hash schematyper 2>/dev/null || {
1212
exit 1
1313
}
1414

15-
specs="v3_0 v3_1 v3_2 v3_3 v3_4 v3_5_experimental"
15+
specs="v3_0 v3_1 v3_2 v3_3 v3_4 v3_5 v3_6_experimental"
1616

1717
for spec in $specs
1818
do

0 commit comments

Comments
 (0)