Salt Bundle

1. Salt Bundleの概要

Salt Bundleは、Salt Minion、Python 3、必須のPythonモジュール、およびライブラリが含まれている1つのバイナリパッケージです。

Salt BundleはPython 3に付属していて、Saltを実行するためのすべての要件です。したがって、Salt Bundleは、システムソフトウェアとしてクライアントにインストールされているPythonバージョンを使用しません。Salt Bundleは、指定のSaltバージョンの要件を満たさないクライアントにインストールできます。

SUSE Multi-Linux Manager Salt Master以外のSalt Masterに接続されているSalt Minionを実行するシステムでSalt Bundleを使用することもできます。

2. Salt Bundleを使用してクライアントをMinionとして登録する

Salt Bundleを使用した登録方法は推奨の登録方法です。このセクションでは、現在の実装の利点と制約について説明します。

The Salt Bundle is provided as the venv-salt-minion package that consists of Salt, Python 3, and the Python modules Salt depends on.

Web UIを使用したブートストラップもSalt Bundleを使用しているため、Web UIを使用したブートストラップはPythonに依存しません。 Salt Bundleを使用すると、クライアントがPythonインタープリターまたはモジュールを提供する必要がなくなります。

If you bootstrap new clients, registration with the Salt Bundle is the default method. You can switch existing clients to the Salt Bundle method. If you switch, the salt-minion package and its dependencies will stay installed.

2.1. Salt Minionを使用したSalt Bundleの使用

The Salt Bundle can be used with the Salt Minion managed by the Salt Master other than SUSE Multi-Linux Manager Server at the same time. If the Salt Bundle is installed on a client SUSE Multi-Linux Manager Server will manage the configuration files of the Salt Bundle, the configuration files of salt-minion will not be managed in this case. For more information, see Salt Bundle configuration.

To bootstrap a client with the Salt Minion managed by the Salt Master other than SUSE Multi-Linux Manager Server it is recommended to use mgr-bootstrap --force-bundle when generating the bootstrap script, or to set FORCE_VENV_SALT_MINION to 1 in the bootstrap script.
For bootstrapping with Web UI mgr_force_venv_salt_minion set to true pillar can be specified globally. For more information, see Salt States and Pillars.

2.2. Salt MinionからSalt Bundleへの切り替え

The Salt state util.mgr_switch_to_venv_minion is available to switch from salt-minion to venv-salt-minion. It is recommended to switch to venv-salt-minion in two steps to avoid trouble with shifting processes:

Procedure: Switching with util.mgr_switch_to_venv_minion state to venv-salt-minion

Apply util.mgr_switch_to_venv_minion with no pillar specified first. This will result in the switch to venv-salt-minion with copying configuration files etc. It will not clean up the original salt-minion configurations and its packages.
```
salt <minion_id> state.apply util.mgr_switch_to_venv_minion
```
Apply util.mgr_switch_to_venv_minion with mgr_purge_non_venv_salt set to True to remove salt-minion and with mgr_purge_non_venv_salt_files set to True to remove all the files related to salt-minion. This second step ensures the first step was processed, and then removes the old configuration files and the now obsolete salt-minion package.
```
salt <minion_id> state.apply util.mgr_switch_to_venv_minion pillar='{"mgr_purge_non_venv_salt_files": True, "mgr_purge_non_venv_salt": True}'
```

2.3. 追加の懸念事項

In case of running the second step only and the first step, state apply process could fail as it requires stopping the salt-minion which is used to execute the command on the client side.
It is also possible to avoid installing the Salt Bundle and keep using salt-minion instead. In this case, specify one of these options:
- Execute mgr-bootstrap with --no-bundle option.
- Set AVOID_VENV_SALT_MINION to 1 in the generated bootstrap script.
- For bootstrap state set the mgr_avoid_venv_salt_minion pillar to True in /srv/pillar/salt_bundle_config.sls.

3. Salt BundleによるSSH Push

Salt Bundleは、クライアントに対してSSH Pushアクションを実行するときにも使用されます。

A shell script deploys the Salt Bundle onto the target system without installing venv-salt-minion before any Salt command is executed. Because the Salt Bundle contains the whole Salt code base, no salt-thin is deployed. SSH Push (including bootstrapping using the Web UI) uses the Python 3 interpreter within the bundle. The target system does not need to have any other Python interpreter installed.

Bundleを使用して配備されたPython 3は、クライアントでSSH Pushセッションを処理するために使用されるため、SSH Push (Web UIを使用したブートストラップを含む)は、システムにインストールされているPythonに依存しません。

Using salt-thin can be enabled as a fallback method, but it requires Python 3 to be installed on the client. This method is not recommended nor supported and exists for development purposes only. Set web.ssh_use_salt_thin to true in the /etc/rhn/rhn.conf configuration file.

ブートストラップリポジトリは、Web UIを使用してクライアントをブートストラップする前に作成済みである必要があります。SSH Pushは、検出したターゲットオペレーティングシステムに基づいてブートストラップリポジトリから取得されたSalt Bundleを使用しています。詳細については、client-configuration:bootstrap-repository.adoc#_prepare_to_create_a_bootstrap_repositoryを参照してください。
SSH Push is using /var/tmp to deploy Salt Bundle to and execute Salt commands on the client with the bundled Python. Therefore you must not mount /var/tmp with the noexec option. It is not possible to bootstrap the clients, which have /var/tmp mounted with noexec option, with the Web UI because the bootstrap process is using SSH Push to reach a client.

4. Extend Salt Bundle With Python Packages using `pip`

The Salt Bundle includes pip to make it possible to extend the functionality of the bundled Salt Minion with extra Python packages.

By default, salt <minion_id> pip.install <package-name> installs the Python package specified by <package_name> into /var/lib/venv-salt-minion/local.

If needed, the path /var/lib/venv-salt-minion/local can be overridden by setting the VENV_PIP_TARGET environment variable for the venv-salt-minion.service. It is recommended to use a systemd drop-in configuration file for the service. It could be done with the configuration file /etc/systemd/system/venv-salt-minion.service.d/10-pip-destination.conf:

[Service]
Environment=VENV_PIP_TARGET=/new/path/local/venv-salt-minion/pip

The Python packages installed through pip are not changing on updating the Salt Bundle. To ensure that such packages are available and functional after an update, it is recommended to install them with a Salt state that is applied after Salt Bundle updates.