Update info on python support #38855

abadger · 2018-04-16T23:40:21Z

SUMMARY

This rolls up ~~three~~ five docs changes:

Update documentation to say Python 3 is officially supported
Adds a few ref targets for some inventory vars
Add a platform FAQ section
- The latter includes documentation on how to solve a problem with non-POSIX shell shipped with Solaris 10.
Correct some :ref: tags in the release_and_maintenance doc
Fix some Explicit markup ends without a blank line; errors that were introduced by the plugin template.

ISSUE TYPE

Bugfix Pull Request
Docs Pull Request

ANSIBLE VERSION

devel 2.5

abadger · 2018-04-16T23:40:32Z

/cc @acozine

ansibot · 2018-04-16T23:51:12Z

The test ansible-test sanity --test docs-build [explain] failed with 10 errors:

docs/docsite/rst/index.rst:0:0: unknown: 
docs/docsite/rst/index.rst:0:0: unknown: 
docs/docsite/rst/index.rst:0:0: unknown:     $ cp -r -v /usr/lib64/python3.*/site-packages/selinux/ ./py3-ansible/lib64/python3.*/site-packages/
docs/docsite/rst/index.rst:0:0: unknown:     $ cp -v /usr/lib64/python3.*/site-packages/*selinux*.so ./py3-ansible/lib64/python3.*/site-packages/
docs/docsite/rst/index.rst:0:0: unknown:     $ virtualenv ansible --system-site-packages
docs/docsite/rst/index.rst:0:0: unknown:     $ virtualenv ansible --system-site-packages
docs/docsite/rst/index.rst:0:0: unknown: .. code-block:: shell
docs/docsite/rst/index.rst:0:0: unknown: .. code-block:: shell
docs/docsite/rst/index.rst:0:0: unknown: maximum 1 argument(s) allowed, 16 supplied.
docs/docsite/rst/index.rst:0:0: unknown: maximum 1 argument(s) allowed, 5 supplied.

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

docs/docsite/rst/reference_appendices/faq.rst:162:0: Error in "code-block" directive:

click here for bot help

ansibot · 2018-04-16T23:51:13Z

cc @dharmabumstead
click here for bot help

bcoca · 2018-04-17T03:31:39Z

docs/docsite/rst/installation_guide/intro_installation.rst

-.. note::
-
-   If you have Python 3 as a default Python slot on your Gentoo nodes (default setting), then you
-   must set ``ansible_python_interpreter = /usr/bin/python2`` in your group or inventory variables.


Gentoo defaults to 3.4, so we might want to leave the note but change the content, but probably make it 'some distros' as it is not the only one.

bcoca · 2018-04-17T03:32:55Z

docs/docsite/rst/reference_appendices/faq.rst

+  this in inventory like so::
+
+    solaris1 ansible_shell_executable=/usr/xpg4/bin/sh
+


+10 on adding solaris notes

acozine

+1 for the Common Platform section. That addresses issue #21594.

acozine · 2018-04-18T17:11:54Z

docs/docsite/rst/reference_appendices/faq.rst

+Running on Solaris
+------------------
+
+Some Solaris machines use a non-POSIX shell by default.  This can cause trouble for things such as


How about:
"By default, some Solaris machines run a non-POSIX shell, which does not correctly expand the default tmp directory Ansible uses ( ~/.ansible/tmp). If you see module failures on Solaris machines, this is likely the problem. There are several workarounds:"

If this is only on certain modules, then I'd say "If you see failures on the x and/or y modules on Solaris machines"

acozine · 2018-04-18T17:53:03Z

docs/docsite/rst/reference_appendices/faq.rst

@@ -200,6 +200,8 @@ several workarounds:

    solaris1 ansible_shell_executable=/usr/xpg4/bin/sh

+  (bash, ksh, and zsh should also be POSIX compatible if you have any of those installed).


+1 for adding specific examples

acozine · 2018-04-18T17:55:21Z

docs/docsite/rst/installation_guide/intro_installation.rst

-   Ansible 2.2 introduces a tech preview of support for Python 3. For more information, see `Python 3 Support <http://docs.ansible.com/ansible/python_3_support.html>`_.
+   * By default, Ansible uses the python interpreter located at :file:`/usr/bin/python` to run its
+     modules.  However, some Linux distributions may only have a Python 3 interpreter installed to
+     :file:`/usr/bin/python3` by default.  On those systems, you can either set the


What error or behavior would the user see in this scenario?

Fixed. Latest version adds the error to look out for.

acozine

WRT issue #21594 this looks good.

…docs

Populate it with * virtualenv info (previously on the python3 support page) * BSD (Link to the working with BSD page) * Solaris (Document how to work around the non-POSIX shell on some Solaris hosts) Fixes ansible#21594

Fix for the module/plugin template unintentionally unindented inside of a raw block, leading to errors like: ERROR: docs/docsite/rst/modules/redshift_facts_module.rst:289:0: Explicit markup ends without a blank line; unexpected unindent.

abadger · 2018-04-18T20:05:32Z

Merged to devel. Adding to the 2.5.x blocker project for potential inclusion in 2.5.2

