SaltStack之return与job管理

1. SaltStack组件之return

return组件可以理解为SaltStack系统对执行Minion返回后的数据进行存储或者返回给其他程序，它支持多种存储方式，比如用MySQL、MongoDB、Redis、Memcache等，通过return我们可以对SaltStack的每次操作进行记录，对以后日志审计提供了数据来源。目前官方已经支持30种return数据存储与接口，我们可以很方便的配置与使用它。当然也支持自己定义的return，自定义的return需由python来编写。在选择和配置好要使用的return后，只需在salt命令后面指定return即可。

//查看所有return列表
[root@master ~]# salt 'minion1' sys.list_returners
minion1:
    - carbon
    - couchdb
    - etcd
    - highstate
    - local
    - local_cache
    - mattermost
    - multi_returner
    - pushover
    - rawfile_json
    - slack
    - slack_webhook
    - smtp
    - splunk
    - sqlite3
    - syslog
    - telegram

官方return：https://docs.saltproject.io/en/latest/ref/returners/index.html

1.1 return流程

return是在Master端触发任务，然后Minion接受处理任务后直接与return存储服务器建立连接，然后把数据return存到存储服务器。关于这点一定要注意，因为此过程都是Minion端操作存储服务器，所以要确保Minion端的配置跟依赖包是正确的，这意味着我们将必须在每个Minion上安装指定的return方式依赖包，假如使用Mysql作为return存储方式，那么我们将在每台Minion上安装python-mysql模块。

1.2 使用mysql作为return存储方式

在所有minion上安装Mysql-python模块

[root@master ~]# salt 'minion1' pkg.install python3-PyMySQL
minion1:
    ----------
    python3-PyMySQL:
        ----------
        new:
            0.10.1-2.module_el8.5.0+761+faacb0fb
        old:
    python3-cffi:
        ----------
        new:
            1.11.5-5.el8
        old:
    python3-cryptography:
        ----------
        new:
            3.2.1-5.el8
        old:
    python3-ply:
        ----------
        new:
            3.9-9.el8
        old:
    python3-pycparser:
        ----------
        new:
            2.14-14.el8
        old:

部署一台mysql服务器用作存储服务器，此处就直接在192.168.47.158这台主机上部署

[root@mysql ~]# yum -y install mariadb mariadb-server
[root@mysql ~]# systemctl enable --now mariadb
[root@mysql ~]# ss -antl
State    Recv-Q   Send-Q     Local Address:Port       Peer Address:Port   Process   
LISTEN   0        128              0.0.0.0:22              0.0.0.0:*                
LISTEN   0        80                     *:3306                  *:*                
LISTEN   0        128                 [::]:22                 [::]:*  




//创建数据库和表结构
[root@mysql ~]# mysql
Welcome to the MariaDB monitor.  Commands end with ; or \g.
Your MariaDB connection id is 8
Server version: 10.3.28-MariaDB MariaDB Server #这里不用复制，从下面开始复制

CREATE DATABASE  `salt`
  DEFAULT CHARACTER SET utf8
  DEFAULT COLLATE utf8_general_ci;

USE `salt`;

--
-- Table structure for table `jids`
--

DROP TABLE IF EXISTS `jids`;
CREATE TABLE `jids` (
  `jid` varchar(255) NOT NULL,
  `load` mediumtext NOT NULL,
  UNIQUE KEY `jid` (`jid`)
) ENGINE=InnoDB DEFAULT CHARSET=utf8;

--
-- Table structure for table `salt_returns`
--

DROP TABLE IF EXISTS `salt_returns`;
CREATE TABLE `salt_returns` (
  `fun` varchar(50) NOT NULL,
  `jid` varchar(255) NOT NULL,
  `return` mediumtext NOT NULL,
  `id` varchar(255) NOT NULL,
  `success` varchar(10) NOT NULL,
  `full_ret` mediumtext NOT NULL,
  `alter_time` TIMESTAMP DEFAULT CURRENT_TIMESTAMP,
  KEY `id` (`id`),
  KEY `jid` (`jid`),
  KEY `fun` (`fun`)
) ENGINE=InnoDB DEFAULT CHARSET=utf8;

--
-- Table structure for table `salt_events`
--

