geerlingguy/jjg-ansible-windows

[DEPRECATED] Windows shell provisioning script to bootstrap Ansible from within a Vagrant VM.

JJG-Ansible-Windows

Important Note: Vagrant now includes an ansible_local provisioner, which provides a much more reliable Ansible provisioning experience within a Vagrant VM. This project will no longer be updated for use beyond Vagrant 1.8.1.

Windows shell provisioning script to bootstrap Ansible from within a Vagrant VM running on Windows.

This script is configured to use configure any Linux-based VM (Debian, Ubuntu, Fedora, RedHat, CentOS, etc.) so it can run Ansible playbooks from within the VM through Vagrant.

Read more about this script, and other techniques for using Ansible within a Windows environment, on Server Check.in: Running Ansible within Windows.

Usage

In your Vagrantfile, use a conditional provisioning statement if you want to use this script (which runs Ansible from within the VM instead of on your host—this example assumes your playbook is inside within a 'provisioning' folder, and this script is within provisioning/JJG-Ansible-Windows):

# Use rbconfig to determine if we're on a windows host or not.
require 'rbconfig'
is_windows = (RbConfig::CONFIG['host_os'] =~ /mswin|mingw|cygwin/)
if is_windows
  # Provisioning configuration for shell script.
  config.vm.provision "shell" do |sh|
    sh.path = "provisioning/JJG-Ansible-Windows/windows.sh"
    sh.args = "/vagrant/provisioning/playbook.yml"
  end
else
  # Provisioning configuration for Ansible (for macOS/Linux hosts).
  config.vm.provision "ansible" do |ansible|
    ansible.playbook = "provisioning/playbook.yml"
    ansible.sudo = true
  end
end

Note that the windows.sh script will run within the VM and will run the given playbook against localhost with --connection=local inside the VM. You shouldn't/can't pass a custom inventory file to the script, as you can using Vagrant's Ansible provisioner.

Role Requirements File

If your playbook requires roles to be installed which are not present in a roles directory within the playbook's directory, then you should add the roles to a role requirements file. Place the resulting requirements.txt or requirements.yml file in the same directory as your playbook, and the roles will be installed automatically.

Licensing and More Info

Created by Jeff Geerling in 2014. Licensed under the MIT license; see the LICENSE file for more info.

jjg-ansible-windows's Issues

Passing extra-vars on sh.args

Is it possible to pass ansible variables to the playbook using JJG-Ansible-Windows?

Allow proxy settings to be passed in via Vagrantfile

When I'm using this with Vagrant in a shared environment (where some devs are on Windows, some on Mac), it's annoying to have to remember to edit the windows.sh file on some of the machines when behind a proxy, so I'd like to make it so the proxy setting (either whether to use it or not, or the proxy details themselves) can be set via an argument in the shell provisioner.

