solutionsoft/timemachine-sidecar

Time Machine Sidecar for Kubernetes 镜像文档

镜像概述和主要用途

该镜像为Kubernetes环境设计的Time Machine Sidecar组件，集成Time Machine软件，提供软件虚拟时钟功能。其核心用途是为时间敏感型应用提供时间偏移测试能力，支持将应用"时间旅行"至过去或未来，验证日期和时间相关逻辑（如月末/季末/年末处理、计费周期、工作流、***生效及策略生命周期等）。镜像提供隔离测试环境，无需修改应用或数据库代码，且不会改变系统时钟，解决传统系统时钟重置耗时、易错及在Active Directory/Kerberos安全环境下不可行的问题。

核心功能和特性

• 虚拟时钟技术：提供独立于系统时钟的软件虚拟时钟，支持应用在时间维度前后"旅行"，精准模拟不同时间点场景。
• 应用透明性：对应用和数据库完全透明，无需修改代码即可实现时间偏移测试，降低测试成本和复杂度。
• 系统时钟保护：不修改主机或容器的系统时钟，避免因时钟变更导致的系统稳定性风险及安全环境限制（如Active Directory/Kerberos环境）。
• 隔离测试环境：可将待测试应用部署至容器中，提供独立的时间偏移测试环境，避免影响其他系统组件。
• 多场景支持：适配月末/季末/年末处理、计费周期验证、工作流时间逻辑、***生效时间点测试、策略生命周期管理等多种时间敏感场景。

使用场景和适用范围

• 时间敏感逻辑测试：需验证日期相关业务逻辑的应用，如财务系统月末结账、订阅服务计费周期、周期性工作流触发等。
• 安全环境测试：部署在Active Directory或Kerberos等强安全策略环境中，需进行时间相关测试但无法修改系统时钟的场景。
• 系统时钟保护需求：需避免因测试修改系统时钟导致的日志混乱、证书失效、分布式系统同步异常等问题的场景。

使用方法和配置说明

基本部署方式

作为Sidecar容器与应用容器部署在同一Kubernetes Pod中，通过共享网络或进程命名空间使应用使用Time Machine虚拟时钟。

部署示例

Docker Run 示例（单机测试）

bash
docker run -d \
  --name time-machine-sidecar \
  --network=app-network \
  [镜像名称]:[标签]

# 启动应用容器并连接至Sidecar网络
docker run -d \
  --name app-container \
  --network=app-network \
  [应用镜像名称]:[标签]

Kubernetes Deployment 示例（Sidecar模式）

yaml
apiVersion: apps/v1
kind: Deployment
metadata:
  name: time-sensitive-app
spec:
  replicas: 1
  template:
    spec:
      containers:
      - name: app
        image: [应用镜像名称]:[标签]
        # 应用容器配置
      - name: time-machine-sidecar
        image: [time-machine-sidecar镜像名称]:[标签]
        # Sidecar容器配置（根据实际需求添加环境变量或挂载配置文件）

配置说明

• 虚拟时钟参数：通过环境变量TIME_MACHINE_TARGET_TIME指定目标时间（格式：YYYY-MM-DD HH:MM:SS），控制应用感知的时间点。
• 隔离级别：可通过挂载配置文件/etc/timemachine/config.yaml自定义时间隔离范围（如仅应用进程、特定库或全容器）。
• 网络配置：确保Sidecar与应用容器在同一网络命名空间，使应用进程能通过本地接口访问虚拟时钟服务。

注：具体配置参数及高级用法请参考Time Machine官方文档，根据应用架构调整部署策略。