SaltStack-return与job管理

2024-01-02 19:35:16

文章目录

SaltStack组件之return
- return流程
- 使用mysql作为return存储方式
SaltStack组件之job cache
- job cache流程

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
//这里只显示一部分，官网详细会有三十多种

return流程

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

return工作流程:

使用mysql作为return存储方式

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

[root@master ~]# salt '*' pkg.install python3-PyMySQL
node1:
    ----------
    python3-PyMySQL:
        ----------
        new:
            0.10.1-2.module_el8.5.0+761+faacb0fb
......

[root@master ~]# salt '*' cmd.run 'rpm -qa|grep python3-PyMySQL'
node1:
    python3-PyMySQL-0.10.1-2.module_el8.5.0+761+faacb0fb.noarch

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

//安装mariadb
[root@return ~]# yum -y install mariadb mariadb-server

[root@return ~]# 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)]> 
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.007 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.008 sec)

DROP TABLE IF EXISTS `salt_events`;
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;

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.000 sec)

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

//minion主机登陆测试
[root@node1 ~]# mysql -usalt -psalt -h192.168.218.130
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
......
############################################
# Default Minion returners. Can be a comma delimited string or a list:
#
#return: mysql
#
#return: mysql,slack,redis
#
#return:
#  - mysql
#  - hipchat
#  - slack
......
//添加以下几行内容
mysql.host: '192.168.218.130'     //数据库主机IP
mysql.user: 'salt'        //授权用户
mysql.pass: 'salt'        //授权用户密码
mysql.db: 'salt'           
mysql.port: 3306

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

在Master上测试存储到mysql中

[root@master ~]# salt '*'  test.ping --return mysql
// --return 让返回信息存储到mysql数据库中
node1:
    True

//在数据库中查询
MariaDB [salt]> select * from salt_returns\G
*************************** 1. row ***************************
       fun: test.ping
       jid: 20211108025018476905
    return: true
        id: node1
   success: 1
  full_ret: {"success": true, "return": true, "retcode": 0, "jid": "20211108025018476905", "fun": "test.ping", "fun_args": [], "id": "node1"}
alter_time: 2021-11-08 10:50:20
1 row in set (0.000 sec)

//如果想把每次的返回信息都放到数据中，因为修改minion端的minion配置文件
[root@node1 ~]# vim /etc/salt/minion
......
############################################
# Default Minion returners. Can be a comma delimited string or a list:
#
#return: mysql     //取消此行注释即可不用指定--return，每次返回信息都默认存储到数据库中
#
#return: mysql,slack,redis
#
#return:
#  - mysql
#  - hipchat
#  - slack
......
//添加以下几行内容
mysql.host: '192.168.218.130'     //数据库主机IP
mysql.user: 'salt'        //授权用户
mysql.pass: 'salt'        //授权用户密码
mysql.db: 'salt'           
mysql.port: 3306
//修改完配置文件记得重启salt-minion

SaltStack组件之job cache

job cache流程

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

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

job cache工作流程：

注意：在使用job cache时一定要关闭return，两者选其一，不能同时使用

在master上安装Mysql-python模块

//此包一定要在master上安装，否则在连接数据库的时候连接不上
[root@master ~]# yum -y install python3-PyMySQL

开启master端的master_job_cache

[root@master ~]# vim /etc/salt/master
......
#job_cache: True
# 添加以下几行
master_job_cache: mysql
mysql.host: '192.168.218.130'     //数据库存储主机IP
mysql.user: 'salt'
mysql.pass: 'salt'
mysql.db: 'salt'
mysql.port: 3306
......

//重启master
[root@master ~]# systemctl restart salt-master

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

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

在数据库中查询

MariaDB [salt]> select * from salt_returns\G
*************************** 1. row ***************************
       fun: test.ping
       jid: 20211108031957837042
    return: true
        id: node1
   success: 1
  full_ret: {"cmd": "_return", "id": "node1", "success": true, "return": true, "retcode": 0, "jid": "20211108031957837042", "fun": "test.ping", "fun_args": [], "_stamp": "2021-11-08T03:19:58.217681"}
alter_time: 2021-11-08 11:19:59

码农公寓