afonso/core-extra
1
0
Fork 0
Code Issues Pull requests Projects Releases Wiki Activity

merged latest from develop

Browse source
This commit is contained in:
Blake Harnden 2019-06-03 13:06:11 -07:00
commit 7efec88e79
178 changed files with 11969 additions and 692 deletions
Download patch file Download diff file Expand all files Collapse all files

BIN
docs/static/core_screenshot.png vendored Normal file
View file

Binary file not shown.
Side by side

After

Width:  |  Height:  |  Size: 753 KiB

18
docs/usage.md
View file

@ -1,16 +1,26 @@
# Using the CORE GUI
* Table of Contents
{:toc}
The following image shows the CORE GUI:
![](static/core_screenshot.png)
## Overview
CORE can be used via the GUI or [Python_Scripting](scripting.md). Often the GUI is used to draw nodes and network devices on the canvas. A Python script could also be written, that imports the CORE Python module, to configure and instantiate nodes and networks. This chapter primarily covers usage of the CORE GUI.
The following image shows the various phases of a CORE session:
![](static/core-workflow.jpg)
After pressing the start button, CORE will proceed through these phases, staying in the **runtime** phase. After the session is stopped, CORE will proceed to the **data collection** phase before tearing down the emulated state.
CORE can be customized to perform any action at each phase in the workflow above. See the *Hooks...* entry on the **Session Menu** for details about when these session states are reached.
__Note: The CORE GUI is currently in a state of transition. The replacement candidate is currently in an alpha version, and can be found [here](https://github.com/coreemu/core/wiki/CORE-GUI-Update).__
## Prerequisites
Beyond instaling CORE, you must have the CORE daemon running. This is done on the command line with either Systemd or SysV
@ -23,6 +33,12 @@ sudo systemctl start core-daemon
sudo service core-daemon start
```
You can also invoke the daemon directly from the command line, which can be useful if you'd like to see the logging output directly.
```
# direct invocation
sudo core-daemon
```
## Modes of Operation
The CORE GUI has two primary modes of operation, **Edit** and **Execute** modes. Running the GUI, by typing **core-gui** with no options, starts in Edit mode. Nodes are drawn on a blank canvas using the toolbar on the left and configured from right-click menus or by double-clicking them. The GUI does not need to be run as root.
@ -470,7 +486,7 @@ address of the tunnel peer. This is the IP address of the other CORE machine or
physical machine, not an IP address of another virtual node.
**NOTE:**
Be aware of possible MTU issues with GRE devices. The *gretap* device
Be aware of possible MTU (Maximum Transmission Unit) issues with GRE devices. The *gretap* device
has an interface MTU of 1,458 bytes; when joined to a Linux bridge, the
bridge's MTU
becomes 1,458 bytes. The Linux bridge will not perform fragmentation for