puppet自动化运维之exec资源

Posted 2020-08-06

Puppet通过exec来执行外部的命令或者脚本，一般来讲是shell脚本。

这里面就涉及到一个重复执行的问题，因为默认的agent一连接上来就会自动执行对应的命令或者脚本。如果脚本重复执行对系统没影响的还无所谓，如果会对系统造成影响呢？

一个有用的方法是使用像creates参数来，除非达到了某个条件才会运行命令。比如执行之前判断文件是否存在等等。你可以使用refreshonly参数限制一个exec只有收到某个事件才执行。

 

作用：

    ①、远程执行系统命令，其实就是shell的调用；

②、由于exec是一次性执行资源，在不同类里面exec名字可相同。

 

格式：

exec {"title":              #一般写上要执行的命令，如不写，则需要指定command     cwd => "目录的绝对路径",    #在那个目录下执行，也可不要     path =>   "/bin:/sbin:...",   #命令执行的搜索路径,如不要，需指定命令的绝对路径     command => "执行的命令",    #写上要执行的命令，一般不需要，可在title中写上     creates => "文件名（绝对路径）",#当且仅当，该文件名不存在，命令才被执行，可不要     user => "用户名",       #定义运行命令的用户。 注意如果你使用了这个参数，那么任何的错误输出不会在当下被捕捉     logoutput =>   "true|false",  #是否记录输出,可取的值为：true，false和其他合法的日志等级。     onlyif => "命令",       #如onlyif中命令的执行结果为0（执行正确），才执行title或command中的目录,与unless相反     unless => "命令",       #如unless中命令的执行结果不为0（执行出错），才执行title或command中的目录,与onlyif相反 }

puppet执行外部命令，多次反复用这个方式执行命令是有威胁性的,因此建议对执行的命令进行加锁或者类似的处理.

建议每个exec资源的名字最好是唯一的.

建议属性值的目录、命令或文件，最好是绝对路径

 

exec 参数介绍：

 

command     command => "执行的命令",

将会被执行的命令，必须为被执行命令的绝对路径，或者得提供该命令的搜索路径。如果命令被成功执行，所有的输出会被记录在实例的正常（normal）日志里，但是如果命令执行失败（既返回值与我们所指定的不同），那么所有的输出会在错误（err）日志中被记录。这个是exec资源类型的名变量（namevar）。

 

creates     creates => "文件名(绝对路径）",

指定命令所生成的文件。如果提供了这个参数，那么命令只会在所指定的文件不存在的情况的被执行，下次的时候，该文件存在了，就不在执行命令。

create属性表明该exec将创建一个文件，当下一次puppet执行的时候，如果发现了这个文件，就不再执行这个exec资源。

 

cwd         cwd => "目录的绝对路径",

指定命令执行的目录。如果目录不存在，则命令执行失败。

 

user        user => "用户名",

定义运行命令的用户。 注意如果你使用了这个参数，那么任何的错误输出不会在当下被捕捉，这是Ruby的一个bug。

If you are using Puppet to create this user, the exec will automatically require the user, as long as it is specified by name

 

onlyif      onlyif => "命令",

如onlyif中命令的执行结果为0（执行正确），才执行title或command中的目录,与unless相反。例如：

exec { "logrotate": path => "/usr/bin:/usr/sbin:/bin", onlyif => "test `du /var/log/messages | cut -f1` -gt 100000" }

只有在test返回true的时候logrotate才会被运行。

需要注意的是onlyif定义的命令跟主命令遵循同样的规则，也就是说如果path没有被设置的话，需要使用绝对路径。

除此之外，onlyif还可以接受数组做为其值，例如：

onlyif => ["test -f /tmp/file1", "test -f /tmp/file2"]

上面的代码限定了只有在所有数组中的条件返回true时exec才会被执行。

 

unless      unless => "命令",

如unless中命令的执行结果不为0（执行出错），才执行title或command中的目录,与onlyif相反。例如：

exec { "/bin/echo root >> /usr/lib/cron/cron.allow":

            path => "/usr/bin:/usr/sbin:/bin",

            unless => "grep root /usr/lib/cron/cron.allow 2>/dev/null"

            }

上面这段代码先用grep在cron.allow文件（Solaris系统中）中找root，如果没有找到，就写入root。

要注意的是这个参数里的命令跟主命令遵循同样的规则，也就是说如果path没有被设置的话，需要使用绝对路径。

 

path        path => "/bin:/sbin:...",

命令执行的搜索路径。如果path没有被定义，命令需要使用绝对路径。路径可以以数组或以冒号分隔的形式来定义。

 

logoutput   logoutput => "true|false|on_failure",

是否记录输出。默认会根据exec资源的日志等级（loglevel） 来记录输出。若定义为on_failure，则仅在命令返回错误的时候记录输出。可取的值为：true，false和其他合法的日志等级。

 

env:

我们不建议使用这个参数，请使用‘environment’。这一部分还未完成。

 

environment

为命令设定额外的环境变量。要注意的是如果你用这个来设定PATH，那么PATH的属性会被覆盖。多个环境变量应该以数组的形式来设定。

 

group

定义运行命令的用户组。在不同的平台下的运行的结果无法确定，由于不同用户运行命令的时候，变量是不变的，所以这是平台的问题，而不是Ruby或Puppet的问题。

 

refresh

定义如何更新命令。当exec收到一个来自其他资源的事件时，默认只会重新执行一次命令。不过这个参数允许你定义更新时执行不同的命令。

 

refreshonly

该属性可以使命令变成仅刷新触发的，也就是说只有在一个依赖的对象被改变时，命令才会被执行。仅当命令与其他对象有依赖关系时，这个参数才有意义。当你要触发某个行为时，会显得很有用：

file { "/etc/aliases": source =>   "puppet://server/module/aliases" } exec { newaliases: path =>   ["/usr/bin", "/usr/sbin"], subscribe =>   File["/etc/aliases"], refreshonly => true }

 

要注意的是只有subscribe和notify可以促发行为，而不是require，所以在使用refreshonly时，只有同时使用subscribe或notify才有意义。有效的值为true, false。

returns

指定返回的代码。如果被执行的命令返回了其他的代码，一个错误（error）会被返回。默认值是0，可以定义为一个由可以接受的返回代码组成的数组或单值。

 

timeout     timeout => "秒数",

命令运行的最长时间。如果命令运行的时间超过了timeout定义的时间，那么这个命令就会被终止，并作为运行失败处理。当定义为负值时就会取消运行时间的限制。timeout的值是以秒为单位的。

 

exec资源在不到万不得已的时候不要去用，简单说来exec资源就是在执行puppet的时候，调用shell执行一条shell语句，例如：

exec {"delete config":

path => "/bin:/usr/bin",

command => "rm /etc/ssh/ssh_config";

}

  

exec资源是不太好掌控的资源，如果能用脚本实现，尽量写成脚本通过file资源分发到服务器上面。然后用其他的方式来调用脚本。例如crontab。或你完全可以用file资源来把crontab任务放到/etc/cron.d目录下来实现crontab资源的管理。使用puppet的时候，尽量用最简单的语法，越是花哨的语法也越容易出错。

 

实例：

#creates vi /etc/puppet/manifest/test.pp #注意命令要使用绝对路径 Exec { path => [ "/bin/", "/sbin/" ,   "/usr/bin/", "/usr/sbin/" ] }   exec { "/tmp/test1":          command =>   "touch /tmp/exec_test1",          creates =>   "/tmp/exec_test1"; }   #check [root@client ~]# ll /tmp/exec_test1 ls: cannot access /tmp/exec_test1: No such file or directory [root@client ~]# [root@client ~]# puppet agent --test -v --server   master.perofu.com info: Caching catalog for client.perofu.com info: Applying configuration version ‘1395071830‘ notice: /Stage[main]//Exec[/tmp/test1]/returns:   executed successfully notice: Finished catalog run in 0.32 seconds [root@client ~]# [root@client ~]# ll /tmp/exec_test1                               -rw-r--r-- 1 root root 0 Mar 17 23:58 /tmp/exec_test1 [root@client ~]# #此时creates的参数已满足，就不会再执行了 [root@client ~]# puppet agent --test -v --server   master.perofu.com info: Caching catalog for client.perofu.com info: Applying configuration version ‘1395071830‘ notice: Finished catalog run in 0.23 seconds [root@client ~]# [root@client ~]# ll /tmp/exec_test1                               -rw-r--r-- 1 root root 0 Mar 17 23:58 /tmp/exec_test1 [root@client ~]#   #onlyif Exec { path => [ "/bin/", "/sbin/" ,   "/usr/bin/", "/usr/sbin/" ] }   exec {"rm -rf /var/log/mysqld.log.bak":         logoutput => "on_failure",         onlyif =>   "[ $(cat /var/log/mysqld.log.bak |wc -l) -gt 10 ]";   }   #check [root@client ~]# cat /var/log/mysqld.log.bak |wc -l 21 [root@client ~]# [ `cat /var/log/mysqld.log.bak |wc -l` -gt   10 ] [root@client ~]# echo $? 0 [root@client ~]# puppet agent --test -v --server   master.perofu.com info: Caching catalog for client.perofu.com info: Applying configuration version ‘1395072287‘ notice: /Stage[main]//Exec[rm -rf   /var/log/mysqld.log.bak]/returns: executed successfully notice: Finished catalog run in 0.38 seconds [root@client ~]# ll /var/log/mysqld.log.bak ls: cannot access /var/log/mysqld.log.bak: No such file or directory

本文出自 “梦想照进现实” 博客，请务必保留此出处http://lookingdream.blog.51cto.com/5177800/1845564