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

Update network debug troubleshooting guide #36288

Merged
merged 8 commits into from
Feb 19, 2018

Conversation

ganeshrn
Copy link
Member

SUMMARY

Fix #35914

Command timeout and connection timeout error messages
are displayed in the log file instead of on the console.
Update the same in the troubleshooting guide.

ISSUE TYPE
  • Docs Pull Request
COMPONENT NAME

rst/networking_guide/network_debug_troubleshooting.rst

ANSIBLE VERSION
2.5
ADDITIONAL INFORMATION

Fix ansible#35914

Command timeout and connection timeout error messages
are dsiplayed in log file instead on console.
Update the same in troubleshooting guide.
@ansibot
Copy link
Contributor

ansibot commented Feb 16, 2018

@ansibot ansibot added docs_pull_request needs_triage Needs a first human triage before being processed. support:core This issue/PR relates to code supported by the Ansible Engineering Team. labels Feb 16, 2018
@ganeshrn ganeshrn added networking Network category and removed needs_triage Needs a first human triage before being processed. labels Feb 16, 2018
@ansibot
Copy link
Contributor

ansibot commented Feb 16, 2018

The test ansible-test sanity --test rstcheck [explain] failed with 1 error:

docs/docsite/rst/networking_guide/network_debug_troubleshooting.rst:163:0: Definition list ends without a blank line; unexpected unindent.

click here for bot help

@ansibot ansibot added ci_verified Changes made in this PR are causing tests to fail. needs_revision This PR fails CI tests or a maintainer has requested a review/revision of the PR. labels Feb 16, 2018
@ansibot ansibot removed the ci_verified Changes made in this PR are causing tests to fail. label Feb 16, 2018
@ansibot
Copy link
Contributor

ansibot commented Feb 16, 2018

The test ansible-test sanity --test rstcheck [explain] failed with 1 error:

docs/docsite/rst/networking_guide/network_debug_troubleshooting.rst:195:0: Explicit markup ends without a blank line; unexpected unindent.

click here for bot help

@ansibot ansibot added the ci_verified Changes made in this PR are causing tests to fail. label Feb 16, 2018
@ansibot ansibot removed the ci_verified Changes made in this PR are causing tests to fail. label Feb 16, 2018
Copy link
Contributor

@gundalow gundalow left a comment

Choose a reason for hiding this comment

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

Thanks, just a few minor comments

.. _socket_path_issue:

Category "socket_path issue"
========================================================
Copy link
Contributor

Choose a reason for hiding this comment

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

Only need = as long as the line above


**Platforms:** Any

The ``socket_path does not exist or cannot be found`` and ``unable to connect to socket`` message is new in Ansible 2.5. This message means that
Copy link
Contributor

Choose a reason for hiding this comment

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

"message is new" -> "messages are new"
"This message means" -> "These messages means"


Suggestions to resolve:

Follow the steps detailed in enable_network_logging_.
Copy link
Contributor

Choose a reason for hiding this comment

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

May be GitHub formatting issue, though this doesn't look right.
I think you want

 :ref:`enable network logging <enable_network_logging>`


Follow the steps detailed in enable_network_logging_.

If the identified the error message from the log file is
Copy link
Contributor

Choose a reason for hiding this comment

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

"log file is:"


If the identified the error message from the log file is

For example:
Copy link
Contributor

Choose a reason for hiding this comment

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

Delete this and a blank line


2017-04-04 12:19:05,670 p=18591 u=fred | persistent connection idle timeout triggered, timeout value is 30 secs

Follow the steps detailed in timeout_issues_.
Copy link
Contributor

Choose a reason for hiding this comment

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

Same as above think you need :ref

@gundalow
Copy link
Contributor

Thanks for this. Will need approval from both @acozine and @dharmabumstead

Once they are happy this will need to go into devel & stable-2.5

@ganeshrn
Copy link
Member Author

ganeshrn commented Feb 16, 2018

@gundalow Fixed comments, thank you for review.

ready_for_review

Copy link
Contributor

@dharmabumstead dharmabumstead left a comment

Choose a reason for hiding this comment

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

OK with some edits.

@ansibot ansibot removed the needs_revision This PR fails CI tests or a maintainer has requested a review/revision of the PR. label Feb 16, 2018
Copy link
Contributor

@acozine acozine left a comment

Choose a reason for hiding this comment

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

Good info to include with the release. Thanks @ganeshrn.

@ganeshrn
Copy link
Member Author

@gundalow @acozine @dharmabumstead @trishnaguha @rcarrillocruz Thank you for review.

@ganeshrn ganeshrn merged commit b57cc7c into ansible:devel Feb 19, 2018
@ganeshrn ganeshrn deleted the update_troubleshooting_guide branch February 19, 2018 15:10
ganeshrn added a commit to ganeshrn/ansible that referenced this pull request Feb 19, 2018
* Update network debug troubleshooting guide

Fix ansible#35914

Command timeout and connection timeout error messages
are dsiplayed in log file instead on console.
Update the same in troubleshooting guide.

* Update example error

* Fix CI issues

* Fix more CI failures

* More fixes

* Fix review comments

* Fix more review comments

* Copy edit

(cherry picked from commit b57cc7c)
ganeshrn added a commit that referenced this pull request Feb 19, 2018
* Update network debug troubleshooting guide

Fix #35914

Command timeout and connection timeout error messages
are dsiplayed in log file instead on console.
Update the same in troubleshooting guide.

* Update example error

* Fix CI issues

* Fix more CI failures

* More fixes

* Fix review comments

* Fix more review comments

* Copy edit

(cherry picked from commit b57cc7c)
@ganeshrn
Copy link
Member Author

Cherry-pick to stable-2.5 51673f4

@ansibot ansibot added docs This issue/PR relates to or includes documentation. and removed docs_pull_request labels Mar 4, 2018
@ansible ansible locked and limited conversation to collaborators Apr 27, 2019
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Labels
docs This issue/PR relates to or includes documentation. networking Network category support:core This issue/PR relates to code supported by the Ansible Engineering Team.
Projects
None yet
Development

Successfully merging this pull request may close these issues.

vyos_command module throwing socket_path does not exist or cannot be found
7 participants