Merge pull request #712 from coreemu/develop

merge develop for 9.0.0 release

Author: bharnden

.github/workflows/daemon-checks.yml

@@ -4,13 +4,13 @@ on: [push]
 
 jobs:
   build:
-    runs-on: ubuntu-18.04
+    runs-on: ubuntu-22.04
     steps:
       - uses: actions/checkout@v1
-      - name: Set up Python 3.6
+      - name: Set up Python 3.9
         uses: actions/setup-python@v1
         with:
-          python-version: 3.6
+          python-version: 3.9
       - name: install poetry
         run: |
           python -m pip install --upgrade pip

.gitignore

@@ -14,6 +14,7 @@ config.h.in
 config.log
 config.status
 configure
+configure~
 debian
 stamp-h1
 
@@ -58,3 +59,6 @@ daemon/setup.py
 
 # python
 __pycache__
+
+# ignore core player files
+*.core

CHANGELOG.md

@@ -1,3 +1,46 @@
+## 2022-11-18 CORE 9.0.0
+
+* Breaking Changes
+    * removed session nodes file
+    * removed session state file
+    * emane now runs in one process per nem with unique control ports
+    * grpc client has been refactored and updated
+    * removed tcl/legacy gui, imn file support and the tlv api
+    * link configuration is now different, but consistent, for wired links
+* Installation
+    * added packaging for single file distribution
+    * python3.9 is now the minimum required version
+    * updated Dockerfile examples
+    * updated various python dependencies
+    * virtual environment is now installed to /opt/core/venv
+* Documentation
+    * updated emane invoke task examples
+    * revamped install documentation
+    * added wireless node notes
+* core-gui
+    * updated config services to display rendered templated and allow editing
+    * fixed node icon issue when updating preferences
+    * \#89 - throughput widget now works for hubs/switches
+    * \#691 - fixed custom nodes to properly use config services
+* gRPC API
+    * add linked call to support linking and unlinking interfaces without destroying them
+    * fixed issue during start session clearing out session options
+    * added call to get rendered config service files
+    * removed get_node_links from links from client
+    * nem id and nem port have been added to GetNode and AddLink calls
+* core-daemon
+    * wired links always create two veth pairs joined by a bridge
+    * node interfaces are now configured within the container to apply to outgoing traffic
+    * session.add_node now uses NodeOptions, allowing for node specific options
+    * fixed issue with xml reading node canvas values
+    * removed Session.add_node_file
+    * fixed get requirements logic
+    * fixed docker/lxd node support terminal commands on remote servers
+    * improved docker node command execution time using nsenter
+    * new wireless node type added to support dynamic loss based on distance
+    * \#513 - add and deleting distributed links during runtime is now supported
+    * \#703 - fixed issue not starting emane event listening service
+
 ## 2022-03-21 CORE 8.2.0
 
 * core-gui

Dockerfile

@@ -6,10 +6,6 @@ if WANT_DOCS
   DOCS = docs man
 endif
 
-if WANT_GUI
-  GUI = gui
-endif
-
 if WANT_DAEMON
   DAEMON = daemon
 endif
@@ -19,12 +15,13 @@ if WANT_NETNS
 endif
 
 # keep docs last due to dependencies on binaries
-SUBDIRS = $(GUI) $(DAEMON) $(NETNS) $(DOCS)
+SUBDIRS = $(DAEMON) $(NETNS) $(DOCS)
 
 ACLOCAL_AMFLAGS = -I config
 
 # extra files to include with distribution tarball
 EXTRA_DIST = bootstrap.sh \
+		 package \
 	     LICENSE \
 	     README.md \
 	     ASSIGNMENT_OF_COPYRIGHT.pdf \
@@ -51,7 +48,7 @@ fpm -s dir -t deb -n core-distributed \
 	--description "Common Open Research Emulator Distributed Package" \
 	--url https://github.com/coreemu/core \
 	--vendor "$(PACKAGE_VENDOR)" \
-	-p core_distributed_VERSION_ARCH.deb \
+	-p core-distributed_VERSION_ARCH.deb \
 	-v $(PACKAGE_VERSION) \
 	-d "ethtool" \
 	-d "procps" \
@@ -62,7 +59,8 @@ fpm -s dir -t deb -n core-distributed \
 	-d "libev4" \
 	-d "openssh-server" \
 	-d "xterm" \
-	-C $(DESTDIR)
+	netns/vnoded=/usr/bin/ \
+	netns/vcmd=/usr/bin/
 endef
 
 define fpm-distributed-rpm =
@@ -72,7 +70,7 @@ fpm -s dir -t rpm -n core-distributed \
 	--description "Common Open Research Emulator Distributed Package" \
 	--url https://github.com/coreemu/core \
 	--vendor "$(PACKAGE_VENDOR)" \
-	-p core_distributed_VERSION_ARCH.rpm \
+	-p core-distributed_VERSION_ARCH.rpm \
 	-v $(PACKAGE_VERSION) \
 	-d "ethtool" \
 	-d "procps-ng" \
@@ -83,12 +81,75 @@ fpm -s dir -t rpm -n core-distributed \
 	-d "net-tools" \
 	-d "openssh-server" \
 	-d "xterm" \
