SaltStack之return与job管理

朱雀 2022-11-30 04:11 216阅读 0赞

### SaltStack之return与job管理 ###

*  1. SaltStack组件之return
 *   *  1.1 return流程
     *  1.2 配置return管理
 *  2. SaltStack组件之job cache
 *   *  2.1 配置job
     *  2.2 job管理

# 1. SaltStack组件之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
    192.168.30.245:
        - carbon
        - couchdb
        - elasticsearch
        - etcd
        - highstate
        - local
        - local_cache
        - mattermost
        - multi_returner
        - mysql
        - 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模块**。

![在这里插入图片描述][watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3p5eTEzMDk4OA_size_16_color_FFFFFF_t_70_pic_center]

*  优点：数据存储不会给Salt Master带来额外的负担。
 *  缺点：每个Salt Minion连接到外部作业缓存，这可能导致大量连接。 还需要额外配置才能在所有Salt Minions上获得返回模块配置。

**MySQLdb 是用于Python链接Mysql数据库的接口**，它实现了 Python 数据库 API 规范 V2.0，基于 MySQL C API 上建立的。  
   
**使用return管理，minion要安装MySQL-python**  
   
**使用job管理，master要安装MySQL-python**

## 1.2 配置return管理 ##

**1. 在minion安装MySQL-python**

//在所有minion安装 MySQL-python
    [root@master ~]# salt '*' pkg.install MySQL-python
    192.168.30.245:
        ----------
        MySQL-python:
            ----------
            new:
                1.2.5-1.el7
            old:

**2. 准备一台mysql服务器**

//准备一台mysql服务器
    [root@mysql ~]# systemctl enable mariadb
    [root@mysql ~]# systemctl start mariadb
    
    [root@mysql ~]# ss -anlt
    State       Recv-Q Send-Q Local Address:Port               Peer Address:Port              
    LISTEN      0      128            *:22                         *:*                  
    LISTEN      0      100    127.0.0.1:25                         *:*                  
    LISTEN      0      128           :::22                        :::*                  
    LISTEN      0      100          ::1:25                        :::*                    
    LISTEN      0      80            :::3306                      :::*

**3. 创建数据库和表结构**  
[详情请见官网][Link 1]

[root@mysql ~]# mysql -uroot -p1
    mysql: [Warning] Using a password on the command line interface can be insecure.
    Welcome to the MySQL monitor.  Commands end with ; or \g.
    Your MySQL connection id is 4
    Server version: 5.7.30 MySQL Community Server (GPL)
    
    Copyright (c) 2000, 2020, Oracle and/or its affiliates. All rights reserved.
    
    Oracle is a registered trademark of Oracle Corporation and/or its
    affiliates. Other names may be trademarks of their respective
    owners.
    
    Type 'help;' or '\h' for help. Type '\c' to clear the current input statement.
    
    
    //创建用户
    mysql> grant all on salt.* to salt@'%' identified by 'salt';
    Query OK, 0 rows affected, 1 warning (0.01 sec)
    
    
    
    mysql> flush privileges;
    Query OK, 0 rows affected (0.00 sec)
    
    
    
    
    //创建数据库和表结构
    mysql> CREATE DATABASE  `salt`
        ->   DEFAULT CHARACTER SET utf8
        ->   DEFAULT COLLATE utf8_general_ci;
    
    Query OK, 1 row affected (0.00 sec)
    
    
    
    //进入库
    mysql> use salt;
    
    
    
    Database changed
    mysql> 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.07 sec)
    
    
    
    
    
    mysql> 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.04 sec)
    
    
    
    
    
    mysql> 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)

**4. 修改minion配置文件**

[root@minion ~]# vim /etc/salt/minion
    mysql.host: '192.168.30.150'   ##mysql服务器IP
    mysql.user: 'salt'
    mysql.pass: 'salt'
    mysql.db: 'salt'
    mysql.port: 3306
    
    [root@minion ~]# systemctl restart salt-minion

**5. 在Master上测试存储到mysql中**

[root@master ~]# salt '*' test.ping --return mysql
    192.168.30.245:
        True
    
    
    [root@master ~]# salt '*' cmd.run 'ls /root/'   ##不加--return mysql
    192.168.30.245:
        111
        222

**6. 在数据库中查询**

//发现只能找到一条信息
    mysql> select * from salt_returns\G
    *************************** 1. row ***************************
           fun: test.ping
           jid: 20200823024659304373
        return: true
            id: 192.168.30.245
       success: 1
      full_ret: {
       "fun_args": [], "jid": "20200823024659304373", "return": true, "retcode": 0, "success": true, "fun": "test.ping", "id": "192.168.30.245"}
    alter_time: 2020-08-23 10:46:59
    1 row in set (0.00 sec)

