Windows support! #69

judy-zz · 2017-05-17T17:42:51Z

I wrote full Windows support for this role. I tried to match the programming style and Ansible best practices as closely as possible. I'm still new to Ansible, and would happily accept any feedback.

There are a LOT of additions, and more than a handful of changes, mostly ansible_os_system checks. I'll comment in the code diff where there might be points of confusion between how Linux does things and how Windows does them.

This role supports Consul 0.8.3 but still installs 0.8.2 by accident. This has been remedied.

judy-zz · 2017-05-17T17:45:34Z

README.md

@@ -86,37 +85,44 @@ the variables are named and described below:
 ### `consul_bin_path`

 - Binary installation path
- Default value: `/usr/local/bin`
+- Default linux value: `/usr/local/bin`
+- Default windows value: `C:\ProgramData\consul\bin`


I've used C:\ProgramData\consul for all necessary program data, including the consul.exe binary. Most Windows programs use the magical %APPDATA% path, but those are tied to specific users. My understanding is that C:\ProgramData is what Chocolatey and NSSM use, and it's a good place for system-level services.

judy-zz · 2017-05-17T17:46:15Z

README.md


 ### `consul_user`

 - OS user
- Default value: *consul*
+- Default linux value: *consul*
+- Default linux value: *LocalSystem*


Windows convention is to have the LocalSystem user run services. It has the right mix of permissions for those kinds of services.

judy-zz · 2017-05-17T17:48:23Z

defaults/main.yml

@@ -5,20 +5,26 @@
 consul_debug: no

 ### Package
-consul_version: "{{ lookup('env','CONSUL_VERSION') | default('0.8.2', true) }}"
+consul_version: "{{ lookup('env','CONSUL_VERSION') | default('0.8.3', true) }}"


The last commit on the upstream repo updates the project to support Consul 0.8.3, but the default installation still downloads 0.8.2. This is an unrelated bug fix, but will probably just disappear if fixed upstream, correct?

judy-zz · 2017-05-17T17:49:23Z

defaults/main.yml

 consul_architecture_map:
  # this first entry seems... redundant
  #(but it's required for reasons)
  amd64: amd64
  x86_64: amd64
  armv7l: arm
  aarch64: arm64
+  32-bit: "386"


I don't know if there are even Windows Server versions that run in 32-bit, but there are personal versions of Windows that do, and this entry ensures the right package is grabbed from Hashicorp.

judy-zz · 2017-05-17T17:50:43Z

defaults/main.yml

+  {% if ansible_os_family == "Windows" %}\
+    {{ 'windows' }}\
+  {% else %}\
+    {{ ansible_system | lower }}\


ansible_system in these cases returns Win32NT. This changes between Windows Server versions and is unfortunately brittle.

judy-zz · 2017-05-17T17:51:14Z

defaults/main.yml

@@ -27,6 +33,7 @@ consul_install_remotely: false
 consul_bin_path: "/usr/local/bin"
 consul_config_path: "/etc/consul"
 consul_configd_path: "/etc/consul.d"
+consul_bootstrap_state: "/etc/consul/.consul_bootstrapped"


Bootstrap state is another path I needed to change for Windows, and consolidating it with the other paths seemed to be the smart choice.

judy-zz · 2017-05-17T17:52:26Z

defaults/main.yml

-consul_iface: "{{ lookup('env','CONSUL_IFACE') | default(ansible_default_ipv4.interface, true) }}"
+consul_iface: "\
+  {% if ansible_os_family == "Windows" %}\
+    {{ lookup('env','CONSUL_IFACE') | default(ansible_interfaces[0].interface_name, true) }}\


Network interfaces in Windows are handled very differently in Ansible, with very little overlap. I'm not sure why. But this works.

judy-zz · 2017-05-17T17:53:37Z

handlers/main.yml

-  service:
-    name: consul
-    state: restarted
+  include: restart_consul.yml


Having OS-contextual handlers is awkward. I attempted to do this with ansible blocks but they're unsupported. This is clunkier than ideal, but is the best option I could find that works.

judy-zz · 2017-05-17T17:57:48Z

tasks/install_windows.yml

+    path: /tmp/consul
+    state: directory
+
+- name: Verify TLS1.2 is used


Windows attempts to use TLS1.0 by default when downloading files, falling back to SSL3, and never trying TLS1.2. This is fixed in later versions of Windows.

This task sets a typical value in the registry just in case it isn't there, ensuring that TLS1.2 is tried first, then TLS1.0, then SSL3. Otherwise, downloading the package and checksum files outright fails because you haven't changed the registry variable. ¯_(ツ)_/¯

judy-zz · 2017-05-17T17:59:51Z

tasks/install_windows.yml

+  when: not consul_checksum.stat.exists | bool
+
+- name: Read Consul package checksum
+  win_shell: "findstr {{ consul_pkg }} /tmp/consul/consul_{{ consul_version }}_SHA256SUMS"


findstr is to Windows as grep is to Linux.

judy-zz · 2017-05-17T18:02:08Z

