stefanprodan/podinfo

Podinfo Docker镜像文档

镜像概述

Podinfo是一个使用Go语言开发的小型Web应用程序，旨在展示在Kubernetes中运行微服务的最佳实践。作为微服务模板，它集成了多种Kubernetes环境下的核心功能和工具，帮助开发者快速构建符合行业标准的微服务应用。

核心功能和特性

• 健康检查：支持就绪探针（readiness）和存活探针（liveness），确保服务可用性
• 优雅关闭：响应中断信号，实现服务平滑退出
• 配置管理：文件监视器实时跟踪Secret和ConfigMap变更
• 可观测性：集成Prometheus指标暴露，支持Istio和Jaeger分布式追踪
• 服务网格兼容：提供Linkerd服务配置文件
• 日志管理：使用zap实现结构化日志输出
• 配置灵活性：遵循12因素应用原则，通过viper管理配置
• 故障注入：支持随机错误和延迟注入，便于测试容错能力
• API文档：内置Swagger文档，方便API调试和使用
• 部署工具：提供Helm和Kustomize安装配置
• 测试支持：包含基于Kubernetes Kind和Helm的端到端测试，以及结合GitHub Actions和Open Policy Agent的Kustomize测试

使用场景和适用范围

• 微服务开发模板：作为Go语言微服务的基础模板，帮助开发者快速搭建符合Kubernetes最佳实践的项目架构
• Kubernetes学习工具：展示微服务在K8s环境中的典型配置和集成方式，适合学习容器编排和服务管理
• 可观测性实践：演示如何在微服务中实现监控、追踪、日志等可观测性能力
• CI/CD流程测试：提供完整的测试配置，可作为CI/CD流水线的测试案例

使用方法和配置说明

源代码获取

完整源代码及详细文档请参考：https://github.com/stefanprodan/podinfo

部署方式

Podinfo推荐通过Helm或Kustomize在Kubernetes集群中部署：

Helm部署

bash
# 添加Helm仓库
helm repo add podinfo https://stefanprodan.github.io/podinfo
helm repo update

# 安装Podinfo
helm install podinfo podinfo/podinfo --namespace podinfo --create-namespace

Kustomize部署

bash
# 克隆代码仓库
git clone https://github.com/stefanprodan/podinfo.git
cd podinfo

# 使用Kustomize部署
kubectl apply -k kustomize/overlays/default

配置参数

具体配置参数可通过以下方式调整：

• 环境变量：通过Pod的环境变量注入配置（遵循12因素应用原则）
• ConfigMap/Secret：使用Kubernetes ConfigMap或Secret存储配置，应用将通过文件监视器自动加载变更
• Helm参数：通过Helm values文件自定义部署配置，详细参数见Helm chart文档

注意事项

• 本镜像主要用于开发和学习目的，生产环境使用前请根据实际需求调整配置和安全策略
• 服务依赖Kubernetes环境特性（如ConfigMap、Secret、服务网格等），建议在K8s集群中运行以发挥完整功能