ansible-collections/community.general
1
0
Fork 0
mirror of https://github.com/ansible-collections/community.general.git synced 2025-07-28 23:51:23 -07:00
Code Issues Projects Releases Packages Wiki Activity Actions 9

Windows: Add Windows Subsystem for Linux documentation (#23515)

Browse source 
* Windows: Add Windows Subsystem for Linux documentation

As discussed during the Windows Working Group meeting we do want
documentation on running Ansible on Windows as it may help grow
the Windows/Ansible community and does work out-of-the-box.

However we do take care to emphasize that WSL is not fit for
production use.

* Update intro_windows.rst

Edits for mechanics and clarity.
This commit is contained in:
Dag Wieers 2017-04-13 20:22:40 +02:00 • committed by Matt Davis
commit b6c00f722b
1 changed files with 29 additions and 11 deletions
Download patch file Download diff file Expand all files Collapse all files

40
docs/docsite/rst/intro_windows.rst
View file

@ -14,6 +14,7 @@ Starting in version 1.7, Ansible also contains support for managing Windows mach
native PowerShell remoting, rather than SSH. native PowerShell remoting, rather than SSH.
Ansible will still be run from a Linux control machine, and uses the "winrm" Python module to talk to remote hosts. Ansible will still be run from a Linux control machine, and uses the "winrm" Python module to talk to remote hosts.
While not supported by Microsoft or Ansible, this Linux control machine can be a Windows Subsystem for Linux (WSL) bash shell.
No additional software needs to be installed on the remote machines for Ansible to manage them, it still maintains the agentless properties that make it popular on Linux/Unix. No additional software needs to be installed on the remote machines for Ansible to manage them, it still maintains the agentless properties that make it popular on Linux/Unix.
@ -31,6 +32,34 @@ On a Linux control machine::
.. Note:: on distributions with multiple python versions, use pip2 or pip2.x, where x matches the python minor version Ansible is running under. .. Note:: on distributions with multiple python versions, use pip2 or pip2.x, where x matches the python minor version Ansible is running under.
.. _windows_control_machine:
Using a Windows control machine
```````````````````````````````
A Linux control machine is required to manage Windows hosts. This Linux control machine can be a Windows Subsystem for Linux (WSL) bash shell.
.. Note:: Running Ansible from a Windows control machine directly is not a goal of the project. Refrain from asking for this feature, as it limits what technologies, features, and code we can use in the main project in the future.
.. Note:: The Windows Subsystem for Linux (Beta) is not supported by Microsoft or Ansible and should not be used for production systems.
If you would like to experiment with the Windows Subsystem for Linux (WSL), first enable the Windows Subsystem for Linux using
`these instructions <https://www.jeffgeerling.com/blog/2017/using-ansible-through-windows-10s-subsystem-linux>`_.
This requires a reboot.
Once WSL is enabled, you can open the Bash terminal. The first time you so this, a few questions need to be answered.
At the prompt you can quickly start using the Ansible devel branch by running the following commands::
sudo apt-get install python-pip
pip install pywinrm
git clone https://github.com/ansible/ansible.git
source ansible/hacking/env-setup
After you've successfully run these commands, you can start to create your inventory, write example playbooks and start targetting systems using the plethora of available Windows modules.
.. Note:: Ansible is also reported to work on Cygwin, but this is more cumbersome and doesn't scale as well as WSL.
Authentication Options Authentication Options
`````````````````````` ``````````````````````
@ -375,17 +404,6 @@ The above magic is necessary to tell Ansible to mix in some common code and also
What modules you see in ``windows/`` are just a start. Additional modules may be submitted as pull requests to github. What modules you see in ``windows/`` are just a start. Additional modules may be submitted as pull requests to github.
.. _windows_and_linux_control_machine:
Reminder: You Must Have a Linux Control Machine
```````````````````````````````````````````````
Note running Ansible from a Windows control machine is NOT a goal of the project. Refrain from asking for this feature,
as it limits what technologies, features, and code we can use in the main project in the future. A Linux control machine
will be required to manage Windows hosts.
Cygwin is not supported, so please do not ask questions about Ansible running from Cygwin.
.. _windows_facts: .. _windows_facts:
Windows Facts Windows Facts