nypl/circ-deploy

circulation-docker

这些是Library Simplified https://github.com/NYPL-Simplified/circulation_manager%E7%9A%84Docker%E9%95%9C%E5%83%8F%E3%80%82%E5%AE%83%E4%BB%AC%E9%80%9A%E8%BF%87%E5%90%91%60NYPL-Simplified/circulation-docker%60 GitHub仓库提交https://github.com/NYPL-Simplified/circulation-docker/pulls%E8%BF%9B%E8%A1%8C%E6%9B%B4%E6%96%B0%E3%80%82

内容：

• 什么是循环管理器？
• 使用此镜像
• 环境变量
• 早期版本说明
• 额外配置
• 贡献指南

什么是循环管理器？

循环管理器是图书馆馆藏与Library Simplified各类客户端应用之间的主要连接点。它处理用户认证，将授权作品与来自https://github.com/NYPL-Simplified/content_server%E7%9A%84%E5%BC%80%E6%94%BE%E8%8E%B7%E5%8F%96%E5%86%85%E5%AE%B9%E7%9B%B8%E7%BB%93%E5%90%88%EF%BC%8C%E4%BB%8Ehttps://github.com/NYPL-Simplified/metadata_wrangler%E6%8B%89%E5%8F%96%E6%9B%B4%E6%96%B0%E7%9A%84%E5%9B%BE%E4%B9%A6%E4%BF%A1%E6%81%AF%EF%BC%8C%E5%B9%B6%E4%BB%A5%E9%80%82%E5%BD%93%E7%BB%84%E7%BB%87%E7%9A%84OPDS feed形式提供可用图书。

此目录中的Dockerfile创建两个不同但必要的容器来部署循环管理器：

• circ-webapp（已弃用： circ-deploy）：使用Nginx和uWSGI启动API和管理界面的容器https://github.com/NYPL-Simplified/Simplified/wiki/Deployment:-Nginx-&-uWSGI
• circ-scripts：按推荐间隔调度和运行重要 cron 任务的容器

为避免数据库锁定，circ-scripts应部署为单实例。

使用此镜像

您需要PostgreSQL实例URL，格式为postgres://[用户名]:[密码]@[主机]:[端口]/[数据库名]。使用此URL，您可以为Web应用（circ-webapp）和后台 cron 任务（circ-scripts）创建容器，这些任务用于导入和更新图书，以及保持应用平稳运行。任一容器均可用于初始化或迁移数据库。首次部署到全新数据库时，首次运行容器可使用默认SIMPLIFIED_DB_TASK='auto'，或手动运行SIMPLIFIED_DB_TASK='init'。更多信息请参见下文“环境变量”部分。

circ-webapp（已弃用： circ-deploy）

# 有关此处列出的值及其替代方案的更多信息，请参见下文“环境变量”部分。
$ docker run --name webapp \
    -d -p 80:80 \
    -e SIMPLIFIED_PRODUCTION_DATABASE='postgres://[用户名]:[密码]@[主机]:[端口]/[数据库名]' \
    nypl/circ-webapp:2.1

在浏览器中导航至http://localhost/admin以输入或更新配置信息。如果您尚未创建管理员授权协议，则需要先创建它才能设置其他配置。

有关整个循环管理器工具套件的故障排除信息和安装指南，请查看https://github.com/NYPL-Simplified/Simplified/wiki/Deployment:-Quickstart-with-Docker%E3%80%82

circ-scripts

# 有关此处列出的值及其替代方案的更多信息，请参见下文“环境变量”部分。
$ docker run --name scripts -d \
    -e TZ='您的时区字符串' \
    -e SIMPLIFIED_PRODUCTION_DATABASE='postgres://[用户名]:[密码]@[主机]:[端口]/[数据库名]' \
    nypl/circ-scripts:2.1

在控制台中使用docker exec -it scripts /bin/bash，导航到容器中的/var/log/simplified目录。5-20分钟后，您将看到日志文件填充该目录。

有关整个循环管理器工具套件的故障排除信息和安装指南，请查看https://github.com/NYPL-Simplified/Simplified/wiki/Deployment:-Quickstart-with-Docker%E3%80%82

circ-exec

此镜像构建的容器将运行单个脚本后停止。它适用于Amazon ECS计划任务等工具，您可以按 cron 风格的计划运行脚本容器。

与持续运行并执行所有可能的维护脚本（无论您的配置是否需要）的circ-scripts镜像不同，circ-exec提供对Library Simplified循环管理器任务的更细致控制。查找推荐任务及其推荐频率的最准确位置是https://github.com/NYPL-Simplified/circulation/blob/main/docker/services/simplified_crontab%E3%80%82

由于基于circ-exec的容器在构建、运行任务后被销毁，因此配置外部日志聚合器以查找/var/log/simplified/${SIMPLIFIED_SCRIPT_NAME}.log中的.log文件非常重要。

