diff --git a/static/img/v1.2/troubleshooting-hv/actively-powered-off-vm.png b/static/img/v1.2/troubleshooting-hv/actively-powered-off-vm.png new file mode 100644 index 00000000..d7629936 Binary files /dev/null and b/static/img/v1.2/troubleshooting-hv/actively-powered-off-vm.png differ diff --git a/static/img/v1.2/troubleshooting-hv/edit-boot-parameter-serial.png b/static/img/v1.2/troubleshooting-hv/edit-boot-parameter-serial.png new file mode 100644 index 00000000..3271db1b Binary files /dev/null and b/static/img/v1.2/troubleshooting-hv/edit-boot-parameter-serial.png differ diff --git a/static/img/v1.2/troubleshooting-hv/edit-boot-parameter.png b/static/img/v1.2/troubleshooting-hv/edit-boot-parameter.png new file mode 100644 index 00000000..68c10a6c Binary files /dev/null and b/static/img/v1.2/troubleshooting-hv/edit-boot-parameter.png differ diff --git a/static/img/v1.2/troubleshooting-hv/edit-rancher-monitoring-yaml.png b/static/img/v1.2/troubleshooting-hv/edit-rancher-monitoring-yaml.png new file mode 100644 index 00000000..356331f6 Binary files /dev/null and b/static/img/v1.2/troubleshooting-hv/edit-rancher-monitoring-yaml.png differ diff --git a/static/img/v1.2/troubleshooting-hv/edit-rancher-monitoring.png b/static/img/v1.2/troubleshooting-hv/edit-rancher-monitoring.png new file mode 100644 index 00000000..6fd4b6c5 Binary files /dev/null and b/static/img/v1.2/troubleshooting-hv/edit-rancher-monitoring.png differ diff --git a/static/img/v1.2/troubleshooting-hv/grub-menu-debug.png b/static/img/v1.2/troubleshooting-hv/grub-menu-debug.png new file mode 100644 index 00000000..399e3240 Binary files /dev/null and b/static/img/v1.2/troubleshooting-hv/grub-menu-debug.png differ diff --git a/static/img/v1.2/troubleshooting-hv/grub-menu.png b/static/img/v1.2/troubleshooting-hv/grub-menu.png new file mode 100644 index 00000000..b481e9f3 Binary files /dev/null and b/static/img/v1.2/troubleshooting-hv/grub-menu.png differ diff --git a/static/img/v1.2/troubleshooting-hv/harvester-sb-support-button.png b/static/img/v1.2/troubleshooting-hv/harvester-sb-support-button.png new file mode 100644 index 00000000..b5ccf5ba Binary files /dev/null and b/static/img/v1.2/troubleshooting-hv/harvester-sb-support-button.png differ diff --git a/static/img/v1.2/troubleshooting-hv/harvester-sb-support-link.png b/static/img/v1.2/troubleshooting-hv/harvester-sb-support-link.png new file mode 100644 index 00000000..b649a7e0 Binary files /dev/null and b/static/img/v1.2/troubleshooting-hv/harvester-sb-support-link.png differ diff --git a/static/img/v1.2/troubleshooting-hv/harvester-sb-support-modal.png b/static/img/v1.2/troubleshooting-hv/harvester-sb-support-modal.png new file mode 100644 index 00000000..f00d612c Binary files /dev/null and b/static/img/v1.2/troubleshooting-hv/harvester-sb-support-modal.png differ diff --git a/static/img/v1.2/troubleshooting-hv/installation-support-config-example.png b/static/img/v1.2/troubleshooting-hv/installation-support-config-example.png new file mode 100644 index 00000000..995a9037 Binary files /dev/null and b/static/img/v1.2/troubleshooting-hv/installation-support-config-example.png differ diff --git a/static/img/v1.2/troubleshooting-hv/setting-up-harvester-after-day-0.png b/static/img/v1.2/troubleshooting-hv/setting-up-harvester-after-day-0.png new file mode 100644 index 00000000..25d6f072 Binary files /dev/null and b/static/img/v1.2/troubleshooting-hv/setting-up-harvester-after-day-0.png differ diff --git a/static/img/v1.2/troubleshooting-hv/start-vm-after-vm-is-stopped-from-webui.png b/static/img/v1.2/troubleshooting-hv/start-vm-after-vm-is-stopped-from-webui.png new file mode 100644 index 00000000..93f22ee7 Binary files /dev/null and b/static/img/v1.2/troubleshooting-hv/start-vm-after-vm-is-stopped-from-webui.png differ diff --git a/static/img/v1.2/troubleshooting-hv/start-vm-and-run.png b/static/img/v1.2/troubleshooting-hv/start-vm-and-run.png new file mode 100644 index 00000000..e258685b Binary files /dev/null and b/static/img/v1.2/troubleshooting-hv/start-vm-and-run.png differ diff --git a/static/img/v1.2/troubleshooting-hv/stop-vm-from-webui.png b/static/img/v1.2/troubleshooting-hv/stop-vm-from-webui.png new file mode 100644 index 00000000..51d61c30 Binary files /dev/null and b/static/img/v1.2/troubleshooting-hv/stop-vm-from-webui.png differ diff --git a/static/img/v1.2/troubleshooting-hv/unschedulable-vm.png b/static/img/v1.2/troubleshooting-hv/unschedulable-vm.png new file mode 100644 index 00000000..7a0ba013 Binary files /dev/null and b/static/img/v1.2/troubleshooting-hv/unschedulable-vm.png differ diff --git a/static/img/v1.2/troubleshooting-hv/vm-is-off.png b/static/img/v1.2/troubleshooting-hv/vm-is-off.png new file mode 100644 index 00000000..ad3e8817 Binary files /dev/null and b/static/img/v1.2/troubleshooting-hv/vm-is-off.png differ diff --git a/static/img/v1.2/troubleshooting-hv/vm-start-button-is-not-visible.png b/static/img/v1.2/troubleshooting-hv/vm-start-button-is-not-visible.png new file mode 100644 index 00000000..893b7989 Binary files /dev/null and b/static/img/v1.2/troubleshooting-hv/vm-start-button-is-not-visible.png differ diff --git a/static/img/v1.2/troubleshooting-hv/vm-stuck-at-starting.png b/static/img/v1.2/troubleshooting-hv/vm-stuck-at-starting.png new file mode 100644 index 00000000..68fb2e5c Binary files /dev/null and b/static/img/v1.2/troubleshooting-hv/vm-stuck-at-starting.png differ diff --git a/versioned_docs/version-v1.6/troubleshooting/harvester.md b/versioned_docs/version-v1.6/troubleshooting/harvester.md index 3ea86292..14a17b56 100644 --- a/versioned_docs/version-v1.6/troubleshooting/harvester.md +++ b/versioned_docs/version-v1.6/troubleshooting/harvester.md @@ -1,7 +1,7 @@ --- sidebar_position: 2 -sidebar_label: Harvester -title: "Harvester" +sidebar_label: Hypervisor +title: "Hypervisor" --- @@ -10,15 +10,15 @@ title: "Harvester" ## Fail to Deploy a Multi-node Cluster Due to Incorrect HTTP Proxy Setting -### ISO Installation Without a Harvester Configuration File +### ISO Installation Without a Hypervisor Configuration File -#### Configure HTTP Proxy During Harvester Installation +#### Configure HTTP Proxy During Hypervisor Installation -In some environments, you configure [http-proxy](../airgap.md#configure-an-http-proxy-during-installation) of [OS Environment](../install/harvester-configuration.md#osenvironment) during Harvester installation. +In some environments, you configure [http-proxy](../airgap.md#configure-an-http-proxy-during-installation) of [OS Environment](../install/harvester-configuration.md#osenvironment) during Hypervisor installation. #### Configure HTTP Proxy After First Node is Ready -After the first node is installed successfully, you login into the `Harvester GUI` to configure [http-proxy](../airgap.md#configure-an-http-proxy-in-harvester-settings) of [Harvester System Settings](../install/harvester-configuration.md#system_settings). +After the first node is installed successfully, you login into the `Hypervisor GUI` to configure [http-proxy](../airgap.md#configure-an-http-proxy-in-harvester-settings) of [Hypervisor System Settings](../install/harvester-configuration.md#system_settings). Then you continue to add more nodes to the cluster. @@ -44,28 +44,28 @@ For example, your cluster assigns IPs from CIDR `172.26.50.128/27` to nodes via After setting this, you can continue to add new nodes to the cluster. -For more details, please refer to [Harvester issue 3091](https://github.com/harvester/harvester/issues/3091). +For more details, please refer to [Hypervisor issue 3091](https://github.com/harvester/harvester/issues/3091). -### ISO Installation With a Harvester Configuration File +### ISO Installation With a Hypervisor Configuration File -When a Harvester configuration file is used in ISO installation, please configure proper `http-proxy` in [Harvester System Settings](../install/harvester-configuration.md#system_settings). +When a Hypervisor configuration file is used in ISO installation, please configure proper `http-proxy` in [Hypervisor System Settings](../install/harvester-configuration.md#system_settings). ### PXE Boot Installation -When [PXE Boot Installation](../install/pxe-boot-install.md) is adopted, please configure proper `http-proxy` in [OS Environment](../install/harvester-configuration.md#osenvironment) and [Harvester System Settings](../install/harvester-configuration.md#system_settings). +When [PXE Boot Installation](../install/pxe-boot-install.md) is adopted, please configure proper `http-proxy` in [OS Environment](../install/harvester-configuration.md#osenvironment) and [Hypervisor System Settings](../install/harvester-configuration.md#system_settings). ## Generate a Support Bundle -Users can generate a support bundle in the Harvester GUI with the following steps: +Users can generate a support bundle in the Hypervisor GUI with the following steps: -- Click the `Support` link at the bottom-left of Harvester Web UI. - ![](/img/v1.2/troubleshooting/harvester-sb-support-link.png) +- Click the `Support` link at the bottom-left of Hypervisor Web UI. + ![](/img/v1.2/troubleshooting-hv/harvester-sb-support-link.png) - Click `Generate Support Bundle` button. - ![](/img/v1.2/troubleshooting/harvester-sb-support-button.png) + ![](/img/v1.2/troubleshooting-hv/harvester-sb-support-button.png) - Enter a useful description for the support bundle and click `Create` to generate and download a support bundle. - ![](/img/v1.2/troubleshooting/harvester-sb-support-modal.png) + ![](/img/v1.2/troubleshooting-hv/harvester-sb-support-modal.png) :::note @@ -85,7 +85,7 @@ For information about collecting guest cluster logs and configuration files, see ### Manually Download and Retain a Support Bundle File -By default, a support bundle file is automatically generated, downloaded, and deleted after you click **Create** on the Harvester UI. However, you may want to retain a file for various reasons, including the following: +By default, a support bundle file is automatically generated, downloaded, and deleted after you click **Create** on the Hypervisor UI. However, you may want to retain a file for various reasons, including the following: - You are unable to download the file because of network connectivity errors and other issues. @@ -93,11 +93,11 @@ By default, a support bundle file is automatically generated, downloaded, and de - You want to view information that only exists in a previously generated file. -Even if the file remains in the cluster, the Harvester UI does not provide a download link. Use the following workaround to generate, manually download, and retain a support bundle file: +Even if the file remains in the cluster, the Hypervisor UI does not provide a download link. Use the following workaround to generate, manually download, and retain a support bundle file: #### Generate the File and Prevent Automatic Downloading -1. On the Harvester UI, click **Generate Support Bundle**. +1. On the Hypervisor UI, click **Generate Support Bundle**. 1. When the progress indicator reaches 20% to 80%, close the browser tab to prevent automatic downloading of the generated file. @@ -195,7 +195,7 @@ You can delete the related resources using the following methods: $ kubectl get supportbundle -A No resources found ``` -- Automatic: Harvester deletes the related resources based on how the following settings are configured: +- Automatic: Hypervisor deletes the related resources based on how the following settings are configured: - [support-bundle-expiration](../advanced/index#support-bundle-expiration): Defines the time allowed for retaining a support bundle file @@ -213,7 +213,7 @@ kubectl cp harvester-system/supportbundle-manager-bundle-dtl2k-69dcc69b59-w64vl: ### Manually Collect Data for Support Bundle -Harvester is unable to collect data and generate a support bundle when the node is inaccessible or not ready. The workaround is to run a script and compress the generated files. +Hypervisor is unable to collect data and generate a support bundle when the node is inaccessible or not ready. The workaround is to run a script and compress the generated files. 1. Prepare the environment. ```sh @@ -319,7 +319,7 @@ Harvester is unable to collect data and generate a support bundle when the node For more information, see [Issue 3383](https://github.com/harvester/harvester/issues/3383). -## Access Embedded Rancher and Longhorn Dashboards + -## I can't access Harvester after I changed SSL/TLS enabled protocols and ciphers +## I can't access Hypervisor after I changed SSL/TLS enabled protocols and ciphers If you changed [SSL/TLS enabled protocols and ciphers settings](../advanced/settings.md#ssl-parameters) -and you no longer have access to Harvester GUI and API, +and you no longer have access to Hypervisor GUI and API, it's highly possible that NGINX Ingress Controller has stopped working due to the misconfigured SSL/TLS protocols and ciphers. Follow these steps to reset the setting: -1. Following [FAQ](../faq.md) to SSH into Harvester node and switch to `root` user. +1. Following [FAQ](../faq.md) to SSH into Hypervisor node and switch to `root` user. ``` $ sudo -s ``` diff --git a/versioned_docs/version-v1.6/troubleshooting/installation.md b/versioned_docs/version-v1.6/troubleshooting/installation.md index 7260a08c..13e6074b 100644 --- a/versioned_docs/version-v1.6/troubleshooting/installation.md +++ b/versioned_docs/version-v1.6/troubleshooting/installation.md @@ -11,7 +11,7 @@ title: "Installation" The following sections contain tips to troubleshoot or get assistance with failed installations. -## Logging into the Harvester Installer (a live OS) +## Logging into the Hypervisor Installer (a live OS) Users can press the key combination `CTRL + ALT + F2` to switch to another TTY and log in with the following credentials: @@ -65,7 +65,7 @@ token: 'ThisIsTheCorrectOne' To ensure the change is persistent across reboots, update the `token` value of the OS configuration file `/oem/90_custom.yaml`: ```yaml -name: Harvester Configuration +name: Hypervisor Configuration stages: ... initramfs: @@ -106,13 +106,13 @@ $ sudo yq eval .token /etc/rancher/rancherd/config.yaml ::: -## Check the status of Harvester components +## Check the status of Hypervisor components -Before checking the status of Harvester components, obtain a copy of the Harvester cluster's kubeconfig file following the [guide](../faq.md#how-can-i-access-the-kubeconfig-file-of-the-harvester-cluster). +Before checking the status of Hypervisor components, obtain a copy of the Hypervisor cluster's kubeconfig file following the [guide](../faq.md#how-can-i-access-the-kubeconfig-file-of-the-harvester-cluster). After you obtain a copy of the kubeconfig file, run the following script against the cluster to check the readiness of each component. -- Harvester components script +- Hypervisor components script ```shell #!/bin/bash @@ -160,7 +160,7 @@ Please include the following information in a bug report when reporting a failed - System information and logs. - Available as of v1.0.2 - Please follow the guide in [Logging into the Harvester Installer (a live OS)](#logging-into-the-harvester-installer-a-live-os) to log in. And run the command to generate a tarball that contains troubleshooting information: + Please follow the guide in [Logging into the Hypervisor Installer (a live OS)](#logging-into-the-harvester-installer-a-live-os) to log in. And run the command to generate a tarball that contains troubleshooting information: ``` supportconfig -k -c @@ -168,21 +168,21 @@ Please include the following information in a bug report when reporting a failed The command output messages contain the generated tarball path. For example the path is `/var/loq/scc_aaa_220520_1021 804d65d-c9ba-4c54-b12d-859631f892c5.txz` in the following example: - ![](/img/v1.2/troubleshooting/installation-support-config-example.png) + ![](/img/v1.2/troubleshooting-hv/installation-support-config-example.png) :::note - A failure PXE Boot installation automatically generates a tarball if the [`install.debug`](../install/harvester-configuration.md#installdebug) field is set to `true` in the Harvester configuration file. + A failure PXE Boot installation automatically generates a tarball if the [`install.debug`](../install/harvester-configuration.md#installdebug) field is set to `true` in the Hypervisor configuration file. ::: -## Harvester Console shows "Setting up Harvester" after day 0 Installation +## Hypervisor Console shows "Setting up Hypervisor" after day 0 Installation ### Issue Description -After a successful installation, the Harvester console persistently shows `Setting up Harvester`. While most UI and CLI operations remain unaffected, attempts to [start an upgrade](../upgrade/automatic.md#start-an-upgrade) are blocked. +After a successful installation, the Hypervisor console persistently shows `Setting up Hypervisor`. While most UI and CLI operations remain unaffected, attempts to [start an upgrade](../upgrade/automatic.md#start-an-upgrade) are blocked. -![](/img/v1.6/troubleshooting/setting-up-harvester-after-day-0.png) +![](/img/v1.2/troubleshooting-hv/setting-up-harvester-after-day-0.png) The following information is displayed after you run the command `kubectl get managedchart -n fleet-local harvester -oyaml`: @@ -205,7 +205,7 @@ status: ### Root Cause -The Harvester console runs the following command to determine if the status of the `harvester` ManagedChart (in the `fleet-local` namespace) is `Ready`. +The Hypervisor console runs the following command to determine if the status of the `harvester` ManagedChart (in the `fleet-local` namespace) is `Ready`. ``` cmd := exec.Command("/bin/sh", "-c", kubectl -n fleet-local get ManagedChart harvester -o jsonpath='{.status.conditions}' | diff --git a/versioned_docs/version-v1.6/troubleshooting/monitoring.md b/versioned_docs/version-v1.6/troubleshooting/monitoring.md index 364bbc05..8b9148ea 100644 --- a/versioned_docs/version-v1.6/troubleshooting/monitoring.md +++ b/versioned_docs/version-v1.6/troubleshooting/monitoring.md @@ -2,21 +2,22 @@ sidebar_position: 4 sidebar_label: Monitoring title: "Monitoring" +draft: true --- -The following sections contain tips to troubleshoot Harvester Monitoring. +The following sections contain tips to troubleshoot Hypervisor Monitoring. ## Monitoring is unusable -When the Harvester Dashboard is not showing any monitoring metrics, it can be caused by the following reasons. +When the Hypervisor Dashboard is not showing any monitoring metrics, it can be caused by the following reasons. ### Monitoring is unusable due to Pod being stuck in `Terminating` status -Harvester Monitoring pods are deployed randomly on the cluster Nodes. When the Node hosting the pods accidentally goes down, the related pods may become stuck in the `Terminating` status rendering the Monitoring unusable from the WebUI. +Hypervisor Monitoring pods are deployed randomly on the cluster Nodes. When the Node hosting the pods accidentally goes down, the related pods may become stuck in the `Terminating` status rendering the Monitoring unusable from the WebUI. ```shell $ kubectl get pods -n cattle-monitoring-system @@ -73,13 +74,13 @@ rancher-monitoring-grafana-d9c56d79b-cp86w 3/3 Running 0 ## Expand PV/Volume Size -`Harvester` integrates `Longhorn` as the default storage provider. +`Hypervisor` integrates `Longhorn` as the default storage provider. -Harvester `Monitoring` uses `Persistent Volume (PV)` to store running data. When a cluster has been running for a certain time, the `Persistent Volume` may need to expand its size. +Hypervisor `Monitoring` uses `Persistent Volume (PV)` to store running data. When a cluster has been running for a certain time, the `Persistent Volume` may need to expand its size. -Based on the `Longhorn` `Volume` expansion guide, `Harvester` illustrates how to [expand the volume size](https://longhorn.io/docs/1.3.2/volumes-and-nodes/expansion/). +Based on the `Longhorn` `Volume` expansion guide, `Hypervisor` illustrates how to [expand the volume size](https://longhorn.io/docs/1.3.2/volumes-and-nodes/expansion/). -### View Volume + ## Fail to Enable `rancher-monitoring` Addon -You may encounter this when you install the Harvester v1.3.0 or higher version cluster with the minimal 250 GB disk per [hardware requirements](../install/requirements.md#hardware-requirements). +You may encounter this when you install the Hypervisor v1.3.0 or higher version cluster with the minimal 250 GB disk per [hardware requirements](../install/requirements.md#hardware-requirements). ### Reproduce Steps -1. Install the Harvester v1.3.0 cluster. +1. Install the Hypervisor v1.3.0 cluster. 1. Enable the `rancher-monitoring` [addon](../advanced/addons.md), you will observe: @@ -275,13 +276,13 @@ You may encounter this when you install the Harvester v1.3.0 or higher version c alertmanager-rancher-monitoring-alertmanager-db-alertmanager-rancher-monitoring-alertmanager-0 Bound pvc-cea6316e-f74f-4771-870b-49edb5442819 5Gi RWO harvester-longhorn 16m ``` -1. On the **Addons** screen of the Harvester UI, select **⋮** (menu icon) and then select **Edit YAML**. +1. On the **Addons** screen of the Hypervisor UI, select **⋮** (menu icon) and then select **Edit YAML**. - ![](/img/v1.3/troubleshooting/edit-rancher-monitoring.png) + ![](/img/v1.3/troubleshooting-hv/edit-rancher-monitoring.png) 1. As indicated below, change the two occurrences of the number `50` to `30` under prometheusSpec, and then save. The `prometheus` feature will use a 30GiB disk to store data. - ![](/img/v1.3/troubleshooting/edit-rancher-monitoring-yaml.png) + ![](/img/v1.3/troubleshooting-hv/edit-rancher-monitoring-yaml.png) Alternatively, you can use `kubectl` to edit the object. @@ -382,7 +383,7 @@ fleet-local mcc-rancher-logging-crd 1/1 fleet-local mcc-rancher-monitoring-crd 0/1 Modified(1) [Cluster fleet-local/local]; clusterrole.rbac.authorization.k8s.io rancher-monitoring-crd-manager missing; clusterrolebinding.rbac.authorization.k8s.io rancher-monitoring-crd-manager missing; configmap.v1 cattle-monitoring-system/rancher-monitoring-crd-manifest missing; serviceaccount.v1 cattle-monitoring-system/rancher-monitoring-crd-manager missing ``` -When the issue exists and you [start an upgrade](../upgrade/automatic.md#start-an-upgrade), Harvester may return the following error message: `admission webhook "validator.harvesterhci.io" denied the request: managed chart rancher-monitoring-crd is not ready, please wait for it to be ready`. +When the issue exists and you [start an upgrade](../upgrade/automatic.md#start-an-upgrade), Hypervisor may return the following error message: `admission webhook "validator.harvesterhci.io" denied the request: managed chart rancher-monitoring-crd is not ready, please wait for it to be ready`. Also, when you search for the objects marked as `missing`, you will find that they exist in the cluster. @@ -638,7 +639,7 @@ The `prometheus` CRD object includes the `storage-network.settings.harvesterhci. creationTimestamp: "2025-05-20T06:40:25Z" ``` -The Harvester pod logs ('harvester-system/harvester' deployment) indicate that the attempt to change the `storage-network` setting was blocked. +The Hypervisor pod logs ('harvester-system/harvester' deployment) indicate that the attempt to change the `storage-network` setting was blocked. ``` ... @@ -652,13 +653,13 @@ The Harvester pod logs ('harvester-system/harvester' deployment) indicate that t ### Root Cause -When you make changes to the [storage-network](../advanced/storagenetwork.md#storage-network-setting) setting, the Harvester controller waits for the attached volumes to be detached before applying the changes. In addition, the controller automatically terminates the pods related to Prometheus, Alertmanager, and Grafana because those pods use volumes to store data. +When you make changes to the [storage-network](../advanced/storagenetwork.md#storage-network-setting) setting, the Hypervisor controller waits for the attached volumes to be detached before applying the changes. In addition, the controller automatically terminates the pods related to Prometheus, Alertmanager, and Grafana because those pods use volumes to store data. This process usually takes a short time to complete, but can be disrupted when the following occur: -- Attached volumes prevent the Harvester controller from applying the changes to the setting. +- Attached volumes prevent the Hypervisor controller from applying the changes to the setting. - A user or the `monitoring-operator` attempts to enable the `rancher-monitoring` add-on. -- The Harvester controller terminates the pods. +- The Hypervisor controller terminates the pods. ### Workaround @@ -666,7 +667,7 @@ This process usually takes a short time to complete, but can be disrupted when t 1. Check if the [storage-network](../advanced/storagenetwork.md#storage-network-setting) setting is enabled or disabled. -1. Check for error indicators in the Harvester pod logs. If volumes are still attached, stop the related virtual machines until no errors appear after the `storage network change` message. +1. Check for error indicators in the Hypervisor pod logs. If volumes are still attached, stop the related virtual machines until no errors appear after the `storage network change` message. 1. Enable the `rancher-monitoring` add-on. diff --git a/versioned_docs/version-v1.6/troubleshooting/os.md b/versioned_docs/version-v1.6/troubleshooting/os.md index c4f8a198..97372a5b 100644 --- a/versioned_docs/version-v1.6/troubleshooting/os.md +++ b/versioned_docs/version-v1.6/troubleshooting/os.md @@ -8,11 +8,11 @@ title: "Operating System" -Harvester runs on an OpenSUSE-based OS. The OS is an artifact produced by the [elemental-toolkit](https://github.com/rancher/elemental-toolkit). The following sections contain information and tips to help users troubleshoot OS-related issues. +Hypervisor runs on an OpenSUSE-based OS. The OS is an artifact produced by the [elemental-toolkit](https://github.com/rancher/elemental-toolkit). The following sections contain information and tips to help users troubleshoot OS-related issues. -## How to log in to a Harvester node +## How to log in to a Hypervisor node -Users can log in to a Harvester node with the username `rancher` and the password or SSH keypair provided during installation. +Users can log in to a Hypervisor node with the username `rancher` and the password or SSH keypair provided during installation. The user `rancher` can execute privileged commands without entering a password: ``` @@ -27,9 +27,9 @@ node1:~ # blkid The OS file system, like a container image, is image-based and immutable except in some directories. -We recommend using a **toolbox container** to run programs not packaged in the Harvester OS for debugging purposes. Please see [this article](https://harvesterhci.io/kb/package_your_own_toolbox_image/) to learn how to build and run a toolbox container. +We recommend using a **toolbox container** to run programs not packaged in the Hypervisor OS for debugging purposes. Please see [this article](https://harvesterhci.io/kb/package_your_own_toolbox_image/) to learn how to build and run a toolbox container. -The Harvester OS also provides a way to enable the read-write mode temporarily. Please follow the following steps: +The Hypervisor OS also provides a way to enable the read-write mode temporarily. Please follow the following steps: :::caution @@ -37,7 +37,7 @@ Enabling read-write mode might break your system if files are modified. Please u ::: -- For version `v0.3.0`, we need to apply a workaround first to [make some directories non-overlaid](https://github.com/harvester/harvester/issues/1388) after enabling read-write mode. On a running Harvester node, run the following command as root: +- For version `v0.3.0`, we need to apply a workaround first to [make some directories non-overlaid](https://github.com/harvester/harvester/issues/1388) after enabling read-write mode. On a running Hypervisor node, run the following command as root: ``` cat > /oem/91_hack.yaml <<'EOF' @@ -54,17 +54,17 @@ Enabling read-write mode might break your system if files are modified. Please u - Reboot the system to GRUB menu. Press ESC to stay on the menu. - ![](/img/v1.2/troubleshooting/grub-menu.png) + ![](/img/v1.2/troubleshooting-hv/grub-menu.png) - Press `e` on first menuentry. Append `rd.cos.debugrw` to the `linux (loop0)$kernel $kernelcmd` line. Press `Ctrl + x` to boot the system. - ![](/img/v1.2/troubleshooting/edit-boot-parameter.png) + ![](/img/v1.2/troubleshooting-hv/edit-boot-parameter.png) ## How to permanently edit kernel parameters :::note -The following steps are a workaround. Harvester will inform the community once a permanent resolution is in place. +The following steps are a workaround. Hypervisor will inform the community once a permanent resolution is in place. ::: @@ -134,10 +134,10 @@ If kernel panic traces are not recorded in the system log when a system crashes, To enable outputting of kernel messages to a serial console, please use the following steps: - Boot the system to GRUB menu. Press ESC to stay on the menu. - ![](/img/v1.2/troubleshooting/grub-menu.png) + ![](/img/v1.2/troubleshooting-hv/grub-menu.png) - Press `e` on first menuentry. Append `console=ttyS0,115200n8` to the `linux (loop0)$kernel $kernelcmd` line. Press `Ctrl + x` to boot the system. - ![](/img/v1.2/troubleshooting/edit-boot-parameter-serial.png) + ![](/img/v1.2/troubleshooting-hv/edit-boot-parameter-serial.png) :::note @@ -151,6 +151,6 @@ For kernel panic crashes, you can use kdump to collect crash dumps. By default, the OS is booted without the kdump feature enabled. Users can enable the feature by selecting the `debug` menuentry when booting, as in the following example: -![](/img/v1.2/troubleshooting/grub-menu-debug.png) +![](/img/v1.2/troubleshooting-hv/grub-menu-debug.png) When a system crashes, a crash dump will be stored in the `/var/crash/