Cloud 1469 (#46)

* adding in tasks for swarm token

* adding in tasks and plans for swarm token

* adding in tasks for docker swarm

* updates for tasks

Author: davejrt

README.md

@@ -1085,6 +1085,58 @@ Auto pool extension threshold (in % of pool size).
 
 Extends the pool by the specified percentage when the threshold is passed.
 
+### Tasks
+
+The docker module has an example task that allows a user to initialize, join and leave a swarm.
+
+```puppet
+bolt task run docker::swarm_init listen_addr=172.17.10.101 adverstise_addr=172.17.10.101 ---nodes swarm-master --user <user> --password <password> --modulepath <module_path>
+
+docker swarm init --advertise-addr=172.17.10.101 --listen-addr=172.17.10.101
+Swarm initialized: current node (w8syk0g286vd7d9kwzt7jl44z) is now a manager.
+
+To add a worker to this swarm, run the following command:
+
+    docker swarm join --token SWMTKN-1-317gw63odq6w1foaw0xkibzqy34lga55aa5nbjlqekcrhg8utl-08vrg0913zken8h9vfo4t6k0t 172.17.10.101:2377
+
+To add a manager to this swarm, run 'docker swarm join-token manager' and follow the instructions.
+
+
+Ran on 1 node in 4.04 seconds
+```
+
+```puppet
+bolt task run docker::swarm_token node_role=worker ---nodes swarm-master --user <user> --password <password> --modulepath <module_path>
+
+SWMTKN-1-317gw63odq6w1foaw0xkibzqy34lga55aa5nbjlqekcrhg8utl-08vrg0913zken8h9vfo4t6k0t
+
+
+Ran on 1 node in 4.02 seconds
+
+```
+```puppet
+bolt task run docker::swarm_join listen_addr=172.17.10.102 adverstise_addr=172.17.10.102 token=<swarm_token> manager_ip=172.17.10.101:2377 --nodes swarm-02 --user root --password puppet --modulepath /tmp/modules
+
+
+This node joined a swarm as a worker.
+
+
+Ran on 1 node in 4.68 seconds
+```
+```puppet
+bolt task run docker::swarm_leave --nodes swarm-02 --user root --password puppet --modulepath --modulepath <module_path>
+
+Node left the swarm.
+
+
+Ran on 1 node in 6.16 seconds
+```
+
+
+
+
+For further explanation please refer to the[PE documentation](https://puppet.com/docs/pe/2017.3/orchestrator/running_tasks.html) or [Bolt documentation](https://puppet.com/docs/bolt/latest/bolt.html) on how to execute a task.
+
 ## Limitations
 
 This module supports:

tasks/swarm_init.json

@@ -0,0 +1,43 @@
+
+{
+  "description": "Initializes a swarm",
+  "input_method": "stdin",
+  "parameters": {
+    "adveritse_addr": {
+      "description": "Advertised address",
+      "type": "Optional[String[1]]"
+    },
+    "autolock": {
+      "description": "Enable manager autolocking",
+      "type": "Optional[Boolean[1]]"
+    },
+    "cert_expiry": {
+      "description": "Validity period for node certificates",
+      "type": "Optional[String[1]]"
+    },
+    "dispatcher_heartbeat": {
+      "description": "Dispatcher heartbeat period",
+      "type": "Optional[String[1]]"
+    },
+    "external_ca": {
+      "description": "Specifications of one or more certificate signing endpoints",
+      "type": "Optional[String[1]]"
+    },
+    "force_new_cluster": {
+      "description": "Force create a new cluster from current state",
+      "type": "Optional[Boolean[1]]"
+    },
+    "listen_addr": {
+      "description": "Listen address",
+      "type": "Optional[String[1]]"
+    },
+    "max_snapshots": {
+      "description": "Number of additional Raft snapshots to retain",
+      "type": "Optional[Integer[1]]"
+    },
+    "snapshot_interval": {
+      "description": "Number of log entries between Raft snapshots",
+      "type": "Optional[Integer[1]]"
+    }
+  }
+}

tasks/swarm_init.rb

@@ -0,0 +1,41 @@
+#!/opt/puppetlabs/puppet/bin/ruby
+require 'json'
+require 'open3'
+require 'puppet'
+
+def swarm_init(advertise_addr, autolock, cert_expiry, dispatcher_heartbeat, external_ca, force_new_cluster, listen_addr, max_snapshots, snapshot_interval)
+  cmd_string = "docker swarm init"
+  cmd_string << " --advertise-addr=#{advertise_addr}" unless advertise_addr.nil?
+  cmd_string << " --autolock" unless autolock.nil?
+  cmd_string << " --cert-expiry" unless cert_expiry.nil?
+  cmd_string << " --dispatcher-heartbeat=#{dispatcher_heartbeat}" unless dispatcher_heartbeat.nil?
+  cmd_string << " --external-ca=#{external_ca}" unless external_ca.nil?
+  cmd_string << " --force-new-cluster" unless force_new_cluster.nil?
+  cmd_string << " --listen-addr=#{listen_addr}" unless listen_addr.nil?
+  cmd_string << " --max-snapshots=#{max_snapshots}" unless max_snapshots.nil?
+  cmd_string << " --snapshot-interval=#{snapshot_interval}" unless snapshot_interval.nil?
+
+  stdout, stderr, status = Open3.capture3(cmd_string)
+  raise Puppet::Error, ("stderr: '#{stderr}'") if status != 0
+  stdout.strip
+end
+
+params = JSON.parse(STDIN.read)
+advertise_addr = params['advertise_addr']
+autolock = params['autolock']
+cert_expiry = params['cert_expiry']
+dispatcher_heartbeat = params['dispatcher_heartbeat']
+external_ca = params['external_ca']
+force_new_cluster = params['force_new_cluster']
+listen_addr = params['listen_addr']
+max_snapshots = params['max_snapshots']
+snapshot_interval = params['snapshot_interval']
+
+begin
+  result = swarm_init(advertise_addr, autolock, cert_expiry, dispatcher_heartbeat, external_ca, force_new_cluster, listen_addr, max_snapshots, snapshot_interval)
+  puts result
+  exit 0
+rescue Puppet::Error => e
+  puts({ status: 'failure', error: e.message })
+  exit 1
+end

tasks/swarm_join.json

@@ -0,0 +1,23 @@
+
+{
+  "description": "Join a swarm",
+  "input_method": "stdin",
+  "parameters": {
+    "adveritse_addr": {
+      "description": "Advertised address",
+      "type": "Optional[String[1]]"
+    },
+    "listen_addr": {
+      "description": "Listen address",
+      "type": "Optional[String[1]]"
+    },
+    "token": {
+      "description": "Join token for the swarm",
+      "type": "String[1]"
+    },
+    "manager_ip": {
+      "description": "IP Address of the swarm manager",
+      "type": "String[1]"
+    }
+  }
+}

tasks/swarm_join.rb

@@ -0,0 +1,32 @@
+#!/opt/puppetlabs/puppet/bin/ruby
+require 'json'
+require 'open3'
+require 'puppet'
+
+def swarm_join(advertise_addr, listen_addr, token, manager_ip)
+  cmd_string = "docker swarm join"
+  cmd_string << " --advertise-addr=#{advertise_addr}" unless advertise_addr.nil?
+  cmd_string << " --listen-addr=#{listen_addr}" unless listen_addr.nil?
+  cmd_string << " --token=#{token}" unless token.nil?
+  cmd_string << " #{manager_ip}" unless manager_ip.nil?
+
+
+  stdout, stderr, status = Open3.capture3(cmd_string)
+  raise Puppet::Error, ("stderr: '#{stderr}'") if status != 0
+  stdout.strip
+end
+
+params = JSON.parse(STDIN.read)
+advertise_addr = params['advertise_addr']
+listen_addr = params['listen_addr']
+token = params['token']
+manager_ip = params['manager_ip']
+
+begin
+  result = swarm_join(advertise_addr, listen_addr, token, manager_ip)
+  puts result
+  exit 0
+rescue Puppet::Error => e
+  puts({ status: 'failure', error: e.message })
+  exit 1
+end

tasks/swarm_leave.json

@@ -0,0 +1,11 @@
+
+{
+  "description": "Leave a swarm",
+  "input_method": "stdin",
+  "parameters": {
+    "force": {
+      "description": "Force this node to leave the swarm, ignoring warnings",
+      "type": "Optional[Boolean[1]]"
+    }
+  }
+}

tasks/swarm_leave.rb

@@ -0,0 +1,23 @@
+#!/opt/puppetlabs/puppet/bin/ruby
+require 'json'
+require 'open3'
+require 'puppet'
+
+def swarm_leave(force)
+  cmd_string = "docker swarm leave "
+  cmd_string << " -f" if force == "true"
+  stdout, stderr, status = Open3.capture3(cmd_string)
+  raise Puppet::Error, ("stderr: '#{stderr}'") if status != 0
+  stdout.strip
+end
+
+params = JSON.parse(STDIN.read)
+force = params['force']
+begin
+  result = swarm_leave(force)
+  puts result
+  exit 0
+rescue Puppet::Error => e
+  puts({ status: 'failure', error: e.message })
+  exit 1
+end

tasks/swarm_token.json

@@ -0,0 +1,11 @@
+
+{
+  "description": "Gets the swarm token from the master",
+  "input_method": "stdin",
+  "parameters": {
+    "node_role": {
+      "description": "The role of the node joining the swarm",
+      "type": "String[1]"
+    }
+  }
+}

tasks/swarm_token.rb

@@ -0,0 +1,25 @@
+#!/opt/puppetlabs/puppet/bin/ruby
+require 'json'
+require 'open3'
+require 'puppet'
+
+def swarm_token(node_role)
+  cmd_string = "docker swarm join-token -q"
+  cmd_string << " #{node_role}" unless node_role.nil?
+
+  stdout, stderr, status = Open3.capture3(cmd_string)
+  raise Puppet::Error, ("stderr: '#{stderr}'") if status != 0
+  stdout.strip
+end
+
+params = JSON.parse(STDIN.read)
+node_role = params['node_role']
+
+begin
+  result = swarm_token(node_role)
+  puts result
+  exit 0
+rescue Puppet::Error => e
+  puts({ status: 'failure', error: e.message })
+  exit 1
+end