| Dir : /proc/self/root/opt/saltstack/salt/lib/python3.10/site-packages/salt/modules/ |
| Server: Linux ngx353.inmotionhosting.com 4.18.0-553.22.1.lve.1.el8.x86_64 #1 SMP Tue Oct 8 15:52:54 UTC 2024 x86_64 IP: 209.182.202.254 |
| Dir : //proc/self/root/opt/saltstack/salt/lib/python3.10/site-packages/salt/modules/chef.py |
"""
Execute chef in server or solo mode
"""
import logging
import os
import tempfile
import salt.utils.decorators.path
import salt.utils.path
import salt.utils.platform
log = logging.getLogger(__name__)
def __virtual__():
"""
Only load if chef is installed
"""
if not salt.utils.path.which("chef-client"):
return (False, "Cannot load chef module: chef-client not found")
return True
def _default_logfile(exe_name):
"""
Retrieve the logfile name
"""
if salt.utils.platform.is_windows():
tmp_dir = os.path.join(__opts__["cachedir"], "tmp")
if not os.path.isdir(tmp_dir):
os.mkdir(tmp_dir)
logfile_tmp = tempfile.NamedTemporaryFile(
dir=tmp_dir, prefix=exe_name, suffix=".log", delete=False
)
logfile = logfile_tmp.name
logfile_tmp.close()
else:
logfile = salt.utils.path.join("/var/log", f"{exe_name}.log")
return logfile
@salt.utils.decorators.path.which("chef-client")
def client(whyrun=False, localmode=False, logfile=None, **kwargs):
"""
Execute a chef client run and return a dict with the stderr, stdout,
return code, and pid.
CLI Example:
.. code-block:: bash
salt '*' chef.client server=https://localhost
server
The chef server URL
client_key
Set the client key file location
config
The configuration file to use
config-file-jail
Directory under which config files are allowed to be loaded
(no client.rb or knife.rb outside this path will be loaded).
environment
Set the Chef Environment on the node
group
Group to set privilege to
json-attributes
Load attributes from a JSON file or URL
localmode
Point chef-client at local repository if True
log_level
Set the log level (debug, info, warn, error, fatal)
logfile
Set the log file location
node-name
The node name for this client
override-runlist
Replace current run list with specified items for a single run
pid
Set the PID file location, defaults to /tmp/chef-client.pid
run-lock-timeout
Set maximum duration to wait for another client run to finish,
default is indefinitely.
runlist
Permanently replace current run list with specified items
user
User to set privilege to
validation_key
Set the validation key file location, used for registering new clients
whyrun
Enable whyrun mode when set to True
"""
if logfile is None:
logfile = _default_logfile("chef-client")
args = [
"chef-client",
"--no-color",
"--once",
f'--logfile "{logfile}"',
"--format doc",
]
if whyrun:
args.append("--why-run")
if localmode:
args.append("--local-mode")
return _exec_cmd(*args, **kwargs)
@salt.utils.decorators.path.which("chef-solo")
def solo(whyrun=False, logfile=None, **kwargs):
"""
Execute a chef solo run and return a dict with the stderr, stdout,
return code, and pid.
CLI Example:
.. code-block:: bash
salt '*' chef.solo override-runlist=test
config
The configuration file to use
environment
Set the Chef Environment on the node
group
Group to set privilege to
json-attributes
Load attributes from a JSON file or URL
log_level
Set the log level (debug, info, warn, error, fatal)
logfile
Set the log file location
node-name
The node name for this client
override-runlist
Replace current run list with specified items for a single run
recipe-url
Pull down a remote gzipped tarball of recipes and untar it to
the cookbook cache
run-lock-timeout
Set maximum duration to wait for another client run to finish,
default is indefinitely.
user
User to set privilege to
whyrun
Enable whyrun mode when set to True
"""
if logfile is None:
logfile = _default_logfile("chef-solo")
args = [
"chef-solo",
"--no-color",
f'--logfile "{logfile}"',
"--format doc",
]
if whyrun:
args.append("--why-run")
return _exec_cmd(*args, **kwargs)
def _exec_cmd(*args, **kwargs):
# Compile the command arguments
cmd_args = " ".join(args)
cmd_kwargs = "".join(
[f" --{k} {v}" for k, v in kwargs.items() if not k.startswith("__")]
)
cmd_exec = f"{cmd_args}{cmd_kwargs}"
log.debug("Chef command: %s", cmd_exec)
return __salt__["cmd.run_all"](cmd_exec, python_shell=False)