Skip to content

Commit

Permalink
docs: update for spec stablization
Browse files Browse the repository at this point in the history
  • Loading branch information
madhu-pillai committed Sep 17, 2024
1 parent 5cba417 commit b5d591a
Show file tree
Hide file tree
Showing 4 changed files with 35 additions and 3 deletions.
28 changes: 28 additions & 0 deletions docs/migrating-configs.md
Original file line number Diff line number Diff line change
Expand Up @@ -10,6 +10,34 @@ Occasionally, there are changes made to Ignition's configuration that break back
1. TOC
{:toc}

## From Version 3.4.0 to 3.5.0

### LUKS cex

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.

<!-- ignition -->
```json
{
"ignition": { "version": "3.5.0" },
"kernelArguments": {
"shouldExist": [
"'rd.luks.key=/etc/luks/cex.key'"
]
},
"storage": {
"luks": [{
"name": "luks-cex",
"device": "/dev/sdb",
"discard": true,
"cex": {
"enabled": true
}
}]
}
}
```

## From Version 3.3.0 to 3.4.0

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.
Expand Down
4 changes: 3 additions & 1 deletion docs/release-notes.md
Original file line number Diff line number Diff line change
Expand Up @@ -11,11 +11,13 @@ nav_order: 9
### Features

- Support partitioning disk with mounted partitions
- Support Proxmox VE

### Changes

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

### Bug fixes

Expand Down
4 changes: 3 additions & 1 deletion docs/specs.md
Original file line number Diff line number Diff line change
Expand Up @@ -19,6 +19,7 @@ We recommend that you always use the latest **stable** specification to benefit
from new features and bug fixes. The following **stable** specification
versions are currently supported in Ignition:

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

- [v3.5.0-experimental](configuration-v3_5_experimental.md)
- [v3.6.0-experimental](configuration-v3_6_experimental.md)

## Legacy spec 2.x configuration specifications

Expand All @@ -54,3 +55,4 @@ recommended to use the latest Ignition release.
| 3.2.0 | 2.7.0 |
| 3.3.0 | 2.11.0 |
| 3.4.0 | 2.15.0 |
| 3.5.0 | 2.20.0 |
2 changes: 1 addition & 1 deletion generate
Original file line number Diff line number Diff line change
Expand Up @@ -12,7 +12,7 @@ hash schematyper 2>/dev/null || {
exit 1
}

specs="v3_0 v3_1 v3_2 v3_3 v3_4 v3_5_experimental"
specs="v3_0 v3_1 v3_2 v3_3 v3_4 v3_5 v3_6_experimental"

for spec in $specs
do
Expand Down

0 comments on commit b5d591a

Please sign in to comment.