Architecture

Host

class nuka.hosts.base.BaseHost(hostname=None, port='22', **vars)

boot()

boot the host

destroy()

destroy the host

get_inventory()

return host’s inventory. await for host’s boot & setup if needed

private_ip

return host’s private ip

public_ip

return host’s public ip

run_command(cmd=None, stdin=None, task=None, **kwargs)

run a shell command on the remote host

Task

class nuka.task.Task(**kwargs)

run()

Serialize the task, send it to the remote host. The remote script will deserialize the task and run do() (or diff() when using –diff)

Remote task

class nuka.remote.task.Task(**kwargs)

Remote task

do()

called on the remote host. Task arguments are available in self.args Must return a dict like:

{'rc': 0, 'changed': False}

classmethod is_alive(process)

return True iif the process is the current process

classmethod send_log(message, level=10)

send a log line to the client

classmethod send_progress(value, level=32)

send progression of the current remote process to the client

classmethod sh(args, stdin=b'', shell=False, env=None, check=True, watcher=None, short_args=None, stdout=None, stderr=None)

run a shell command