tasks/install_windows.yml

+    dest: "/tmp/consul/{{ consul_pkg }}"
+  tags: installation
+
+- name: Calculate checksum


These next two tasks are done different from the usual path, because win_get_url doesn't allow checksums like get_url does. Minor inconsistency we have to handle by hand here.

judy-zz · 2017-05-17T18:05:13Z

tasks/main.yml

+  include: config_windows.yml
+  when: ansible_os_family == 'Windows'
+
+- name: Ensure neither ACL nor TLS are requested for windows hosts


Small safety check. I haven't updated the ACL or TLS code, so in the meanwhile their support is turned off for Windows hosts. This can be added later.

judy-zz · 2017-05-17T18:05:33Z

tasks/main.yml

@@ -157,10 +200,12 @@
      group: root
      mode: 0755
    when:
+      - ansible_service_mgr is defined


ansible_service_mgr is undefined on Windows.

judy-zz · 2017-05-17T18:06:55Z

tasks/main.yml

+      state: latest
+
+  - name: Start Consul on Windows
+    win_nssm:


NSSM is used to wrap consul.exe into a Windows-friendly service. Without it we can't use the regular win_service module because services don't let you set configuration variables.

judy-zz · 2017-05-17T18:08:35Z

tasks/main.yml


  - name: Check Consul HTTP API
    wait_for:
      delay: 15
      port: 8500
+    when: ansible_os_family != "Windows"
+
+  - name: Check Consul HTTP API


There's no win_wait_for module yet. This is a hack to use wait_for locally and watch the port in the same way. It works on my machine perfectly, but I can see cases where this could potentially fail depending on network setup. It may need more work in the future.

judy-zz · 2017-05-17T18:11:16Z

vars/Windows.yml

+# File: Windows.yml - Windows OS variables for Consul
+
+# paths
+consul_windows_path: /ProgramData/consul


Fun fact: forward slashes now work almost as well as backslashes do in Windows! Folder structure is still different though.

brianshumate · 2017-05-22T16:08:03Z

Thanks very much for this contribution!

groggemans · 2017-05-22T16:12:36Z

tasks/main.yml

+  - name: Install NSSM
+    win_chocolatey:
+      name: nssm
+      state: latest


@judy @brianshumate Shouldn't there be a when clause here checking for os_family == "Windows"?
(Didn't test)

gmarkey · 2017-05-23T04:28:25Z

Heads up; the "when" clauses are breaking anything that registers objects in the output (e.g. stat) as the condition failure is being stored in register and forcibly casting as a dict.

Might just be an ordering problem; it's likely best to encapsulate the Windows & non-Windows stuff inside a block.

brianshumate · 2017-05-23T15:44:54Z

Yeah... missed that stuff, sorry!

I have committed a quick change that puts all non-Windows and Windows main tasks in separate top-level blocks. Not the ideal solution, but it unbreaks the role for the moment. This is released in v1.20.1 also.

judy-zz · 2017-05-23T17:32:47Z

I was trying this earlier but wasn't formatting my blocks correctly. I see how you did it now. This is much cleaner!

brianshumate · 2017-05-23T18:10:02Z

👍

judy-zz added 3 commits May 17, 2017 11:55

Add Windows support.

77eba47

Add documentation to Windows versions.

dcc9e99

Install 0.8.3 by default.

9761dbc

This role supports Consul 0.8.3 but still installs 0.8.2 by accident. This has been remedied.

judy-zz commented May 17, 2017

View reviewed changes

Fix syntax hangup on TravisCI.

aa1d208

brianshumate merged commit 7b83474 into ansible-collections:master May 22, 2017

groggemans reviewed May 22, 2017

View reviewed changes

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Windows support! #69

Windows support! #69

judy-zz commented May 17, 2017

judy-zz May 17, 2017

judy-zz May 17, 2017

judy-zz May 17, 2017

judy-zz May 17, 2017

judy-zz May 17, 2017

judy-zz May 17, 2017

judy-zz May 17, 2017

judy-zz May 17, 2017

judy-zz May 17, 2017 •

edited

Loading

judy-zz May 17, 2017

judy-zz May 17, 2017

judy-zz May 17, 2017

judy-zz May 17, 2017

judy-zz May 17, 2017

judy-zz May 17, 2017

judy-zz May 17, 2017

brianshumate commented May 22, 2017

groggemans May 22, 2017

gmarkey commented May 23, 2017 •

edited

Loading

brianshumate commented May 23, 2017

judy-zz commented May 23, 2017

brianshumate commented May 23, 2017

Windows support! #69

Windows support! #69

Conversation

judy-zz commented May 17, 2017

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

judy-zz May 17, 2017 • edited Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

brianshumate commented May 22, 2017

Choose a reason for hiding this comment

gmarkey commented May 23, 2017 • edited Loading

brianshumate commented May 23, 2017

judy-zz commented May 23, 2017

brianshumate commented May 23, 2017

judy-zz May 17, 2017 •

edited

Loading

gmarkey commented May 23, 2017 •

edited

Loading