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

documentation theme update, version bumping to 5.0, changes to cleanup pass for ns3 code

Browse source
This commit is contained in:
Blake J. Harnden 2017-08-17 15:25:12 -07:00
parent 340b37444b
commit 8155cdc617
14 changed files with 54 additions and 52 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

2
Changelog
View file

@ -7,7 +7,7 @@
- leverage "logzero" module to make easy usage of the standard logging module
- improvements to documentation across the code base
- initial work to separate the dependence on TCP API messaging from the core library (easier core scripting)
- beta support for running core in openvswitch mode, leveraging ovs bridges, instead of linux bridges
- beta support for running core in Open vSwitch mode, leveraging Open vSwitch bridges, instead of Linux bridges
* SERVICES:
- added Ryu SDN controller service
- added Open vSwitch service

2
configure.ac
View file

@ -12,7 +12,7 @@
#
# this defines the CORE version number, must be static for AC_INIT
#
AC_INIT(core, m4_esyscmd_s([./revision.sh 4.8]), core-dev@pf.itd.nrl.navy.mil)
AC_INIT(core, m4_esyscmd_s([./revision.sh 5.0]), core-dev@pf.itd.nrl.navy.mil)
VERSION=$PACKAGE_VERSION
CORE_VERSION=$PACKAGE_VERSION
CORE_VERSION_DATE=m4_esyscmd_s([./revision.sh -d])

2
daemon/Makefile.am
View file

@ -97,7 +97,7 @@ uninstall-local:
# Python package uninstall
uninstall-hook:
yes | pip uninstall core_python
yes | pip uninstall core-python
rm -f ${pythondir}/core_python_netns-1.0-py${PYTHON_VERSION}.egg-info
rm -rf ${pythondir}/core
rmdir -p $(coreexservicesdir) || true

2
daemon/ns3/examples/ns3wifi.py
View file

@ -41,7 +41,7 @@ def add_to_server(session):
"""
global server
try:
server.addsession(session)
server.add_session(session)
return True
except NameError:
return False

2
daemon/ns3/examples/ns3wifirandomwalk.py
View file

@ -30,7 +30,7 @@ def add_to_server(session):
"""
global server
try:
server.addsession(session)
server.add_session(session)
return True
except NameError:
return False

2
daemon/ns3/setup.py
View file

