Skip to content

Commit 68ccd00

Browse files
committed
update new config formart and fix desc
1 parent e6ae033 commit 68ccd00

File tree

2 files changed

+50
-15
lines changed

2 files changed

+50
-15
lines changed

docs/install/harvester-configuration.md

Lines changed: 19 additions & 14 deletions
Original file line numberDiff line numberDiff line change
@@ -58,7 +58,8 @@ install:
5858
hwAddr: "B8:CA:3A:6A:64:7C"
5959
method: dhcp
6060
force_efi: true
61-
device: /dev/vda
61+
device: /dev/sda
62+
data_disk: /dev/sdb
6263
silent: true
6364
iso_url: http://myserver/test.iso
6465
poweroff: true
@@ -409,6 +410,8 @@ Force EFI installation even when EFI is not detected. Default: `false`.
409410

410411
The device to install the OS.
411412

413+
Prefer to use `/dev/disk/by-id/$id` or `/dev/disk/by-path/$path` to specify the storage device if your machine contains multiple physical volumes via pxe installation.
414+
412415
### `install.silent`
413416

414417
Reserved.
@@ -506,6 +509,8 @@ _Available as of v1.0.1_
506509

507510
Sets the default storage device to store the VM data.
508511

512+
Prefer to use `/dev/disk/by-id/$id` or `/dev/disk/by-path/$path` to specify the storage device if your machine contains multiple physical volumes via pxe installation.
513+
509514
Default: Same storage device as the one set for [`install.device`](#installdevice)
510515

511516
#### Example
@@ -515,9 +520,9 @@ install:
515520
data_disk: /dev/sdb
516521
```
517522

518-
### `install.harvester.storageClass.replicaCount`
523+
### `install.harvester.storage_class.replica_count`
519524

520-
_Available as of v1.0.2_
525+
_Available as of v1.1.2_
521526

522527
#### Definition
523528

@@ -527,7 +532,7 @@ Default: 3
527532

528533
Supported values: 1, 2, 3. All other values are considered 3.
529534

530-
In edge scenarios where users may deploy single-node Harvester clusters, they can set this value to 1. In most scenarios, it is recommended to keep the default value 3 for system high availability.
535+
In edge scenarios where users may deploy single-node Harvester clusters, they can set this value to 1. In most scenarios, it is recommended to keep the default value 3 for storage high availability.
531536

532537
Please refer to [longhorn-replica-count](https://longhorn.io/docs/1.4.1/references/settings/#default-replica-count) for more details.
533538

@@ -536,17 +541,17 @@ Please refer to [longhorn-replica-count](https://longhorn.io/docs/1.4.1/referenc
536541
```yaml
537542
install:
538543
harvester:
539-
storageClass:
540-
replicaCount: 1
544+
storage_class:
545+
replica_count: 1
541546
```
542547

543-
### `install.harvester.longhorn.defaultSettings.guaranteedEngineManagerCPU`
548+
### `install.harvester.longhorn.default_settings.guaranteedEngineManagerCPU`
544549

545-
_Available as of v1.0.2_
550+
_Available as of v1.2.0_
546551

547552
#### Definition
548553

549-
Sets the default storage class replica count.
554+
Sets the default percentage of the total allocatable CPU on each node will be reserved for each Longhorn engine manager Pod.
550555

551556
Default: 12
552557

@@ -564,17 +569,17 @@ Before setting the value, please refer to [longhorn-guaranteed-engine-manager-cp
564569
install:
565570
harvester:
566571
longhorn:
567-
defaultSettings:
572+
default_settings:
568573
guaranteedEngineManagerCPU: 6
569574
```
570575

571-
### `install.harvester.longhorn.defaultSettings.guaranteedReplicaManagerCPU`
576+
### `install.harvester.longhorn.default_settings.guaranteedReplicaManagerCPU`
572577

573-
_Available as of v1.0.2_
578+
_Available as of v1.2.0_
574579

575580
#### Definition
576581

577-
Sets the default storage class replica count.
582+
Sets the default percentage of the total allocatable CPU on each node will be reserved for each Longhorn replica manager Pod.
578583

579584
Default: 12
580585

@@ -592,7 +597,7 @@ Before setting the value, please refer to [longhorn-guaranteed-replica-manager-c
592597
install:
593598
harvester:
594599
longhorn:
595-
defaultSettings:
600+
default_settings:
596601
guaranteedReplicaManagerCPU: 6
597602
```
598603

versioned_docs/version-v1.1/install/harvester-configuration.md

Lines changed: 31 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -58,7 +58,8 @@ install:
5858
hwAddr: "B8:CA:3A:6A:64:7C"
5959
method: dhcp
6060
force_efi: true
61-
device: /dev/vda
61+
device: /dev/sda
62+
data_disk: /dev/sdb
6263
silent: true
6364
iso_url: http://myserver/test.iso
6465
poweroff: true
@@ -409,6 +410,8 @@ Force EFI installation even when EFI is not detected. Default: `false`.
409410

410411
The device to install the OS.
411412

413+
Prefer to use `/dev/disk/by-id/$id` or `/dev/disk/by-path/$path` to specify the storage device if your machine contains multiple physical volumes via pxe installation.
414+
412415
### `install.silent`
413416

414417
Reserved.
@@ -506,6 +509,8 @@ _Available as of v1.0.1_
506509

507510
Sets the default storage device to store the VM data.
508511

512+
Prefer to use `/dev/disk/by-id/$id` or `/dev/disk/by-path/$path` to specify the storage device if your machine contains multiple physical volumes via pxe installation.
513+
509514
Default: Same storage device as the one set for [`install.device`](#installdevice)
510515

511516
#### Example
@@ -515,6 +520,31 @@ install:
515520
data_disk: /dev/sdb
516521
```
517522

523+
### `install.harvester.storage_class.replica_count`
524+
525+
_Available as of v1.1.2_
526+
527+
#### Definition
528+
529+
Sets the replica count of Harvester's default storage class `harvester-longhorn`.
530+
531+
Default: 3
532+
533+
Supported values: 1, 2, 3. All other values are considered 3.
534+
535+
In edge scenarios where users may deploy single-node Harvester clusters, they can set this value to 1. In most scenarios, it is recommended to keep the default value 3 for storage high availability.
536+
537+
Please refer to [longhorn-replica-count](https://longhorn.io/docs/1.4.1/references/settings/#default-replica-count) for more details.
538+
539+
#### Example
540+
541+
```yaml
542+
install:
543+
harvester:
544+
storage_class:
545+
replica_count: 1
546+
```
547+
518548
### `system_settings`
519549

520550
#### Definition

0 commit comments

Comments
 (0)