saltstack之return与job管理

saltstack之return与job管理

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
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存储方式

环境说明

主机名	IP	服务
master	192.168.100.110	salt-master
node1	192.168.100.120	salt-minion mariadb
node2	192.168.100.150	mariadb mariadb-server

在node1上安装mariadb和python3-PyMySQL

[root@node1 ~]# yum -y install mariadb python3-PyMySQL

node2上安装mariadb-server mariadb

[root@node2 ~]# yum -y install mariadb-server mariadb
[root@node2 ~]# systemctl enable --now mariadb
[root@node2 ~]# 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          80                         *:3306                      *:*                    
LISTEN     0          128                     [::]:22                     [::]:* 

进入数据库设置密码

[root@node2 ~]# mysql
MariaDB [(none)]> set password = password('123456');
Query OK, 0 rows affected (0.001 sec)

MariaDB [(none)]> exit
Bye

创建数据库和表结构

[root@node2 ~]# mysql -uroot -p123456
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)]> CREATE DATABASE  `salt`
    -> DEFAULT CHARACTER SET utf8
    -> DEFAULT COLLATE utf8_general_ci;
Query OK, 1 row affected (0.001 sec)

MariaDB [(none)]> show databases;
+--------------------+
| Database           |
+--------------------+
| information_schema |
| mysql              |
| performance_schema |
| salt               |
+--------------------+
4 rows in set (0.001 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.008 sec)

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

修改node1上mariadb的配置文件

[root@node1 ~]# mysql -usalt -psalt -h192.168.100.150
Welcome to the MariaDB monitor.  Commands end with ; or \g.
Your MariaDB connection id is 17
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)]> exit
Bye

[root@node1 ~]# vim /etc/salt/minion
#return:
#  - mysql
#  - hipchat
#  - slack
mysql.host: '192.168.100.150'
mysql.user: 'salt'
mysql.pass: 'salt'
mysql.db: 'salt'
mysql.port: 3306

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

master上使用test.ping测试连通性

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

mariadb上查看是否有数据

[root@node2 ~]# mysql -uroot -p123456
Welcome to the MariaDB monitor.  Commands end with ; or \g.
Your MariaDB connection id is 18
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)]> select * from salt.salt_returns;
Empty set (0.001 sec)

master上测试存储到mariadb中

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

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

job cache

job cache流程

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

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

master默认的存储位置

[root@master ~]# cd /var/cache/salt/master/jobs/
[root@master jobs]# ls
01  11  1b  21  29  32  40  4e  5a  6b  7b  83  88  91  a0  aa  b4  c0  ca  d5  df  f0  fc
02  12  1d  22  2c  34  45  4f  5b  6c  7e  84  8a  94  a2  ad  b6  c1  cb  d9  e6  f2  ff
03  13  1e  24  2d  37  49  53  5e  73  7f  85  8e  95  a4  ae  bb  c5  cf  db  e9  f3
0b  16  1f  25  2f  38  4a  54  5f  76  80  86  8f  9a  a8  b2  be  c7  d0  dc  ea  f9
10  1a  20  27  30  3a  4c  57  68  77  82  87  90  9e  a9  b3  bf  c9  d3  de  ec  fa

关闭node1上的return功能

[root@node1 ~]# vim /etc/salt/minion
#return:
#  - mysql
#  - hipchat
#  - slack
#mysql.host: '192.168.100.150'
#mysql.user: 'salt'
#mysql.pass: 'salt'
#mysql.db: 'salt'
#mysql.port: 3306
[root@node1 ~]# systemctl restart salt-minion.service

开启master端的master_job_cache

[root@master ~]# yum -y install python3-PyMySQL

修改master的配置文件

[root@master ~]# vim /etc/salt/master
#job_cache: True
mysql.host: '192.168.100.150'
mysql.user: 'salt'
mysql.pass: 'salt'
mysql.db: 'salt'
mysql.port: 3306
[root@master ~]# systemctl restart salt-master.service 

测试连通性

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

master安装mariadb服务

[root@master ~]# yum -y install mariadb

[root@master ~]# mysql -usalt -psalt -h192.168.100.150
Welcome to the MariaDB monitor.  Commands end with ; or \g.
Your MariaDB connection id is 21
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)]> 

删除表中之前的数据

[root@node2 ~]# mysql -uroot -p123456
Welcome to the MariaDB monitor.  Commands end with ; or \g.
Your MariaDB connection id is 22
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)]> delete from salt.salt_returns;
Query OK, 1 row affected (0.002 sec)

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

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

[root@master ~]# salt node1 test.ping --return mysql
node1:
    True
    
MariaDB [(none)]> select * from salt.salt_returns\G
*************************** 1. row ***************************
       fun: test.ping
       jid: 20211107080577496739
    return: true
        id: node1
   success: 1
  full_ret: {"success": true, "return": true, "retcode": 0, "jid": "20211107080577496739", "fun": "test.ping", "fun_args": [], "id": "node1"}
alter_time: 2021-11-07 03:17:25
1 row in set (0.001 sec)

job管理

Salt 0.9.7 为管理作业的saltutil引入了一些新功能。这些功能是：

1. running返回在proc目录中找到的所有运行作业的数据
2. find_job根据工作id返回有关某项工作的具体数据
3. signal_job允许向给定夹具发送信号
4. term_job向控制指定作业的流程发送终止信号(SIGTERM,15)
5. kill_job向控制指定作业的流程发送杀伤信号(SIGKILL,9)

获取任务的jid

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

node1:
    Sun Nov  7 03:24:57 EST 2021

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

[root@master ~]# salt-run jobs.lookup_jid 20211107082457573822
node1:
    Sun Nov  7 03:24:57 EST 2021

列出正在执行的任务,可以通过上面的 kill_job jid 杀死一个正在执行的任务

[root@master ~]# salt-run jobs.active

列出执行过的任务

[root@master ~]# salt-run jobs.list_jobs
20211107065237647652:
    ----------
    Arguments:
    Function:
        sys.list_functions
    StartTime:
        2021, Nov 07 06:52:37.647652
    Target:
        *
    Target-type:
        glob
    User:
        root
20211107065336107756:
    ----------
    Arguments:
        - /root/abc
    Function:
        file.touch
    StartTime:
        2021, Nov 07 06:53:36.107756
    Target:
        node1
    Target-type:
        glob
    User:
        root
20211107065502362628:
    ----------
    Arguments:
        - cat /root/abc
    Function:
        cmd.run
    StartTime:
        2021, Nov 07 06:55:02.362628
    Target:
        node1
    Target-type:
        glob
    User:
        root