DROP TABLE IF EXISTS `salt_events`;
CREATE TABLE `salt_events` (
`id` BIGINT NOT NULL AUTO_INCREMENT,
`tag` varchar(255) NOT NULL,
`data` mediumtext NOT NULL,
`alter_time` TIMESTAMP DEFAULT CURRENT_TIMESTAMP,
`master_id` varchar(255) NOT NULL,
PRIMARY KEY (`id`),
KEY `tag` (`tag`)
) ENGINE=InnoDB DEFAULT CHARSET=utf8;


//上面复制完成后，查看表
MariaDB [salt]> show tables;
+----------------+
| Tables_in_salt |
+----------------+
| jids           |
| salt_events    |
| salt_returns   |
+----------------+
3 rows in set (0.001 sec)

MariaDB [salt]> desc jids;
+-------+--------------+------+-----+---------+-------+
| Field | Type         | Null | Key | Default | Extra |
+-------+--------------+------+-----+---------+-------+
| jid   | varchar(255) | NO   | PRI | NULL    |       |
| load  | mediumtext   | NO   |     | NULL    |       |
+-------+--------------+------+-----+---------+-------+
2 rows in set (0.001 sec)
//授权
MariaDB [salt]> grant all on salt.* to 'salt'@'%' identified by 'salt';
Query OK, 0 rows affected (0.000 sec)
//刷新
MariaDB [salt]> flush privileges;
Query OK, 0 rows affected (0.000 sec)

配置minion

//能登陆就能存储
[root@minion1 ~]# yum -y install mariadb
[root@minion1 ~]# mysql -usalt -psalt -h192.168.47.158
Welcome to the MariaDB monitor.  Commands end with ; or \g.
Your MariaDB connection id is 11
Server version: 10.3.28-MariaDB MariaDB Server

Copyright (c) 2000, 2018, Oracle, MariaDB Corporation Ab and others.

Type 'help;' or '\h' for help. Type '\c' to clear the current input statement.

MariaDB [(none)]> quit
Bye


[root@minion1 ~]# vim /etc/salt/minion
......省
#  - slack
mysql.host: '192.168.47.158' #主机是MySQL存储服务器主机
mysql.user: 'salt'
mysql.pass: 'salt'
mysql.db: 'salt'
mysql.port: 3306
[root@minion1 ~]# systemctl restart salt-minion
[root@master ~]# salt minion1 test.ping
minion1:
    True

在Master上测试存储到mysql中

//查看表一开始没有东西的，
MariaDB [salt]> show tables;
+----------------+
| Tables_in_salt |
+----------------+
| jids           |
| salt_events    |
| salt_returns   |
+----------------+
3 rows in set (0.000 sec)

MariaDB [salt]> select * from salt_returns; #所有数据缓存到salt_returns里，所以查看这个表
Empty set (0.000 sec)

在Master上测试存储到mysql中

//测试，添加东西
[root@master ~]# salt 'minion1' test.ping --return mysql #在minion里没有取消注释，所以这里得指定return
minion1:
    True

在数据库中查询

MariaDB [salt]> select * from salt_returns\G
*************************** 1. row ***************************
       fun: test.ping
       jid: 20211105144353897141
    return: true
        id: minion1
   success: 1
  full_ret: {"success": true, "return": true, "retcode": 0, "jid": "20211105144353897141", "fun": "test.ping", "fun_args": [], "id": "minion1"}
alter_time: 2021-11-05 22:43:54
1 row in set (0.000 sec)

2. job cache

2.1 job cache流程

return时是由Minion直接与存储服务器进行交互，因此需要在每台Minion上安装指定的存储方式的模块，比如python-mysql，那么我们能否直接在Master上就把返回的结果给存储到存储服务器呢？

答案是肯定的，这种方式被称作 job cache 。意思是当Minion将结果返回给Master后，由Master将结果给缓存在本地，然后将缓存的结果给存储到指定的存储服务器，比如存储到mysql中。

开启master端的master_job_cache
注意：开启job cache之前得把return关掉

//这是默认数据存放在master上得位置，默认存储24个小时
[root@master ~]# ls /var/cache/salt/master/jobs/
00  0c  15  1e  30  3a  4f  60  6c  76  86  8f  a4  b4  c1  cd  d6  df  e9  f8
01  0d  16  23  31  42  50  63  6d  77  87  90  a6  b7  c3  ce  d7  e3  ef  fb
02  0e  17  24  32  45  5a  64  70  78  8a  98  a7  b8  c4  cf  d8  e4  f1  fc
03  0f  19  2a  33  47  5b  68  71  7b  8b  9c  ab  b9  c8  d0  db  e5  f4  ff
06  10  1a  2c  34  4b  5c  69  73  82  8c  9d  ac  bc  c9  d2  dc  e6  f5
07  14  1d  2d  35  4c  5f  6a  75  84  8d  a0  b0  c0  cc  d5  dd  e8  f7

