Puppet – 编码风格

Puppet – 编码风格

在 Puppet 中，编码风格定义了在尝试将机器配置上的基础设施转换为代码时需要遵循的所有标准。Puppet 使用资源工作并执行其所有定义的任务。

Puppet 的语言定义有助于以结构化的方式指定所有资源，这是管理任何需要管理的目标机器所必需的。Puppet 使用 Ruby 作为其编码语言，它具有多种内置功能，可以通过代码端的简单配置轻松完成工作。

基本单元

Puppet 使用了多种易于理解和管理的基本编码风格。以下是少数人的名单。

资源

在 Puppet 中，资源被称为基本建模单元，用于管理或修改任何目标系统。资源涵盖了系统的所有方面，例如文件、服务和包。Puppet 具有内置功能，允许用户或开发人员开发自定义资源，这有助于管理机器的任何特定单元

在 Puppet 中，所有资源都通过使用“定义”或“类”聚合在一起。这些聚合功能有助于组织模块。以下是一个示例资源，它由多种类型、一个标题和一个属性列表组成，Puppet 可以使用这些属性来支持多个属性。Puppet 中的每个资源都有自己的默认值，可以在需要时覆盖。

文件的示例木偶资源

在以下命令中，我们尝试为特定文件指定权限。

file {  
   '/etc/passwd': 
   owner => superuser, 
   group => superuser, 
   mode => 644, 
}

每当在任何机器上执行上述命令时，它都会验证系统中的 passwd 文件是否按描述配置。冒号之前的文件是资源的标题，在Puppet配置的其他部分可以称为资源。

除标题外还指定本地名称

file { 'sshdconfig': 
   name => $operaSystem ? { 
      solaris => '/usr/local/etc/ssh/sshd_config', 
      default => '/etc/ssh/sshd_config', 
   }, 
   owner => superuser, 
   group => superuser, 
   mode => 644, 
}

通过使用始终相同的标题，可以很容易地在配置中引用文件资源，而无需重复操作系统相关逻辑。

另一个示例可能是使用依赖于文件的服务。

service { 'sshd': 
   subscribe => File[sshdconfig], 
}

有了这种依赖性，一旦sshdconfig文件更改，sshd服务将始终重新启动。这里要记住的一点是File[sshdconfig]是小写形式的 File 声明，但如果我们将其更改为FILE[sshdconfig] ，那么它将成为一个参考。

在声明资源时需要牢记的一个基本点是，每个配置文件只能声明一次。多次重复声明相同的资源会导致错误。通过这个基本概念，Puppet 确保对配置进行良好建模。

我们甚至有能力管理资源依赖，这有助于管理多个关系。

service { 'sshd': 
   require => File['sshdconfig', 'sshconfig', 'authorized_keys']
}

元参数

元参数在 Puppet 中被称为全局参数。元参数的关键特性之一是，它适用于 Puppet 中的任何类型的资源。

资源默认

当需要定义默认资源属性值时，Puppet 提供了一组语法来归档它，使用没有标题的大写资源规范。

例如，如果我们想设置所有可执行文件的默认路径，可以使用以下命令完成。

Exec { path => '/usr/bin:/bin:/usr/sbin:/sbin' } 
exec { 'echo Testing mataparamaters.': }

在上面的命令中，第一条语句 Exec 将为 exec 资源设置默认值。Exec 资源需要一个完全限定的路径或一个看起来像可执行文件的路径。有了这个，我们可以为整个配置定义一个默认路径。默认值适用于 Puppet 中的任何资源类型。

默认值不是全局值，然而，它们只影响定义它们的范围或它的下一个变量。如果要为完整配置定义默认值，那么我们将在下一节中定义默认值和类。

资源集合

聚合是将事物收集在一起的方法。Puppet 支持一个非常强大的聚合概念。在 Puppet 中，聚合用于将资源分组，这是 Puppet 的基本单位。Puppet 中的这种聚合概念是通过使用两个强大的方法（称为类和定义）来实现的。

类和定义

类负责对节点的基本方面进行建模。他们可以说节点是一个网络服务器，而这个特定的节点就是其中之一。在 Puppet 中，编程类是单例的，每个节点可以评估一次。

