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

docker_swarm inventory plugin: fix some docs formatting #54952

Merged
merged 1 commit into from Apr 8, 2019

Conversation

felixfontein
Copy link
Contributor

SUMMARY

Improves docs formatting of docker_swarm inventory plugin.

ISSUE TYPE
  • Docs Pull Request
COMPONENT NAME

lib/ansible/plugins/inventory/docker_swarm.py

@ansibot
Copy link
Contributor

ansibot commented Apr 7, 2019

@ansibot ansibot added affects_2.8 This issue/PR affects Ansible v2.8 cloud community_review In order to be merged, this PR must follow the community review workflow. docker docs This issue/PR relates to or includes documentation. inventory Inventory category needs_triage Needs a first human triage before being processed. support:community This issue/PR relates to code supported by the Ansible community. labels Apr 7, 2019
@@ -89,10 +89,10 @@
default: 60
aliases: [ time_out ]
include_host_uri:
description: Toggle to return the additional attribute I(ansible_host_uri) which contains the URI of the
swarm leader in format of M(tcp://172.16.0.1:2376). This value may be used without additional
Copy link
Contributor Author

Choose a reason for hiding this comment

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

M(xyz) creates a link to a module called xyz, which totally doesn't make sense here.

@ansibot ansibot added needs_revision This PR fails CI tests or a maintainer has requested a review/revision of the PR. and removed community_review In order to be merged, this PR must follow the community review workflow. labels Apr 7, 2019
@felixfontein
Copy link
Contributor Author

Hmmm, the CI failures (https://app.shippable.com/github/ansible/ansible/runs/118028/62/tests) are totally unrelated to this PR:

 failure: Failed to import docker or docker-py (Docker SDK for Python) - No module named docker. Try `pip install docker` or `pip install docker-py` (Python 2.6). 

In fact, the real error is a bit earlier: ERROR! the role 'setup_epel' was not found in /root/.ansible/test/tmp/inventory_docker_swarm-PFYm1A-ÅÑŚÌβŁÈ/test/integration/targets/inventory_docker_swarm/playbooks/roles:/root/.ansible/roles:/usr/share/ansible/roles:/etc/ansible/roles:/root/.ansible/test/tmp/inventory_docker_swarm-PFYm1A-ÅÑŚÌβŁÈ/test/integration/targets/inventory_docker_swarm/playbooks
@mattclay this seems to be related to your recent change (#54917). Do you have any idea what goes wrong here?

@felixfontein felixfontein reopened this Apr 7, 2019
@felixfontein
Copy link
Contributor Author

Ok, I've figured it out. The problem is that the tests for the inventory plugin use the runme.sh approach, and the playbooks called from there included setup_docker via a relative path without changing the role search path. That's now fixed in this PR.

@ansibot ansibot added community_review In order to be merged, this PR must follow the community review workflow. test This PR relates to tests. and removed needs_revision This PR fails CI tests or a maintainer has requested a review/revision of the PR. labels Apr 7, 2019
@felixfontein
Copy link
Contributor Author

I've created a new PR for that commit (#54962), I'll rebase this one once that PR is merged.

@felixfontein
Copy link
Contributor Author

ready_for_review

@WojciechowskiPiotr
Copy link
Contributor

shipit

@ansibot ansibot added shipit This PR is ready to be merged by Core and removed community_review In order to be merged, this PR must follow the community review workflow. needs_triage Needs a first human triage before being processed. labels Apr 7, 2019
Copy link
Contributor

@resmo resmo left a comment

Choose a reason for hiding this comment

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

shipit

@felixfontein
Copy link
Contributor Author

shipit

@ansibot ansibot added the automerge This PR was automatically merged by ansibot. label Apr 8, 2019
@ansibot ansibot merged commit 4503426 into ansible:devel Apr 8, 2019
@felixfontein
Copy link
Contributor Author

@WojciechowskiPiotr @resmo thanks for reviewing!

@felixfontein felixfontein deleted the docker_swarm-docs-update branch April 8, 2019 06:19
@ansible ansible locked and limited conversation to collaborators Jul 25, 2019
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Labels
affects_2.8 This issue/PR affects Ansible v2.8 automerge This PR was automatically merged by ansibot. cloud docker docs This issue/PR relates to or includes documentation. inventory Inventory category shipit This PR is ready to be merged by Core support:community This issue/PR relates to code supported by the Ansible community. test This PR relates to tests.
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

4 participants