OPS-673: Remove custom supervisorctl module

playbooks/library/supervisorctl_local

-#!/usr/bin/python
-# -*- coding: utf-8 -*-
-
-# (c) 2012, Matt Wright <matt@nobien.net>
-#
-# This file is part of Ansible
-#
-# Ansible is free software: you can redistribute it and/or modify
-# it under the terms of the GNU General Public License as published by
-# the Free Software Foundation, either version 3 of the License, or
-# (at your option) any later version.
-#
-# Ansible is distributed in the hope that it will be useful,
-# but WITHOUT ANY WARRANTY; without even the implied warranty of
-# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
-# GNU General Public License for more details.
-#
-# You should have received a copy of the GNU General Public License
-# along with Ansible.  If not, see <http://www.gnu.org/licenses/>.
-#
-import os
-
-DOCUMENTATION = '''
----
-module: supervisorctl
-short_description: Manage the state of a program or group of programs running via Supervisord
-description:
-     - Manage the state of a program or group of programs running via I(Supervisord)
-version_added: "0.7"
-options:
-  name:
-    description:
-      - The name of the I(supervisord) program/process to manage
-    required: true
-    default: null
-  config:
-    description:
-      - configuration file path, passed as -c to supervisorctl
-    required: false
-    default: null
-    version_added: "1.3"
-  server_url:
-    description:
-      - URL on which supervisord server is listening, passed as -s to supervisorctl
-    required: false
-    default: null
-    version_added: "1.3"
-  username:
-    description:
-      - username to use for authentication with server, passed as -u to supervisorctl
-    required: false
-    default: null
-    version_added: "1.3"
-  password:
-    description:
-      - password to use for authentication with server, passed as -p to supervisorctl
-    required: false
-    default: null
-    version_added: "1.3"
-  state:
-    description:
-      - The state of service
-    required: true
-    default: null
-    choices: [ "present", "started", "stopped", "restarted" ]
-  supervisorctl_path:
-    description:
-      - Path to supervisorctl executable to use
-    required: false
-    default: null
-    version_added: "1.4"
-requirements:
-  - supervisorctl
-requirements: [ ]
-author: Matt Wright
-'''
-
-EXAMPLES = '''
-# Manage the state of program to be in 'started' state.
-- supervisorctl: name=my_app state=started
-
-# Restart my_app, reading supervisorctl configuration from a specified file.
-- supervisorctl: name=my_app state=restarted config=/var/opt/my_project/supervisord.conf
-
-# Restart my_app, connecting to supervisord with credentials and server URL.
-- supervisorctl: name=my_app state=restarted username=test password=testpass server_url=http://localhost:9001
-
-'''
-
-def main():
-    arg_spec = dict(
-        name=dict(required=True),
-        config=dict(required=False),
-        server_url=dict(required=False),
-        username=dict(required=False),
-        password=dict(required=False),
-        supervisorctl_path=dict(required=False),
-        state=dict(required=True, choices=['present', 'started', 'restarted', 'stopped'])
-    )
-
-    module = AnsibleModule(argument_spec=arg_spec, supports_check_mode=True)
-
-    name = module.params['name']
-    state = module.params['state']
-    config = module.params.get('config')
-    server_url = module.params.get('server_url')
-    username = module.params.get('username')
-    password = module.params.get('password')
-    supervisorctl_path = module.params.get('supervisorctl_path')
-
-    if supervisorctl_path:
-        supervisorctl_path = os.path.expanduser(supervisorctl_path)
-        if os.path.exists(supervisorctl_path) and module.is_executable(supervisorctl_path):
-            supervisorctl_args = [ supervisorctl_path ]
-        else:
-            module.fail_json(msg="Provided path to supervisorctl does not exist or isn't executable: %s" % supervisorctl_path)
-    else:
-        supervisorctl_args = [ module.get_bin_path('supervisorctl', True) ]
-
-    if config:
-        supervisorctl_args.extend(['-c', os.path.expanduser(config)])
-    if server_url:
-        supervisorctl_args.extend(['-s', server_url])
-    if username:
-        supervisorctl_args.extend(['-u', username])
-    if password:
-        supervisorctl_args.extend(['-p', password])
-
-    def run_supervisorctl(cmd, name=None, **kwargs):
-        args = list(supervisorctl_args)  # copy the master args
-        args.append(cmd)
-        if name:
-            args.append(name)
-        return module.run_command(args, **kwargs)
-
-    rc, out, err = run_supervisorctl('status')
-    present = name in out
-
-    if state == 'present':
-        if not present:
-            if module.check_mode:
-                module.exit_json(changed=True)
-            run_supervisorctl('reread', check_rc=True)
-            rc, out, err = run_supervisorctl('add', name)
-
-            if '%s: added process group' % name in out:
-                module.exit_json(changed=True, name=name, state=state)
-            else:
-                module.fail_json(msg=out, name=name, state=state)
-
-        module.exit_json(changed=False, name=name, state=state)
-
-    rc, out, err = run_supervisorctl('status', name)
-    running = 'RUNNING' in out
-
-    if running and state == 'started':
-        module.exit_json(changed=False, name=name, state=state)
-
-    if running and state == 'stopped':
-        if module.check_mode:
-            module.exit_json(changed=True)
-        rc, out, err = run_supervisorctl('stop', name)
-
-        if '%s: stopped' % name in out:
-            module.exit_json(changed=True, name=name, state=state)
-
-        module.fail_json(msg=out)
-
-    elif state == 'restarted':
-        if module.check_mode:
-            module.exit_json(changed=True)
-        rc, out, err = run_supervisorctl('update', name)
-        rc, out, err = run_supervisorctl('restart', name)
-
-        if '%s: started' % name in out:
-            module.exit_json(changed=True, name=name, state=state)
-
-        module.fail_json(msg=out)
-
-    elif not running and state == 'started':
-        if module.check_mode:
-            module.exit_json(changed=True)
-        rc, out, err = run_supervisorctl('start',name)
-
-        if '%s: started' % name in out:
-            module.exit_json(changed=True, name=name, state=state)
-        elif '%s: ERROR (already started)' % name in out:
-            # addresses a race condition if update is called
-            # immediately before started and the service is set
-            # to start automatically
-            module.exit_json(changed=False, name=name, state=state)
-
-        module.fail_json(msg=out)
-
-    module.exit_json(changed=False, name=name, state=state)
-
-# this is magic, see lib/ansible/module_common.py
-#<<INCLUDE_ANSIBLE_MODULE_COMMON>>
-
-main()

