RackHD Release Installation Guide
Version List
for RackHD sprint release versions list, please refer to RackHD Release Page
Installation :
Installation From | Recommendation |
---|---|
docker | Recommended ! docker/docker-compose is required. refer below for detail. |
debian package | Pre-setup required. |
npm package | Pre-setup required. |
source code | similar as npm package. |
VMWare OVA | supported on demand or self-service. |
vagrant box | supported on demand or self-service. |
1.Docker
Prerequisite:
- docker v1.10 or higher (Install docker )
- docker-compose v1.6 or higher( Install Docker Compose)
sprint release
Latest nightly build
2.NPM
Sprint release
Prerequisite :
http://rackhd.readthedocs.io/en/latest/rackhd/npm_based_installation.html#prerequisites
- Install latest sprint release:
- Install specify version
Below code use 1.1.0 as an example:
Download static images & Start Services
1.. Create static directory and download static images for PXE bootsyou can follow steps in Line 51 - Line 77 of install_src.sh
2.Start services with pm2
2.1. Create a pm2.yml like below, the ```cwd``` field should locate the where the on-xxx package lives.
2.2. Run $sudo pm2 start pm2.yml
Latest nightly build
- Prerequisite :
- Install NodeJS 4.0 and dependencies
- Install latest nightly build:
- Start Services
Start services with the same steps as sprint release.
3.Debian packages
Prerequisites
Please install NodeJS 4.x before below steps if you are running on Ubuntu 14.04
http://rackhd.readthedocs.io/en/latest/rackhd/npm_based_installation.html#prerequisites
Otherwise, on-http will not be installed due to error " on-http : Depends: nodejs (>= 4.4.5-1nodesource1~) but it is not going to be installed"
sprint release
- Update Source List
- Install RackHD
Install previous( or specific ) RackHD release version, example : version 1.0.0
Latest nightly build
- Update Source List
- Get available version list
- Install specified RackHD , the ${version} is the one of the version list obtained by above step
4.Install from source code
sprint release
Prerequisite :
http://rackhd.readthedocs.io/en/latest/rackhd/npm_based_installation.html#prerequisites
Install RackHD from src code of specific version :
To clone and checkout to sprint release code( the version naming is like 1.0.0/1.1.0...etc). you can use the helper script or follow below steps.
Tips: you can find the "tag names"(like 1.1.0) from github , example: https://github.com/RackHD/on-core/releases
above command line will clone and build local code , according to git tag "release/1.1.0". then using PM2 to start services.
the tag name is actually a git-tag . you can change the tag name from version tagging to other tag.
OR
if you would like to do it by yourselves , you can follow:
1. clone all RackHD repos, then go into each on them:
2. link the on-core/on-tasks repo, to other repo's node_modules
3. Create static directory and download static images for PXE boots
you can follow steps in Line 51 - Line 77 of install_src.sh
4. using PM2 to start services
create a pm2.yml like below, the ```cwd``` field should locate the where the on-xxx code lives.
then run $sudo pm2 start pm2.yml
5. Vagrant box (legacy)
Before using vagrant we suggest to read vagrant docs first.
If you will use virtualbox/vagrant box under Windows, here's a blog article for your reference: How to set up RackHD demo under Windows (vagrant box)
sprint release
- Get RackHD vagrant box
- Note : vagrant version should be at least >= 1.8.5, to support `--box-version` parameter. ( check by ```vagrant -v ```)
This code snippet will pull the rackhd vagrant box of version 1.1.0. You can read the generated Vagrantfile for more configuration information.
below code use 1.1.0 version as an example:
- Important Tips
For running RackHD service successfully, you need to up a second netcard.
For change configuration of RackHD, you need to mount local config into vagrant.
For connecting RackHD out of box, you need to forward internal ports to outside .
example Vagrantfile for details. ( it's recommended to customized the vagrant file based on this example )
Please see ourLatest nightly build
Format of nightly build version is 0.mm.dd
. For example, you can get the nightly build on January 13 with
If you have own Vagrantfile, just modify the version number in it to 0.mm.dd
, and then you can up the vagrant box of related nightly build.
ATTENTION: nightly builds will only be kept for two weeks.