Skip to content

Commit

Permalink
docs: fix typos
Browse files Browse the repository at this point in the history
Fix yaml key systemDisksEncryption -> systemDiskEncryption

Signed-off-by: Serge Logvinov <serge.logvinov@sinextra.dev>
  • Loading branch information
sergelogvinov authored and talos-bot committed May 2, 2021
1 parent a2bb390 commit 79d804c
Show file tree
Hide file tree
Showing 3 changed files with 33 additions and 33 deletions.
24 changes: 12 additions & 12 deletions website/content/docs/v0.10/Guides/disk-encryption.md
Original file line number Diff line number Diff line change
Expand Up @@ -32,15 +32,15 @@ To enable disk encryption you should modify the machine configuration with the f
```yaml
machine:
...
systemDisksEncryption:
systemDiskEncryption:
ephemeral:
keys:
- nodeID:
keySlot: 0
- nodeID: {}
slot: 0
state:
keys:
- nodeID:
keySlot: 0
- nodeID: {}
slot: 0
```
### Encryption Keys
Expand All @@ -52,21 +52,21 @@ LUKS2 supports up to 32 encryption keys and it is possible to specify all of the
Talos always tries to sync the keys list defined in the machine config with the actual keys defined for the LUKS2 partition.
So if you update the keys list you should have at least one key that is not changed to be used for keys management.
When you define a key you should specify the key kind and the `keySlot`:
When you define a key you should specify the key kind and the `slot`:

```yaml
machine:
...
state:
keys:
- nodeID: # key kind
keySlot: 1
- nodeID: {} # key kind
slot: 1
ephemeral:
keys:
- static:
passphrase: supersecret
keySlot: 0
slot: 0
```

Take a note that key order does not play any role on which key slot is used.
Expand Down Expand Up @@ -95,10 +95,10 @@ machine:
keys:
- static:
passphrase: oldkey
keySlot: 0
slot: 0
- static:
passphrase: newkey
keySlot: 1
slot: 1
...
```

Expand All @@ -117,7 +117,7 @@ machine:
keys:
- static:
passphrase: newkey
keySlot: 1
slot: 1
...
```

Expand Down
24 changes: 12 additions & 12 deletions website/content/docs/v0.11/Guides/disk-encryption.md
Original file line number Diff line number Diff line change
Expand Up @@ -32,15 +32,15 @@ To enable disk encryption you should modify the machine configuration with the f
```yaml
machine:
...
systemDisksEncryption:
systemDiskEncryption:
ephemeral:
keys:
- nodeID:
keySlot: 0
- nodeID: {}
slot: 0
state:
keys:
- nodeID:
keySlot: 0
- nodeID: {}
slot: 0
```
### Encryption Keys
Expand All @@ -52,21 +52,21 @@ LUKS2 supports up to 32 encryption keys and it is possible to specify all of the
Talos always tries to sync the keys list defined in the machine config with the actual keys defined for the LUKS2 partition.
So if you update the keys list you should have at least one key that is not changed to be used for keys management.
When you define a key you should specify the key kind and the `keySlot`:
When you define a key you should specify the key kind and the `slot`:

```yaml
machine:
...
state:
keys:
- nodeID: # key kind
keySlot: 1
- nodeID: {} # key kind
slot: 1
ephemeral:
keys:
- static:
passphrase: supersecret
keySlot: 0
slot: 0
```

Take a note that key order does not play any role on which key slot is used.
Expand Down Expand Up @@ -95,10 +95,10 @@ machine:
keys:
- static:
passphrase: oldkey
keySlot: 0
slot: 0
- static:
passphrase: newkey
keySlot: 1
slot: 1
...
```

Expand All @@ -117,7 +117,7 @@ machine:
keys:
- static:
passphrase: newkey
keySlot: 1
slot: 1
...
```

Expand Down
18 changes: 9 additions & 9 deletions website/content/docs/v0.9/Guides/disk-encryption.md
Original file line number Diff line number Diff line change
Expand Up @@ -32,15 +32,15 @@ To enable disk encryption you should modify the machine configuration with the f
```yaml
machine:
...
systemDisksEncryption:
systemDiskEncryption:
ephemeral:
keys:
- nodeID:
keySlot: 0
- nodeID: {}
slot: 0
state:
keys:
- nodeID:
keySlot: 0
- nodeID: {}
slot: 0
```
### Encryption Keys
Expand All @@ -52,21 +52,21 @@ LUKS2 supports up to 32 encryption keys and it is possible to specify all of the
Talos always tries to sync the keys list defined in the machine config with the actual keys defined for the LUKS2 partition.
So if you update the keys list you should have at least one key that is not changed to be used for keys management.
When you define a key you should specify the key kind and the `keySlot`:
When you define a key you should specify the key kind and the `slot`:

```yaml
machine:
...
state:
keys:
- nodeID: # key kind
keySlot: 1
- nodeID: {} # key kind
slot: 1
ephemeral:
keys:
- static:
passphrase: supersecret
keySlot: 0
slot: 0
```

Take a note that key order does not play any role on which key slot is used.
Expand Down

0 comments on commit 79d804c

Please sign in to comment.