Skip to content
3 changes: 2 additions & 1 deletion docs/authentication.md
Original file line number Diff line number Diff line change
Expand Up @@ -14,7 +14,8 @@ _Available as of v0.2.0_

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](./install/first-log-in.png)


The Harvester login page is shown below:
Expand Down
35 changes: 18 additions & 17 deletions docs/dev/dev-mode.md
Original file line number Diff line number Diff line change
Expand Up @@ -29,7 +29,7 @@ Harvester can be installed on a Kubernetes cluster in the following ways:
- Install with the [Helm](https://helm.sh/) CLI
- Install as a Rancher catalog app, in which case the [harvester/harvester](https://github.com/harvester/harvester) repo is added to the Rancher Catalog as a Helm `v3` app

Please refer to the Harvester [Helm chart](../deploy/charts/harvester) for more details on installing and configuring the Helm chart.
Please refer to the Harvester [Helm chart](https://github.com/harvester/harvester/blob/master/deploy/charts/harvester/README.md) for more details on installing and configuring the Helm chart.

### Requirements

Expand All @@ -45,35 +45,36 @@ cat /proc/cpuinfo | grep vmx

1. Clone the GitHub repository:

```bash
git clone https://github.com/harvester/harvester.git --depth=1
```
```bash
git clone https://github.com/harvester/harvester.git --depth=1
```

1. Go to the Helm chart:

```bash
cd harvester/deploy/charts
```
```bash
cd harvester/deploy/charts
```

1. Install the Harvester chart with the following commands:

```bash
### To install the chart with the release name `harvester`:
```bash
### To install the chart with the release name `harvester`:

## Create the target namespace
kubectl create ns harvester-system
## Create the target namespace
kubectl create ns harvester-system

## Install the chart to the target namespace
helm install harvester harvester \
--namespace harvester-system \
--set longhorn.enabled=true,minio.persistence.storageClass=longhorn
```

## Install the chart to the target namespace
helm install harvester harvester \
--namespace harvester-system \
--set longhorn.enabled=true,minio.persistence.storageClass=longhorn
```

### Option 2: Install using Rancher

!!! tip
You can create a testing Kubernetes environment in Rancher using the Digital Ocean cloud provider. For details, see [this section](#digital-ocean-test-environment).

You can create a testing Kubernetes environment in Rancher using the Digital Ocean cloud provider. For details, see [this section](#digital-ocean-test-environment).

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`.
Expand Down
8 changes: 6 additions & 2 deletions docs/import-image.md
Original file line number Diff line number Diff line change
Expand Up @@ -15,9 +15,13 @@ To import virtual machine images in the **Images** page, enter a URL that can be
Currently, we support qcow2, raw, and ISO images.

!!!note
Uploading images from UI to the Harvester cluster is not supported yet. The feature request is being tracked on [#570](https://github.com/harvester/harvester/issues/570).

Uploading images from UI to the Harvester cluster is not supported yet. The feature request is being tracked on [#570](https://github.com/harvester/harvester/issues/570).



Description and labels are optional.

![](/img/import-image.png)

![](./assets/upload-image.png)

4 changes: 2 additions & 2 deletions docs/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -26,7 +26,7 @@ Harvester implements HCI on bare metal servers. Here are some notable features o
1. Multiple NICs in the VM connecting to the management network or VLANs
1. Virtual Machine and cloud-init templates
1. Built-in [Rancher](https://github.com/rancher/rancher) integration and the Harvester node driver
1. [PXE/iPXE boot support](https://github.com/rancher/harvester/blob/master/docs/automatic-installation.md)
1. [PXE/iPXE boot support](./install/pxe-boot-install.md)

The following diagram gives a high-level architecture of Harvester:

Expand Down Expand Up @@ -87,4 +87,4 @@ Note: This [video](https://youtu.be/97ADieBX6bE) shows a quick overview of the I

### Other Installation Methods

Starting from version `0.2.0`, Harvester can be installed in a mass manner, please refer to [PXE Boot Install](/docs/installation/pxe-boot-install) for detailed instructions.
Starting from version `0.2.0`, Harvester can be installed in a mass manner, please refer to [PXE Boot Install](./install/pxe-boot-install.md) for detailed instructions.
6 changes: 2 additions & 4 deletions docs/upgrade.md
Original file line number Diff line number Diff line change
Expand Up @@ -23,8 +23,6 @@ Harvester provides two ways to upgrade. Users can either upgrade using the ISO i
- Zero downtime upgrade is supported when the Harvester cluster includes 3 or more nodes. If the cluster has less than 3 nodes, you can still perform upgrades but there'll be downtime during the upgrade.
- Upgrade nodes one by one.



## Upgrade using the ISO image

To get the Harvester ISO of a newer version, download it from the Github releases.
Expand All @@ -35,7 +33,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.
Expand All @@ -47,6 +45,6 @@ _Prerequisite: Internet access is required to perform a live upgrade in the UI._

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.
4 changes: 2 additions & 2 deletions docs/vm/create-vm.md
Original file line number Diff line number Diff line change
Expand Up @@ -25,7 +25,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.

![](/create-vm.png)
![create-vm](create-vm.png)

## Cloud config examples

Expand Down Expand Up @@ -65,4 +65,4 @@ By default, a VM can be accessed via the management network.

### Secondary Network

It is also possible to connect VMs using additional networks with Harvester's built-in [vlan networks](/docs/harvester-network.md).
It is also possible to connect VMs using additional networks with Harvester's built-in [vlan networks](../harvester-network.md).