diff --git a/docs/index.md b/docs/index.md index 0fa500c..b812229 100644 --- a/docs/index.md +++ b/docs/index.md @@ -1,6 +1,6 @@ # Horizon Management Hub -## Deploy All-in-One Horizon Management Hub, Agent and CLI +## Deploy All-in-One Horizon Management Hub, Agent and CLI This enables you to quickly set up a host with all of the Horizon components to facilitate learning Horizon and doing development for it. @@ -20,7 +20,7 @@ As **root** run: curl -sSL https://raw.githubusercontent.com/open-horizon/devops/master/mgmt-hub/deploy-mgmt-hub.sh | bash ``` -### System Requirements +### System Requirements The All-in-One environment is intended for use on devices or virtual machines with **at least 4GB RAM and 20GB of storage space**. @@ -28,7 +28,7 @@ Ubuntu Server 18.04 and 20.04 are the preferred operating systems for evaluating If you wish to use the All-in-One environment in a virtual machine, please read the VM setup notes further down for details. -### What To Do Next +### What To Do Next #### Run the Automated Tests @@ -174,7 +174,7 @@ You will see the script do these steps: - Import the voucher of this device into the SDO management hub component - Simulate the booting of this device, which will verify the agent has already been installed, and then register it for the helloworld edge service example -### "Pausing" the Horizon management hub services +### "Pausing" the Horizon management hub services The Horizon management hub services and edge agent use some CPU even in steady state. If you don't need them for a period of time, you can stop the containers by running: @@ -188,13 +188,13 @@ When you want to use the Horizon management hub services and edge agent again, y ./deploy-mgmt-hub.sh -s ``` -## Setting up a VM for the All-in-One Environment +## Setting up a VM for the All-in-One Environment Using a Virtual Machine (VM) allows you to learn and experiment with Open Horizon in a safe, controlled environment without affecting your host system. This requires the use of virtualization software that is easily obtainable or even integrated into your host's operating system. [VirtualBox](#setup-vm-vbox) and [QEMU](#setup-vm-qemu-kvm-boxes) are two popular open-source choices. -#### VirtualBox +#### VirtualBox Oracle VM [VirtualBox](https://www.virtualbox.org/wiki/Downloads) is a virtualization application that runs on {{site.data.keyword.macOS_notm}}, Solaris and Windows as well as Linux. Its Virtual Machine Manager user interface has a reasonable learning curve for beginners while keeping advanced settings within easy reach. @@ -230,7 +230,7 @@ Network > Adapter 1 | Set `Attached to` to `Bridged Adapter` to share network wi [^vbox-nofloppy]: It is also good idea to disable unused devices. -#### QEMU with GNOME Boxes +#### QEMU with GNOME Boxes The QEMU virtualization software is preinstalled on most major GNU/Linux distributions. There are several ways to use QEMU, from third-party VM managers to the command line, but GNOME Boxes is one of the simplest. @@ -252,7 +252,7 @@ To create a VM in Boxes: All new VMs are configured with bridged networking and thus share the same network as the host. -### Installing Ubuntu for the All-in-One Environment +### Installing Ubuntu for the All-in-One Environment Ubuntu image files (or ISOs) may be configured to use one of these installers: @@ -260,7 +260,7 @@ Ubuntu image files (or ISOs) may be configured to use one of these installers: - [Debian-style](#install-os-debstyle) (with a purple background and grey dialog boxes) -#### Subiquity Installer +#### Subiquity Installer Choose the following options when prompted, when installing with Subiquity: @@ -283,7 +283,7 @@ Only skip updates if the update stalls for an unreasonably long time. Remember t If prompted, press Enter to reboot. -#### Debian-style Installer +#### Debian-style Installer Choose the following options when prompted, when using the Debian-style installer: @@ -309,7 +309,7 @@ On the last `Installation complete` dialog box, select `Continue`. [^ubuntu-location]: The location list changes according to the language you have selected -#### Ubuntu Server Notes +#### Ubuntu Server Notes The first boot after installation may be slow. A VM may appear to be unresponsive and present a blank screen for up to a few minutes. A login prompt should soon appear. @@ -323,7 +323,7 @@ sudo apt-get -y update Once you have set up your VM, you are ready to deploy the all-in-one environment. Instructions are at [the top of this file](#deploy-all-in-one). -#### Using SSH with your VM +#### Using SSH with your VM If your VM is correctly set up with the OpenSSH server, and an SSH client is correctly set up on your host, you can log in to your VM from a terminal on your host by running: