Added arguments to create a swarm with a custom address pool and subnet size. #2201

originalgremlin · 2018-12-12T06:12:00Z

Signed-off-by: Barry Shapira [email protected]

…net size. Signed-off-by: Barry Shapira <[email protected]>

originalgremlin · 2018-12-12T06:19:47Z

Adding the arguments to swarm init was relatively straightforward. I do wonder how the maintainers will feel about adding these arguments at all: other parts of the docker-py swarm API rely on a docker engine API version of 1.24, whereas these features are from a much more recent docker engine API of 1.39.

If any maintainers have ideas on how best to handle modernization of the swarm part of this repo I would be happy to help round out the codebase and truly "let you do anything the docker command does".

shin- · 2018-12-13T19:52:38Z

Thanks for submitting a PR @originalgremlin !

FWIW, the library already has a fairly established way to handle parameters added in newer versions of the API. see here or here for example. Please make sure to adopt the same idiom for this PR so we can move forward!

Also corrected a documentation error: the default API version from constants is currently 1.35, not 1.30 as was sometimes listed. Signed-off-by: Barry Shapira <[email protected]>

originalgremlin · 2018-12-14T08:02:51Z

@shin- That makes sense. Thanks for pointing out the examples for how such things are handled.

Code updated and pushed. Has been tested a fair amount in my local environment. Did my best to stick with the project style though you may well have suggestions for things that I missed.

GordonTheTurtle · 2018-12-14T16:30:50Z

Please sign your commits following these rules:
https://github.com/moby/moby/blob/master/CONTRIBUTING.md#sign-your-work
The easiest way to do this is to amend the last commit:

$ git clone -b "2200-swarm-default-addr-pool" [email protected]:originalgremlin/docker-py.git somewhere
$ cd somewhere
$ git rebase -i HEAD~842354056040
editor opens
change each 'pick' to 'edit'
save the file and quit
$ git commit --amend -s --no-edit
$ git rebase --continue # and repeat the amend for each commit
$ git push -f

Amending updates the existing PR. You DO NOT need to open a new one.

Signed-off-by: Barry Shapira <[email protected]>

The integration tests require restarting the swarm once for each test. I had done so manually with self.init_swarm(force_new_cluster=True) but that wasn't resetting the swarm state correctly. The usual test teardown procedure cleans up correctly. Signed-off-by: Barry Shapira <[email protected]>

originalgremlin · 2019-01-04T01:57:05Z

@shin- Should be ready to go now. All tests pass and all protocol followed to the best of my ability. Let me know if there's any other polishing I should do.

originalgremlin · 2019-01-14T05:17:10Z

@shin- Squeaky wheel ping. Anything missing or needing improvement in order to get this PR merged?

chris-crone

Thanks for the contribution @originalgremlin! Just a couple of minor comments.

chris-crone · 2019-01-15T10:19:18Z

