voxpupuli/puppet-catalog-diff-viewer

Puppet Catalog Diff Viewer

一个用于查看https://github.com/voxpupuli/puppet-catalog-diff%E7%94%9F%E6%88%90%E7%9A%84JSON%E6%8A%A5%E5%91%8A%E7%9A%84%E6%9F%A5%E7%9C%8B%E5%99%A8%E3%80%82

可在线试用该界面：<[***]>。

差异确认（Acking diffs）

该界面允许确认差异以简化报告审查。差异会在所有具有相同资源和相同差异的节点上被确认。

部分区域提供全局确认按钮，可一次性确认该部分中的所有差异。

差异标记（Starring diffs）

使用全局确认按钮时，可能需要排除某些差异。差异标记功能可实现此目的。与确认类似，标记也会跨节点生效。

使用Docker运行

shell
$ docker run -it --rm \
  -p 8080:80 \
  ghcr.io/voxpupuli/puppet-catalog-diff-viewer:development

运行后可通过 http://localhost:8080 访问目录差异查看器。

服务器端存储

如果能读取到 reportlist.json 文件，查看器会自动填充可用报告的下拉列表。该文件记录了 data 目录中的JSON文件信息。

假设目录结构如下：

text
data/
  file1.json
  file2.json

则 reportlist.json 应格式化为：

json
{
  "First Report": "file1",
  "Second Report": "file2"
}

Python脚本 generate_reportlist.py 可自动填充该文件，包含所有 data/*.json 文件，并将文件名作为键。

使用Docker镜像时，可将所有文件放在 /data 目录：

shell
$ docker run -ti \
   -v ./data:/data \
   -p 8080:8080 \
   ghcr.io/voxpupuli/puppet-catalog-diff-viewer

S3存储

查看器可自动从S3存储桶检索目录。要使用此功能，创建 s3_credentials.js 文件并配置以下变量：

javascript
const s3_bucketName = 'your-bucket-name';
const s3_access_key = 'your-access-key';
const s3_secret_key = 'your-secret-key';
// 标准S3及对应区域示例
const s3_endpoint   = 's3.us-east-2.amazonaws.com';
// 自托管S3示例
const s3_endpoint   = 'http://your.endpoint.example.com:9000';

// 若使用存储桶内路径前缀
const s3_bucketPathPrefix = 'your-prefix';
const s3_ForcePathStyle = true;

使用Docker镜像时，可通过以下方式挂载配置文件：

shell
$ docker run -it --rm \
   -v ./s3_credentials.js:/data/s3_credentials.js:ro \
   -p 8080:8080 \
   ghcr.io/voxpupuli/puppet-catalog-diff-viewer:development

或使用环境变量配置：

shell
$ docker run -it --rm \
   -e S3_BUCKET=your-bucket-name \
   -e S3_ACCESS_KEY=your-access-key \
   -e S3_SECRET_KEY=your-secret-key \
   -p 8080:8080 \
   ghcr.io/voxpupuli/puppet-catalog-diff-viewer:development

确保访问密钥所属用户对存储桶具有 s3:GetObject 和 s3:ListBucket 操作权限。以下是一个策略示例，用于从catalog-diff机器上传文件并在查看器中检索：

json
{
  "Version": "2012-10-17",
  "Id": "Policy1451988974568",
  "Statement": [
    {
      "Sid": "Upload",
      "Effect": "Allow",
      "Principal": {
        "AWS": "arn:aws:iam::123456789:user/uploader"
      },
      "Action": "s3:PutObject",
      "Resource": "arn:aws:s3:::bucket-id/my-site/*"
    },
    {
      "Sid": "ViewerList",
      "Effect": "Allow",
      "Principal": {
        "AWS": "arn:aws:iam::123456789:user/viewer"
      },
      "Action": "s3:ListBucket",
      "Resource": "arn:aws:s3:::bucket-id"
    },
    {
      "Sid": "ViewerGet",
      "Effect": "Allow",
      "Principal": {
        "AWS": "arn:aws:iam::123456789:user/viewer"
      },
      "Action": "s3:GetObject",
      "Resource": "arn:aws:s3:::bucket-id/*"
    }
  ]
}

贡献

构建发布版本

参见 RELEASE.md

项目转移说明

该项目最初由 Caocamp 开发。维护者希望Vox Pupuli接管该项目以进行未来的改进和维护。现有的拉取请求和问题已转移，建议在此处复刻并继续贡献，而非Caocamp。