You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: README.md
+16-8Lines changed: 16 additions & 8 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -1,28 +1,36 @@
1
1
# Diode NetBox Plugin
2
2
3
+
Diode NetBox plugin is a [NetBox](https://netboxlabs.com/oss/netbox/) plugin for the Diode ingestion service.
4
+
5
+
Diode is a new NetBox ingestion service that greatly simplifies and enhances the
6
+
process to add and update network data
7
+
in NetBox, ensuring your network source of truth is always accurate and can be trusted to power your network automation
8
+
pipelines.
9
+
10
+
More information about Diode can be found
11
+
at [https://netboxlabs.com/blog/introducing-diode-streamlining-data-ingestion-in-netbox/](https://netboxlabs.com/blog/introducing-diode-streamlining-data-ingestion-in-netbox/).
12
+
3
13
## Installation
4
14
5
15
```bash
6
16
pip install netboxlabs-diode-netbox-plugin
7
17
```
8
18
9
-
In your `configuration.py` file, add `netbox_diode_plugin` to the `PLUGINS` list.
19
+
In your NetBox `configuration.py` file, add `netbox_diode_plugin` to the `PLUGINS` list.
10
20
11
21
```python
12
22
PLUGINS= [
13
23
"netbox_diode_plugin",
14
24
]
15
25
```
16
26
17
-
Ensure following environment variables are set:
27
+
Set following environment variables for your NetBox:
18
28
19
-
```
20
-
DIODE_TO_NETBOX_API_KEY=<API_KEY_1>
21
-
NETBOX_TO_DIODE_API_KEY=<API_KEY_2>
22
-
INGESTION_API_KEY=<API_KEY_3>
23
-
```
29
+
*`DIODE_TO_NETBOX_API_KEY=<API_KEY_1>` - API key for the Diode service to interact with NetBox
30
+
*`NETBOX_TO_DIODE_API_KEY=<API_KEY_2>` - API key for the NetBox service to interact with Diode
31
+
*`INGESTION_API_KEY=<API_KEY_3>` - API key for Diode SDKs to ingest data into Diode
24
32
25
-
Values of these environment variables should be 40 character long alphanumeric strings.
33
+
Note: values of these environment variables should be 40 character long alphanumeric strings.
26
34
27
35
Configure the plugin by running the following command in your NetBox instance:
0 commit comments