Difference between revisions of "StarlingX/Installation Guide"

Latest revision as of 20:53, 26 July 2019

See the StarlingX Deploy and Installation Guide for information on installing StarlingX. This wiki page has been deprecated.

@@ Line 1: / Line 1: @@
+See the [https://docs.starlingx.io/deploy_install_guides/index.html StarlingX Deploy and Installation Guide] for information on installing StarlingX.  This wiki page has been deprecated.
+<!--
 == Intro ==
@@ Line 5: / Line 11: @@
 * '''Virtual Environment''': It should only be used for evaluation or development purposes.
 <br>
-StarlingX installed in virtual environments has two options currently known to work:
+StarlingX installed in virtual environments has two options:
 * [[Installation_libvirt_qemu|Libvirt/QEMU]]
 * VirtualBox
-==Requirements==
+== Requirements ==
 Different use cases require different configurations.
-===Bare Metal===
+=== Bare Metal ===
+The minimum requirements for the physical servers where StarlingX might be deployed, include:
+* '''Controller Hosts'''
+** Minimum Processor is:
+*** Dual-CPU Intel® Xeon® E5 26xx Family (SandyBridge) 8 cores/socket
+** Minimum Memory: 64 GB
+** Hard Drives:
+*** Primary Hard Drive, minimum 500 GB for OS and system databases.
+*** Secondary Hard Drive, minimum 500 GB for persistent VM storage.
+** 2 physical Ethernet interfaces: OAM and MGMT Network.
+** USB boot support.
+** PXE boot support.
+* '''Storage Hosts'''
+** Minimum Processor is:
+*** Dual-CPU Intel® Xeon® E5 26xx Family (SandyBridge) 8 cores/socket.
+** Minimum Memory: 64 GB.
+** Hard Drives:
+*** Primary Hard Drive, minimum 500 GB for OS.
+*** 1 or more additional Hard Drives for CEPH OSD storage, and
+*** Optionally 1 or more SSD or NVMe Drives for CEPH Journals.
+** 1 physical Ethernet interface: MGMT Network
+** PXE boot support.
+* '''Compute Hosts'''
+** Minimum Processor is:
+*** Dual-CPU Intel® Xeon® E5 26xx Family (SandyBridge) 8 cores/socket.
+** Minimum Memory: 32 GB.
+** Hard Drives:
+*** Primary Hard Drive, minimum 500 GB for OS.
+*** 1 or more additional Hard Drives for ephemeral VM Storage.
+** 2 or more physical Ethernet interfaces: MGMT Network and 1 or more Provider Networks.
+** PXE boot support.
+<br>
 The recommended minimum requirements for the physical servers are described later in each StarlingX Deployment Options guide.
-===Virtual Environment===
+=== Virtual Environment ===
+The recommended minimum requirements for the workstation, hosting the Virtual Machine(s) where StarlingX will be deployed, include:
+==== Hardware Requirements ====
-The recommended minimum requirements for the workstation, running the Virtual Machine(s) where StarlingX will be deployed, include:
-<br>
 A workstation computer with:
@@ Line 29: / Line 69: @@
 * Network: Two network adapters with active Internet connection
-====Software Requirements====
+==== Software Requirements ====
 A workstation computer with:
@@ Line 42: / Line 82: @@
 * StarlingX ISO Image
-===Deployment Environment Setup===
+==== Deployment Environment Setup ====
-This section describes how to set up a StarlingX Controller Storage system in a workstation computer. After completing these steps, you will be able to deploy and run your StarlingX system on the following Linux distribution:
-* Ubuntu 16.04 LTS 64-bit
+This section describes how to set up the workstation computer which will host the Virtual Machine(s) where StarlingX will be deployed.
-====Updating Your Operating System====
+===== Updating Your Operating System =====
 Before proceeding with the build, ensure your OS is up to date. You’ll first need to update the local database list of available packages:
@@ Line 56: / Line 94: @@
 </nowiki></pre>
-====Install stx-tools project====
+===== Install stx-tools project =====
 Clone the stx-tools project. Usually you’ll want to clone it under your user’s home directory.
@@ Line 65: / Line 103: @@
 </nowiki></pre>
-====Installing Requirements and Dependencies====
+===== Installing Requirements and Dependencies =====
 Navigate to the stx-tools installation libvirt directory:
@@ Line 77: / Line 115: @@
 </nowiki></pre>
-====Disabling Firewall====
+===== Disabling Firewall =====
 Unload firewall and disable firewall on boot:
@@ Line 88: / Line 126: @@
 </nowiki></pre>
-==Getting the StarlingX ISO Image==
+== Getting the StarlingX ISO Image ==
+Follow the instructions from [[StarlingX/Developer_Guide]] to build a StarlingX ISO image.
-Follow the instructions from [[StarlingX/Developer_Guide]] to build a StarlingX ISO image. Copy the StarlingX ISO Image to the ''<stx-deployment>'' libvirt project directory naming it as bootimage.iso:
+=== Bare Metal ===
+A bootable USB flash drive containing StarlingX ISO image.
+=== Virtual Environment ===
+Copy the StarlingX ISO Image to the stx-tools deployment libvirt project directory:
 <pre><nowiki>
-$ cp <starlingx iso image> $HOME/stx-tools/deployment/libvirt/bootimage.iso
+$ cp <starlingx iso image> $HOME/stx-tools/deployment/libvirt/
 </nowiki></pre>
-==Deployment Options==
+== Deployment Options ==
 * Standard Controller
-** [[StarlingX/Installation Guide Virtual Environment/Dedicated Storage|StarlingX Cloud with Dedicated Storage Virtual Environment]]
+** [[StarlingX/Installation Guide/Dedicated Storage|StarlingX Cloud with Dedicated Storage]]
-** [[StarlingX/Installation Guide Virtual Environment/Controller Storage|StarlingX Cloud with Controller Storage Virtual Environment]]
+** [[StarlingX/Installation Guide/Controller Storage|StarlingX Cloud with Controller Storage]]
 * All-in-one
-** [[StarlingX/Installation Guide Virtual Environment/Duplex|StarlingX Cloud Duplex Virtual Environment]]
+** [[StarlingX/Installation Guide/Duplex|StarlingX Cloud Duplex]]
-** [[StarlingX/Installation Guide Virtual Environment/Simplex|StarlingX Cloud Simplex Virtual Environment]]
+** [[StarlingX/Installation Guide/Simplex|StarlingX Cloud Simplex]]
+-->