init-postgresql

概要

初始化用于Senzing的PostgreSQL数据库。

概述

init-postgresql.py Python脚本是一个“一次性运行”（run-to-completion）任务，用于初始化与Senzing配合使用的PostgreSQL数据库。它会创建Senzing数据库模式，并向数据库中填充初始Senzing配置。

senzing/init-postgresql Docker镜像是一个包装器，用于Docker环境（如docker-compose、kubernetes）。

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

console
$ ./init-postgresql.py
usage: init-postgres.py [-h] {mandatory,sleep,version,docker-acceptance-test} ...

添加描述。有关更多信息，请参见 [***]

positional arguments:
  {mandatory,sleep,version,docker-acceptance-test}
                        子命令 [SENZING_SUBCOMMAND]:
    mandatory           执行必要的初始化任务。
    sleep               仅休眠，不执行其他操作。用于Docker测试。
    version             打印程序版本。
    docker-acceptance-test
                        用于Docker验收测试。

optional arguments:
  -h, --help            显示此帮助消息并退出

目录

1. 前言
   1. 图例
2. 预期
3. 使用Docker演示
4. 使用docker-compose演示
5. 配置
6. 许可证
7. 参考资料

前言

在Senzing，我们努力创建符合“别让我思考”风格的GitHub文档。在大多数情况下， instructions都是“复制粘贴”式的。当需要思考时，会标记“思考”图标 :thinking:；当需要自定义时，会标记“铅笔”图标 :pencil2:。如果说明不清晰，请通过创建新的文档问题告诉我们需要改进的地方。现在开始正文...

图例

1. :thinking: - “思考者”图标表示可能需要一些额外思考。可能需要做出选择，或者这是一个可选步骤。
2. :pencil2: - “铅笔”图标表示说明可能需要修改后再执行。
3. :warning: - “警告”图标表示有需要注意的 tricky 部分，请特别关注。

预期

• 空间：此仓库和演示需要6 GB的可用磁盘空间。
• 时间：根据CPU和网络速度，预计需要15分钟才能使演示启动并运行。
• 背景知识：此仓库假设用户具备以下知识：
  • Docker

使用Docker演示

1. :pencil2: 指定数据库连接信息。示例：

   console
   export DATABASE_PROTOCOL=postgresql
   export DATABASE_USERNAME=postgres
   export DATABASE_PASSWORD=postgres
   export DATABASE_HOST=example.com
   export DATABASE_PORT=5432
   export DATABASE_DATABASE=G2
   

2. :thinking: 提示：不要将DATABASE_HOST设置为localhost或127.0.0.1，因为这会假设数据库在Docker容器内部。如果数据库在本地系统上运行，可通过以下方法查找本地系统的IP地址。示例：

   console
   export DATABASE_HOST=$(curl --silent [***] | python3 -)
   

3. 构造数据库URL。示例：

   console
   export SENZING_DATABASE_URL="${DATABASE_PROTOCOL}://${DATABASE_USERNAME}:${DATABASE_PASSWORD}@${DATABASE_HOST}:${DATABASE_PORT}/${DATABASE_DATABASE}"
   

4. 运行Docker容器。示例：

   console
   sudo --preserve-env docker run \
     --env SENZING_DATABASE_URL \
     --rm \
     senzing/init-postgresql mandatory
   

5. 替代方案：运行Docker容器。示例：

   console
   sudo --preserve-env docker run \
     --env SENZING_DATABASE_URL \
     --env SENZING_SUBCOMMAND=mandatory \
     --rm \
     senzing/init-postgresql
   

使用docker-compose演示

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

   console
   export SENZING_VOLUME=~/my-senzing
   

   1. :warning: macOS - 必须为SENZING_VOLUME启用文件共享。
   2. :warning: Windows - 必须为SENZING_VOLUME启用文件共享。

2. 设置环境变量。示例：

   console
   export PGADMIN_DIR=${SENZING_VOLUME}/pgadmin
   export POSTGRES_DIR=${SENZING_VOLUME}/postgres
   

3. 创建目录。示例：

   console
   mkdir -p ${PGADMIN_DIR} ${POSTGRES_DIR}
   

4. 获取Docker镜像版本。示例：

   console
   curl -X GET \
       --output ${SENZING_VOLUME}/docker-versions-stable.sh \
       [***]
   source ${SENZING_VOLUME}/docker-versions-stable.sh
   

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

   console
   curl -X GET \
       --output ${SENZING_VOLUME}/docker-compose.yaml \
       "[***]"
   cd ${SENZING_VOLUME}
   sudo --preserve-env docker-compose pull
   

6. 启动Senzing docker-compose栈。示例：

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

7. 允许时间让组件下载、启动和初始化。

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

配置

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

• SENZING_CONFIGURATION_MODIFICATIONS
• SENZING_DATABASE_URL
• SENZING_DEBUG
• SENZING_ENGINE_CONFIGURATION_JSON
• SENZING_INPUT_SQL_URL
• SENZING_SUBCOMMAND

许可证

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

此Docker镜像可能还包含来自Senzing GitHub社区的软件，采用Apache License 2.0许可。

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

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

参考资料

1. 开发
2. 错误
3. 示例
4. 相关工件：
   1. DockerHub
   2. Helm Chart