SaltStack组件之return
return组件可以理解为SaltStack系统对执行Minion返回后的数据进行存储或者返回给其他程序,它支持多种存储方式,比如用MySQL、MongoDB、Redis、Memcache等,通过return我们可以对SaltStack的每次操作进行记录,对以后日志审计提供了数据来源。目前官方已经支持30种return数据存储与接口,我们可以很方便的配置与使用它。当然也支持自己定义的return,自定义的return需由python来编写。在选择和配置好要使用的return后,只需在salt命令后面指定return即可。
[root@master ~]# salt '*' sys.list_returners
node1:
- carbon
- couchdb
- etcd
- highstate
- local
- local_cache
- mattermost
- multi_returner
- mysql
- pushover
- rawfile_json
- slack
- slack_webhook
- smtp
- splunk
- sqlite3
- syslog
- telegram
[root@master ~]# salt '*' cmd.run 'rpm -qa|grep python3-PyMySQL'
node1:
python3-PyMySQL-0.10.1-2.module_el8.5.0+761+faacb0fb.noarch
return流程
return是在Master端触发任务,然后Minion接受处理任务后直接与return存储服务器建立连接,然后把数据return存到存储服务器。关于这点一定要注意,因为此过程都是Minion端操作存储服务器,所以要确保Minion端的配置跟依赖包是正确的,这意味着我们将必须在每个Minion上安装指定的return方式依赖包,假如使用Mysql作为return存储方式,那么我们将在每台Minion上安装python-mysql模块。
使用mysql作为return存储方式
部署一台mysql服务器用作存储服务器,此处就直接在192.168.100.30这台主机上部署
[root@master ~]# yum -y install python3-PyMySQL.noarch
[root@localhost ~]# yum -y install mariadb-server
[root@localhost ~]# systemctl start mariadb
[root@localhost ~]# 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 128 [::]:22 [::]:*
LISTEN 0 80 *:3306 *:*
//创建数据库和表结构
[root@localhost ~]# 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 [salt]> 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;
Query OK, 0 rows affected (0.003 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.003 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.003 sec)
MariaDB [salt]> show tables;
+----------------+
| Tables_in_salt |
+----------------+
| jids |
| salt_events |
| salt_returns |
+----------------+
3 rows in set (0.000 sec)
MariaDB [salt]> grant all on salt.* to salt@'%' identified by 'salt';
Query OK, 0 rows affected (0.002 sec)
MariaDB [salt]> flush privileges;
Query OK, 0 rows affected (0.000 sec)
配置minion
[root@node1 ~]# vim /etc/salt/minion
mysql.host: '192.168.100.30'
mysql.user: 'salt'
mysql.pass: 'salt'
mysql.db: 'salt'
mysql.port: 3306
[root@node1 ~]# systemctl restart salt-minion
在Master上测试存储到mysql中
[root@master ~]# salt '*' cmd.run 'date' --return mysql
node1:
Thu Jul 8 04:05:40 EDT 2021
在数据库中查询
MariaDB [salt]> select * from salt_returns\G
*************************** 1. row ***************************
fun: cmd.run
jid: 20210708080529363975
return: "Thu Jul 8 04:05:40 EDT 2021"
id: node1
success: 1
full_ret: {"success": true, "return": "Thu Jul 8 04:05:40 EDT 2021", "retcode": 0, "jid": "20210708080529363975", "fun": "cmd.run", "fun_args": ["date"], "id": "node1"}
alter_time: 2021-07-08 04:05:41
1 row in set (0.000 sec)
job cache
job cache流程
return时是由Minion直接与存储服务器进行交互,因此需要在每台Minion上安装指定的存储方式的模块,比如python-mysql,那么我们能否直接在Master上就把返回的结果给存储到存储服务器呢?
答案是肯定的,这种方式被称作 job cache 。意思是当Minion将结果返回给Master后,由Master将结果给缓存在本地,然后将缓存的结果给存储到指定的存储服务器,比如存储到mysql中。
开启master端的master_job_cache
[root@master ~]# vim /etc/salt/master
#job_cache: mysql
master_job_cache: mysql
mysql.host: '192.168.100.30'
mysql.user: 'salt'
mysql.pass: 'salt'
mysql.db: 'salt'
mysql.port: 3306
###### Miscellaneous settings ######
[root@master ~]# systemctl restart salt-master
在数据库中清空表内容
MariaDB [salt]> delete from salt.salt_returns;
Query OK, 1 row affected (0.002 sec)
MariaDB [salt]> select * from salt.salt_returns;
Empty set (0.000 sec)
在master上再次测试能否存储至数据库
[root@master ~]# salt '*' cmd.run 'ls -l /root'
node1:
total 20
-rw-r--r--. 1 root root 45 Jul 7 04:46 EOF
-rw-r--r--. 1 root root 17 Jul 7 02:28 abc
-rw-------. 1 root root 1270 Jul 1 11:52 anaconda-ks.cfg
d--------T. 2 zdj zdj 6 Jul 7 04:34 kk
-rwxr-xr-x. 1 root root 55 Jul 7 04:57 lala
-rw-r--r--. 1 root root 18 Jul 7 05:20 ll
-rw-r--r--. 1 root root 0 Jul 7 04:00 zdj
这里需要在master装一个软件包
[root@master ~]# yum -y install python3-PyMySQL.noarch
在数据库中查询
MariaDB [salt]> select * from salt.salt_returns\G
*************************** 1. row ***************************
fun: cmd.run
jid: 20210708081217230242
return: "total 20\n-rw-r--r--. 1 root root 45 Jul 7 04:46 EOF\n-rw-r--r--. 1 root root 17 Jul 7 02:28 abc\n-rw-------. 1 root root 1270 Jul 1 11:52 anaconda-ks.cfg\nd--------T. 2 zdj zdj 6 Jul 7 04:34 kk\n-rwxr-xr-x. 1 root root 55 Jul 7 04:57 lala\n-rw-r--r--. 1 root root 18 Jul 7 05:20 ll\n-rw-r--r--. 1 root root 0 Jul 7 04:00 zdj"
id: node1
success: 1
full_ret: {"cmd": "_return", "id": "node1", "success": true, "return": "total 20\n-rw-r--r--. 1 root root 45 Jul 7 04:46 EOF\n-rw-r--r--. 1 root root 17 Jul 7 02:28 abc\n-rw-------. 1 root root 1270 Jul 1 11:52 anaconda-ks.cfg\nd--------T. 2 zdj zdj 6 Jul 7 04:34 kk\n-rwxr-xr-x. 1 root root 55 Jul 7 04:57 lala\n-rw-r--r--. 1 root root 18 Jul 7 05:20 ll\n-rw-r--r--. 1 root root 0 Jul 7 04:00 zdj", "retcode": 0, "jid": "20210708081217230242", "fun": "cmd.run", "fun_args": ["ls -l /root"], "_stamp": "2021-07-08T08:12:17.506180"}
alter_time: 2021-07-08 04:12:17
1 row in set (0.000 sec)
job管理
获取任务的jid
[root@master ~]# salt '*' cmd.run 'date' -v
Executing job with jid 20210708101342903862
-------------------------------------------
node1:
Thu Jul 8 06:13:43 EDT 2021
[root@master ~]# salt '*' cmd.run 'date' -v
Executing job with jid 20210708101426334988
-------------------------------------------
node1:
Thu Jul 8 06:14:26 EDT 2021
通过jid获取此任务的返回结果
[root@master ~]# salt-run jobs.lookup_jid 20210708101426334988
node1:
Thu Jul 8 06:14:26 EDT 2021