Align actions to Consul API, add 9 new actions, unmask consul metadata for some actions.

Author: nzlosh

CHANGES.md

@@ -1,5 +1,33 @@
 # Change Log
 
+## [0.6.0] 16 Nov 2017
+
+### Added the following API calls. (See https://python-consul.readthedocs.io for documentation)
+    - AgentChecks
+    - AgentForce
+    - AgentJoin
+    - AgentMaintenance
+    - AgentMembers
+    - AgentServices
+    - EventFire
+    - EventList
+    - HealthNode
+    - HealthState
+    - ServiceDeregister
+    - ServiceMaintenance
+    - ServiceRegister
+    - SessionCreate
+    - SessionDestroy
+    - SessionInfo
+    - SessionList
+    - SessionNode
+    - SessionRenew
+### Changed
+ - Renamed existing action names to be aligned with the consul API.  This helps logically group
+   operations by the subsystem they will apply to.
+ - Returned unmodified data from Consul API from some existing actions.  Some of the existing actions
+   were masking the metadata returned by the consul API.  This metadata is useful in certain cases.
+
 ## 0.5.0
 
 - Updated action `runner_type` from `run-python` to `python-script`

actions/acl_create.py

@@ -5,5 +5,4 @@ class ConsulAclCreateAction(action.ConsulBaseAction):
     def run(self, name=None, acl_type='client', rules=None):
 
         rules = rules.encode('ascii', 'ignore')
-        acl_id = self.consul.acl.create(name=name, type=acl_type, rules=rules)
-        return acl_id
+        return (True, self.consul.acl.create(name=name, type=acl_type, rules=rules))

actions/acl_destroy.py

@@ -3,6 +3,4 @@
 
 class ConsulAclDestroyAction(action.ConsulBaseAction):
     def run(self, acl_id):
-
-        resp = self.consul.acl.destroy(acl_id)
-        return resp
+        return (True, self.consul.acl.destroy(acl_id))

actions/acl_list.py

@@ -5,6 +5,4 @@
 
 class ConsulAclListAction(action.ConsulBaseAction):
     def run(self):
-
-        acl_list = self.consul.acl.list()
-        print json.dumps(acl_list)
+        return (True, json.dumps(self.consul.acl.list()))

actions/agent_checks.py

@@ -0,0 +1,6 @@
+from lib import action
+
+
+class ConsulAgentChecksAction(action.ConsulBaseAction):
+    def run(self):
+        return (True, self.consul.agent.checks())

actions/agent_checks.yaml

@@ -0,0 +1,5 @@
+name: agent_checks
+runner_type: python-script
+description: "Returns all the checks that are registered with the local agent."
+enabled: true
+entry_point: "agent_checks.py"

actions/agent_force_leave.py

@@ -0,0 +1,6 @@
+from lib import action
+
+
+class ConsulAgentForceLeaveAction(action.ConsulBaseAction):
+    def run(self, node):
+        return (True, self.consul.agent.force_leave(node))

actions/agent_force_leave.yaml

@@ -0,0 +1,10 @@
+name: agent_force_leave
+runner_type: python-script
+description: "Instructs the agent to force a node into the left state."
+enabled: true
+entry_point: "agent_force_leave.py"
+parameters:
+    node:
+        type: string
+        description: "The node to change state for."
+        required: true

actions/agent_join.py

@@ -0,0 +1,6 @@
+from lib import action
+
+
+class ConsulAgentJoinAction(action.ConsulBaseAction):
+    def run(self, address, wan=False):
+        return (True, self.consul.agent.join(address, wan))

actions/agent_join.yaml

@@ -0,0 +1,15 @@
+name: agent_join
+runner_type: python-script
+description: "Instructs the agent to attempt to connect to a given address."
+enabled: true
+entry_point: "agent_join.py"
+parameters:
+    address:
+        type: string
+        description: "The ip to connect to."
+        required: true
+    wan:
+        type: boolean
+        description: "True: causes the agent to attempt to join using the WAN pool."
+        required: false
+