playbooks/roles/alton/handlers/main.yml

@@ -15,7 +15,7 @@
 # 
 #
 - name: restart alton
-  supervisorctl_local: >
+  supervisorctl: >
     name=alton
     supervisorctl_path={{ supervisor_ctl }}
     config={{ supervisor_cfg }}

playbooks/roles/alton/tasks/deploy.yml

@@ -65,7 +65,7 @@
   when: not disable_edx_services
 
 - name: ensure alton is started
-  supervisorctl_local: >
+  supervisorctl: >
     name=alton
     supervisorctl_path={{ supervisor_ctl }}
     config={{ supervisor_cfg }}

playbooks/roles/analytics_api/tasks/main.yml

@@ -122,7 +122,7 @@
   - manage.py
 
 - name: restart analytics_api
-  supervisorctl_local: >
+  supervisorctl: >
     state=restarted
     supervisorctl_path={{ supervisor_ctl }}
     config={{ supervisor_cfg }}

playbooks/roles/certs/handlers/main.yml

@@ -15,7 +15,7 @@
 #
 
 - name: restart certs
-  supervisorctl_local: >
+  supervisorctl: >
     name=certs
     supervisorctl_path={{ supervisor_ctl }}
     config={{ supervisor_cfg }}

playbooks/roles/certs/tasks/deploy.yml

@@ -90,7 +90,7 @@
   when: not disable_edx_services
 
 - name: ensure certs has started
-  supervisorctl_local: >
+  supervisorctl: >
     name=certs
     supervisorctl_path={{ supervisor_ctl }}
     config={{ supervisor_cfg }}

playbooks/roles/devpi/handlers/main.yml

@@ -12,7 +12,7 @@
 #
 ---
 - name: restart devpi
-  supervisorctl_local: >
+  supervisorctl: >
     state=restarted
     supervisorctl_path={{ devpi_supervisor_ctl }}
     config={{ devpi_supervisor_cfg }}

playbooks/roles/devpi/tasks/main.yml

@@ -106,7 +106,7 @@
   changed_when: supervisor_update.stdout is defined and supervisor_update.stdout != ""
 
 - name: ensure devpi is started
