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@zzl01 ~]# salt '*' sys.list_returners
192.168.20.135:
    - carbon
    - couchdb
    - elasticsearch
    - 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@zzl01 ~]# salt '*' pkg.install MySQL-python
192.168.20.135:
    ----------
    MySQL-python:
        ----------
        new:
            1.2.5-1.el7
        old:
[root@zzl01 ~]# salt '*' cmd.run 'rpm -qa|grep -i mysql-python'
192.168.20.135:
    MySQL-python-1.2.5-1.el7.x86_64

部署一台mysql服务器用作存储服务器

[root@mariadb ~]# yum -y install mariadb-server
[root@mariadb ~]# systemctl enable --now mariadb

[root@mariadb ~]# mysql
Welcome to the MariaDB monitor.  Commands end with ; or \g.
Your MariaDB connection id is 201
Server version: 5.5.65-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;

USE `salt`;

MariaDB [salt]>CREATE TABLE `jids` (
  `jid` varchar(255) NOT NULL,
  `load` mediumtext NOT NULL,
  UNIQUE KEY `jid` (`jid`)
) ENGINE=InnoDB DEFAULT CHARSET=utf8;

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;

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;

MariaDB [salt]> show tables;
+----------------+
| Tables_in_salt |
+----------------+
| jids           |
| salt_events    |
| salt_returns   |
+----------------+
3 rows in set (0.00 sec)


\\授权登入
MariaDB [salt]> grant all on salt.* to salt@'%' identified by 'salt'；

MariaDB [salt]> flush privileges；

配置minion

[root@zzl02 ~]# vim /etc/salt/minion
mysql.host: '192.168.20.120'    //安装mysql主机ip地址
mysql.user: 'salt'
mysql.pass: 'salt'
mysql.db: 'salt'
mysql.port: 3306

[root@zzl02 ~]# systemctl restart salt-minion

在Master上测试存储到mysql中

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

在数据库中查询

MariaDB [salt]> select * from salt_returns\G
*************************** 1. row ***************************
       fun: test.ping
       jid: 20200824101635392254
    return: true
        id: 192.168.20.135
   success: 1
  full_ret: {"fun_args": [], "jid": "20200824101635392254", "return": true, "retcode": 0, "success": true, "cmd": "_return", "_stamp": "2020-08-24T10:16:35.819296", "fun": "test.ping", "id": "192.168.20.135"}
alter_time:  2020-08-24 18:16:35

2. job cache

2.1 job cache流程

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

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

开启master端的master_job_cache

[root@zzl01 ~]# yum -y install MySQL-python

[root@zzl01 ~]# vim /etc/salt/master
master_job_cache: mysql
mysql.host: '192.168.20.120'
mysql.user: 'salt'
mysql.pass: 'salt'
mysql.db: 'salt'
mysql.port: 3306

[root@zzl01 ~]# systemctl restart salt-master

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

[root@zzl01 ~]# salt '*' cmd.run 'df -h'
192.168.20.135:
    Filesystem      Size  Used Avail Use% Mounted on
    /dev/sda3        16G  5.9G  8.5G  41% /
    devtmpfs        903M     0  903M   0% /dev
    tmpfs           912M  120K  912M   1% /dev/shm
    tmpfs           912M  8.7M  903M   1% /run
    tmpfs           912M     0  912M   0% /sys/fs/cgroup
    /dev/sda1       477M  104M  344M  24% /boot
    tmpfs           183M     0  183M   0% /run/user/

在数据库中查询

MariaDB [salt]> select * from salt_returns\G
*************************** 1. row ***************************
       fun: cmd.run
       jid: 20200824103402657388
    return: "Filesystem      Size  Used Avail Use% Mounted on\n/dev/sda3        16G  5.9G  8.5G  41% /\ndevtmpfs        903M     0  903M   0% /dev\ntmpfs           912M  120K  912M   1% /dev/shm\ntmpfs           912M  8.7M  903M   1% /run\ntmpfs           912M     0  912M   0% /sys/fs/cgroup\n/dev/sda1       477M  104M  344M  24% /boot\ntmpfs           183M     0  183M   0% /run/user/0"
        id: 192.168.20.135
   success: 1
  full_ret: {"fun_args": ["df -h"], "jid": "20200824103402657388", "return": "Filesystem      Size  Used Avail Use% Mounted on\n/dev/sda3        16G  5.9G  8.5G  41% /\ndevtmpfs        903M     0  903M   0% /dev\ntmpfs           912M  120K  912M   1% /dev/shm\ntmpfs           912M  8.7M  903M   1% /run\ntmpfs           912M     0  912M   0% /sys/fs/cgroup\n/dev/sda1       477M  104M  344M  24% /boot\ntmpfs           183M     0  183M   0% /run/user/0", "retcode": 0, "success": true, "cmd": "_return", "_stamp": "2020-08-24T10:34:02.872451", "fun": "cmd.run", "id": "192.168.20.135"}
alter_time: 2020-08-24 18:34:02
1 row in set (0.00 sec)

MariaDB [salt]> 

2.2 job管理

获取任务的jid

[root@zzl01 ~]# salt '*' cmd.run 'uptime' -v
Executing job with jid 20200824103723789296
-------------------------------------------

192.168.20.135:
     01:48:55 up  4:27,  2 users,  load average: 0.01, 0.03, 0.05

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

[root@zzl01 ~]# salt-run jobs.lookup_jid 20200824103723789296
192.168.20.135:
     01:48:55 up  4:27,  2 users,  load average: 0.01, 0.03, 0.05