updates to NOTEs in documentation
This commit is contained in:
Blake Harnden
parent
0d490344fc
commit
36b3243a4b
6 changed files with 19 additions and 19 deletions
|
|
@ -30,11 +30,11 @@ new sessions will use by default. To simultaneously run multiple sessions with
|
|||
control networks, the session option should be used instead of the *core.conf*
|
||||
default.
|
||||
|
||||
> :warning: If you have a large scenario with more than 253 nodes, use a control
|
||||
> **NOTE:** If you have a large scenario with more than 253 nodes, use a control
|
||||
network prefix that allows more than the suggested */24*, such as */23* or
|
||||
greater.
|
||||
|
||||
> :warning: Running a session with a control network can fail if a previous
|
||||
> **NOTE:** Running a session with a control network can fail if a previous
|
||||
session has set up a control network and the its bridge is still up. Close
|
||||
the previous session first or wait for it to complete. If unable to, the
|
||||
*core-daemon* may need to be restarted and the lingering bridge(s) removed
|
||||
|
|
@ -52,7 +52,7 @@ for cb in $ctrlbridges; do
|
|||
done
|
||||
```
|
||||
|
||||
> :bulb: If adjustments to the primary control network configuration made in
|
||||
> **NOTE:** If adjustments to the primary control network configuration made in
|
||||
*/etc/core/core.conf* do not seem to take affect, check if there is anything
|
||||
set in the *Session Menu*, the *Options...* dialog. They may need to be
|
||||
cleared. These per session settings override the defaults in
|
||||
|
|
@ -120,7 +120,7 @@ assign *ctrl1* to the OTA manager device and *ctrl2* to the Event Service
|
|||
device in the EMANE Options dialog box and leave *ctrl0* for CORE control
|
||||
traffic.
|
||||
|
||||
> :warning: *controlnet0* may be used in place of *controlnet* to configure
|
||||
> **NOTE:** *controlnet0* may be used in place of *controlnet* to configure
|
||||
>the primary control network.
|
||||
|
||||
Unlike the primary control network, the auxiliary control networks will not
|
||||
|
|
@ -139,7 +139,7 @@ controlnetif2 = eth2
|
|||
controlnetif3 = eth3
|
||||
```
|
||||
|
||||
> :warning: There is no need to assign an interface to the primary control
|
||||
> **NOTE:** There is no need to assign an interface to the primary control
|
||||
>network because tunnels are formed between the master and the slaves using IP
|
||||
>addresses that are provided in *servers.conf*.
|
||||
|
||||
|
|
|
|||
|
|
@ -224,7 +224,7 @@ configured. Click *Apply* to save these settings.
|
|||
|
||||
|
||||
|
||||
> :bulb: Here is a quick checklist for distributed emulation with EMANE.
|
||||
> **NOTE:** Here is a quick checklist for distributed emulation with EMANE.
|
||||
|
||||
1. Follow the steps outlined for normal CORE.
|
||||
2. Under the *EMANE* tab of the EMANE WLAN, click on *EMANE options*.
|
||||
|
|
|
|||
12
docs/gui.md
12
docs/gui.md
|
|
@ -369,7 +369,7 @@ physical interface. A list of available interfaces will be shown, and one may
|
|||
be selected by double-clicking its name in the list, or an interface name may
|
||||
be entered into the text box.
|
||||
|
||||
> :warning: When you press the Start button to instantiate your topology, the
|
||||
> **NOTE:** When you press the Start button to instantiate your topology, the
|
||||
interface assigned to the RJ45 will be connected to the CORE topology. The
|
||||
interface can no longer be used by the system. For example, if there was an
|
||||
IP address assigned to the physical interface before execution, the address
|
||||
|
|
@ -409,7 +409,7 @@ the node will display "UNASSIGNED". This text should be replaced with the IP
|
|||
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.
|
||||
|
||||
> :warning: Be aware of possible MTU (Maximum Transmission Unit) issues with GRE devices. The *gretap* device
|
||||
> **NOTE:** 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
|
||||
|
|
@ -674,7 +674,7 @@ would appear for a failed validation command with the UserDefined service.
|
|||
Buttons are available at the bottom of the dialog for clearing the exception
|
||||
list and for viewing the CORE daemon and node log files.
|
||||
|
||||
> :warning: In batch mode, exceptions received from the CORE daemon are displayed on
|
||||
> **NOTE:** In batch mode, exceptions received from the CORE daemon are displayed on
|
||||
the console.
|
||||
|
||||
## Configuration Files
|
||||
|
|
@ -694,17 +694,17 @@ has a block contained in braces. The first block is indented by four spaces.
|
|||
Within the **network-config** block (and any *custom-*-config* block), the
|
||||
indentation is one tab character.
|
||||
|
||||
> :bulb: There are several topology examples included with CORE in
|
||||
> **NOTE:** There are several topology examples included with CORE in
|
||||
the **configs/** directory.
|
||||
This directory can be found in **~/.core/configs**, or
|
||||
installed to the filesystem
|
||||
under **/usr[/local]/share/examples/configs**.
|
||||
|
||||
> :bulb: When using the **.imn** file format, file paths for things like custom
|
||||
> **NOTE:** When using the **.imn** file format, file paths for things like custom
|
||||
icons may contain the special variables **$CORE_DATA_DIR** or **$CONFDIR** which
|
||||
will be substituted with **/usr/share/core** or **~/.core/configs**.
|
||||
|
||||
> :bulb: Feel free to edit the files directly using your favorite text editor.
|
||||
> **NOTE:** Feel free to edit the files directly using your favorite text editor.
|
||||
|
||||
## Customizing your Topology's Look
|
||||
|
||||
|
|
|
|||
|
|
@ -32,8 +32,8 @@ the number of times the system as a whole needed to deal with a packet. As
|
|||
more network hops are added, this increases the number of context switches
|
||||
and decreases the throughput seen on the full length of the network path.
|
||||
|
||||
> :warning: The right question to be asking is *"how much traffic?"*, not
|
||||
*"how many nodes?"*.**
|
||||
> **NOTE:** The right question to be asking is *"how much traffic?"*, not
|
||||
*"how many nodes?"*.
|
||||
|
||||
For a more detailed study of performance in CORE, refer to the following
|
||||
publications:
|
||||
|
|
|
|||
|
|
@ -66,7 +66,7 @@ The CORE Python modules are documented with comments in the code. From an
|
|||
interactive Python shell, you can retrieve online help about the various
|
||||
classes and methods; for example *help(CoreNode)* or *help(Session)*.
|
||||
|
||||
> :warning: The CORE daemon *core-daemon* manages a list of sessions and allows
|
||||
> **NOTE:** The CORE daemon *core-daemon* manages a list of sessions and allows
|
||||
the GUI to connect and control sessions. Your Python script uses the same CORE
|
||||
modules but runs independently of the daemon. The daemon does not need to be
|
||||
running for your script to work.
|
||||
|
|
|
|||
|
|
@ -15,7 +15,7 @@ set of default services. Each service defines the per-node directories,
|
|||
configuration files, startup index, starting commands, validation commands,
|
||||
shutdown commands, and meta-data associated with a node.
|
||||
|
||||
> :warning: **Network namespace nodes do not undergo the normal Linux boot process**
|
||||
> **NOTE:** **Network namespace nodes do not undergo the normal Linux boot process**
|
||||
using the **init**, **upstart**, or **systemd** frameworks. These
|
||||
lightweight nodes use configured CORE *services*.
|
||||
|
||||
|
|
@ -79,7 +79,7 @@ the service customization dialog for that service.
|
|||
The dialog has three tabs for configuring the different aspects of the service:
|
||||
files, directories, and startup/shutdown.
|
||||
|
||||
> :warning: A **yellow** customize icon next to a service indicates that service
|
||||
> **NOTE:** A **yellow** customize icon next to a service indicates that service
|
||||
requires customization (e.g. the *Firewall* service).
|
||||
A **green** customize icon indicates that a custom configuration exists.
|
||||
Click the *Defaults* button when customizing a service to remove any
|
||||
|
|
@ -98,7 +98,7 @@ per-node directories that are defined by the services. For example, the
|
|||
the Zebra service, because Quagga running on each node needs to write separate
|
||||
PID files to that directory.
|
||||
|
||||
> :warning: The **/var/log** and **/var/run** directories are
|
||||
> **NOTE:** The **/var/log** and **/var/run** directories are
|
||||
mounted uniquely per-node by default.
|
||||
Per-node mount targets can be found in **/tmp/pycore.nnnnn/nN.conf/**
|
||||
(where *nnnnn* is the session number and *N* is the node number.)
|
||||
|
|
@ -128,7 +128,7 @@ if a process is running and return zero when found. When a validate command
|
|||
produces a non-zero return value, an exception is generated, which will cause
|
||||
an error to be displayed in the Check Emulation Light.
|
||||
|
||||
> :bulb: To start, stop, and restart services during run-time, right-click a
|
||||
> **NOTE:** To start, stop, and restart services during run-time, right-click a
|
||||
node and use the *Services...* menu.
|
||||
|
||||
## New Services
|
||||
|
|
|
|||
Loading…
Reference in a new issue