# 有关此处列出的值及其替代方案的更多信息，请参见下文“环境变量”部分。
$ docker run --name refresh-materialized-views -it \
    -e SIMPLIFIED_SCRIPT_NAME='refresh_materialized_views' \
    -e SIMPLIFIED_PRODUCTION_DATABASE='postgres://[用户名]:[密码]@[主机]:[端口]/[数据库名]' \
    nypl/circ-exec:2.1

环境变量

环境变量可通过docker run命令的-e VARIABLE_KEY='variable_value'选项设置。SIMPLIFIED_PRODUCTION_DATABASE是唯一必填的环境变量。

SIMPLIFIED_CONFIGURATION_FILE

可选。容器中配置文件的完整路径。配置现在存储在数据库中，并通过/admin的管理界面访问，因此您可能不需要此变量。如果需要，请使用https://github.com/NYPL-Simplified/Simplified/wiki/Configuration%E4%B8%BA%E6%82%A8%E7%89%B9%E5%AE%9A%E5%9B%BE%E4%B9%A6%E9%A6%86%E7%9A%84%E9%85%8D%E7%BD%AE%E5%88%9B%E5%BB%BAJSON%E6%96%87%E4%BB%B6%E3%80%82%E5%A6%82%E6%9E%9C%E6%82%A8%E4%B8%8D%E7%86%9F%E6%82%89JSON%EF%BC%8C%E5%8F%AF%E4%BB%A5%E4%BD%BF%E7%94%A8%E6%AD%A4JSON%E6%A0%BC%E5%BC%8F%E5%8C%96%E5%99%A8%E5%92%8C%E9%AA%8C%E8%AF%81%E5%99%A8%E9%AA%8C%E8%AF%81%E6%82%A8%E7%9A%84%E9%85%8D%E7%BD%AE%E6%96%87%E4%BB%B6%E3%80%82

SIMPLIFIED_DB_TASK

可选。在容器运行时对数据库执行任务。选项包括：

• auto：根据数据库是否为新数据库，初始化或迁移数据库。这是默认值。
• ignore：不执行任何操作。
• init：针对全新数据库初始化应用。如果您首次运行循环管理器，请使用此值设置Elasticsearch别名并为未来迁移准备数据库模式。
• migrate：将现有数据库迁移到新版本。从一个稳定版本切换到另一个稳定版本时使用此值。

SIMPLIFIED_PRODUCTION_DATABASE

必填。应用的生产PostgreSQL数据库URL。

SIMPLIFIED_TEST_DATABASE

可选。用于测试的PostgreSQL数据库URL。此可选变量允许在容器中运行单元测试。

TZ

可选。仅适用于circ-scripts。cron运行计划脚本应使用的时区——通常是循环管理器实例上图书馆的时区。此值应根据Debian系统时区选项选择。此值允许脚本在理想时间运行。

构建新镜像

如果您计划使用循环管理器的稳定版本，我们强烈建议使用https://hub.docker.com/r/nypl/%E4%B8%8A%E5%8F%91%E5%B8%83%E7%9A%84%E6%9C%80%E6%96%B0%E7%A8%B3%E5%AE%9A%E7%89%88%E6%9C%AC%E7%9A%84circ-webapp%E5%92%8Ccirc-scripts%E3%80%82%E7%84%B6%E8%80%8C%EF%BC%8C%E5%9C%A8%E5%BC%80%E5%8F%91%E8%BF%87%E7%A8%8B%E4%B8%AD%EF%BC%8C%E6%82%A8%E5%8F%AF%E8%83%BD%E9%9C%80%E8%A6%81%E4%B8%BA%E5%BE%AA%E7%8E%AF%E7%AE%A1%E7%90%86%E5%99%A8%E7%9A%84%E7%89%B9%E5%AE%9A%E7%89%88%E6%9C%AC%E6%9E%84%E5%BB%BADocker%E5%AE%B9%E5%99%A8%E3%80%82%E5%A6%82%E6%9E%9C%E6%98%AF%E8%BF%99%E6%A0%B7%EF%BC%8C%E8%AF%B7%E4%BD%BF%E7%94%A8%E4%BB%A5%E4%B8%8B%E8%AF%B4%E6%98%8E%E3%80%82

我们建议您至少安装Docker引擎18.06版本和Docker Compose 1.24版本。

> .webapp 和 .scripts

确定您要构建的容器，并相应更新下面列出的标签和Dockerfile。

sh
$ docker build --build-arg version=您需要的分支或提交 \
    --tag circ-scripts:development \
    --file Dockerfile.scripts \
    --no-cache .

您必须使用--no-cache选项运行此命令，否则容器中的代码不会从上一次构建更新，这会违背构建的目的并增加整体混乱。您可以随意更改镜像标签。

