SaltStack之return与job管理

目录

1. 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
    - pushover
    - rawfile_json
    - slack
    - slack_webhook
    - smtp
    - splunk
    - sqlite3
    - syslog
    - telegram
master:
    - carbon
    - couchdb
    - 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存储方式

环境说明:

主机 IP 服务
master 192.168.235.160 salt-master
minion-node1 192.168.220.10 salt-minion mariadb
mariadb 192.168.220.17 mariadb-server mariadb

关闭三台防火墙和selinux并更改主机名

master上安装服务

# 下载仓库
[root@master ~]# rpm --import https://repo.saltproject.io/py3/redhat/8/x86_64/latest/SALTSTACK-GPG-KEY.pub

[root@master ~]# curl -fsSL https://repo.saltproject.io/py3/redhat/8/x86_64/latest.repo | sudo tee /etc/yum.repos.d/salt.repo
[salt-latest-repo]
name=Salt repo for RHEL/CentOS 8 PY3
baseurl=https://repo.saltproject.io/py3/redhat/8/x86_64/latest
skip_if_unavailable=True
failovermethod=priority
enabled=1
enabled_metadata=1
gpgcheck=1
gpgkey=https://repo.saltproject.io/py3/redhat/8/x86_64/latest/SALTSTACK-GPG-KEY.pub

[root@master ~]# ls /etc/yum.repos.d/
CentOS-Stream-AppStream.repo         CentOS-Stream-Media.repo
CentOS-Stream-BaseOS.repo            CentOS-Stream-PowerTools.repo
CentOS-Stream-Debuginfo.repo         CentOS-Stream-RealTime.repo
CentOS-Stream-Extras.repo            salt.repo
CentOS-Stream-HighAvailability.repo

# 安装服务salt-master
[root@master ~]# yum -y install salt-master
......

# 启动
[root@master ~]# systemctl start salt-master
[root@master ~]# 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            0.0.0.0:4505        0.0.0.0:*            
LISTEN 0       128            0.0.0.0:4506        0.0.0.0:*            
LISTEN 0       128               [::]:22             [::]:*

node1上安装服务

# 下载仓库
[root@node1 ~]# rpm --import https://repo.saltproject.io/py3/redhat/8/x86_64/latest/SALTSTACK-GPG-KEY.pub

[root@node1 ~]# curl -fsSL https://repo.saltproject.io/py3/redhat/8/x86_64/latest.repo | sudo tee /etc/yum.repos.d/salt.repo
[salt-latest-repo]
name=Salt repo for RHEL/CentOS 8 PY3
baseurl=https://repo.saltproject.io/py3/redhat/8/x86_64/latest
skip_if_unavailable=True
failovermethod=priority
enabled=1
enabled_metadata=1
gpgcheck=1
gpgkey=https://repo.saltproject.io/py3/redhat/8/x86_64/latest/SALTSTACK-GPG-KEY.pub

[root@node1 ~]# ls /etc/yum.repos.d/
CentOS-Stream-AppStream.repo         CentOS-Stream-Media.repo
CentOS-Stream-BaseOS.repo            CentOS-Stream-PowerTools.repo
CentOS-Stream-Debuginfo.repo         CentOS-Stream-RealTime.repo
CentOS-Stream-Extras.repo            salt.repo
CentOS-Stream-HighAvailability.repo

# 安装服务salt-minion, python3-PyMySQL mariadb
[root@node1 ~]# yum -y install salt-minion
....
[root@node1 ~]# yum -y install python3-PyMySQL
......


# 修改配置文件
[root@node1 ~]# vim /etc/salt/minion
......
15 # resolved, then the minion will fail to start.
16 #master: salt
17 master: 192.168.235.160 # IP是master的,前面有一个空格
.......

