Docker inventory service/stack groups for docker swarm

[sosheskaz]

SUMMARY

This adds host grouping based on "service" and "stack" to the docker.py inventory script.

ISSUE TYPE

• Feature Pull Request

COMPONENT NAME

docker.py inventory

ANSIBLE VERSION

ansible 2.7.0
  config file = None
  configured module search path = [u'/home/eric/.ansible/plugins/modules', u'/usr/share/ansible/plugins/modules']
  ansible python module location = /usr/local/lib/python2.7/dist-packages/ansible
  executable location = /usr/local/bin/ansible
  python version = 2.7.15rc1 (default, Apr 15 2018, 21:51:34) [GCC 7.3.0]

ADDITIONAL INFORMATION

This makes no change to existing functionality but extends the grouping of containers based on image to group on stack and service as well. This is done by conditionally keying the a host's groups off of the labels com.docker.stack.namespace and com.docker.swarm.service.name.

The derived groups are in the format service_<service_name> and stack_<stack_name>

You can find the docker-compose file I used to create these groups here.

Excerpt from "pretty" docker.py output:

$ contrib/inventory/docker.py | jq .service_ansible_mock_host
[
  "ansible_mock_host.2.qo2m6mrmtfy8f8zl64yogsyef",
  "ansible_mock_host.1.hxnrh84blwmscu2pmgl4p5ann",
  "ansible_mock_host.3.sn74oapkk5ay3la148js5z93n",
  "ansible_mock_host.4.zi8jyrocpts7hw8x0sba9k47b",
  "ansible_mock_host.5.i5t8il409jgua2olw1wfw5ucg",
  "ansible_mock_host.3.ly13cxwzvibmuf6volsr8t1z8",
  "ansible_mock_host.2.bkiiay0a48a3koxkgbvvte9me"
]

$ contrib/inventory/docker.py | jq .stack_ansible_mock
[
  "ansible_mock_host.2.qo2m6mrmtfy8f8zl64yogsyef",
  "ansible_mock_host.1.hxnrh84blwmscu2pmgl4p5ann",
  "ansible_mock_host.3.sn74oapkk5ay3la148js5z93n",
  "ansible_mock_host.4.zi8jyrocpts7hw8x0sba9k47b",
  "ansible_mock_host.5.i5t8il409jgua2olw1wfw5ucg",
  "ansible_mock_host.3.ly13cxwzvibmuf6volsr8t1z8",
  "ansible_mock_host.2.bkiiay0a48a3koxkgbvvte9me"
]

# warnings omitted from output for legibility
$ ansible -i contrib/inventory/docker.py 'stack_ansible_mock:&running' \
-m ping -e ansible_connection=docker -e ansible_python_interpreter=/usr/local/bin/python
ansible_mock_host.1.hxnrh84blwmscu2pmgl4p5ann | SUCCESS => {
    "changed": false,
    "ping": "pong"
}
ansible_mock_host.5.i5t8il409jgua2olw1wfw5ucg | SUCCESS => {
    "changed": false,
    "ping": "pong"
}
ansible_mock_host.3.sn74oapkk5ay3la148js5z93n | SUCCESS => {
    "changed": false,
    "ping": "pong"
}
ansible_mock_host.4.zi8jyrocpts7hw8x0sba9k47b | SUCCESS => {
    "changed": false,
    "ping": "pong"
}
ansible_mock_host.2.qo2m6mrmtfy8f8zl64yogsyef | SUCCESS => {
    "changed": false,
    "ping": "pong"
}

[ansibot]

Hi @sosheskaz, thank you for submitting this pull-request!

click here for bot help

[ansibot]

cc @akshay196 @danihodovic @dariko @felixfontein @jwitko @kassiansun @tbouvet
click here for bot help

[DBendit]

This looks great, but you're missing a changelog fragment explaining the change in functionality. See https://docs.ansible.com/ansible/latest/reference_appendices/release_and_maintenance.html#creating-new-fragments. Once you get that added in (which should also trigger another CI run, clearing that label), I can come back and approve this.

[ansibot]

cc @DBendit
click here for bot help

[sosheskaz]

The documentation linked does not mention a type for inventory scripts or a sample format; I made the assumption of minor_changes and named the "module" inventory/docker.

[DBendit]

LGTM

Whoever ends up reviewing this for merge: I know we're done with inventory scripts, but I figure that this modification to an existing one is alright. Let me know if that assumption is incorrect.

[DBendit]

Also, thank you @sosheskaz for the detailed test instructions. It made it much easier to verify this change!

[felixfontein]

The changes look good to me, though I cannot say anything specific about inventory scripts.

shipit

[felixfontein]

bot_status

[ansibot]

Components

changelogs/fragments/inventory-docker-service-stack-groups.yaml
support: community
maintainers:

contrib/inventory/docker.py
support: community
maintainers: DBendit akshay196 danihodovic dariko felixfontein jwitko kassiansun tbouvet

Metadata

waiting_on: maintainer
changes_requested_by: null
needs_info: False
needs_revision: False
needs_rebase: False
merge_commits: []
too many files or commits: False
mergeable_state: clean
shippable_status: success
maintainer_shipits (module maintainers): 1
community_shipits (namespace maintainers): 0
ansible_shipits (core team members): 1
shipit_actors (maintainers or core team members): DBendit felixfontein
shipit_actors_other: []
automerge: automerge is_module test failed

click here for bot help

[gundalow]

@sosheskaz Thank you, merged into devel for release in Ansible 2.8

[felixfontein]

@sosheskaz thanks for your PR!
@DBendit thanks for reviewing and testing it!
@gundalow thanks for merging :)