neo4j/helm-charts-operations

Neo4j Helm Chart 操作工具

1. 镜像概述和主要用途

本镜像是一个专为 Neo4j Helm Chart 设计的操作工具，旨在简化 Kubernetes (K8s) 环境中 Neo4j 集群的 Cypher 查询执行及集群管理操作。通过集成 Helm 包管理功能，该工具可无缝对接基于 Helm Chart 部署的 Neo4j 集群，提供便捷的查询执行、配置管理及状态监控能力，适用于自动化脚本、集群运维及数据操作场景。

2. 核心功能和特性

2.1 核心功能

• Cypher 查询执行：直接在 Neo4j 集群上执行 Cypher 语句，支持单条查询、批量脚本及文件导入。
• Helm Chart 集成：与 Neo4j Helm Chart 深度整合，支持集群部署参数校验、配置更新及版本管理。
• 集群连接管理：自动识别 Helm 部署的 Neo4j 集群服务端点，简化连接配置流程。

2.2 主要特性

• 集群兼容性：支持 Neo4j 单节点、因果集群及核心-只读副本架构。
• 认证支持：兼容 Neo4j 基本认证、LDAP 及 Kerberos（需额外配置）。
• 查询结果处理：支持 JSON、CSV 等多种输出格式，便于后续数据处理。
• 轻量级设计：最小化镜像体积，适配 K8s 资源受限环境。

3. 使用场景和适用范围

3.1 典型使用场景

• 集群数据管理：执行数据初始化脚本、索引创建、数据清理等维护操作。
• 自动化运维：集成 CI/CD 流水线，实现部署后自动执行验证查询或配置检查。
• 监控与诊断：定期执行集群健康检查查询（如 MATCH (n) RETURN count(n)）并输出监控指标。
• 批量数据迁移：通过脚本批量执行数据导入/导出相关 Cypher 命令。

3.2 适用范围

• 环境：Kubernetes 集群（1.21+），使用 Neo4j Helm Chart v4.0+ 部署的 Neo4j 集群。
• 用户：数据库管理员、DevOps 工程师、数据工程师（需熟悉 Cypher 语法及 K8s 基础）。
• 版本：支持 Neo4j 4.x/5.x 集群（社区版/企业版）。

4. 使用方法和配置说明

4.1 安装与部署

4.1.1 通过 Helm 安装（推荐）

bash
helm repo add neo4j-ops https://charts.example.com/neo4j-ops
helm repo update
helm install neo4j-ops neo4j-ops/neo4j-ops \
  --namespace neo4j \
  --set neo4j.uri="bolt://neo4j-cluster:7687" \
  --set neo4j.auth.user="neo4j" \
  --set neo4j.auth.password="your-password"

4.1.2 通过 Docker 运行（独立工具模式）

bash
docker run -it --rm \
  -e NEO4J_URI="bolt://neo4j-cluster:7687" \
  -e NEO4J_USER="neo4j" \
  -e NEO4J_PASSWORD="your-password" \
  -v $(pwd)/queries:/queries \
  example/neo4j-ops:latest

4.2 执行 Cypher 查询

4.2.1 交互式执行

通过工具的交互式终端输入 Cypher 语句：

bash
# 进入工具容器
kubectl exec -it -n neo4j neo4j-ops-0 -- /bin/bash

# 执行查询
neo4j-ops cypher run "MATCH (n:User) RETURN n.name LIMIT 5"

4.2.2 批量执行文件中的查询

将 Cypher 脚本保存为文件（如 init.cypher），挂载到容器并执行：

bash
# Docker 模式
docker run -it --rm \
  -e NEO4J_URI="bolt://neo4j-cluster:7687" \
  -e NEO4J_USER="neo4j" \
  -e NEO4J_PASSWORD="your-password" \
  -v $(pwd)/init.cypher:/scripts/init.cypher \
  example/neo4j-ops:latest \
  neo4j-ops cypher file /scripts/init.cypher --output json

4.3 配置参数说明

4.3.1 环境变量配置

4.3.2 Helm Chart 配置参数

5. 注意事项

• 生产环境中，建议通过 Kubernetes Secret 管理 NEO4J_PASSWORD 等敏感信息，避免明文配置。
• 执行大规模数据操作（如批量删除/更新）时，建议先在测试环境验证，并设置合理的事务超时时间。
• 工具镜像需与 Neo4j 集群版本兼容，具体版本对应关系参见官方 release 说明。