Update docs to reflect v0.2.0

README.md

@@ -1,25 +1,27 @@
-Rancher Harvester
+Harvester
 ========
 [![Build Status](https://drone-publish.rancher.io/api/badges/harvester/harvester/status.svg)](https://drone-publish.rancher.io/harvester/harvester)
 [![Go Report Card](https://goreportcard.com/badge/github.com/harvester/harvester)](https://goreportcard.com/report/github.com/harvester/harvester)
 
-Rancher 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 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](./docs/assets/harvester-ui.png)
 
 ## Overview
 Harvester implements HCI on bare metal servers. Here are some notable features of the Harvester:
 1. VM lifecycle management including SSH-Key injection, Cloud-init and, graphic and serial port console
+1. VM live migration support
+1. Supporting VM backup and restore
 1. Distributed block storage
 1. Multiple NICs connecting to the management network or VLANs
-1. ISO image repository
-1. Virtual Machine templates
+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)
 
 The following diagram gives a high-level architecture of Harvester:
 
-![](./docs/assets/architecture.png)
+![](./docs/assets/architecture.svg)
 
-- [MinIO](https://min.io/) is a cloud storage server compatible with Amazon S3.
 - [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.
 - [K3OS](https://k3os.io/) is a Linux distribution designed to remove as much OS maintenance as possible in a Kubernetes cluster. The OS is designed to be managed by kubectl.
@@ -42,33 +44,41 @@ Users can use the ISO to install Harvester directly on the bare-metal server to
 
 To get the Harvester ISO, download it from the [Github releases.](https://github.com/harvester/harvester/releases)
 
-During installation you can either choose to form a new cluster, or join the node to an existing cluster.
+During the installation you can either choose to form a new cluster, or join the node to an existing cluster.
 
 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](./docs/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](./docs/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/<username>.keys`.
-1. Select the network interface for the management network.
 1. (Optional) If you need to use an HTTP proxy to access the outside world, enter the proxy URL address here, otherwise, leave this blank.
 1. (Optional) If you need to customize the host with cloud-init config, enter the HTTP URL here.
 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. <small>(You can Use F12 to switch between Harvester console and the Shell)</small>
-1. The default credentials for the web interface are username:`admin` and password: `password`.
+1. The default URL of the web interface is `https://your-host-ip:30443`.
 ![iso-installed.png](./docs/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](./docs/assets/first-log-in.png)
 
 
 
 ## Documentation
 Please refer to the following documentation to find out more details:
+- [Automatic Installation](./docs/automatic-installation.md)
 - [Authentication](./docs/authentication.md)
 - [Upload Images](./docs/upload-image.md)
-- [Create a VM](./docs/create-vm.md)
-- [Access to the VM](./docs/access-to-the-vm.md)
+- VM Management
+  * [Create a VM](./docs/create-vm.md)
+  * [Access to the VM](./docs/access-to-the-vm.md)
+  * [Backup & Restore](./docs/backup-restore.md)
+- Network
+  * [Introduction of the Harvester Network](./docs/harvester-network.md)
 - [Node driver](./docs/node-driver.md)
 - [Dev Mode](./docs/app-mode-installation.md)
 
@@ -84,12 +94,13 @@ Harvester is 100% open-source software. The project source code is spread across
 | Harvester UI | https://github.com/harvester/harvester-ui |
 | Harvester Installer | https://github.com/harvester/harvester-installer |
 | Harvester Network Controller | https://github.com/harvester/harvester-network-controller|
+| Harvester Node Driver | https://github.com/harvester/docker-machine-driver-harvester |
 
 Check out this [demo](https://youtu.be/wVBXkS1AgHg) to get a quick overview of the Harvester UI.
 
 
 ## Community
-If you need any help with Harvester, please join us at either our [Rancher forums](https://forums.rancher.com/) or [Slack](https://slack.rancher.io/) where most of our team hangs out at.
+If you need any help with Harvester, please join us at either our [Slack](https://slack.rancher.io/) or [forums](https://forums.rancher.com/) where most of our team hangs out at.
 
 If you have any feedback or questions, feel free to [file an issue](https://github.com/harvester/harvester/issues/new/choose).
 

deploy/charts/harvester/Chart.yaml

@@ -2,7 +2,7 @@ apiVersion: v2
 name: harvester
 version: 0.0.0-dev
 appVersion: 0.1.x
-description: Rancher Harvester is an open source Hyper-Converged Infrastructure(HCI) solution based on Kubernetes.
+description: Harvester is an open source Hyper-Converged Infrastructure(HCI) solution based on Kubernetes.
 icon: https://harvester.github.io/images/logo_horizontal.svg
 type: application
 keywords:

deploy/charts/harvester/README.md

@@ -1,6 +1,6 @@
 # Harvester Helm Chart [Development]
 
-Rancher Harvester is an open source Hyper-Converged Infrastructure(HCI) solution based on Kubernetes.
+Harvester is an open source Hyper-Converged Infrastructure(HCI) solution based on Kubernetes.
 
 Note: the master branch is under active development, please use the `stable` branch if you need a stable version of the Harvester chart.
 

docs/README.md

@@ -7,7 +7,6 @@ or hang out with our developers on either our [Slack](https://slack.rancher.io/)
 
 - Installation
   * [ISO Mode](./iso-installation.md)
-  * [App Mode - for development](./app-mode-installation.md)
   * [Automatic Mode - for mass installation](./automatic-installation.md)
 - Upgrade
   * [Upgrading Harvester](./upgrade.md)
@@ -21,3 +20,6 @@ or hang out with our developers on either our [Slack](https://slack.rancher.io/)
   * [Live Migration](./live-migration.md)
 - Network
   * [Introduction of the Harvester Network](./harvester-network.md)
+- [Rancher Integration](./rancher-integration.md)
+    - [Harvester Node driver](./node-driver.md)
+- [Dev Mode](./docs/app-mode-installation.md)

docs/app-mode-installation.md

@@ -1,4 +1,4 @@
-# App Mode Installation
+# App Mode Installation [Development Mode]
 
 App mode is intended to be used for testing and development purposes.