From c0b2fe3e3bd44e31c19c05abb8432b527f9c5ee0 Mon Sep 17 00:00:00 2001 From: Michael Bridgen Date: Mon, 29 Jun 2015 19:19:44 +0100 Subject: [PATCH] Remove references to 'IPAM' in docs and UI The option `--no-default-ipam` is replaced with `--no-default-ipalloc`; the former will still work (in a 'last one wins' way), but its usage message says it's deprecated. --- prog/weaveproxy/main.go | 3 ++- site/proxy.md | 10 +++++----- site/weavedns.md | 8 ++++---- test/600_proxy_docker_py_test.sh | 2 +- test/660_proxy_ipam_test.sh | 2 +- weave | 2 +- 6 files changed, 14 insertions(+), 13 deletions(-) diff --git a/prog/weaveproxy/main.go b/prog/weaveproxy/main.go index e1d87a7a..df1a732f 100644 --- a/prog/weaveproxy/main.go +++ b/prog/weaveproxy/main.go @@ -26,7 +26,8 @@ func main() { getopt.BoolVarLong(&debug, "debug", 'd', "log debugging information") getopt.BoolVarLong(&justVersion, "version", 0, "print version and exit") getopt.ListVar(&c.ListenAddrs, 'H', fmt.Sprintf("address on which to listen (default %s)", defaultListenAddrs)) - getopt.BoolVarLong(&c.NoDefaultIPAM, "no-default-ipam", 0, "do not automatically allocate addresses for containers without a WEAVE_CIDR") + getopt.BoolVarLong(&c.NoDefaultIPAM, "no-default-ipalloc", 0, "do not automatically allocate addresses for containers without a WEAVE_CIDR") + getopt.BoolVarLong(&c.NoDefaultIPAM, "no-default-ipam", 0, "do not automatically allocate addresses for containers without a WEAVE_CIDR (deprecated; please use --no-default-ipalloc") getopt.StringVarLong(&c.TLSConfig.CACert, "tlscacert", 0, "Trust certs signed only by this CA") getopt.StringVarLong(&c.TLSConfig.Cert, "tlscert", 0, "Path to TLS certificate file") getopt.BoolVarLong(&c.TLSConfig.Enabled, "tls", 0, "Use TLS; implied by --tlsverify") diff --git a/site/proxy.md b/site/proxy.md index 3ec5ed76..611a5643 100644 --- a/site/proxy.md +++ b/site/proxy.md @@ -110,10 +110,10 @@ To start a container without connecting it to the weave network, pass host1$ docker run -ti -e WEAVE_CIDR=none ubuntu -If you do not want IPAM to be used by default, the proxy needs to be -passed the `--no-default-ipam` flag, e.g. +If you do not want an IP to be assigned by default, the proxy needs to +be passed the `--no-default-ipalloc` flag, e.g., - host1$ docker launch-proxy --no-default-ipam + host1$ docker launch-proxy --no-default-ipalloc In this configuration, containers with no `WEAVE_CIDR` environment variable will not be connected to the weave network. Containers @@ -121,7 +121,7 @@ started with a `WEAVE_CIDR` environment variable are handled as before. To automatically assign an address in this mode, we start the container with a blank `WEAVE_CIDR`, e.g. - host1$ docker run -ti -e WEAVE_CIDR= ubuntu + host1$ docker run -ti -e WEAVE_CIDR="" ubuntu ## Automatic discovery @@ -186,7 +186,7 @@ containers on the weave network with `weave run`: The arguments after `run` are passed through to `docker run` so you can freely specify whichever docker options are appropriate. Once the container is started, `weave run` attaches it to the weave network, in -this example with an address allocated by IPAM. If you wish you can +this example with an automatically allocated IP. If you wish you can specify addresses manually instead: $ weave run 10.2.1.1/24 -ti ubuntu diff --git a/site/weavedns.md b/site/weavedns.md index c97d80d5..304364dd 100644 --- a/site/weavedns.md +++ b/site/weavedns.md @@ -72,10 +72,10 @@ detection of the weaveDNS container. Each weaveDNS container started with `launch-dns` needs its own unique IP address in a subnet that is common to all weaveDNS containers. In the example above we did not specify such an address, so one was -allocated automatically by IPAM from the default subnet; you can -however specify an address in CIDR format manually. In this case you -are responsible for ensuring that the IP addresses specified are -uniquely allocated and not in use by any other container. +allocated automatically from the default subnet; you can however +specify an address in CIDR format manually. In this case you are +responsible for ensuring that the IP addresses specified are uniquely +allocated and not in use by any other container. Finally, weaveDNS can be stopped independently with diff --git a/test/600_proxy_docker_py_test.sh b/test/600_proxy_docker_py_test.sh index 84d27608..f016572f 100755 --- a/test/600_proxy_docker_py_test.sh +++ b/test/600_proxy_docker_py_test.sh @@ -6,7 +6,7 @@ start_suite "Run docker-py test suite against the proxy" docker_on $HOST1 pull joffrey/docker-py >/dev/null -weave_on $HOST1 launch-proxy --no-default-ipam +weave_on $HOST1 launch-proxy --no-default-ipalloc if docker_on $HOST1 run \ -e NOT_ON_HOST=true \ diff --git a/test/660_proxy_ipam_test.sh b/test/660_proxy_ipam_test.sh index f0635f83..72a4ceed 100755 --- a/test/660_proxy_ipam_test.sh +++ b/test/660_proxy_ipam_test.sh @@ -20,7 +20,7 @@ start_suite "Ping proxied containers over cross-host weave network (with IPAM)" weave_on $HOST1 launch-router -iprange $UNIVERSE weave_on $HOST2 launch-router -iprange $UNIVERSE $HOST1 weave_on $HOST1 launch-proxy -weave_on $HOST2 launch-proxy --no-default-ipam +weave_on $HOST2 launch-proxy --no-default-ipalloc start $HOST1 --name=auto start $HOST1 --name=none -e WEAVE_CIDR=none diff --git a/weave b/weave index 4326d360..a9effdd7 100755 --- a/weave +++ b/weave @@ -32,7 +32,7 @@ usage() { echo " [-iprange [-ipsubnet ]] ..." echo "weave launch-dns []" echo "weave launch-proxy [-H ] [--with-dns | --without-dns]" - echo " [--no-default-ipam]" + echo " [--no-default-ipalloc]" echo "weave connect [--replace] [ ...]" echo "weave forget ..." echo "weave run [--with-dns | --without-dns] [ ...] ..."