8 KiB
CORE Installation
- Table of Contents {:toc}
Overview
This section will describe how to install CORE from source or from a pre-built package.
Required Hardware
Any computer capable of running Linux should be able to run CORE. Since the physical machine will be hosting numerous virtual machines, as a general rule you should select a machine having as much RAM and CPU resources as possible.
Operating System
CORE requires a Linux operating system because it uses virtualization provided by the kernel. It does not run on Windows or Mac OS X operating systems (unless it is running within a virtual machine guest.) The virtualization technology that CORE currently uses is Linux network namespaces.
Ubuntu and Fedora/CentOS Linux are the recommended distributions for running CORE. However, these distributions are not strictly required. CORE will likely work on other flavors of Linux as well, assuming dependencies are met.
NOTE: CORE Services determine what run on each node. You may require other software packages depending on the services you wish to use. For example, the HTTP service will require the apache2 package.
Installed Files
CORE files are installed to the following directories, when the installation prefix is /usr.
| Install Path | Description |
|---|---|
| /usr/bin/core-gui | GUI startup command |
| /usr/bin/coretk-gui | BETA Python GUI |
| /usr/bin/core-daemon | Daemon startup command |
| /usr/bin/{core-cleanup, coresendmsg, core-manage} | Misc. helper commands/scripts |
| /usr/lib/core | GUI files |
| /usr/lib/python{3.6+}/dist-packages/core | Python modules for daemon/scripts |
| /etc/core/ | Daemon and log configuration files |
| ~/.core/ | User-specific GUI preferences and scenario files |
| /usr/share/core/ | Example scripts and scenarios |
| /usr/share/man/man1/ | Command man pages |
| /etc/init.d/core-daemon | SysV startup script for daemon |
| /etc/systemd/system/core-daemon.service | Systemd startup script for daemon |
Pre-Req Installing Python
You may already have these installed, and can ignore this step if so, but if needed you can run the following to install python and pip.
sudo apt install python3.6
sudo apt install python3-pip
Pre-Req Python Requirements
The newly added gRPC API which depends on python library grpcio is not commonly found within system repos. To account for this it would be recommended to install the python dependencies using the requirements.txt found in the latest CORE Release.
sudo pip3 install -r requirements.txt
Pre-Req Installing OSPF MDR
Virtual networks generally require some form of routing in order to work (e.g. to automatically populate routing tables for routing packets from one subnet to another.) CORE builds OSPF routing protocol configurations by default when the blue router node type is used.
- OSPF MANET Designated Routers (MDR) - the Quagga routing suite with a modified version of OSPFv3, optimized for use with mobile wireless networks. The mdr node type (and the MDR service) requires this variant of Quagga.
Ubuntu <= 16.04 and Fedora/CentOS
There is a built package which can be used.
wget https://github.com/USNavalResearchLaboratory/ospf-mdr/releases/download/v0.99.21mr2.2/quagga-mr_0.99.21mr2.2_amd64.deb
sudo dpkg -i quagga-mr_0.99.21mr2.2_amd64.deb
Ubuntu >= 18.04
Requires building from source, from the latest nightly snapshot.
# packages needed beyond what's normally required to build core on ubuntu
sudo apt install libtool libreadline-dev autoconf gawk
git clone https://github.com/USNavalResearchLaboratory/ospf-mdr
cd ospf-mdr
./bootstrap.sh
./configure --disable-doc --enable-user=root --enable-group=root --with-cflags=-ggdb \
--sysconfdir=/usr/local/etc/quagga --enable-vtysh \
--localstatedir=/var/run/quagga
make
sudo make install
Note that the configuration directory /usr/local/etc/quagga shown for Quagga above could be /etc/quagga, if you create a symbolic link from /etc/quagga/Quagga.conf -> /usr/local/etc/quagga/Quagga.conf on the host. The quaggaboot.sh script in a Linux network namespace will try and do this for you if needed.
If you try to run quagga after installing from source and get an error such as:
error while loading shared libraries libzebra.so.0
this is usually a sign that you have to run ```sudo ldconfig```` to refresh the cache file.
Installing from Packages
The easiest way to install CORE is using the pre-built packages. The package managers on Ubuntu or Fedora/CentOS will help in automatically installing most dependencies, except for the python ones described previously.
You can obtain the CORE packages from CORE Releases.
Ubuntu
Ubuntu package defaults to using systemd for running as a service.
sudo apt install ./core_$VERSION_amd64.deb
Run the CORE GUI as a normal user:
core-gui
After running the core-gui command, a GUI should appear with a canvas for drawing topologies. Messages will print out on the console about connecting to the CORE daemon.
Fedora/CentOS
NOTE: tkimg is not required for the core-gui, but if you get an error message about it you can install the package on CentOS <= 6, or build from source otherwise
yum install ./core_$VERSION_x86_64.rpm
Disabling SELINUX:
# change the following in /etc/sysconfig/selinux
SELINUX=disabled
# add the following to the kernel line in /etc/grub.conf
selinux=0
# Fedora 15 and newer, disable sandboxd
# reboot in order for this change to take effect
chkconfig sandbox off
Turn off firewalls:
systemctl disable firewalld
systemctl disable iptables.service
systemctl disable ip6tables.service
chkconfig iptables off
chkconfig ip6tables off
You need to reboot after making these changes, or flush the firewall using
iptables -F
ip6tables -F
Start the CORE daemon.
# systemd
sudo systemctl daemon-reload
sudo systemctl start core-daemon
# sysv
sudo service core-daemon start
Run the CORE GUI as a normal user:
core-gui
After running the core-gui command, a GUI should appear with a canvas for drawing topologies. Messages will print out on the console about connecting to the CORE daemon.
Building and Installing from Source
This option is listed here for developers and advanced users who are comfortable patching and building source code. Please consider using the binary packages instead for a simplified install experience.
Download and Extract Source Code
You can obtain the CORE source from the CORE GitHub page.
Install grpcio-tools
Python module grpcio-tools is currently needed to generate code from the CORE protobuf file during the build.
sudo pip3 install grpcio-tools
Distro Requirements
Ubuntu 18.04 Requirements
sudo apt install automake pkg-config gcc iproute2 libev-dev ebtables python3.6 python3.6-dev python3-pip tk libtk-img ethtool python3-tk
Ubuntu 16.04 Requirements
sudo apt-get install automake ebtables python3-dev libev-dev python3-setuptools libtk-img ethtool
CentOS 7 with Gnome Desktop Requirements
sudo yum -y install automake gcc python36 python36-devel libev-devel tk ethtool iptables-ebtables iproute python3-pip python3-tkinter
Build and Install
./bootstrap.sh
./configure
make
sudo make install
Building Documentation
Building documentation requires python-sphinx not noted above.
sudo apt install python3-sphinx
sudo yum install python3-sphinx
./bootstrap.sh
./configure
make doc
Building Packages
Build package commands, DESTDIR is used to make install into and then for packaging by fpm.
NOTE: clean the DESTDIR if re-using the same directory
- Install fpm
./bootstrap.sh
./configure
make
mkdir /tmp/core-build
make fpm DESTDIR=/tmp/core-build
This will produce and RPM and Deb package for the currently configured python version.