* Update the documentation to list Python 3 as official * Add some reference targets for inventory variables so we can link to docs * Add a platform FAQ section Populate it with * virtualenv info (previously on the python3 support page) * BSD (Link to the working with BSD page) * Solaris (Document how to work around the non-POSIX shell on some Solaris hosts) Fixes #21594 * Fix some refs in the release_and_maintenance document * Fix unindent error in module template Fix for the module/plugin template unintentionally unindented inside of a raw block, leading to errors like: ERROR: docs/docsite/rst/modules/redshift_facts_module.rst:289:0: Explicit markup ends without a blank line; unexpected unindent. * Make wording for Solaris troubleshooting better. (cherry picked from commit a08459a)

abadger · 2018-04-19T18:41:05Z

cherry-picked to stable-2.5 for inclusion in 2.5.2

* Update the documentation to list Python 3 as official * Add some reference targets for inventory variables so we can link to docs * Add a platform FAQ section Populate it with * virtualenv info (previously on the python3 support page) * BSD (Link to the working with BSD page) * Solaris (Document how to work around the non-POSIX shell on some Solaris hosts) Fixes ansible#21594 * Fix some refs in the release_and_maintenance document * Fix unindent error in module template Fix for the module/plugin template unintentionally unindented inside of a raw block, leading to errors like: ERROR: docs/docsite/rst/modules/redshift_facts_module.rst:289:0: Explicit markup ends without a blank line; unexpected unindent. * Make wording for Solaris troubleshooting better.

bcoca changed the title ~~Solaris shell faq~~ Update info on python support Apr 17, 2018

bcoca reviewed Apr 17, 2018

View reviewed changes

bcoca approved these changes Apr 17, 2018

View reviewed changes

ryansb removed the needs_triage Needs a first human triage before being processed. label Apr 17, 2018

abadger force-pushed the solaris-shell-faq branch 2 times, most recently from 5720514 to 9d9784f Compare April 17, 2018 14:34

gundalow requested a review from acozine April 17, 2018 15:18

ansibot removed the needs_revision This PR fails CI tests or a maintainer has requested a review/revision of the PR. label Apr 17, 2018

acozine reviewed Apr 18, 2018

View reviewed changes

acozine approved these changes Apr 18, 2018

View reviewed changes

abadger added 6 commits April 18, 2018 11:36

Update the documentation to list Python 3 as official

771d183

Add some reference targets for inventory variables so we can link to …

07f50d0

…docs

Add a platform FAQ section

811ee09

Populate it with * virtualenv info (previously on the python3 support page) * BSD (Link to the working with BSD page) * Solaris (Document how to work around the non-POSIX shell on some Solaris hosts) Fixes ansible#21594

Fix some refs in the release_and_maintenance document

13e485f

Fix unindent error in module template

658253e

Fix for the module/plugin template unintentionally unindented inside of a raw block, leading to errors like: ERROR: docs/docsite/rst/modules/redshift_facts_module.rst:289:0: Explicit markup ends without a blank line; unexpected unindent.

Make wording for Solaris troubleshooting better.

b394a94

abadger force-pushed the solaris-shell-faq branch from 345f298 to b394a94 Compare April 18, 2018 18:37

acozine mentioned this pull request Apr 18, 2018

Ansible 2.2.1.0 copy module fails with Solaris 10 as target OS #21594

Closed

abadger merged commit a08459a into ansible:devel Apr 18, 2018

abadger deleted the solaris-shell-faq branch April 18, 2018 20:05

abadger added this to To Do in 2.5.x blocker list via automation Apr 18, 2018

abadger moved this from To Do to Done in 2.5.x blocker list Apr 19, 2018

ansible locked and limited conversation to collaborators Apr 27, 2019

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Update info on python support #38855

Update info on python support #38855

abadger commented Apr 16, 2018 •

edited

abadger commented Apr 16, 2018

ansibot commented Apr 16, 2018

ansibot commented Apr 16, 2018

bcoca Apr 17, 2018

bcoca Apr 17, 2018

acozine left a comment

acozine Apr 18, 2018

acozine Apr 18, 2018

acozine Apr 18, 2018

acozine Apr 18, 2018

abadger Apr 18, 2018

acozine left a comment

abadger commented Apr 18, 2018

abadger commented Apr 19, 2018

		this in inventory like so::

		solaris1 ansible_shell_executable=/usr/xpg4/bin/sh

		@@ -200,6 +200,8 @@ several workarounds:

		solaris1 ansible_shell_executable=/usr/xpg4/bin/sh

		(bash, ksh, and zsh should also be POSIX compatible if you have any of those installed).

Update info on python support #38855

Update info on python support #38855

Conversation

abadger commented Apr 16, 2018 • edited

SUMMARY

ISSUE TYPE

ANSIBLE VERSION

abadger commented Apr 16, 2018

ansibot commented Apr 16, 2018

ansibot commented Apr 16, 2018

bcoca Apr 17, 2018

Choose a reason for hiding this comment

bcoca Apr 17, 2018

Choose a reason for hiding this comment

acozine left a comment

Choose a reason for hiding this comment

acozine Apr 18, 2018

Choose a reason for hiding this comment

acozine Apr 18, 2018

Choose a reason for hiding this comment

acozine Apr 18, 2018

Choose a reason for hiding this comment

acozine Apr 18, 2018

Choose a reason for hiding this comment

abadger Apr 18, 2018

Choose a reason for hiding this comment

acozine left a comment

Choose a reason for hiding this comment

abadger commented Apr 18, 2018

abadger commented Apr 19, 2018

abadger commented Apr 16, 2018 •

edited