### Cruise1.0中文配置说明
#### 概述
Cruise1.0是Thoughtworks公司在2008年推出的一款持续集成与发布管理系统。它首次实现了Pipeline的概念，并将连续集成的概念扩展到了发布管理领域，极大地提高了软件开发过程中的自动化水平。
本篇文档旨在详细介绍Cruise1.0配置文件的各个组成部分及其作用，帮助使用者更好地理解并应用这些配置选项。
#### 配置文件结构概览
Cruise1.0的配置文件采用XML格式，主要分为以下几个部分：
- `<cruise>`：配置文件的根元素。
- `<server>`：用于定义Cruise Server的相关信息与属性。
- `<pipelines>`：用于定义Pipeline的集合。
- `<agents>`：定义Agent节点的信息。
#### `<cruise>` 元素
- **功能**：作为配置文件的根元素，包含了所有关于Cruise Server配置的信息。
- **属性集合**：无特定属性。
#### `<server>` 元素
- **功能**：用于定义Cruise Server的相关信息与属性。
- **属性集合**：无特定属性。
- **子元素**：
- `<license>`：用于存储获取到的Cruise License。如果没有License，请访问Cruise官网申请。Cruise提供了试用版和免费版的License。
- `<security>`：用于配置Cruise的安全管理。
- `<ldap>`：指定LDAP服务器。用户需通过在LDAP服务器上的用户名和密码登录Cruise。
- `<passwordFile>`：指定包含用户名-密码对的文本文件。密码需经过SHA1加密。
- `<admins>`：指定Cruise的管理员。管理员可通过Administration页面对Cruise进行配置管理。
- `<user>`：指定单个管理员。
#### `<pipelines>` 元素
- **功能**：所有Pipeline的容器。
- **属性集合**：无特定属性。
- **子元素**：
- `<pipeline>`：包含一个Pipeline的所有配置信息。
- `<dependencies>`：描述Pipeline之间的依赖关系。一个Pipeline可以被其他Pipeline的成功运行触发。
- `<materials>`：定义Pipeline使用的源码仓库类型，例如SVN、Mercurial等。
- `<stage>`：定义Pipeline中的阶段（Stage）。每个Pipeline至少包含一个Stage。
- `<jobs>`：定义Stage中的任务（Job）。
- `<job>`：单个任务的定义。
- `<resources>`：定义任务所需资源。
- `<tasks>`：定义任务执行的具体操作，如Ant、NAnt、Rake、Exec等。
- `<artifacts>`：定义构建产物。
- `<tabs>`：定义界面展示的选项卡。
- `<approval>`：定义审批流程。
#### `<agents>` 元素
- **功能**：定义Agent节点的信息。
- **属性集合**：无特定属性。
- **子元素**：
- `<agent>`：定义单个Agent节点的信息。
- `<resources>`：定义Agent节点上可用的资源。
#### 示例解析
下面是一个具体的配置文件示例解析：
```xml
<cruise>
<server>
<license/>
<security>
<ldap/>
<passwordFile/>
<admins>
<user/>
</admins>
</security>
</server>
<pipelines>
<pipeline>
<dependencies>
<depends/>
</dependencies>
<materials>
<svn/>
<hg/>
</materials>
<stage>
<jobs>
<job>
<resources>
<resource/>
</resources>
<tasks>
<ant/>
<nant/>
<rake/>
<exec/>
</tasks>
<artifacts>
<artifact/>
<test/>
</artifacts>
<tabs>
<tab/>
</tabs>
</job>
</jobs>
<approval/>
</stage>
</pipeline>
</pipelines>
<agents>
<agent>
<resources>
<resource/>
</resources>
</agent>
</agents>
</cruise>
```
#### `<license>` 元素
- **功能**：用于存储获取到的Cruise License。
- **属性集合**：无特定属性。
#### `<security>` 元素
- **功能**：用于配置Cruise的安全管理。
- **属性集合**：无特定属性。
- **子元素**：
- `<ldap>`：指定LDAP服务器。
- `<passwordFile>`：指定包含用户名-密码对的文本文件。
- `<admins>`：指定管理员列表。
- `<user>`：指定单个管理员。
#### `<ldap>` 元素
- **功能**：用于指定LDAP服务器。
- **属性集合**：无特定属性。
#### `<passwordFile>` 元素
- **功能**：指定包含用户名-密码对的文本文件。
- **属性集合**：无特定属性。
- **示例**：假设文件名为`admins.properties`，位于目录`/home/cruise`下。文件中有两个用户：
- 用户名为`Jez`，加密后的密码是`ThmbShxAtJepX80c2JY1FzOEmUk=`
- 用户名为`lqiao`，加密后的密码是`TfkgShslgJepX80c2JY1trwEskT=`
- 文件格式如下：
```properties
Jez=ThmbShxAtJepX80c2JY1FzOEmUk=
lqiao=TfkgShslgJepX80c2JY1trwEskT=
```
#### `<admins>` 元素
- **功能**：指定管理员列表。
- **属性集合**：无特定属性。
- **子元素**：
- `<user>`：指定单个管理员。
- **注意事项**：
- 至少要指定`<ldap>`和`<passwordFile>`之一。
- 用户名必须存在于LDAP服务器或passwordFile中。
- Cruise目前不支持使用Groups来指定管理员，也无法为某个Pipeline指定管理员。
- 如果在LDAP和password文件中有同名用户，那么这两个用户都是管理员。
#### `<pipeline>` 元素
- **功能**：包含一个Pipeline的所有配置信息。
- **属性集合**：无特定属性。
- **子元素**：
- `<dependencies>`：描述Pipeline之间的依赖关系。
- `<materials>`：定义Pipeline使用的源码仓库类型。
- `<stage>`：定义Pipeline中的阶段。
- `<jobs>`：定义Stage中的任务。
- `<job>`：单个任务的定义。
- `<resources>`：定义任务所需资源。
- `<tasks>`：定义任务执行的具体操作。
- `<artifacts>`：定义构建产物。
- `<tabs>`：定义界面展示的选项卡。
- `<approval>`：定义审批流程。
#### `<dependencies>` 元素
- **功能**：描述Pipeline之间的依赖关系。
- **属性集合**：无特定属性。
- **子元素**：
- `<depends>`：指定依赖关系。
#### `<materials>` 元素
- **功能**：定义Pipeline使用的源码仓库类型。
- **属性集合**：无特定属性。
- **子元素**：
- `<svn>`：定义SVN类型的源码库。
- `<hg>`：定义Mercurial类型的源码库。
#### `<stage>` 元素
- **功能**：定义Pipeline中的阶段。
- **属性集合**：无特定属性。
- **子元素**：
- `<jobs>`：定义Stage中的任务。
- `<job>`：单个任务的定义。
- `<resources>`：定义任务所需资源。
- `<tasks>`：定义任务执行的具体操作。
- `<artifacts>`：定义构建产物。
- `<tabs>`：定义界面展示的选项卡。
- `<approval>`：定义审批流程。
#### `<jobs>` 元素
- **功能**：定义Stage中的任务。
- **属性集合**：无特定属性。
- **子元素**：
- `<job>`：单个任务的定义。
#### `<job>` 元素
- **功能**：单个任务的定义。
- **属性集合**：无特定属性。
- **子元素**：
- `<resources>`：定义任务所需资源。
- `<tasks>`：定义任务执行的具体操作。
- `<artifacts>`：定义构建产物。
- `<tabs>`：定义界面展示的选项卡。
#### `<resources>` 元素
- **功能**：定义任务所需资源。
- **属性集合**：无特定属性。
- **子元素**：
- `<resource>`：定义单个资源。
#### `<tasks>` 元素
- **功能**：定义任务执行的具体操作。
- **属性集合**：无特定属性。
- **子元素**：
- `<ant>`：执行Ant脚本。
- `<nant>`：执行NAnt脚本。
- `<rake>`：执行Rake脚本。
- `<exec>`：执行命令行指令。
#### `<artifacts>` 元素
- **功能**：定义构建产物。
- **属性集合**：无特定属性。
- **子元素**：
- `<artifact>`：定义单个构建产物。
- `<test>`：定义测试相关的构建产物。
#### `<tabs>` 元素
- **功能**：定义界面展示的选项卡。
- **属性集合**：无特定属性。
- **子元素**：
- `<tab>`：定义单个选项卡。
#### `<approval>` 元素
- **功能**：定义审批流程。
- **属性集合**：无特定属性。
#### `<agents>` 元素
- **功能**：定义Agent节点的信息。
- **属性集合**：无特定属性。
- **子元素**：
- `<agent>`：定义单个Agent节点的信息。
- `<resources>`：定义Agent节点上可用的资源。
#### `<agent>` 元素
- **功能**：定义单个Agent节点的信息。
- **属性集合**：无特定属性。
- **子元素**：
- `<resources>`：定义Agent节点上可用的资源。
#### `<resources>` 元素 (Agent)
- **功能**：定义Agent节点上可用的资源。
- **属性集合**：无特定属性。
- **子元素**：
- `<resource>`：定义单个资源。
#### 结论
Cruise1.0配置文件涵盖了从服务器信息到Pipeline定义以及Agent配置等多个方面，通过对各个元素的理解与正确配置，可以有效提升软件项目的自动化程度，简化持续集成与发布的流程。希望本文能够帮助读者更好地理解和应用Cruise1.0配置文件，提高软件项目的开发效率和质量。