另一方面，定义可以在单个节点上多次使用。它们的工作方式类似于使用该语言创建自己的 Puppet 类型。它们被创建为多次使用，每次使用不同的输入。这意味着可以将变量值传递到定义中。

类和定义之间的区别

类和定义之间唯一的主要区别是在定义构建结构和分配资源时，类每个节点仅评估一次，而另一方面，定义在同一单个节点上多次使用。

班级

Puppet 中的类是使用 class 关键字引入的，该特定类的内容包含在花括号内，如下例所示。

class unix { 
   file { 
      '/etc/passwd': 
      owner => 'superuser', 
      group => 'superuser', 
      mode => 644; 
      '/etc/shadow': 
      owner => 'vipin', 
      group => 'vipin', 
      mode => 440; 
   } 
}

在下面的例子中，我们使用了一些类似于上面的简写。

class unix { 
   file { 
      '/etc/passwd': 
      owner => 'superuser', 
      group => 'superuser', 
      mode => 644; 
   }  
   
   file {'/etc/shadow': 
      owner => 'vipin', 
      group => 'vipin', 
      mode => 440; 
   } 
}

Puppet 类中的继承

在 Puppet 中，默认支持继承的 OOP 概念，其中类可以扩展以前的功能，而无需在新创建的类中再次复制和粘贴完整的代码位。继承允许子类覆盖父类中定义的资源设置。使用继承时要记住的一件关键事情是，一个类只能从一个父类继承特性，不能超过一个。

class superclass inherits testsubclass { 
   File['/etc/passwd'] { group => wheel } 
   File['/etc/shadow'] { group => wheel } 
}

如果需要撤销父类中指定的某些逻辑，我们可以使用undef 命令。

class superclass inherits testsubcalss { 
   File['/etc/passwd'] { group => undef } 
}

使用继承的替代方法

class tomcat { 
   service { 'tomcat': require => Package['httpd'] } 
} 
class open-ssl inherits tomcat { 
   Service[tomcat] { require +> File['tomcat.pem'] } 
}

Puppet 中的嵌套类

Puppet 支持类嵌套的概念，它允许使用嵌套类，这意味着一个类在另一个类中。这有助于实现模块化和范围界定。

class testclass { 
   class nested { 
      file {  
         '/etc/passwd': 
         owner => 'superuser', 
         group => 'superuser', 
         mode => 644; 
      } 
   } 
} 
class anotherclass { 
   include myclass::nested 
}

参数化类

在 Puppet 中，类可以扩展它们的功能以允许将参数传递到类中。

要在类中传递参数，可以使用以下构造 –

class tomcat($version) { 
   ... class contents ... 
}

在 Puppet 中要记住的一个关键点是，使用 include 函数不会添加带参数的类，而是可以将生成的类作为定义添加。

node webserver { 
   class { tomcat: version => "1.2.12" } 
}

默认值作为类中的参数

class tomcat($version = "1.2.12",$home = "/var/www") { 
   ... class contents ... 
}

运行阶段

Puppet 支持运行阶段的概念，这意味着用户可以根据需要添加多个阶段，以管理任何特定资源或多个资源。当用户想要开发复杂的目录时，此功能非常有用。在复杂的目录中，需要编译大量资源，同时牢记定义的资源之间的依赖关系不应受到影响。

Run Stage 在管理资源依赖方面非常有帮助。这可以通过在定义的阶段添加类来完成，其中特定类包含资源集合。使用运行阶段，Puppet 保证定义的阶段将在每次目录运行并应用于任何 Puppet 节点时以指定的可预测顺序运行。

为了使用它，需要在已经存在的阶段之外声明额外的阶段，然后 Puppet 可以配置为使用相同的资源关系语法按指定的顺序管理每个阶段，然后使用 require “->”和“+>”。然后，该关系将保证与每个阶段关联的类的顺序。

使用 Puppet 声明式语法声明额外的阶段

stage { "first": before => Stage[main] } 
stage { "last": require => Stage[main] }

一旦声明了阶段，一个类就可以与使用阶段的主要阶段以外的阶段相关联。

class { 
   "apt-keys": stage => first; 
   "sendmail": stage => main; 
   "apache": stage => last; 
}

