Skip to content

Home

Jump to bottom
Byungjoon Lee edited this page Mar 17, 2014 · 63 revisions

This is IRIS main documentation page. Further documentations are added per-request basis. API javadoc will be included within the source distribution. It is also linked in the OpenIRIS website.

Releases

Just see the Release section of OpenIRIS project on GitHub.

Documentation

Since the first release of the OpenIRIS, there have been couple of big changes. First one is the Xen-based Openflow 1.3.2 support (Xen is the home-made Openflow stack generator), Second one is the introduction of AngularJS to Periscope (Periscope is the Web-based UI of OpenIRIS), and Third one is the introduction of Loxigen as a replacement of Xen (Loxigen-based OpenIRIS is currently in 'loxigen' branch).

After the planned merge of 'loxigen' branch into 'master' (in the very near future), we think we will no longer support Xen-based 1.3.2 protocol stack. Xen will be used only in commercial releases of IRIS to provide better performance. It means the goal of OpenIRIS project is no longer to resolve performance issues.

So, the documentation is organized as follows: 'ko' is for Korean readers, 'en' is for English readers. Both documents represent the current status of the loxigen branch. The third one is 'deprecated', which is for the Xen-based OpenIRIS (master branch).

We strongly recommend you to use loxigen branch from now on.

  1. Getting Started

    1. Download ( ko | en )
    2. Installation ( ko | en | deprecated )
    3. Tutorial
      1. Creating network topology with mininet ( ko | en )
      2. Basic Openflow-based network failover ( ko | en )
      3. Built-in Firewall usage ( ko | en )

  2. Programming Guide 2. Controller Programming Guide ( ko | en | deprecated ) 3. Module Programming Guide ( ko | en | deprecated ) 4. REST API Programming Guide ( ko | en | deprecated ) 5. MongoDB Programming Guide ( ko | en )

  3. IRIS UI

    1. IRIS UI Programming ( ko | en | deprecated )

  4. FAQ (BRAND NEW!)

    1. What does each bundled controller instance do?

  5. FAQ (~25/Feb/2014)

    1. Why device manager save devices which have no attachment points?
    2. [Firewall module drops every new flow since a flow is dropped by a firewall rule] (http://github.com/bjlee72/IRIS/wiki/Firewall-module-drops-every-new-flow-since-a-flow-is-dropped-by-a-firewall-rule)
    3. Why IRIS CPU usage is high for idle connections to switches?

OpenIRIS Development Team: contact bjlee@etri.re.kr

Clone this wiki locally