├── .gitignore ├── LICENSE ├── README.md ├── Vagrantfile ├── macosx └── README.md ├── ryuInstallHelper.sh └── start_ryu.sh /.gitignore: -------------------------------------------------------------------------------- 1 | # Byte-compiled / optimized / DLL files 2 | __pycache__/ 3 | *.py[cod] 4 | 5 | # C extensions 6 | *.so 7 | 8 | # Distribution / packaging 9 | .Python 10 | env/ 11 | build/ 12 | develop-eggs/ 13 | dist/ 14 | downloads/ 15 | eggs/ 16 | lib/ 17 | lib64/ 18 | parts/ 19 | sdist/ 20 | var/ 21 | *.egg-info/ 22 | .installed.cfg 23 | *.egg 24 | 25 | # PyInstaller 26 | # Usually these files are written by a python script from a template 27 | # before PyInstaller builds the exe, so as to inject date/other infos into it. 28 | *.manifest 29 | *.spec 30 | 31 | # Installer logs 32 | pip-log.txt 33 | pip-delete-this-directory.txt 34 | 35 | # Unit test / coverage reports 36 | htmlcov/ 37 | .tox/ 38 | .coverage 39 | .cache 40 | nosetests.xml 41 | coverage.xml 42 | 43 | # Translations 44 | *.mo 45 | *.pot 46 | 47 | # Django stuff: 48 | *.log 49 | 50 | # Sphinx documentation 51 | docs/_build/ 52 | 53 | # PyBuilder 54 | target/ 55 | 56 | # ryu source code 57 | ryu/ 58 | -------------------------------------------------------------------------------- /LICENSE: -------------------------------------------------------------------------------- 1 | Apache License 2 | Version 2.0, January 2004 3 | http://www.apache.org/licenses/ 4 | 5 | TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION 6 | 7 | 1. Definitions. 8 | 9 | "License" shall mean the terms and conditions for use, reproduction, 10 | and distribution as defined by Sections 1 through 9 of this document. 11 | 12 | "Licensor" shall mean the copyright owner or entity authorized by 13 | the copyright owner that is granting the License. 14 | 15 | "Legal Entity" shall mean the union of the acting entity and all 16 | other entities that control, are controlled by, or are under common 17 | control with that entity. For the purposes of this definition, 18 | "control" means (i) the power, direct or indirect, to cause the 19 | direction or management of such entity, whether by contract or 20 | otherwise, or (ii) ownership of fifty percent (50%) or more of the 21 | outstanding shares, or (iii) beneficial ownership of such entity. 22 | 23 | "You" (or "Your") shall mean an individual or Legal Entity 24 | exercising permissions granted by this License. 25 | 26 | "Source" form shall mean the preferred form for making modifications, 27 | including but not limited to software source code, documentation 28 | source, and configuration files. 29 | 30 | "Object" form shall mean any form resulting from mechanical 31 | transformation or translation of a Source form, including but 32 | not limited to compiled object code, generated documentation, 33 | and conversions to other media types. 34 | 35 | "Work" shall mean the work of authorship, whether in Source or 36 | Object form, made available under the License, as indicated by a 37 | copyright notice that is included in or attached to the work 38 | (an example is provided in the Appendix below). 39 | 40 | "Derivative Works" shall mean any work, whether in Source or Object 41 | form, that is based on (or derived from) the Work and for which the 42 | editorial revisions, annotations, elaborations, or other modifications 43 | represent, as a whole, an original work of authorship. For the purposes 44 | of this License, Derivative Works shall not include works that remain 45 | separable from, or merely link (or bind by name) to the interfaces of, 46 | the Work and Derivative Works thereof. 47 | 48 | "Contribution" shall mean any work of authorship, including 49 | the original version of the Work and any modifications or additions 50 | to that Work or Derivative Works thereof, that is intentionally 51 | submitted to Licensor for inclusion in the Work by the copyright owner 52 | or by an individual or Legal Entity authorized to submit on behalf of 53 | the copyright owner. For the purposes of this definition, "submitted" 54 | means any form of electronic, verbal, or written communication sent 55 | to the Licensor or its representatives, including but not limited to 56 | communication on electronic mailing lists, source code control systems, 57 | and issue tracking systems that are managed by, or on behalf of, the 58 | Licensor for the purpose of discussing and improving the Work, but 59 | excluding communication that is conspicuously marked or otherwise 60 | designated in writing by the copyright owner as "Not a Contribution." 61 | 62 | "Contributor" shall mean Licensor and any individual or Legal Entity 63 | on behalf of whom a Contribution has been received by Licensor and 64 | subsequently incorporated within the Work. 65 | 66 | 2. Grant of Copyright License. Subject to the terms and conditions of 67 | this License, each Contributor hereby grants to You a perpetual, 68 | worldwide, non-exclusive, no-charge, royalty-free, irrevocable 69 | copyright license to reproduce, prepare Derivative Works of, 70 | publicly display, publicly perform, sublicense, and distribute the 71 | Work and such Derivative Works in Source or Object form. 72 | 73 | 3. Grant of Patent License. Subject to the terms and conditions of 74 | this License, each Contributor hereby grants to You a perpetual, 75 | worldwide, non-exclusive, no-charge, royalty-free, irrevocable 76 | (except as stated in this section) patent license to make, have made, 77 | use, offer to sell, sell, import, and otherwise transfer the Work, 78 | where such license applies only to those patent claims licensable 79 | by such Contributor that are necessarily infringed by their 80 | Contribution(s) alone or by combination of their Contribution(s) 81 | with the Work to which such Contribution(s) was submitted. If You 82 | institute patent litigation against any entity (including a 83 | cross-claim or counterclaim in a lawsuit) alleging that the Work 84 | or a Contribution incorporated within the Work constitutes direct 85 | or contributory patent infringement, then any patent licenses 86 | granted to You under this License for that Work shall terminate 87 | as of the date such litigation is filed. 88 | 89 | 4. Redistribution. You may reproduce and distribute copies of the 90 | Work or Derivative Works thereof in any medium, with or without 91 | modifications, and in Source or Object form, provided that You 92 | meet the following conditions: 93 | 94 | (a) You must give any other recipients of the Work or 95 | Derivative Works a copy of this License; and 96 | 97 | (b) You must cause any modified files to carry prominent notices 98 | stating that You changed the files; and 99 | 100 | (c) You must retain, in the Source form of any Derivative Works 101 | that You distribute, all copyright, patent, trademark, and 102 | attribution notices from the Source form of the Work, 103 | excluding those notices that do not pertain to any part of 104 | the Derivative Works; and 105 | 106 | (d) If the Work includes a "NOTICE" text file as part of its 107 | distribution, then any Derivative Works that You distribute must 108 | include a readable copy of the attribution notices contained 109 | within such NOTICE file, excluding those notices that do not 110 | pertain to any part of the Derivative Works, in at least one 111 | of the following places: within a NOTICE text file distributed 112 | as part of the Derivative Works; within the Source form or 113 | documentation, if provided along with the Derivative Works; or, 114 | within a display generated by the Derivative Works, if and 115 | wherever such third-party notices normally appear. The contents 116 | of the NOTICE file are for informational purposes only and 117 | do not modify the License. You may add Your own attribution 118 | notices within Derivative Works that You distribute, alongside 119 | or as an addendum to the NOTICE text from the Work, provided 120 | that such additional attribution notices cannot be construed 121 | as modifying the License. 122 | 123 | You may add Your own copyright statement to Your modifications and 124 | may provide additional or different license terms and conditions 125 | for use, reproduction, or distribution of Your modifications, or 126 | for any such Derivative Works as a whole, provided Your use, 127 | reproduction, and distribution of the Work otherwise complies with 128 | the conditions stated in this License. 129 | 130 | 5. Submission of Contributions. Unless You explicitly state otherwise, 131 | any Contribution intentionally submitted for inclusion in the Work 132 | by You to the Licensor shall be under the terms and conditions of 133 | this License, without any additional terms or conditions. 134 | Notwithstanding the above, nothing herein shall supersede or modify 135 | the terms of any separate license agreement you may have executed 136 | with Licensor regarding such Contributions. 137 | 138 | 6. Trademarks. This License does not grant permission to use the trade 139 | names, trademarks, service marks, or product names of the Licensor, 140 | except as required for reasonable and customary use in describing the 141 | origin of the Work and reproducing the content of the NOTICE file. 142 | 143 | 7. Disclaimer of Warranty. Unless required by applicable law or 144 | agreed to in writing, Licensor provides the Work (and each 145 | Contributor provides its Contributions) on an "AS IS" BASIS, 146 | WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or 147 | implied, including, without limitation, any warranties or conditions 148 | of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A 149 | PARTICULAR PURPOSE. You are solely responsible for determining the 150 | appropriateness of using or redistributing the Work and assume any 151 | risks associated with Your exercise of permissions under this License. 152 | 153 | 8. Limitation of Liability. In no event and under no legal theory, 154 | whether in tort (including negligence), contract, or otherwise, 155 | unless required by applicable law (such as deliberate and grossly 156 | negligent acts) or agreed to in writing, shall any Contributor be 157 | liable to You for damages, including any direct, indirect, special, 158 | incidental, or consequential damages of any character arising as a 159 | result of this License or out of the use or inability to use the 160 | Work (including but not limited to damages for loss of goodwill, 161 | work stoppage, computer failure or malfunction, or any and all 162 | other commercial damages or losses), even if such Contributor 163 | has been advised of the possibility of such damages. 164 | 165 | 9. Accepting Warranty or Additional Liability. While redistributing 166 | the Work or Derivative Works thereof, You may choose to offer, 167 | and charge a fee for, acceptance of support, warranty, indemnity, 168 | or other liability obligations and/or rights consistent with this 169 | License. However, in accepting such obligations, You may act only 170 | on Your own behalf and on Your sole responsibility, not on behalf 171 | of any other Contributor, and only if You agree to indemnify, 172 | defend, and hold each Contributor harmless for any liability 173 | incurred by, or claims asserted against, such Contributor by reason 174 | of your accepting any such warranty or additional liability. 175 | 176 | END OF TERMS AND CONDITIONS 177 | 178 | APPENDIX: How to apply the Apache License to your work. 179 | 180 | To apply the Apache License to your work, attach the following 181 | boilerplate notice, with the fields enclosed by brackets "{}" 182 | replaced with your own identifying information. (Don't include 183 | the brackets!) The text should be enclosed in the appropriate 184 | comment syntax for the file format. We also recommend that a 185 | file or class name and description of purpose be included on the 186 | same "printed page" as the copyright notice for easier 187 | identification within third-party archives. 188 | 189 | Copyright {yyyy} {name of copyright owner} 190 | 191 | Licensed under the Apache License, Version 2.0 (the "License"); 192 | you may not use this file except in compliance with the License. 193 | You may obtain a copy of the License at 194 | 195 | http://www.apache.org/licenses/LICENSE-2.0 196 | 197 | Unless required by applicable law or agreed to in writing, software 198 | distributed under the License is distributed on an "AS IS" BASIS, 199 | WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. 200 | See the License for the specific language governing permissions and 201 | limitations under the License. 202 | 203 | -------------------------------------------------------------------------------- /README.md: -------------------------------------------------------------------------------- 1 | RyuInstallHelper 2 | ================ 3 | There are two ways to install ryu without any painful 4 | 5 | #### Option 1: Get the latest official version source build and install it. 6 | 7 | (The Easiest Way) 8 | 9 | An automatic installation script for build and install Ryu source code on Ubuntu 12.04+. 10 | 11 | To make installation easiest. This helper script which should get all 12 | dependencies and download, build, and install Ryu. 13 | 14 | ``` 15 | $ curl -sL https://raw.githubusercontent.com/sdnds-tw/ryuInstallHelper/master/ryuInstallHelper.sh | bash 16 | ``` 17 | 18 | That's it !! 19 | 20 | Note: This script has only been tested on the most recent stable version of Ubuntu. 21 | 22 | ----- 23 | 24 | #### Option 2: Using Python Virtualenv 25 | 26 | virtualenv is a tool to create isolated Python environments. 27 | 28 | ##### 1. Install Ryu dependency 29 | 30 | ``` 31 | $ sudo apt-get update 32 | $ sudo apt-get install git python-pip python-dev libxml2-dev libxslt1-dev -y 33 | ``` 34 | 35 | ##### 2. Setup virtualenv 36 | 37 | First, create a new virtualenv called "ryu_venv": 38 | 39 | `$ virtualenv ryu_venv` 40 | 41 | Activate the newly created virtualenv: 42 | 43 | `$ source ./ryu_venv/bin/activate` 44 | 45 | Your shell prompt will now display the currently active virtualenv: 46 | 47 | `(ryu_venv)$` 48 | 49 | 50 | ##### 3. Install the Ryu packages 51 | 52 | `(ryu_venv)$ pip install ryu` 53 | 54 | ##### 4. Starting Ryu 55 | 56 | Once you have properly setup virtualenv and install ryu, you can start ryu using following command: 57 | 58 | `(ryu_venv)$ ryu-manager` 59 | 60 | You may need to clone official source code for running sample application. 61 | 62 | `$ git clone https://github.com/osrg/ryu.git` 63 | 64 | Running a sample application 65 | 66 | `(ryu_venv)$ ryu-manager ./ryu/ryu/ryu/app/simple_switch_13.py` 67 | 68 | 69 | ##### 5. Deactivate virtualenv 70 | 71 | If you want to leave python virtualenv just using `deactivate` command. 72 | 73 | `(ryu_venv)$ deactivate` 74 | 75 | 76 | For more information on virtualenv, see [https://virtualenv.pypa.io/en/latest/](https://virtualenv.pypa.io/en/latest/) 77 | 78 | Enjoy hacking on SDN :smile: 79 | 80 | Contributor 81 | =========== 82 | 83 | - [John-Lin](https://github.com/John-Lin) 84 | - [pichuang](https://github.com/pichuang) 85 | - [PeterDaveHello](https://github.com/PeterDaveHello) 86 | -------------------------------------------------------------------------------- /Vagrantfile: -------------------------------------------------------------------------------- 1 | # -*- mode: ruby -*- 2 | # vi: set ft=ruby : 3 | Vagrant.configure("2") do |config| 4 | 5 | config.vm.box = "ubuntu/xenial64" 6 | 7 | config.vm.provider "virtualbox" do |vb| 8 | vb.cpus = 2 9 | vb.memory = 512 10 | end 11 | 12 | config.vm.provision "shell", privileged: false, inline: <<-SHELL 13 | sudo apt-get update 14 | sudo apt-get install -y git python-pip python3-pip build-essential python-dev python3-dev 15 | git clone --depth 1 https://github.com/osrg/ryu.git 16 | sudo pip install pip --upgrade 17 | sudo pip install -r /home/ubuntu/ryu/tools/pip-requires 18 | cd ryu; sudo python ./setup.py install 19 | SHELL 20 | end 21 | -------------------------------------------------------------------------------- /macosx/README.md: -------------------------------------------------------------------------------- 1 | Mac OSX Install Guide 2 | ================ 3 | Using virtualenv is the recommended way for working on Mac OSX 4 | 5 | #### Using Python Virtualenv 6 | 7 | virtualenv is a tool to create isolated Python environments. 8 | 9 | ##### 1. Install [Homebrew](http://brew.sh/) 10 | 11 | Paste that at a Terminal prompt. 12 | 13 | ``` 14 | $ ruby -e "$(curl -fsSL https://raw.githubusercontent.com/Homebrew/install/master/install)" 15 | ``` 16 | 17 | ##### 2. Using Homebrew install Python and pip 18 | 19 | First, create a new virtualenv called "ryu_venv": 20 | 21 | `$ brew install python` 22 | 23 | Then pip will work. 24 | 25 | ##### 3. Install the virtualenv 26 | 27 | Using pip install virtualenv. 28 | 29 | `$ pip install virtualenv ` 30 | 31 | 32 | ##### 4. Setup virtualenv 33 | 34 | First, create a new virtualenv called "ryu_venv": 35 | 36 | `$ virtualenv ryu_venv` 37 | 38 | Activate the newly created virtualenv: 39 | 40 | `$ source ./ryu_venv/bin/activate` 41 | 42 | Your shell prompt will now display the currently active virtualenv: 43 | 44 | `(ryu_venv)$` 45 | 46 | 47 | ##### 5. Install the Ryu packages 48 | 49 | ``` 50 | (ryu_venv)$ STATIC_DEPS=true pip install lxml 51 | (ryu_venv)$ pip install greenlet 52 | (ryu_venv)$ pip install ryu 53 | ``` 54 | 55 | ##### 6. Starting Ryu 56 | 57 | Once you have properly setup virtualenv and install ryu, you can start ryu using following command: 58 | 59 | `(ryu_venv)$ ryu-manager` 60 | 61 | You may need to clone official source code for running sample application. 62 | 63 | `$ git clone https://github.com/osrg/ryu.git` 64 | 65 | Running a sample application 66 | 67 | `(ryu_venv)$ ryu-manager ./ryu/ryu/ryu/app/simple_switch_13.py` 68 | 69 | 70 | ##### 7. Deactivate virtualenv 71 | 72 | If you want to leave python virtualenv just using `deactivate` command. 73 | 74 | `(ryu_venv)$ deactivate` 75 | 76 | 77 | For more information on virtualenv, see [https://virtualenv.pypa.io/en/latest/](https://virtualenv.pypa.io/en/latest/) -------------------------------------------------------------------------------- /ryuInstallHelper.sh: -------------------------------------------------------------------------------- 1 | #!/bin/sh 2 | # This is a quick install script for ryu and dependencies. 3 | 4 | # Check Permission 5 | # test $(id -u) -ne 0 && echo "This script must be run as root" && exit 0 6 | 7 | # On Ubuntu 16.04 LTS 8 | # Do NOT use 512MB VM to compile ryu source code since there is not enough memory to compile source code 9 | # Use SI standard, if you need more info, please try "man units" 10 | total_memory=$(free -b | grep 'Mem' | awk '{print $2}') 11 | minimum_memory=512000 12 | test $total_memory -lt $minimum_memory && echo "Minimum memory requirement is 512MB" && exit 0 13 | 14 | # Get the latest package lists 15 | sudo apt-get update 16 | 17 | 18 | echo "##############################################################################" 19 | echo "# RYU DEPENDENCY CHECK #" 20 | echo "##############################################################################" 21 | sudo apt-get install -y git python-pip python3-pip build-essential python-dev python3-dev 22 | 23 | echo "##############################################################################" 24 | echo "# DOWNLOADING RYU FROM GIT #" 25 | echo "##############################################################################" 26 | 27 | git clone --depth 1 https://github.com/osrg/ryu.git 28 | # Upgrade pip 29 | sudo pip install pip --upgrade 30 | 31 | sudo pip install -r ryu/tools/pip-requires 32 | 33 | echo "##############################################################################" 34 | echo "# BUILDING RYU #" 35 | echo "##############################################################################" 36 | 37 | cd ryu; sudo python ./setup.py install 38 | 39 | echo "##############################################################################" 40 | echo "# Try to use ./start_ryu.sh #" 41 | echo "# DONE #" 42 | echo "##############################################################################" 43 | -------------------------------------------------------------------------------- /start_ryu.sh: -------------------------------------------------------------------------------- 1 | #!/bin/sh 2 | PWD=$(pwd) 3 | APP_PATH=$PWD/ryu/ryu/app 4 | ryu-manager --verbose $APP_PATH/simple_switch_13.py $APP_PATH/ofctl_rest.py $APP_PATH/rest_topology.py 5 | --------------------------------------------------------------------------------