Skip to content

Commit a74d188

Browse files
committed
docs: regen talosctl reference for v1.14.0-alpha*
Whole diff genereted by: make generate-talos-reference-local TALOSCTL_IMAGE=ghcr.io/siderolabs/talosctl:v1.14.0-alpha.1-110-gb34be14e9 TALOS_VERSION=v1.14 Signed-off-by: Maja Bojarska <maja.bojarska@siderolabs.com>
1 parent 6269873 commit a74d188

66 files changed

Lines changed: 2744 additions & 1818 deletions

File tree

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

Makefile

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -8,8 +8,8 @@ DOCS_GEN_IMAGE := ghcr.io/siderolabs/docs-gen:latest
88
DOCS_CONVERT_IMAGE := ghcr.io/siderolabs/docs-convert:latest
99
CHANGELOG_GEN_IMAGE := ghcr.io/siderolabs/changelog-gen:latest
1010
VERSION_UPGRADE_IMAGE := ghcr.io/siderolabs/version-upgrade-gen:latest
11-
TALOSCTL_IMAGE := ghcr.io/siderolabs/talosctl:v1.13.0
12-
TALOS_VERSION := v1.13
11+
TALOSCTL_IMAGE := ghcr.io/siderolabs/talosctl:v1.14.0-alpha.2
12+
TALOS_VERSION := v1.14
1313
VALE_IMAGE := jdkato/vale:latest
1414
VALE_CONFIG ?= .vale.ini
1515

public/talos/v1.14/reference/cli.mdx

Lines changed: 698 additions & 403 deletions
Large diffs are not rendered by default.

public/talos/v1.14/reference/configuration/block/existingvolumeconfig.mdx

Lines changed: 53 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,10 @@
11
---
2-
description: 'ExistingVolumeConfig is an existing volume configuration document. Existing volumes allow to mount partitions (or whole disks) that were created outside of Talos. Volume will be mounted under `/var/mnt/<name>`. The existing volume config name should not conflict with user volume names.'
2+
description: |
3+
ExistingVolumeConfig is an existing volume configuration document.
4+
Existing volumes allow to mount partitions (or whole disks) that were created
5+
outside of Talos. Volume will be mounted under `/var/mnt/<name>`.
6+
The existing volume config name should not conflict with user volume names.
37
title: ExistingVolumeConfig
4-
canonical: https://docs.siderolabs.com/talos/v1.13/reference/configuration/block/existingvolumeconfig
58
---
69

