senzing/keystore-generator

keystore-generator

概述

keystore-generator是一个用于生成客户端和服务器Java keystore的Docker镜像，主要为https://github.com/Senzing/senzing-api-server%E5%92%8Chttps://github.com/Senzing/senzing-poc-server%E6%8F%90%E4%BE%9B%E5%AE%A2%E6%88%B7%E7%AB%AFSSL%E8%AE%A4%E8%AF%81%E6%94%AF%E6%8C%81%E3%80%82

该镜像封装了keystore-generator.py Python脚本，作为"运行完成即结束"的任务，可在指定文件夹中生成客户端和服务器Java keystore，适用于Docker环境（如docker-compose、Kubernetes）。

要查看所有子命令，运行：

console
$ ./keystore-generator.py
usage: keystore-generator.py [-h] {aws,sleep,version,docker-acceptance-test} ...

初始化Senzing安装。更多信息请参见 https://github.com/Senzing/keystore-generator

位置参数: {aws,sleep,version,docker-acceptance-test}
子命令 (SENZING_SUBCOMMAND):
    aws                 为AWS创建keystore
    sleep               仅休眠，用于Docker测试
    version             打印程序版本
    docker-acceptance-test
                        用于Docker验收测试

可选参数:
  -h, --help            显示此帮助消息并退出

目录

1. 前言
   1. 图例
2. 环境要求
3. 使用Docker演示
4. 使用docker-compose演示
5. 配置
6. 许可协议
7. 参考资料

前言

在Senzing，我们致力于以"https://github.com/Senzing/knowledge-base/blob/main/WHATIS/dont-make-me-think.md%22%E7%9A%84%E9%A3%8E%E6%A0%BC%E5%88%9B%E5%BB%BAGitHub%E6%96%87%E6%A1%A3%E3%80%82%E5%A4%A7%E5%A4%9A%E6%95%B0%E6%83%85%E5%86%B5%E4%B8%8B%EF%BC%8C%E6%8C%87%E4%BB%A4%E6%98%AF%E5%8F%AF%E4%BB%A5%E7%9B%B4%E6%8E%A5%E5%A4%8D%E5%88%B6%E7%B2%98%E8%B4%B4%E7%9A%84%E3%80%82%E5%BD%93%E9%9C%80%E8%A6%81%E9%A2%9D%E5%A4%96%E6%80%9D%E8%80%83%E6%97%B6%EF%BC%8C%E4%BC%9A%E6%A0%87%E8%AE%B0%22%E6%80%9D%E8%80%83%22%E5%9B%BE%E6%A0%87%EF%BC%9Athinking:%EF%BC%9B%E5%BD%93%E9%9C%80%E8%A6%81%E8%87%AA%E5%AE%9A%E4%B9%89%E6%97%B6%EF%BC%8C%E4%BC%9A%E6%A0%87%E8%AE%B0%22%E9%93%85%E7%AC%94%22%E5%9B%BE%E6%A0%87%EF%BC%9Apencil2:%E3%80%82%E5%A6%82%E6%9E%9C%E6%8C%87%E4%BB%A4%E4%B8%8D%E6%B8%85%E6%99%B0%EF%BC%8C%E8%AF%B7%E9%80%9A%E8%BF%87%E5%88%9B%E5%BB%BA%E6%96%B0%E7%9A%84https://github.com/Senzing/keystore-generator/issues/new?template=documentation_request.md%E5%91%8A%E8%AF%89%E6%88%91%E4%BB%AC%E9%9C%80%E8%A6%81%E6%94%B9%E8%BF%9B%E7%9A%84%E5%9C%B0%E6%96%B9%E3%80%82%E7%8E%B0%E5%9C%A8%E5%BC%80%E5%A7%8B%E6%AD%A3%E6%96%87...

图例

1. :thinking: - "思考者"图标表示可能需要一些额外思考，可能需要做出选择，也可能是可选步骤。
2. :pencil2: - "铅笔"图标表示指令可能需要修改后才能执行。
3. :warning: - "警告"图标表示有需要注意的复杂操作。

