### 使用標準的命名規范 > There are only two hard problems in computer science: cache invalidation, naming things, and off-by-one errors. > > — Phil Karlton 當你維護代碼時會發現，選擇適當而有意義的信息為你的模塊或類命名是有很大幫助的。 尤其是當其他人需要閱讀或基于你編寫的配置清單工作時，這種命名方法是十分必要的。 #### 操作步驟 1. 模塊應該以被管理的軟件或服務命名，例如：apache 或 haproxy。 用跟在模塊之后的功能或提供的服務為模塊中的類命名，例如：apache::vhosts 或 rails::dependencies。 如果在模塊中提供了禁用服務的功能，將其命名為 disabled。例如一個禁用 Apache 的類應該命令為 apache::disabled。 2. 如果一個節點需要提供多種服務，請在節點的定義中包含一個類或者每個服務的類名。例如： ``` node server014 inherits server { include puppet::server include mail::server include repo::gem include repo::apt include zabbix } ``` 3. 管理用戶的模塊應該命名為 user。 1. 在 user 模塊中，聲明虛擬用戶的類應命名為 user::virtual。 2. 在 user 模塊中，一個特定的用戶組應該命名為子類，例如 user::sysadmins 或 user::contractors。 4. 當你需要覆蓋某些特定節點或服務的類時，繼承該類并以節點名作為子類名的前綴。 例如，如果節點 cartman 需要一個特殊的 SSH 配置且要覆蓋 ssh 類，可以這樣做： ``` class cartman_ssh inherits ssh { [ override config here ] } ``` 5. 當使用 Puppet 為不同的服務部署配置時，被 Puppet 解析后傳出的文件應該以服務開頭， 隨后跟上指示文件功能的后綴。例如： * Apache init 腳本?—?apache.init * Rails 的日志滾動配置片段?—?rails.logrotate * Nginx 為 mywizzoapp 應用所做的 vhost 配置?—?mywizzoapp.vhost.nginx * 獨立運行的 MySQL 服務器的配置?—?standalone.mysql 如果你要管理不同的 Ruby 版本，可以使用添加了版本號的類名，表示由此類負責特定版本的管理， 例如 ruby192 或 ruby186。 #### 更多用法 Puppet 社區維護著一套 Puppet 基礎設施的最佳實踐準則，其中包括對命名的提示： [http://projects.puppetlabs.com/projects/1/wiki/Puppet_Best_Practice2](http://projects.puppetlabs.com/projects/1/wiki/Puppet_Best_Practice2) 。 一些人更愿意在一個節點中使用逗號分割的列表包含多個類，而不是使用分離的 include 語句。例如： ``` node server014 inherits server { include puppet::server, mail::server, repo::gem, repo::apt, zabbix } ``` 這是個風格問題，但我更愿意使用分離的 include 語句，一行包含一個模塊或類， 因為這樣可以更容易地在節點之間復制或移動，而無需每次都要整理逗號和縮進的問題。 我在前面的例子中曾幾次提到過繼承。如果你不知道這是什么，不要擔心：我會在下一章詳細解釋。