与 apt-key 类关联的所有资源将首先运行。Sendmail 中的所有资源将是主类，与 Apache 关联的资源将是最后一个阶段。

定义

在 Puppet 中，任何清单文件中的资源收集都是由类或定义完成的。定义与 Puppet 中的类非常相似，但是它们是通过定义关键字（不是类）引入的，并且它们支持参数而不是继承。它们可以使用不同的参数在同一系统上多次运行。

例如，如果想要创建一个定义来控制源代码存储库，其中一个人试图在同一系统上创建多个存储库，则可以使用定义而不是类。

define perforce_repo($path) { 
   exec {  
      "/usr/bin/svnadmin create $path/$title": 
      unless => "/bin/test -d $path", 
   } 
} 
svn_repo { puppet_repo: path => '/var/svn_puppet' } 
svn_repo { other_repo: path => '/var/svn_other' }

这里要注意的关键点是如何将变量与定义一起使用。我们使用 ( $ ) 美元符号变量。在上面，我们使用了 $title。定义可以同时具有 $title 和 $name，用它们可以表示名称和标题。默认情况下，$title 和 $name 设置为相同的值，但可以设置标题属性并将不同的名称作为参数传递。$title 和 $name 仅适用于定义，不适用于类或其他资源。

模块

一个模块可以定义为所有配置的集合，Puppet master 将使用这些配置在任何特定的 Puppet 节点（代理）上应用配置更改。它们也被称为执行特定任务所需的不同类型配置的便携式集合。例如，一个模块可能包含配置 Postfix 和 Apache 所需的所有资源。

节点

节点是非常简单的剩余步骤，这就是我们如何将我们定义的内容（“这就是网络服务器的样子”）与选择哪些机器来完成这些指令进行匹配。

节点定义看起来很像类，包括支持的继承，但是它们很特殊，当一个节点（运行 Puppet 客户端的受管计算机）连接到 Puppet 主守护进程时，它的名称将出现在定义的节点列表中。将为节点评估定义的信息，然后节点将发送该配置。

节点名称可以是短主机名或完全限定域名 (FQDN)。

node 'www.vipin.com' { 
   include common 
   include apache, squid 
}

上面的定义创建了一个名为 www.vipin.com 的节点，并包含了 common、Apache 和 Squid 类

我们可以通过用逗号分隔每个节点来将相同的配置发送到不同的节点。

node 'www.testing.com', 'www.testing2.com', 'www3.testing.com' { 
   include testing 
   include tomcat, squid 
}

匹配节点的正则表达式

node /^www\d+$/ { 
   include testing 
}

节点继承

Node 支持有限的继承模型。像类一样，节点只能从另一个节点继承。

node 'www.testing2.com' inherits 'www.testing.com' { 
   include loadbalancer 
}

在上面的代码中，除了一个额外的负载均衡器类之外，www.testing2.com 继承了 www.testing.com 的所有功能。

高级支持功能

Quoting – 在大多数情况下，我们不需要在 Puppet 中引用字符串。任何以字母开头的字母数字字符串都应保留而不加引号。但是，为任何非负值引用字符串始终是最佳实践。

带引号的变量插值

到目前为止，我们已经在定义方面提到了变量。如果需要将这些变量与字符串一起使用，请使用双引号，而不是单引号。单引号字符串不会做任何变量插值，双引号字符串会做。变量可以用{}括起来，这使它们更易于一起使用且更易于理解。

$value = "${one}${two}"

作为最佳实践，应该对所有不需要字符串插值的字符串使用单引号。

大写

大写是用于引用、继承和设置特定资源的默认属性的过程。基本上有两种基本的使用方法。

  • 引用– 这是引用已创建资源的方式。它主要用于依赖目的，必须将资源的名称大写。例如，需要 => 文件 [sshdconfig]

  • 继承– 从子类覆盖父类的设置时，使用资源名称的大写版本。使用小写版本会导致错误。

  • 设置默认属性值– 使用没有标题的大写资源可以设置资源的默认值。

数组

Puppet 允许在多个区域使用数组[一、二、三]。

几个类型成员，例如主机定义中的别名，在它们的值中接受数组。具有多个别名的主机资源将如下所示。

