abesesr/archi-htmlreport-docker

archi-htmlreport-docker

https://github.com/abes-esr/archi-htmlreport-docker/actions/workflows/build-test-pubtodockerhub.yml/badge.svg](https://github.com/abes-esr/archi-htmlreport-docker/actions/workflows/build-test-pubtodockerhub.yml)

从ArchiMateTool模型生成并提供HTML网站（通过Docker打包 🐳）。

我们在Abes内部使用它来生成"城市化网站"，帮助我们了解IT系统的组织结构。

!Demo

快速开始

shell
docker run --rm -p 8080:80 \
  -e GIT_REPOSITORY="https://github.com/abes-esr/archi-model-example.git" \
  abesesr/archi-htmlreport-docker:1.6.2

然后访问 http://127.0.0.1:8080/%EF%BC%8C%E5%B0%86%E4%BB%A5%E5%9F%BA%E7%A1%80%E7%BD%91%E7%AB%99%E5%BD%A2%E5%BC%8F%E6%98%BE%E7%A4%BAhttps://github.com/abes-esr/archi-model-example.git%E3%80%82

参数

环境变量参数

• GIT_REPOSITORY：ArchiMateTool模型的Git仓库URL（必填）
• GIT_CHECK_EACH_NBMINUTES：检查Git仓库变更的间隔时间（默认：5分钟）

文件参数（Docker卷）

如果需要通过SSH克隆GIT_REPOSITORY，需将本地id_rsa SSH密钥挂载到容器的以下位置：

• /root/.ssh/id_rsa.orig
• /root/.ssh/id_rsa.pub.orig 容器会将其复制到/root/.ssh/id_rsa和/root/.ssh/id_rsa.pub并设置正确的权限。

GIT_REPOSITORY结构

GIT_REPOSITORY仓库需包含以下特定位置的内容：

• model/：包含由ArchiMateTool IDE及其Model Repository Collaboration Plugin生成的多XML文件（必填）
• create-htmlreport.postscript.sh：每次HTML报告生成后执行的脚本（可选）
• create-htmlreport.prescript.sh：每次HTML报告生成前执行的脚本（可选）

容器内部结构

• /archi-model-git-repo/：包含git clone $GIT_REPOSITORY的结果
• /archi-model-git-repo/model.archimate：自动生成的单文件模型
• /use/share/nginx/html-tmp/：网站生成目录
• /use/share/nginx/html/：Nginx网站目录，最终会将html-tmp移动到此处
• 网站根目录会自动创建两个文件：
  • /use/share/nginx/html/version.html：包含当前使用的Docker镜像版本
  • /use/share/nginx/html/create-htmlreport.periodically.log.html：包含最新HTML报告构建的日志（出错时有用）

生产环境部署

mkdir archi-htmlreport/ && cd archi-htmlreport/
echo 'GIT_CHECK_EACH_NBMINUTES=5' > .env
echo 'GIT_REPOSITORY=https://github.com/abes-esr/archi-model-example.git' >> .env
wget https://raw.githubusercontent.com/abes-esr/archi-htmlreport-docker/master/docker-compose.yml
docker-compose up -d

（当然，需调整GIT_REPOSITORY参数）

生成的网站将在 [***] 上监听（将127.0.0.1替换为服务器IP）

开发人员指南

本地测试

docker build -t abesesr/archi-htmlreport-docker:1.6.2 .
docker run --rm -p 8080:80 --name archi-htmlreport-dev \
  -v $(pwd)/docker-entrypoint.sh:/docker-entrypoint.sh \
  -v $(pwd)/create-htmlreport.periodically.sh:/create-htmlreport.periodically.sh \
  -e GIT_CHECK_EACH_NBMINUTES=5 \
  -e GIT_REPOSITORY="https://github.com/abes-esr/archi-model-example.git" \
  abesesr/archi-htmlreport-docker:1.6.2

版本控制

要生成新版本，只需使用create-release.yml GitHub Action：
https://github.com/abes-esr/archi-htmlreport-docker/actions/workflows/create-release.yml

它将通过https://hub.docker.com/r/abesesr/archi-htmlreport-docker/%E8%87%AA%E5%8A%A8%E6%9E%84%E5%BB%BA%E6%96%B0%E7%9A%84Docker%E9%95%9C%E5%83%8F%E3%80%82 最新生成的Docker镜像名称和标签为：

abesesr/archi-htmlreport-docker:1.6.2