Diode NetBox插件

Diode NetBox插件是NetBox的插件。它是Diode数据摄取服务的一个必要组件。

Diode是一个NetBox数据摄取服务，它极大地简化并增强了在NetBox中添加和更新网络数据的过程，确保您的网络真相来源始终准确，并且可以信任它为您的网络自动化流程提供动力。

有关Diode的更多信息，请参阅https://netboxlabs.com/blog/introducing-diode-streamlining-data-ingestion-in-netbox/。

兼容性

安装

源NetBox Python虚拟环境

cd /opt/netbox
source venv/bin/activate

安装插件

pip install netboxlabs-diode-netbox-plugin

在您的NetBox configuration.py 文件中，将 netbox_diode_plugin 添加到 PLUGINS 列表。

PLUGINS = [
    "netbox_diode_plugin",
]

同样在您的 configuration.py 文件中，为了自定义插件设置，将 netbox_diode_plugin 添加到 PLUGINS_CONFIG 字典中，例如。

PLUGINS_CONFIG = {
    "netbox_diode_plugin": {
        # Diode gRPC target for communication with Diode server
        "diode_target_override": "grpc://localhost:8080/diode",

        # User allowed for Diode to NetBox communication
        "diode_to_netbox_username": "diode-to-netbox",

        # User allowed for NetBox to Diode communication
        "netbox_to_diode_username": "netbox-to-diode",

        # User allowed for data ingestion
        "diode_username": "diode-ingestion",
    },
}

注意：一旦在首次安装期间使用PLUGINS_CONFIG自定义用户名，就不应更改或删除它们。这样做将导致插件无法正常工作。

重新启动NetBox服务以加载插件

sudo systemctl restart netbox netbox-rq

有关详细信息，请参阅NetBox文档。

配置

源NetBox Python虚拟环境（如果尚未）

cd /opt/netbox
source venv/bin/activate

需要三个API密钥（这些是随机的40位字母数字字符串）。可以使用以下命令生成并将它们设置为适当的环境变量：

# API key for the Diode service to interact with NetBox
export DIODE_TO_NETBOX_API_KEY=$(head -c20 </dev/urandom|xxd -p); env | grep DIODE_TO_NETBOX_API_KEY
# API key for the NetBox service to interact with Diode
export NETBOX_TO_DIODE_API_KEY=$(head -c20 </dev/urandom|xxd -p); env | grep NETBOX_TO_DIODE_API_KEY
# API key for Diode SDKs to ingest data into Diode
export DIODE_API_KEY=$(head -c20 </dev/urandom|xxd -p); env | grep DIODE_API_KEY

注意：请将API密钥字符串存储在安全的地方，因为稍后需要它们来配置Diode服务器。

运行迁移以创建所有必要的资源

cd /opt/netbox/netbox
./manage.py migrate netbox_diode_plugin

正在运行测试

make docker-compose-netbox-plugin-test

许可协议

在PolyForm Shield License 1.0.0许可协议下分发。更多信息请参阅LICENSE.md。

所需通知

版权所有 NetBox Labs, Inc.