| commit | author | age | ||
| 659253 | 1 | # pyIPAM - Docker Plugin for IPAM |
| JK | 2 | |
| 3 | Simple IPAM plugin for Docker Engine that correctly handles IPv6 addresses | |
| 4 | (see https://github.com/docker/for-linux/issues/931 for bug details). | |
| 5 | ||
| 6 | It should be a drop-in replacement for "default" IPAM module. | |
| 7 | ||
| 40a1f9 | 8 |  |
| JK | 9 | |
| 659253 | 10 | ## Installation |
| JK | 11 | |
| 12 | Plugin is packaged as [Docker Engine-managed plugin](https://docs.docker.com/engine/extend/). | |
| 40a1f9 | 13 | Check out [plugin page on Docker Hub](https://hub.docker.com/p/jacekkow/pyipam). |
| 659253 | 14 | |
| JK | 15 | To install it simply run: |
| 16 | ||
| 17 | ```bash | |
| 18 | docker plugin install jacekkow/pyipam | |
| 19 | ``` | |
| 20 | ||
| 21 | Then you can use it in newly-created networks: | |
| 22 | ||
| 23 | ```bash | |
| a007ff | 24 | docker network create --ipam-driver jacekkow/pyipam:latest new-network |
| 659253 | 25 | ``` |
| JK | 26 | |
| 27 | Check out [`test_integration.sh`](test_integration.sh) for more examples. | |
| 28 | ||
| 29 | ## Manual packaging | |
| 30 | ||
| 31 | In order to test this module in development environment, you can build it | |
| 32 | by following [Docker Engine documentation](https://docs.docker.com/engine/extend/#developing-a-plugin). | |
| 33 | ||
| 34 | You can also use `package.sh` helper script which will perform | |
| 35 | all the steps (including installation) automatically. | |
