Skip to content

Commit bab807c

Browse files
irishgordoYu-Jack
authored andcommitted
docs: Adjust Settings Value Examples
* adjust settings value examples, in YAML wrapping {} JSON blobs will need to be done with something like single-quotes '', and have other content escaped where applicable Resolves: docs/adj-settings See also: harvester/harvester#7456 Signed-off-by: Mike Russell <[email protected]>
1 parent daf1662 commit bab807c

File tree

2 files changed

+78
-78
lines changed

2 files changed

+78
-78
lines changed

docs/advanced/settings.md

Lines changed: 32 additions & 32 deletions
Original file line numberDiff line numberDiff line change
@@ -68,12 +68,12 @@ Use the field `expiringInHours` to specify the validity period of each certifica
6868

6969
For more information, see the **Certificate Rotation** section of the [Rancher](https://ranchermanager.docs.rancher.com/how-to-guides/new-user-guides/manage-clusters/rotate-certificates) and [RKE2](https://docs.rke2.io/advanced#certificate-rotation) documentation.
7070

71-
**Default value**: `{"enable":false,"expiringInHours":240}`
71+
**Default value**: `'{"enable":false,"expiringInHours":240}'`
7272

7373
**Example**:
7474

7575
```
76-
{"enable":true,"expiringInHours":48}
76+
'{"enable":true,"expiringInHours":48}'
7777
```
7878

7979
### `backup-target`
@@ -87,7 +87,7 @@ For more information, see the [Longhorn documentation](https://longhorn.io/docs/
8787
**Example**:
8888

8989
```json
90-
{
90+
'{
9191
"type": "s3",
9292
"endpoint": "https://s3.endpoint.svc",
9393
"accessKeyId": "test-access-key-id",
@@ -96,7 +96,7 @@ For more information, see the [Longhorn documentation](https://longhorn.io/docs/
9696
"bucketRegion": "us‑east‑2",
9797
"cert": "",
9898
"virtualHostedStyle": false
99-
}
99+
}'
100100
```
101101

102102
### `cluster-registration-url`
@@ -133,7 +133,7 @@ For security purposes, Harvester automatically removes the username and password
133133
![containerd-registry](/img/v1.2/advanced/containerd-registry.png)
134134

135135
```json
136-
{
136+
'{
137137
"Mirrors": {
138138
"docker.io": {
139139
"Endpoints": ["https://myregistry.local:5000"],
@@ -151,7 +151,7 @@ For security purposes, Harvester automatically removes the username and password
151151
}
152152
}
153153
}
154-
}
154+
}'
155155
```
156156

157157
### `csi-driver-config`
@@ -169,12 +169,12 @@ You must configure the following information before using features related to ba
169169
**Default value**:
170170

171171
```
172-
{
172+
'{
173173
"driver.longhorn.io": {
174174
"volumeSnapshotClassName": "longhorn-snapshot",
175175
"backupVolumeSnapshotClassName": "longhorn"
176176
}
177-
}
177+
}'
178178
```
179179

180180
### `default-vm-termination-grace-period-seconds`
@@ -197,7 +197,7 @@ Changing this setting might cause single-node clusters to temporarily become una
197197

198198
:::
199199

200-
**Default value**: `{}`
200+
**Default value**: `'{}'`
201201

202202
**Supported options and values**:
203203

@@ -217,11 +217,11 @@ Harvester appends necessary addresses to user-specified `noProxy` values (for ex
217217
**Example**:
218218

219219
```json
220-
{
220+
'{
221221
"httpProxy": "http://my.proxy",
222222
"httpsProxy": "https://my.proxy",
223223
"noProxy": "some.internal.svc,172.16.0.0/16"
224-
}
224+
}'
225225
```
226226

227227
### `log-level`
@@ -294,12 +294,12 @@ Changes to the server address list are applied to all nodes.
294294
**Example**:
295295

296296
```
297-
{
297+
'{
298298
"ntpServers": [
299299
"0.suse.pool.ntp.org",
300300
"1.suse.pool.ntp.org"
301301
]
302-
}
302+
}'
303303
```
304304

305305
### `overcommit-config`
@@ -308,7 +308,7 @@ Changes to the server address list are applied to all nodes.
308308

309309
Overcommitting is used to optimize physical resource allocation, particularly when VMs are not expected to fully consume the allocated resources most of the time. Setting values greater than 100% allows scheduling of multiple VMs even when physical resources are notionally fully allocated.
310310

311-
**Default values**: `{ "cpu":1600, "memory":150, "storage":200 }`
311+
**Default values**: `'{"cpu":1600, "memory":150, "storage":200}'`
312312

313313
With the default values, it would be possible to schedule the following:
314314

@@ -321,11 +321,11 @@ A VM that is configured to use 2 CPUs (equivalent to 2,000 milliCPU) can consume
321321
**Example**:
322322

323323
```json
324-
{
324+
'{
325325
"cpu": 1000,
326326
"memory": 200,
327327
"storage": 300
328-
}
328+
}'
329329
```
330330

331331
### `additional-guest-memory-overhead-ratio`
@@ -489,16 +489,16 @@ Changing this setting might cause single-node clusters to temporarily become una
489489

490490
:::
491491

492-
**Default value**: `{}`
492+
**Default value**: `'{}'`
493493

494494
**Example**:
495495

496496
```json
497-
{
497+
'{
498498
"ca": "-----BEGIN CERTIFICATE-----\nSOME-CERTIFICATE-ENCODED-IN-PEM-FORMAT\n-----END CERTIFICATE-----",
499499
"publicCertificate": "-----BEGIN CERTIFICATE-----\nSOME-CERTIFICATE-ENCODED-IN-PEM-FORMAT\n-----END CERTIFICATE-----",
500500
"privateKey": "-----BEGIN RSA PRIVATE KEY-----\nSOME-PRIVATE-KEY-ENCODED-IN-PEM-FORMAT\n-----END RSA PRIVATE KEY-----"
501-
}
501+
}'
502502
```
503503

504504
### `ssl-parameters`
@@ -525,10 +525,10 @@ If you do not specify any values, Harvester uses `TLSv1.2` and `ECDHE-ECDSA-AES1
525525
**Example**:
526526

527527
```
528-
{
528+
'{
529529
"protocols": "TLSv1.2 TLSv1.3",
530530
"ciphers": "ECDHE-ECDSA-AES128-GCM-SHA256:ECDHE-ECDSA-CHACHA20-POLY1305"
531-
}
531+
}'
532532
```
533533

534534
### `storage-network`
@@ -550,11 +550,11 @@ Specify an IP range in the IPv4 CIDR format. The number of IPs must be four time
550550
**Example**:
551551

552552
```
553-
{
553+
'{
554554
"vlan": 100,
555555
"clusterNetwork": "storage",
556556
"range": "192.168.0.0/24"
557-
}
557+
}'
558558
```
559559

560560
### `support-bundle-image`
@@ -570,11 +570,11 @@ Specify an IP range in the IPv4 CIDR format. The number of IPs must be four time
570570
In this example, the default image tag of the cluster is `v0.0.25`.
571571

572572
```
573-
{
573+
'{
574574
"repository": "rancher/support-bundle-kit",
575575
"tag": "v0.0.25",
576576
"imagePullPolicy": "IfNotPresent"
577-
}
577+
}'
578578
```
579579

580580
**Supported options and values**:
@@ -809,15 +809,15 @@ https://your.upgrade.checker-url/v99/checkupgrade
809809
**Example**:
810810

811811
```json
812-
{
812+
'{
813813
"imagePreloadOption": {
814814
"strategy": {
815815
"type": "parallel",
816816
"concurrency": 2
817817
}
818818
},
819819
"restoreVM": true
820-
}
820+
}'
821821
```
822822

823823
### `vip-pools`
@@ -826,15 +826,15 @@ https://your.upgrade.checker-url/v99/checkupgrade
826826

827827
**Definition**: Global or namespace-specific IP address pools of the VIP by CIDR or IP range.
828828

829-
**Default value**: `{}`
829+
**Default value**: `'{}'`
830830

831831
**Example**:
832832

833833
```json
834-
{
834+
'{
835835
"default": "172.16.0.0/24,172.16.1.0/24",
836836
"demo": "172.16.2.50-172.16.2.100,172.16.2.150-172.16.3.200"
837-
}
837+
}'
838838
```
839839

840840
### `vm-force-reset-policy`
@@ -850,10 +850,10 @@ When the node becomes unavailable or is powered off, the VM only restarts and do
850850
**Example**:
851851

852852
```json
853-
{
853+
'{
854854
"enable": "true",
855855
"period": 300
856-
}
856+
}'
857857
```
858858

859859
### `volume-snapshot-class`

0 commit comments

Comments
 (0)