710
{/*
@@ -58,6 +61,12 @@ discovery:
5861
<td>The mount describes additional mount options.</td>
5962
<td></td>
6063
</tr>
64+
<tr>
65+
<td>`trim`</td>
66+
<td><a href="#trim">TrimConfig</a></td>
67+
<td>The trim describes the per-volume filesystem trim (fstrim) configuration.</td>
68+
<td></td>
69+
</tr>
6170
</tbody>
6271
</table>
6372

@@ -70,6 +79,7 @@ VolumeDiscoverySpec describes how the volume is discovered.
7079

7180

7281

82+
7383
<table>
7484
<thead>
7585
<tr>
@@ -98,6 +108,7 @@ VolumeSelector selects an existing volume.
98108

99109

100110

111+
101112
<table>
102113
<thead>
103114
<tr>
@@ -130,6 +141,7 @@ ExistingMountSpec describes how the volume is mounted.
130141

131142

132143

144+
133145
<table>
134146
<thead>
135147
<tr>
@@ -160,3 +172,42 @@ ExistingMountSpec describes how the volume is mounted.
160172
</tr>
161173
</tbody>
162174
</table>
175+
176+
177+
178+
179+
180+
## trim
181+
182+
TrimConfig describes per-volume filesystem trim (fstrim) configuration.
183+
184+
It overrides the global FilesystemTrimConfig for the volume.
185+
186+
187+
188+
189+
190+
<table>
191+
<thead>
192+
<tr>
193+
<th>Field</th>
194+
<th>Type</th>
195+
<th>Description</th>
196+
<th>Value(s)</th>
197+
</tr>
198+
</thead>
199+
<tbody>
200+
<tr>
201+
<td>`enabled`</td>
202+
<td>bool</td>
203+
<td>Enable or disable trimming for this volume.<br /><br />If not set, trimming is enabled when the global FilesystemTrimConfig is present.</td>
204+
<td></td>
205+
</tr>
206+
<tr>
207+
<td>`interval`</td>
208+
<td>Duration</td>
209+
<td>The interval at which the volume is trimmed, overriding the global trim interval.</td>
210+
<td></td>
211+
</tr>
212+
</tbody>
213+
</table>

public/talos/v1.14/reference/configuration/block/externalvolumeconfig.mdx

Lines changed: 7 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,10 @@
11
---
2-
description: 'ExternalVolumeConfig is an external disk mount configuration document. External volumes allow to mount volumes that were created outside of Talos, over the network or API. Volume will be mounted under `/var/mnt/<name>`. The external volume config name should not conflict with user volume names.'
2+
description: |
3+
ExternalVolumeConfig is an external disk mount configuration document.
4+
External volumes allow to mount volumes that were created outside of Talos,
5+
over the network or API. Volume will be mounted under `/var/mnt/<name>`.
6+
The external volume config name should not conflict with user volume names.
37
title: ExternalVolumeConfig
4-
canonical: https://docs.siderolabs.com/talos/v1.13/reference/configuration/block/externalvolumeconfig
58
---
69

710
{/*
@@ -71,6 +74,7 @@ ExternalMountSpec describes how the external volume is mounted.
7174

7275

7376

77+
7478
<table>
7579
<thead>
7680
<tr>
@@ -117,6 +121,7 @@ VirtiofsMountSpec describes Virtiofs mount options.
117121

118122

119123

124+
120125
<table>
121126
<thead>
122127
<tr>
Lines changed: 51 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,51 @@
1+
---
2+
description: |
3+
FilesystemTrimConfig is a filesystem trim (fstrim) configuration document.
4+
Filesystem trim (the equivalent of the `fstrim` command) periodically discards unused blocks
5+
of mounted filesystems which support trimming.
6+
7+
When this document is present, Talos builds a stable per-node, per-volume schedule and trims
8+
eligible volumes at the configured interval. If the document is absent, no automatic trimming
9+
is performed (unless enabled explicitly on a per-volume basis).
10+
title: FilesystemTrimConfig
11+
---
12+
13+
{/*
14+
This file is automatically generated from source documentation.
15+
Do not edit manually. For more information, see https://github.com/siderolabs/docs
16+
*/}
17+
18+
19+
20+
21+
22+
23+
24+
25+
26+
27+
```yaml
28+
apiVersion: v1alpha1
29+
kind: FilesystemTrimConfig
30+
interval: 168h0m0s # The interval at which the filesystems are trimmed.
31+
```
32+
33+
34+
<table>
35+
<thead>
36+
<tr>
37+
<th>Field</th>
38+
<th>Type</th>
39+
<th>Description</th>
40+
<th>Value(s)</th>
41+
</tr>
42+
</thead>
43+
<tbody>
44+
<tr>
45+
<td>`interval`</td>
46+
<td>Duration</td>
47+
<td>The interval at which the filesystems are trimmed.<br /><br />The trim is performed at a stable, hash-derived time within the interval, which is different<br />for each volume and each node, so that trims are spread out over time.</td>
48+
<td></td>
49+
</tr>
50+
</tbody>
51+
</table>

public/talos/v1.14/reference/configuration/block/rawvolumeconfig.mdx

Lines changed: 20 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,11 @@
11
---
2-
description: 'RawVolumeConfig is a raw volume configuration document. Raw volumes allow to create partitions without formatting them. If you want to use local storage, user volumes is a better choice, raw volumes are intended to be used with CSI provisioners. The partition label is automatically generated as `r-<name>`.'
2+
description: |
3+
RawVolumeConfig is a raw volume configuration document.
4+
Raw volumes allow to create partitions without formatting them.
5+
If you want to use local storage, user volumes is a better choice,
6+
raw volumes are intended to be used with CSI provisioners.
7+
The partition label is automatically generated as `r-<name>`.
38
title: RawVolumeConfig
4-
canonical: https://docs.siderolabs.com/talos/v1.13/reference/configuration/block/rawvolumeconfig
59
---
610

