Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Add NetworkAttachmentConfig for service create/update #2333

Merged
merged 3 commits into from
Aug 27, 2019

Conversation

hannseman
Copy link
Contributor

@hannseman hannseman commented May 3, 2019

The current documentation makes it appear like the only way to attach networks to a service is to provide them as a list of strings of ids/names.

Attaching networks also support setting aliases and driver options. I've added the new type docker.types.NetworkAttachmentConfig which is used to document these features.

I also found that a documentation link to ConfigReference did not work. It should be referenced as docker.types.ConfigReference, this is now fixed.

docker.types.ConfigReference was also referenced by its absolute path. I changed this to make the documentation a bit easier to read.

@GordonTheTurtle
Copy link

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 "network-attachment-config" git@github.com:hannseman/docker-py.git somewhere
$ cd somewhere
$ git rebase -i HEAD~842357812144
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: Hannes Ljungberg <hannes@5monkeys.se>
Signed-off-by: Hannes Ljungberg <hannes@5monkeys.se>
Signed-off-by: Hannes Ljungberg <hannes@5monkeys.se>
@hannseman
Copy link
Contributor Author

hannseman commented Aug 24, 2019

Let me know if there's anything I can help with regarding this PR. Thanks!

I've also opened a PR in moby to fix the documentation there: moby/moby#39495

Copy link
Contributor

@shin- shin- left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Sorry it took so long! LGTM - thank you!

@shin- shin- merged commit 8fea573 into docker:master Aug 27, 2019
@shin- shin- added this to the 4.1.0 milestone Aug 27, 2019
@hannseman
Copy link
Contributor Author

@shin- No problem! Thanks for the review.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants