cilium/microscope

Cilium Microscope

镜像概述和主要用途

Cilium Microscope 是一个网络流量监控工具，允许用户查看 Kubernetes 集群中所有 Cilium 节点的 cilium monitor 输出，通过简单易用的命令实现与集群内 Cilium 节点的交互，帮助用户高效监控和分析网络流量情况。

核心功能和特性

• 聚合展示集群中所有 Cilium 节点的网络流量监控数据
• 提供简洁的命令行交互界面，降低操作复杂度
• 支持 Kubernetes 集群内部署，包含必要的 RBAC 权限配置
• 支持本地运行模式，依赖 Python 3.5 及以上版本

使用场景和适用范围

适用于 Kubernetes 集群环境中 Cilium 网络的监控与分析场景，包括但不限于：网络问题排查、流量行为分析、Cilium 功能验证、集群网络状态监控等。

使用方法和配置说明

在 Kubernetes 集群中运行

提供两种部署方式，根据集群 RBAC 配置选择：

1. 通过 YAML 文件部署（推荐，包含 RBAC 配置）
   执行以下命令创建包含 RBAC 对象的 Microscope Pod：

   bash
   kubectl create -f https://raw.githubusercontent.com/cilium/microscope/master/docs/microscope.yaml
   

   该命令会在 kube-system 命名空间创建 Pod，并自动配置 Microscope 工作所需的 RBAC 权限。部署完成后，通过以下命令进入 Pod 并启动工具：

   bash
   kubectl exec -it -n kube-system microscope sh
   

   在 Pod 内执行 microscope -h 可查看完整帮助信息。

2. 通过 kubectl run 快速部署（RBAC 启用时可能失效）
   执行以下命令直接创建 Microscope Pod：

   bash
   kubectl run -i --tty microscope --image cilium/microscope --restart=Never -- sh
   

   注意：若集群启用 RBAC 权限控制，此方法可能因权限不足导致工具无法正常工作。

本地运行

本地运行需满足 Python 3.5 或更高版本，推荐使用虚拟环境隔离依赖。

1. 通过 PyPI 安装
   Microscope 作为 PyPI 包发布，可直接通过 pip 安装：

   bash
   pip install cilium-microscope
   

   安装完成后，microscope 可执行文件将添加至系统路径，直接运行 microscope 即可启动工具。

2. 构建自包含 Python 归档
   从源码构建包含所有依赖的自包含 Python 归档（仅需 Python 环境即可运行）：

   bash
   make
   

   构建产物位于 dist/microscope.pyz，可直接执行：

   bash
   ./dist/microscope.pyz