diff --git a/docs/advanced/settings.md b/docs/advanced/settings.md index 0f308fb6f8f..bd99086cb94 100644 --- a/docs/advanced/settings.md +++ b/docs/advanced/settings.md @@ -68,12 +68,12 @@ Use the field `expiringInHours` to specify the validity period of each certifica 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. -**Default value**: `{"enable":false,"expiringInHours":240}` +**Default value**: `'{"enable":false,"expiringInHours":240}'` **Example**: ``` -{"enable":true,"expiringInHours":48} +'{"enable":true,"expiringInHours":48}' ``` ### `backup-target` @@ -87,7 +87,7 @@ For more information, see the [Longhorn documentation](https://longhorn.io/docs/ **Example**: ```json -{ +'{ "type": "s3", "endpoint": "https://s3.endpoint.svc", "accessKeyId": "test-access-key-id", @@ -96,7 +96,7 @@ For more information, see the [Longhorn documentation](https://longhorn.io/docs/ "bucketRegion": "us‑east‑2", "cert": "", "virtualHostedStyle": false -} +}' ``` ### `cluster-registration-url` @@ -133,7 +133,7 @@ For security purposes, Harvester automatically removes the username and password ![containerd-registry](/img/v1.2/advanced/containerd-registry.png) ```json -{ +'{ "Mirrors": { "docker.io": { "Endpoints": ["https://myregistry.local:5000"], @@ -151,7 +151,7 @@ For security purposes, Harvester automatically removes the username and password } } } -} +}' ``` ### `csi-driver-config` @@ -169,12 +169,12 @@ You must configure the following information before using features related to ba **Default value**: ``` -{ +'{ "driver.longhorn.io": { "volumeSnapshotClassName": "longhorn-snapshot", "backupVolumeSnapshotClassName": "longhorn" } -} +}' ``` ### `default-vm-termination-grace-period-seconds` @@ -197,7 +197,7 @@ Changing this setting might cause single-node clusters to temporarily become una ::: -**Default value**: `{}` +**Default value**: `'{}'` **Supported options and values**: @@ -217,11 +217,11 @@ Harvester appends necessary addresses to user-specified `noProxy` values (for ex **Example**: ```json -{ +'{ "httpProxy": "http://my.proxy", "httpsProxy": "https://my.proxy", "noProxy": "some.internal.svc,172.16.0.0/16" -} +}' ``` ### `log-level` @@ -294,12 +294,12 @@ Changes to the server address list are applied to all nodes. **Example**: ``` -{ +'{ "ntpServers": [ "0.suse.pool.ntp.org", "1.suse.pool.ntp.org" ] -} +}' ``` ### `overcommit-config` @@ -308,7 +308,7 @@ Changes to the server address list are applied to all nodes. 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. -**Default values**: `{ "cpu":1600, "memory":150, "storage":200 }` +**Default values**: `'{"cpu":1600, "memory":150, "storage":200}'` With the default values, it would be possible to schedule the following: @@ -321,11 +321,11 @@ A VM that is configured to use 2 CPUs (equivalent to 2,000 milliCPU) can consume **Example**: ```json -{ +'{ "cpu": 1000, "memory": 200, "storage": 300 -} +}' ``` ### `additional-guest-memory-overhead-ratio` @@ -489,16 +489,16 @@ Changing this setting might cause single-node clusters to temporarily become una ::: -**Default value**: `{}` +**Default value**: `'{}'` **Example**: ```json -{ +'{ "ca": "-----BEGIN CERTIFICATE-----\nSOME-CERTIFICATE-ENCODED-IN-PEM-FORMAT\n-----END CERTIFICATE-----", "publicCertificate": "-----BEGIN CERTIFICATE-----\nSOME-CERTIFICATE-ENCODED-IN-PEM-FORMAT\n-----END CERTIFICATE-----", "privateKey": "-----BEGIN RSA PRIVATE KEY-----\nSOME-PRIVATE-KEY-ENCODED-IN-PEM-FORMAT\n-----END RSA PRIVATE KEY-----" -} +}' ``` ### `ssl-parameters` @@ -525,10 +525,10 @@ If you do not specify any values, Harvester uses `TLSv1.2` and `ECDHE-ECDSA-AES1 **Example**: ``` -{ +'{ "protocols": "TLSv1.2 TLSv1.3", "ciphers": "ECDHE-ECDSA-AES128-GCM-SHA256:ECDHE-ECDSA-CHACHA20-POLY1305" -} +}' ``` ### `storage-network` @@ -550,11 +550,11 @@ Specify an IP range in the IPv4 CIDR format. The number of IPs must be four time **Example**: ``` -{ +'{ "vlan": 100, "clusterNetwork": "storage", "range": "192.168.0.0/24" -} +}' ``` ### `support-bundle-image` @@ -570,11 +570,11 @@ Specify an IP range in the IPv4 CIDR format. The number of IPs must be four time In this example, the default image tag of the cluster is `v0.0.25`. ``` -{ +'{ "repository": "rancher/support-bundle-kit", "tag": "v0.0.25", "imagePullPolicy": "IfNotPresent" -} +}' ``` **Supported options and values**: @@ -809,7 +809,7 @@ https://your.upgrade.checker-url/v99/checkupgrade **Example**: ```json -{ +'{ "imagePreloadOption": { "strategy": { "type": "parallel", @@ -817,7 +817,7 @@ https://your.upgrade.checker-url/v99/checkupgrade } }, "restoreVM": true -} +}' ``` ### `vip-pools` @@ -826,15 +826,15 @@ https://your.upgrade.checker-url/v99/checkupgrade **Definition**: Global or namespace-specific IP address pools of the VIP by CIDR or IP range. -**Default value**: `{}` +**Default value**: `'{}'` **Example**: ```json -{ +'{ "default": "172.16.0.0/24,172.16.1.0/24", "demo": "172.16.2.50-172.16.2.100,172.16.2.150-172.16.3.200" -} +}' ``` ### `vm-force-reset-policy` @@ -850,10 +850,10 @@ When the node becomes unavailable or is powered off, the VM only restarts and do **Example**: ```json -{ +'{ "enable": "true", "period": 300 -} +}' ``` ### `volume-snapshot-class` diff --git a/versioned_docs/version-v1.5/advanced/settings.md b/versioned_docs/version-v1.5/advanced/settings.md index 0f308fb6f8f..6efd9acc022 100644 --- a/versioned_docs/version-v1.5/advanced/settings.md +++ b/versioned_docs/version-v1.5/advanced/settings.md @@ -68,17 +68,17 @@ Use the field `expiringInHours` to specify the validity period of each certifica 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. -**Default value**: `{"enable":false,"expiringInHours":240}` +**Default value**: `'{"enable":false,"expiringInHours":240}'` **Example**: ``` -{"enable":true,"expiringInHours":48} +'{"enable":true,"expiringInHours":48}' ``` ### `backup-target` -**Definition**: Custom backup target used to store VM backups. +**Definition**: Custom backup target used to store VM backups. For more information, see the [Longhorn documentation](https://longhorn.io/docs/1.6.0/snapshots-and-backups/backup-and-restore/set-backup-target/#set-up-aws-s3-backupstore). @@ -87,7 +87,7 @@ For more information, see the [Longhorn documentation](https://longhorn.io/docs/ **Example**: ```json -{ +'{ "type": "s3", "endpoint": "https://s3.endpoint.svc", "accessKeyId": "test-access-key-id", @@ -96,7 +96,7 @@ For more information, see the [Longhorn documentation](https://longhorn.io/docs/ "bucketRegion": "us‑east‑2", "cert": "", "virtualHostedStyle": false -} +}' ``` ### `cluster-registration-url` @@ -122,7 +122,7 @@ https://172.16.0.1/v3/import/w6tp7dgwjj549l88pr7xmxb4x6m54v5kcplvhbp9vv2wzqrrjhr ### `containerd-registry` -**Definition**: Configuration of a private registry created for the Harvester cluster. +**Definition**: Configuration of a private registry created for the Harvester cluster. The value is stored in the `registries.yaml` file of each node (path: `/etc/rancher/rke2/registries.yaml`). For more information, see [Containerd Registry Configuration](https://docs.rke2.io/install/private_registry) in the RKE2 documentation. @@ -133,7 +133,7 @@ For security purposes, Harvester automatically removes the username and password ![containerd-registry](/img/v1.2/advanced/containerd-registry.png) ```json -{ +'{ "Mirrors": { "docker.io": { "Endpoints": ["https://myregistry.local:5000"], @@ -151,7 +151,7 @@ For security purposes, Harvester automatically removes the username and password } } } -} +}' ``` ### `csi-driver-config` @@ -169,12 +169,12 @@ You must configure the following information before using features related to ba **Default value**: ``` -{ +'{ "driver.longhorn.io": { "volumeSnapshotClassName": "longhorn-snapshot", "backupVolumeSnapshotClassName": "longhorn" } -} +}' ``` ### `default-vm-termination-grace-period-seconds` @@ -197,7 +197,7 @@ Changing this setting might cause single-node clusters to temporarily become una ::: -**Default value**: `{}` +**Default value**: `'{}'` **Supported options and values**: @@ -205,7 +205,7 @@ Changing this setting might cause single-node clusters to temporarily become una - Proxy URL for HTTPS requests: `"httpsProxy": "https://:@:"` - Comma-separated list of hostnames and/or CIDRs: `"noProxy": ""` -You must specify key information in the `noProxy` field if you configured the following options or settings: +You must specify key information in the `noProxy` field if you configured the following options or settings: | Configured option/setting | Required value in `noProxy` | Reason | | --- | --- | --- | @@ -217,11 +217,11 @@ Harvester appends necessary addresses to user-specified `noProxy` values (for ex **Example**: ```json -{ +'{ "httpProxy": "http://my.proxy", "httpsProxy": "https://my.proxy", "noProxy": "some.internal.svc,172.16.0.0/16" -} +}' ``` ### `log-level` @@ -252,7 +252,7 @@ debug **Definition**: Setting that enables and disables the Longhorn V2 Data Engine. -When set to `true`, Harvester automatically loads the kernel modules required by the Longhorn V2 Data Engine, and attempts to allocate 1024 × 2 MiB-sized huge pages (for example, 2 GiB of RAM) on all nodes. +When set to `true`, Harvester automatically loads the kernel modules required by the Longhorn V2 Data Engine, and attempts to allocate 1024 × 2 MiB-sized huge pages (for example, 2 GiB of RAM) on all nodes. Changing this setting automatically restarts RKE2 on all nodes but does not affect running virtual machine workloads. @@ -261,7 +261,7 @@ Changing this setting automatically restarts RKE2 on all nodes but does not affe If you encounter error messages that include the phrase "not enough hugepages-2Mi capacity", allow some time for the error to be resolved. If the error persists, reboot the affected nodes. To disable the Longhorn V2 Data Engine on specific nodes (for example, nodes with less processing and memory resources), go to the **Hosts** screen and add the following label to the target nodes: - + - label: `node.longhorn.io/disable-v2-data-engine` - value: `true` @@ -294,21 +294,21 @@ Changes to the server address list are applied to all nodes. **Example**: ``` -{ +'{ "ntpServers": [ "0.suse.pool.ntp.org", "1.suse.pool.ntp.org" ] -} +}' ``` ### `overcommit-config` **Definition**: Percentage of physical compute, memory, and storage resources that can be allocated for VM use. -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. +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. -**Default values**: `{ "cpu":1600, "memory":150, "storage":200 }` +**Default values**: `'{"cpu":1600, "memory":150, "storage":200}'` With the default values, it would be possible to schedule the following: @@ -321,11 +321,11 @@ A VM that is configured to use 2 CPUs (equivalent to 2,000 milliCPU) can consume **Example**: ```json -{ +'{ "cpu": 1000, "memory": 200, "storage": 300 -} +}' ``` ### `additional-guest-memory-overhead-ratio` @@ -489,16 +489,16 @@ Changing this setting might cause single-node clusters to temporarily become una ::: -**Default value**: `{}` +**Default value**: `'{}'` **Example**: ```json -{ +'{ "ca": "-----BEGIN CERTIFICATE-----\nSOME-CERTIFICATE-ENCODED-IN-PEM-FORMAT\n-----END CERTIFICATE-----", "publicCertificate": "-----BEGIN CERTIFICATE-----\nSOME-CERTIFICATE-ENCODED-IN-PEM-FORMAT\n-----END CERTIFICATE-----", "privateKey": "-----BEGIN RSA PRIVATE KEY-----\nSOME-PRIVATE-KEY-ENCODED-IN-PEM-FORMAT\n-----END RSA PRIVATE KEY-----" -} +}' ``` ### `ssl-parameters` @@ -515,7 +515,7 @@ If you misconfigure this setting and are unable to access the Harvester UI and A **Supported options and values**: -- `protocols`: Enabled protocols. +- `protocols`: Enabled protocols. - `ciphers`: Enabled ciphers. For more information about the supported options, see [`ssl-protocols`](https://kubernetes.github.io/ingress-nginx/user-guide/nginx-configuration/configmap/#ssl-protocols) and [`ssl-ciphers`](https://kubernetes.github.io/ingress-nginx/user-guide/nginx-configuration/configmap/#ssl-ciphers) in the Ingress-Nginx Controller documentation. @@ -525,10 +525,10 @@ If you do not specify any values, Harvester uses `TLSv1.2` and `ECDHE-ECDSA-AES1 **Example**: ``` -{ +'{ "protocols": "TLSv1.2 TLSv1.3", "ciphers": "ECDHE-ECDSA-AES128-GCM-SHA256:ECDHE-ECDSA-CHACHA20-POLY1305" -} +}' ``` ### `storage-network` @@ -550,11 +550,11 @@ Specify an IP range in the IPv4 CIDR format. The number of IPs must be four time **Example**: ``` -{ +'{ "vlan": 100, "clusterNetwork": "storage", "range": "192.168.0.0/24" -} +}' ``` ### `support-bundle-image` @@ -570,11 +570,11 @@ Specify an IP range in the IPv4 CIDR format. The number of IPs must be four time In this example, the default image tag of the cluster is `v0.0.25`. ``` -{ +'{ "repository": "rancher/support-bundle-kit", "tag": "v0.0.25", "imagePullPolicy": "IfNotPresent" -} +}' ``` **Supported options and values**: @@ -686,7 +686,7 @@ When the cluster is upgraded in the future, the contents of the `value` field ma **Versions**: v1.2.0 and later -**Definition**: Additional namespaces that you can use when [generating a support bundle](../troubleshooting/harvester.md#generate-a-support-bundle). +**Definition**: Additional namespaces that you can use when [generating a support bundle](../troubleshooting/harvester.md#generate-a-support-bundle). By default, the support bundle only collects resources from the following predefined namespaces: @@ -729,7 +729,7 @@ You can specify a value greater than or equal to 0. When the value is 0, Harvest **Versions**: v1.3.1 and later -**Definition**: Number of minutes Harvester allows for collection of logs and configurations (Harvester) on the nodes for the support bundle. +**Definition**: Number of minutes Harvester allows for collection of logs and configurations (Harvester) on the nodes for the support bundle. If the collection process is not completed within the allotted time, Harvester still allows you to download the support bundle (without the uncollected data). You can specify a value greater than or equal to 0. When the value is 0, Harvester uses the default value. @@ -770,7 +770,7 @@ https://your.upgrade.checker-url/v99/checkupgrade **Supported options and fields**: - `imagePreloadOption`: Options for the image preloading phase. - + The full ISO contains the core operating system components and all required container images. Harvester can preload these container images to each node during installation and upgrades. When workloads are scheduled to management and worker nodes, the container images are ready to use. - `strategy`: Image preload strategy. @@ -786,10 +786,10 @@ https://your.upgrade.checker-url/v99/checkupgrade If you decide to use `skip`, ensure that the following requirements are met: - You have a private container registry that contains all required images. - - Your cluster has high-speed internet access and is able to pull all images from Docker Hub when necessary. - + - Your cluster has high-speed internet access and is able to pull all images from Docker Hub when necessary. + Note any potential internet service interruptions and how close you are to reaching your [Docker Hub rate limit](https://www.docker.com/increase-rate-limits/). Failure to download any of the required images may cause the upgrade to fail and may leave the cluster in a middle state. - + ::: - `parallel` (**experimental**): Nodes preload images in batches. You can adjust this using the `concurrency` option. @@ -809,7 +809,7 @@ https://your.upgrade.checker-url/v99/checkupgrade **Example**: ```json -{ +'{ "imagePreloadOption": { "strategy": { "type": "parallel", @@ -817,7 +817,7 @@ https://your.upgrade.checker-url/v99/checkupgrade } }, "restoreVM": true -} +}' ``` ### `vip-pools` @@ -826,20 +826,20 @@ https://your.upgrade.checker-url/v99/checkupgrade **Definition**: Global or namespace-specific IP address pools of the VIP by CIDR or IP range. -**Default value**: `{}` +**Default value**: `'{}'` **Example**: ```json -{ +'{ "default": "172.16.0.0/24,172.16.1.0/24", "demo": "172.16.2.50-172.16.2.100,172.16.2.150-172.16.3.200" -} +}' ``` ### `vm-force-reset-policy` -**Definition**: Setting that allows you to force rescheduling of a VM when the node that it is running on becomes unavailable. +**Definition**: Setting that allows you to force rescheduling of a VM when the node that it is running on becomes unavailable. When the state of the node changes to `Not Ready`, the VM is force deleted and rescheduled to an available node after the configured number of seconds. @@ -850,10 +850,10 @@ When the node becomes unavailable or is powered off, the VM only restarts and do **Example**: ```json -{ +'{ "enable": "true", "period": 300 -} +}' ``` ### `volume-snapshot-class`