zoukankan      html  css  js  c++  java
  • Saltstack常用模块及API

      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
    

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

    {'SN100-129': True, 'SN100-128': True, 'SN100-130': True}
    

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

    (1) Archive模块

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

    2)示例: 

    #采用gzip压缩/tmp/sourcefile.txt文件,sourcefile.txt 是在客户端存在的文件。
    [root@localhost ]# salt '*' archive.gzip /tmp/sourcefile.txt 
    
    #采用gunzip解压/tmp/sourcefile.txt.gz包
    
    [root@localhost~]# salt '*' archive.gunzip /tmp/sourcefile.txt.gz 
    

    3)API调用:

    client.cmd('*','archive.gunzip',['/tmp/sourcefile.txt.gz'])
    

    (2) cmd模块

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

    2)示例:

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

    3)API调用:

    client.cmd('SN100-128','cmd.run',['free -m'])
    

    (3) cp 模块

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

    2)示例:

    #将指定被控主机的/etc/hosts文件复制到被控主机本地的salt cache目录(/var/cache/salt/minion/localfiles);
    
    [root@localhost~]# salt '*' cp.cache_local_file /etc/hosts
    
    我的file_roots在/srv/salt下面,目录结构如下:
    [root@localhost salt]# tree /srv/salt/
    /srv/salt/
    ├── apache
    │   └── 1.txt
    ├── mysql
    ├── nginx
    │   └── nginx.conf
    ├── script
    │   ├── test.py
    │   └── test.sh
    └── software
        └── soft
    
    6 directories, 4 files
    #将主服务器file_roots指定位置下的目录复制到被控主机
    
    [root@locahost salt]# salt '*' cp.get_dir salt://apache/ /minion/dest
    
    #将主服务器file_roots指定位置下的文件复制到被控主机
    
    [root@localhost ~]# salt '*' cp.get_file salt://nginx/nginx.conf /minion/dest/nginx.conf    #复制文件
    
    [root@localhost ~]# salt '*' cp.get_file salt://nginx/nginx.conf /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
    

    3)API调用:

    client.cmd('SN100-128','cp.get_file',['salt://script/test.py','/tmp/test.py'])
    

    (4) cron 模块

    1)功能:实现被控主机的crontab操作。

    2)示例:

    #查看指定被控主机、root用户的crontab 清单

    [root@localhost~]# salt 'SN100-128' cron.raw_cron root                
    SN100-128:
        0 */2 * * *     /opt/bin/crontab/date.sh
    

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

    [root@localhost~]# salt 'SN100-128' cron.set_job root '*' '*' '*' '*' 1 /usr/local/weekly
    SN100-128:
        new
    #/usr/local/weekly文件在被控主机上是存在的
    

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

    [root@localhost~]# salt 'SN100-128' cron.rm_job root /usr/local/weekly
    SN100-128:
        removed
    

    3)API调用:

    >>> import salt.client
    >>> client = salt.client.LocalClient()
    >>> ret = client.cmd('SN100-128','cron.set_job',['root','*','*','*','*','*','/usr/echo'])
    >>> print ret
    {'SN100-128': 'new'}
    

    (5) dnsutil 模块

    1)功能:实现被控主机通用DNS相关操作。

    2)示例:

    #添加指定被控主机hosts的主机配置项

    [root@localhost~]# salt '*' dnsutil.hosts_append /etc/hosts 1.1.1.1 abc.com,bcd.com,
    SN100-128:
        The following line was added to /etc/hosts:
        1.1.1.1 abc.com bcd.com 
    SN100-129:
        The following line was added to /etc/hosts:
        1.1.1.1 abc.com bcd.com 
    SN100-130:
        The following line was added to /etc/hosts:
        1.1.1.1 abc.com bcd.com 
    

    #删除指定被控主机hosts的主机配置项

    [root@localhost~]# salt '*' dnsutil.hosts_remove /etc/hosts abc.com
    SN100-128:
        None
    SN100-129:
        None
    SN100-130:
        None
    

    3)API 调用

    client.cmd('*','dnsutil.hosts_append',['/etc/hosts','127.0.0.1','abc.com'])
    

    (6) file 模块

    1)功能:被控主机文件常见操作,包括文件读写、权限、查找、校验等。

    2)示例:

    #修改所以被控主机/etc/passwd 文件的属组、用户权限,等价于chown root:root /etc/passwd

    salt '*' file.chown /etc/passwd root root
    

    #复制所有被控主机本地/path/to/src 文件到/path/to/dst 文件

    salt 'SN100-128' file.copy /root/filename /tmp/filename
    
    #将SN100-128主机/root/filename文件复制到/tmp/filename.
    

    #检查所有被控主机/etc 目录是否存在,存在则返回True,检查文件是否存在使用file.file_exists方法

    [root@localhost~]# salt '*' file.directory_exists /etc
    SN100-128:
        True
    SN100-129:
        True
    SN100-130:
        True
    

    #获取所以被控主机/etc/passwd 的stats信息

    [root@localhost~]# salt 'SN100-128' file.stats /etc/passwd 
    SN100-128:
        ----------
        atime:
            1465195261.8
        ctime:
            1465195234.02
        gid:
            0
        group:
            root
        inode:
            1572021
        mode:
            0644
        mtime:
            1462760708.29
        size:
            1740
        target:
            /etc/passwd
        type:
            file
        uid:
            0
        user:
            root
    

    #获取所有被控主机/etc/passwd 的权限mode,如755、644

    [root@localhost~]# salt '*' file.get_mode /etc/passwd
    SN100-128:
        0644
    SN100-129:
        0644
    SN100-130:
        0644
    

    #在所有被控主机创建/opt/test目录

    [root@localhost~]# salt '*' file.mkdir /opt/test
    SN100-128:
        None
    SN100-129:
        None
    SN100-130:
        None
    

    #删除所有被控主机的/tmp/test 文件(文件或目录)

    [root@localhost~]# salt '*' file.remove /opt/test
    SN100-128:
        True
    SN100-130:
        True
    SN100-129:
        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
    

    3) API调用

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

    (7) network 模块

    1)功能:返回被控主机网络信息。

    2)示例:

    #在指定被控主机'SN100-128'获取dig、ping、traceroute目录域名信息.

    salt 'SN100-128' network.dig www.9888.cn
    
    salt 'SN100-128' network.ping www.9888.cn
    
     salt 'SN100-128' network.traceroute www.9888.cn
    

    #获取指定被控主机‘SN100-128’的 MAC 地址

    [root@localhost~]# salt 'SN100-128' network.hwaddr eth0
    SN100-128:
        00:50:56:87:b1:54
    

    #获取指定被控主机‘SN100-128’的网卡配置信息

    salt 'SN100-128' network.interfaces
    

    #获取指定被控主机'SN100-128'的IP地址配置信息

    [root@localhost~]# salt '*' network.ip_addrs
    SN100-128:
        - 10.10.100.128
    

    #获取指定被控主机‘SN100-128’的子网信息

    [root@localhost~]# salt 'SN100-128' network.subnets
    SN100-128:
        - 10.10.100.0/24
    

    #检测指定被控主机'SN100-128'是否属于10.0.0.0/16子网范围,属于则返回True.

    salt '*' network.in_subnet 10.0.0.0/16
    

    3) API调用:

    >>> import salt.client
    >>> 
    >>> client = salt.client.LocalClient()
    >>> ret = client.cmd('SN100-128','network.ip_addrs')
    >>> 
    >>> print ret
    {'SN100-128': ['10.10.100.128']}
    >>> 
    

    (8) pkg 包管理模块

    1)功能:被控主机程序包管理,如yum、apt-get等。

    2)示例:

    #为被控主机安装PHP环境,根据不同系统发行版调用不同安装工具进行部署,如redhat平台的yum,等价于yum -y install php

    salt 'SN100-128' pkg.install php
    

    #卸载被控端主机的PHP环境

    salt 'SN100-128' pkg.remove php
    

    #升级被控端主机的软件包

    salt '*' pkg.upgrade
    

    3)API调用:

    client.cmd('SN100-128','pkg.remove',['php'])
    

    (9) Service 服务模块

    1)功能:被控主机程序包服务管理。

    2)示例:

    #开启(enable)、禁用(disable) nginx开机自启动服务

    salt 'SN100-128' service.enable nginx
    salt 'SN100-128' 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
    

    3) API调用:

    client.cmd('SN100-128','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扩展功能模块来满足需求...

  • 相关阅读:
    读spring Micro-Service tats收获
    读spring Micro-Service tats收获
    读spring Micro-Service tats收获
    读Software Entity Architektur收获
    读Software Entity Architektur收获
    读Software Entity Architektur收获
    mvc案例
    11.16
    11.15
    11.13
  • 原文地址:https://www.cnblogs.com/saneri/p/5534015.html
Copyright © 2011-2022 走看看