doc: update the ntp configuration (#472)

Signed-off-by: Vicente Cheng <[email protected]>
Co-authored-by: Kiefer Chang <[email protected]>
Co-authored-by: Connor Kuehl <[email protected]>
Co-authored-by: Jillian <[email protected]>

Author: 4 people

docs/host/host.md

@@ -251,3 +251,33 @@ When Ksmtuned starts, initialize `pages_to_scan` in KSM to 1000 (**Minimum Pages
 KSM starts when the available memory falls below the **Threshold Coefficient**. If it detects that it is running, `pages_to_scan` increments by 300 (**Boost**) every minute until it reaches 5000 (**Maximum Pages**).
 
 KSM will stop when the available memory is above the **Threshold Coefficient**. If it detects that it is stopped, `pages_to_scan` decrements by 100 (**Decay**) every minute until it reaches 1000 (**Minimum Pages**).
+
+## NTP Configuration
+
+Time synchronization is an important aspect of distributed cluster architecture. Because of this, Harvester now provides a simpler way for configuring NTP settings.
+
+In previous Harvester versions, NTP settings were mainly configurable [during the installation process](https://docs.harvesterhci.io/v1.2/install/harvester-configuration#osntp_servers). To modify the settings, you needed to manually update the configuration file on each node.
+
+Beginning with version v1.2.0, Harvester is supporting NTP configuration on the Harvester UI Settings screen (**Advanced** > **Settings**). You can configure NTP settings for the entire Harvester cluster at any time, and the settings are applied to all nodes in the cluster.
+
+![](/img/v1.3/host/harvester-ntp-settings.png)
+
+You can set up multiple NTP servers at once.
+
+![](/img/v1.3/host/harvester-ntp-settings-multiple.png)
+
+You can check the settings in the `node.harvesterhci.io/ntp-service` annotation in Kubernetes nodes: 
+- `ntpSyncStatus`: Status of the connection to NTP servers (possible values: `disabled`, `synced` and `unsynced`)
+- `currentNtpServers`: List of existing NTP servers
+
+```
+$ kubectl get nodes harvester-node-0 -o yaml |yq -e '.metadata.annotations.["node.harvesterhci.io/ntp-service"]'
+{"ntpSyncStatus":"synced","currentNtpServers":"0.suse.pool.ntp.org 1.suse.pool.ntp.org"}
+```
+
+> **Note:**
+>
+> 1. Do not modify the NTP configuration file on each node. Harvester will automatically sync the settings that you configured on the Harvester UI to the nodes.
+> 1. If you upgraded Harvester from an earlier version, the **ntp-servers** list on the Settings screen will be empty (see screenshot). You must manually configure the NTP settings because Harvester is unaware of the previous settings and is unable to detect conflicts.
+
+![](/img/v1.3/host/harvester-ntp-settings-empty.png)

docs/install/update-harvester-configuration.md

@@ -69,88 +69,9 @@ If you upgrade from a version before `v1.1.2`, the `cloud-init` file in examples
 
 ## NTP servers
 
-### Runtime change
-
-1. Log in to a Harvester node and become root. See [how to log into a Harvester node](../troubleshooting/os.md#how-to-log-in-to-a-harvester-node) for more details.
-1. Edit `/etc/systemd/timesyncd.conf` and specify NTP servers in the `NTP=` setting:
-
-    ```
-    [Time]
-    NTP = 0.suse.pool.ntp.org 1.suse.pool.ntp.org
-    ```
-
-1. Restart the `systemd-timesyncd.service` service:
-
-    ```
-    systemctl restart systemd-timesyncd.service
-    ```
-
-1. Display the timesync status:
-
-    ```
-    timedatectl timesync-status
-    ```
-
-### Configuration persistence
-
-1. Backup the elemental `cloud-init` file `/oem/90_custom.yaml` as follows:
-
-    ```
-    cp /oem/90_custom.yaml /oem/install/90_custom.yaml.$(date --iso-8601=minutes)
-    ```
-
-1. Edit `/oem/90_custom.yaml` and update the yaml path `stages.initramfs[0].timesyncd`. The `timesyncd` map must be in the following format:
-
-    ```
-    stages:
-      initramfs:
-      - ...
-        timesyncd:
-        NTP: 0.suse.pool.ntp.org 1.suse.pool.ntp.org
-    ```
-
-1. Edit `/oem/90_custom.yaml` and update the yaml path `stages.initramfs[0].systemctl.enable`. The array must have the two services (`systemd-timesyncd` and `systemd-time-wait-sync`) enabled:
-
-    ```
-    stages:
-      initramfs:
-      - ...
-        systemctl:
-        enable:
-            systemd-timesyncd
-            systemd-time-wait-sync
-        disable: []
-        start: []
-        mask: []
-    ```
-
-## SSH keys of user `rancher`
-
-### Runtime change
-
-1. Log in to a Harvester node as user `rancher`. See [how to log into a Harvester node](../troubleshooting/os.md#how-to-log-in-to-a-harvester-node) for more details.
-1. Edit `/home/rancher/.ssh/authorized_keys` to add or remove keys.
-
-### Configuration persistence
-
-1. Backup the elemental `cloud-init` file `/oem/90_custom.yaml` as follows:
-
-    ```
-    cp /oem/90_custom.yaml /oem/install/90_custom.yaml.$(date --iso-8601=minutes)
-    ```
-
-1. Edit `/oem/90_custom.yaml` and update the yaml path `stages.network[0].authorized_keys.rancher`. Add or remove keys in the `rancher` array:
-
-    ```
-    stages:
-      network:
-      - ...
-        authorized_keys:
-          rancher:
-          - key1
-          - key2
-    ```
+We introduce the new mechanism for the NTP configuration in Harvester v1.2.0.
 
+For more information about NTP settings in Harvester v1.2.0 and later versions, see the [NTP servers](../host/host.md#ntp-configuration).
 
 ## Password of user `rancher`
 

static/img/v1.2/host/harvester-ntp-settings-empty.png

@@ -251,3 +251,33 @@ When Ksmtuned starts, initialize `pages_to_scan` in KSM to 1000 (**Minimum Pages
 KSM starts when the available memory falls below the **Threshold Coefficient**. If it detects that it is running, `pages_to_scan` increments by 300 (**Boost**) every minute until it reaches 5000 (**Maximum Pages**).
 
 KSM will stop when the available memory is above the **Threshold Coefficient**. If it detects that it is stopped, `pages_to_scan` decrements by 100 (**Decay**) every minute until it reaches 1000 (**Minimum Pages**).
+
+## NTP Configuration
+
+Time synchronization is an important aspect of distributed cluster architecture. Because of this, Harvester now provides a simpler way for configuring NTP settings.
+
+In previous Harvester versions, NTP settings were mainly configurable [during the installation process](https://docs.harvesterhci.io/v1.2/install/harvester-configuration#osntp_servers). To modify the settings, you needed to manually update the configuration file on each node.
+
+Beginning with version v1.2.0, Harvester is supporting NTP configuration on the Harvester UI Settings screen (**Advanced** > **Settings**). You can configure NTP settings for the entire Harvester cluster at any time, and the settings are applied to all nodes in the cluster.
+
+![](/img/v1.2/host/harvester-ntp-settings.png)
+
+You can set up multiple NTP servers at once.
+
+![](/img/v1.2/host/harvester-ntp-settings-multiple.png)
+
+You can check the settings in the `node.harvesterhci.io/ntp-service` annotation in Kubernetes nodes: 
+- `ntpSyncStatus`: Status of the connection to NTP servers (possible values: `disabled`, `synced` and `unsynced`)
+- `currentNtpServers`: List of existing NTP servers
+
+```
+$ kubectl get nodes harvester-node-0 -o yaml |yq -e '.metadata.annotations.["node.harvesterhci.io/ntp-service"]'
+{"ntpSyncStatus":"synced","currentNtpServers":"0.suse.pool.ntp.org 1.suse.pool.ntp.org"}
+```
+
+> **Note:**
+>
+> 1. Do not modify the NTP configuration file on each node. Harvester will automatically sync the settings that you configured on the Harvester UI to the nodes.
+> 1. If you upgraded Harvester from an earlier version, the **ntp-servers** list on the Settings screen will be empty (see screenshot). You must manually configure the NTP settings because Harvester is unaware of the previous settings and is unable to detect conflicts.
+
+![](/img/v1.2/host/harvester-ntp-settings-empty.png)

static/img/v1.2/host/harvester-ntp-settings-multiple.png

@@ -69,60 +69,9 @@ If you upgrade from a version before `v1.1.2`, the `cloud-init` file in examples
 
 ## NTP servers
 
-### Runtime change
-
-1. Log in to a Harvester node and become root. See [how to log into a Harvester node](../troubleshooting/os.md#how-to-log-in-to-a-harvester-node) for more details.
-1. Edit `/etc/systemd/timesyncd.conf` and specify NTP servers in the `NTP=` setting:
-
-    ```
-    [Time]
-    NTP = 0.suse.pool.ntp.org 1.suse.pool.ntp.org
-    ```
-
-1. Restart the `systemd-timesyncd.service` service:
-
-    ```
-    systemctl restart systemd-timesyncd.service
-    ```
-
-1. Display the timesync status:
-
-    ```
-    timedatectl timesync-status
-    ```
-
-### Configuration persistence
-
-1. Backup the elemental `cloud-init` file `/oem/90_custom.yaml` as follows:
+We introduce the new mechanism for the NTP configuration in Harvester v1.2.0.
 
-    ```
-    cp /oem/90_custom.yaml /oem/install/90_custom.yaml.$(date --iso-8601=minutes)
-    ```
-
-1. Edit `/oem/90_custom.yaml` and update the yaml path `stages.initramfs[0].timesyncd`. The `timesyncd` map must be in the following format:
-
-    ```
-    stages:
-      initramfs:
-      - ...
-        timesyncd:
-        NTP: 0.suse.pool.ntp.org 1.suse.pool.ntp.org
-    ```
-
-1. Edit `/oem/90_custom.yaml` and update the yaml path `stages.initramfs[0].systemctl.enable`. The array must have the two services (`systemd-timesyncd` and `systemd-time-wait-sync`) enabled:
-
-    ```
-    stages:
-      initramfs:
-      - ...
-        systemctl:
-        enable:
-            systemd-timesyncd
-            systemd-time-wait-sync
-        disable: []
-        start: []
-        mask: []
-    ```
+For more information about NTP settings in Harvester v1.2.0 and later versions, see the [NTP servers](../host/host.md#ntp-configuration).
 
 ## SSH keys of user `rancher`