-  supervisorctl_local: >
+  supervisorctl: >
     state=started
     supervisorctl_path={{ devpi_supervisor_ctl }}
     config={{ devpi_supervisor_cfg }}

playbooks/roles/discern/handlers/main.yml

 ---
 - name: restart discern
-  supervisorctl_local: >
+  supervisorctl: >
     name=discern
     supervisorctl_path={{ supervisor_ctl }}
     config={{ supervisor_cfg }}

playbooks/roles/discern/tasks/deploy.yml

@@ -127,7 +127,7 @@
   when: not disable_edx_services
 
 - name: ensure discern, discern_celery has started
-  supervisorctl_local: >
+  supervisorctl: >
     name={{ item }}
     supervisorctl_path={{ supervisor_ctl }}
     config={{ supervisor_cfg }}

playbooks/roles/ecommerce/tasks/main.yml

@@ -116,7 +116,7 @@
   - manage.py
 
 - name: restart the applicaton
-  supervisorctl_local: >
+  supervisorctl: >
     state=restarted
     supervisorctl_path={{ supervisor_ctl }}
     config={{ supervisor_cfg }}

playbooks/roles/edx_notes_api/tasks/main.yml

@@ -96,7 +96,7 @@
     - deploy
 
 - name: restart supervisor
-  supervisorctl_local: >
+  supervisorctl: >
     name={{ edx_notes_api_service_name }}
     supervisorctl_path={{ supervisor_ctl }}
     config={{ supervisor_cfg }}
@@ -122,7 +122,7 @@
     state=link
 
 - name: restart edx_notes_api
-  supervisorctl_local: >
+  supervisorctl: >
     state=restarted
     supervisorctl_path={{ supervisor_ctl }}
     config={{ supervisor_cfg }}

playbooks/roles/edxapp/tasks/deploy.yml

@@ -356,7 +356,7 @@
   when: not disable_edx_services
 
 - name: ensure edxapp has started
-  supervisorctl_local: >
+  supervisorctl: >
     state=started
     supervisorctl_path={{ supervisor_ctl }}
     config={{ supervisor_cfg }}
@@ -366,7 +366,7 @@
   with_items: service_variants_enabled
 
 - name: ensure edxapp_workers has started
-  supervisorctl_local: >
+  supervisorctl: >
     name="edxapp_worker:{{ item.service_variant }}_{{ item.queue }}_{{ item.concurrency }}"
     supervisorctl_path={{ supervisor_ctl }}
     config={{ supervisor_cfg }}
@@ -403,7 +403,7 @@
 - set_fact: edxapp_installed=true
 
 - name: restart edxapp
-  supervisorctl_local: >
+  supervisorctl: >
     state=restarted
     supervisorctl_path={{ supervisor_ctl }}
     config={{ supervisor_cfg }}
@@ -413,7 +413,7 @@
   with_items: service_variants_enabled
 
 - name: restart edxapp_workers
-  supervisorctl_local: >
+  supervisorctl: >
     name="edxapp_worker:{{ item.service_variant }}_{{ item.queue }}_{{ item.concurrency }}"
     supervisorctl_path={{ supervisor_ctl }}
     config={{ supervisor_cfg }}

playbooks/roles/flower/handlers/main.yml

 ---
 - name: restart flower
-  supervisorctl_local: >
+  supervisorctl: >
     state=restarted
     supervisorctl_path={{ supervisor_ctl }}
     config={{ supervisor_cfg }}

playbooks/roles/forum/handlers/main.yml

 ---
 - name: restart the forum service
-  supervisorctl_local: >
+  supervisorctl: >
     name=forum
     supervisorctl_path={{ supervisor_ctl }}
     config={{ supervisor_cfg }}

playbooks/roles/forum/tasks/deploy.yml

@@ -58,7 +58,7 @@
   when: not disable_edx_services
 
 - name: ensure forum is started
-  supervisorctl_local: >
+  supervisorctl: >
     name=forum
     supervisorctl_path={{ supervisor_ctl }}
     config={{ supervisor_cfg }}

playbooks/roles/gitreload/handlers/main.yml

@@ -15,7 +15,7 @@
 # 
 #
 - name: restart gitreload
-  supervisorctl_local: >
+  supervisorctl: >
     name=gitreload
     supervisorctl_path={{ supervisor_ctl }}
     config={{ supervisor_cfg }}

playbooks/roles/gitreload/tasks/deploy.yml

@@ -54,7 +54,7 @@
   when: not disable_edx_services
 
 - name: ensure gitreload is started
