diff --git a/docs/authentication.md b/docs/authentication.md index bde6ab0e8da..929e3bc853d 100644 --- a/docs/authentication.md +++ b/docs/authentication.md @@ -15,11 +15,11 @@ keywords: With ISO installation mode, user will be prompted to set the password for the default `admin` user on the first-time login. -![auth](/assets/first-log-in.png) +![auth](./assets/first-log-in.png) The Harvester login page is shown below: -![auth](/assets/authentication.png) +![auth](./assets/authentication.png) ## Developer Mode diff --git a/docs/dev/dev-mode.md b/docs/dev/dev-mode.md index ae068d73559..7d120ea6be2 100644 --- a/docs/dev/dev-mode.md +++ b/docs/dev/dev-mode.md @@ -75,14 +75,14 @@ Tip: You can create a testing Kubernetes environment in Rancher using the Digita 1. Add the Harvester repo `https://github.com/harvester/harvester` to your Rancher catalogs by clicking **Global > Tools > Catalogs.** 1. Specify the URL and name. Set the branch to `stable` if you need a stable release version. Set the `Helm version` to be `Helm v3`. - ![harvester-catalog.png](/assets/harvester-catalog.png) + ![harvester-catalog.png](./assets/harvester-catalog.png) 1. Click **Create.** 1. Navigate to your project-level `Apps.` 1. Click `Launch` and choose the Harvester app. 1. (Optional) You can modify the configurations if needed. Otherwise, use the default options. 1. Click **Launch** and wait for the app's components to be ready. 1. Click the `/index.html` link to navigate to the Harvester UI: - ![harvester-app.png](/assets/harvester-app.png) + ![harvester-app.png](./assets/harvester-app.png) ### Digital Ocean Test Environment @@ -94,6 +94,6 @@ We recommend using the `8 core, 16 GB RAM` node, which will have nested virtuali This screenshot shows how to create a Rancher node template that would allow Rancher to provision such a node in Digital Ocean: -![do.png](/assets/do.png) +![do.png](./assets/do.png) For more information on how to launch Digital Ocean nodes with Rancher, refer to the [Rancher documentation.](https://rancher.com/docs/rancher/v2.x/en/cluster-provisioning/rke-clusters/node-pools/digital-ocean/) diff --git a/docs/harvester-network.md b/docs/harvester-network.md index 3afd84e32db..edcc0a6d274 100644 --- a/docs/harvester-network.md +++ b/docs/harvester-network.md @@ -30,7 +30,7 @@ Harvester adopts [flannel](https://github.com/flannel-io/flannel) as the default Below is a use case of the VLAN in Harvester. -![](/assets/vlan-case.png) +![](./assets/vlan-case.png) - Harvester network-controller uses a bridge for a node and a pair of veth for a VM to implement the VLAN. The bridge acts as a switch to forward the network traffic from or to VMs and the veth pair is like the connected ports between vms and switch. - VMs within the same VLAN is able to communicate with each other, while the VMs within different VLANs can't. @@ -45,21 +45,21 @@ The first physical NIC name of each Harvester node always defaults to eth0. It i Note: Modifying the default VLAN network setting will not change the existing configured host networks. -![](/assets/enable-vlan.png) +![](./assets/enable-vlan.png) - (optional) Users can always customize each node's VLAN network configuration via going to the **HOST > Network** tab. - ![](/assets/node-network-configuration.png) + ![](./assets/node-network-configuration.png) - A new VLAN network is created by going to the **Advanced > Networks** page and clicking the **Create** button. - ![](/assets/create-network.png) + ![](./assets/create-network.png) - The network is configured when the VM is created. - Only the first network interface card will be enabled by default. Users can either choose to use a management network or VLAN network. Note: You will need to select the `Install guest agent` option in the `Advanced Options` tab to get the VLAN network IP address from the Harvester UI. - ![](/assets/vm-network-configuration.png) + ![](./assets/vm-network-configuration.png) - Users can choose to add one or multiple network interface cards. Additional network interface card configurations can be set via cloud-init network data, e.g.: diff --git a/docs/import-image.md b/docs/import-image.md index 275f573aae8..3357d376065 100644 --- a/docs/import-image.md +++ b/docs/import-image.md @@ -20,4 +20,4 @@ Currently, we support qcow2, raw, and ISO images. Description and labels are optional. -![](/assets/import-image.png) +![](./assets/import-image.png) diff --git a/docs/index.md b/docs/index.md index 1be7f3f511d..ec0c65b2471 100644 --- a/docs/index.md +++ b/docs/index.md @@ -13,7 +13,7 @@ keywords: Harvester is an open source [hyper-converged infrastructure](https://en.wikipedia.org/wiki/Hyper-converged_infrastructure) (HCI) software built on Kubernetes. It is an open source alternative to vSphere and Nutanix. -![harvester-ui](/assets/harvester-ui.png) +![harvester-ui](./assets/harvester-ui.png) ## Overview @@ -30,7 +30,7 @@ Harvester implements HCI on bare metal servers. Here are some notable features o The following diagram gives a high-level architecture of Harvester: -![](/assets/architecture.svg) +![](./assets/architecture.svg) - [Longhorn](https://longhorn.io/) is a lightweight, reliable and easy-to-use distributed block storage system for Kubernetes. - [KubeVirt](https://kubevirt.io/) is a virtual machine management add-on for Kubernetes. @@ -60,11 +60,11 @@ During the installation you can either choose to form a new cluster, or join the Note: This [video](https://youtu.be/97ADieBX6bE) shows a quick overview of the ISO installation. 1. Mount the Harvester ISO disk and boot the server by selecting the `Harvester Installer`. - ![iso-install.png](/assets/iso-install.png) + ![iso-install.png](./assets/iso-install.png) 1. Choose the installation mode by either creating a new Harvester cluster, or by joining an existing one. 1. Choose the installation device that the Harvester will be formatted to. 1. Configure the hostname and select the network interface for the management network, the IP address can either be configured via DHCP or static method. - ![iso-installed.png](/assets/iso-nic-config.png) + ![iso-installed.png](./assets/iso-nic-config.png) 1. Configure the `cluster token`. This token will be used for adding other nodes to the cluster. 1. Configure the login password of the host. The default ssh user is `rancher`. 1. (Optional) you can choose to import SSH keys from a remote URL server. Your GitHub public keys can be used with `https://github.com/.keys`. @@ -73,6 +73,6 @@ Note: This [video](https://youtu.be/97ADieBX6bE) shows a quick overview of the I 1. Confirm the installation options and the Harvester will be installed to your host. The installation may take a few minutes to be complete. 1. Once the installation is complete it will restart the host and a console UI with management URL and status will be displayed. (You can Use F12 to switch between Harvester console and the Shell) 1. The default URL of the web interface is `https://your-host-ip:30443`. - ![iso-installed.png](/assets/iso-installed.png) + ![iso-installed.png](./assets/iso-installed.png) 1. User will be prompted to set the password for the default `admin` user on the first-time login. - ![first-login.png](/assets/first-log-in.png) + ![first-login.png](./assets/first-log-in.png) diff --git a/docs/install/iso-install.md b/docs/install/iso-install.md index 18081c1c050..8d567626b08 100644 --- a/docs/install/iso-install.md +++ b/docs/install/iso-install.md @@ -21,11 +21,11 @@ During the installation you can either choose to form a new cluster, or join the This [video](https://youtu.be/97ADieBX6bE) shows a quick overview of the ISO installation. 1. Mount the Harvester ISO disk and boot the server by selecting the `Harvester Installer`. - ![iso-install.png](/assets/iso-install.png) + ![iso-install.png](./assets/iso-install.png) 1. Choose the installation mode by either creating a new Harvester cluster, or by joining an existing one. 1. Choose the installation device that the Harvester will be formatted to. 1. Configure the hostname and select the network interface for the management network, the IP address can either be configured via DHCP or static method. - ![iso-installed.png](/assets/iso-nic-config.png) + ![iso-installed.png](./assets/iso-nic-config.png) 1. Configure the `cluster token`. This token will be used for adding other nodes to the cluster. 1. Configure the login password of the host. The default ssh user is `rancher`. 1. (Optional) you can choose to import SSH keys from a remote URL server. Your GitHub public keys can be used with `https://github.com/.keys`. @@ -34,6 +34,6 @@ During the installation you can either choose to form a new cluster, or join the 1. Confirm the installation options and the Harvester will be installed to your host. The installation may take a few minutes to be complete. 1. Once the installation is complete it will restart the host and a console UI with management URL and status will be displayed. (You can Use F12 to switch between Harvester console and the Shell) 1. The default URL of the web interface is `https://your-host-ip:30443`. - ![iso-installed.png](/assets/iso-installed.png) + ![iso-installed.png](./assets/iso-installed.png) 1. User will be prompted to set the password for the default `admin` user on the first-time login. - ![first-login.png](/assets/first-log-in.png) + ![first-login.png](./assets/first-log-in.png) diff --git a/docs/upgrade.md b/docs/upgrade.md index deb4247aedd..4da9f1e3119 100644 --- a/docs/upgrade.md +++ b/docs/upgrade.md @@ -32,7 +32,7 @@ To get the Harvester ISO of a newer version, download it from the Github release 1. Shut down the server, and boot the server from the ISO disk of the newer Harvester version. 1. Select the `Harvester Installer` in the grub menu. 1. Select `Upgrade Harvester` and confirm in the prompt. - ![iso-mode-upgrade](/assets/iso-mode-upgrade.png) + ![iso-mode-upgrade](./assets/iso-mode-upgrade.png) 1. Wait until the upgrade completes. The node will be rebooted and show `Ready` again in the terminal console. 1. Go to the **Hosts** page in Harvester UI. 1. Find the node that just completed the upgrade. Click on the action dropdown. Click on the `Disable Maintenance Mode` action. @@ -45,6 +45,6 @@ To get the Harvester ISO of a newer version, download it from the Github release 1. Go to the **Dashboard** page in Harvester UI. 1. When newer versions are available, an upgrade button will be shown in the top-right corner. Click upgrade. - ![upgrade-ui](/assets/upgrade-ui.png) + ![upgrade-ui](./assets/upgrade-ui.png) 1. Select a version to upgrade. Click upgrade. 1. Wait until the upgrade to complete. You can view the upgrade progress by clicking the circle icon in the top navigation bar. diff --git a/docs/vm/access-to-the-vm.md b/docs/vm/access-to-the-vm.md index 0ddce850d52..35a6488c2ca 100644 --- a/docs/vm/access-to-the-vm.md +++ b/docs/vm/access-to-the-vm.md @@ -29,4 +29,4 @@ Use the address in a terminal emulation client (such as Putty) or use the follow ssh -i ~/.ssh/your-ssh-key user@ ``` -![](/assets/access-to-vm.png) +![](./assets/access-to-vm.png) diff --git a/docs/vm/create-vm.md b/docs/vm/create-vm.md index 3f10213289b..50a2f4f6c22 100644 --- a/docs/vm/create-vm.md +++ b/docs/vm/create-vm.md @@ -23,7 +23,7 @@ Create one or more virtual machines from the **Virtual Machines** page. 1. To configure networks, go to the **Networks** tab. The **Management Network** is added by default. It is also possible to add secondary networks to the VMs using vlan networks (configured on **Advanced > Networks**). 1. Optional: Configure advanced options like hostname and cloud-init data in the **Advanced Options** section. -![](/assets/create-vm.png) +![](./assets/create-vm.png) ### Cloud config examples