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
minion01:
    - carbon
    - couchdb
    - etcd
    - highstate
    - local
    - local_cache
    - mattermost
    - multi_returner
    - pushover
    - rawfile_json
    - slack
    - slack_webhook
    - smtp
    - splunk
    - sqlite3
    - syslog
    - telegram
minion02:
    - carbon
    - couchdb
    - etcd
    - highstate
    - local
    - local_cache
    - mattermost
    - multi_returner
    - pushover
    - rawfile_json
    - slack
    - slack_webhook
    - smtp
    - splunk
    - sqlite3
    - syslog
    - telegram

return流程

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

使用mysql作为return存储方式

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

[root@master ~]# salt '*' pkg.install python3-PyMySQL
minion01:
    ----------
    python3-PyMySQL:
        ----------
        new:
            0.10.1-2.module_el8.4.0+666+456f5f48
        old:

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

[root@localhost ~]# yum -y install mariadb mariadb-server

[root@localhost ~]# systemctl enable --now mariadb

创建数据库和表结构
MariaDB [(none)]> CREATE DATABASE  `salt`
    -> DEFAULT CHARACTER SET utf8
    -> DEFAULT COLLATE utf8_general_ci;
Query OK, 1 row affected (0.000 sec)

MariaDB [(none)]> use 'salt';  //进入数据库
Database changed

MariaDB [salt]> DROP TABLE IF EXISTS `jids`;
Query OK, 0 rows affected, 1 warning (0.001 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.006 sec)


MariaDB [salt]> DROP TABLE IF EXISTS `salt_returns`;
Query OK, 0 rows affected, 1 warning (0.000 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.041 sec)


MariaDB [salt]> DROP TABLE IF EXISTS `salt_events`;
Query OK, 0 rows affected, 1 warning (0.000 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.006 sec)


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


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

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

在minion01上安装mariadb进行测试

[root@minion01 ~]# yum -y install mariadb
[root@minion01 ~]# mysql -usalt -psalt -h 192.168.182.143

配置minion01

[root@minion01 ~]# vim /etc/salt/minion
mysql.host: '192.168.182.143'  //用来存储的数据库主机的IP地址
mysql.user: 'salt'
mysql.pass: 'salt'
mysql.db: 'salt'
mysql.port: 3306

[root@minion01 ~]# systemctl restart salt-minion.service

在master上测试存储到mysql中

[root@master ~]# salt '*' test.ping  
minion01:
    True

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

在Master上测试存储到mysql中

MariaDB [salt]> select * from salt_returns\G
*************************** 1. row ***************************
       fun: test.ping
       jid: 20211106090212085114
    return: true
        id: minion01
   success: 1
  full_ret: {"success": true, "return": true, "retcode": 0, "jid": "20211106090212085114", "fun": "test.ping", "fun_args": [], "id": "minion01"}
alter_time: 2021-11-06 17:02:12
1 row in set (0.001 sec)

job cache

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

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

开启master端的master_job_cache

关闭minion01上的return

[root@minion01 ~]# vim /etc/salt/minion
#mysql.host: '192.168.182.143'
#mysql.user: 'salt'
#mysql.pass: 'salt'
##mysql.db: 'salt'
#mysql.port: 3306
[root@minion01 ~]# systemctl restart salt-minion.service


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

[root@master ~]# systemctl restart salt-master.service

在要使用job cache必须安装python3-PyMySQL
[root@master ~]# yum -y install python3-PyMySQL
[root@master ~]# salt '*' test.ping
minion01:
    True

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

MariaDB [salt]> delete from salt_returns;
Query OK, 2 rows affected (0.040 sec)

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

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

[root@master ~]# salt "*" test.ping
minion01:
    True

MariaDB [salt]> select * from salt_returns\G
*************************** 1. row ***************************
       fun: test.ping
       jid: 20211106105510286783
    return: true
        id: minion01
   success: 1
  full_ret: {"cmd": "_return", "id": "minion01", "success": true, "return": true, "retcode": 0, "jid": "20211106105510286783", "fun": "test.ping", "fun_args": [], "_stamp": "2021-11-06T10:55:10.524486"}
