美文网首页saltstack
Saltstack常用模块及API

Saltstack常用模块及API

作者: 六弦极品 | 来源:发表于2017-10-05 18:41 被阅读23次

    Saltstack提供了非常丰富的功能模块,涉及操作系统的基础功能、常用工具支持等,更多模块信息可以查看官网模块介绍。也可以通过sys模块列出当前版本支持的模块。

    salt '*' sys.list_modules
    

    一、模块API使用方法:

    API的原理是通过调用 master端的 client 模块,实例化一个LocalClient 对象,再调用cmd()方法来实现的。
    以下是API实现test.ping的示例:

    >>> import salt.client
    >>> client = salt.client.LocalClient()
    >>> ret = client.cmd('*','test.ping')
    >>> print ret
    {'YXH-Dev-Web-010040006059': True, 'YXH-deploy-010040006058': True}
    

    结果以一个标准的python字典形式的字符串返回,可以通过eval()函数转换成python的字典类型,方便后续的业务逻辑处理,程序运行结果如下:

    二、常见的模块介绍及使用方法:

    (1) Archive模块

    ① 功能:实现系统层面的压缩包调用,支持gzip、gunzip、rar、tar、unrar、unzip等。
    ② 示例:

    #采用gzip压缩/tmp/sourcefile.txt文件,sourcefile.txt 是在客户端存在的文件
    # salt 'YXH-Dev-Web-010040006059' archive.gzip /tmp/sourcefile.txt
    
    #采用gunzip解压/tmp/sourcefile.txt.gz包
    # salt 'YXH-Dev-Web-010040006059' archive.gunzip /tmp/sourcefile.txt.gz
    

    ③ API调用:

    client.cmd('YXH-Dev-Web-010040006059','archive.gunzip',['/tmp/sourcefile.txt.gz'])
    
    (2) cmd模块

    ① 功能:实现远程的命令行调用执行(默认具备root操作权限,使用时需评估风险)
    ② 示例:

    #获取所以主机的内存使用情况
    # salt '*' cmd.run "free -h"
     
    #在YXH-deploy-010040006058 master主机运行test.sh脚本,其中script/test.sh存放在file_roots指定的目录,默认目录为(/srv/salt)
    #该命令会做两个动作:首先同步test.sh到minion的cache目录(/var/cache/salt/minion/files/base/script/);其次运行该脚本,命令如下:
     
    # salt 'YXH-Dev-Web-010040006059' cmd.script salt://script/test.sh
    

    ③ API调用:

    client.cmd('YXH-Dev-Web-010040006059','cmd.run',['free -m'])
    
    (3) cp 模块

    ① 功能:实现远程文件、目录的复制,以及下载URL文件等操作。
    ② 示例:

    #将指定被控主机的/etc/hosts文件复制到被控主机本地的salt cache目录(/var/cache/salt/minion/localfiles);
    # salt '*' cp.cache_local_file /etc/hosts
    我的file_roots在/srv/salt下面,目录结构如下:
    #tree  /srv/salt/
    /srv/salt/
    ├── apache
    ├── _grains
    │   └── sysprocess.py
    ├── mysql
    ├── nginx
    │   └── nginx.conf
    ├── script
    │   └── test.sh
    └── software
        └── soft
    
    7 directories, 3 files
    

    将主服务器file_roots指定位置下的目录复制到被控主机

    # salt 'YXH-Dev-Web-010040006059' cp.get_dir salt://script/ /minion/dest
    YXH-Dev-Web-010040006059:
        - /minion/dest/script/test.sh
    
    # 将主服务器file_roots指定位置下的文件复制到被控主机
    #salt 'YXH-Dev-Web-010040006059' cp.get_file salt://nginx/nginx.conf /minion/dest/nginx.conf #复制文件
    YXH-Dev-Web-010040006059:
        /minion/dest/nginx.conf   
    ##salt 'YXH-Dev-Web-010040006059' cp.get_file salt://nginx/nginx.conf /minion/dest/test_nginx.conf #复制文件并重命名
    YXH-Dev-Web-010040006059:
        /minion/dest/test_nginx.conf  
    

    下载URL内容到被控主机指定位置(将rpm包下载到salt-minion客户端的/tmp目录.)

    salt '*' cp.get_url http://ftp.linux.ncsu.edu/pub/epel/6/i386/epel-release-6-8.noarch.rpm  /tmp/epel-releas
    

    ③ API调用:

    client.cmd('YXH-Dev-Web-010040006059','cp.get_file',['salt://script/test.sh','/tmp/test.sh'])
    
    (4) cron 模块

    ① 功能:实现被控主机的crontab操作。
    ② 示例:

    #查看指定被控主机、root用户的crontab 清单
    #salt 'YXH-Dev-Web-010040006059' cron.raw_cron root
    YXH-Dev-Web-010040006059:
        # update system time
        0  1  *  *  * /usr/sbin/ntpdate -u 0.europe.pool.ntp.org >/dev/null 2>&1
    

    为指定的被控主机、root用户添加/usr/local/weekly任务作业

    #salt 'YXH-Dev-Web-010040006059' cron.set_job root '*' '*' '*' '*' 1 /tmp/www_user_test.sh
    YXH-Dev-Web-010040006059:
        new
    
    #/usr/local/weekly文件在被控主机上是存在的
    

    删除指定的被控主机、root用户crontab 的/usr/local/weekly任务作业

    #salt 'YXH-Dev-Web-010040006059' cron.rm_job root /tmp/www_user_test.sh
    YXH-Dev-Web-010040006059:
        removed
    

    ③ API调用:

    >>> import salt.client
    >>> client = salt.client.LocalClient()
    >>> ret = client.cmd('YXH-Dev-Web-010040006059','cron.set_job',['root','*/5','*','*','*','*','/usr/echo'])
    >>> print ret
    {'YXH-Dev-Web-010040006059': 'updated'}
    
    (5) dnsutil 模块

    ① 功能:实现被控主机通用DNS相关操作。
    ② 示例:

    # 添加指定被控主机hosts的主机配置项
    # salt '*' dnsutil.hosts_append /etc/hosts 1.1.1.1 abc.com,bcd.com
    YXH-Dev-Web-010040006059:
        The following line was added to /etc/hosts:
        1.1.1.1 abc.com bcd.com
    YXH-deploy-010040006058:
        The following line was added to /etc/hosts:
        1.1.1.1 abc.com bcd.com
    
    # 删除指定被控主机hosts的主机配置项
    #salt '*' dnsutil.hosts_remove /etc/hosts abc.com
    YXH-deploy-010040006058:
        None
    YXH-Dev-Web-010040006059:
        None
    
    注意:这里删除只是abc.com,bcd.com 未删除
    

    ③ API 调用

    # client.cmd('*','dnsutil.hosts_append',['/etc/hosts','127.0.0.1','abc.com'])
    
    (6) file 模块

    ① 功能:minion端文件常见操作,包括文件读写、权限、查找、校验等。
    ② 示例:

    修改所以被控主机/etc/passwd 文件的属组、用户权限,等价于chown root:root /etc/passwd
    # salt '*' file.chown /etc/passwd root root
    YXH-deploy-010040006058:
        None
    YXH-Dev-Web-010040006059:
        Non
    
    将 YXH-Dev-Web-010040006059主机上的 /root/test.txt文件复制到 /tmp/test.txt
    #salt 'YXH-Dev-Web-010040006059' file.copy /root/test.txt /tmp/test.txt
    YXH-Dev-Web-010040006059:
        True
    
    
    检查所有被控主机 /etc 目录是否存在,存在则返回True,检查文件是否存在使用 file.file_exists方法
    #salt 'YXH-Dev-Web-010040006059' file.directory_exists /etc
    YXH-Dev-Web-010040006059:
        True
    
    #salt 'YXH-Dev-Web-010040006059' file.file_exists /root/test.txt
    YXH-Dev-Web-010040006059:
        True
    
    获取所以被控主机/etc/passwd 的stats信息
    #salt 'YXH-Dev-Web-010040006059' file.stats /etc/passwd
    YXH-Dev-Web-010040006059:
        ----------
        atime:
            1507195785.55
        ctime:
            1507195665.62
        gid:
            0
        group:
            root
        inode:
            2360570
        mode:
            0644
        mtime:
            1500617763.79
        size:
            1244
        target:
            /etc/passwd
        type:
            file
        uid:
            0
        user:
            root
    
    获取所有被控主机/etc/passwd 的权限mode,如755、644
    # salt '*' file.get_mode /etc/passwd
    YXH-deploy-010040006058:
        0644
    YXH-Dev-Web-010040006059:
        0644
    
    在YXH-Dev-Web-010040006059被控主机创建/opt/test目录
    #salt 'YXH-Dev-Web-010040006059' file.mkdir /opt/test
    YXH-Dev-Web-010040006059:
        None
    
    删除YXH-Dev-Web-010040006059被控主机的/tmp/test 文件(文件或目录)
    # salt 'YXH-Dev-Web-010040006059' file.remove /opt/test
    YXH-Dev-Web-010040006059:
        True
    
    给所有被控主机的/tmp/test/test.conf 文件追加内容"Maxclient 100"
    # salt '*' file.append /tmp/test/test.conf "maxclient 100"  
    
    将所有被控主机/etc/httpd/httpd.conf 文件的LogLevel 参数warn 值修改成info
    # salt '*' file.sed /etc/httpd/httpd.conf 'LogLevel warn' 'LogLevel info'
    
    校验所有被控主机文件的加密信息、支持md5、sha1、sha224、sha256、sha384、sha512加密算法
    # salt '*' file.get_sum /etc/passwd md5
    

    ③ API调用

    # client.cmd('*','file.remove',['/tmp/foo'])
    

    (7) network 模块**

    ① 功能:返回被控主机网络信息。
    ② 示例:

    #在指定被控主机'YXH-Dev-Web-010040006059'获取dig、ping、traceroute目录域名信息.
    salt 'YXH-Dev-Web-010040006059' network.dig www.9888.cn
    salt 'YXH-Dev-Web-010040006059' network.ping www.9888.cn
    salt 'YXH-Dev-Web-010040006059' network.traceroute www.9888.cn
    
    #获取指定被控主机‘YXH-Dev-Web-010040006059’的 MAC 地址
    salt 'YXH-Dev-Web-010040006059' network.hwaddr eth0
    YXH-Dev-Web-010040006059:
        00:0c:29:6a:01:76
    
    #获取指定被控主机‘YXH-Dev-Web-010040006059’的网卡配置信息
    salt 'YXH-Dev-Web-010040006059' network.interfaces
    
    #获取指定被控主机'YXH-Dev-Web-010040006059'的IP地址配置信息
    
    salt 'YXH-Dev-Web-010040006059' network.ip_addrs
    YXH-Dev-Web-010040006059:
        - 10.40.6.59
        - 10.40.6.84
    
    #获取指定被控主机‘YXH-Dev-Web-010040006059’的子网信息
    salt 'YXH-Dev-Web-010040006059' network.subnets
    YXH-Dev-Web-010040006059:
        - 10.40.6.0/24
        - 10.40.6.84/32
    
    #检测指定被控主机'YXH-Dev-Web-010040006059'是否属于10.0.0.0/16子网范围,属于则返回True.
    salt 'YXH-Dev-Web-010040006059' network.in_subnet 10.0.0.0/8
    YXH-Dev-Web-010040006059:
        True
    

    ③ API调用:

    >>> import salt.client
    >>> 
    >>> client = salt.client.LocalClient()
    >>> ret = client.cmd('YXH-Dev-Web-010040006059','network.ip_addrs')
    >>> 
    >>> print ret
    {'YXH-Dev-Web-010040006059': ['10.40.6.59', '10.40.6.84']}
    

    (8) pkg 包管理模块

    ① 功能:被控主机程序包管理,如yum、apt-get等。
    ② 示例:

    #为被控主机安装PHP环境,根据不同系统发行版调用不同安装工具进行部署,如redhat平台的yum,等价于yum -y install php
    salt 'YXH-Dev-Web-010040006059' pkg.install php
    
    #卸载被控端主机的PHP环境
    salt 'YXH-Dev-Web-010040006059' pkg.remove php
    
    #升级被控端主机的软件包
    salt '*' pkg.upgrade
    

    ③ API调用:

    client.cmd('YXH-Dev-Web-010040006059','pkg.remove',['php'])
    

    (9) Service 服务模块**

    ① 功能:被控主机程序包服务管理。
    ② 示例:

    #开启(enable)、禁用(disable) nginx开机自启动服务
    salt 'YXH-Dev-Web-010040006059' service.enable nginx
    salt 'YXH-Dev-Web-010040006059' service.disable nginx
    
    #针对nginx服务的reload、restart、start、stop、status操作
    salt '*' service.reload nginx
    salt '*' service.restart nginx
    salt '*' service.start nginx
    salt '*' service.stop nginx
    salt '*' service.status nginx
    

    ③ API调用:

    client.cmd('YXH-Dev-Web-010040006059','service.stop',['nginx'])
    

    其他模块:
    通过上面介绍的几个常用模块,基本上已经覆盖日常运维操作。Saltstack还提供了以下模块.
    user(系统用户模块)
    group(系统组模块)
    partition(系统分区模块)
    puppet(puppet管理模块)
    system(系统重启、关机模块)
    timezone(时区管理模块)
    nginx(Nginx管理模块)
    iptables(被控主机iptables支持模块)
    mount(文件系统挂载模块) 等等...
    更多模块查看官网介绍:
    http://docs.saltstack.com/ref/modules/all/index.html#all-salt-modules
    当然也可以通过python扩展功能模块来满足需求...

    相关文章

      网友评论

        本文标题:Saltstack常用模块及API

        本文链接:https://www.haomeiwen.com/subject/zefkyxtx.html