@ -2,7 +2,7 @@ from setuptools import setup
setup(
name="corens3-python",
version="5.0.0",
version="5.0",
packages=[
"corens3",
],

2
daemon/requirements.txt
View file

@ -7,5 +7,3 @@ pycco==0.5.1
pytest==3.0.7
pytest-cov==2.5.1
pytest-runner==2.11.1
sphinx==1.4.8
sphinx_rtd_theme==0.1.9

2
daemon/setup.py
View file

@ -8,7 +8,7 @@ Defines how CORE will be built for installation.
from setuptools import setup
setup(name="core-python",
version="5.0.0",
version="5.0",
packages=[
"core",
"core.addons",

5
doc/conf.py.in
View file

@ -12,6 +12,7 @@
# serve to show the default.
import sys, os
import sphinx_rtd_theme
# If extensions (or modules to document with autodoc) are in another directory,
# add these directories to sys.path here. If the directory is relative to the
@ -91,7 +92,7 @@ pygments_style = 'sphinx'
# The theme to use for HTML and HTML Help pages. See the documentation for
# a list of builtin themes.
html_theme = 'default'
html_theme = 'sphinx_rtd_theme'
# Theme options are theme-specific and customize the look and feel of a theme
# further. For a list of options available for each theme, see the
@ -99,7 +100,7 @@ html_theme = 'default'
#html_theme_options = {}
# Add any paths that contain custom themes here, relative to this directory.
#html_theme_path = []
html_theme_path = [sphinx_rtd_theme.get_html_theme_path()]
# The name for this set of Sphinx documents. If None, it defaults to
# "<project> v<release> documentation".

14
doc/intro.rst
View file

@ -30,17 +30,11 @@ demonstrations, application and platform testing, evaluating networking
scenarios, security studies, and increasing the size of physical test networks.
What's New?
=================
For readers who are already familiar with CORE and have read this manual before, below is a list of what changed in version 4.8:
* :ref:`Configuration_Files` - a new XML format has been defined by the U.S. Naval Research Lab (NRL) for the Network Management Framework. .
* :ref:`EMANE` - `Release 0.9.2 of EMANE <https://github.com/adjacentlink/emane/wiki/Release-Notes#092>`_ included a new capability that, in order to be leveraged, needs changes on how it is deployed by CORE. The EMANE section of this document has been updated with new method of connecting together the deployed instances.
* :ref:`Control_Network` - with EMANE 0.9.2, the CORE control network has become an important component of CORE. Auxiliary control networks have been added to the primary control network to host EMANE traffic. As a result, the discussion on the control network has been elevated to a top level topic.
* `Tips, Hints, Important Information` - miscellaneous information added to several chapters in the document.
===========
For readers who are already familiar with CORE and have read this manual before, below is a list of what changed in version 5.0:
* :ref:`Services` - Added Ryu SD and Open vSwitch services
* :ref:`Python_Scripting` - Updated script examples to reflect code changes
.. index::
single: CORE; components of

2
doc/requirements.txt Normal file
View file

@ -0,0 +1,2 @@
sphinx==1.6.3
sphinx_rtd_theme==0.2.4

21
doc/scripting.rst
View file

@ -37,14 +37,13 @@ allow for GUI connections.
Here are the basic elements of a CORE Python script:
::
#!/usr/bin/python
from core.session import Session
from core.netns import nodes
from core import pycore
session = pycore.Session(persistent=True)
node1 = session.addobj(cls=pycore.nodes.CoreNode, name="n1")
node2 = session.addobj(cls=pycore.nodes.CoreNode, name="n2")
hub1 = session.addobj(cls=pycore.nodes.HubNode, name="hub1")
session = Session(persistent=True)
node1 = session.add_object(cls=nodes.CoreNode, name="n1")
node2 = session.add_object(cls=nodes.CoreNode, name="n2")
hub1 = session.add_object(cls=nodes.HubNode, name="hub1")
node1.newnetif(hub1, ["10.0.0.1/24"])
node2.newnetif(hub1, ["10.0.0.2/24"])
@ -63,8 +62,8 @@ a test ping to the other.
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(pycore.nodes.CoreNode)* or
*help(pycore.Session)*.
classes and methods; for example *help(nodes.CoreNode)* or
*help(Session)*.
An interactive development environment (IDE) is available for browsing
the CORE source, the
@ -113,14 +112,14 @@ A global ``server`` variable is exposed to the script pointing to the
'''
global server
try:
server.addsession(session)
server.add_session(session)
return True
except NameError:
return False
::
session = pycore.Session(persistent=True)
session = Session(persistent=True)
add_to_server(session)

6
packaging/deb/changelog
View file

@ -1,3 +1,9 @@
core (5.0-0ubuntu1) precise; urgency=low
* Added Ryu SD and Open vSwitch services, code cleanup and refactoring
-- CORE Developers <core-dev@pf.itd.nrl.navy.mil> XXX, XX XXX 2017 00:00:00 -0700
core (4.8-0ubuntu1) precise; urgency=low
* Support for NRL Network Modeling Framework (NMF) XML representation, bugfixes

2
packaging/rpm/core.spec.in
View file

@ -410,6 +410,8 @@ fi
%{_sbindir}/vnoded
%changelog
* XXX XXX X 2017 CORE Developers <core-dev@pf.itd.nrl.navy.mil> - 5.0
- Added Ryu SD and Open vSwitch services, code cleanup and refactoring
* Fri Jun 5 2015 CORE Developers <core-dev@pf.itd.nrl.navy.mil> - 4.8
- Support for NRL Network Modeling Framework (NMF) XML representation, bugfixes
* Wed Aug 6 2014 Jeff Ahrenholz <core-dev@pf.itd.nrl.navy.mil> - 4.7