[{"_1":2,"_196":-5,"_197":-5},"loaderData",{"_3":4,"_13":14,"_19":20,"_169":170},"root",{"_5":-5,"_6":-7,"_7":8,"_9":-7,"_10":11,"_12":-7},"currentUser","primaryEmail","siteVerification","6LeIxAcTAAAAAJcZVRqyHh71UMIEGNQ_MXjiZKhI","toast","enableDev",false,"incidentStatus","routes/_layout",{"_15":-5,"_16":17,"_18":17},"username","isAskGordonEnabled",true,"isUsingNewTemplate","routes/_layout.r.$namespace.$reponame",{"_21":22,"_23":-5,"_24":11,"_25":11,"_26":27,"_28":29,"_30":-5,"_31":11,"_32":33,"_89":90,"_114":115,"_162":-5,"_163":11,"_164":11,"_165":11,"_166":-5,"_167":168},"canonicalUrl","https://hub.docker.com/r/nlnetlabs/gantry/tags","mcpServer","canSeeDockerfile","canSeeAutobuilds","namespace","nlnetlabs","reponame","gantry","cloudBuildSource","isAutobuildsAvailable","repo",{"_34":35,"_44":45,"_47":48,"_49":50,"_51":11,"_52":53,"_54":55,"_56":57,"_37":29,"_26":27,"_59":60,"_61":46,"_62":63,"_64":65,"_66":67,"_68":-5,"_69":63,"_70":71,"_72":11,"_73":27,"_74":75,"_80":11,"_81":82,"_86":27,"_87":88},"categories",[36,41],{"_37":38,"_39":40},"name","Networking","slug","networking",{"_37":42,"_39":43},"Integration & delivery","integration-and-delivery","content_types",[46],"image","date_registered","2019-04-04T08:35:09.002919Z","description","A tool for deploying and testing network routers in the cloud.","is_private","last_updated","2020-10-09T12:53:44.845269Z","last_modified","2024-10-16T13:48:34.145251Z","media_types",[58],"application/vnd.docker.container.image.v1+json","pull_count",26179,"repository_type","star_count",0,"status",1,"status_description","active","source","collaborator_count","full_description","[![Travis CI status badge](https://travis-ci.com/NLnetLabs/gantry.svg?branch=master)](https://travis-ci.com/NLnetLabs/gantry)\n\n# Gantry\n\n> _a structure built on a rocket launch pad to facilitate assembly and servicing_\n\nNLnet Labs Gantry is a tool for deploying and testing network routers in the cloud, built to support the [NLnet Labs Routinator](https://www.nlnetlabs.nl/projects/rpki/routinator/) project.\n\nThis project exists to answer the question \"Does the Routinator work with real routers?\" and to make it easy to keep checking that answer as the Routinator grows and the set of test routers and router versions increases.\n\n## Here be dragons!\n\nWarning: This is very definitely an early work-in-progress, it has bugs, it's incomplete, and running and hacking on it will require effort. This is not yet for the faint of heart.\n\n## Quick Start\n\nAssuming you are running on Ubuntu 18.10 and have Docker, a DigitalOcean account, and a private Docker registry containing one or more supported virtual router images with any necessary licenses, then:\n\n```\n$ cp gantry.cfg.example gantry.cfg\n$ vi gantry.cfg # edit the values to match your setup\n$ ./gantry deploy routinator\n$ ./gantry logs routinator\n...\nRTR: Listening on 0.0.0.0:3323.\n$ ./gantry deploy vr-sros:16.0.R6 # or the router that you wish to deploy\n```\n\nSit back and drink a coffee while the rocket launches!\n\n```\n...\nTASK [ON ROUTER vr-sros-16.0.R6 @ 134.209.202.139 : WAIT FOR CONNECTION ESTABLISHED ...\nok: [134.209.202.139 ]\n\nTASK [debug] *********************************************************************************\nok: [134.209.202.139 ] => {\n \"result.stdout_lines\": [\n [\n \"===============================================================================\",\n \"Rpki Session Information\",\n \"===============================================================================\",\n \"IP Address : 134.209.198.136\",\n \"-------------------------------------------------------------------------------\",\n \"Port : 3323 Oper State : established\",\n \"UpTime : 0d 00:00:02 Flaps : 0\",\n \"Active IPv4 records: 6986 Active IPv6 records: 1258\",\n \"===============================================================================\",\n \"No. of Rpki-Sessions : 1\",\n \"===============================================================================\"\n ]\n ]\n}\n```\n\n## Configuring and testing with data directory Ansible fragments\n\nGantry can execute Ansible based router post-deployment configuration steps, and optional test suites, using Ansible fragments that you supply in the Gantry data directory.\n\nTest execution takes place inside the Gantry Docker container and so only Ansible playbooks accessible to the container via the Gantry data directory can be executed. By default the host directory `/tmp/gantry` is mapped into the container. You can override this location using the `--data-dir ` command line option.\n\n- Any `config-*.yml` files in the Gantry data directory will be included as task sets to be executed post deployment.\n- All `test-*.yml` files will be executed by `./gantry test all`.\n- Individual playbooks in the Gantry data directory can be executed using `./gantry test `, .e.g `./gantry test test-compare-vrps`.\n\n## Upgrading\n\nWhen using the `./gantry` wrapper script the Gantry Docker image is fetched the first time you use it. To upgrade it after that, assuming that a newer version of Gantry has been built over on [Docker Hub](https://hub.docker.com/r/nlnetlabs/gantry/builds), you can issue the following command:\n\n```\n$ ./gantry upgrade\nlatest: Pulling from nlnetlabs/gantry\nDigest: sha256:16c8559eed1543a4cbc8e3324aae131cb0e6246df0668b41bb13dbd8a99c6c40\nStatus: Downloaded newer image for nlnetlabs/gantry:latest\n```\n\n## Preparing router images\n\nGantry contains support for building and publishing router images to a private Docker registry. Assuming that you have in your possession the router image file and any required license file you can use Gantry to build and publish it.\n\nBelow is an example of how to build and publish a Nokia SROS 16.0.R6 router image:\n\n```\n$ mkdir /tmp/gantry\n$ cp /path/to/your/19.0.R6/sros-vm.qcow2 /tmp/gantry/sros-19.0.R6.qcow2\n$ cp /path/to/your/19.0.R6/license.txt /tmp/gantry/sros-19.0.R6.qcow2.license\n$ ./gantry registry publish\n2019-12-09 11:05:21 +0000: Publishing builds a vrnetlab router image and publishes it to your private Docker registry.\n2019-12-09 11:05:21 +0000: The router images and licenses must be supplied by you.\n2019-12-09 11:05:21 +0000: Do you wish to proceed? [y/N] y\n2019-12-09 11:05:22 +0000:\n2019-12-09 11:05:22 +0000: Which of the following router image types do you want to publish?\n csr\n nxos\n openwrt\n routeros\n sros\n veos\n vmx\n vqfx\n vrp\n vsr1000\n xrv\n xrv9k\n2019-12-09 11:05:22 +0000: Router type, e.g. sros: sros\n2019-12-09 11:05:23 +0000:\n2019-12-09 11:05:23 +0000: Please copy or sym link your .qcow2 router image, and optionally a .qcow2.license file, into:\n2019-12-09 11:05:23 +0000: /tmp/gantry\n2019-12-09 11:05:23 +0000:\n2019-12-09 11:05:23 +0000: Please read CAREFULLY the instructions that will be printed next on your screen.\n2019-12-09 11:05:23 +0000: If you do not name the copied/linked files correctly the build will FAIL.\n2019-12-09 11:05:23 +0000: Do you wish to proceed? [y/N] y\n2019-12-09 11:05:24 +0000:\nvrnetlab / Nokia VSR SROS\n=========================\nThis is the vrnetlab docker image for Nokia VSR / SROS.\n...\n... skip vrnetlab router specific README ...\n...\n2019-12-09 11:05:24 +0000: Do you wish to proceed? [y/N] y\n...\n... skip make and Docker build process output ...\n...\n2019-12-09 11:05:28 +0000:\n2019-12-09 11:05:29 +0000: The image build has finished. Does the following identify the image that was built?\n2019-12-09 11:05:29 +0000: vrnetlab/vr-sros:19.10.R1\n2019-12-09 11:05:29 +0000: Do you wish to proceed? [y/N] y\n...\n... skip Docker push output ...\n...\n2019-12-09 11:06:07 +0000: Done.\n```\n\n## Status\nDeployment of components to test:\n- [ ] NLnet Labs Krill\n- [x] NLnet Labs Routinator\n- [x] Nokia/Alcatel SROS 16.0.R6 virtual router\n- [x] Juniper VMX 18.2R1.9 virtual router\n- [ ] Cisco IOS XRv 9000 virtual router\n- [ ] Cisco CSR 1000 virtual router\n- [ ] Other RPKI caches (TBD)\n\nConfigure virtual routers to populate their RPKI VRP database from the Routinator:\n- [x] Nokia/Alcatel SROS 16.0.R6\n- [x] Juniper VMX 18.2R1.9\n- [ ] Cisco IOS XRv 9000 virtual router\n- [ ] Cisco CSR 1000 virtual router\n- [ ] Configure virtual routers to populate their RPKI VRP database from other RPKI caches (TBD)\n- [ ] Configure RPKI caches to use Krill as their data source\n\nTest scenarios:\n- [x] Symmetric diff of virtual router VRP database to that of the VRP source (done with Routinator)\n- [ ] Others (TBD)\n\n## Architecture\n\nGantry depends heavily on the [vrnetlab](https://github.com/plajjan/vrnetlab) project which is used to build the virtual router Docker images that are deployed and tested. Currently the vr-sros image build is slightly patched to enable outbound connectivity to the Routinator. With a better understanding of vrnetlab and routers the patch might turn out to be unnecessary, otherwise I would like to see if it is something that makes sense to somehow contribute pack to the vrnetlab project.\n\nInfrastructure is spun up using Docker Machine and DigitalOcean.\n\nRouter images are provisioned using Docker Machine, Docker and Ansible.\n\nTerraform is used to deploy a private Docker registry to store the router images. The [reg](https://github.com/genuinetools/reg) tool is used to work with the registry.\n\nDocker, Docker Hub and Bash are used to wrap the project up and make it easy to use. The \"simple\" Bash wrapper script has already grown beyond the initial expectation and is overdue for a rewrite in Python.\n\nThe manner in which different routers with different VM size requirements and post-deployment setup commands is supported will likely evolve, at present it's a bit of an Ansible/Docker/Bash hack.\n\n## Help\n\nFor questions, suggestions, and contributions please use GitHub issues and pull requests.\n\nConsulting the Gantry `--help` output is a good way to get a feel for what Gantry can do and how to do it:\n\n```\n$ ./gantry --help\nGantry: \"a structure built on a rocket launch pad to facilitate assembly and servicing\"\n\nNLnet Labs Gantry is a tool for deploying and testing network routers in the cloud, built to support the NLnet Labs Routinator project.\n\nUsage: gantry help|--help\n\nComponent management commands:\n gantry deploy [..] [--region ] \n gantry docker ..commands..\n gantry exec ..commands..\n gantry ip \n gantry logs [--follow]\n gantry ssh [--host]\n gantry status\n gantry undeploy [..] [--force]\n\nDocker registry commands:\n gantry registry ls|deploy|publish\n gantry registry rm /:\n\nTest suite commands:\n gantry test |all []\n\nWrapper commands:\n gantry shell\n gantry upgrade\n\nWrapper options:\n gantry --data-dir \n gantry --version\n\nWhere COMPONENT can be one of: (deploy and undeploy also accept special component 'all')\n COMPONENT VENDOR\n routinator NLnet Labs\n vr-csr:16.09.02 Cisco CSR1000v\n vr-sros:16.0.R6 Nokia/Alcatel SROS\n vr-vmx:18.2R1.9 Juniper vMX\n```\n\n_Note: The list of COMPONENTs shown is the set for which specific playbooks exist in the `playbooks/` directory. You will need the appropriate virtual router image published in your Docker registry in order to actually deploy one of these routers._\n\n## Upgrading the Routinator version\n\nThe Routinator image is pulled from the private Docker registry, NOT from the public registry.\n\nYou can upgrade it like so:\n\n```\n$ docker pull nlnetlabs/routinator:latest\n$ docker tag nlnetlabs/routinator:latest docker-reg.do.nlnetlabs.nl/nlnetlabs/routinator:latest\n$ docker push /nlnetlabs/routinator:latest\n```\n\nThe registry FQDN and login details (you might need to do `docker login` before you can push) can be found in your `gantry.cfg` file.\n\n## Hacking\n\nIf you know what you are doing and want to take full control you can dive into the Gantry wrapper container shell prompt:\n\n```\n$ ./gantry shell\nEntering shell mode..\n\nroot@a18e60b24e33:/opt/nlnetlabs/gantry# \n```\n\n## TO DO\n\nFinish this README.\n","has_starred","hub_user","immutable_tags_settings",{"_76":11,"_77":78},"enabled","rules",[79],".*","is_automated","permissions",{"_83":17,"_84":11,"_85":11},"read","write","admin","user","storage_size",3656316904,"orgData",{"_91":92,"_93":94,"_95":96,"_97":27,"_98":99,"_100":101,"_102":103,"_104":105,"_106":107,"_108":109,"_110":103,"_111":112,"_113":17},"id","98dd59ddd218413e9181258e64d84461","uuid","98dd59dd-d218-413e-9181-258e64d84461","type","organization","orgname","full_name","NLnet Labs","location","Amsterdam","company","","profile_url","https://nlnetlabs.nl","date_joined","2018-11-22T08:55:02.114424Z","gravatar_url","https://www.gravatar.com/avatar/da73ac5719ebf33be95e4b44d72c2c3a?s=80&r=g&d=mm","gravatar_email","badge","open_source","is_active","recentTags",[116,152],{"_117":46,"_118":119,"_120":121,"_91":122,"_123":124,"_52":141,"_142":119,"_143":27,"_144":58,"_37":145,"_146":147,"_148":132,"_149":141,"_150":67,"_151":17},"content_type","creator",4669854,"full_size",439714475,51856713,"images",[125],{"_126":127,"_128":129,"_130":103,"_131":132,"_133":134,"_135":136,"_137":103,"_138":-5,"_139":121,"_64":67,"_140":-5},"architecture","amd64","digest","sha256:d1698f5c5cbf5455ac43f9e64ba4aa8fe4c3a7bdf05be0e6cb69f92da3e9c2c1","features","last_pulled","2026-08-13T05:46:34.769253518Z","last_pushed","2020-10-09T12:53:45Z","os","linux","os_features","os_version","size","variant","2020-10-09T12:53:44.554554Z","last_updater","last_updater_username","media_type","latest","repository",6929682,"tag_last_pulled","tag_last_pushed","tag_status","v2",{"_117":46,"_118":119,"_120":153,"_91":154,"_123":155,"_52":160,"_142":119,"_143":27,"_144":58,"_37":161,"_146":147,"_148":158,"_149":160,"_150":67,"_151":17},387635328,55071097,[156],{"_126":127,"_128":157,"_130":103,"_131":158,"_133":159,"_135":136,"_137":103,"_138":-5,"_139":153,"_64":67,"_140":-5},"sha256:d67cb38006ce71d9d966aea591ecfeb8a4720184428ea826f15cd1101e64b255","2026-08-13T05:46:44.705447738Z","2019-05-09T12:59:08Z","2019-05-09T12:59:07.755461Z","v0.1-alpha","sbxKitMetadata","isPotentialSpam","isHubSbxKitsEnabled","displaySecurityMetadata","tagAttestations","tagsHaveAttestations",[],"routes/_layout.r.$namespace.$reponame.tags",{"_32":171,"_180":181,"_167":194,"_195":11},{"_34":172,"_44":175,"_47":48,"_49":50,"_51":11,"_52":53,"_54":55,"_56":176,"_37":29,"_26":27,"_59":60,"_61":46,"_62":63,"_64":65,"_66":67,"_68":-5,"_69":63,"_70":71,"_72":11,"_73":27,"_74":177,"_80":11,"_81":179,"_86":27,"_87":88},[173,174],{"_37":38,"_39":40},{"_37":42,"_39":43},[46],[58],{"_76":11,"_77":178},[79],{"_83":17,"_84":11,"_85":11},"tags",{"_182":183,"_184":-5,"_185":-5,"_186":187},"count",2,"next","previous","results",[188,191],{"_117":46,"_118":119,"_120":121,"_91":122,"_123":189,"_52":141,"_142":119,"_143":27,"_144":58,"_37":145,"_146":147,"_148":132,"_149":141,"_150":67,"_151":17},[190],{"_126":127,"_128":129,"_130":103,"_131":132,"_133":134,"_135":136,"_137":103,"_138":-5,"_139":121,"_64":67,"_140":-5},{"_117":46,"_118":119,"_120":153,"_91":154,"_123":192,"_52":160,"_142":119,"_143":27,"_144":58,"_37":161,"_146":147,"_148":158,"_149":160,"_150":67,"_151":17},[193],{"_126":127,"_128":157,"_130":103,"_131":158,"_133":159,"_135":136,"_137":103,"_138":-5,"_139":153,"_64":67,"_140":-5},[],"canDeleteTags","actionData","errors"]

Help

System theme

Docker Suite

nlnetlabs/gantry

Tags for nlnetlabs/gantry