Quick Start 快速上手#

批量部署服务器配置数据#

  1. 修改配置数据的 Schema: 修改 acore_server_config/config/define/server.py 模块即可.

  2. 根据配置数据的 Schema, 填入配置数据:

    • 对于非敏感数据, 可以填入 config/config.json 中

    • 对于敏感数据, 可以填入 ${HOME}/.projects/acore_server_config/config-secret.json 中. 本项目中各种账号密码, 服务配置都属于敏感数据.

  3. 部署配置数据: 运行 python config/deploy_parameter.py 脚本即可将配置部署到 AWS S3 中 (之所以不用 parameter store 是因为配置数据可能会很大).

在 EC2 服务器上读取对应的配置数据#

当你需要让 EC2 上面的脚本自行找到属于自己的配置数据时, 你可以在 EC2 服务器上的自动化脚本中插入以下代码:

>>> from acore_server_config.api import Ec2ConfigLoader
>>> server = Ec2ConfigLoader.load(server_id="sbx-blue")
>>> server
Server(id='sbx-blue', db_admin_password='sbx*dummy4test', db_username='myuser', db_password='sbx*dummy4test', ...)

如果你不想使用默认的 boto session (默认使用 EC2 的 IAM Instance Profile), 或想要更改 s3folder_config 或 parameter_name_prefix, 你可以这样:

>>> from boto_session_manager import BotoSesManager
>>> bsm = BotoSesManager(
...     profile_name=...,
...     region_name=...,
...     aws_access_key_id=...,
...     aws_secret_access_key=...,
... )
# 这样
>>> server = get_server(bsm, s3folder_config="s3://mybucket/myfolder/config/")
# 或这样
>>> server = get_server(bsm, parameter_name_prefix="your_own_prefix")

在其他项目中读取服务器的配置数据#

当你在其他项目中需要读取服务器的配置数据时, 你可以这样:

>>> from acore_server_config.api import ConfigLoader
>>> config_loader = ConfigLoader.new(
...     bsm=self.bsm,
...     env_name="sbx",
... )
>>> for server_name, server in config_loader.iter_servers():
...
>>> server = config_loader.get_server(server_name="blue")
>>> server
Server(id='sbx-blue', db_admin_password='sbx*dummy4test', db_username='myuser', db_password='sbx*dummy4test')