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 '*' sys.list_returners
slave1:
    - carbon
    - couchdb
    - etcd
    - highstate
    - local
    - local_cache
    - mattermost
    - multi_returner
    - pushover
    - rawfile_json
    - slack
    - slack_webhook
    - smtp
    - splunk
    - sqlite3
    - syslog
    - telegram

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 '*' pkg.install python3-PyMySQL
slave1:
    ----------
    python3-PyMySQL:
        ----------
        new:
            0.10.1-2.module_el8.4.0+666+456f5f48
        old:
    python3-cffi:
        ----------
        new:
            1.11.5-5.el8
        old:
    python3-cryptography:
        ----------
        new:
            3.2.1-4.el8
        old:
    python3-ply:
        ----------
        new:
            3.9-9.el8
        old:
    python3-pycparser:
        ----------
        new:
            2.14-14.el8
        old:
[root@master ~]# salt '*' cmd.run 'rpm -qa|grep  python3-PyMySQL'
slave1:
    python3-PyMySQL-0.10.1-2.module_el8.4.0+666+456f5f48.noarch

部署一台mysql服务器用作存储服务器
return官方文档

//关闭防火墙，selinux并下载mariadb服务
[root@localhost ~]# yum -y install mariadb mariadb-server
[root@localhost ~]# systemctl enable --now mariadb
Created symlink from /etc/systemd/system/multi-user.target.wants/mariadb.service to /usr/lib/systemd/system/mariadb.service.
[root@localhost ~]# ss -antl
State       Recv-Q Send-Q                                                   Local Address:Port                                                                  Peer Address:Port              
LISTEN      0      50                                                                   *:3306                                                                             *:*                  
LISTEN      0      128                                                                  *:22                                                                               *:*                  
LISTEN      0      100                                                          127.0.0.1:25                                                                               *:*                  
LISTEN      0      128                                                                 :::22                                                                              :::*                  
LISTEN      0      100                                                                ::1:25                                                                              :::*           

[root@localhost ~]# mysql
Welcome to the MariaDB monitor.  Commands end with ; or \g.
Your MariaDB connection id is 2
Server version: 5.5.68-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)]> CREATE DATABASE  `salt`  //按照官方文档创建表，这里提前创建过所以报错
    ->   DEFAULT CHARACTER SET utf8
    ->   DEFAULT COLLATE utf8_general_ci;
ERROR 1007 (HY000): Can't create database 'salt'; database exists
MariaDB [(none)]> show databases;
+--------------------+
| Database           |
+--------------------+
| information_schema |
| mysql              |
| performance_schema |
| salt               |
| test               |
+--------------------+
5 rows in set (0.00 sec)

MariaDB [(none)]> use salt;
Database changed
MariaDB [salt]> show tables;
Empty set (0.00 sec)

MariaDB [salt]> DROP TABLE IF EXISTS `jids`;
Query OK, 0 rows affected, 1 warning (0.00 sec)

MariaDB [salt]> CREATE TABLE `jids` (
    ->   `jid` varchar(255) NOT NULL,
    ->   `load` mediumtext NOT NULL,
    ->   UNIQUE KEY `jid` (`jid`)
    -> ) ENGINE=InnoDB DEFAULT CHARSET=utf8;
Query OK, 0 rows affected (0.00 sec)

MariaDB [salt]> DROP TABLE IF EXISTS `salt_returns`;
Query OK, 0 rows affected, 1 warning (0.00 sec)

MariaDB [salt]> 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;
Query OK, 0 rows affected (0.00 sec)

MariaDB [salt]> DROP TABLE IF EXISTS `salt_events`;
Query OK, 0 rows affected, 1 warning (0.00 sec)

MariaDB [salt]> 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;
Query OK, 0 rows affected (0.00 sec)

//刷新访问权限
MariaDB [salt]> grant all on salt.* to salt@'%' identified by 'salt';
Query OK, 0 rows affected (0.00 sec)

MariaDB [salt]> flush privileges;
Query OK, 0 rows affected (0.00 sec)

配置minion

//在minion端配置
[root@slave1 ~]# vim /etc/salt/minion
927 #return:
928 #  - mysql
929 #  - hipchat
930 #  - slack
//添加以下几行
931 mysql.host: '192.168.216.215' //写数据库服务器
932 mysql.user: 'salt'
933 mysql.pass: 'salt'
934 mysql.db: 'salt'
935 mysql.port: 3306
936 

//重启生效
[root@slave1 ~]# systemctl restart salt-minion

在Master上测试存储到mysql中

[root@master ~]# salt '*' test.ping --return mysql
slave1:
    True

在数据库中查询

MariaDB [salt]> select * from salt_returns\G
*************************** 1. row ***************************
       fun: test.ping
       jid: 20211105083221559575
    return: true
        id: slave1
   success: 1
  full_ret: {"success": true, "return": true, "retcode": 0, "jid": "20211105083221559575", "fun": "test.ping", "fun_args": [], "id": "slave1"}
alter_time: 2021-11-05 16:32:21
1 row in set (0.00 sec)

2. job cache

2.1 job cache流程

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

答案是肯定的，这种方式被称作 job cache 。意思是当Minion将结果返回给Master后，由Master将结果给缓存在本地，然后将缓存的结果给存储到指定的存储服务器，比如存储到mysql中,比较return，能将负载给master，减轻minion负担，并且minion端不用安装包。

job_cache官方文档
开启master端的master_job_cache
注意先关闭minion上的return，也就是删除原来添加的几行，重启minion

//在master上配置
[root@master ~]# vim /etc/salt/master
 137 #job_cache: True
 //添加以下几行
 138 master_job_cache: mysql
 139 mysql.host: '192.168.216.215'
 140 mysql.user: 'salt'
 141 mysql.pass: 'salt'
 142 mysql.db: 'salt'
 143 mysql.port: 3306

//重启
[root@master ~]# systemctl restart salt-master


//安装包不然连接不上mysql
[root@master ~]# yum -y install python3-PyMySQL

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

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

MariaDB [salt]> select * from salt.salt_returns;
Empty set (0.00 sec)

测试

//随便执行一条命令，后面不用跟return
[root@master ~]# salt '*' cmd.run 'ls'
slave1:
    abc
    anaconda-ks.cfg
    b
    ha
    hah
    haha

在数据库中查询

MariaDB [salt]> select * from salt.salt_returns\G;
*************************** 1. row ***************************
       fun: cmd.run
       jid: 20211105090437682720
    return: "abc\nanaconda-ks.cfg\nb\nha\nhah\nhaha"
        id: slave1
   success: 1
  full_ret: {"cmd": "_return", "id": "slave1", "success": true, "return": "abc\nanaconda-ks.cfg\nb\nha\nhah\nhaha", "retcode": 0, "jid": "20211105090437682720", "fun": "cmd.run", "fun_args": ["ls"], "_stamp": "2021-11-05T09:04:37.835429"}
alter_time: 2021-11-05 17:04:37
1 row in set (0.00 sec)

2.2 job管理

-v 返回jobid
[root@master ~]# salt '*' test.ping -v
Executing job with jid 20211105090630946370  //此处就是此命令的jid
-------------------------------------------

slave1:
    True

//通过jid获取此任务的返回结果
[root@master ~]# salt-run jobs.lookup_jid 20211105090630946370