├── .dockerignore ├── Dockerfile ├── ENTRYPOINT.sh ├── LICENSE ├── README.md ├── docker-compose.yml ├── ubuntu-18.04 ├── Dockerfile ├── ENTRYPOINT.sh └── docker-compose.yml └── ubuntu-20.04 ├── Dockerfile ├── ENTRYPOINT.sh └── docker-compose.yml /.dockerignore: -------------------------------------------------------------------------------- 1 | ubuntu-* 2 | -------------------------------------------------------------------------------- /Dockerfile: -------------------------------------------------------------------------------- 1 | FROM ubuntu:22.04 2 | 3 | USER root 4 | WORKDIR /root 5 | 6 | COPY ENTRYPOINT.sh / 7 | 8 | RUN apt-get update && apt-get install -y --no-install-recommends \ 9 | curl \ 10 | dnsutils \ 11 | ifupdown \ 12 | iproute2 \ 13 | iptables \ 14 | iputils-ping \ 15 | mininet \ 16 | net-tools \ 17 | openvswitch-switch \ 18 | openvswitch-testcontroller \ 19 | tcpdump \ 20 | vim \ 21 | x11-xserver-utils \ 22 | xterm \ 23 | && rm -rf /var/lib/apt/lists/* \ 24 | && touch /etc/network/interfaces \ 25 | && chmod +x /ENTRYPOINT.sh 26 | 27 | EXPOSE 6633 6653 6640 28 | 29 | ENTRYPOINT ["/ENTRYPOINT.sh"] 30 | -------------------------------------------------------------------------------- /ENTRYPOINT.sh: -------------------------------------------------------------------------------- 1 | #!/usr/bin/env bash 2 | 3 | service openvswitch-switch start 4 | ovs-vsctl set-manager ptcp:6640 5 | 6 | if [ $# -gt 0 ] 7 | then 8 | if [ "$1" == "mn" ] 9 | then 10 | bash -c "$@" 11 | else 12 | mn "$@" 13 | fi 14 | else 15 | bash 16 | fi 17 | 18 | service openvswitch-switch stop 19 | -------------------------------------------------------------------------------- /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 | -------------------------------------------------------------------------------- /README.md: -------------------------------------------------------------------------------- 1 | # docker-mininet 2 | 3 | The Docker image for [Mininet](http://mininet.org/) 4 | 5 | ## Usage 6 | 7 | ### Get Docker Image 8 | 9 | Download from [Docker Hub](https://hub.docker.com/) 10 | 11 | ```bash 12 | docker pull iwaseyusuke/mininet 13 | ``` 14 | 15 | ### Run Docker Container 16 | 17 | ```bash 18 | docker run -it --rm --privileged -e DISPLAY \ 19 | -v /tmp/.X11-unix:/tmp/.X11-unix \ 20 | -v /lib/modules:/lib/modules \ 21 | iwaseyusuke/mininet 22 | ``` 23 | 24 | Output Example: 25 | 26 | ```text 27 | * Inserting openvswitch module 28 | * /etc/openvswitch/conf.db does not exist 29 | * Creating empty database /etc/openvswitch/conf.db 30 | * Starting ovsdb-server 31 | * Configuring Open vSwitch system IDs 32 | * Starting ovs-vswitchd 33 | * Enabling remote OVSDB managers 34 | root@457697d70ebc:~# 35 | ``` 36 | 37 | Now, you can run `mn` command inside the container. 38 | 39 | Also, you can pass options for `mn` command when running a new container. 40 | 41 | ```bash 42 | $ docker run -it --rm --privileged -e DISPLAY \ 43 | -v /tmp/.X11-unix:/tmp/.X11-unix \ 44 | -v /lib/modules:/lib/modules \ 45 | iwaseyusuke/mininet --topo linear 46 | ``` 47 | 48 | Output Example: 49 | 50 | ```text 51 | * /etc/openvswitch/conf.db does not exist 52 | * Creating empty database /etc/openvswitch/conf.db 53 | * Starting ovsdb-server 54 | * Configuring Open vSwitch system IDs 55 | * Starting ovs-vswitchd 56 | * Enabling remote OVSDB managers 57 | *** Error setting resource limits. Mininet's performance may be affected. 58 | *** Creating network 59 | *** Adding controller 60 | *** Adding hosts: 61 | h1 h2 62 | *** Adding switches: 63 | s1 s2 64 | *** Adding links: 65 | (h1, s1) (h2, s2) (s2, s1) 66 | *** Configuring hosts 67 | h1 h2 68 | *** Starting controller 69 | c0 70 | *** Starting 2 switches 71 | s1 s2 ... 72 | *** Starting CLI: 73 | mininet> 74 | ``` 75 | 76 | ## Docker Compose 77 | 78 | If you have installed [Docker Compose](https://docs.docker.com/compose/), 79 | you can run container with: 80 | 81 | ```bash 82 | # Download Compose file 83 | wget https://raw.githubusercontent.com/iwaseyusuke/docker-mininet/main/docker-compose.yml 84 | 85 | # Run a container 86 | docker compose run --rm mininet 87 | ``` 88 | 89 | ## TIPS 90 | 91 | ### Open X Window applications in containers 92 | 93 | If you could not open `xterm` or other X Window applications, or faced to the 94 | following error message; 95 | 96 | ```bash 97 | root@26f36691a400:~# xterm 98 | No protocol specified 99 | Warning: This program is an suid-root program or is being run by the root user. 100 | The full text of the error or warning message cannot be safely formatted 101 | in this environment. You may get a more descriptive message by running the 102 | program as a non-root user or by removing the suid bit on the executable. 103 | xterm: Xt error: Can't open display: %s 104 | ``` 105 | 106 | Please add `root` user to the local access control list of xhost on your 107 | "Docker host" (not on your containers). 108 | 109 | ```bash 110 | $ xhost +si:localuser:root 111 | localuser:root being added to access control list 112 | ``` 113 | -------------------------------------------------------------------------------- /docker-compose.yml: -------------------------------------------------------------------------------- 1 | version: '3' 2 | services: 3 | mininet: 4 | build: 5 | context: . 6 | image: iwaseyusuke/mininet:ubuntu-22.04 #latest 7 | tty: true 8 | network_mode: "bridge" 9 | privileged: true 10 | environment: 11 | - DISPLAY 12 | volumes: 13 | - /tmp/.X11-unix:/tmp/.X11-unix 14 | - /lib/modules:/lib/modules 15 | -------------------------------------------------------------------------------- /ubuntu-18.04/Dockerfile: -------------------------------------------------------------------------------- 1 | FROM ubuntu:18.04 2 | 3 | USER root 4 | WORKDIR /root 5 | 6 | COPY ENTRYPOINT.sh / 7 | 8 | RUN apt-get update && apt-get install -y --no-install-recommends \ 9 | curl \ 10 | dnsutils \ 11 | ifupdown \ 12 | iproute2 \ 13 | iptables \ 14 | iputils-ping \ 15 | mininet \ 16 | net-tools \ 17 | openvswitch-switch \ 18 | openvswitch-testcontroller \ 19 | tcpdump \ 20 | vim \ 21 | x11-xserver-utils \ 22 | xterm \ 23 | && rm -rf /var/lib/apt/lists/* \ 24 | && touch /etc/network/interfaces \ 25 | && chmod +x /ENTRYPOINT.sh 26 | 27 | EXPOSE 6633 6653 6640 28 | 29 | ENTRYPOINT ["/ENTRYPOINT.sh"] 30 | -------------------------------------------------------------------------------- /ubuntu-18.04/ENTRYPOINT.sh: -------------------------------------------------------------------------------- 1 | #!/usr/bin/env bash 2 | 3 | service openvswitch-switch start 4 | ovs-vsctl set-manager ptcp:6640 5 | 6 | if [ $# -gt 0 ] 7 | then 8 | if [ "$1" == "mn" ] 9 | then 10 | bash -c "$@" 11 | else 12 | mn "$@" 13 | fi 14 | else 15 | bash 16 | fi 17 | 18 | service openvswitch-switch stop 19 | -------------------------------------------------------------------------------- /ubuntu-18.04/docker-compose.yml: -------------------------------------------------------------------------------- 1 | version: '3' 2 | services: 3 | mininet: 4 | build: 5 | context: . 6 | image: iwaseyusuke/mininet:ubuntu-18.04 7 | tty: true 8 | network_mode: "bridge" 9 | privileged: true 10 | environment: 11 | - DISPLAY 12 | volumes: 13 | - /tmp/.X11-unix:/tmp/.X11-unix 14 | - /lib/modules:/lib/modules 15 | -------------------------------------------------------------------------------- /ubuntu-20.04/Dockerfile: -------------------------------------------------------------------------------- 1 | FROM ubuntu:20.04 2 | 3 | USER root 4 | WORKDIR /root 5 | 6 | COPY ENTRYPOINT.sh / 7 | 8 | RUN apt-get update && apt-get install -y --no-install-recommends \ 9 | curl \ 10 | dnsutils \ 11 | ifupdown \ 12 | iproute2 \ 13 | iptables \ 14 | iputils-ping \ 15 | mininet \ 16 | net-tools \ 17 | openvswitch-switch \ 18 | openvswitch-testcontroller \ 19 | tcpdump \ 20 | vim \ 21 | x11-xserver-utils \ 22 | xterm \ 23 | && rm -rf /var/lib/apt/lists/* \ 24 | && touch /etc/network/interfaces \ 25 | && chmod +x /ENTRYPOINT.sh 26 | 27 | EXPOSE 6633 6653 6640 28 | 29 | ENTRYPOINT ["/ENTRYPOINT.sh"] 30 | -------------------------------------------------------------------------------- /ubuntu-20.04/ENTRYPOINT.sh: -------------------------------------------------------------------------------- 1 | #!/usr/bin/env bash 2 | 3 | service openvswitch-switch start 4 | ovs-vsctl set-manager ptcp:6640 5 | 6 | if [ $# -gt 0 ] 7 | then 8 | if [ "$1" == "mn" ] 9 | then 10 | bash -c "$@" 11 | else 12 | mn "$@" 13 | fi 14 | else 15 | bash 16 | fi 17 | 18 | service openvswitch-switch stop 19 | -------------------------------------------------------------------------------- /ubuntu-20.04/docker-compose.yml: -------------------------------------------------------------------------------- 1 | version: '3' 2 | services: 3 | mininet: 4 | build: 5 | context: . 6 | image: iwaseyusuke/mininet:ubuntu-20.04 7 | tty: true 8 | network_mode: "bridge" 9 | privileged: true 10 | environment: 11 | - DISPLAY 12 | volumes: 13 | - /tmp/.X11-unix:/tmp/.X11-unix 14 | - /lib/modules:/lib/modules 15 | --------------------------------------------------------------------------------