711
{/*
@@ -98,6 +102,7 @@ ProvisioningSpec describes how the volume is provisioned.
98102

99103

100104

105+
101106
<table>
102107
<thead>
103108
<tr>
@@ -144,6 +149,7 @@ DiskSelector selects a disk for the volume.
144149

145150

146151

152+
147153
<table>
148154
<thead>
149155
<tr>
@@ -246,7 +252,13 @@ encryption:
246252
<td>`options`</td>
247253
<td>[]string</td>
248254
<td>Additional --perf parameters for the LUKS2 encryption.</td>
249-
<td>`no_read_workqueue`<br />`no_write_workqueue`<br />`same_cpu_crypt`<br /></td>
255+
<td></td>
256+
</tr>
257+
<tr>
258+
<td>`allowDiscards`</td>
259+
<td>bool</td>
260+
<td>Allow TRIM/discard requests to be passed through to the underlying device when the encrypted volume is opened.<br />Defaults to false.</td>
261+
<td></td>
250262
</tr>
251263
</tbody>
252264
</table>
@@ -260,6 +272,7 @@ EncryptionKey represents configuration for disk encryption key.
260272

261273

262274

275+
263276
<table>
264277
<thead>
265278
<tr>
@@ -318,6 +331,7 @@ EncryptionKeyStatic represents throw away key type.
318331

319332

320333

334+
321335
<table>
322336
<thead>
323337
<tr>
@@ -353,6 +367,7 @@ EncryptionKeyNodeID represents deterministically generated key from the node UUI
353367

354368

355369

370+
356371
#### kms
357372

358373
EncryptionKeyKMS represents a key that is generated and then sealed/unsealed by the KMS server.
@@ -397,6 +412,7 @@ EncryptionKeyTPM represents a key that is generated and then sealed/unsealed by
397412

398413

399414

415+
400416
<table>
401417
<thead>
402418
<tr>
@@ -431,6 +447,7 @@ EncryptionKeyTPMOptions represents the options for TPM-based key protection.
431447

432448

433449

450+
434451
<table>
435452
<thead>
436453
<tr>

public/talos/v1.14/reference/configuration/block/swapvolumeconfig.mdx

Lines changed: 19 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,10 @@
11
---
2-
description: 'SwapVolumeConfig is a disk swap volume configuration document. Swap volume is automatically allocated as a partition on the specified disk and activated as swap, removing a swap volume deactivates swap. The partition label is automatically generated as `s-<name>`.'
2+
description: |
3+
SwapVolumeConfig is a disk swap volume configuration document.
4+
Swap volume is automatically allocated as a partition on the specified disk
5+
and activated as swap, removing a swap volume deactivates swap.
6+
The partition label is automatically generated as `s-<name>`.
37
title: SwapVolumeConfig
4-
canonical: https://docs.siderolabs.com/talos/v1.13/reference/configuration/block/swapvolumeconfig
58
---
69

710
{/*
@@ -96,6 +99,7 @@ ProvisioningSpec describes how the volume is provisioned.
9699

97100

98101

102+
99103
<table>
100104
<thead>
101105
<tr>
@@ -142,6 +146,7 @@ DiskSelector selects a disk for the volume.
142146

143147

144148

149+
145150
<table>
146151
<thead>
147152
<tr>
@@ -244,7 +249,13 @@ encryption:
244249
<td>`options`</td>
245250
<td>[]string</td>
246251
<td>Additional --perf parameters for the LUKS2 encryption.</td>
247-
<td>`no_read_workqueue`<br />`no_write_workqueue`<br />`same_cpu_crypt`<br /></td>
252+
<td></td>
253+
</tr>
254+
<tr>
255+
<td>`allowDiscards`</td>
256+
<td>bool</td>
257+
<td>Allow TRIM/discard requests to be passed through to the underlying device when the encrypted volume is opened.<br />Defaults to false.</td>
258+
<td></td>
248259
</tr>
249260
</tbody>
250261
</table>
@@ -258,6 +269,7 @@ EncryptionKey represents configuration for disk encryption key.
258269

259270

260271

272+
261273
<table>
262274
<thead>
263275
<tr>
@@ -316,6 +328,7 @@ EncryptionKeyStatic represents throw away key type.
316328

317329

318330

331+
319332
<table>
320333
<thead>
321334
<tr>
@@ -351,6 +364,7 @@ EncryptionKeyNodeID represents deterministically generated key from the node UUI
351364

352365

353366

367+
354368
#### kms
355369

356370
EncryptionKeyKMS represents a key that is generated and then sealed/unsealed by the KMS server.
@@ -395,6 +409,7 @@ EncryptionKeyTPM represents a key that is generated and then sealed/unsealed by
395409

396410

397411

412+
398413
<table>
399414
<thead>
400415
<tr>
@@ -429,6 +444,7 @@ EncryptionKeyTPMOptions represents the options for TPM-based key protection.
429444

430445

431446

447+
432448
<table>
433449
<thead>
434450
<tr>

0 commit comments

Comments
 (0)