netdata/devenv

Devenv 镜像文档

镜像概述和主要用途

Devenv（开发者环境）是一个容器化工作空间，旨在帮助开发者为Netdata Agent及其各类收集器进行开发，而不会影响生产环境。该镜像包含开发Netdata Agent所需的全部依赖和工具，使开发者能够快速开始贡献代码，无需手动配置开发环境。

核心功能和特性

• 完整依赖：包含构建Netdata Agent及其收集器所需的所有依赖项
• 开发工具：内置多种PR检查工具，包括flake8和shellcheck等代码检查器
• 即开即用：无需复杂配置，下载代码仓库后即可开始开发
• 容器化：完全容器化环境，避免本地环境冲突
• 自动发布：通过GitHub Actions CI/CD管道自动发布到DockerHub

使用场景和适用范围

适用于需要为以下Netdata项目贡献代码的开发者：

• Netdata Agent核心开发
• 收集器开发与改进
• 代码质量检查和PR准备
• 跨平台开发环境保持一致

使用方法和配置说明

前置要求

• 必需：Docker
• 可选：
  • VS Code（流行的开源编辑器）
  • Remote Containers VS Code扩展

快速启动（推荐）

1. 下载并安装VS Code和Docker

2. Fork目标GitHub仓库：https://github.com/netdata/netdata

3. 克隆fork的仓库到本地：

   bash
   git clone https://github.com/你的用户名/netdata netdata
   

4. 克隆社区仓库：

   bash
   git clone https://github.com/netdata/community community
   

5. 将.devcontainer文件夹从社区仓库复制到netdata目录：

   bash
   cp -r community/devenv/.devcontainer netdata/
   

6. 用VS Code打开netdata目录，点击弹出的"在容器中重新打开"提示，VS Code将在Netdata Devenv容器中重新打开目录

   注：本地目录与容器内目录实时同步，任何文件更改会立即反映在容器中

7. 开发环境准备完成！容器已预装常用VS Code扩展，也可根据需要安装更多扩展

   注意：本地安装的VS Code扩展不会在容器中生效，需在容器内单独安装

手动方式

直接拉取镜像并启动终端会话：

bash
docker pull netdata/devenv
docker run -it --rm netdata/devenv /bin/bash

容器已包含所有开发所需工具，可直接开始开发。

支持的Netdata仓库

Devenv包含开发以下仓库所需的全部依赖：

• netdata/netdata（核心Agent）
• netdata/dashboard（仪表盘）
• netdata/go.d.plugin（Go收集器插件）
• netdata/helmchart（Helm图表）