astarte/astarte_housekeeping_api

Astarte Housekeeping API

镜像概述和主要用途

Astarte Housekeeping API是Astarte集群的维护REST API，作为集群管理的核心接口，主要用于支持前端应用和开发人员对Astarte集群中的领域（realms）资源进行创建、配置和维护操作，是Astarte集群日常管理和配置的关键组件。

核心功能和特性

• 领域管理：提供创建、配置Astarte集群中领域资源的接口，支持领域初始化及参数调整
• RESTful架构：遵循REST设计规范，通过标准HTTP方法（GET、POST等）实现资源操作，便于集成和使用
• 多角色支持：同时面向前端应用和开发人员，提供灵活的集群配置入口

使用场景和适用范围

• Astarte集群部署初期：管理员通过该API创建初始管理领域，完成集群基础配置
• 日常集群维护：开发人员或运维人员需添加新领域、调整现有领域配置时使用
• 管理工具集成：前端管理平台、自动化脚本通过调用该API实现集群管理功能的集成

使用方法和配置说明

基本部署

通过Docker容器部署Astarte Housekeeping API的示例命令：

bash
docker run -d --name astarte-housekeeping-api \
  -p 4000:4000 \
  --network astarte-network \
  astarte/housekeeping-api:latest

环境变量配置

该镜像需通过环境变量进行必要配置（具体参数请参考官方文档）：

• ASTARTE_DATABASE_URL：数据库连接地址，用于存储领域配置数据
• ASTARTE_AUTH_JWT_SECRET：JWT认证密钥，用于API访问权限控制
• ASTARTE_HOUSEKEEPING_PORT：服务监听端口，默认4000

API调用示例

创建新领域的HTTP请求示例：

bash
POST /v1/realms
Content-Type: application/json
Authorization: Bearer <valid-jwt-token>

{
  "realm_name": "example-realm",
  "realm_config": {
    "replication_factor": 3,
    "retention_policy": "default"
  }
}

注：完整API规范及参数说明请参考Astarte官方文档，不同版本可能存在接口差异。