salt-proxy

Salt Proxy Minion Factory

class saltfactories.daemons.proxy.SystemdSaltProxyImpl(*, factory, before_start_callbacks=NOTHING, after_start_callbacks=NOTHING, before_terminate_callbacks=NOTHING, after_terminate_callbacks=NOTHING)[source]

Bases: saltfactories.bases.SystemdSaltDaemonImpl

Return type

None

get_service_name()[source]

Return the systemd service name

after_start(callback, *args, **kwargs)

Register a function callback to run after the daemon starts

Parameters

  • callback (Callable) – The function to call back

  • args – The arguments to pass to the callback

  • kwargs – The keyword arguments to pass to the callback

after_terminate(callback, *args, **kwargs)

Register a function callback to run after the daemon terminates

Parameters

  • callback (Callable) – The function to call back

  • args – The arguments to pass to the callback

  • kwargs – The keyword arguments to pass to the callback

before_start(callback, *args, **kwargs)

Register a function callback to run before the daemon starts

Parameters

  • callback (Callable) – The function to call back

  • args – The arguments to pass to the callback

  • kwargs – The keyword arguments to pass to the callback

before_terminate(callback, *args, **kwargs)

Register a function callback to run before the daemon terminates

Parameters

  • callback (Callable) – The function to call back

  • args – The arguments to pass to the callback

  • kwargs – The keyword arguments to pass to the callback

cmdline(*args)

Construct a list of arguments to use when starting the subprocess

Parameters

args (str) – Additional arguments to use when starting the subprocess

get_start_arguments()

Return the arguments and keyword arguments used when starting the daemon:

Return type

StartDaemonCallArguments

init_terminal(cmdline, env=None)

Instantiate a terminal with the passed command line(cmdline) and return it.

Additionally, it sets a reference to it in self._terminal and also collects an initial listing of child processes which will be used when terminating the terminal

Parameters

  • cmdline (list,tuple) – List of strings to pass as args to Popen

  • environ (dict) – A dictionary of key, value pairs to add to the py:attr:saltfactories.base.Factory.environ.

internal_run(*args, **kwargs)

Run the given command synchronously

is_running()

Returns true if the sub-process is alive

property pid

The pid of the running process. None if not running.

run(*args, **kwargs)

Run the given command synchronously

start(*extra_cli_arguments, max_start_attempts=None, start_timeout=None)

Start the daemon

Parameters

  • extra_cli_arguments (tuple,) – Extra arguments to pass to the CLI that starts the daemon

  • max_start_attempts (int) – Maximum number of attempts to try and start the daemon in case of failures

  • start_timeout (int) – The maximum number of seconds to wait before considering that the daemon did not start

terminate()

Terminate the daemon

class saltfactories.daemons.proxy.SaltProxyMinion(*, config, python_executable=None, system_install=False, cwd=None, environ=None, script_name, base_script_args=NOTHING, slow_stop=True, check_ports=None, factories_manager=None, start_timeout, max_start_attempts=3, extra_cli_arguments_after_first_start_failure=NOTHING, event_listener=None, started_at=None, include_proxyid_cli_flag=True)[source]

Bases: saltfactories.bases.SaltDaemon

Return type

None

classmethod load_config(config_file, config)[source]

Should return the configuration as the daemon would have loaded after parsing the CLI

get_base_script_args()[source]

Returns any additional arguments to pass to the CLI script

cmdline(*args)[source]

Construct a list of arguments to use when starting the subprocess

Parameters

args (str) – Additional arguments to use when starting the subprocess

get_check_events()[source]

Return a list of tuples in the form of (master_id, event_tag) check against to ensure the daemon is running

salt_call_cli(factory_class=<class 'saltfactories.cli.call.SaltCall'>, **factory_class_kwargs)[source]

Return a salt-call CLI process for this minion instance

after_start(callback, *args, **kwargs)

Register a function callback to run after the daemon starts

Parameters

  • callback (Callable) – The function to call back

  • args – The arguments to pass to the callback

  • kwargs – The keyword arguments to pass to the callback

after_terminate(callback, *args, **kwargs)

Register a function callback to run after the daemon terminates

Parameters

  • callback (Callable) – The function to call back

  • args – The arguments to pass to the callback

  • kwargs – The keyword arguments to pass to the callback

before_start(callback, *args, **kwargs)

Register a function callback to run before the daemon starts

Parameters

  • callback (Callable) – The function to call back

  • args – The arguments to pass to the callback

  • kwargs – The keyword arguments to pass to the callback

before_terminate(callback, *args, **kwargs)

Register a function callback to run before the daemon terminates

Parameters

  • callback (Callable) – The function to call back

  • args – The arguments to pass to the callback

  • kwargs – The keyword arguments to pass to the callback

classmethod configure(factories_manager, daemon_id, root_dir=None, defaults=None, overrides=None, **configure_kwargs)

Configure the salt daemon

get_check_ports()

Return a list of ports to check against to ensure the daemon is running

get_display_name()

Returns a human readable name for the factory

get_script_args()

Returns any additional arguments to pass to the CLI script

get_script_path()

Returns the path to the script to run

is_running()

Returns true if the sub-process is alive

property pid

The pid of the running process. None if not running.

run_start_checks(started_at, timeout_at)

Run checks to confirm that the daemon has started

start(*extra_cli_arguments, max_start_attempts=None, start_timeout=None)

Start the daemon

started(*extra_cli_arguments, max_start_attempts=None, start_timeout=None)

Start the daemon and return it’s instance so it can be used as a context manager

stopped(before_stop_callback=None, after_stop_callback=None, before_start_callback=None, after_start_callback=None)
Parameters

  • before_stop_callback (Callable) – A callable to run before stopping the daemon. The callback must accept one argument, the daemon instance.

  • after_stop_callback (Callable) – A callable to run after stopping the daemon. The callback must accept one argument, the daemon instance.

  • before_start_callback (Callable) – A callable to run before starting the daemon. The callback must accept one argument, the daemon instance.

  • after_start_callback (Callable) – A callable to run after starting the daemon. The callback must accept one argument, the daemon instance.

This context manager will stop the factory while the context is in place, it re-starts it once out of context.

For example:

assert factory.is_running() is True

with factory.stopped():
    assert factory.is_running() is False

assert factory.is_running() is True
terminate()

Terminate the started daemon

classmethod write_config(config)

Write the configuration to file