Difference between revisions of "HICN"

From fd.io
Jump to: navigation, search
(→‎Build)
 
(112 intermediate revisions by 3 users not shown)
Line 15: Line 15:
 
* Alberto Compagno
 
* Alberto Compagno
 
* Jacques Samain
 
* Jacques Samain
 +
* Angelo Mantellini
 +
* Olivier Roques
 
}}
 
}}
  
Line 34: Line 36:
 
*4. A transport library compatible with both  client and server forwarders implementing transport protocols.
 
*4. A transport library compatible with both  client and server forwarders implementing transport protocols.
  
−
== News ==
+
A presentation of hICN at IETF IntArea WG is available on [https://youtu.be/PlC0xdk38tc Video] with the relative [https://datatracker.ietf.org/meeting/102/materials/slides-102-intarea-hybrid-icn-ipv6-00.pdf Slides]
  
−
[https://fd.io/2019/02/introducing-hybrid-information-centric-networking-hicn-a-new-fd-io-project/ FD.io Blog Post]
 
  
−
[https://trac.ietf.org/trac/ietf/meeting/wiki/104hackathon IETF 104 Hackathon]
+
== Presentations ==
  
−
[https://fdiominisummiteu19.sched.com/ FD.io mini summit]
+
[[File:Kubecon.png|480px| link=https://www.youtube.com/watch?v=LZEZX6z98Ic]]
  
 +
[https://www.slideshare.net/LucaMuscariello/introduction-to-hybrid-informationcentric-networking Slide Deck on the Introduction]
  
−
== Internet Drafts ==
+
[https://www.slideshare.net/LucaMuscariello/a-transport-layer-and-socket-api-for-hicn-design-implementation-and-performance-analysis Slide Deck on Transport]
−
[https://icn-team.gitlab.io/internet-drafts  IETF I-D]
+
  
−
Sources
+
[https://fd.io/latest/singles/hicn/ FD.io Blog Post]
−
https://gitlab.com/icn-team/internet-drafts
+
  
 +
==Supported Platform ==
  
  
−
Presentation of hICN at IETF IntArea WG
+
{| style="border-spacing: 2px; border: 1px solid darkgray;"
−
[https://datatracker.ietf.org/meeting/102/materials/slides-102-intarea-hybrid-icn-ipv6-00.pdf Slides]
+
! style="width: 140px;" | Linux
−
and [https://youtu.be/PlC0xdk38tc Video]
+
! style="width: 150px;" | Android
 +
! style="width: 130px;" | macOS
 +
! style="width: 130px;" | Windows
 +
|-
 +
|- style="text-align: center;"
 +
| style="border: 1px solid #777777;"|
 +
[[File:Linux.png|120px| link=https://github.com/cisco-open/hicn-sdk]]
 +
| style="border: 1px solid #777777;"|
 +
[[File:Android.svg|120px|link=https://github.com/cisco-open/hicn-sdk]]
 +
| style="border: 1px solid #777777;"|
 +
[[File:MacOS_logo_(2017).svg|120px|link=https://github.com/cisco-open/hicn-sdk]]
 +
| style="border: 1px solid #777777;"|
 +
[[File:Windows.png|120px|link=https://github.com/cisco-open/hicn-sdk]]
 +
|- style="text-align: center;"
 +
|}
  
−
== Meetings ==
 
−
A Slack space is available to discuss about hICN development.
 
  
−
[https://fdio-hicn.slack.com  Fd.io hICN Slack Space ]
+
==More Resources ==
  
−
Meetings can also be launched by using Zoom integrated to the Slack space.
+
{| style="border-spacing: 2px; border: 1px solid darkgray;"
 +
! style="width: 140px;" | Docker Hub
 +
! style="width: 140px;" | Slack Channel
 +
! style="width: 140px;" | GitHub FDio Sync
 +
! style="width: 140px;" | GitHub SDKs
 +
|-
 +
|- style="text-align: center;"
 +
| style="border: 1px solid #777777;"|
 +
[[File:Docker.png|120px|link=https://github.com/orgs/cisco-open/packages]]
 +
| style="border: 1px solid #777777;"|
 +
[[File:Screen Shot 2019-09-26 at 17.38.39.png|120px|link=http://fdio-project.slack.com]]
 +
| style="border: 1px solid #777777;"|
 +
[[File:GitHub Logo.png|120px|link=https://github.com/FDio/hicn]]
 +
| style="border: 1px solid #777777;"|
 +
[[File:GitHub Logo.png|120px|link=https://github.com/cisco-open/hicn-sdk]]
 +
|}
  
 +
==Architecture Documentation ==
  
−
== Getting Started ==  
+
{| style="border-spacing: 2px; border: 1px solid darkgray;"
 +
! style="width: 140px;" | IETF work
 +
! style="width: 140px;" | Publications
 +
! style="width: 140px;" | Read the docs
 +
|-
 +
|- style="text-align: center;"
 +
| style="border: 1px solid #777777;"|
 +
[[File:Ietf-logo.original.png|120px| link=https://icn-team.github.io/internet-drafts/]]
 +
| style="border: 1px solid #777777;"|
 +
[[File:Pub.jpeg|120px|link=HICN/pub]]
 +
| style="border: 1px solid #777777;"|
 +
[[File:Readthedocs.png|120px|link=https://hicn.readthedocs.io]]
 +
|}
  
−
<pre>
+
==For Developers==
−
Install libparc
+
−
https://github.com/FDio/cicn/blob/cframework/master/libparc/README.md
+
−
</pre>
+
  
−
==Linux==
+
{| style="border-spacing: 2px; border: 1px solid darkgray;"
−
 
+
! style="width: 140px;" | Submit Patches
−
===Build===
+
! style="width: 140px;" | Bug tracker
−
<pre>
+
! style="width: 140px;" | Kanban Board
−
$ git clone https://git.fd.io/hicn
+
! style="width: 140px;" | Sonarcloud Static Scan
−
$ cd hicn
+
−
$ mkdir build; cd build
+
−
$ cmake -DBUILD_HICNPLUGIN=ON -DBUILD_APPS=ON ..
+
−
$ make
+
−
</pre>
+
−
 
+
−
===Repository for Ubuntu (16.04/18.40)===
+
−
<pre>
+
−
$ curl -s https://packagecloud.io/install/repositories/fdio/release/script.deb.sh | sudo bash
+
−
$ sudo apt-get update
+
−
$ sudo apt-get install hicn-light hicn-utils hicn-apps hicn-plugin
+
−
</pre>
+
−
 
+
−
==Mac Os X==
+
−
 
+
−
===Build===
+
−
<pre>
+
−
$ git clone https://git.fd.io/hicn
+
−
$ cd hicn
+
−
$ mkdir build; cd build
+
−
$ cmake -DOPENSSL_ROOT_DIR=/usr/local/opt/openssl\@1.1 -DBUILD_APPS=ON ..
+
−
$ make
+
−
</pre>
+
−
 
+
−
===HomeBrew Tap for Mac Os X 10.14===
+
−
<pre>
+
−
$ brew tap icn-team/hicn-tap
+
−
$ brew install  hicn
+
−
</pre>
+
−
 
+
−
==Windows==
+
−
===Build===
+
−
#Install [https://visualstudio.microsoft.com/it/ Visual Studio 2017]
+
−
#Install [https://developer.microsoft.com/en-us/windows/downloads/windows-10-sdk Windows 10 SDK]
+
−
#Install [https://git-scm.com/download/win Git]
+
−
#Install [https://cmake.org/download/ CMake]
+
−
<pre>
+
−
$ git clone https://github.com/Microsoft/vcpkg.git
+
−
$ cd vcpkg
+
−
$ set vcpkg_path=%cd%
+
−
$ .\bootstrap-vcpkg.bat
+
−
$ .\vcpkg integrate install
+
−
$ .\vcpkg install libevent:x64-windows
+
−
$ .\vcpkg install openssl:x64-windows
+
−
$ .\vcpkg install pthreads:x64-windows
+
−
$ .\vcpkg install curl:x64-windows
+
−
$ .\vcpkg install asio:x64-windows
+
−
$ set PATH=%PATH%;%vcpkg_path%\installed\x64-windows\bin
+
−
$ cd ..
+
−
$ mkdir hicn-fdio
+
−
$ cd hicn-fdio
+
−
$ set hicn-fdio_path=%cd%
+
−
$ git clone -b cframework/master https://gerrit.fd.io/r/cicn cframework
+
−
$ cd cframework\libparc
+
−
$ mkdir build
+
−
$ cd build
+
−
$ cmake .. -G"NMake Makefiles" -DCMAKE_TOOLCHAIN_FILE="%vcpkg_path%/scripts/buildsystems/vcpkg.cmake" ^
+
−
-DCMAKE_INSTALL_PREFIX="%hicn-fdio_path%/install" -DCMAKE_BUILD_TYPE="Release"
+
−
$ nmake install
+
−
$ cd ..\..\..
+
−
$ git clone https://gerrit.fd.io/r/hicn
+
−
$ cd hicn
+
−
$ mkdir build
+
−
$ cd build
+
−
$ cmake .. -G"NMake Makefiles" -DCMAKE_TOOLCHAIN_FILE="%vcpkg_path%/scripts/buildsystems/vcpkg.cmake" ^
+
−
-DCMAKE_INSTALL_PREFIX="%hicn-fdio_path%/install" -DLIBPARC_HOME="%hicn-fdio_path%/install" -DCMAKE_BUILD_TYPE="Release"
+
−
$ nmake install
+
−
 
+
−
</pre>
+
−
 
+
−
==Android==
+
−
The following guide is tested on Ubuntu and Mac Os X
+
−
<pre>
+
−
$ git clone https://github.com/icn-team/android-sdk.git
+
−
$ cd android-sdk
+
−
$ export ANDROID_ARCH="arm64"
+
−
$ make all
+
−
$ export ANDROID_ARCH="x86"
+
−
$ make all
+
−
 
+
−
# The hICN Distillery software will be installed in android-sdk/usr_aarch64 and android-sdk/usr_i686
+
−
</pre>
+
−
The git repo is also synced to github at
+
−
 
+
−
https://github.com/FDio/hicn
+
−
 
+
−
 
+
−
 
+
−
{| class="wikitable"
+
−
! Folder
+
−
! Description
+
−
! Documentation
+
−
|-
+
−
| lib (C11)
+
−
| Core support library
+
−
| [https://docs.fd.io/hicn/19.01/ core lib]
+
−
|-
+
−
| hicn-plugin (POSIX C)
+
−
| VPP plugin. You need to know about [[VPP]]
+
−
| [https://github.com/FDio/hicn/tree/master/hicn-plugin VPP plugin]
+
−
|-
+
−
| hicn-light (C11)
+
−
| Lightweight packet forwarder. It is a portable forwarder for most used client devices such as macOS, Windows, Android, iOS, Linux.
+
−
| [https://github.com/FDio/hicn/tree/master/hicn-light hicn light]
+
−
|-
+
−
| libtransport (C++11)
+
−
| Library that contains transport protocol implementations as well as a socket API.
+
−
| [https://github.com/FDio/hicn/tree/master/libtransport Transport]
+
−
|-
+
−
| utils
+
−
| Tools for testing
+
−
|
+
 
|-
 
|-
−
| apps
+
|- style="text-align: center;"
−
| Application examples using hicn stack
+
| style="border: 1px solid #777777;"|
−
|
+
[[File:Code.png|120px| link=HICN/Contribute]]
 +
| style="border: 1px solid #777777;"|
 +
[[File:Jira.png|120px|link=https://jira.fd.io/projects/HICN]]
 +
| style="border: 1px solid #777777;"|
 +
[[File:Kanban.png|120px|link=https://jira.fd.io/secure/Dashboard.jspa?selectPageId=10900]]
 +
| style="border: 1px solid #777777;"|
 +
[[File:Sonarcloud.png|120px|link=https://sonarcloud.io/project/overview?id=fdio-hicn]]
 
|}
 
|}
  
−
== Supported Platform ==
+
== HowTo ==
−
<pre>
+
−
- Ubuntu 16.04 LTS
+
−
- Ubuntu 18.04 LTS
+
−
- Debian Stable/Testing
+
−
- Red Hat Enterprise Linux 7
+
−
- CentOS 7
+
−
- Android 8
+
−
- iOS 12
+
−
- macOS 10.12
+
−
- Windows 10
+
−
</pre>
+
  
 +
All infra issues require to file a ticket to the Linux Foundation via the following page.
  
−
== hICN vSwitch ==
+
[https://jira.linuxfoundation.org/servicedesk/customer/portals  Linux Foundation Issue manager ]
−
Work in progress: hicn vSwitch in a docker container.
+
−
 
+
−
https://hub.docker.com/r/icnteam/hicn_vswitch
+
−
 
+
−
<pre>
+
−
docker pull icnteam/hicn_vswitch
+
−
</pre>
+
−
 
+
−
Provides a docker image with hicn VPP plugin and NETCONF/YANG hicn API.
+
−
 
+
−
The YANG model can be retrieved from
+
−
 
+
−
https://github.com/FDio/hicn/blob/master/utils/sysrepo-plugins/yang/hicn/hicn.yang
+
−
 
+
−
 
+
−
<pre>
+
−
docker pull icnteam/vhost
+
−
</pre>
+
−
 
+
−
== hICN Applications ==
+
−
 
+
−
TDA
+
−
 
+
−
== Tutorials ==
+
  
 
[[HICN/hICN_Howtos| hICN Howtos]]
 
[[HICN/hICN_Howtos| hICN Howtos]]
  
−
== For developers ==
+
==Release management ==
−
 
+
−
[[VPP/Pulling,_Building,_Running,_Hacking_and_Pushing_VPP_Code| Pulling, Building, Hacking, and Pushing VPP Code]] - Explains how to get up and going with the vpp code base and FD.io repositories.
+
−
For every patch that is submitted to [https://gerrit.fd.io fd.io Gerrit], please open first an issue on [https://jira.fd.io/projects/HICN  fd.io Jira]  and put the issue ID (HICN-#) in the commit message.
+
−
Also, associate every issue to a project component as available in the following table:
+
−
 
+
−
[https://jira.fd.io/projects/HICN?selectedItem=com.atlassian.jira.jira-projects-plugin:components-page  Project components]
+
−
 
+
−
If you do not want your patch to be merged, append DO_NOT_MERGE to the Jira issue ID.
+
−
 
+
−
 
+
−
[https://jira.fd.io/secure/Dashboard.jspa?selectPageId=10900  hICN Kanban boards] (Must have a Linux Foundation account).
+
−
 
+
−
==Current Release ==
+
−
Current release is 19.01 and is available on [https://packagecloud.io/fdio/release  Package Cloud]
+
−
 
+
−
==Releases management ==
+
  
 
hICN releases are distributed every quarter (End of Jan, Apr, Jul, Oct) based on calendar versioning , i.e. YY.MM.
 
hICN releases are distributed every quarter (End of Jan, Apr, Jul, Oct) based on calendar versioning , i.e. YY.MM.
Line 258: Line 140:
 
keep it in sync with the newly released VPP distribution.
 
keep it in sync with the newly released VPP distribution.
 
The server stack of hICN project, based on VPP,  is guaranteed to work with the latest stable VPP release only.
 
The server stack of hICN project, based on VPP,  is guaranteed to work with the latest stable VPP release only.
 +
 +
[https://jira.fd.io/projects/HICN?selectedItem=com.atlassian.jira.jira-projects-plugin%3Arelease-page&status=released-unreleased, Releases on Jira]
  
 
The client stack is unaffected by VPP release management.
 
The client stack is unaffected by VPP release management.
Line 263: Line 147:
 
[[File:Hicn release management.png|center|hicn release management]]
 
[[File:Hicn release management.png|center|hicn release management]]
  
−
 
−
Packages are published for both the amd64 (Intel) and aarch64 (ARM) architectures. The packages are stored in the same repository so no special action is required to select your architecture.
 
−
 
−
Binary distributions are available on [https://packagecloud.io/fdio/release  Package Cloud]
 
−
for:
 
−
 
−
<pre>
 
−
- Ubuntu 16.04 LTS (amd64, aarch64)
 
−
- Ubuntu 18.04 LTS (amd64, aarch64)
 
−
- CentOS 7 (x86_64, aarch64)
 
−
</pre>
 
  
 
== Bibliography ==
 
== Bibliography ==
 +
* [0] Enabling ICN in the Internet Protocol: Analysis and Evaluation of the Hybrid-ICN Architecture Giovanna Carofiglio (Cisco Systems), Luca Muscariello (Cisco Systems), Jordan Augé (Cisco Systems), Michele Papalini (Cisco Systems), Mauro Sardara (Cisco Systems), Alberto Compagno (Cisco Systems) In Proc. of ACM SIGCOMM ICN 2019  [https://conferences.sigcomm.org/acm-icn/2019/proceedings/icn19-14.pdf]
 
*[1] Muscariello, L., Carofiglio, G., Auge, J., and M. Papalini, "Hybrid Information-Centric Networking", [https://tools.ietf.org/html/draft-muscariello-intarea-hicn-01 draft-muscariello-intarea-hicn-01] (work in progress), December 2018.
 
*[1] Muscariello, L., Carofiglio, G., Auge, J., and M. Papalini, "Hybrid Information-Centric Networking", [https://tools.ietf.org/html/draft-muscariello-intarea-hicn-01 draft-muscariello-intarea-hicn-01] (work in progress), December 2018.
 
*[2] Auge, J., Carofiglio, G., Muscariello, L., and M. Papalini, "Anchorless mobility through hICN" draft-auge-dmm-hicn-mobility-01 (work in progress), December 2018.
 
*[2] Auge, J., Carofiglio, G., Muscariello, L., and M. Papalini, "Anchorless mobility through hICN" draft-auge-dmm-hicn-mobility-01 (work in progress), December 2018.

Latest revision as of 08:47, 27 January 2023

HICN banner.png


hICN Facts

Project Lead: Luca Muscariello
Committers:

  • Luca Muscariello
  • Michele Papalini
  • Jordan Augé
  • Mauro Sardara
  • Alberto Compagno
  • Jacques Samain
  • Angelo Mantellini
  • Olivier Roques

Repository: git clone https://gerrit.fd.io/r/hicn
Mailing List: hicn-dev@lists.fd.io
Jenkins: jenkins silo
Gerrit Patches: code patches/reviews
Bugs: HICN bugs

Introduction

Hybrid ICN is an architecture that brings ICN into IPv6 as described in [1]. By doing that, hicn allows to generalize IPv6 networking by using location-independent name-based networking. This is made either at the network layer and at the transport layer by also providing name-based sockets to applications.

hicn allows to reuse existing IPv6 protocol and architectures, to extend them and deploy hybrid solutions based on the use case and application needs. Moreover, hicn can exploit hardware and software implementations heavily based on IP, making much simpler insertion of the technology in current networks, current applications and design future applications reusing what the industry already provides in terms of on the shelf components.

hicn is composed of network and transport stack for a variety of platforms. It supports end-host operating systems by using a portable and lightweight forwarder in C11 and a server oriented network forwarder based on VPP. The transport stack is implemented as a shared library written in C++11 where different transport protocols can be implemented based on the application needs. The early release will support a reliable transport protocol that is throughput optimal (à la TCP) and a transport protocol that can carry audio/video for real-time communications. The transport library provides an API for application that is based on INET socket API with in addition a post-socket API based on [5],[6],[7]. Both network forwarders will be equipped of binary APIs to provide a CLI as well data-model driven management features.

The project will have strong interactions with other fdio projects such as VPP, CICN in the first place and with DMM in the future.

Several applications will be supported from early releases such as HTTP, RTP where many-to-many communications, mobility and multi-homing is important. Some relevant applications include, but are not limited to, MPEG-DASH, WebRTC, heterogenous access (LTE/WiFi), mobile edge offloading (V2X, IoT), mobility management ([2],[3],[4])and cloud-native applications (service-mesh, micro-services communications).

In more detail, early releases would include:

  • 1. A core library that reflects the Internet draft specifications in [1];
  • 2. A forwarder implemented as a VPP plugin (server);
  • 3. A portable lightweight forwarder (client);
  • 4. A transport library compatible with both client and server forwarders implementing transport protocols.

A presentation of hICN at IETF IntArea WG is available on Video with the relative Slides


Presentations

Kubecon.png

Slide Deck on the Introduction

Slide Deck on Transport

FD.io Blog Post

Supported Platform

Linux Android macOS Windows

Linux.png

Android.svg

MacOS logo (2017).svg

Windows.png


More Resources

Docker Hub Slack Channel GitHub FDio Sync GitHub SDKs

Docker.png

Screen Shot 2019-09-26 at 17.38.39.png

GitHub Logo.png

GitHub Logo.png

Architecture Documentation

IETF work Publications Read the docs

Ietf-logo.original.png

Pub.jpeg

Readthedocs.png

For Developers

Submit Patches Bug tracker Kanban Board Sonarcloud Static Scan

Code.png

Jira.png

Kanban.png

Sonarcloud.png

HowTo

All infra issues require to file a ticket to the Linux Foundation via the following page.

Linux Foundation Issue manager

hICN Howtos

Release management

hICN releases are distributed every quarter (End of Jan, Apr, Jul, Oct) based on calendar versioning , i.e. YY.MM. The master branch is always tagged with the latest release which is the latest VPP stable release. As soon as a new VPP release is distributed the hICN master branch will merge code from development branches and keep it in sync with the newly released VPP distribution. The server stack of hICN project, based on VPP, is guaranteed to work with the latest stable VPP release only.

Releases on Jira

The client stack is unaffected by VPP release management.

hicn release management


Bibliography

  • [0] Enabling ICN in the Internet Protocol: Analysis and Evaluation of the Hybrid-ICN Architecture Giovanna Carofiglio (Cisco Systems), Luca Muscariello (Cisco Systems), Jordan Augé (Cisco Systems), Michele Papalini (Cisco Systems), Mauro Sardara (Cisco Systems), Alberto Compagno (Cisco Systems) In Proc. of ACM SIGCOMM ICN 2019 [1]
  • [1] Muscariello, L., Carofiglio, G., Auge, J., and M. Papalini, "Hybrid Information-Centric Networking", draft-muscariello-intarea-hicn-01 (work in progress), December 2018.
  • [2] Auge, J., Carofiglio, G., Muscariello, L., and M. Papalini, "Anchorless mobility through hICN" draft-auge-dmm-hicn-mobility-01 (work in progress), December 2018.
  • [3] Auge, J., Carofiglio, G., Muscariello, L., and M. Papalini, "Anchorless mobility management through hICN (hICN-AMM): Deployment options" draft-auge-hicn-mobility-deployment-options-01 (work in progress), December 2018.
  • [4] Bogineni K., Akhavain A., Herbert T., Farinacci T., et al. "Optimized Mobile User Plane Solutions for 5G" draft-bogineni-dmm-optimized-mobile-user-plane-01 (work in progress), December 2018.
  • [5] Pauly, T., Trammell, B., Brunstrom, A., Fairhurst, G., Perkins, C., Tiesel, P., and C. Wood, "An Architecture for Transport Services", draft-ietf-taps-arch-02 (work in progress), October 2018.
  • [6] Brunstrom, A., Pauly, T., Enghardt, T., Grinnemo, K., Jones, T., Tiesel, P., Perkins, C., and M. Welzl, "Implementing Interfaces to Transport Services", draft- ietf-taps-impl-02 (work in progress), October 2018.
  • [7] Trammell, B., Welzl, M., Enghardt, T., Fairhurst, G., Kuehlewind, M., Perkins, C., Tiesel, P., and C. Wood, "An Abstract Application Layer Interface to Transport Services", draft-ietf-taps-interface-02 (work in progress), October 2018.
Retrieved from "https://wiki.fd.io/index.php?title=HICN&oldid=12049"