docker/api/swarm.py


    @utils.minimum_version('1.24')
    def init_swarm(self, advertise_addr=None, listen_addr='0.0.0.0:2377',
+                   default_addr_pool=None, subnet_size=None,


Should add new parameters at the end of the list so that callers of init_swarm that use ordered (i.e.: unnamed) parameters continue to work as expected.

e.g.: An existing function could call:

s.init_swarm('192.168.0.1', '0.0.0.0:2377', True)

Which would now break.

chris-crone · 2019-01-15T10:22:56Z

docker/models/swarm.py

    get_unlock_key.__doc__ = APIClient.get_unlock_key.__doc__

    def init(self, advertise_addr=None, listen_addr='0.0.0.0:2377',
+             default_addr_pool=None, subnet_size=None,


Same comment here for parameters.

chris-crone · 2019-01-15T10:29:37Z

docker/api/swarm.py

                is used. Default: '0.0.0.0:2377'
+            default_addr_pool (list of strings): Default Address Pool specifies
+                default subnet pools for global scope networks. Each pool
+                should be specified as a CIDR block, like '10.0.0.0/16'.


nit: Might be good to use the default as the example.

Following docker#2201 (review)

Following docker#2201 (review) Signed-off-by: Hannes Ljungberg <[email protected]>

Following docker#2201 (review) Co-authored-by: hannseman <[email protected]> Co-authored-by: bluikko Signed-off-by: Hannes Ljungberg <[email protected]>

Co-authored-by: hannseman <[email protected]> Co-authored-by: bluikko <[email protected]> Following docker#2201 (review) Signed-off-by: Hannes Ljungberg <[email protected]>

Co-authored-by: Hannes Ljungberg <[email protected]> Co-authored-by: bluikko <[email protected]> Following docker#2201 (review) Signed-off-by: Hannes Ljungberg <[email protected]>

Following docker#2201 (review) Signed-off-by: Hannes Ljungberg <[email protected]> Co-authored-by: Hannes Ljungberg <[email protected]> Co-authored-by: bluikko <[email protected]>

Added arguments to creeate a swarm with a custom address pool and sub…

e941c51

…net size. Signed-off-by: Barry Shapira <[email protected]>

originalgremlin mentioned this pull request Dec 12, 2018

No option to initialize a swarm with a default-addr-pool #2200

Closed

Check API version before setting swarm addr pool.

b7d93f6

Also corrected a documentation error: the default API version from constants is currently 1.35, not 1.30 as was sometimes listed. Signed-off-by: Barry Shapira <[email protected]>

GordonTheTurtle added the dco/no label Dec 14, 2018

Removed accidental whitespace.

6e21b83

Signed-off-by: Barry Shapira <[email protected]>

originalgremlin force-pushed the 2200-swarm-default-addr-pool branch from d74d652 to 6e21b83 Compare December 14, 2018 16:49

GordonTheTurtle removed the dco/no label Dec 14, 2018

chris-crone requested changes Jan 15, 2019

View reviewed changes

This was referenced Feb 22, 2019

docker_swarm module support for --default-addr-pool ansible/ansible#51611

Closed

swarm with a custom address pool and subnet size revisited #2261

Closed

hannseman pushed a commit to hannseman/docker-py that referenced this pull request Mar 22, 2019

Fix documentation and argument order

b10b0e6

Following docker#2201 (review)

hannseman pushed a commit to hannseman/docker-py that referenced this pull request Mar 22, 2019

Fix documentation and argument order

f51f0f0

Following docker#2201 (review)

hannseman added a commit to hannseman/docker-py that referenced this pull request Mar 22, 2019

Fix documentation and argument order

8c29e1f

Following docker#2201 (review) Signed-off-by: Hannes Ljungberg <[email protected]>

hannseman pushed a commit to hannseman/docker-py that referenced this pull request Mar 22, 2019

Fix documentation and argument order

5699b92

Following docker#2201 (review) Signed-off-by: Hannes Ljungberg <[email protected]>

hannseman mentioned this pull request Mar 22, 2019

Redux added arguments to create a swarm with a custom address pool and subnet size. #2287

Merged

hannseman added a commit to hannseman/docker-py that referenced this pull request Mar 22, 2019

Fix documentation and argument order

cb17091

Following docker#2201 (review) Signed-off-by: Hannes Ljungberg <[email protected]>

hannseman added a commit to hannseman/docker-py that referenced this pull request Mar 22, 2019

Fix documentation and order of arguments

5e2fd8d

Following docker#2201 (review) Signed-off-by: Hannes Ljungberg <[email protected]>

ijc closed this in #2287 Mar 25, 2019

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Uh oh!

Added arguments to create a swarm with a custom address pool and subnet size. #2201

Added arguments to create a swarm with a custom address pool and subnet size. #2201

Uh oh!

originalgremlin commented Dec 12, 2018

Uh oh!

originalgremlin commented Dec 12, 2018 •

edited

Loading

Uh oh!

shin- commented Dec 13, 2018

Uh oh!

originalgremlin commented Dec 14, 2018

Uh oh!

GordonTheTurtle commented Dec 14, 2018

Uh oh!

originalgremlin commented Jan 4, 2019

Uh oh!

originalgremlin commented Jan 14, 2019

Uh oh!

chris-crone left a comment

Uh oh!

chris-crone Jan 15, 2019

Uh oh!

chris-crone Jan 15, 2019

Uh oh!

chris-crone Jan 15, 2019

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

4 participants

Added arguments to create a swarm with a custom address pool and subnet size. #2201

Added arguments to create a swarm with a custom address pool and subnet size. #2201

Uh oh!

Conversation

originalgremlin commented Dec 12, 2018

Uh oh!

originalgremlin commented Dec 12, 2018 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

shin- commented Dec 13, 2018

Uh oh!

originalgremlin commented Dec 14, 2018

Uh oh!

GordonTheTurtle commented Dec 14, 2018

Uh oh!

originalgremlin commented Jan 4, 2019

Uh oh!

originalgremlin commented Jan 14, 2019

Uh oh!

chris-crone left a comment

Choose a reason for hiding this comment

Uh oh!

chris-crone Jan 15, 2019

Choose a reason for hiding this comment

Uh oh!

chris-crone Jan 15, 2019

Choose a reason for hiding this comment

Uh oh!

chris-crone Jan 15, 2019

Choose a reason for hiding this comment

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

4 participants

originalgremlin commented Dec 12, 2018 •

edited

Loading