PSICK 技术文档

本文档将详细介绍如何安装、使用以及通过 API 操作 PSICK（Puppet Systems Infrastructure Construction Kit）项目。

1. 安装指南

首先，您需要克隆 PSICK 仓库到本地：

git clone https://github.com/example42/psick
cd psick
./psick create

psick 命令当前仅允许创建新的控制库，并填充其内容为最简结构或完整的 PSICK 内容。在未来，它将提供选择单一组件（集成、配置文件等）的功能。

2. 项目的使用说明

创建完控制库后，您可以开始使用它。如果选择复制完整的 PSICK 内容到您的控制库，您可以在自己的控制库目录下运行以下命令，否则在 PSICK 目录下运行。

以下适用于文档中引用的所有脚本和路径，但请注意，一些位于 bin/ 目录和其他集成中的脚本在不完整的 PSICK 设置下可能无法正确运行。

设置 Puppet 环境

PSICK 控制库需要 Puppet 4 或更高版本。如果尚未安装，可以使用以下跨操作系统 Puppet 4 安装脚本（使用官方 Puppet 仓库）：

sudo bin/puppet_install.sh  # 仅在未安装 Puppet 4 的情况下

在开始使用之前，您需要填充控制库的 modules/ 目录。您需要在开发工作站和 Puppet 服务器上执行此操作（将控制库放置到 /etc/puppetlabs/code/environments/ 目录下后）。

为了安装必需的 gems（hiera-eyaml、deep_merge、r10k）并通过 r10k 填充外部模块目录，可以运行：

bin/puppet_setup.sh        # 仅在未安装必要 gems 的情况下

如果已经安装了 r10k 和必要 gems，只需运行：

r10k puppetfile install -v

如果您还想安装推荐的（Vagrant、Docker）工具，可以与仓库一起使用，运行：

bin/setup.sh               # 仅在需要安装 Vagrant 和 Docker 的情况下

脚本将安装并运行 r10k，然后使用 Puppet 安装其他软件。

注意：

• 您将始终被要求确认或跳过每个步骤。

• 脚本将使用 sudo 执行需要 root 权限的操作。

• 脚本主要在 Mac 和 Linux 环境下进行了测试。在 Mac 上，某些软件包的安装可能不工作。

• 您可以随时使用 CTRL+C 中断脚本。

• 对于无人值守的设置（如 CI 管道），可以通过传递 auto 参数来跳过确认请求：

    bin/puppet_setup.sh auto
    bin/setup.sh auto
  

3. 项目 API 使用文档

PSICK 项目主要通过 Puppet 进行操作，不直接提供 API。但是，它支持多种 CI 解决方案（Gitlab、GitHub、CD4PE...），并且可以通过这些工具的 API 进行集成。

4. 项目安装方式

PSICK 的安装方式已在“安装指南”部分详细说明。以下是简要步骤：

1. 克隆仓库。
2. 使用 ./psick create 创建控制库。
3. 根据 Puppet 环境安装必要的 gems 和外部模块。
4. （可选）安装 Vagrant 和 Docker。

遵循上述步骤，您可以成功安装并开始使用 PSICK 项目。