Skip to content

Commit 84ca89a

Browse files
committed
docs/migrating-configs: move special mode bits section
Due to #2042 the special mode bits are not functional in versions =< 3.6.0-exp. Add an experimental spec entry, and move docs to that sub-section migrating-configs.
1 parent 9350560 commit 84ca89a

File tree

1 file changed

+29
-26
lines changed

1 file changed

+29
-26
lines changed

docs/migrating-configs.md

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

13+
14+
## From Version 3.5.0 to 3.6.0-experimental
15+
16+
### Special mode bits supported
17+
18+
The `mode` field of the `files` and `directories` sections now respects the setuid, setgid, and sticky bits. Previous spec versions ignore these bits, but will generate a warning on Ignition ≥ 2.21.0.
19+
20+
<!-- ignition -->
21+
```json
22+
{
23+
"ignition": {
24+
"version": "3.6.0-experimental"
25+
},
26+
"storage": {
27+
"files": [{
28+
"path": "/usr/local/bin/setuid",
29+
"contents": {
30+
"source": "https://rootkit.example.com/setuid"
31+
},
32+
"mode": 2541
33+
}],
34+
"directories": [{
35+
"path": "/var/local/tmp",
36+
"mode": 1023
37+
}]
38+
}
39+
}
40+
```
41+
1342
## From Version 3.4.0 to 3.5.0
1443

1544
### LUKS cex
@@ -110,32 +139,6 @@ The `luks` section gained a new `openOptions` field. It is a list of options Ign
110139
}
111140
```
112141

113-
### Special mode bits supported
114-
115-
The `mode` field of the `files` and `directories` sections now respects the setuid, setgid, and sticky bits. Previous spec versions ignore these bits, but will generate a warning on Ignition ≥ 2.14.0.
116-
117-
<!-- ignition -->
118-
```json
119-
{
120-
"ignition": {
121-
"version": "3.4.0"
122-
},
123-
"storage": {
124-
"files": [{
125-
"path": "/usr/local/bin/setuid",
126-
"contents": {
127-
"source": "https://rootkit.example.com/setuid"
128-
},
129-
"mode": 2541
130-
}],
131-
"directories": [{
132-
"path": "/var/local/tmp",
133-
"mode": 1023
134-
}]
135-
}
136-
}
137-
```
138-
139142
### AWS S3 access point ARN support
140143

141144
The sections which allow fetching a remote URL now accept AWS S3 access point ARNs (`arn:aws:s3:<region>:<account>:accesspoint/<accesspoint>/object/<path>`) in the `source` field.

0 commit comments

Comments
 (0)