mirror of
https://github.com/ansible-collections/community.general.git
synced 2025-04-25 20:01:25 -07:00
Add reboot action plugin (#35205)
* Update docs * Add reboot action plugin Refactor win_reboot so it is subclassed from reboot * Use new connection methods * Test fixes * Use better uptime command for Linux Use who -b to get the last time the system was booted rather than uptime, which changes every second. * Use distribution specefic commands and flags Query the managed node to determien its distribution, then set the appropriate command and flags. * Tune debug messages a bit * Update module docs with details about pre_reboot_delay s docs * Ensure that post_reboot_delay is a positive number * Remove the stringification * Add integration tests * Make sure aliases are honored * Handle systems that have an incorrect last boot time SystemD and fakehw-clock do not properly set the last boot time and instead always set it to epoch. Use a different command if that is the case. * Copyright and encoding fixes * Minor fixes based on feedback * Add exponential backoff to sucess check method * Update integration test Skip the integration test if it would try to reboot the control node. We need a new mechanism to account for this scenario in ansible-test, so tests must currently be run manually for this plugin. * Update integration test Skip the integration test if it would try to reboot the control node. We need a new mechanism to account for this scenario in ansible-test, so tests must currently be run manually for this plugin. * Fail early with running with local connection * Update docs based on feedback * minor refactoring, state mgmt changes
This commit is contained in:
Sam Doran
Matt Davis
parent
60e3af42d5
commit
4d9218cec4
5 changed files with 459 additions and 175 deletions
|
|
@ -1,16 +1,15 @@
|
|||
# (c) 2016, Matt Davis <mdavis@ansible.com>
|
||||
# (c) 2018, Matt Davis <mdavis@ansible.com>
|
||||
# GNU General Public License v3.0+ (see COPYING or https://www.gnu.org/licenses/gpl-3.0.txt)
|
||||
|
||||
from __future__ import (absolute_import, division, print_function)
|
||||
__metaclass__ = type
|
||||
|
||||
import time
|
||||
|
||||
from datetime import datetime, timedelta
|
||||
from datetime import datetime
|
||||
|
||||
from ansible.errors import AnsibleError
|
||||
from ansible.plugins.action import ActionBase
|
||||
from ansible.module_utils._text import to_native
|
||||
from ansible.plugins.action.reboot import ActionModule as RebootActionModule
|
||||
|
||||
try:
|
||||
from __main__ import display
|
||||
|
|
@ -23,201 +22,66 @@ class TimedOutException(Exception):
|
|||
pass
|
||||
|
||||
|
||||
class ActionModule(ActionBase):
|
||||
class ActionModule(RebootActionModule, ActionBase):
|
||||
TRANSFERS_FILES = False
|
||||
|
||||
DEFAULT_REBOOT_TIMEOUT = 600
|
||||
DEFAULT_CONNECT_TIMEOUT = 5
|
||||
DEFAULT_PRE_REBOOT_DELAY = 2
|
||||
DEFAULT_POST_REBOOT_DELAY = 0
|
||||
DEFAULT_TEST_COMMAND = 'whoami'
|
||||
DEFAULT_REBOOT_MESSAGE = 'Reboot initiated by Ansible.'
|
||||
DEFAULT_BOOT_TIME_COMMAND = "(Get-WmiObject -ClassName Win32_OperatingSystem).LastBootUpTime"
|
||||
DEFAULT_SHUTDOWN_COMMAND_ARGS = '/r /t %d /c "%s"'
|
||||
DEFAULT_SUDOABLE = False
|
||||
|
||||
def get_system_uptime(self):
|
||||
uptime_command = "(Get-WmiObject -ClassName Win32_OperatingSystem).LastBootUpTime"
|
||||
(rc, stdout, stderr) = self._connection.exec_command(uptime_command)
|
||||
DEPRECATED_ARGS = {
|
||||
'shutdown_timeout': '2.5',
|
||||
'shutdown_timeout_sec': '2.5',
|
||||
}
|
||||
|
||||
if rc != 0:
|
||||
raise Exception("win_reboot: failed to get host uptime info, rc: %d, stdout: %s, stderr: %s"
|
||||
% (rc, stdout, stderr))
|
||||
def construct_command(self):
|
||||
shutdown_command = self.DEFAULT_SHUTDOWN_COMMAND
|
||||
pre_reboot_delay = int(self._task.args.get('pre_reboot_delay', self._task.args.get('pre_reboot_delay_sec', self.DEFAULT_PRE_REBOOT_DELAY)))
|
||||
msg = self._task.args.get('msg', self.DEFAULT_REBOOT_MESSAGE)
|
||||
shutdown_command_args = self.DEFAULT_SHUTDOWN_COMMAND_ARGS % (pre_reboot_delay, msg)
|
||||
|
||||
return stdout
|
||||
reboot_command = '%s %s' % (shutdown_command, shutdown_command_args)
|
||||
return reboot_command
|
||||
|
||||
def do_until_success_or_timeout(self, what, timeout, what_desc, fail_sleep=1):
|
||||
max_end_time = datetime.utcnow() + timedelta(seconds=timeout)
|
||||
def perform_reboot(self):
|
||||
display.debug("Rebooting server")
|
||||
|
||||
exc = ""
|
||||
while datetime.utcnow() < max_end_time:
|
||||
try:
|
||||
what()
|
||||
if what_desc:
|
||||
display.debug("win_reboot: %s success" % what_desc)
|
||||
return
|
||||
except Exception as e:
|
||||
exc = e
|
||||
if what_desc:
|
||||
display.debug("win_reboot: %s fail '%s' (expected), retrying in %d seconds..." % (what_desc, to_native(e), fail_sleep))
|
||||
time.sleep(fail_sleep)
|
||||
remote_command = self.construct_command()
|
||||
reboot_result = self._low_level_execute_command(remote_command, sudoable=self.DEFAULT_SUDOABLE)
|
||||
|
||||
raise TimedOutException("timed out waiting for %s: %s" % (what_desc, exc))
|
||||
|
||||
def run(self, tmp=None, task_vars=None):
|
||||
|
||||
self._supports_check_mode = True
|
||||
self._supports_async = True
|
||||
|
||||
if self._play_context.check_mode:
|
||||
return dict(changed=True, elapsed=0, rebooted=True)
|
||||
|
||||
if task_vars is None:
|
||||
task_vars = dict()
|
||||
|
||||
result = super(ActionModule, self).run(tmp, task_vars)
|
||||
del tmp # tmp no longer has any effect
|
||||
|
||||
if result.get('skipped', False) or result.get('failed', False):
|
||||
return result
|
||||
|
||||
# Handle timeout parameters and its alias
|
||||
deprecated_args = {
|
||||
'shutdown_timeout': '2.5',
|
||||
'shutdown_timeout_sec': '2.5',
|
||||
}
|
||||
for arg, version in deprecated_args.items():
|
||||
if self._task.args.get(arg) is not None:
|
||||
display.warning("Since Ansible %s, %s is no longer used with win_reboot" % (version, arg))
|
||||
|
||||
if self._task.args.get('connect_timeout') is not None:
|
||||
connect_timeout = int(self._task.args.get('connect_timeout', self.DEFAULT_CONNECT_TIMEOUT))
|
||||
else:
|
||||
connect_timeout = int(self._task.args.get('connect_timeout_sec', self.DEFAULT_CONNECT_TIMEOUT))
|
||||
|
||||
if self._task.args.get('reboot_timeout') is not None:
|
||||
reboot_timeout = int(self._task.args.get('reboot_timeout', self.DEFAULT_REBOOT_TIMEOUT))
|
||||
else:
|
||||
reboot_timeout = int(self._task.args.get('reboot_timeout_sec', self.DEFAULT_REBOOT_TIMEOUT))
|
||||
|
||||
if self._task.args.get('pre_reboot_delay') is not None:
|
||||
pre_reboot_delay = int(self._task.args.get('pre_reboot_delay', self.DEFAULT_PRE_REBOOT_DELAY))
|
||||
else:
|
||||
pre_reboot_delay = int(self._task.args.get('pre_reboot_delay_sec', self.DEFAULT_PRE_REBOOT_DELAY))
|
||||
|
||||
if self._task.args.get('post_reboot_delay') is not None:
|
||||
post_reboot_delay = int(self._task.args.get('post_reboot_delay', self.DEFAULT_POST_REBOOT_DELAY))
|
||||
else:
|
||||
post_reboot_delay = int(self._task.args.get('post_reboot_delay_sec', self.DEFAULT_POST_REBOOT_DELAY))
|
||||
|
||||
test_command = str(self._task.args.get('test_command', self.DEFAULT_TEST_COMMAND))
|
||||
msg = str(self._task.args.get('msg', self.DEFAULT_REBOOT_MESSAGE))
|
||||
|
||||
# Get current uptime
|
||||
try:
|
||||
before_uptime = self.get_system_uptime()
|
||||
except Exception as e:
|
||||
result['failed'] = True
|
||||
result['reboot'] = False
|
||||
result['msg'] = to_native(e)
|
||||
return result
|
||||
|
||||
# Initiate reboot
|
||||
display.vvv("rebooting server")
|
||||
(rc, stdout, stderr) = self._connection.exec_command('shutdown /r /t %d /c "%s"' % (pre_reboot_delay, msg))
|
||||
pre_reboot_delay = int(self._task.args.get('pre_reboot_delay', self._task.args.get('pre_reboot_delay_sec', self.DEFAULT_PRE_REBOOT_DELAY)))
|
||||
|
||||
# Test for "A system shutdown has already been scheduled. (1190)" and handle it gracefully
|
||||
if rc == 1190 or (rc != 0 and b"(1190)" in stderr):
|
||||
if reboot_result['rc'] == 1190 or (reboot_result['rc'] != 0 and b"(1190)" in reboot_result['stderr']):
|
||||
display.warning('A scheduled reboot was pre-empted by Ansible.')
|
||||
|
||||
# Try to abort (this may fail if it was already aborted)
|
||||
(rc, stdout1, stderr1) = self._connection.exec_command('shutdown /a')
|
||||
result1 = self._low_level_execute_command('shutdown /a', sudoable=self.DEFAULT_SUDOABLE)
|
||||
# (reboot_result['rc'], stdout1, stderr1) = self._connection.exec_command('shutdown /a')
|
||||
|
||||
# Initiate reboot again
|
||||
(rc, stdout2, stderr2) = self._connection.exec_command('shutdown /r /t %d' % pre_reboot_delay)
|
||||
stdout += stdout1 + stdout2
|
||||
stderr += stderr1 + stderr2
|
||||
result2 = self._connection.exec_command('shutdown /r /t %d' % pre_reboot_delay)
|
||||
# (reboot_result['rc'], stdout2, stderr2) = self._connection.exec_command('shutdown /r /t %d' % pre_reboot_delay)
|
||||
|
||||
if rc != 0:
|
||||
stdout = reboot_result['stdout'] + result1['stdout'] + result2['stdout']
|
||||
stderr = reboot_result['stderr'] + result1['stderr'] + result2['stderr']
|
||||
|
||||
result = {}
|
||||
if reboot_result['rc'] != 0:
|
||||
result['failed'] = True
|
||||
result['rebooted'] = False
|
||||
result['msg'] = "Shutdown command failed, error text was '%s'" % to_native(stderr)
|
||||
result['msg'] = "Shutdown command failed, error was: %s %s" % (to_native(stdout.strip()), to_native('stderr'.strip()))
|
||||
return result
|
||||
|
||||
start = datetime.now()
|
||||
result['failed'] = False
|
||||
result['start'] = datetime.utcnow()
|
||||
|
||||
# Get the original connection_timeout option var so it can be reset after
|
||||
connection_timeout_orig = None
|
||||
try:
|
||||
connection_timeout_orig = self._connection.get_option('connection_timeout')
|
||||
self._original_connection_timeout = self._connection.get_option('connection_timeout')
|
||||
except AnsibleError:
|
||||
display.debug("win_reboot: connection_timeout connection option has not been set")
|
||||
|
||||
try:
|
||||
# keep on checking system uptime with short connection responses
|
||||
def check_uptime():
|
||||
display.vvv("attempting to get system uptime")
|
||||
|
||||
# override connection timeout from defaults to custom value
|
||||
try:
|
||||
self._connection.set_option("connection_timeout",
|
||||
connect_timeout)
|
||||
self._connection.reset()
|
||||
except AttributeError:
|
||||
display.warning("Connection plugin does not allow the "
|
||||
"connection timeout to be overridden")
|
||||
|
||||
# try and get uptime
|
||||
try:
|
||||
current_uptime = self.get_system_uptime()
|
||||
except Exception as e:
|
||||
raise e
|
||||
|
||||
if current_uptime == before_uptime:
|
||||
raise Exception("uptime has not changed")
|
||||
|
||||
self.do_until_success_or_timeout(check_uptime, reboot_timeout, what_desc="reboot uptime check success")
|
||||
|
||||
# reset the connection to clear the custom connection timeout
|
||||
try:
|
||||
self._connection.set_option("connection_timeout",
|
||||
connection_timeout_orig)
|
||||
self._connection.reset()
|
||||
except (AnsibleError, AttributeError) as e:
|
||||
display.debug("Failed to reset connection_timeout back to default: %s" % to_native(e))
|
||||
|
||||
# finally run test command to ensure everything is working
|
||||
def run_test_command():
|
||||
display.vvv("attempting post-reboot test command '%s'" % test_command)
|
||||
try:
|
||||
(rc, stdout, stderr) = self._connection.exec_command(test_command)
|
||||
except Exception as e:
|
||||
# in case of a failure trying to execute the command
|
||||
# (another reboot occurred) we need to reset the connection
|
||||
# to make sure we are not re-using the same shell id
|
||||
try:
|
||||
self._connection.reset()
|
||||
except AttributeError:
|
||||
pass
|
||||
raise
|
||||
else:
|
||||
if rc != 0:
|
||||
raise Exception("test command failed, stdout: '%s', stderr: '%s', rc: %d"
|
||||
% (stdout, stderr, rc))
|
||||
|
||||
# FUTURE: add a stability check (system must remain up for N seconds) to deal with self-multi-reboot updates
|
||||
|
||||
self.do_until_success_or_timeout(run_test_command, reboot_timeout, what_desc="post-reboot test command success")
|
||||
|
||||
result['rebooted'] = True
|
||||
result['changed'] = True
|
||||
|
||||
except TimedOutException as toex:
|
||||
result['failed'] = True
|
||||
result['rebooted'] = True
|
||||
result['msg'] = to_native(toex)
|
||||
|
||||
if post_reboot_delay != 0:
|
||||
display.vvv("win_reboot: waiting an additional %d seconds" % post_reboot_delay)
|
||||
time.sleep(post_reboot_delay)
|
||||
|
||||
elapsed = datetime.now() - start
|
||||
result['elapsed'] = elapsed.seconds
|
||||
display.debug("%s: connect_timeout connection option has not been set" % self._task.action)
|
||||
|
||||
return result
|
||||
|
|
|
|||
Loading…
Add table
Add a link
Reference in a new issue