**7. 再次测试**

//加上--return mysql
    [root@master ~]# salt '*' cmd.run 'ls /root/' --return mysql
    192.168.30.245:
        111
        222

**8. 再次在数据库中查询**

//成功查到两条
    mysql> select * from salt_returns\G
    *************************** 1. row ***************************
           fun: test.ping
           jid: 20200823024659304373
        return: true
            id: 192.168.30.245
       success: 1
      full_ret: {
       "fun_args": [], "jid": "20200823024659304373", "return": true, "retcode": 0, "success": true, "fun": "test.ping", "id": "192.168.30.245"}
    alter_time: 2020-08-23 10:46:59
    *************************** 2. row ***************************
           fun: cmd.run
           jid: 20200823025253018464
        return: "111\n222"
            id: 192.168.30.245
       success: 1
      full_ret: {
       "fun_args": ["ls /root/"], "jid": "20200823025253018464", "return": "111\n222", "retcode": 0, "success": true, "fun": "cmd.run", "id": "192.168.30.245"}
    alter_time: 2020-08-23 10:52:53
    3 rows in set (0.00 sec)

# 2. SaltStack组件之job cache #

--------------------

**Minion将结果返回给Master后，由Master将结果给缓存在本地，然后将缓存的结果给存储到指定的存储服务器，比如存储到mysql中。**  
![在这里插入图片描述][watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3p5eTEzMDk4OA_size_16_color_FFFFFF_t_70_pic_center 1]

*  优点：外部缓存系统只需要维护单个连接。 这对数据库和类似系统是首选。
 *  缺点：在Salt Master上增加了额外的负载。

## 2.1 配置job ##

**1.安装MySQL-python**

[root@master ~]# yum -y install MySQL-python

**2.修改master配置文件**

master_job_cache: mysql
    mysql.host: '192.168.30.150'
    mysql.user: 'salt'
    mysql.pass: 'salt'
    mysql.db: 'salt'
    mysql.port: 3306
    
    [root@master salt]# systemctl restart salt-master

**3. 清空表**  
没有表，请见return第3步

mysql> delete from salt.salt_returns;
    Query OK, 3 rows affected (0.01 sec)
    
    
    mysql> select * from salt_returns\G
    Empty set (0.00 sec)

**4. 在master上测试能否存储至数据库**

[root@master salt]# salt '*' test.ping
    192.168.30.245:
        True
    
    
    [root@master ~]# salt '*' cmd.run 'ls /root/'
    192.168.30.245:
        111
        222

**5. 在数据库中查询**

mysql> select * from salt_returns\G
    *************************** 1. row ***************************
           fun: test.ping
           jid: 20200823031036575204
        return: true
            id: 192.168.30.245
       success: 1
      full_ret: {
       "fun_args": [], "jid": "20200823031036575204", "return": true, "retcode": 0, "success": true, "cmd": "_return", "_stamp": "2020-08-23T03:10:36.955782", "fun": "test.ping", "id": "192.168.30.245"}
    alter_time: 2020-08-23 11:10:36
    *************************** 2. row ***************************
           fun: cmd.run
           jid: 20200823031235440788
        return: "111\n222"
            id: 192.168.30.245
       success: 1
      full_ret: {
       "fun_args": ["ls /root/"], "jid": "20200823031235440788", "return": "111\n222", "retcode": 0, "success": true, "cmd": "_return", "_stamp": "2020-08-23T03:12:35.567587", "fun": "cmd.run", "id": "192.168.30.245"}
    alter_time: 2020-08-23 11:12:35
    2 rows in set (0.00 sec)

## 2.2 job管理 ##

**获取任务的jid**

[root@master ~]# salt '*' cmd.run 'uptime' -v
    Executing job with jid 20200823031427371583
    -------------------------------------------
    192.168.30.245:
         11:14:27 up 48 min,  2 users,  load average: 0.33, 0.15, 0.14

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

[root@master ~]# salt-run jobs.lookup_jid 20200823031427371583
    192.168.30.245:
         11:14:27 up 48 min,  2 users,  load average: 0.33, 0.15, 0.14

[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3p5eTEzMDk4OA_size_16_color_FFFFFF_t_70_pic_center]: /images/20221124/580dd433d4974c78b5fbea2126dd2cb5.png
[Link 1]: https://docs.saltstack.com/en/latest/ref/returners/all/salt.returners.mysql.html
[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3p5eTEzMDk4OA_size_16_color_FFFFFF_t_70_pic_center 1]: /images/20221124/dbd54f40aa6946d1ae24d84632e6e18a.png