[root@master ~]# vim /etc/salt/master
#job_cache: True #这是开启默认数据存放得位置
master_job_cache: mysql  #相当于上面return上那个没有注释的那个，添加此项后数据默认存到MySQL
mysql.host: '192.168.47.158'
mysql.user: 'salt'
mysql.pass: 'salt'
mysql.db: 'salt'
mysql.port: 3306

测试master能否连到mysql储存端

[root@master ~]# yum -y install mariadb
[root@master ~]# which mysql
/usr/bin/mysql
[root@master ~]# mysql -usalt -psalt -h192.168.47.158
Welcome to the MariaDB monitor.  Commands end with ; or \g.
Your MariaDB connection id is 14
Server version: 10.3.28-MariaDB MariaDB Server

Copyright (c) 2000, 2018, Oracle, MariaDB Corporation Ab and others.

Type 'help;' or '\h' for help. Type '\c' to clear the current input statement.

MariaDB [(none)]> 

注意

//使用return时需要所有minion安装python3-MyMSQL包，但是使用job只需要master装，千万不要忘记，会报错
[root@master ~]# yum -y install python3-PyMySQL

在数据库服务器中清空表内容

MariaDB [salt]> delete from salt_returns;
Query OK, 1 row affected (0.001 sec)

MariaDB [salt]> select * from salt_returns\G
Empty set (0.000 sec)

在master上再次测试能否存储至数据库

[root@master ~]# salt 'minion1' cmd.run 'cat /root/aaa'
minion1:
    世界灿烂盛大
    欢迎回家

在数据库中查询

MariaDB [salt]> select * from salt_returns\G
*************************** 1. row ***************************
       fun: cmd.run
       jid: 20211105152851491993
    return: "世界灿烂盛大\n欢迎回家"
        id: minion1
   success: 1
  full_ret: {"cmd": "_return", "id": "minion1", "success": true, "return": "世界灿烂盛大\n欢迎回家", "retcode": 0, "jid": "20211105152851491993", "fun": "cmd.run", "fun_args": ["cat /root/aaa"], "_stamp": "2021-11-05T15:28:51.687976"}
alter_time: 2021-11-05 23:28:52
1 row in set (0.000 sec)

2.2 job管理

2.2.1 获取任务的jid

##可以显示任务的Jid，-v 显示命令执行的详细过程
[root@master ~]# salt 'minion1' cmd.run 'uptime' -v
Executing job with jid 20211105153026292134
-------------------------------------------

minion1:
     23:30:26 up  2:37,  2 users,  load average: 0.12, 0.08, 0.05

通过jid获取此任务的返回结果

[root@master ~]# salt-run jobs.lookup_jid 20211105153026292134
minion1:
     23:30:26 up  2:37,  2 users,  load average: 0.12, 0.08, 0.05

2.2.2 jobs.lookup_jid

当作业被执行时，返回的数据被发送回主服务器并被缓存。默认情况下，它会缓存 24 小时，但这可以通过keep_jobs主配置中的 选项进行配置。使用 lookup_jid runner 将显示与使用 salt 命令进行初始作业调用将显示的相同返回数据。

[root@master ~]# salt-run jobs.lookup_jid 20211105154924183416

minion1:
     23:49:24 up 9 min,  2 users,  load average: 0.20, 0.14, 0.09

2.2.3 jobs.list_jobs

在查找历史工作之前，可能需要查找工作 ID。list_jobs 将解析缓存的执行数据并显示已经或部分返回的作业的所有作业数据。

[root@master ~]# salt-run jobs.list_jobs
20211105152851491993:
    ----------
    Arguments:
        - cat /root/aaa
    Function:
        cmd.run
    StartTime:
        2021, Nov 05 15:28:51.491993
    Target:
        minion1
    Target-type:
        glob
    User:
        root
20211105153026292134:
    ----------
    Arguments:
        - uptime
    Function:
        cmd.run
    StartTime:
        2021, Nov 05 15:30:26.292134
    Target:
        minion1
    Target-type:
        glob
    User:
        root
20211105153140762077:
    ----------