host { 'one.vipin.com': 
   alias => [ 'satu', 'dua', 'tiga' ], 
   ip => '192.168.100.1', 
   ensure => present, 
}

上面的代码将一个主机‘one.brcletest.com’添加到主机列表中，三个别名为‘satu’ ‘dua’ ‘tiga’。如果想将多个资源添加到一个资源中，可以按照以下示例进行操作。

resource { 'baz': 
   require => [ Package['rpm'], File['testfile'] ], 
}

变量

Puppet 像大多数其他编程语言一样支持多个变量。Puppet 变量用$表示。

$content = 'some content\n' 
file { '/tmp/testing': content => $content }

如前所述，Puppet 是一种声明式语言，这意味着它的范围和赋值规则与命令式语言不同。主要区别在于不能在单个范围内更改变量，因为它们依赖文件中的顺序来确定变量的值。顺序在声明性语言中无关紧要。

$user = root 
file {  
   '/etc/passwd': 
   owner => $user, 
} 

$user = bin 
   file {  
      '/bin': 
      owner => $user, 
      recurse => true, 
   }

变量范围

变量作用域定义了所有定义的变量是否有效。与最新功能一样，Puppet 目前是动态范围的，在 Puppet 术语中，这意味着所有定义的变量都在其范围内进行评估，而不是在定义它们的位置。

$test = 'top' 
class Testclass { 
   exec { "/bin/echo $test": logoutput => true } 
} 

class Secondtestclass { 
   $test = 'other' 
   include myclass 
} 

include Secondtestclass

限定变量

Puppet 支持在类或定义中使用限定变量。当用户希望在他已经定义或将要定义的其他类中使用相同的变量时，这非常有用。

class testclass { 
   $test = 'content' 
} 

class secondtestclass { 
   $other = $myclass::test 
}

在上面的代码中， $other 变量的值评估内容。

条件句

条件是用户希望在满足定义的条件或所需条件时执行一组语句或代码的情况。Puppet 支持两种类型的条件。

只能在定义的资源内使用的选择器条件来选择机器的正确值。

语句条件是清单中使用更广泛的条件，它有助于包含用户希望包含在同一清单文件中的其他类。在一个类中定义一组不同的资源，或做出其他结构性决策。

选择器

当用户希望基于事实或其他变量指定与默认值不同的资源属性和变量时，选择器很有用。在 Puppet 中，选择器索引的工作方式类似于多值三向运算符。选择器还能够在无值中定义自定义默认值，这些值在清单中定义并与条件匹配。

$owner = $Sysoperenv ? { 
   sunos => 'adm', 
   redhat => 'bin', 
   default => undef, 
}

在 Puppet 0.25.0 的更高版本中，选择器可以用作正则表达式。

$owner = $Sysoperenv ? { 
   /(Linux|Ubuntu)/ => 'bin', 
   default => undef, 
}

在上面的例子中，选择器$Sysoperenv值匹配 Linux 或 Ubuntu，那么 bin 将是选择的结果，否则用户将被设置为 undefined。

语句条件

语句条件是 Puppet 中的另一种条件语句，与 Shell 脚本中的 switch case 条件非常相似。在这里，定义了多组 case 语句，并根据每个条件匹配给定的输入值。

匹配给定输入条件的 case 语句被执行。这个case语句条件没有任何返回值。在 Puppet 中，条件语句的一个非常常见的用例是运行一组基于底层操作系统的代码位。

case $ Sysoperenv { 
   sunos: { include solaris }  
   redhat: { include redhat }  
   default: { include generic}  
}

Case Statement 还可以通过用逗号分隔来指定多个条件。

case $Sysoperenv { 
   development,testing: { include development } testing,production: { include production }
   default: { include generic }  
}

If-Else 语句

Puppet 支持基于条件的操作的概念。为了实现它，If/else 语句提供了基于条件返回值的分支选项。如以下示例所示 –

if $Filename { 
   file { '/some/file': ensure => present } 
} else { 
   file { '/some/other/file': ensure => present } 
}

最新版本的 Puppet 支持变量表达式，其中 if 语句也可以根据表达式的值进行分支。

