saltstack之return与job管理

saltstack组件之return

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

[root@master ~]# salt node1 sys.list_returners
node1:
    - 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存储方式

在node1minion上安装Mysql-python模块

[root@node1 ~]# yum list all|grep -i 'mysql'|grep python
python2-PyMySQL.noarch                                 0.8.0-10.module_el8.4.0+642+1dc4fb01              AppStream        
python3-PyMySQL.noarch                                 0.10.1-2.module_el8.4.0+666+456f5f48              AppStream        
python38-PyMySQL.noarch                                0.10.1-1.module_el8.4.0+677+b84873a2              AppStream        
python39-PyMySQL.noarch                                0.10.1-2.module_el8.4.0+680+7b309a77              AppStream        

[root@master ~]# salt node1 pkg.install python3-PyMySQL
node1:
    ----------
    python3-PyMySQL:
        ----------
        new:
            0.10.1-2.module_el8.4.0+666+456f5f48
        old:
[root@master ~]# salt node1 cmd.run 'rpm -qa|grep python3-PyMySQL'
node1:
    python3-PyMySQL-0.10.1-2.module_el8.4.0+666+456f5f48.noarch

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

[root@node2 ~]# yum -y install mariadb*
[root@node2 ~]# systemctl enable --now mariadb
Created symlink /etc/systemd/system/mysql.service → /usr/lib/systemd/system/mariadb.service.
Created symlink /etc/systemd/system/mysqld.service → /usr/lib/systemd/system/mariadb.service.
Created symlink /etc/systemd/system/multi-user.target.wants/mariadb.service → /usr/lib/systemd/system/mariadb.service.

[root@node2 ~]# 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

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;
Query OK, 1 row affected (0.000 sec)

MariaDB [(none)]> use salt
Database changed
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]> 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.006 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)

//测试
[root@node1 ~]# yum -y install mariadb
[root@node1 ~]# mysql -usalt -psalt -h192.168.111.145
Welcome to the MariaDB monitor.  Commands end with ; or \g.
Your MariaDB connection id is 10
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)]> 

配置minion

[root@node1 ~]# vim /etc/salt/minion
mysql.host: '192.168.111.145'  //存储服务器ip
mysql.user: 'salt'
mysql.pass: 'salt'
mysql.db: 'salt'
mysql.port: 3306

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

在Master上测试存储到mysql中

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

在数据库中查询

MariaDB [salt]> select * from salt_returns\G
*************************** 1. row ***************************
       fun: test.ping
       jid: 20211107165123318949
    return: true
        id: node1
   success: 1
  full_ret: {"success": true, "return": true, "retcode": 0, "jid": "20211107165123318949", "fun": "test.ping", "fun_args": [], "id": "node1"}
alter_time: 2021-11-08 00:14:50
1 row in set (0.001 sec)

MariaDB [salt]> 

job cache

job cache流程

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

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

[root@master ~]# yum -y install python3-PyMySQL
[root@master ~]# vim /etc/salt/master
master_job_cache: mysql
mysql.host: '192.168.200.134'
mysql.user: 'salt'
mysql.pass: 'salt'
mysql.db: 'salt'
mysql.port: 3306
[root@master ~]# systemctl restart salt-master.service

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

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

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

MariaDB [(none)]> 

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

[root@master ~]# salt node1 cmd.run 'df -h'
node1:
    Filesystem             Size  Used Avail Use% Mounted on
    devtmpfs               883M     0  883M   0% /dev
    tmpfs                  901M   40K  901M   1% /dev/shm
    tmpfs                  901M  8.7M  892M   1% /run
    tmpfs                  901M     0  901M   0% /sys/fs/cgroup
    /dev/mapper/rhel-root   17G  2.5G   15G  15% /
    /dev/nvme0n1p1        1014M  179M  836M  18% /boot
    tmpfs                  181M     0  181M   0% /run/user/0

在数据库中查询

MariaDB [(none)]> select * from salt.salt_returns\G
*************************** 1. row ***************************
       fun: cmd.run
       jid: 20211106073325547944
    return: "Filesystem             Size  Used Avail Use% Mounted on\ndevtmpfs               1.9G     0  1.9G   0% /dev\ntmpfs                  1.9G   60K  1.9G   1% /dev/shm\ntmpfs                  1.9G  9.0M  1.9G   1% /run\ntmpfs                  1.9G     0  1.9G   0% /sys/fs/cgroup\n/dev/mapper/rhel-root   50G  2.1G   48G   5% /\n/dev/mapper/rhel-home  145G  1.1G  144G   1% /home\n/dev/nvme0n1p1        1014M  179M  836M  18% /boot\ntmpfs                  376M     0  376M   0% /run/user/0"
        id: node1
   success: 1
  full_ret: {"cmd": "_return", "id": "node1", "success": true, "return": "Filesystem             Size  Used Avail Use% Mounted on\ndevtmpfs               1.9G     0  1.9G   0% /dev\ntmpfs                  1.9G   60K  1.9G   1% /dev/shm\ntmpfs                  1.9G  9.0M  1.9G   1% /run\ntmpfs                  1.9G     0  1.9G   0% /sys/fs/cgroup\n/dev/mapper/rhel-root   50G  2.1G   48G   5% /\n/dev/mapper/rhel-home  145G  1.1G  144G   1% /home\n/dev/nvme0n1p1        1014M  179M  836M  18% /boot\ntmpfs                  376M     0  376M   0% /run/user/0", "retcode": 0, "jid": "20211106073325547944", "fun": "cmd.run", "fun_args": ["df -h"], "_stamp": "2021-11-06T07:33:25.789413"}
alter_time: 2021-11-06 15:33:25
1 row in set (0.000 sec)

job管理

获取任务的jid

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

[WARNING ] Returner unavailable: (2003, "Can't connect to MySQL server on '192.168.200.134' (timed out)")
node1:
     01:02:57 up  2:55,  1 user,  load average: 0.00, 0.00, 0.00

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

[root@master ~]# salt-run jobs.lookup_jid 20211107170247785173
node1:
     01:02:57 up  2:55,  1 user,  load average: 0.00, 0.00, 0.00