# 启动salt-minion
[root@node1 ~]# systemctl start salt-minion
[root@node1 ~]# systemctl status salt-minion
● salt-minion.service - The Salt Minion
   Loaded: loaded (/usr/lib/systemd/system/salt-minion.service; disabl>
   Active: active (running) since Fri 2021-11-05 06:08:37 EDT; 6s ago
     Docs: man:salt-minion(1)
           file:///usr/share/doc/salt/html/contents.html
           https://docs.saltproject.io/en/latest/contents.html
 Main PID: 89941 (salt-minion)
    Tasks: 15 (limit: 11201)
   Memory: 81.8M
   CGroup: /system.slice/salt-minion.service
           ├─89941 /usr/bin/python3.6 /usr/bin/salt-minion

mariadb安装服务并配置

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

[root@mariadb ~]# systemctl start mariadb
[root@mariadb ~]# ss -antl
State       Recv-Q Send-Q Local Address:Port               Peer Address:Port              
LISTEN      0      50            *:3306                      *:*                  
LISTEN      0      128           *:22                        *:*                  
LISTEN      0      100    127.0.0.1:25                        *:*                  
LISTEN      0      128          :::22                       :::*                  
LISTEN      0      100         ::1:25                       :::*        
[root@mariadb ~]# mysql
Welcome to the MariaDB monitor.  Commands end with ; or \g.
Your MariaDB connection id is 2
Server version: 5.5.68-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)]> set password = password('1');
Query OK, 0 rows affected (0.00 sec)

MariaDB [(none)]> exit
Bye
[root@mariadb ~]# mysql -uroot -p1
Welcome to the MariaDB monitor.  Commands end with ; or \g.
Your MariaDB connection id is 3
Server version: 5.5.68-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)]> 

MariaDB [(none)]> create database `salt`
    -> DEFAULT CHARACTER SET utf8
    -> DEFAULT COLLATE utf8_general_ci;
Query OK, 1 row affected (0.00 sec)

MariaDB [(none)]> show databases;
+--------------------+
| Database           |
+--------------------+
| information_schema |
| mysql              |
| performance_schema |
| salt               |
| test               |
+--------------------+
5 rows in set (0.01 sec)

MariaDB [(none)]> USE `salt`;
Database changed
MariaDB [salt]> DROP TABLE IF EXISTS `jids`;
Query OK, 0 rows affected, 1 warning (0.00 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.00 sec)

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

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

MariaDB [salt]> grant all on salt.* to salt@'%' identified by 'salt';
Query OK, 0 rows affected (0.00 sec)

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

[root@master ~]# salt-key -L
Accepted Keys:
master
node1
Denied Keys:
Unaccepted Keys:
Rejected Keys:

在node1上安装mariadb

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

# 尝试使用mariadb主机创建的用户和密码登录
[root@node1 ~]# mysql -usalt -psalt -h192.168.235.173  (mariadb主机的ip)
Welcome to the MariaDB monitor.  Commands end with ; or \g.
Your MariaDB connection id is 5
Server version: 5.5.68-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 ~]# 

[root@node1 ~]# vim /etc/salt/minion
927 #return:
928 #  - mysql
929 #  - hipchat
930 #  - slack
931 mysql.host: '192.168.235.173'       //IP是mariadb的主机
932 mysql.user: 'salt'
933 mysql.pass: 'salt'
934 mysql.db: 'salt'
935 mysql.port: 3306

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

mariadb上查看是否有数据

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

master上测试存储到mariadb中

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

mariadb查看

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

2. job cache

2.1 job cache流程

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

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

master默认的存储位置

[root@master ~]# cd /var/cache/salt/master/jobs/
[root@master jobs]# ls
05  16  21  30  3b  50  68  81  89  94  a5  af  bc  c8  d5  e1  f0  fa
08  17  22  33  3e  54  6b  83  8a  95  a9  b2  bd  cd  d6  e2  f1  fc
0a  19  25  34  3f  5e  73  84  8b  97  ab  b3  bf  cf  d9  e3  f2
0d  1c  27  36  42  61  79  85  8f  9b  ac  b4  c0  d1  da  eb  f4
12  1d  28  38  48  66  7c  86  92  a2  ad  b7  c4  d3  db  ec  f5
14  1f  2c  3a  4d  67  7d  87  93  a3  ae  ba  c6  d4  dd  ee  f9