if $machine == 'production' { 
   include ssl 
} else { 
   include nginx 
}

为了实现更多的代码多样性和执行复杂的条件操作，Puppet 支持嵌套的 if/else 语句，如下代码所示。

if $ machine == 'production' { 
   include ssl 
} elsif $ machine == 'testing' { 
   include nginx
} else { 
   include openssl 
}

虚拟资源

虚拟资源是那些除非实现否则不会发送到客户端的资源。

以下是在 Puppet 中使用虚拟资源的语法。

@user { vipin: ensure => present }

在上面的例子中，用户vipin是虚拟定义的，以实现可以在集合中使用的定义。

User <| title == vipin |>

注释

在任何代码位中都使用注释来创建关于一组代码行及其功能的附加节点。在 Puppet 中，目前支持两种类型的注释。

  • Unix shell 风格的注释。他们可以在自己的行上，也可以在下一行。
  • 多行 C 风格注释。

以下是 shell 样式注释的示例。

# this is a comment

以下是多行注释的示例。

/* 
This is a comment 
*/

运算符优先级

Puppet 运算符优先级符合大多数系统中的标准优先级，从最高到最低。

以下是表达式列表

  • ！= 不是
  • / = 乘以除法
  • – + = 减号，加号
  • << >> = 左移和右移
  • == !== 不等于，等于
  • >= <= > < = 大于等于、小于或等于、大于、小于

比较表达式

当用户想要在满足给定条件时执行一组语句时使用比较表达式。比较表达式包括使用 == 表达式的相等性测试。

if $environment == 'development' { 
   include openssl 
} else { 
   include ssl 
}

不相等的例子

if $environment != 'development' { 
   $otherenvironment = 'testing' 
} else { 
   $otherenvironment = 'production' 
}

算术表达式

$one = 1 
$one_thirty = 1.30 
$two = 2.034e-2 $result = ((( $two + 2) / $one_thirty) + 4 * 5.45) - 
   (6 << ($two + 4)) + (0×800 + -9)

布尔表达式

布尔表达式可以使用 or、and、& not。

$one = 1 
$two = 2 
$var = ( $one < $two ) and ( $one + 1 == $two )

正则表达式

Puppet 支持使用 =~（匹配）和 !~（不匹配）进行正则表达式匹配。

if $website =~ /^www(\d+)\./ { 
   notice('Welcome web server #$1') 
}

像 case 和 selector regex match 为每个 regex 创建有限范围的变量。

exec { "Test": 
   command => "/bin/echo now we don’t have openssl installed on machine > /tmp/test.txt", 
   unless => "/bin/which php" 
}

同样，我们可以使用unless、unless一直执行命令，除非unless下的命令成功退出。

exec { "Test": 
   command => "/bin/echo now we don’t have openssl installed on machine > /tmp/test.txt", 
   unless => "/bin/which php" 
}

使用模板

当一个人希望有一个预定义的结构时使用模板，该结构将在 Puppet 中的多个模块中使用，并且这些模块将分布在多台机器上。使用模板的第一步是创建一个使用模板方法呈现模板内容的模板。

file { "/etc/tomcat/sites-available/default.conf": 
   ensure => "present", 
   content => template("tomcat/vhost.erb")  
}

为了加强组织和模块化，Puppet 在处理本地文件时几乎没有做任何假设。Puppet 在模块目录中的文件夹 apache/templates 中查找 vhost.erb 模板。

定义和触发服务

在 Puppet 中，它有一个称为服务的资源，它能够管理在任何特定机器或环境上运行的所有服务的生命周期。服务资源用于确保服务被初始化和启用。它们也用于服务重启。

例如，在之前的 tomcat 模板中，我们设置了 apache 虚拟主机。如果要确保在虚拟主机更改后重新启动 apache，我们需要使用以下命令为 apache 服务创建服务资源。

service { 'tomcat': 
   ensure => running, 
   enable => true 
}

在定义资源时，我们需要包含通知选项以触发重启。

file { "/etc/tomcat/sites-available/default.conf": 
   ensure => "present", 
   content => template("vhost.erb"), 
   notify => Service['tomcat']  
}

觉得文章有用？

点个广告表达一下你的爱意吧 ！😁