Chaos Toolkit Kubernetes 扩展使用教程

Chaos Toolkit Kubernetes 扩展使用教程

chaostoolkit-kubernetesKubernetes driver extension of the Chaos Toolkit probes and actions API项目地址:https://gitcode.com/gh_mirrors/ch/chaostoolkit-kubernetes

1. 项目的目录结构及介绍

Chaos Toolkit Kubernetes 扩展项目的目录结构如下：

chaostoolkit-kubernetes/
├── CHANGELOG.md
├── LICENSE
├── README.md
├── chaostoolkit/
│   ├── __init__.py
│   ├── kubernetes/
│   │   ├── __init__.py
│   │   ├── actions.py
│   │   ├── probes.py
│   │   └── ...
│   └── ...
├── pdm.lock
├── pyproject.toml
└── tests/
    ├── __init__.py
    ├── test_actions.py
    ├── test_probes.py
    └── ...

目录结构介绍

• CHANGELOG.md: 记录项目版本变更历史。
• LICENSE: 项目许可证文件。
• README.md: 项目介绍和使用说明。
• chaostoolkit/: 包含项目的主要代码文件。
  • kubernetes/: Kubernetes 相关的操作和探针。
    • actions.py: 定义 Kubernetes 操作动作。
    • probes.py: 定义 Kubernetes 探针。
• pdm.lock: 项目依赖锁定文件。
• pyproject.toml: 项目配置文件。
• tests/: 包含项目的测试文件。
  • test_actions.py: 测试 Kubernetes 操作动作。
  • test_probes.py: 测试 Kubernetes 探针。

2. 项目的启动文件介绍

Chaos Toolkit Kubernetes 扩展项目没有明确的“启动文件”，因为它是一个库，需要通过 Chaos Toolkit 实验文件来调用其功能。实验文件通常是一个 JSON 或 YAML 文件，定义了如何执行 Chaos Engineering 实验。

例如，一个简单的实验文件如下：

{
  "title": "Do we remain available in face of pod going down",
  "description": "We expect Kubernetes to handle the situation gracefully when a pod goes down",
  "tags": ["kubernetes"],
  "steady-state-hypothesis": {
    "title": "Verifying service remains healthy",
    "probes": [
      {
        "name": "all-our-microservices-should-be-healthy",
        "type": "probe",
        "tolerance": true,
        "provider": {
          "type": "python",
          "module": "chaosk8s.probes",
          "func": "microservice_available_and_healthy",
          "arguments": {
            "name": "myapp"
          }
        }
      }
    ]
  },
  "method": [
    {
      "type": "action",
      "name": "terminate-pod",
      "provider": {
        "type": "python",
        "module": "chaosk8s.pod.actions",
        "func": "terminate_pods",
        "arguments": {
          "label_selector": "app=myapp",
          "name_pattern": "myapp",
          "rand": true
        }
      }
    }
  ]
}

3. 项目的配置文件介绍

Chaos Toolkit Kubernetes 扩展项目的主要配置文件是 pyproject.toml，它使用 PDM (Python Development Master) 进行依赖管理和项目配置。

pyproject.toml 文件内容示例

[project]
name = "chaostoolkit-kubernetes"
version = "0.0.1"
description = "Kubernetes driver extension of the Chaos Toolkit probes and actions API"
authors = [
    { name="Chaos Toolkit Contributors", email="contact@chaostoolkit.org" }
]
license = { file="LICENSE" }
readme = "README.md"
requires-python = ">=3.6"
dependencies = [
    "chaostoolkit>=1.0.0",
    "kubernetes>=12.0.0"
]

[build-system]
requires = ["pdm-pep517"]
build-backend = "pdm.pep517.api"

配置文件介绍

• [project]: 项目基本信息，包括名称、版本、描述、作者、许可证等。
• dependencies: 项目依赖列表，包括 Chaos Toolkit 和 Kubernetes 库。

chaostoolkit-kubernetesKubernetes driver extension of the Chaos Toolkit probes and actions API项目地址:https://gitcode.com/gh_mirrors/ch/chaostoolkit-kubernetes