litmuschaos/ansible-runner

Litmus 镜像技术文档

1. 镜像概述和主要用途

1.1 镜像概述

Litmus 是一个 Kubernetes 原生的混沌工程工具集，旨在通过模拟真实世界故障场景，帮助云原生开发者和 SRE 团队验证系统韧性、发现潜在弱点，并提升生产环境中 Kubernetes 部署的稳定性。Litmus 基于 Kubernetes 自定义资源定义（CRD）构建，提供声明式的混沌实验配置与执行能力，实现故障注入、编排与监控的全流程自动化。

1.2 主要用途

• 生产环境 Kubernetes 集群稳定性测试：模拟节点故障、网络延迟、服务不可用等场景，验证系统容错能力。
• 云原生应用韧性验证：针对微服务、有状态应用（如数据库、消息队列）等，测试其在故障下的恢复能力。
• SRE 日常混沌演练：通过标准化混沌实验流程，常态化验证系统韧性，降低生产故障风险。

2. 核心功能和特性

2.1 Kubernetes 原生设计

• 基于 CRD 实现混沌实验定义（ChaosExperiment）、执行引擎（ChaosEngine）和结果监控（ChaosResult），与 Kubernetes 控制平面深度集成，支持声明式配置与生命周期管理。

2.2 混沌实验全流程支持

• 故障注入：覆盖节点、Pod、网络、存储、应用配置等多维度故障（如 Pod 驱逐、网络分区、CPU 压力等）。
• 编排能力：支持串行/并行执行多故障场景，可配置故障持续时间、重试策略、目标资源选择规则（如标签、命名空间）。
• 监控与反馈：自动记录混沌实验状态（ChaosResult CRD），集成 Prometheus 指标，支持故障影响可视化与结果分析。

2.3 易用性与可扩展性

• 提供预定义混沌实验模板（如 pod-delete、node-cpu-hog），支持自定义故障场景（通过编写 CRD 或扩展实验镜像）。
• 兼容主流 Kubernetes 发行版（EKS、GKE、AKS、自建集群等），支持多集群管理。

3. 使用场景和适用范围

3.1 适用场景

• 生产环境稳定性测试：在不中断业务的前提下，模拟基础设施或应用层故障，验证自动恢复机制（如 Deployment 自愈、StatefulSet 故障转移）。
• 云原生应用发布前验证：针对新部署的微服务，通过混沌实验验证服务降级、限流、熔断等韧性策略有效性。
• SRE 混沌演练：定期执行标准化混沌实验（如每月一次节点故障演练），积累系统韧性基线数据。

3.2 适用范围

• 目标集群：Kubernetes v1.19+ 集群（推荐 v1.21+ 以获得完整 CRD 支持）。
• 用户角色：云原生开发者、SRE、平台工程师、DevOps 团队。
• 支持应用类型：无状态服务（Deployment）、有状态服务（StatefulSet）、Operator 管理的应用（如数据库、消息中间件）。

4. 详细使用方法和配置说明

4.1 前置条件

• Kubernetes 集群（v1.19+），集群节点需支持 Pod 调度（至少 2 CPU 核心、4GB 内存）。
• kubectl 命令行工具（已配置集群访问权限）。
• Helm v3.5+（可选，用于简化安装）。

4.2 安装步骤

4.2.1 通过 Helm 安装（推荐）

bash
# 添加 Litmus 仓库
helm repo add litmuschaos https://litmuschaos.github.io/litmus-helm/
helm repo update

# 安装 Litmus 核心组件（混沌控制器、CRD、实验模板）
helm install litmus litmuschaos/litmus --namespace litmus --create-namespace

4.2.2 通过 kubectl 安装

bash
# 应用 Litmus CRD 与控制器部署清单
kubectl apply -f https://raw.githubusercontent.com/litmuschaos/litmus/master/litmus-operator-v2.14.0.yaml

4.3 核心配置参数

4.3.1 混沌实验定义（ChaosExperiment CRD）

4.3.2 混沌引擎配置（ChaosEngine CRD）

4.4 环境变量（控制器组件）

Litmus 控制器（litmus-controller）支持通过环境变量调整运行参数，常见配置如下：

5. 部署与使用示例

5.1 安装 Litmus 核心组件

通过 Helm 安装 Litmus 到 litmus 命名空间：

bash
helm install litmus litmuschaos/litmus \
  --namespace litmus \
  --create-namespace \
  --set controller.logLevel=debug  # 可选：调整日志级别为 debug

5.2 创建混沌实验示例（Pod 驱逐实验）

1. 创建 ChaosExperiment CRD（定义故障类型）：

yaml
# pod-delete-experiment.yaml
apiVersion: litmuschaos.io/v1alpha1
kind: ChaosExperiment
metadata:
  name: pod-delete
  namespace: litmus
spec:
  targets:
    - kind: Pod
      name: ""  # 留空表示通过标签选择
      label: "app=nginx"  # 目标 Pod 标签
  chaosDuration: "60s"  # 故障持续 60 秒
  faults:
    - name: pod-delete
      params:
        - name: duration
          value: "30s"  # 单次 Pod 驱逐后，30 秒内不再重复驱逐

应用配置：

bash
kubectl apply -f pod-delete-experiment.yaml

2. 创建 ChaosEngine CRD（执行实验）：

yaml
# nginx-pod-delete-engine.yaml
apiVersion: litmuschaos.io/v1alpha1
kind: ChaosEngine
metadata:
  name: nginx-pod-delete
  namespace: default
spec:
  appinfo:
    appns: "default"  # 目标应用命名空间
    applabel: "app=nginx"  # 目标应用标签
  experiments:
    - name: pod-delete  # 引用上述 ChaosExperiment 名称
      rank: 1  # 优先级 1（立即执行）

应用配置并启动实验：

bash
kubectl apply -f nginx-pod-delete-engine.yaml

3. 监控实验结果：
   查看 ChaosResult CRD 状态：

bash
kubectl get chaosresult nginx-pod-delete -n default -o yaml

结果中 status.verdict 字段为 Pass 表示实验执行成功，status.failureReason 会记录失败原因（如目标 Pod 不存在）。

6. 注意事项

• 生产环境风险：首次执行混沌实验前，建议在测试集群验证，避免对生产业务造成中断（如先执行低影响实验，如 pod-delete 而非 node-failure）。
• 权限要求：Litmus 控制器需要集群级权限（ClusterRole）以操作节点、网络等资源，生产环境需限制最小权限范围。
• 版本兼容性：确保 Litmus 版本与 Kubernetes 集群版本匹配（参考 Litmus 官方兼容性矩阵）。