alter_time: 2021-11-06 18:55:10
1 row in set (0.001 sec)


[root@master ~]# salt '*' cmd.run 'ls /opt'
minion01:
    file
    file01
    file01.bak
    test


MariaDB [salt]> select * from salt_returns\G
*************************** 1. row ***************************
       fun: test.ping
       jid: 20211106105510286783
    return: true
        id: minion01
   success: 1
  full_ret: {"cmd": "_return", "id": "minion01", "success": true, "return": true, "retcode": 0, "jid": "20211106105510286783", "fun": "test.ping", "fun_args": [], "_stamp": "2021-11-06T10:55:10.524486"}
alter_time: 2021-11-06 18:55:10
*************************** 2. row ***************************
       fun: cmd.run
       jid: 20211106105552672396
    return: "file\nfile01\nfile01.bak\ntest"
        id: minion01
   success: 1
  full_ret: {"cmd": "_return", "id": "minion01", "success": true, "return": "file\nfile01\nfile01.bak\ntest", "retcode": 0, "jid": "20211106105552672396", "fun": "cmd.run", "fun_args": ["ls /opt"], "_stamp": "2021-11-06T10:55:53.000269"}
alter_time: 2021-11-06 18:55:53
2 rows in set (0.001 sec)

job管理

获取任务的jid

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

minion01:
     18:58:00 up  4:02,  1 user,  load average: 0.00, 0.00, 0.00  //此处就是此命令的jid

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

[root@master ~]# salt-run jobs.lookup_jid 20211106105759452279
minion01:
     18:58:00 up  4:02,  1 user,  load average: 0.00, 0.00, 0.00

list_jobs 将解析缓存的执行数据并显示已经或部分返回的作业的所有作业数据

[root@master ~]# salt-run jobs.list_jobs
20211106104547659513:
    ----------
    Arguments:
    Function:
        test.ping
    StartTime:
        2021, Nov 06 10:45:47.659513
    Target:
        *
    Target-type:
        glob
    User:
        root
20211106105510286783:
    ----------
    Arguments:
    Function:
        test.ping
    StartTime:
        2021, Nov 06 10:55:10.286783
    Target:
        *
    Target-type:
        glob
    User:
        root
20211106105552672396:
    ----------
    Arguments:
        - ls /opt
    Function:
        cmd.run
    StartTime:
        2021, Nov 06 10:55:52.672396
    Target:
        *
    Target-type:
        glob
    User:
        root
20211106105759452279:
    ----------
    Arguments:
        - uptime
    Function:
        cmd.run
    StartTime:
        2021, Nov 06 10:57:59.452279
    Target:
        *
    Target-type:
        glob
    User:
        root
20211106110003339024:
    ----------
    Arguments:
    Function:
        runner.jobs.lookup_jid
    StartTime:
        2021, Nov 06 11:00:03.339024
    Target:
        master_master
    Target-type:
        list
    User:
        root
20211106110701863719:
    ----------
    Arguments:
    Function:
        runner.jobs.active
    StartTime:
        2021, Nov 06 11:07:01.863719
    Target:
        master_master
    Target-type:
        list
    User:
        root
20211106110732721807:
    ----------
    Arguments:
    Function:
        saltutil.running
    StartTime:
        2021, Nov 06 11:07:32.721807
    Target:
        *
    Target-type:
        glob
    User:
        root
20211106110846994548:
    ----------
    Arguments:
    Function:
        runner.jobs.active
    StartTime:
        2021, Nov 06 11:08:46.994548
    Target:
        master_master
    Target-type:
        list
    User:
        root
20211106110848797724:
    ----------
    Arguments:
    Function:
        saltutil.running
    StartTime:
        2021, Nov 06 11:08:48.797724
    Target:
        *
    Target-type:
        glob
    User:
        root