Difference between revisions of "StarlingX/Installation Guide"
(→Bare Metal) |
|||
Line 9: | Line 9: | ||
* VirtualBox | * VirtualBox | ||
− | ==Requirements== | + | == Requirements == |
Different use cases require different configurations. | Different use cases require different configurations. | ||
− | ===Bare Metal=== | + | === Bare Metal === |
The recommended minimum requirements for the physical servers are described later in each StarlingX Deployment Options guide. | 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, running the Virtual Machine(s) where StarlingX will be deployed, include: | The recommended minimum requirements for the workstation, running the Virtual Machine(s) where StarlingX will be deployed, include: | ||
Line 29: | Line 29: | ||
* Network: Two network adapters with active Internet connection | * Network: Two network adapters with active Internet connection | ||
− | ====Software Requirements==== | + | ==== Software Requirements ==== |
A workstation computer with: | A workstation computer with: | ||
Line 42: | Line 42: | ||
* StarlingX ISO Image | * StarlingX ISO Image | ||
− | ===Deployment Environment Setup=== | + | ==== Deployment Environment Setup ==== |
− | This section describes how to set up a StarlingX | + | This section describes how to set up a StarlingX 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 | * Ubuntu 16.04 LTS 64-bit | ||
− | ====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: | 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 56: | ||
</nowiki></pre> | </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. | Clone the stx-tools project. Usually you’ll want to clone it under your user’s home directory. | ||
Line 65: | Line 65: | ||
</nowiki></pre> | </nowiki></pre> | ||
− | ====Installing Requirements and Dependencies==== | + | ===== Installing Requirements and Dependencies ===== |
Navigate to the stx-tools installation libvirt directory: | Navigate to the stx-tools installation libvirt directory: | ||
Line 77: | Line 77: | ||
</nowiki></pre> | </nowiki></pre> | ||
− | ====Disabling Firewall==== | + | ===== Disabling Firewall ===== |
Unload firewall and disable firewall on boot: | Unload firewall and disable firewall on boot: | ||
Line 88: | Line 88: | ||
</nowiki></pre> | </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. Copy the StarlingX ISO Image to the ''<stx-deployment>'' libvirt project directory naming it as bootimage.iso: | 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: | ||
Line 96: | Line 96: | ||
</nowiki></pre> | </nowiki></pre> | ||
− | ==Deployment Options== | + | == Deployment Options == |
* Standard Controller | * Standard Controller |
Revision as of 19:28, 1 October 2018
Intro
StarlingX may be installed in:
- Bare Metal: Real deployments of StarlingX are only supported on physical servers.
- Virtual Environment: It should only be used for evaluation or development purposes.
StarlingX installed in virtual environments has two options currently known to work:
- Libvirt/QEMU
- VirtualBox
Requirements
Different use cases require different configurations.
Bare Metal
The recommended minimum requirements for the physical servers are described later in each StarlingX Deployment Options guide.
Virtual Environment
The recommended minimum requirements for the workstation, running the Virtual Machine(s) where StarlingX will be deployed, include:
A workstation computer with:
- Processor: x86_64 only supported architecture with BIOS enabled hardware virtualization extensions
- Cores: 8 (4 with careful monitoring of cpu load)
- Memory: At least 32GB RAM
- Hard Disk: 500GB HDD
- Network: Two network adapters with active Internet connection
Software Requirements
A workstation computer with:
- Operating System: Freshly installed Ubuntu 16.04 LTS 64-bit
- Proxy settings configured (if applies)
- Git
- KVM/VirtManager
- Libvirt Library
- QEMU Full System Emulation Binaries
- <stx-deployment> project
- StarlingX ISO Image
Deployment Environment Setup
This section describes how to set up a StarlingX 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
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:
$ sudo apt-get update
Install stx-tools project
Clone the stx-tools project. Usually you’ll want to clone it under your user’s home directory.
$ cd $HOME $ git clone git://git.openstack.org/openstack/stx-tools
Installing Requirements and Dependencies
Navigate to the stx-tools installation libvirt directory:
$ cd $HOME/stx-tools/deployment/libvirt/
Install the required packages:
$ bash install_packages.sh
Disabling Firewall
Unload firewall and disable firewall on boot:
$ sudo ufw disable Firewall stopped and disabled on system startup $ sudo ufw status Status: inactive
Getting the 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:
$ cp <starlingx iso image> $HOME/stx-tools/deployment/libvirt/bootimage.iso