环境要求

• 空间：此仓库和演示需要6 GB可用磁盘空间。
• 时间：根据CPU和网络速度，预计15分钟可完成演示的部署和运行。
• 背景知识：本仓库假设用户具备以下知识：
  • https://github.com/Senzing/knowledge-base/blob/main/WHATIS/docker.md

使用Docker演示

1. :pencil2: 指定子命令 示例：

   console
   export SENZING_SUBCOMMAND=aws
   

2. 运行Docker容器 示例：

   console
   sudo --preserve-env docker run \
     --env SENZING_SUBCOMMAND \
     --rm \
     senzing/keystore-generator
   

使用docker-compose演示

1. :pencil2: 指定本地主机上用于存放演示工件的新目录 示例：

   console
   export SENZING_VOLUME=~/my-senzing
   

   1. :warning: macOS - 必须为SENZING_VOLUME启用https://github.com/Senzing/knowledge-base/blob/main/HOWTO/share-directories-with-docker.md#macos%E3%80%82
   2. :warning: Windows - 必须为SENZING_VOLUME启用https://github.com/Senzing/knowledge-base/blob/main/HOWTO/share-directories-with-docker.md#windows%E3%80%82

2. 设置环境变量 示例：

   console
   export SENZING_ETC_DIR=${SENZING_VOLUME}/etc
   

3. 创建目录 示例：

   console
   mkdir -p ${SENZING_ETC_DIR}
   

4. :pencil2: 指定环境... 示例：

   console
   export SENZING_SUBCOMMAND=aws
   

5. 获取Docker镜像版本 示例：

   console
   curl -X GET \
       --output ${SENZING_VOLUME}/docker-versions-stable.sh \
       https://raw.githubusercontent.com/Senzing/knowledge-base/main/lists/docker-versions-stable.sh
   source ${SENZING_VOLUME}/docker-versions-stable.sh
   

6. 下载docker-compose.yaml和Docker镜像 示例：

   console
   curl -X GET \
       --output ${SENZING_VOLUME}/docker-compose.yaml \
       "https://raw.githubusercontent.com/Senzing/keystore-generator/main/docker-compose.yaml"
   cd ${SENZING_VOLUME}
   sudo --preserve-env docker-compose pull
   

7. 启动Senzing docker-compose堆栈 示例：

   console
   cd ${SENZING_VOLUME}
   sudo --preserve-env docker-compose up
   

8. 等待组件下载、启动和初始化

   1. 某些Docker日志中可能会出现错误，因为它们在等待依赖服务可用。docker-compose在编排Docker容器依赖方面不是最理想的。

配置

通过环境变量或命令行参数指定的配置值：

• https://github.com/Senzing/knowledge-base/blob/main/lists/environment-variables.md#senzing_database_url
• https://github.com/Senzing/knowledge-base/blob/main/lists/environment-variables.md#senzing_debug
• https://github.com/Senzing/knowledge-base/blob/main/lists/environment-variables.md#senzing_engine-configuration_json

许可协议

查看此Docker镜像中软件容器的许可信息。请注意，此许可不允许进一步分发。

此Docker镜像可能还包含来自https://github.com/Senzing/%E7%9A%84%E8%BD%AF%E4%BB%B6%EF%BC%8C%E8%BF%99%E4%BA%9B%E8%BD%AF%E4%BB%B6%E9%87%87%E7%94%A8Apache License 2.0许可。

此外，与所有Docker镜像一样，此镜像可能还包含其他采用其他许可的软件（如基础发行版中的Bash等，以及主要软件的任何直接或间接依赖项）。

对于任何预构建镜像的使用，镜像用户有责任确保对该镜像的任何使用都符合其中包含的所有软件的相关许可。

参考资料

1. 开发
2. 错误
3. 示例
4. 相关资源：
   1. https://hub.docker.com/r/senzing/keystore-generator
   2. https://github.com/Senzing/charts/tree/main/charts/senzing-keystore-generator