如何检测Kubernetes YAML文件中重复的环境变量？

PyYAML本身不会自动检测数组内的重复环境变量名，但我们可以在解析YAML后，通过遍历容器的环境变量列表来实现检测。以下是一个实用的Python实现示例：

实现脚本 #

import yaml
import os
from collections import Counter

def check_duplicate_env_vars(file_path):
    try:
        with open(file_path, 'r', encoding='utf-8') as f:
            data = yaml.safe_load(f)
            if not data:
                return
            
            # 适配不同K8s资源类型的结构（Pod、Deployment、ReplicationController等）
            spec = data.get('spec', {})
            # 处理带template的资源（如Deployment、ReplicationController）
            if 'template' in spec:
                container_spec = spec.get('template', {}).get('spec', {})
            else:
                # 处理Pod这类直接包含containers的资源
                container_spec = spec
            
            containers = container_spec.get('containers', [])
            for container_idx, container in enumerate(containers):
                env_list = container.get('env', [])
                # 提取所有非空的环境变量名
                env_names = [env.get('name') for env in env_list if env.get('name')]
                # 统计重复项
                duplicate_counts = Counter(env_names)
                duplicates = [name for name, count in duplicate_counts.items() if count > 1]
                
                if duplicates:
                    print(f"文件: {file_path}")
                    print(f"容器索引: {container_idx}")
                    print(f"重复环境变量: {', '.join(duplicates)}\n")
    except Exception as e:
        print(f"处理文件 {file_path} 时出错: {str(e)}\n")

def scan_k8s_yamls(directory):
    """遍历指定目录下所有YAML文件进行检测"""
    for root, _, files in os.walk(directory):
        for file in files:
            if file.lower().endswith(('.yaml', '.yml')):
                full_path = os.path.join(root, file)
                check_duplicate_env_vars(full_path)

if __name__ == '__main__':
    # 替换为你的Kubernetes YAML文件所在目录
    target_directory = "./k8s-resources"
    scan_k8s_yamls(target_directory)

使用说明 #

1. 将脚本中的target_directory替换为你的YAML文件所在的实际目录
2. 运行脚本后，会输出所有包含重复环境变量的文件路径、对应容器索引以及重复的变量名
3. 脚本兼容多种K8s资源类型（Pod、Deployment、ReplicationController等），自动适配不同的YAML结构

关键点说明 #

• 利用collections.Counter统计环境变量名的出现次数，快速定位重复项
• 适配不同K8s资源的YAML结构，无论是带template的控制器资源，还是直接定义的Pod资源都能处理
• 捕获文件读取和解析时的异常，避免单个文件出错导致整个扫描中断

内容的提问来源于stack exchange，提问作者Aziz Zoaib