newrelic/newrelic-python-init

New Relic Python Agent Init Container 镜像文档

镜像概述和主要用途

New Relic Python Agent Init Container 镜像是将 https://github.com/newrelic/newrelic-python-agent 分发为 Kubernetes Init Container 的专用镜像，用于配合 New Relic https://github.com/newrelic/k8s-agents-operator/ 使用。其核心用途是在 Kubernetes 环境中，作为初始化容器为应用部署 New Relic Python Agent，确保 Agent 在应用容器启动前完成配置准备。

核心功能和特性

• 初始化部署能力：作为 Kubernetes Init Container，在应用容器启动前完成 New Relic Python Agent 的部署与配置，确保 Agent 环境就绪。
• 版本灵活控制：通过镜像标签精确指定 Agent 版本，支持语义化版本（SemVer）及构建号标识，满足不同环境的版本管理需求。
• 与 Operator 集成：专为 New Relic Kubernetes Agents Operator 设计，无缝集成 Operator 的部署流程，简化 Agent 管理。

使用场景和适用范围

• Kubernetes 环境监控：适用于运行在 Kubernetes 集群中、需集成 New Relic 监控的 Python 应用。
• Operator 管理场景：配合 New Relic Kubernetes Agents Operator 使用，实现 Agent 的自动化部署与生命周期管理。
• 初始化依赖场景：需在应用启动前完成 Agent 配置（如文件复制、环境变量注入等）的部署流程。

镜像标签约定

Agent 版本遵循 语义化版本（SemVer） 规范，部分版本包含构建号（如 1.2.3.99）。不同镜像标签对应不同的 Agent 版本，具体说明如下：

说明：若需重新构建同一 Agent 版本（如修复容器层问题），会递增构建号（如 9.10.0.1），原标签（如 9.10.0.0）保持不变。

使用方法和配置说明

前提条件

• 已部署 New Relic Kubernetes Agents Operator（参考 https://github.com/newrelic/k8s-agents-operator/#installation%EF%BC%89%E3%80%82
• Kubernetes 集群版本支持 Init Container（Kubernetes 1.6+）。

Kubernetes 部署示例

在 Kubernetes Pod 中，通过 initContainers 配置该镜像，将 Agent 文件复制到共享卷（供应用容器使用）。示例 Pod YAML 片段如下：

yaml
apiVersion: v1
kind: Pod
metadata:
  name: python-app-with-newrelic
spec:
  initContainers:
  - name: newrelic-python-agent-init
    image: newrelic/python-agent-init-container:9.10.0  # 指定 Agent 版本标签
    volumeMounts:
    - name: newrelic-agent-volume
      mountPath: /newrelic-agent  # 挂载共享卷，用于传递 Agent 文件
    # 可选：若需自定义 Agent 配置，可通过环境变量或挂载配置文件
    env:
    - name: NEW_RELIC_LICENSE_KEY
      valueFrom:
        secretKeyRef:
          name: newrelic-credentials
          key: license-key
  containers:
  - name: python-app
    image: your-python-app-image:latest
    volumeMounts:
    - name: newrelic-agent-volume
      mountPath: /opt/newrelic  # 应用容器挂载共享卷，使用 Agent 文件
    env:
    - name: NEW_RELIC_AGENT_PATH
      value: /opt/newrelic  # 告知应用 Agent 路径
  volumes:
  - name: newrelic-agent-volume
    emptyDir: {}  # 使用 emptyDir 作为共享临时存储

关键配置说明

• 镜像标签选择：根据需求选择具体标签（如 latest、9.10 或 9.10.0.0），确保 Agent 版本匹配应用兼容性要求。
• 共享卷配置：通过 emptyDir 或持久卷（PVC）挂载共享目录，实现 Init Container 与应用容器间的文件传递。
• 环境变量注入：可通过 env 注入 New Relic 许可证密钥（NEW_RELIC_LICENSE_KEY）等配置，或挂载 newrelic.ini 配置文件到 Init Container 的 /newrelic-agent 目录。

支持与贡献

支持渠道

New Relic 提供在线论坛支持，可通过 New Relic Explorers Hub 与官方团队及社区用户交流问题、分享最佳实践。

贡献指南

欢迎通过以下方式贡献代码或改进：

1. 提交 Pull Request 前，需签署 贡献者许可协议（CLA）（个人贡献仅需签署一次）。
2. 企业贡献需联系 opensource@newrelic.com 执行企业 CLA。
3. 安全漏洞报告：通过 New Relic 漏洞赏金计划 提交，详情参见 https://github.com/newrelic/newrelic-agent-init-container/security/policy%E3%80%82

许可证

New Relic Python Agent Init Container 镜像基于 Apache 2.0 许可证 开源。第三方依赖库的许可证信息详见项目的“第三方声明”文档。