-	-C $(DESTDIR)
+	netns/vnoded=/usr/bin/ \
+	netns/vcmd=/usr/bin/
+endef
+
+define fpm-rpm =
+fpm -s dir -t rpm -n core \
+	-m "$(PACKAGE_MAINTAINERS)" \
+	--license "BSD" \
+	--description "core vnoded/vcmd and system dependencies" \
+	--url https://github.com/coreemu/core \
+	--vendor "$(PACKAGE_VENDOR)" \
+	-p core_VERSION_ARCH.rpm \
+	-v $(PACKAGE_VERSION) \
+	--rpm-init package/core-daemon \
+	--after-install package/after-install.sh \
+	--after-remove package/after-remove.sh \
+	-d "ethtool" \
+	-d "tk" \
+	-d "procps-ng" \
+	-d "bash >= 3.0" \
+	-d "ebtables" \
+	-d "iproute" \
+	-d "libev" \
+	-d "net-tools" \
+	-d "nftables" \
+	netns/vnoded=/usr/bin/ \
+	netns/vcmd=/usr/bin/ \
+	package/etc/core.conf=/etc/core/ \
+	package/etc/logging.conf=/etc/core/ \
+	package/examples=/opt/core/ \
+	daemon/dist/core-$(PACKAGE_VERSION)-py3-none-any.whl=/opt/core/
+endef
+
+define fpm-deb =
+fpm -s dir -t deb -n core \
+	-m "$(PACKAGE_MAINTAINERS)" \
+	--license "BSD" \
+	--description "core vnoded/vcmd and system dependencies" \
+	--url https://github.com/coreemu/core \
+	--vendor "$(PACKAGE_VENDOR)" \
+	-p core_VERSION_ARCH.deb \
+	-v $(PACKAGE_VERSION) \
+	--deb-systemd package/core-daemon.service \
+	--deb-no-default-config-files \
+	--after-install package/after-install.sh \
+	--after-remove package/after-remove.sh \
+	-d "ethtool" \
+	-d "tk" \
+	-d "libtk-img" \
+	-d "procps" \
+	-d "libc6 >= 2.14" \
+	-d "bash >= 3.0" \
+	-d "ebtables" \
+	-d "iproute2" \
+	-d "libev4" \
+	-d "nftables" \
+	netns/vnoded=/usr/bin/ \
+	netns/vcmd=/usr/bin/ \
+	package/etc/core.conf=/etc/core/ \
+	package/etc/logging.conf=/etc/core/ \
+	package/examples=/opt/core/ \
+	daemon/dist/core-$(PACKAGE_VERSION)-py3-none-any.whl=/opt/core/
 endef
 
-.PHONY: fpm-distributed
-fpm-distributed: clean-local-fpm
-	$(MAKE) -C netns install DESTDIR=$(DESTDIR)
+.PHONY: fpm
+fpm: clean-local-fpm
+	cd daemon && poetry build -f wheel
+	$(call fpm-deb)
+	$(call fpm-rpm)
 	$(call fpm-distributed-deb)
 	$(call fpm-distributed-rpm)
 
@@ -115,15 +176,13 @@ $(info creating file $1 from $1.in)
 	-e 's,[@]CORE_STATE_DIR[@],$(CORE_STATE_DIR),g' \
 	-e 's,[@]CORE_DATA_DIR[@],$(CORE_DATA_DIR),g' \
 	-e 's,[@]CORE_CONF_DIR[@],$(CORE_CONF_DIR),g' \
-	-e 's,[@]CORE_GUI_CONF_DIR[@],$(CORE_GUI_CONF_DIR),g' \
 	< $1.in > $1
 endef
 
 all: change-files
 
 .PHONY: change-files
 change-files:
-	$(call change-files,gui/core-gui-legacy)
 	$(call change-files,daemon/core/constants.py)
 	$(call change-files,netns/setup.py)
 

Makefile.am

@@ -1,26 +1,46 @@
 # CORE
-
 CORE: Common Open Research Emulator
 
 Copyright (c)2005-2022 the Boeing Company.
 
 See the LICENSE file included in this distribution.
 
 ## About
-
 The Common Open Research Emulator (CORE) is a tool for emulating
 networks on one or more machines. You can connect these emulated
 networks to live networks. CORE consists of a GUI for drawing
 topologies of lightweight virtual machines, and Python modules for
 scripting network emulation.
 
 ## Quick Start
+Requires Python 3.9+. More detailed instructions and install options can be found
+[here](https://coreemu.github.io/core/install.html).
+
+### Package Install
+Grab the latest deb/rpm from [releases](https://github.com/coreemu/core/releases).
+
+This will install vnoded/vcmd, system dependencies, and CORE within a python
+virtual environment at `/opt/core/venv`.
+```shell
+sudo <yum/apt> install -y ./<package>
+```
 
-The following should get you up and running on Ubuntu 18+ and CentOS 7+
-from a clean install, it will prompt you for sudo password. This would
+Then install OSPF MDR from source:
+```shell
+git clone https://github.com/USNavalResearchLaboratory/ospf-mdr.git
+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 -j$(nproc)
+sudo make install
+```
+
+### Script Install
+The following should get you up and running on Ubuntu 22.04. This would
 install CORE into a python3 virtual environment and install
 [OSPF MDR](https://github.com/USNavalResearchLaboratory/ospf-mdr) from source.
-For more detailed installation see [here](https://coreemu.github.io/core/install.html).
 
 ```shell
 git clone https://github.com/coreemu/core.git
@@ -36,7 +56,6 @@ inv install -p /usr
 ```
 
 ## Documentation & Support
-
 We are leveraging GitHub hosted documentation and Discord for persistent
 chat rooms. This allows for more dynamic conversations and the
 capability to respond faster. Feel free to join us at the link below.

README.md

@@ -1,9 +1,5 @@
 #!/bin/sh
 #
-# (c)2010-2012 the Boeing Company
-#
-# author:	Jeff Ahrenholz <[email protected]>
-#
 # Bootstrap the autoconf system.
 #