之前改的node1上的配置文件还原

#return:
#  - mysql
#  - hipchat
#  - slack
#mysql.host: '192.168.235.173'
#mysql.user: 'salt'
#mysql.pass: 'salt'
#mysql.db: 'salt'
#mysql.port: 3306

开启master端的master_job_cache

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

[root@master ~]# vim /etc/salt/master  
 137 #job_cache: True
 138 mysql.host: '192.168.235.173'     mariadb主机的IP
 139 mysql.user: 'salt'
 140 mysql.pass: 'salt'
 141 mysql.db: 'salt'
 142 mysql.port: 3306

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

master安装mariadb服务

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

[root@master ~]#  mysql -usalt -psalt -h192.168.235.173
Welcome to the MariaDB monitor.  Commands end with ; or \g.
Your MariaDB connection id is 8
Server version: 5.5.68-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@mariadb ~]# mysql -uroot -p1
Welcome to the MariaDB monitor.  Commands end with ; or \g.
Your MariaDB connection id is 9
Server version: 5.5.68-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, 0 rows affected (0.00 sec)

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

MariaDB [(none)]> 

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

[root@master ~]# salt 'node1' cmd.run 'df -h'
node1:
    Filesystem           Size  Used Avail Use% Mounted on
    devtmpfs             876M     0  876M   0% /dev
    tmpfs                895M   60K  895M   1% /dev/shm
    tmpfs                895M  8.7M  887M   1% /run
    tmpfs                895M     0  895M   0% /sys/fs/cgroup
    /dev/mapper/cs-root   66G  2.3G   63G   4% /
    /dev/mapper/cs-home   32G  260M   32G   1% /home
    /dev/sda1           1014M  195M  820M  20% /boot
    tmpfs                179M     0  179M   0% /run/user/0

在mariadb数据库中查询

MariaDB [(none)]> select * from salt.salt_returns\G
*************************** 1. row ***************************
       fun: cmd.run
       jid: 20211105115047743305
    return: "Filesystem           Size  Used Avail Use% Mounted on\ndevtmpfs             876M     0  876M   0% /dev\ntmpfs                895M   60K  895M   1% /dev/shm\ntmpfs                895M   17M  879M   2% /run\ntmpfs                895M     0  895M   0% /sys/fs/cgroup\n/dev/mapper/cs-root   17G  2.0G   16G  12% /\n/dev/sda1           1014M  195M  820M  20% /boot\ntmpfs                179M     0  179M   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             876M     0  876M   0% /dev\ntmpfs                895M   60K  895M   1% /dev/shm\ntmpfs                895M   17M  879M   2% /run\ntmpfs                895M     0  895M   0% /sys/fs/cgroup\n/dev/mapper/cs-root   17G  2.0G   16G  12% /\n/dev/sda1           1014M  195M  820M  20% /boot\ntmpfs                179M     0  179M   0% /run/user/0", "retcode": 0, "jid": "20211105115047743305", "fun": "cmd.run", "fun_args": ["df -h"], "_stamp": "2021-11-05T11:50:47.859197"}
alter_time: 2021-11-05 07:50:47
1 row in set (0.000 sec)

2.2 job管理

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

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

获取任务的jid

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

node1:
    Sun Nov  7 17:14:51 CST 2021

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

[root@master ~]# salt-run jobs.lookup_jid 20211107091451183526
node1:
    Sun Nov  7 17:14:51 CST 2021

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

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

列出执行过的任务

[root@master ~]# salt-run jobs.list_jobs
20211107015350680626:
    ----------
    Arguments:
        - /root/test.sh
    Function:
        file.prepend
    StartTime:
        2021, Nov 07 01:53:50.680626
    Target:
        node1
    Target-type:
        glob
    User:
        root
20211107015405852746:
    ----------
    Arguments:
        - cat /root/test.sh
    Function:
        cmd.run
    StartTime:
        2021, Nov 07 01:54:05.852746
    Target:
        node1
    Target-type:
        glob
    User:
        root
····························
上一篇:yocto


下一篇:A Child's History of England.164