OSHA OiRA 统计部署

此包包含部署OSHA OiRA统计数据的配置和脚本。Buildout配置设置了一些metabase实例以提供服务，并生成管理它们的脚本。

设置

快速入门

创建一个如下的buildout.cfg

[buildout]
extends =
    base.cfg
    secrets.cfg

[secrets]
<= secrets-production

运行

# make

安装/更新

一次性

如果您是第一次安装，请确保创建了数据库（见下文）。如果您正在更新现有安装，通常只需调用

# make

或者等价地，

# make all

这会一次性设置所有内容，除了创建数据库 - 您可能需要以特权用户身份执行此操作，并且不需要在每次更新时运行，因此默认情况下不包括在内。有关说明，请参阅“创建数据库”。

逐步

如果您因某种原因导致一次性设置失败，或者您对细节感兴趣，请继续阅读逐步设置。

如果您处于一个具有管理密钥的环境，请使用以下命令解密密钥文件：

# gpg -d secrets.cfg.gpg > secrets.cfg

创建一个名为 buildout.cfg 的配置文件，该文件扩展 base.cfg，如果需要，还包括 secrets.cfg。

[buildout]
extends =
    base.cfg
    secrets.cfg

请确保您的 buildout.cfg 中有一个密钥部分，并且它从 secrets.cfg.gpg 中的正确部分继承。

[secrets]
<= secrets-production

否则请手动设置密码。

[secrets]
metabase-password = secret
ldap-password = secret

如果您想要绑定到不同于 localhost 的地址，请设置 metabase-host。

[metabase-instance]
metabase-host = oira.local

然后，像往常一样运行：

# bin/buildout

或者，通过以下方式解密和运行 buildout：

# make buildout

创建数据库

在第一次设置期间或遇到错误时

psql: FATAL:  database "xyz" does not exist

您需要初始化 postgresql 数据库。确保

• buildout 已成功运行 (make buildout 或 bin/buildout)
• PSQL_USER（请参阅 Makefile）设置为一个可以创建 postgresql 数据库的用户。
• 您当前的用户可以使用 sudo 变成 PSQL_USER。

一旦设置好，运行：

# make create-databases

或者，如果您已经以适当的用户登录

# psql -U postgres < scripts/create-databases.sql

然后重试 make all。

用法

入门

如果您已成功运行 make all，则可以跳过本节。

要设置 metabase 实例

# bin/init-metabase

或

# make init-metabase

这将为所有实例调用 bin/init-metabase-instance（见下文），并使用对应 buildout 部分中指定的参数。

之后，您可以使用在 buildout 配置中提供的凭据登录到 metabase 实例。

进行更改

要更改 metabase 内容，请修改 oira.statistics.deployment.content 中的数据。通过 UI 进行更改然后通过 API 获取相应的值可能更方便。您可以使用在 devel.cfg 中定义的 ipybase shell 来实现此目的。

要将更改应用到全局和区域实例，再次运行

# bin/init-metabase

init-metabase-instance

将设置应用于单个 metabase 实例。设置数据库连接参数并可选地创建其他用户。运行 init-metabase-instance --help 以查看参数。

init-metabase

通过删除所有数据库内容并在每个实例上运行 init-metabase-instance 来初始化所有 metabase 实例。不接收任何参数；buildout 直接将它们写入脚本。如果已设置环境变量 SKIP_DB_RESTORE，则不会删除数据库内容，而是保留。

变更日志

1.0.0 (2024-06-13)

• 首次发布