isalt 2021.2.2

安装

ISalt 通过 PyPI 分发，您可以通过执行以下命令进行安装：

$ pip install isalt

依赖关系

• salt

• IPython

这些包没有特定的版本，因此不会干扰您的环境。它通常可以与任何版本很好地工作。

使用方法

您可以使用以下选项之一或多个配置数据或条件，优先级顺序如下：ISalt 配置文件、环境变量和 CLI 参数。

需要牢记的一个重要细节是，在节点端运行代码与在主服务器端运行代码之间的区别（我们可以进一步区分作为 Runner 执行的代码与为任意节点执行的执行模块——对于前者，您可能需要使用 --minion-id CLI 参数提供节点 ID）。

通常，当您在运行 Salt 节点的计算机上安装 ISalt 时，只需执行 $ isalt 即可。

当您想在主服务器端使用 ISalt 但要测试执行模块时，可以运行 $ isalt --on-master。

当您正在查看评估 Runner 代码时，您只能在主服务器端这样做，因此，您需要将控制台作为 $ isalt --master 启动。

您可以通过以下方式查看完整的 CLI 可选参数列表：

$ isalt -h
usage: isalt [-h] [--saltenv SALTENV] [--pillarenv PILLARENV] [-c CFG_FILE]
             [-e CFG_FILE_ENV_VAR] [--minion-cfg MINION_CFG_FILE]
             [--proxy-cfg PROXY_CFG_FILE] [--master-cfg MASTER_CFG_FILE]
             [--minion] [--proxytype PROXYTYPE] [--proxy] [--sproxy]
             [--master] [--local] [--minion-id MINION_ID] [--on-master]

ISalt console

optional arguments:
  -h, --help            show this help message and exit
  --saltenv SALTENV     Salt environment name.
  --pillarenv PILLARENV
                        The Salt environment name to compile the Pillar from.
  -c CFG_FILE, --cfg-file CFG_FILE
                        The absolute path to the ISalt config file.
  -e CFG_FILE_ENV_VAR, --env-var CFG_FILE_ENV_VAR
                        The name of the environment variable pointing to the
                        ISalt config file.
  --minion-cfg MINION_CFG_FILE
                        The absolute path to the Minion config file.
  --proxy-cfg PROXY_CFG_FILE
                        The absolute path to the Proxy Minion config file.
  --master-cfg MASTER_CFG_FILE
                        The absolute path to the Master config file.
  --minion              Prepare the Salt dunders for the Minion.
  --proxy               Prepare the Salt dunders for the Proxy Minion.
  --sproxy              Prepare the Salt dunders for the salt-sproxy (Master
                        side).
  --master              Prepare the Salt dunders for the Master.
  --local               Override the Minion config and use the local client.
                        This option loads the file roots config from the
                        Master file.
  --minion-id MINION_ID
                        The Minion ID to compile the Salt dunders for. This
                        argument is optional, however it may fail when ISalt
                        is not able to determine the Minion ID, or take it
                        from the environment variable, etc.
  --on-minion           Whether should compile the dunders for the Minion
                        side, starting the ISalt console on the Minion
                        machine. The main difference is that the Pillar and
                        Grains are compiled locally, while when using --on-
                        master, it's using the local cached data.
  --on-master           Whether should compile the dunders for the Minion
                        side, starting the ISalt console on the Master
                        machine. This option is ignored when used in
                        conjunction with --master.

$ isalt --master

In [1]: # execute the ``test.sleep`` Runner:

In [2]: # https://docs.saltstack.com/en/latest/ref/runners/all/salt.runners.test.html#module-salt.runners.test

In [3]: __salt__['test.sleep'](1)
1
Out[3]: True

$ isalt --on-master --minion-id jerry

$ isalt --on-master --minion-id edge-router --proxy

proxy:
  proxytype: napalm

$ echo $ISALT_MINION_ID
jerry
$ isalt

In [1]: __opts__['id']
Out[1]: 'jerry'

$ isalt --sproxy

>>> sproxy
<function execute at 0x7fd394075510>
>>> sproxy('*', preview_target=True)
['router1',
 'router2']

>>> sproxy('router1', function='test.ping', static=True)
{'router1': True}
>>>

$ isalt -c /path/to/isalt/config/file

$ echo $ISALT_CFG_FILE
/path/to/isalt/config/file
$ isalt

$ echo $ALTERNATIVE_ISALT_CFG_FILE
/path/to/another/isalt/config/file
$ isalt -e ALTERNATIVE_ISALT_CFG_FILE

on_master: true
proxytype: dummy
proxy_cfg: /path/to/proxy/config
minion_cfg: /path/to/minion/config
master_cfg: /path/to/master/config