-  supervisorctl_local: >
+  supervisorctl: >
     name=gitreload
     supervisorctl_path={{ supervisor_ctl }}
     config={{ supervisor_cfg }}

playbooks/roles/insights/tasks/main.yml

@@ -126,7 +126,7 @@
     state=link
 
 - name: restart insights
-  supervisorctl_local: >
+  supervisorctl: >
     state=restarted
     supervisorctl_path={{ supervisor_ctl }}
     config={{ supervisor_cfg }}

playbooks/roles/newrelic/tasks/s3-watcher.yml

@@ -67,7 +67,7 @@
   changed_when: supervisor_update.stdout is defined and supervisor_update.stdout != ""
 
 - name: ensure s3watcher is started
-  supervisorctl_local: >
+  supervisorctl: >
     name=s3watcher
     supervisorctl_path={{ supervisor_ctl }}
     config={{ supervisor_cfg }}

playbooks/roles/notifier/handlers/main.yml

 ---
 
 - name: restart notifier-scheduler
-  supervisorctl_local: >
+  supervisorctl: >
     name=notifier-scheduler
     state=restarted
     config={{ supervisor_cfg }}
@@ -9,7 +9,7 @@
   when: not disable_edx_services
 
 - name: restart notifier-celery-workers
-  supervisorctl_local: >
+  supervisorctl: >
     name=notifier-celery-workers
     state=restarted
     config={{ supervisor_cfg }}

playbooks/roles/ora/handlers/main.yml

 ---
 - name: restart ora
-  supervisorctl_local: >
+  supervisorctl: >
     name=ora
     supervisorctl_path={{ supervisor_ctl }}
     config={{ supervisor_cfg }}
@@ -8,7 +8,7 @@
   when: ora_installed is defined and not disable_edx_services
 
 - name: restart ora_celery
-  supervisorctl_local: >
+  supervisorctl: >
     name=ora_celery
     supervisorctl_path={{ supervisor_ctl }}
     config={{ supervisor_cfg }}

playbooks/roles/ora/tasks/deploy.yml

@@ -114,7 +114,7 @@
   changed_when: supervisor_update.stdout is defined and supervisor_update.stdout != ""
 
 - name: ensure ora is started
-  supervisorctl_local: >
+  supervisorctl: >
     name=ora
     supervisorctl_path={{ supervisor_ctl }}
     config={{ supervisor_cfg }}
@@ -122,7 +122,7 @@
   when: not disable_edx_services
 
 - name: ensure ora_celery is started
-  supervisorctl_local: >
+  supervisorctl: >
     name=ora_celery
     supervisorctl_path={{ supervisor_ctl }}
     config={{ supervisor_cfg }}

playbooks/roles/xqueue/handlers/main.yml

 - name: restart xqueue
-  supervisorctl_local: >
+  supervisorctl: >
     name={{ item }}
     supervisorctl_path={{ supervisor_ctl }}
     config={{ supervisor_cfg }}

playbooks/roles/xqueue/tasks/deploy.yml

@@ -93,7 +93,7 @@
   when: not disable_edx_services
 
 - name: ensure xqueue, consumer is running
-  supervisorctl_local: >
+  supervisorctl: >
     name={{ item }}
     supervisorctl_path={{ supervisor_ctl }}
     config={{ supervisor_cfg }}

playbooks/roles/xqwatcher/tasks/deploy_watcher.yml

@@ -35,7 +35,7 @@
   when: not disable_edx_services
 
 - name: restart xqwatcher
-  supervisorctl_local: >
+  supervisorctl: >
     state=restarted
     supervisorctl_path={{ xqwatcher_supervisor_ctl }}
     config={{ xqwatcher_supervisor_app_dir }}/supervisord.conf

playbooks/roles/xserver/handlers/main.yml

@@ -15,7 +15,7 @@
 #
 
 - name: restart xserver
-  supervisorctl_local: >
+  supervisorctl: >
     name=xserver
     supervisorctl_path={{ supervisor_ctl }}
     config={{ supervisor_cfg }}

playbooks/roles/xserver/tasks/deploy.yml

@@ -83,7 +83,7 @@
   when: not disable_edx_services
 
 - name: ensure xserver is started
-  supervisorctl_local: >
+  supervisorctl: >
     name=xserver
     supervisorctl_path={{ supervisor_ctl }}
     config={{ supervisor_cfg }}