STORING JOB RESULTS IN AN EXTERNAL SYSTEM

After a job executes, job results are returned to the Salt Master by each Salt Minion. These results are stored in the?Default Job Cache.

作業執行后，作業結果由每個salt minion返回給salt master。這些結果存儲在默認作業緩存中。

In addition to the Default Job Cache, Salt provides two additional mechanisms to send job results to other systems (databases, local syslog, and others):

除了缺省的作業緩存之外，Salt還提供了兩種附加的機制來將作業結果發送給其他系統(數據庫、本地系統日志等):

• External Job Cache 外部job緩存
• Master Job Cache? Maste job緩存

The major difference between these two mechanism is from where results are returned (from the Salt Master or Salt Minion). Configuring either of these options will also make the?Jobs?Runner?functions?to automatically query the remote stores for information.

這兩種機制之間的主要區別是從結果返回(從salt master或salt minion)。配置這些選項中的任何一個也將使Jobs?Runner?functions能自動查詢遠程存儲的信息。

external job cache - minion-side returner

When an External Job Cache is configured, data is returned to the Default Job Cache on the Salt Master like usual, and then results are also sent to an External Job Cache using a Salt returner module running on the Salt Minion.

當配置外部作業緩存時，數據像往常一樣返回到salt master上的缺省作業緩存，然后使用在salt minion上運行的salt返回器模塊將結果發送到外部作業緩存。

• Advantages: Data is stored without placing additional load on the Salt Master.?優點：數據存儲，而不增加 Salt Master上的額外負載。
• Disadvantages: Each Salt Minion connects to the external job cache, which can result in a large number of connections. Also requires additional configuration to get returner module settings on all Salt Minions. 缺點：每個salt minion連接到外部作業緩存，這可能導致大量的連接。還需要額外的配置，以獲得返回模塊設置在所有salt minions。

master job cache - master-side returner

New in version 2014.7.0.

Instead of configuring an External Job Cache on each Salt Minion, you can configure the Master Job Cache to send job results from the Salt Master instead. In this configuration, Salt Minions send data to the Default Job Cache as usual, and then the Salt Master sends the data to the external system using a Salt returner module running on the Salt Master.

代替配置每個salt minion上的外部作業緩存，可以配置Master job cache以salt master發送作業結果。在這種配置中，salt? minion像往常一樣將數據發送到默認作業緩存，然后salt master使用運行在salt master上的salt返回器模塊將數據發送到外部系統。

• Advantages: A single connection is required to the external system. This is preferred for databases and similar systems.優點：外部系統需要一個連接。這對于數據庫和類似系統是優選的。
• Disadvantages: Places additional load on your Salt Master.?缺點：給你的salt master 增加額外的負擔。

configure an external or master job cache

step 1: understand salt returners 了解salt returners

Before you configure a job cache, it is essential to understand Salt returner modules ("returners"). Returners are pluggable Salt Modules that take the data returned by jobs, and then perform any necessary steps to send the data to an external system. For example, a returner might establish a connection, authenticate, and then format and transfer data.

在配置job cache之前，了解Salt returner 模塊("returners")是絕對有必要的。Returners?是可插拔的Salt模塊，它接收作業返回的數據，然后執行任何必要的步驟將數據發送到外部系統。例如，返回者可以建立連接、認證、然后格式化和傳輸數據。

The Salt Returner system provides the core functionality used by the External and Master Job Cache systems, and the same returners are used by both systems.

Salt Returnner系統提供External和Master Job Cache系統所使用的核心功能，并且兩個系統都使用相同的returnners。

Salt currently provides many different returners that let you connect to a wide variety of systems. A complete list is available at?all Salt returners. Each returner is configured differently, so make sure you read and follow the instructions linked from that page.

Salt目前提供了許多不同的returners, 讓你連接到各種各樣的系統。所有Salt returners都有一份完整的清單。每個return的配置不同，所以請務必閱讀并遵循從該頁面鏈接的指令。

For example, the MySQL returner requires: 比如，MySQL returnner的規定：

• A database created using provided schema (structure is available at?MySQL?returner)
• A user created with privileges to the database
• Optional SSL configuration

A simpler returner, such as Slack or HipChat, requires:

• An API key/version
• The target channel/room
• The username that should be used to send the message

step 2: configure the returner

After you understand the configuration and have the external system ready, the configuration requirements must be declared.

在了解配置并使外部系統準備好之后，必須聲明配置要求。

EXTERNAL JOB CACHE

The returner configuration settings can be declared in the Salt Minion configuration file, the Minion's pillar data, or the Minion's grains.

returner聲明設置可以在salt minion配置文件配置，Minion的pillar數據或Minion的grains聲明。?

If?external_job_cache?configuration settings are specified in more than one place, the options are retrieved in the following order. The first configuration location that is found is the one that will be used.

如果在多個地方指定外部 external_job_cache，則按以下順序檢索選項。找到的第一個配置位置是將被使用的位置。

• Minion configuration file
• Minion's grains
• Minion's pillar data

MASTER JOB CACHE

The returner configuration settings for the Master Job Cache should be declared in the Salt Master's configuration file.

Master Job Cache 的返回器配置設置應在Salt Master'的配置文件中聲明。

CONFIGURATION FILE EXAMPLES

MySQL requires:

mysql.host: 'salt' mysql.user: 'salt' mysql.pass: 'salt' mysql.db: 'salt' mysql.port: 3306

Slack requires:

slack.channel: 'channel' slack.api_key: 'key' slack.from_name: 'name'

After you have configured the returner and added settings to the configuration file, you can enable the External or Master Job Cache.

在配置returnner并將配置添加到配置文件之后，可以啟用?External or Master Job Cache。

step 3: enable the external or master job cache

Configuration is a single line that specifies an already-configured returner to use to send all job data to an external system.

配置是一個單行，指定已配置的returner用于將所有作業數據發送到外部系統。

EXTERNAL JOB CACHE

To enable a returner as the External Job Cache (Minion-side), add the following line to the Salt Master configuration file:

若要使returner作為?External Job Cache (Minion-side)，請將以下行添加到Salt Master?配置文件中：

ext_job_cache: <returner>

For example:?例如：

ext_job_cache: mysql 注意： When configuring an External Job Cache (Minion-side), the returner settings are added to the Minion configuration file, but the External Job Cache setting is configured in the Master configuration file. 當配置 External Job Cache (Minion-side)時，將returner設置添加到 Minion配置文件中，但 External Job Cache設置在Master配置文件中配置。

master job cache

To enable a returner as a Master Job Cache (Master-side), add the following line to the Salt Master configuration file:

若要使returner?作為Master Job Cache (Master-side), 請將以下行添加到Salt Master?配置文件中：?

master_job_cache: <returner>

For example:??例如：

master_job_cache: mysql

Verify that the returner configuration settings are in the Master configuration file, and be sure to restart the salt-master service after you make configuration changes. (service?salt-master?restart).

驗證returner配置設置在Master配置文件中，并確保在配置更改之后重新啟動?salt-master?服務。（service?salt-master?restart）。

轉載于:https://www.cnblogs.com/zuoyang/p/9254379.html

總結

以上是生活随笔為你收集整理的【SaltStack官方版】—— STORING JOB RESULTS IN AN EXTERNAL SYSTEM的全部內容，希望文章能夠幫你解決所遇到的問題。

如果覺得生活随笔網站內容還不錯，歡迎將生活随笔推薦給好友。