mirrors/talos
1
0
Fork 0
mirror of https://github.com/siderolabs/talos.git synced 2025-08-15 11:07:03 +02:00
Code Issues Packages Projects Releases Wiki Activity

docs: document omitting DiskPartition size

Browse Source 
Documents the effect of omitting the size of a DiskPartition.

Closes talos-systems/talos#3014

Signed-off-by: Brandon McNama <brandonmcnama@outlook.com>
This commit is contained in:
Brandon McNama 2021-01-03 00:19:32 -05:00 committed by talos-bot
parent 5325a66e3e
commit d455f917fb
5 changed files with 11 additions and 15 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

5
pkg/machinery/config/types/v1alpha1/v1alpha1_types.go
View File

@ -986,8 +986,9 @@ func (ds *DiskSize) UnmarshalYAML(unmarshal func(interface{}) error) error {
// DiskPartition represents the options for a disk partition. // DiskPartition represents the options for a disk partition.
type DiskPartition struct { type DiskPartition struct {
// description: | // description: >
// This size of partition: either bytes or human readable representation. // The size of partition: either bytes or human readable representation. If `size:`
// is omitted, the partition is sized to occupy the full disk.
// examples: // examples:
// - name: Human readable representation. // - name: Human readable representation.
// value: DiskSize(100000000) // value: DiskSize(100000000)

4
pkg/machinery/config/types/v1alpha1/v1alpha1_types_doc.go
View File

@ -873,8 +873,8 @@ func init() {
DiskPartitionDoc.Fields[0].Name = "size" DiskPartitionDoc.Fields[0].Name = "size"
DiskPartitionDoc.Fields[0].Type = "DiskSize" DiskPartitionDoc.Fields[0].Type = "DiskSize"
DiskPartitionDoc.Fields[0].Note = "" DiskPartitionDoc.Fields[0].Note = ""
DiskPartitionDoc.Fields[0].Description = "This size of partition: either bytes or human readable representation." DiskPartitionDoc.Fields[0].Description = "The size of partition: either bytes or human readable representation. If `size:` is omitted, the partition is sized to occupy the full disk."
DiskPartitionDoc.Fields[0].Comments[encoder.LineComment] = "This size of partition: either bytes or human readable representation." DiskPartitionDoc.Fields[0].Comments[encoder.LineComment] = "The size of partition: either bytes or human readable representation. If `size:` is omitted, the partition is sized to occupy the full disk."
DiskPartitionDoc.Fields[0].AddExample("Human readable representation.", DiskSize(100000000)) DiskPartitionDoc.Fields[0].AddExample("Human readable representation.", DiskSize(100000000))

2
website/content/docs/v0.6/Reference/configuration.md
View File

@ -1161,7 +1161,7 @@ Type: `array`
#### size #### size
This size of the partition in bytes. The size of the partition in bytes. If `size:` is omitted, the partition is sized to occupy the full disk.
Type: `uint` Type: `uint`

9
website/content/docs/v0.7/Reference/configuration.md
View File

@ -394,7 +394,7 @@ disks:
partitions: partitions:
- mountpoint: /var/mnt/extra # Where to mount the partition. - mountpoint: /var/mnt/extra # Where to mount the partition.
# # This size of partition: either bytes or human readable representation. # # The size of partition: either bytes or human readable representation. Setting this to <code>0</code> will cause the parititon to take up the rest of the disk.
# # Human readable representation. # # Human readable representation.
# size: 100 MB # size: 100 MB
@ -2451,8 +2451,7 @@ Appears in:
</div> </div>
<div class="dt"> <div class="dt">
This size of partition: either bytes or human readable representation. The size of partition: either bytes or human readable representation. If `size:` is omitted, the partition is sized to occupy the full disk.
Examples: Examples:
@ -3732,7 +3731,3 @@ Skip TLS server certificate verification (not recommended).
</div> </div>
<hr /> <hr />

6
website/content/docs/v0.8/Reference/configuration.md
View File

@ -398,7 +398,7 @@ disks:
partitions: partitions:
- mountpoint: /var/mnt/extra # Where to mount the partition. - mountpoint: /var/mnt/extra # Where to mount the partition.
# # This size of partition: either bytes or human readable representation. # # The size of partition: either bytes or human readable representation. If `size:` is omitted, the partition is sized to occupy the full disk.
# # Human readable representation. # # Human readable representation.
# size: 100 MB # size: 100 MB
@ -2446,7 +2446,7 @@ Appears in:
partitions: partitions:
- mountpoint: /var/mnt/extra # Where to mount the partition. - mountpoint: /var/mnt/extra # Where to mount the partition.
# # This size of partition: either bytes or human readable representation. # # The size of partition: either bytes or human readable representation. If `size:` is omitted, the partition is sized to occupy the full disk.
# # Human readable representation. # # Human readable representation.
# size: 100 MB # size: 100 MB
@ -2505,7 +2505,7 @@ Appears in:
</div> </div>
<div class="dt"> <div class="dt">
This size of partition: either bytes or human readable representation. The size of partition: either bytes or human readable representation. If `size:` is omitted, the partition is sized to occupy the full disk.