就是这样！按照https://github.com/NYPL-Simplified/Simplified/wiki/Deployment:-Quickstart-with-Docker%E4%B8%AD%E7%9A%84%E8%AF%A6%E7%BB%86%E8%AF%B4%E6%98%8E%E8%BF%90%E8%A1%8C%E6%82%A8%E7%9A%84%E5%AE%B9%E5%99%A8%E3%80%82%E8%AF%B7%E8%AE%B0%E4%BD%8F%EF%BC%8C%E5%A6%82%E6%9E%9C%E6%82%A8%E4%BD%BF%E7%94%A8%E7%8E%B0%E6%9C%89%E7%89%88%E6%9C%AC%E7%9A%84%E6%95%B0%E6%8D%AE%E5%BA%93%EF%BC%8C%E5%8F%AF%E8%83%BD%E9%9C%80%E8%A6%81%E8%BF%90%E8%A1%8C%E8%BF%81%E7%A7%BB%E6%88%96%E9%85%8D%E7%BD%AE%E3%80%82

> 使用docker-compose进行本地测试

https://github.com/NYPL-Simplified/Simplified/wiki/Deployment:-Quickstart-with-Docker%E4%B8%AD%E6%8F%8F%E8%BF%B0%E7%9A%84%E6%95%B4%E4%B8%AA%E8%AE%BE%E7%BD%AE%E5%8F%AF%E4%BB%A5%E4%BD%BF%E7%94%A8%60version=$%E6%82%A8%E9%9C%80%E8%A6%81%E7%9A%84%E5%88%86%E6%94%AF%E6%88%96%E6%8F%90%E4%BA%A4 docker-compose up`一次性运行。这对于本地测试功能分支和/或新Docker构建的成功非常有用。

此参考包含许多关于docker-compose up选项和设置的精彩信息，但-d将在后台运行容器。docker-compose run允许您使用Dockerfile中设置以外的命令和设置运行应用，以进一步支持测试。

如果您使用Docker for Mac，请留意/Users/courteneyervin/Library/Containers/com.docker.docker/Data/com.docker.driver.amd64-linux/Docker.qcow2文件的大小，它在本地测试期间可能会变得相当大。定期删除它将删除所有现有容器，但也避免其膨胀导致的性能下降。

额外配置

如果您想使用不同的工具处理LS循环管理器的部署，欢迎您这样做！我们很乐意支持更多部署配置；请随时将您可能做的任何更改贡献到https://github.com/NYPL-Simplified/circulation-docker%EF%BC%81

贡献指南

我们欢迎您对新功能、修复或更新的贡献，无论大小；我们总是很高兴收到拉取请求，并尽力尽快处理它们。

在开始编码之前，我们建议通过https://github.com/NYPL-Simplified/circulation-docker/issues/new%E8%AE%A8%E8%AE%BA%E6%82%A8%E7%9A%84%E8%AE%A1%E5%88%92%EF%BC%8C%E5%B0%A4%E5%85%B6%E6%98%AF%E5%AF%B9%E4%BA%8E%E6%9B%B4%E5%AE%8F%E5%A4%A7%E7%9A%84%E8%B4%A1%E7%8C%AE%E3%80%82%E8%BF%99%E7%BB%99%E5%85%B6%E4%BB%96%E8%B4%A1%E7%8C%AE%E8%80%85%E4%B8%80%E4%B8%AA%E6%9C%BA%E4%BC%9A%E4%B8%BA%E6%82%A8%E6%8C%87%E6%98%8E%E6%AD%A3%E7%A1%AE%E6%96%B9%E5%90%91%EF%BC%8C%E5%AF%B9%E6%82%A8%E7%9A%84%E8%AE%BE%E8%AE%A1%E6%8F%90%E4%BE%9B%E5%8F%8D%E9%A6%88%EF%BC%8C%E5%B9%B6%E5%B8%AE%E5%8A%A9%E6%82%A8%E4%BA%86%E8%A7%A3%E6%98%AF%E5%90%A6%E6%9C%89%E4%BA%BA%E6%AD%A3%E5%9C%A8%E5%A4%84%E7%90%86%E7%9B%B8%E5%90%8C%E7%9A%84%E4%BA%8B%E6%83%85%E3%80%82

（注意： 本README旨在直接反映https://hub.docker.com/r/nypl/circ-webapp/%E3%80%82%EF%BC%89

许可证

Copyright © 2015 The New York Public Library, Astor, Lenox, and Tilden Foundations

Licensed under the Apache License, Version 2.0 (the "License");
you may not use this file except in compliance with the License.
You may obtain a copy of the License at

   [***]

Unless required by applicable law or agreed to in writing, software
distributed under the License is distributed on an "AS IS" BASIS,
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
See the License for the specific language governing permissions and
limitations under the License.