I should be able to simply use args in the Vagrantfile to pass in an argument (see: http://docs.vagrantup.com/v2/provisioning/shell.html), so this shouldn't be too difficult.

Figure out how to get vars_prompt working with windows.sh

I just realized that vars_prompt (Ansible prompts) don't work at all with windows.sh, since it's not able to get control of the terminal through the SSH connection over Vagrant correctly. An error message always results:

/usr/lib64/python2.6/getpass.py:83: GetPassWarning: Can not control echo on the terminal.
  passwd = fallback_getpass(prompt, stream)
Warning: Password input may be echoed.
Enter network username:
Warning: Password input may be echoed.
Enter network password: Traceback (most recent call last):
  File "/usr/bin/ansible-playbook", line 269, in <module>
    sys.exit(main(sys.argv[1:]))
  File "/usr/bin/ansible-playbook", line 209, in main
    pb.run()
  File "/usr/lib/python2.6/site-packages/ansible/playbook/__init__.py", line 229, in run
    play = Play(self, play_ds, play_basedir)
  File "/usr/lib/python2.6/site-packages/ansible/playbook/play.py", line 62, in __init__
    self.vars             = self._get_vars()
  File "/usr/lib/python2.6/site-packages/ansible/playbook/play.py", line 618, in _get_vars
    vname, private, prompt, encrypt, confirm, salt_size, salt, default
  File "/usr/lib/python2.6/site-packages/ansible/callbacks.py", line 653, in on_vars_prompt
    result = prompt(msg, private)
  File "/usr/lib/python2.6/site-packages/ansible/callbacks.py", line 641, in prompt
    return getpass.getpass(prompt)
  File "/usr/lib64/python2.6/getpass.py", line 83, in unix_getpass
    passwd = fallback_getpass(prompt, stream)
  File "/usr/lib64/python2.6/getpass.py", line 118, in fallback_getpass
    return _raw_input(prompt, stream)
  File "/usr/lib64/python2.6/getpass.py", line 135, in _raw_input
    raise EOFError
EOFError

fatal error: ffi.h: No such file or directory

Tested on config.vm.box = "geerlingguy/ubuntu1604"

Running setup.py bdist_wheel for cryptography: finished with status 'error'
==> default:   Complete output from command /usr/bin/python -u -c "import setuptools, tokenize;__file__='/tmp/pip-build-KiMAPG/cryptography/setup.py';exec(compile(getattr(tokenize, 'open', open)(__file__).read().replace('\r\n', '\n'), __file__, 'exec'))" bdist_wheel -d /tmp/tmp5uiFmwpip-wheel- --python-tag cp27:
==> default:   c/_cffi_backend.c:15:17: fatal error: ffi.h: No such file or directory
==> default:   compilation terminated.

You need to install the development package as well.
libffi-dev + libssl-dev on Debian/Ubuntu, libffi-devel + something for openssl dev package on Redhat/Centos/Fedora.

Problem executing windows.sh (unable to locate playbook.yml)

Hi,
I don't know if this is the proper channel for this, sorry if not.

I'm trying to make my Vagrant (which uses ansible) compatible with windows and I found your script which seems great, but I found a problem.
I set up the Vagrantfile more or less as you specified in your instruction (see below) but when I execute vagrant provision I get this error: Cannot find Ansible playbook.
I added this to the windows.sh to be able to know what file is it looking for:

# Make sure Ansible playbook exists.
if [ ! -f "$ANSIBLE_PLAYBOOK" ]; then
  echo "Cannot find Ansible playbook $ANSIBLE_PLAYBOOK"
  exit 1
fi

and what I get is ansible/playbook.yml which is correct.

My directory structure is as follow:
Vagrantfile

• /ansible/
  • playbook.yml
  • windows.sh
  • ...

# -*- mode: ruby -*-
# vi: set ft=ruby :

# All Vagrant configuration is done below. The "2" in Vagrant.configure
# configures the configuration version (we support older styles for
# backwards compatibility). Please don't change it unless you know what
# you're doing.


require 'rbconfig'
is_windows = (RbConfig::CONFIG['host_os'] =~ /mswin|mingw|cygwin/)



Vagrant.configure(2) do |config|
  config.vm.box = "ubuntu/trusty64" 

  config.vm.network "forwarded_port", guest: 80, host: 8088
  config.vm.network "private_network", ip: "192.168.56.100"

  config.vm.hostname = "development"

  config.vm.synced_folder ".", "/var/www/socialcar.dev"

  config.vm.provider :virtualbox do |vb|
    vb.customize ["modifyvm", :id, "--memory", "2048"]
  end   

  if is_windows
  # Provisioning configuration for shell script.
    config.vm.provision "shell" do |sh|
      sh.path = "ansible/windows.sh"
      sh.args = "ansible/playbook.yml"
    end
  else
    config.vm.provision :ansible do |ansible|
      ansible.playbook = "ansible/playbook.yml"
      ansible.verbose = 'vvv'
      ansible.inventory_path = "ansible/hosts"
      ansible.limit = 'all'
    end
  end
end

Make it work on Ubuntu/Debian

Right now there's a yum command, meaning this script fails on any non-RHEL machine. I'd like to make the script a bit more portable, especially so I could use it on machines like my drupal-dev-vm.

Remove custom inventory file requirement

Since running the playbook with --connection=local in this situation implies everything should be run on localhost regardless, let's drop the requirement to pass in an inventory file. Rather, if we pass the command line option all -i 'localhost,', Ansible should attempt to run the playbook on localhost only.

Install roles from Ansible requirements file

Since not every playbook includes all it's roles within the playbook roles directory, it would be nice if we could automatically install all the roles in a playbook's requirements.txt or requirements.yml file, if present.

Pip installation does not work on Ubuntu 16.04

I tried running the script on Ubuntu 16.04 but it fails when using the pip command. I noticed I had an outdated base box so updating it to see if anything changes.

==> drupalvm: Installing required python modules.
==> drupalvm: Traceback (most recent call last):
==> drupalvm:   File "/usr/local/bin/pip", line 5, in <module>
==> drupalvm:     from pkg_resources import load_entry_point
==> drupalvm: ImportError: No module named pkg_resources
==> drupalvm: Installing Ansible.
==> drupalvm: Traceback (most recent call last):
==> drupalvm:   File "/usr/local/bin/pip", line 5, in <module>
==> drupalvm:
==> drupalvm: from pkg_resources import load_entry_point
==> drupalvm: ImportError
==> drupalvm: :
==> drupalvm: No module named pkg_resources

Install requirements with --force to match Vagrant ansible_local behavior

...this would also fix issues like geerlingguy/drupal-vm#594

pip installation method

Please check these changes:

echo "Installing pip via easy_install."
wget https://raw.githubusercontent.com/ActiveState/ez_setup/v0.9/ez_setup.py
python ez_setup.py && rm -f ez_setup.py
easy_install pip

# Make sure setuptools are installed crrectly.
pip install setuptools --no-use-wheel --upgrade

Change to:

echo "Installing pip."
wget https://bootstrap.pypa.io/get-pip.py
python get-pip.py && rm -f get-pip.py

It will fix Ubuntu errors (14.04, 15.10), but I haven't tested it on other Linux distributions.

We still need this fix because ansible_local is broken for Windows hosts.

Move ez_setup.py into repository for security

This script currently pulls down the file ez_setup.py from:

http://peak.telecommunity.com/dist/ez_setup.py

This link is not available over SSL. It would be more secure to host it here and download it over HTTPS from GitHub.

Pass along 'is_windows' variable

In order to allow plays to be run conditionally when running inside a windows VM, I'd like to add an 'is_windows' variable via CLI argument (for Mac/Linux, you can use ansible.extra_vars via Vagrantfile).

Allow Ansible raw_arguments to be passed in via Vagrantfile

I've seen some times when it would be helpful to accept raw arguments for ansible (like -vvvv) straight from the Vagrantfile, so users don't have to modify windows.sh to change the way ansible-playbook is called.

Add `--ignore-errors` to requirements installation

I wish that Ansible wouldn't error out on requirements installation if a role already exists, but it does... so the simplest solution in case a provision was bailed halfway through and only some roles were installed (or if you have new roles in the requirements file) is to add --ignore-errors. --force is too heavy-handed for my liking.

/

Missing apt-get update

Hi,

On various vagrant boxes, "apt-get install" fails because cache apt is too old. You should add "apt-get update" before "apt-get install".

Cheers!

Emilien

r

Cygwin SSH is failing with mux_client_request_session: read from master failed: Connection reset by peer

I was following the guide on https://servercheck.in/blog/running-ansible-within-windows.

I may have misunderstood what was meant by "if you would like to use Ansible as a provisioner for Vagrant..." I thought that meant standing up a Vagrant guest OS. I was starting my own Vagrant guest, so I didn't think this applied to me. I thought the only hurdle I was running into was that the line endings were CRLF rather than just LF. I changed that in Git. I can SSH into the Vagrant guest, so I was surprised when running the playbook failed. Turning on verbose logging -vvvv the error looks different than what you were describing in the blog post:

$ ansible-playbook -vvvv <playbook.yml> -i host_inventories/hosts.yml --tags "" --private-key=/cygdrive/c/Users//.vagrant.d/insecure_private_key -u vagrant

PLAY [Deploy Services] ***********************************************

GATHERING FACTS ***************************************************************
<127.0.0.1> ESTABLISH CONNECTION FOR USER: vagrant
<127.0.0.1> REMOTE_MODULE setup
<127.0.0.1> EXEC ['ssh', '-C', '-tt', '-vvv', '-o', 'ControlMaster=auto', '-o', 'ControlPersist=60s', '-o', 'ControlPath=/home//.ansible/cp/ansible-ssh-%h-%p-%r', '-o', 'Port=2222', '-o', 'IdentityFile=/cygdrive/c/Users//.vagrant.d/insecure_private_key', '-o', 'KbdInteractiveAuthentication=no', '-o', 'PreferredAuthentications=gssapi-with-mic,gssapi-keyex,hostbased,publickey', '-o', 'PasswordAuthentication=no', '-o', 'User=vagrant', '-o', 'ConnectTimeout=10', '127.0.0.1', "/bin/sh -c 'mkdir -p /tmp/ansible-tmp-1395190782.76-199795475576977 && chmod a+rx /tmp/ansible-tmp-1395190782.76-199795475576977 && echo /tmp/ansible-tmp-1395190782.76-199795475576977'"]
fatal: [localhost] => SSH encountered an unknown error. The output was:
OpenSSH_6.5, OpenSSL 1.0.1f 6 Jan 2014
debug1: auto-mux: Trying existing master
debug1: Control socket "/home//.ansible/cp/ansible-ssh-127.0.0.1-2222-vagrant" does not exist
debug2: ssh_connect: needpriv 0
debug1: Connecting to 127.0.0.1 [127.0.0.1] port 2222.
debug2: fd 3 setting O_NONBLOCK
debug1: fd 3 clearing O_NONBLOCK
debug1: Connection established.
debug3: timeout: 10000 ms remain after connect
debug3: Incorrect RSA1 identifier
debug3: Could not load "/cygdrive/c/Users//.vagrant.d/insecure_private_key" as a RSA1 public key
debug1: identity file /cygdrive/c/Users//.vagrant.d/insecure_private_key type -1
debug1: identity file /cygdrive/c/Users//.vagrant.d/insecure_private_key-cert type -1
debug1: Enabling compatibility mode for protocol 2.0
debug1: Local version string SSH-2.0-OpenSSH_6.5
debug1: Remote protocol version 2.0, remote software version OpenSSH_5.9p1 Debian-5ubuntu1
debug1: match: OpenSSH_5.9p1 Debian-5ubuntu1 pat OpenSSH_5* compat 0x0c000000
debug2: fd 3 setting O_NONBLOCK
debug3: put_host_port: [127.0.0.1]:2222
debug3: load_hostkeys: loading entries for host "[127.0.0.1]:2222" from file "/home//.ssh/known_hosts"
debug3: load_hostkeys: found key type ECDSA in file /home//.ssh/known_hosts:2
debug3: load_hostkeys: loaded 1 keys
debug3: order_hostkeyalgs: prefer hostkeyalgs: [email protected],[email protected],[email protected],ecdsa-sha2-nistp256,ecdsa-sha2-nistp384,ecdsa-sha2-nistp521
debug1: SSH2_MSG_KEXINIT sent
debug1: SSH2_MSG_KEXINIT received
debug2: kex_parse_kexinit: [email protected],ecdh-sha2-nistp256,ecdh-sha2-nistp384,ecdh-sha2-nistp521,diffie-hellman-group-exchange-sha256,diffie-hellman-group-exchange-sha1,diffie-hellman-group14-sha1,diffie-hellman-group1-sha1
debug2: kex_parse_kexinit: [email protected],[email protected],[email protected],ecdsa-sha2-nistp256,ecdsa-sha2-nistp384,ecdsa-sha2-nistp521,[email protected],[email protected],[email protected],[email protected],[email protected],ssh-ed25519,ssh-rsa,ssh-dss
debug2: kex_parse_kexinit: aes128-ctr,aes192-ctr,aes256-ctr,arcfour256,arcfour128,[email protected],[email protected],[email protected],aes128-cbc,3des-cbc,blowfish-cbc,cast128-cbc,aes192-cbc,aes256-cbc,arcfour,[email protected]
debug2: kex_parse_kexinit: aes128-ctr,aes192-ctr,aes256-ctr,arcfour256,arcfour128,[email protected],[email protected],[email protected],aes128-cbc,3des-cbc,blowfish-cbc,cast128-cbc,aes192-cbc,aes256-cbc,arcfour,[email protected]
debug2: kex_parse_kexinit: [email protected],[email protected],[email protected],[email protected],[email protected],[email protected],[email protected],[email protected],[email protected],hmac-md5,hmac-sha1,[email protected],[email protected],hmac-sha2-256,hmac-sha2-512,hmac-ripemd160,[email protected],hmac-sha1-96,hmac-md5-96
debug2: kex_parse_kexinit: [email protected],[email protected],[email protected],[email protected],[email protected],[email protected],[email protected],[email protected],[email protected],hmac-md5,hmac-sha1,[email protected],[email protected],hmac-sha2-256,hmac-sha2-512,hmac-ripemd160,[email protected],hmac-sha1-96,hmac-md5-96
debug2: kex_parse_kexinit: [email protected],zlib,none
debug2: kex_parse_kexinit: [email protected],zlib,none
debug2: kex_parse_kexinit:
debug2: kex_parse_kexinit:
debug2: kex_parse_kexinit: first_kex_follows 0
debug2: kex_parse_kexinit: reserved 0
debug2: kex_parse_kexinit: ecdh-sha2-nistp256,ecdh-sha2-nistp384,ecdh-sha2-nistp521,diffie-hellman-group-exchange-sha256,diffie-hellman-group-exchange-sha1,diffie-hellman-group14-sha1,diffie-hellman-group1-sha1
debug2: kex_parse_kexinit: ssh-rsa,ssh-dss,ecdsa-sha2-nistp256
debug2: kex_parse_kexinit: aes128-ctr,aes192-ctr,aes256-ctr,arcfour256,arcfour128,aes128-cbc,3des-cbc,blowfish-cbc,cast128-cbc,aes192-cbc,aes256-cbc,arcfour,[email protected]
debug2: kex_parse_kexinit: aes128-ctr,aes192-ctr,aes256-ctr,arcfour256,arcfour128,aes128-cbc,3des-cbc,blowfish-cbc,cast128-cbc,aes192-cbc,aes256-cbc,arcfour,[email protected]
debug2: kex_parse_kexinit: hmac-md5,hmac-sha1,[email protected],hmac-sha2-256,hmac-sha2-256-96,hmac-sha2-512,hmac-sha2-512-96,hmac-ripemd160,[email protected],hmac-sha1-96,hmac-md5-96
debug2: kex_parse_kexinit: hmac-md5,hmac-sha1,[email protected],hmac-sha2-256,hmac-sha2-256-96,hmac-sha2-512,hmac-sha2-512-96,hmac-ripemd160,[email protected],hmac-sha1-96,hmac-md5-96
debug2: kex_parse_kexinit: none,[email protected]
debug2: kex_parse_kexinit: none,[email protected]
debug2: kex_parse_kexinit:
debug2: kex_parse_kexinit:
debug2: kex_parse_kexinit: first_kex_follows 0
debug2: kex_parse_kexinit: reserved 0
debug2: mac_setup: found hmac-md5
debug1: kex: server->client aes128-ctr hmac-md5 [email protected]
debug2: mac_setup: found hmac-md5
debug1: kex: client->server aes128-ctr hmac-md5 [email protected]
debug1: sending SSH2_MSG_KEX_ECDH_INIT
debug1: expecting SSH2_MSG_KEX_ECDH_REPLY
debug1: Server host key: ECDSA XX:XX:XX:XX:XX:XX:XX:XX:XX:XX:XX:XX:XX:XX:XX:XX
debug3: put_host_port: [127.0.0.1]:2222
debug3: put_host_port: [127.0.0.1]:2222
debug3: load_hostkeys: loading entries for host "[127.0.0.1]:2222" from file "/home//.ssh/known_hosts"
debug3: load_hostkeys: found key type ECDSA in file /home//.ssh/known_hosts:2
debug3: load_hostkeys: loaded 1 keys
debug1: Host '[127.0.0.1]:2222' is known and matches the ECDSA host key.
debug1: Found key in /home//.ssh/known_hosts:2
debug1: ssh_ecdsa_verify: signature correct
debug2: kex_derive_keys
debug2: set_newkeys: mode 1
debug1: SSH2_MSG_NEWKEYS sent
debug1: expecting SSH2_MSG_NEWKEYS
debug2: set_newkeys: mode 0
debug1: SSH2_MSG_NEWKEYS received
debug1: Roaming not allowed by server
debug1: SSH2_MSG_SERVICE_REQUEST sent
debug2: service_accept: ssh-userauth
debug1: SSH2_MSG_SERVICE_ACCEPT received
debug2: key: /cygdrive/c/Users//.vagrant.d/insecure_private_key (0x0), explicit
debug1: Authentications that can continue: publickey,password
debug3: start over, passed a different list publickey,password
debug3: preferred gssapi-with-mic,gssapi-keyex,hostbased,publickey
debug3: authmethod_lookup publickey
debug3: remaining preferred: ,gssapi-keyex,hostbased,publickey
debug3: authmethod_is_enabled publickey
debug1: Next authentication method: publickey
debug1: Trying private key: /cygdrive/c/Users//.vagrant.d/insecure_private_key
debug1: key_parse_private2: missing begin marker
debug1: read PEM private key done: type RSA
debug3: sign_and_send_pubkey: RSA xx:xx:xx:xx:xx:xx:xx:xx:xx:xx:xx:xx:xx:xx:xx:xx
debug2: we sent a publickey packet, wait for reply
debug1: Enabling compression at level 6.
debug1: Authentication succeeded (publickey).
Authenticated to 127.0.0.1 ([127.0.0.1]:2222).
debug1: setting up multiplex master socket
debug3: muxserver_listen: temporary control path /home//.ansible/cp/ansible-ssh-127.0.0.1-2222-vagrant.q4roHdSf4LGT5CHm
debug2: fd 4 setting O_NONBLOCK
debug3: fd 4 is O_NONBLOCK
debug3: fd 4 is O_NONBLOCK
debug1: channel 0: new [/home/beesleyr/.ansible/cp/ansible-ssh-127.0.0.1-2222-vagrant]
debug3: muxserver_listen: mux listener channel 0 fd 4
debug2: fd 3 setting TCP_NODELAY
debug3: packet_set_tos: set IP_TOS 0x08
debug1: control_persist_detach: backgrounding master process
debug2: control_persist_detach: background process is 13356
debug1: forking to background
debug1: Entering interactive session.
debug2: set_control_persist_exit_time: schedule exit in 60 seconds
debug1: multiplexing control connection
debug3: fd 5 is O_NONBLOCK
debug2: fd 4 setting O_NONBLOCK
debug3: fd 5 is O_NONBLOCK
debug1: channel 1: new [mux-control]
debug3: channel_post_mux_listener: new mux channel 1 fd 5
debug3: mux_master_read_cb: channel 1: hello sent
debug2: set_control_persist_exit_time: cancel scheduled exit
debug3: mux_master_read_cb: channel 1 packet type 0x00000001 len 4
debug2: process_mux_master_hello: channel 1 slave version 4
debug2: mux_client_hello_exchange: master version 4
debug3: mux_client_forwards: request forwardings: 0 local, 0 remote
debug3: mux_client_request_session: entering
debug3: mux_client_request_alive: entering
debug3: mux_master_read_cb: channel 1 packet type 0x10000004 len 4
debug2: process_mux_alive_check: channel 1: alive check
debug3: mux_client_request_alive: done pid = 14104
debug3: mux_master_read_cb: channel 1 packet type 0x10000002 len 225
debug2: process_mux_new_session: channel 1: request tty 1, X 0, agent 0, subsys 0, term "xterm", cmd "/bin/sh -c 'mkdir -p /tmp/ansible-tmp-1395190782.76-199795475576977 && chmod a+rx /tmp/ansible-tmp-1395190782.76-199795475576977 && echo /tmp/ansible-tmp-1395190782.76-199795475576977'", env 0
debug3: mux_client_request_session: session request sent
mm_receive_fd: no message header
process_mux_new_session: failed to receive fd 0 from slave
debug1: channel 1: mux_rcb failed
debug2: channel 1: zombie
debug2: channel 1: gc: notify user
debug3: mux_master_control_cleanup_cb: entering for channel 1
debug2: channel 1: gc: user detached
debug2: channel 1: zombie
debug2: channel 1: garbage collecting
debug1: channel 1: free: mux-control, nchannels 2
debug3: channel 1: status: The following connections are open:

mux_client_request_session: read from master failed: Connection reset by peer
Failed to connect to new control master
debug2: set_control_persist_exit_time: schedule exit in 60 seconds

TASK: [stop-services] *******************************************
FATAL: no hosts matched or all hosts have already failed -- aborting

PLAY RECAP ********************************************************************
to retry, use: --limit @/home//playbook.retry

localhost : ok=0 changed=0 unreachable=1 failed=0